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.74.3" /><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;
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 strong.command { font-family: monospace; font-weight: normal; }
26 tr { vertical-align: top; }
28 </style></head><body><div class="book" lang="en" xml:lang="en"><div class="titlepage"><div><div><h1 class="title"><a id="id476998"></a>The Mutt E-Mail Client</h1></div><div><div class="author"><h3 class="author"><span class="firstname">Michael</span> <span class="surname">Elkins</span></h3><code class="email"><<a class="email" href="mailto:me@cs.hmc.edu">me@cs.hmc.edu</a>></code></div></div><div><p class="releaseinfo">version 1.5.20 (2009-06-14)</p></div><div><div class="abstract"><p class="title"><b>Abstract</b></p><p>
29 “<span class="quote">All mail clients suck. This one just sucks less.</span>” — me, circa 1995
30 </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. Typograhical Conventions</a></span></dt><dt><span class="sect1"><a href="#copyright">7. Copyright</a></span></dt></dl></dd><dt><span class="chapter"><a href="#gettingstarted">2. Getting Started</a></span></dt><dd><dl><dt><span class="sect1"><a href="#core-concepts">1. Core Concepts</a></span></dt><dt><span class="sect1"><a href="#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="#ignore">10.1. Selecting Headers</a></span></dt><dt><span class="sect2"><a href="#hdr-order">10.2. 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></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="#regexp">1. Regular Expressions</a></span></dt><dt><span class="sect1"><a href="#patterns">2. Patterns: Searching, Limiting and Tagging</a></span></dt><dd><dl><dt><span class="sect2"><a href="#patterns-modifier">2.1. Pattern Modifier</a></span></dt><dt><span class="sect2"><a href="#simple-searches">2.2. Simple Searches</a></span></dt><dt><span class="sect2"><a href="#complex-patterns">2.3. Nesting and Boolean Operators</a></span></dt><dt><span class="sect2"><a href="#date-patterns">2.4. Searching by Date</a></span></dt></dl></dd><dt><span class="sect1"><a href="#tags">3. Using Tags</a></span></dt><dt><span class="sect1"><a href="#hooks">4. Using Hooks</a></span></dt><dd><dl><dt><span class="sect2"><a href="#pattern-hook">4.1. Message Matching in Hooks</a></span></dt></dl></dd><dt><span class="sect1"><a href="#query">5. External Address Queries</a></span></dt><dt><span class="sect1"><a href="#mailbox-formats">6. Mailbox Formats</a></span></dt><dt><span class="sect1"><a href="#shortcuts">7. Mailbox Shortcuts</a></span></dt><dt><span class="sect1"><a href="#using-lists">8. Handling Mailing Lists</a></span></dt><dt><span class="sect1"><a href="#handling-folders">9. Handling multiple folders</a></span></dt><dt><span class="sect1"><a href="#editing-threads">10. Editing Threads</a></span></dt><dd><dl><dt><span class="sect2"><a href="#link-threads">10.1. Linking Threads</a></span></dt><dt><span class="sect2"><a href="#break-threads">10.2. Breaking Threads</a></span></dt></dl></dd><dt><span class="sect1"><a href="#dsn">11. Delivery Status Notification (DSN) Support</a></span></dt><dt><span class="sect1"><a href="#urlview">12. Start a WWW Browser on URLs</a></span></dt><dt><span class="sect1"><a href="#misc-topics">13. 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-pager">1.1. Viewing MIME Messages in the Pager</a></span></dt><dt><span class="sect2"><a href="#attach-menu">1.2. The Attachment Menu</a></span></dt><dt><span class="sect2"><a href="#compose-menu">1.3. The Compose Menu</a></span></dt></dl></dd><dt><span class="sect1"><a href="#mime-types">2. MIME Type Configuration with mime.types</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="#maint-cache">7.3. Maintenance</a></span></dt></dl></dd><dt><span class="sect1"><a href="#exact-address">8. Exact Address Generation</a></span></dt><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. mailto:-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="#mailcap-path">3.119. mailcap_path</a></span></dt><dt><span class="sect2"><a href="#mailcap-sanitize">3.120. mailcap_sanitize</a></span></dt><dt><span class="sect2"><a href="#maildir-header-cache-verify">3.121. maildir_header_cache_verify</a></span></dt><dt><span class="sect2"><a href="#maildir-trash">3.122. maildir_trash</a></span></dt><dt><span class="sect2"><a href="#mark-old">3.123. mark_old</a></span></dt><dt><span class="sect2"><a href="#markers">3.124. markers</a></span></dt><dt><span class="sect2"><a href="#mask">3.125. mask</a></span></dt><dt><span class="sect2"><a href="#mbox">3.126. mbox</a></span></dt><dt><span class="sect2"><a href="#mbox-type">3.127. mbox_type</a></span></dt><dt><span class="sect2"><a href="#menu-context">3.128. menu_context</a></span></dt><dt><span class="sect2"><a href="#menu-move-off">3.129. menu_move_off</a></span></dt><dt><span class="sect2"><a href="#menu-scroll">3.130. menu_scroll</a></span></dt><dt><span class="sect2"><a href="#message-cache-clean">3.131. message_cache_clean</a></span></dt><dt><span class="sect2"><a href="#message-cachedir">3.132. message_cachedir</a></span></dt><dt><span class="sect2"><a href="#message-format">3.133. message_format</a></span></dt><dt><span class="sect2"><a href="#meta-key">3.134. meta_key</a></span></dt><dt><span class="sect2"><a href="#metoo">3.135. metoo</a></span></dt><dt><span class="sect2"><a href="#mh-purge">3.136. mh_purge</a></span></dt><dt><span class="sect2"><a href="#mh-seq-flagged">3.137. mh_seq_flagged</a></span></dt><dt><span class="sect2"><a href="#mh-seq-replied">3.138. mh_seq_replied</a></span></dt><dt><span class="sect2"><a href="#mh-seq-unseen">3.139. mh_seq_unseen</a></span></dt><dt><span class="sect2"><a href="#mime-forward">3.140. mime_forward</a></span></dt><dt><span class="sect2"><a href="#mime-forward-decode">3.141. mime_forward_decode</a></span></dt><dt><span class="sect2"><a href="#mime-forward-rest">3.142. mime_forward_rest</a></span></dt><dt><span class="sect2"><a href="#mix-entry-format">3.143. mix_entry_format</a></span></dt><dt><span class="sect2"><a href="#mixmaster">3.144. mixmaster</a></span></dt><dt><span class="sect2"><a href="#move">3.145. move</a></span></dt><dt><span class="sect2"><a href="#narrow-tree">3.146. narrow_tree</a></span></dt><dt><span class="sect2"><a href="#net-inc">3.147. net_inc</a></span></dt><dt><span class="sect2"><a href="#pager">3.148. pager</a></span></dt><dt><span class="sect2"><a href="#pager-context">3.149. pager_context</a></span></dt><dt><span class="sect2"><a href="#pager-format">3.150. pager_format</a></span></dt><dt><span class="sect2"><a href="#pager-index-lines">3.151. pager_index_lines</a></span></dt><dt><span class="sect2"><a href="#pager-stop">3.152. pager_stop</a></span></dt><dt><span class="sect2"><a href="#pgp-auto-decode">3.153. pgp_auto_decode</a></span></dt><dt><span class="sect2"><a href="#pgp-autoinline">3.154. pgp_autoinline</a></span></dt><dt><span class="sect2"><a href="#pgp-check-exit">3.155. pgp_check_exit</a></span></dt><dt><span class="sect2"><a href="#pgp-clearsign-command">3.156. pgp_clearsign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-decode-command">3.157. pgp_decode_command</a></span></dt><dt><span class="sect2"><a href="#pgp-decrypt-command">3.158. pgp_decrypt_command</a></span></dt><dt><span class="sect2"><a href="#pgp-encrypt-only-command">3.159. pgp_encrypt_only_command</a></span></dt><dt><span class="sect2"><a href="#pgp-encrypt-sign-command">3.160. pgp_encrypt_sign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-entry-format">3.161. pgp_entry_format</a></span></dt><dt><span class="sect2"><a href="#pgp-export-command">3.162. pgp_export_command</a></span></dt><dt><span class="sect2"><a href="#pgp-getkeys-command">3.163. pgp_getkeys_command</a></span></dt><dt><span class="sect2"><a href="#pgp-good-sign">3.164. pgp_good_sign</a></span></dt><dt><span class="sect2"><a href="#pgp-ignore-subkeys">3.165. pgp_ignore_subkeys</a></span></dt><dt><span class="sect2"><a href="#pgp-import-command">3.166. pgp_import_command</a></span></dt><dt><span class="sect2"><a href="#pgp-list-pubring-command">3.167. pgp_list_pubring_command</a></span></dt><dt><span class="sect2"><a href="#pgp-list-secring-command">3.168. pgp_list_secring_command</a></span></dt><dt><span class="sect2"><a href="#pgp-long-ids">3.169. pgp_long_ids</a></span></dt><dt><span class="sect2"><a href="#pgp-mime-auto">3.170. pgp_mime_auto</a></span></dt><dt><span class="sect2"><a href="#pgp-replyinline">3.171. pgp_replyinline</a></span></dt><dt><span class="sect2"><a href="#pgp-retainable-sigs">3.172. pgp_retainable_sigs</a></span></dt><dt><span class="sect2"><a href="#pgp-show-unusable">3.173. pgp_show_unusable</a></span></dt><dt><span class="sect2"><a href="#pgp-sign-as">3.174. pgp_sign_as</a></span></dt><dt><span class="sect2"><a href="#pgp-sign-command">3.175. pgp_sign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-sort-keys">3.176. pgp_sort_keys</a></span></dt><dt><span class="sect2"><a href="#pgp-strict-enc">3.177. pgp_strict_enc</a></span></dt><dt><span class="sect2"><a href="#pgp-timeout">3.178. pgp_timeout</a></span></dt><dt><span class="sect2"><a href="#pgp-use-gpg-agent">3.179. pgp_use_gpg_agent</a></span></dt><dt><span class="sect2"><a href="#pgp-verify-command">3.180. pgp_verify_command</a></span></dt><dt><span class="sect2"><a href="#pgp-verify-key-command">3.181. pgp_verify_key_command</a></span></dt><dt><span class="sect2"><a href="#pipe-decode">3.182. pipe_decode</a></span></dt><dt><span class="sect2"><a href="#pipe-sep">3.183. pipe_sep</a></span></dt><dt><span class="sect2"><a href="#pipe-split">3.184. pipe_split</a></span></dt><dt><span class="sect2"><a href="#pop-auth-try-all">3.185. pop_auth_try_all</a></span></dt><dt><span class="sect2"><a href="#pop-authenticators">3.186. pop_authenticators</a></span></dt><dt><span class="sect2"><a href="#pop-checkinterval">3.187. pop_checkinterval</a></span></dt><dt><span class="sect2"><a href="#pop-delete">3.188. pop_delete</a></span></dt><dt><span class="sect2"><a href="#pop-host">3.189. pop_host</a></span></dt><dt><span class="sect2"><a href="#pop-last">3.190. pop_last</a></span></dt><dt><span class="sect2"><a href="#pop-pass">3.191. pop_pass</a></span></dt><dt><span class="sect2"><a href="#pop-reconnect">3.192. pop_reconnect</a></span></dt><dt><span class="sect2"><a href="#pop-user">3.193. pop_user</a></span></dt><dt><span class="sect2"><a href="#post-indent-string">3.194. post_indent_string</a></span></dt><dt><span class="sect2"><a href="#postpone">3.195. postpone</a></span></dt><dt><span class="sect2"><a href="#postponed">3.196. postponed</a></span></dt><dt><span class="sect2"><a href="#preconnect">3.197. preconnect</a></span></dt><dt><span class="sect2"><a href="#print">3.198. print</a></span></dt><dt><span class="sect2"><a href="#print-command">3.199. print_command</a></span></dt><dt><span class="sect2"><a href="#print-decode">3.200. print_decode</a></span></dt><dt><span class="sect2"><a href="#print-split">3.201. print_split</a></span></dt><dt><span class="sect2"><a href="#prompt-after">3.202. prompt_after</a></span></dt><dt><span class="sect2"><a href="#query-command">3.203. query_command</a></span></dt><dt><span class="sect2"><a href="#query-format">3.204. query_format</a></span></dt><dt><span class="sect2"><a href="#quit">3.205. quit</a></span></dt><dt><span class="sect2"><a href="#quote-regexp">3.206. quote_regexp</a></span></dt><dt><span class="sect2"><a href="#read-inc">3.207. read_inc</a></span></dt><dt><span class="sect2"><a href="#read-only">3.208. read_only</a></span></dt><dt><span class="sect2"><a href="#realname">3.209. realname</a></span></dt><dt><span class="sect2"><a href="#recall">3.210. recall</a></span></dt><dt><span class="sect2"><a href="#record">3.211. record</a></span></dt><dt><span class="sect2"><a href="#reply-regexp">3.212. reply_regexp</a></span></dt><dt><span class="sect2"><a href="#reply-self">3.213. reply_self</a></span></dt><dt><span class="sect2"><a href="#reply-to">3.214. reply_to</a></span></dt><dt><span class="sect2"><a href="#resolve">3.215. resolve</a></span></dt><dt><span class="sect2"><a href="#reverse-alias">3.216. reverse_alias</a></span></dt><dt><span class="sect2"><a href="#reverse-name">3.217. reverse_name</a></span></dt><dt><span class="sect2"><a href="#reverse-realname">3.218. reverse_realname</a></span></dt><dt><span class="sect2"><a href="#rfc2047-parameters">3.219. rfc2047_parameters</a></span></dt><dt><span class="sect2"><a href="#save-address">3.220. save_address</a></span></dt><dt><span class="sect2"><a href="#save-empty">3.221. save_empty</a></span></dt><dt><span class="sect2"><a href="#save-history">3.222. save_history</a></span></dt><dt><span class="sect2"><a href="#save-name">3.223. save_name</a></span></dt><dt><span class="sect2"><a href="#score">3.224. score</a></span></dt><dt><span class="sect2"><a href="#score-threshold-delete">3.225. score_threshold_delete</a></span></dt><dt><span class="sect2"><a href="#score-threshold-flag">3.226. score_threshold_flag</a></span></dt><dt><span class="sect2"><a href="#score-threshold-read">3.227. score_threshold_read</a></span></dt><dt><span class="sect2"><a href="#search-context">3.228. search_context</a></span></dt><dt><span class="sect2"><a href="#send-charset">3.229. send_charset</a></span></dt><dt><span class="sect2"><a href="#sendmail">3.230. sendmail</a></span></dt><dt><span class="sect2"><a href="#sendmail-wait">3.231. sendmail_wait</a></span></dt><dt><span class="sect2"><a href="#shell">3.232. shell</a></span></dt><dt><span class="sect2"><a href="#sig-dashes">3.233. sig_dashes</a></span></dt><dt><span class="sect2"><a href="#sig-on-top">3.234. sig_on_top</a></span></dt><dt><span class="sect2"><a href="#signature">3.235. signature</a></span></dt><dt><span class="sect2"><a href="#simple-search">3.236. simple_search</a></span></dt><dt><span class="sect2"><a href="#sleep-time">3.237. sleep_time</a></span></dt><dt><span class="sect2"><a href="#smart-wrap">3.238. smart_wrap</a></span></dt><dt><span class="sect2"><a href="#smileys">3.239. smileys</a></span></dt><dt><span class="sect2"><a href="#smime-ask-cert-label">3.240. smime_ask_cert_label</a></span></dt><dt><span class="sect2"><a href="#smime-ca-location">3.241. smime_ca_location</a></span></dt><dt><span class="sect2"><a href="#smime-certificates">3.242. smime_certificates</a></span></dt><dt><span class="sect2"><a href="#smime-decrypt-command">3.243. smime_decrypt_command</a></span></dt><dt><span class="sect2"><a href="#smime-decrypt-use-default-key">3.244. smime_decrypt_use_default_key</a></span></dt><dt><span class="sect2"><a href="#smime-default-key">3.245. smime_default_key</a></span></dt><dt><span class="sect2"><a href="#smime-encrypt-command">3.246. smime_encrypt_command</a></span></dt><dt><span class="sect2"><a href="#smime-encrypt-with">3.247. smime_encrypt_with</a></span></dt><dt><span class="sect2"><a href="#smime-get-cert-command">3.248. smime_get_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-get-cert-email-command">3.249. smime_get_cert_email_command</a></span></dt><dt><span class="sect2"><a href="#smime-get-signer-cert-command">3.250. smime_get_signer_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-import-cert-command">3.251. smime_import_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-is-default">3.252. smime_is_default</a></span></dt><dt><span class="sect2"><a href="#smime-keys">3.253. smime_keys</a></span></dt><dt><span class="sect2"><a href="#smime-pk7out-command">3.254. smime_pk7out_command</a></span></dt><dt><span class="sect2"><a href="#smime-sign-command">3.255. smime_sign_command</a></span></dt><dt><span class="sect2"><a href="#smime-sign-opaque-command">3.256. smime_sign_opaque_command</a></span></dt><dt><span class="sect2"><a href="#smime-timeout">3.257. smime_timeout</a></span></dt><dt><span class="sect2"><a href="#smime-verify-command">3.258. smime_verify_command</a></span></dt><dt><span class="sect2"><a href="#smime-verify-opaque-command">3.259. smime_verify_opaque_command</a></span></dt><dt><span class="sect2"><a href="#smtp-authenticators">3.260. smtp_authenticators</a></span></dt><dt><span class="sect2"><a href="#smtp-pass">3.261. smtp_pass</a></span></dt><dt><span class="sect2"><a href="#smtp-url">3.262. smtp_url</a></span></dt><dt><span class="sect2"><a href="#sort">3.263. sort</a></span></dt><dt><span class="sect2"><a href="#sort-alias">3.264. sort_alias</a></span></dt><dt><span class="sect2"><a href="#sort-aux">3.265. sort_aux</a></span></dt><dt><span class="sect2"><a href="#sort-browser">3.266. sort_browser</a></span></dt><dt><span class="sect2"><a href="#sort-re">3.267. sort_re</a></span></dt><dt><span class="sect2"><a href="#spam-separator">3.268. spam_separator</a></span></dt><dt><span class="sect2"><a href="#spoolfile">3.269. spoolfile</a></span></dt><dt><span class="sect2"><a href="#ssl-ca-certificates-file">3.270. ssl_ca_certificates_file</a></span></dt><dt><span class="sect2"><a href="#ssl-client-cert">3.271. ssl_client_cert</a></span></dt><dt><span class="sect2"><a href="#ssl-force-tls">3.272. ssl_force_tls</a></span></dt><dt><span class="sect2"><a href="#ssl-min-dh-prime-bits">3.273. ssl_min_dh_prime_bits</a></span></dt><dt><span class="sect2"><a href="#ssl-starttls">3.274. ssl_starttls</a></span></dt><dt><span class="sect2"><a href="#ssl-use-sslv2">3.275. ssl_use_sslv2</a></span></dt><dt><span class="sect2"><a href="#ssl-use-sslv3">3.276. ssl_use_sslv3</a></span></dt><dt><span class="sect2"><a href="#ssl-use-tlsv1">3.277. ssl_use_tlsv1</a></span></dt><dt><span class="sect2"><a href="#ssl-usesystemcerts">3.278. ssl_usesystemcerts</a></span></dt><dt><span class="sect2"><a href="#ssl-verify-dates">3.279. ssl_verify_dates</a></span></dt><dt><span class="sect2"><a href="#ssl-verify-host">3.280. ssl_verify_host</a></span></dt><dt><span class="sect2"><a href="#status-chars">3.281. status_chars</a></span></dt><dt><span class="sect2"><a href="#status-format">3.282. status_format</a></span></dt><dt><span class="sect2"><a href="#status-on-top">3.283. status_on_top</a></span></dt><dt><span class="sect2"><a href="#strict-threads">3.284. strict_threads</a></span></dt><dt><span class="sect2"><a href="#suspend">3.285. suspend</a></span></dt><dt><span class="sect2"><a href="#text-flowed">3.286. text_flowed</a></span></dt><dt><span class="sect2"><a href="#thorough-search">3.287. thorough_search</a></span></dt><dt><span class="sect2"><a href="#thread-received">3.288. thread_received</a></span></dt><dt><span class="sect2"><a href="#tilde">3.289. tilde</a></span></dt><dt><span class="sect2"><a href="#time-inc">3.290. time_inc</a></span></dt><dt><span class="sect2"><a href="#timeout">3.291. timeout</a></span></dt><dt><span class="sect2"><a href="#tmpdir">3.292. tmpdir</a></span></dt><dt><span class="sect2"><a href="#to-chars">3.293. to_chars</a></span></dt><dt><span class="sect2"><a href="#tunnel">3.294. tunnel</a></span></dt><dt><span class="sect2"><a href="#uncollapse-jump">3.295. uncollapse_jump</a></span></dt><dt><span class="sect2"><a href="#use-8bitmime">3.296. use_8bitmime</a></span></dt><dt><span class="sect2"><a href="#use-domain">3.297. use_domain</a></span></dt><dt><span class="sect2"><a href="#use-envelope-from">3.298. use_envelope_from</a></span></dt><dt><span class="sect2"><a href="#use-from">3.299. use_from</a></span></dt><dt><span class="sect2"><a href="#use-idn">3.300. use_idn</a></span></dt><dt><span class="sect2"><a href="#use-ipv6">3.301. use_ipv6</a></span></dt><dt><span class="sect2"><a href="#user-agent">3.302. user_agent</a></span></dt><dt><span class="sect2"><a href="#visual">3.303. visual</a></span></dt><dt><span class="sect2"><a href="#wait-key">3.304. wait_key</a></span></dt><dt><span class="sect2"><a href="#weed">3.305. weed</a></span></dt><dt><span class="sect2"><a href="#wrap">3.306. wrap</a></span></dt><dt><span class="sect2"><a href="#wrap-search">3.307. wrap_search</a></span></dt><dt><span class="sect2"><a href="#wrapmargin">3.308. wrapmargin</a></span></dt><dt><span class="sect2"><a href="#write-bcc">3.309. write_bcc</a></span></dt><dt><span class="sect2"><a href="#write-inc">3.310. 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="#attach-map">4.6. Attach Menu</a></span></dt><dt><span class="sect2"><a href="#compose-map">4.7. Compose Menu</a></span></dt><dt><span class="sect2"><a href="#postpone-map">4.8. Postpone Menu</a></span></dt><dt><span class="sect2"><a href="#browser-map">4.9. Browser Menu</a></span></dt><dt><span class="sect2"><a href="#pgp-map">4.10. Pgp Menu</a></span></dt><dt><span class="sect2"><a href="#smime-map">4.11. Smime Menu</a></span></dt><dt><span class="sect2"><a href="#mix-map">4.12. Mix Menu</a></span></dt><dt><span class="sect2"><a href="#editor-map">4.13. Editor Menu</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#miscellany">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>9.1. <a href="#tab-commandline-options">Command line options</a></dt><dt>9.2. <a href="#generic-table">Default generic Function Bindings</a></dt><dt>9.3. <a href="#index-table">Default index Function Bindings</a></dt><dt>9.4. <a href="#pager-table">Default pager Function Bindings</a></dt><dt>9.5. <a href="#alias-table">Default alias Function Bindings</a></dt><dt>9.6. <a href="#query-table">Default query Function Bindings</a></dt><dt>9.7. <a href="#attach-table">Default attach Function Bindings</a></dt><dt>9.8. <a href="#compose-table">Default compose Function Bindings</a></dt><dt>9.9. <a href="#postpone-table">Default postpone Function Bindings</a></dt><dt>9.10. <a href="#browser-table">Default browser Function Bindings</a></dt><dt>9.11. <a href="#pgp-table">Default pgp Function Bindings</a></dt><dt>9.12. <a href="#smime-table">Default smime Function Bindings</a></dt><dt>9.13. <a href="#mix-table">Default mix Function Bindings</a></dt><dt>9.14. <a href="#editor-table">Default editor Function Bindings</a></dt></dl></div><div class="list-of-examples"><p><b>List of Examples</b></p><dl><dt>3.1. <a href="#ex-rc-multiple-cmds">Multiple configuration commands per line</a></dt><dt>3.2. <a href="#ex-ec-comment">Commenting configuration files</a></dt><dt>3.3. <a href="#ex-rc-quote">Escaping quotes in congfiguration files</a></dt><dt>3.4. <a href="#ex-rc-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 save-hook</a></dt><dt>3.13. <a href="#ex-folder-hook-push">Embedding push in folder-hook</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-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 default hook</a></dt><dt>5.1. <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" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="intro"></a>Chapter 1. Introduction</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#homepage">1. Mutt Home Page</a></span></dt><dt><span class="sect1"><a href="#muttlists">2. Mailing Lists</a></span></dt><dt><span class="sect1"><a href="#distribution">3. 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. Typograhical Conventions</a></span></dt><dt><span class="sect1"><a href="#copyright">7. Copyright</a></span></dt></dl></div><p>
31 <span class="bold"><strong>Mutt</strong></span> is a small but very powerful text-based MIME mail client. Mutt is
32 highly configurable, and is well suited to the mail power user with advanced
33 features like key bindings, keyboard macros, mail threading, regular
34 expression searches and a powerful pattern matching language for selecting
36 </p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="homepage"></a>1. Mutt Home Page</h2></div></div></div><p>
37 The official homepage can be found at
38 <a class="ulink" href="http://www.mutt.org/" target="_top">http://www.mutt.org/</a>.
39 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="muttlists"></a>2. Mailing Lists</h2></div></div></div><p>
40 To subscribe to one of the following mailing lists, send a message with the
41 word <span class="emphasis"><em>subscribe</em></span> in the body to
42 <code class="literal">list-name</code><span class="emphasis"><em>-request</em></span><code class="literal">@mutt.org</code>.
43 </p><div class="itemizedlist"><ul type="disc"><li><p>
44 <code class="email"><<a class="email" href="mailto:mutt-announce-request@mutt.org">mutt-announce-request@mutt.org</a>></code> -- low traffic list for announcements
46 <code class="email"><<a class="email" href="mailto:mutt-users-request@mutt.org">mutt-users-request@mutt.org</a>></code> -- help, bug reports and feature requests
48 <code class="email"><<a class="email" href="mailto:mutt-dev-request@mutt.org">mutt-dev-request@mutt.org</a>></code> -- development mailing list
49 </p></li></ul></div><div class="note"><h3 class="title">Note</h3><p>
50 All messages posted to
51 <span class="emphasis"><em>mutt-announce</em></span> are automatically forwarded to
52 <span class="emphasis"><em>mutt-users</em></span>, so you do not need to be subscribed to
54 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="distribution"></a>3. Getting Mutt</h2></div></div></div><p>
55 Mutt releases can be downloaded from
56 <a class="ulink" href="ftp://ftp.mutt.org/mutt/" target="_top">ftp://ftp.mutt.org/mutt/</a>.
57 For a list of mirror sites, please refer to
58 <a class="ulink" href="http://www.mutt.org/download.html" target="_top">http://www.mutt.org/download.html</a>.
60 For nightly tarballs and version control access, please refer to the
61 <a class="ulink" href="http://dev.mutt.org/" target="_top">Mutt development site</a>.
62 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="irc"></a>4. Mutt Online Resources</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">Bug Tracking System</span></dt><dd><p>
63 The official Mutt bug tracking system can be found at
64 <a class="ulink" href="http://bugs.mutt.org/" target="_top">http://bugs.mutt.org/</a>
65 </p></dd><dt><span class="term">Wiki</span></dt><dd><p>
66 An (unofficial) wiki can be found
67 at <a class="ulink" href="http://wiki.mutt.org/" target="_top">http://wiki.mutt.org/</a>.
68 </p></dd><dt><span class="term">IRC</span></dt><dd><p>
69 For the IRC user community, visit channel <span class="emphasis"><em>#mutt</em></span> on
70 <a class="ulink" href="http://www.freenode.net/" target="_top">irc.freenode.net</a>.
71 </p></dd><dt><span class="term">USENET</span></dt><dd><p>
72 For USENET, see the newsgroup <a class="ulink" href="news:comp.mail.mutt" target="_top">comp.mail.mutt</a>.
73 </p></dd></dl></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="contrib"></a>5. Contributing to Mutt</h2></div></div></div><p>
74 There are various ways to contribute to the Mutt project.
76 Especially for new users it may be helpful to meet other new and
77 experienced users to chat about Mutt, talk about problems and share
80 Since translations of Mutt into other languages are highly appreciated,
81 the Mutt developers always look for skilled translators that help
82 improve and continue to maintain stale translations.
84 For contributing code patches for new features and bug fixes, please
85 refer to the developer pages at
86 <a class="ulink" href="http://dev.mutt.org/" target="_top">http://dev.mutt.org/</a> for more details.
87 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="typo"></a>6. Typograhical Conventions</h2></div></div></div><p>
88 This section lists typographical conventions followed throughout this
89 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
90 conventions for special terms.
91 </p><div class="table"><a id="tab-typo"></a><p class="title"><b>Table 1.1. Typographical conventions for special terms</b></p><div class="table-contents"><table summary="Typographical conventions for special terms" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Item</th><th>Refers to...</th></tr></thead><tbody><tr><td><code class="literal">printf(3)</code></td><td>UNIX manual pages, execute <code class="literal">man 3 printf</code></td></tr><tr><td><code class="literal"><PageUp></code></td><td>named keys</td></tr><tr><td><code class="literal"><create-alias></code></td><td>named Mutt function</td></tr><tr><td><code class="literal">^G</code></td><td>Control+G key combination</td></tr><tr><td>$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>
92 Examples are presented as:
93 </p><pre class="screen">
96 Within command synopsis, curly brackets (“<span class="quote">{}</span>”) denote a set
97 of options of which one is mandatory, square brackets
98 (“<span class="quote">[]</span>”) denote optional arguments, three dots
99 denote that the argument may be repeated arbitrary times.
100 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="copyright"></a>7. Copyright</h2></div></div></div><p>
101 Mutt is Copyright © 1996-2009 Michael R. Elkins
102 <code class="email"><<a class="email" href="mailto:me@mutt.org">me@mutt.org</a>></code> and others.
104 This program is free software; you can redistribute it and/or modify
105 it under the terms of the GNU General Public License as published by
106 the Free Software Foundation; either version 2 of the License, or
107 (at your option) any later version.
109 This program is distributed in the hope that it will be useful,
110 but WITHOUT ANY WARRANTY; without even the implied warranty of
111 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
112 GNU General Public License for more details.
114 You should have received a copy of the GNU General Public License
115 along with this program; if not, write to the Free Software
116 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
117 </p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="gettingstarted"></a>Chapter 2. Getting Started</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#core-concepts">1. Core Concepts</a></span></dt><dt><span class="sect1"><a href="#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>
118 This section is intended as a brief overview of how to use Mutt. There are
119 many other features which are described elsewhere in the manual. There
120 is even more information available in the Mutt FAQ and various web
121 pages. See the <a class="ulink" href="http://www.mutt.org/" target="_top">Mutt homepage</a> for more details.
123 The keybindings described in this section are the defaults as distributed.
124 Your local system administrator may have altered the defaults for your site.
125 You can always type “<span class="quote">?</span>” in any menu to display the current bindings.
127 The first thing you need to do is invoke Mutt, simply by typing <code class="literal">mutt</code>
128 at the command line. There are various command-line options, see
129 either the Mutt man page or the <a class="link" href="#commandline" title="1. Command-Line Options">reference</a>.
130 </p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="core-concepts"></a>1. Core Concepts</h2></div></div></div><p>
131 Mutt is a text-based application which interacts with users through
132 different menus which are mostly line-/entry-based or page-based. A
133 line-based menu is the so-called “<span class="quote">index</span>” menu (listing all messages of
134 the currently opened folder) or the “<span class="quote">alias</span>” menu (allowing you to
135 select recipients from a list). Examples for page-based menus are the
136 “<span class="quote">pager</span>” (showing one message at a time) or the “<span class="quote">help</span>” menu listing
137 all available key bindings.
139 The user interface consists of a context sensitive help line at the top,
140 the menu's contents followed by a context sensitive status line and
141 finally the command line. The command line is used to display
142 informational and error messages as well as for prompts and for entering
143 interactive commands.
145 Mutt is configured through variables which, if the user wants to
146 permanently use a non-default value, are written to configuration
147 files. Mutt supports a rich config file syntax to make even complex
148 configuration files readable and commentable.
150 Because Mutt allows for customizing almost all key bindings, there are
151 so-called “<span class="quote">functions</span>” which can be executed manually (using the
152 command line) or in macros. Macros allow the user to bind a sequence of
153 commands to a single key or a short key sequence instead of repeating a
154 sequence of actions over and over.
156 Many commands (such as saving or copying a message to another folder)
157 can be applied to a single message or a set of messages (so-called
158 “<span class="quote">tagged</span>” messages). To help selecting messages, Mutt provides a rich
159 set of message patterns (such as recipients, sender, body contents, date
160 sent/received, etc.) which can be combined into complex expressions
161 using the boolean <span class="emphasis"><em>and</em></span> and <span class="emphasis"><em>or</em></span>
162 operations as well as negating. These patterns can also be used to (for
163 example) search for messages or to limit the index to show only matching
166 Mutt supports a “<span class="quote">hook</span>” concept which allows the user to execute
167 arbitrary configuration commands and functions in certain situations
168 such as entering a folder, starting a new message or replying to an
169 existing one. These hooks can be used to highly customize Mutt's
170 behaviour including managing multiple identities, customizing the
171 display for a folder or even implementing auto-archiving based on a
172 per-folder basis and much more.
174 Besides an interactive mode, Mutt can also be used as a command-line
175 tool only send messages. It also supports a
176 <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
178 </p></div><div class="sect1" lang="en" xml:lang="en"><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" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="intro-index"></a>2.1. Index</h3></div></div></div><p>
179 The index is the screen that you usually see first when you start
180 Mutt. It gives an overview over your emails in the currently opened
181 mailbox. By default, this is your system mailbox. The information you
182 see in the index is a list of emails, each with its number on the left,
183 its flags (new email, important email, email that has been forwarded or
184 replied to, tagged email, ...), the date when email was sent, its
185 sender, the email size, and the subject. Additionally, the index also
186 shows thread hierarchies: when you reply to an email, and the other
187 person replies back, you can see the other's person email in a
188 "sub-tree" below. This is especially useful for personal email between
189 a group of people or when you've subscribed to mailing lists.
190 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="intro-pager"></a>2.2. Pager</h3></div></div></div><p>
191 The pager is responsible for showing the email content. On the top of
192 the pager you have an overview over the most important email headers
193 like the sender, the recipient, the subject, and much more
194 information. How much information you actually see depends on your
195 configuration, which we'll describe below.
197 Below the headers, you see the email body which usually contains the
198 message. If the email contains any attachments, you will see more
199 information about them below the email body, or, if the attachments are
200 text files, you can view them directly in the pager.
202 To give the user a good overview, it is possible to configure Mutt to
203 show different things in the pager with different colors. Virtually
204 everything that can be described with a regular expression can be
205 colored, e.g. URLs, email addresses or smileys.
206 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="intro-browser"></a>2.3. File Browser</h3></div></div></div><p>
207 The file browser is the interface to the local or remote file
208 system. When selecting a mailbox to open, the browser allows custom
209 sorting of items, limiting the items shown by a regular expression and a
210 freely adjustable format of what to display in which way. It also allows
211 for easy navigation through the file system when selecting file(s) to
212 attach to a message, select multiple files to attach and many more.
213 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="intro-help"></a>2.4. Help</h3></div></div></div><p>
214 The help screen is meant to offer a quick help to the user. It lists the
215 current configuration of key bindings and their associated commands
216 including a short description, and currently unbound functions that
217 still need to be associated with a key binding (or alternatively, they
218 can be called via the Mutt command prompt).
219 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="intro-compose"></a>2.5. Compose Menu</h3></div></div></div><p>
220 The compose menu features a split screen containing the information
221 which really matter before actually sending a message by mail: who gets
222 the message as what (recipients and who gets what kind of
223 copy). Additionally, users may set security options like deciding
224 whether to sign, encrypt or sign and encrypt a message with/for what
225 keys. Also, it's used to attach messages, to re-edit any attachment
226 including the message itself.
227 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="intro-alias"></a>2.6. Alias Menu</h3></div></div></div><p>
228 The alias menu is used to help users finding the recipients of
229 messages. For users who need to contact many people, there's no need to
230 remember addresses or names completely because it allows for searching,
231 too. The alias mechanism and thus the alias menu also features grouping
232 several addresses by a shorter nickname, the actual alias, so that users
233 don't have to select each single recipient manually.
234 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="intro-attach"></a>2.7. Attachment Menu</h3></div></div></div><p>
235 As will be later discussed in detail, Mutt features a good and stable
236 MIME implementation, that is, it supports sending and receiving messages
237 of arbitrary MIME types. The attachment menu displays a message's
238 structure in detail: what content parts are attached to which parent
239 part (which gives a true tree structure), which type is of what type and
240 what size. Single parts may saved, deleted or modified to offer great
241 and easy access to message's internals.
242 </p></div></div><div class="sect1" lang="en" xml:lang="en"><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>
243 The most important navigation keys common to line- or entry-based menus
244 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
245 <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.
246 </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 <Down></td><td><code class="literal"><next-entry></code></td><td>move to the next entry</td></tr><tr><td>k or <Up></td><td><code class="literal"><previous-entry></code></td><td>move to the previous entry</td></tr><tr><td>z or <PageDn></td><td><code class="literal"><page-down></code></td><td>go to the next page</td></tr><tr><td>Z or <PageUp></td><td><code class="literal"><page-up></code></td><td>go to the previous page</td></tr><tr><td>= or <Home></td><td><code class="literal"><first-entry></code></td><td>jump to the first entry</td></tr><tr><td>* or <End></td><td><code class="literal"><last-entry></code></td><td>jump to the last entry</td></tr><tr><td>q</td><td><code class="literal"><quit></code></td><td>exit the current menu</td></tr><tr><td>?</td><td><code class="literal"><help></code></td><td>list all keybindings for the current menu</td></tr></tbody></table></div></div><br class="table-break" /><div 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 <Return></td><td><code class="literal"><next-line></code></td><td>scroll down one line</td></tr><tr><td><Backspace></td><td><code class="literal"><previous-line></code></td><td>sroll up one line</td></tr><tr><td>K, <Space> or <PageDn></td><td><code class="literal"><next-page></code></td><td>move to the next page</td></tr><tr><td>- or <PageUp></td><td><code class="literal"><previous-page></code></td><td>move the previous page</td></tr><tr><td><Home></td><td><code class="literal"><top></code></td><td>move to the top</td></tr><tr><td><End></td><td><code class="literal"><bottom></code></td><td>move to the bottom</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="editing"></a>4. Editing Input Fields</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="editing-intro"></a>4.1. Introduction</h3></div></div></div><p>
247 Mutt has a built-in line editor for inputting text, e.g. email
248 addresses or filenames. The keys used to manipulate text input are
249 very similar to 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
250 reference of available functions, their default key bindings, and
252 </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 <Home></td><td><code class="literal"><bol></code></td><td>move to the start of the line</td></tr><tr><td>^B or <Left></td><td><code class="literal"><backward-char></code></td><td>move back one char</td></tr><tr><td>Esc B</td><td><code class="literal"><backward-word></code></td><td>move back one word</td></tr><tr><td>^D or <Delete></td><td><code class="literal"><delete-char></code></td><td>delete the char under the cursor</td></tr><tr><td>^E or <End></td><td><code class="literal"><eol></code></td><td>move to the end of the line</td></tr><tr><td>^F or <Right></td><td><code class="literal"><forward-char></code></td><td>move forward one char</td></tr><tr><td>Esc F</td><td><code class="literal"><forward-word></code></td><td>move forward one word</td></tr><tr><td><Tab></td><td><code class="literal"><complete></code></td><td>complete filename or alias</td></tr><tr><td>^T</td><td><code class="literal"><complete-query></code></td><td>complete address with query</td></tr><tr><td>^K</td><td><code class="literal"><kill-eol></code></td><td>delete to the end of the line</td></tr><tr><td>Esc d</td><td><code class="literal"><kill-eow></code></td><td>delete to the end of the word</td></tr><tr><td>^W</td><td><code class="literal"><kill-word></code></td><td>kill the word in front of the cursor</td></tr><tr><td>^U</td><td><code class="literal"><kill-line></code></td><td>delete entire line</td></tr><tr><td>^V</td><td><code class="literal"><quote-char></code></td><td>quote the next typed key</td></tr><tr><td><Up></td><td><code class="literal"><history-up></code></td><td>recall previous string from history</td></tr><tr><td><Down></td><td><code class="literal"><history-down></code></td><td>recall next string from history</td></tr><tr><td><BackSpace></td><td><code class="literal"><backspace></code></td><td>kill the char in front of the cursor</td></tr><tr><td>Esc u</td><td><code class="literal"><upcase-word></code></td><td>convert word to upper case</td></tr><tr><td>Esc l</td><td><code class="literal"><downcase-word></code></td><td>convert word to lower case</td></tr><tr><td>Esc c</td><td><code class="literal"><capitalize-word></code></td><td>capitalize the word</td></tr><tr><td>^G</td><td>n/a</td><td>abort</td></tr><tr><td><Return></td><td>n/a</td><td>finish editing</td></tr></tbody></table></div></div><br class="table-break" /><p>
253 You can remap the <span class="emphasis"><em>editor</em></span> functions using the
254 <a class="link" href="#bind" title="5. Changing the Default Key Bindings"><span class="command"><strong>bind</strong></span></a> command. For example, to make
255 the <Delete> key delete the character in front of
256 the cursor rather than under, you could use:
257 </p><pre class="screen">
258 bind editor <delete> backspace
259 </pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="editing-history"></a>4.2. History</h3></div></div></div><p>
260 Mutt maintains a history for the built-in editor. The number of items
261 is controlled by the <a class="link" href="#history" title="3.89. history">$history</a>
262 variable and can be made persistent using an external file specified
263 using <a class="link" href="#history-file" title="3.90. history_file">$history_file</a>.
264 You may cycle through them at an editor prompt by using the
265 <code class="literal"><history-up></code> and/or
266 <code class="literal"><history-down></code> commands. But notice that Mutt
267 does not remember the currently entered text, it only cycles through
268 history and wraps around at the end or beginning.
270 Mutt maintains several distinct history lists, one for each of the
271 following categories:
272 </p><div class="itemizedlist"><ul type="disc"><li><p><code class="literal">.muttrc</code> commands</p></li><li><p>addresses and aliases</p></li><li><p>shell commands</p></li><li><p>filenames</p></li><li><p>patterns</p></li><li><p>everything else</p></li></ul></div><p>
273 Mutt automatically filters out consecutively repeated items from the history. It
274 also mimics the behavior of some shells by ignoring items starting
275 with a space. The latter feature can be useful in macros to not clobber
276 the history's valuable entries with unwanted entries.
277 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="reading"></a>5. Reading Mail</h2></div></div></div><p>
278 Similar to many other mail clients, there are two modes in which mail is
279 read in Mutt. The first is a list of messages in the mailbox, which is
280 called the “<span class="quote">index</span>” menu in Mutt. The second mode is the display of the
281 message contents. This is called the “<span class="quote">pager.</span>”
283 The next few sections describe the functions provided in each of these
285 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="index-menu"></a>5.1. The Message Index</h3></div></div></div><p>
286 Common keys used to navigate through and manage messages in the index
287 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
288 in the index menu can be customized using the
289 <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> variable.
290 </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><Return></td><td>display-message</td></tr><tr><td><Tab></td><td>jump to the next new or unread message</td></tr><tr><td>@</td><td>show the author's full e-mail address</td></tr><tr><td>$</td><td>save changes to mailbox</td></tr><tr><td>/</td><td>search</td></tr><tr><td>Esc /</td><td>search-reverse</td></tr><tr><td>^L</td><td>clear and redraw the screen</td></tr><tr><td>^T</td><td>untag messages matching a pattern</td></tr></tbody></table></div></div><br class="table-break" /><p>
291 In addition to who sent the message and the subject, a short summary of
292 the disposition of each message is printed beside the message number.
293 Zero or more of the “<span class="quote">flags</span>” in <a class="xref" href="#tab-msg-status-flags" title="Table 2.5. Message status flags">Table 2.5, “Message status flags”</a>
294 may appear, some of which can be turned on or off using these functions:
295 <code class="literal"><set-flag></code> and
296 <code class="literal"><clear-flag></code>
297 bound by default to “<span class="quote">w</span>” and “<span class="quote">W</span>” respectively.
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
301 <a class="link" href="#to-chars" title="3.293. to_chars">$to_chars</a> variable.
302 </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></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" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pager-menu"></a>5.2. The Pager</h3></div></div></div><p>
303 By default, Mutt uses its builtin pager to display the contents of
304 messages (an external pager such as <code class="literal">less(1)</code> can be
305 configured, see <a class="link" href="#pager" title="3.148. pager">$pager</a> variable).
306 The pager is very similar to the Unix program <code class="literal">less(1)</code>
307 though not nearly as featureful.
308 </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><Return></td><td>go down one line</td></tr><tr><td><Space></td><td>display the next page (or next message if at the end of a message)</td></tr><tr><td>-</td><td>go back to the previous page</td></tr><tr><td>n</td><td>search for next match</td></tr><tr><td>S</td><td>skip beyond quoted text</td></tr><tr><td>T</td><td>toggle display of quoted text</td></tr><tr><td>?</td><td>show keybindings</td></tr><tr><td>/</td><td>regular expression search</td></tr><tr><td>Esc /</td><td>backward regular expression search</td></tr><tr><td>\</td><td>toggle highlighting of search matches</td></tr><tr><td>^</td><td>jump to the top of the message</td></tr></tbody></table></div></div><br class="table-break" /><p>
309 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>,
310 many of the functions from the index menu are also available in
311 the pager, such as <code class="literal"><delete-message></code> or <code class="literal"><copy-message></code>
312 (this is one advantage over using an external pager to view messages).
314 Also, the internal pager supports a couple other advanced features. For
315 one, it will accept and translate the “<span class="quote">standard</span>” nroff sequences for
316 bold and underline. These sequences are a series of either the letter,
317 backspace (“<span class="quote">^H</span>”), the letter again for bold or the letter, backspace,
318 “<span class="quote">_</span>” for denoting underline. Mutt will attempt to display these
319 in bold and underline respectively if your terminal supports them. If
320 not, you can use the bold and underline <a class="link" href="#color" title="9. Using Color and Mono Video Attributes">color</a>
321 objects to specify a <span class="command"><strong>color</strong></span> or mono attribute for them.
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
329 where <span class="emphasis"><em>Ps</em></span> can be one of the codes shown in
330 <a class="xref" href="#tab-ansi-esc" title="Table 2.8. ANSI escape sequences">Table 2.8, “ANSI escape sequences”</a>.
331 </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><color></em></span></td><td>Foreground color is <span class="emphasis"><em><color></em></span> (see <a class="xref" href="#tab-color" title="Table 2.9. Color sequences">Table 2.9, “Color sequences”</a>)</td></tr><tr><td>4<span class="emphasis"><em><color></em></span></td><td>Background color is <span class="emphasis"><em><color></em></span> (see <a class="xref" href="#tab-color" title="Table 2.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>
332 Mutt uses these attributes for handling <code class="literal">text/enriched</code>
333 messages, and they can also be used by an external
334 <a class="link" href="#auto-view" title="4. MIME Autoview">autoview</a> script for highlighting
336 </p><div class="note"><h3 class="title">Note</h3><p>
337 If you change the colors for your
338 display, for example by changing the color associated with color2 for
339 your xterm, then that color will be used instead of green.
340 </p></div><div class="note"><h3 class="title">Note</h3><p>
341 Note that the search commands in the pager take regular expressions,
342 which are not quite the same as the more
343 complex <a class="link" href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">patterns</a> used by the search
344 command in the index. This is because patterns are used to select messages by
345 criteria whereas the pager already displays a selected message.
346 </p></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="threads"></a>5.3. Threaded Mode</h3></div></div></div><p>
347 So-called “<span class="quote">threads</span>” provide a hierarchy of messages where
348 replies are linked to their parent message(s). This organizational form
349 is extremely useful in mailing lists where different parts of the
350 discussion diverge. Mutt displays threads as a tree structure.
352 In Mutt, when a mailbox is <a class="link" href="#sort" title="3.263. sort">sorted</a>
353 by <span class="emphasis"><em>threads</em></span>, there are a few additional functions
354 available in the <span class="emphasis"><em>index</em></span>
355 and <span class="emphasis"><em>pager</em></span> modes as shown in
356 <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>.
357 </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"><delete-thread></code></td><td>delete all messages in the current thread</td></tr><tr><td>^U</td><td><code class="literal"><undelete-thread></code></td><td>undelete all messages in the current thread</td></tr><tr><td>^N</td><td><code class="literal"><next-thread></code></td><td>jump to the start of the next thread</td></tr><tr><td>^P</td><td><code class="literal"><previous-thread></code></td><td>jump to the start of the previous thread</td></tr><tr><td>^R</td><td><code class="literal"><read-thread></code></td><td>mark the current thread as read</td></tr><tr><td>Esc d</td><td><code class="literal"><delete-subthread></code></td><td>delete all messages in the current subthread</td></tr><tr><td>Esc u</td><td><code class="literal"><undelete-subthread></code></td><td>undelete all messages in the current subthread</td></tr><tr><td>Esc n</td><td><code class="literal"><next-subthread></code></td><td>jump to the start of the next subthread</td></tr><tr><td>Esc p</td><td><code class="literal"><previous-subthread></code></td><td>jump to the start of the previous subthread</td></tr><tr><td>Esc r</td><td><code class="literal"><read-subthread></code></td><td>mark the current subthread as read</td></tr><tr><td>Esc t</td><td><code class="literal"><tag-thread></code></td><td>toggle the tag on the current thread</td></tr><tr><td>Esc v</td><td><code class="literal"><collapse-thread></code></td><td>toggle collapse for the current thread</td></tr><tr><td>Esc V</td><td><code class="literal"><collapse-all></code></td><td>toggle collapse for all threads</td></tr><tr><td>P</td><td><code class="literal"><parent-message></code></td><td>jump to parent message in thread</td></tr></tbody></table></div></div><br class="table-break" /><p>
358 Collapsing a thread displays only the first message
359 in the thread and hides the others. This is useful when threads
360 contain so many messages that you can only see a handful of threads on
361 the screen. See %M in <a class="link" href="#index-format" title="3.114. index_format">$index_format</a>.
362 For example, you could use “<span class="quote">%?M?(#%03M)&(%4l)?</span>” in <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> to optionally
363 display the number of hidden messages if the thread is
364 collapsed. The <code class="literal">%?<char>?<if-part>&<else-part>?</code>
365 syntax is explained in detail in
366 <a class="link" href="#formatstrings-conditionals" title="29.2. Conditionals">format string conditionals</a>.
368 Technically, every reply should contain a list of its parent messages in
369 the thread tree, but not all do. In these cases, Mutt groups them by
370 subject which can be controlled using the
371 <a class="link" href="#strict-threads" title="3.284. strict_threads">$strict_threads</a> variable.
372 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="reading-misc"></a>5.4. Miscellaneous Functions</h3></div></div></div><p>
373 In addition, the <span class="emphasis"><em>index</em></span> and <span class="emphasis"><em>pager</em></span>
374 menus have these interesting functions:
375 </p><div class="variablelist"><dl><dt><span class="term">
376 <code class="literal"><create-alias></code><a id="create-alias"></a> (default: a)
378 Creates a new alias based upon the current message (or prompts for a
379 new one). Once editing is complete, an <a class="link" href="#alias" title="4. Defining/Using Aliases"><span class="command"><strong>alias</strong></span></a>
380 command is added to the file specified by
381 the <a class="link" href="#alias-file" title="3.3. alias_file">$alias_file</a> variable
383 </p><div class="note"><h3 class="title">Note</h3><p>
384 Mutt does not read the <a class="link" href="#alias-file" title="3.3. alias_file">$alias_file</a>
385 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.
386 </p></div></dd><dt><span class="term">
387 <code class="literal"><check-traditional-pgp></code><a id="check-traditional-pgp"></a> (default: Esc P)
389 This function will search the current message for content signed or
390 encrypted with PGP the “<span class="quote">traditional</span>” way, that is, without proper
391 MIME tagging. Technically, this function will temporarily change
392 the MIME content types of the body parts containing PGP data; this
393 is similar to the <a class="link" href="#edit-type"><code class="literal"><edit-type></code></a> function's
395 </p></dd><dt><span class="term">
396 <code class="literal"><edit></code><a id="edit"></a> (default: e)
398 This command (available in the index and pager) allows you to
399 edit the raw current message as it's present in the mail folder.
400 After you have finished editing, the changed message will be
401 appended to the current folder, and the original message will be
402 marked for deletion; if the message is unchanged it won't be replaced.
403 </p></dd><dt><span class="term">
404 <code class="literal"><edit-type></code><a id="edit-type"></a> (default:
405 ^E on the attachment menu, and in the pager and index menus;
406 ^T on the compose menu)
408 This command is used to temporarily edit an attachment's content
409 type to fix, for instance, bogus character set parameters. When
410 invoked from the index or from the pager, you'll have the
411 opportunity to edit the top-level attachment's content type. On the
412 <a class="link" href="#attach-menu" title="1.2. The Attachment Menu">attachment menu</a>, you can change any
413 attachment's content type. These changes are not persistent, and get
414 lost upon changing folders.
416 Note that this command is also available on the <a class="link" href="#compose-menu" title="1.3. The Compose Menu">compose
417 menu</a>. There, it's used to fine-tune the properties of attachments you are going
419 </p></dd><dt><span class="term">
420 <code class="literal"><enter-command></code><a id="enter-command"></a> (default: “<span class="quote">:</span>”)
422 This command is used to execute any command you would normally put in a
423 configuration file. A common use is to check the settings of variables, or
424 in conjunction with <a class="link" href="#macro" title="8. Keyboard Macros">macros</a> to change settings on the
426 </p></dd><dt><span class="term">
427 <code class="literal"><extract-keys></code><a id="extract-keys"></a> (default: ^K)
429 This command extracts PGP public keys from the current or tagged
430 message(s) and adds them to your PGP public key ring.
431 </p></dd><dt><span class="term">
432 <code class="literal"><forget-passphrase></code><a id="forget-passphrase"></a> (default:
435 This command wipes the passphrase(s) from memory. It is useful, if
436 you misspelled the passphrase.
437 </p></dd><dt><span class="term">
438 <code class="literal"><list-reply></code><a id="list-reply"></a> (default: L)
440 Reply to the current or tagged message(s) by extracting any addresses which
441 match the regular expressions given by the <a class="link" href="#lists" title="12. Mailing Lists"><span class="command"><strong>lists</strong></span> or <span class="command"><strong>subscribe</strong></span></a>
442 commands, but also honor any <code class="literal">Mail-Followup-To</code> header(s) if the
443 <a class="link" href="#honor-followup-to" title="3.92. honor_followup_to">$honor_followup_to</a>
444 configuration variable is set. Using this when replying to messages posted
445 to mailing lists helps avoid duplicate copies being sent to the author of
446 the message you are replying to.
447 </p></dd><dt><span class="term">
448 <code class="literal"><pipe-message></code><a id="pipe-message"></a> (default: |)
450 Asks for an external Unix command and pipes the current or
451 tagged message(s) to it. The variables <a class="link" href="#pipe-decode" title="3.182. pipe_decode">$pipe_decode</a>, <a class="link" href="#pipe-split" title="3.184. pipe_split">$pipe_split</a>,
452 <a class="link" href="#pipe-sep" title="3.183. pipe_sep">$pipe_sep</a> and <a class="link" href="#wait-key" title="3.304. wait_key">$wait_key</a> control the exact behavior of this function.
453 </p></dd><dt><span class="term">
454 <code class="literal"><resend-message></code><a id="resend-message"></a> (default: Esc e)
456 Mutt takes the current message as a template for a
457 new message. This function is best described as "recall from arbitrary
458 folders". It can conveniently be used to forward MIME messages while
459 preserving the original mail structure. Note that the amount of headers
460 included here depends on the value of the <a class="link" href="#weed" title="3.305. weed">$weed</a>
463 This function is also available from the attachment menu. You can use this
464 to easily resend a message which was included with a bounce message
465 as a <code class="literal">message/rfc822</code> body part.
466 </p></dd><dt><span class="term">
467 <code class="literal"><shell-escape></code><a id="shell-escape"></a> (default: !)
469 Asks for an external Unix command and executes it. The <a class="link" href="#wait-key" title="3.304. wait_key">$wait_key</a> can be used to control
470 whether Mutt will wait for a key to be pressed when the command returns
471 (presumably to let the user read the output of the command), based on
472 the return status of the named command. If no command is given, an
473 interactive shell is executed.
474 </p></dd><dt><span class="term">
475 <code class="literal"><toggle-quoted></code><a id="toggle-quoted"></a> (default: T)
477 The pager uses the <a class="link" href="#quote-regexp" title="3.206. quote_regexp">$quote_regexp</a> variable to detect quoted text when
478 displaying the body of the message. This function toggles the display
479 of the quoted material in the message. It is particularly useful when
480 being interested in just the response and there is a large amount of
481 quoted text in the way.
482 </p></dd><dt><span class="term">
483 <code class="literal"><skip-quoted></code><a id="skip-quoted"></a> (default: S)
485 This function will go to the next line of non-quoted text which comes
486 after a line of quoted text in the internal pager.
487 </p></dd></dl></div></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="sending"></a>6. Sending Mail</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sending-intro"></a>6.1. Introduction</h3></div></div></div><p>
488 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 the
489 <span class="emphasis"><em>index</em></span> and <span class="emphasis"><em>pager</em></span> to start a new message.
490 </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"><compose></code></td><td>compose a new message</td></tr><tr><td>r</td><td><code class="literal"><reply></code></td><td>reply to sender</td></tr><tr><td>g</td><td><code class="literal"><group-reply></code></td><td>reply to all recipients</td></tr><tr><td>L</td><td><code class="literal"><list-reply></code></td><td>reply to mailing list address</td></tr><tr><td>f</td><td><code class="literal"><forward></code></td><td>forward message</td></tr><tr><td>b</td><td><code class="literal"><bounce></code></td><td>bounce (remail) message</td></tr><tr><td>Esc k</td><td><code class="literal"><mail-key></code></td><td>mail a PGP public key to someone</td></tr></tbody></table></div></div><br class="table-break" /><p>
491 <span class="emphasis"><em>Bouncing</em></span> a message sends the message as-is to the recipient you
492 specify. <span class="emphasis"><em>Forwarding</em></span> a message allows you to add comments or
493 modify the message you are forwarding. These items are discussed
494 in greater detail in the next section “<span class="quote"><a class="link" href="#forwarding-mail" title="7. Forwarding and Bouncing Mail">Forwarding
495 and Bouncing Mail</a>.</span>”
497 Mutt will then enter the <span class="emphasis"><em>compose</em></span> menu and prompt you for the
498 recipients to place on the “<span class="quote">To:</span>” header field when you hit <code class="literal">m</code> to start a new message. Next, it will ask
499 you for the “<span class="quote">Subject:</span>” field for the message, providing a default if
500 you are replying to or forwarding a message. You again
501 have the chance to adjust recipients, subject, and security settings
502 right before actually sending the message. See also
503 <a class="link" href="#askcc" title="3.10. askcc">$askcc</a>,
504 <a class="link" href="#askbcc" title="3.9. askbcc">$askbcc</a>,
505 <a class="link" href="#autoedit" title="3.18. autoedit">$autoedit</a>,
506 <a class="link" href="#bounce" title="3.21. bounce">$bounce</a>,
507 <a class="link" href="#fast-reply" title="3.63. fast_reply">$fast_reply</a>,
508 and <a class="link" href="#include" title="3.111. include">$include</a>
509 for changing how and if Mutt asks these questions.
511 When replying, Mutt fills these fields with proper values depending on
512 the reply type. The types of replying supported are:
513 </p><div class="variablelist"><dl><dt><span class="term">Simple reply</span></dt><dd><p>
514 Reply to the author directly.
515 </p></dd><dt><span class="term">Group reply</span></dt><dd><p>
516 Reply to the author as well to all recipients except you; this consults
517 <a class="link" href="#alternates" title="11. Alternative Addresses"><span class="command"><strong>alternates</strong></span></a>.
518 </p></dd><dt><span class="term">List reply</span></dt><dd><p>
519 Reply to all mailing list addresses found, either specified via
520 configuration or auto-detected. See <a class="xref" href="#lists" title="12. Mailing Lists">Section 12, “Mailing Lists”</a> for
522 </p></dd></dl></div><p>
523 After getting recipients for new messages, forwards or replies, Mutt
524 will then automatically start your <a class="link" href="#editor" title="3.58. editor">$editor</a> on the message body. If the <a class="link" href="#edit-headers" title="3.57. edit_headers">$edit_headers</a> variable is
525 set, the headers will be at the top of the message in your editor. Any
526 messages you are replying to will be added in sort order to the message,
527 with appropriate <a class="link" href="#attribution" title="3.16. attribution">$attribution</a>,
528 <a class="link" href="#indent-string" title="3.113. indent_string">$indent_string</a> and
529 <a class="link" href="#post-indent-string" title="3.194. post_indent_string">$post_indent_string</a>.
530 When forwarding a message, if the <a class="link" href="#mime-forward" title="3.140. mime_forward">$mime_forward</a> variable is
531 unset, a copy of the forwarded message will be included. If you have
532 specified a <a class="link" href="#signature" title="3.235. signature">$signature</a>, it will
533 be appended to the message.
535 Once you have finished editing the body of your mail message, you are
536 returned to the <span class="emphasis"><em>compose</em></span> menu providing the functions
537 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 postpone the
539 </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"><attach-file></code></td><td>attach a file</td></tr><tr><td>A</td><td><code class="literal"><attach-message></code></td><td>attach message(s) to the message</td></tr><tr><td>Esc k</td><td><code class="literal"><attach-key></code></td><td>attach a PGP public key</td></tr><tr><td>d</td><td><code class="literal"><edit-description></code></td><td>edit description on attachment</td></tr><tr><td>D</td><td><code class="literal"><detach-file></code></td><td>detach a file</td></tr><tr><td>t</td><td><code class="literal"><edit-to></code></td><td>edit the To field</td></tr><tr><td>Esc f</td><td><code class="literal"><edit-from></code></td><td>edit the From field</td></tr><tr><td>r</td><td><code class="literal"><edit-reply-to></code></td><td>edit the Reply-To field</td></tr><tr><td>c</td><td><code class="literal"><edit-cc></code></td><td>edit the Cc field</td></tr><tr><td>b</td><td><code class="literal"><edit-bcc></code></td><td>edit the Bcc field</td></tr><tr><td>y</td><td><code class="literal"><send-message></code></td><td>send the message</td></tr><tr><td>s</td><td><code class="literal"><edit-subject></code></td><td>edit the Subject</td></tr><tr><td>S</td><td><code class="literal"><smime-menu></code></td><td>select S/MIME options</td></tr><tr><td>f</td><td><code class="literal"><edit-fcc></code></td><td>specify an “<span class="quote">Fcc</span>” mailbox</td></tr><tr><td>p</td><td><code class="literal"><pgp-menu></code></td><td>select PGP options</td></tr><tr><td>P</td><td><code class="literal"><postpone-message></code></td><td>postpone this message until later</td></tr><tr><td>q</td><td><code class="literal"><quit></code></td><td>quit (abort) sending the message</td></tr><tr><td>w</td><td><code class="literal"><write-fcc></code></td><td>write the message to a folder</td></tr><tr><td>i</td><td><code class="literal"><ispell></code></td><td>check spelling (if available on your system)</td></tr><tr><td>^F</td><td><code class="literal"><forget-passphrase></code></td><td>wipe passphrase(s) from memory</td></tr></tbody></table></div></div><br class="table-break" /><p>
540 The compose menu is also used to edit the attachments for a message which can be either files
541 or other messages. The <code class="literal"><attach-message></code> function to will prompt you for a folder to
542 attach messages from. You can now tag messages in that folder and they
543 will be attached to the message you are sending.
544 </p><div class="note"><h3 class="title">Note</h3><p>
546 operations like composing a new mail, replying, forwarding, etc. are
547 not permitted when you are in that folder. The %r in
548 <a class="link" href="#status-format" title="3.282. status_format">$status_format</a> will change to
549 a “<span class="quote">A</span>” to indicate that you are in attach-message mode.
550 </p></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="edit-header"></a>6.2. Editing the Message Header</h3></div></div></div><p>
551 When editing the header because of <a class="link" href="#edit-headers" title="3.57. edit_headers">$edit_headers</a>
552 being set, there are a several pseudo headers available which
553 will not be included in sent messages but trigger special Mutt behavior.
554 </p><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="fcc-header"></a>6.2.1. Fcc: Pseudo Header</h4></div></div></div><p>
557 <code class="literal">Fcc:</code> <span class="emphasis"><em>filename</em></span>
559 as a header, Mutt will pick up <span class="emphasis"><em>filename</em></span>
560 just as if you had used the <code class="literal"><edit-fcc></code> function in the <span class="emphasis"><em>compose</em></span> menu.
561 It can later be changed from the compose menu.
562 </p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="attach-header"></a>6.2.2. Attach: Pseudo Header</h4></div></div></div><p>
563 You can also attach files to your message by specifying
565 <code class="literal">Attach:</code> <span class="emphasis"><em>filename</em></span>
566 [ <span class="emphasis"><em>description</em></span> ]
568 where <span class="emphasis"><em>filename</em></span> is the file to attach and <span class="emphasis"><em>description</em></span> is an
569 optional string to use as the description of the attached file. Spaces
570 in filenames have to be escaped using backslash (“<span class="quote">\</span>”).
571 The file can be removed as well as more added from the compose menu.
572 </p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="pgp-header"></a>6.2.3. Pgp: Pseudo Header</h4></div></div></div><p>
573 If you want to use PGP, you can specify
575 <code class="literal">Pgp:</code> [ <code class="literal">E</code> | <code class="literal">S</code> | <code class="literal">S</code><span class="emphasis"><em><id></em></span> ]
578 “<span class="quote">E</span>” selects encryption, “<span class="quote">S</span>” selects signing and
579 “<span class="quote">S<id></span>” selects signing with the given key, setting
580 <a class="link" href="#pgp-sign-as" title="3.174. pgp_sign_as">$pgp_sign_as</a>
581 permanently. The selection can later be changed in the compose menu.
582 </p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="in-reply-to-header"></a>6.2.4. In-Reply-To: Header</h4></div></div></div><p>
583 When replying to messages, the <span class="emphasis"><em>In-Reply-To:</em></span> header contains the
584 Message-Id of the message(s) you reply to. If you remove or modify its value, Mutt will not generate a
585 <span class="emphasis"><em>References:</em></span> field, which allows you to create a new message thread, for example
586 to create a new message to a mailing list without having to enter the mailing list's address.
587 </p></div></div><div class="sect2" lang="en" xml:lang="en"><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>
588 If you have told Mutt to PGP or S/MIME encrypt a message, it will guide you
589 through a key selection process when you try to send the message.
590 Mutt will not ask you any questions about keys which have a
591 certified user ID matching one of the message recipients' mail
592 addresses. However, there may be situations in which there are
593 several keys, weakly certified user ID fields, or where no matching
596 In these cases, you are dropped into a menu with a list of keys from
597 which you can select one. When you quit this menu, or Mutt can't
598 find any matching keys, you are prompted for a user ID. You can, as
599 usually, abort this prompt using <code class="literal">^G</code>. When you do so, Mutt will
600 return to the compose screen.
602 Once you have successfully finished the key selection, the message
603 will be encrypted using the selected public keys when sent out.
605 Most fields of the entries in the key selection menu (see also <a class="link" href="#pgp-entry-format" title="3.161. pgp_entry_format">$pgp_entry_format</a>)
606 have obvious meanings. But some explanations on the capabilities, flags,
607 and validity fields are in order.
609 The flags sequence (“<span class="quote">%f</span>”) will expand to one of the flags in
610 <a class="xref" href="#tab-pgp-menuflags" title="Table 2.13. PGP key menu flags">Table 2.13, “PGP key menu flags”</a>.
611 </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>
612 The capabilities field (“<span class="quote">%c</span>”) expands to a two-character sequence
613 representing a key's capabilities. The first character gives
614 the key's encryption capabilities: A minus sign (“<span class="quote">-</span>”) means
615 that the key cannot be used for encryption. A dot (“<span class="quote">.</span>”) means that
616 it's marked as a signature key in one of the user IDs, but may
617 also be used for encryption. The letter “<span class="quote">e</span>” indicates that
618 this key can be used for encryption.
620 The second character indicates the key's signing capabilities. Once
621 again, a “<span class="quote">-</span>” implies “<span class="quote">not for signing</span>”, “<span class="quote">.</span>” implies
622 that the key is marked as an encryption key in one of the user-ids, and
623 “<span class="quote">s</span>” denotes a key which can be used for signing.
625 Finally, the validity field (“<span class="quote">%t</span>”) indicates how well-certified a user-id
626 is. A question mark (“<span class="quote">?</span>”) indicates undefined validity, a minus
627 character (“<span class="quote">-</span>”) marks an untrusted association, a space character
628 means a partially trusted association, and a plus character (“<span class="quote">+</span>”)
629 indicates complete validity.
630 </p></div><div class="sect2" lang="en" xml:lang="en"><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" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="ff-concept"></a>6.4.1. Concept</h4></div></div></div><p>
631 <code class="literal">format=flowed</code>-style messages (or <code class="literal">f=f</code>
632 for short) are <code class="literal">text/plain</code> messages that consist of paragraphs which a receiver's
633 mail client may reformat to its own needs which mostly means to
634 customize line lengths regardless of what the sender sent. Technically this is
635 achieved by letting lines of a “<span class="quote">flowable</span>” paragraph end in spaces
636 except for the last line.
638 While for text-mode clients like Mutt it's the best way to assume only a
639 standard 80x25 character cell terminal, it may be desired to let the
640 receiver decide completely how to view a message.
641 </p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="ff-support"></a>6.4.2. Mutt Support</h4></div></div></div><p>
642 Mutt only supports setting the required <code class="literal">format=flowed</code>
643 MIME parameter on outgoing messages if the <a class="link" href="#text-flowed" title="3.286. text_flowed">$text_flowed</a>
644 variable is set, specifically it does not add the
647 After editing the initial message text and before entering
648 the compose menu, Mutt properly space-stuffes the message.
649 <span class="emphasis"><em>Space-stuffing</em></span> is required by RfC3676 defining
650 <code class="literal">format=flowed</code> and means to prepend a space to:
651 </p><div class="itemizedlist"><ul type="disc"><li><p>all lines starting with a space</p></li><li><p>lines starting with the word “<span class="quote"><code class="literal">From</code></span>”
652 followed by space</p></li><li><p>all lines starting with “<span class="quote"><code class="literal">></code></span>” which
653 is not intended to be a quote character</p></li></ul></div><div class="note"><h3 class="title">Note</h3><p>
654 Mutt only supports space-stuffing
655 for the first two types of lines but not for the third: It is impossible to
656 safely detect whether a leading <code class="literal">></code> character starts a
657 quote or not. Furthermore, Mutt only applies space-stuffing
658 <span class="emphasis"><em>once</em></span> after the initial edit is finished.
660 All leading spaces are to be removed by receiving clients to restore
661 the original message prior to further processing.
662 </p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="ff-editor"></a>6.4.3. Editor Considerations</h4></div></div></div><p>
663 As Mutt provides no additional features to compose <code class="literal">f=f</code>
664 messages, it's completely up to the user and his editor to produce
665 proper messages. Please consider your editor's documentation if you
666 intend to send <code class="literal">f=f</code> messages.
668 Please note that when editing messages from the compose menu several
669 times before really sending a mail, it's up to the user to ensure that
670 the message is properly space-stuffed.
672 For example, <span class="emphasis"><em>vim</em></span> provides the <code class="literal">w</code>
673 flag for its <code class="literal">formatoptions</code> setting to assist in
674 creating <code class="literal">f=f</code> messages, see <code class="literal">:help
675 fo-table</code> for details.
676 </p></div></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="forwarding-mail"></a>7. Forwarding and Bouncing Mail</h2></div></div></div><p>
677 Bouncing and forwarding let you send an existing message to recipients
678 that you specify. Bouncing a message sends a verbatim copy of a message
679 to alternative addresses as if they were the message's original
680 recipients specified in the Bcc header.
681 Forwarding a message, on the other hand, allows you to modify the message
682 before it is resent (for example, by adding your own comments). Bouncing
683 is done using the <code class="literal"><bounce></code> function and forwarding
684 using the <code class="literal"><forward></code> function bound to “<span class="quote">b</span>” and “<span class="quote">f</span>”
687 Forwarding can be done by including the original message in the new
688 message's body (surrounded by indicating lines) or including it as a MIME
689 attachment, depending on the value of the <a class="link" href="#mime-forward" title="3.140. mime_forward">$mime_forward</a> variable. Decoding of attachments,
690 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.141. mime_forward_decode">$mime_forward_decode</a> variables,
691 respectively. The desired forwarding format may depend on the content,
692 therefore <a class="link" href="#mime-forward" title="3.140. mime_forward">$mime_forward</a> is a quadoption which, for
693 example, can be set to “<span class="quote">ask-no</span>”.
695 The inclusion of headers is controlled by the current setting of the
696 <a class="link" href="#weed" title="3.305. weed">$weed</a> variable, unless <a class="link" href="#mime-forward" title="3.140. mime_forward">$mime_forward</a> is set.
698 Editing the message to forward follows the same procedure as sending or
699 replying to a message does.
700 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="postponing-mail"></a>8. Postponing Mail</h2></div></div></div><p>
701 At times it is desirable to delay sending a message that you have
702 already begun to compose. When the <code class="literal"><postpone-message></code> function is
703 used in the <span class="emphasis"><em>compose</em></span> menu, the body of your message and attachments
704 are stored in the mailbox specified by the <a class="link" href="#postponed" title="3.196. postponed">$postponed</a> variable. This means that you can recall the
705 message even if you exit Mutt and then restart it at a later time.
707 Once a message is postponed, there are several ways to resume it. From the
708 command line you can use the “<span class="quote">-p</span>” option, or if you compose a new
709 message from the <span class="emphasis"><em>index</em></span> or <span class="emphasis"><em>pager</em></span> you will be prompted if postponed
710 messages exist. If multiple messages are currently postponed, the
711 <span class="emphasis"><em>postponed</em></span> menu will pop up and you can select which message you would
713 </p><div class="note"><h3 class="title">Note</h3><p>
714 If you postpone a reply to a message, the reply setting of
715 the message is only updated when you actually finish the message and
716 send it. Also, you must be in the same folder with the message you
717 replied to for the status of the message to be updated.
719 See also the <a class="link" href="#postpone" title="3.195. postpone">$postpone</a> quad-option.
720 </p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="configuration"></a>Chapter 3. Configuration</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#configuration-files">1. Location of Initialization Files</a></span></dt><dt><span class="sect1"><a href="#muttrc-syntax">2. Syntax of Initialization Files</a></span></dt><dt><span class="sect1"><a href="#addrgroup">3. Address Groups</a></span></dt><dt><span class="sect1"><a href="#alias">4. Defining/Using Aliases</a></span></dt><dt><span class="sect1"><a href="#bind">5. Changing the Default Key Bindings</a></span></dt><dt><span class="sect1"><a href="#charset-hook">6. Defining Aliases for Character Sets</a></span></dt><dt><span class="sect1"><a href="#folder-hook">7. Setting Variables Based Upon Mailbox</a></span></dt><dt><span class="sect1"><a href="#macro">8. Keyboard Macros</a></span></dt><dt><span class="sect1"><a href="#color">9. Using Color and Mono Video Attributes</a></span></dt><dt><span class="sect1"><a href="#msg-hdr-display">10. Message Header Display</a></span></dt><dd><dl><dt><span class="sect2"><a href="#ignore">10.1. Selecting Headers</a></span></dt><dt><span class="sect2"><a href="#hdr-order">10.2. 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></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" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="configuration-files"></a>1. Location of Initialization Files</h2></div></div></div><p>
721 While the default configuration (or “<span class="quote">preferences</span>”) make Mutt
722 usable right out of the box, it is often desirable to tailor Mutt to
723 suit your own tastes. When Mutt is first invoked, it will attempt to
724 read the “<span class="quote">system</span>” configuration file (defaults set by your local
725 system administrator), unless the “<span class="quote">-n</span>” <a class="link" href="#commandline" title="1. Command-Line Options">command line</a> option is specified. This file is typically
726 <code class="literal">/usr/local/share/mutt/Muttrc</code> or <code class="literal">/etc/Muttrc</code>. Mutt
727 will next look for a file named <code class="literal">.muttrc</code> in your home
728 directory. If this file does not exist and your home directory has
729 a subdirectory named <code class="literal">.mutt</code>, Mutt tries to load a file named
730 <code class="literal">.mutt/muttrc</code>.
732 <code class="literal">.muttrc</code> is the file where you will usually place your <a class="link" href="#commands" title="2. Configuration Commands">commands</a> to configure Mutt.
734 In addition, Mutt supports version specific configuration files that are
735 parsed instead of the default files as explained above. For instance, if
736 your system has a <code class="literal">Muttrc-0.88</code> file in the system configuration
737 directory, and you are running version 0.88 of Mutt, this file will be
738 sourced instead of the <code class="literal">Muttrc</code> file. The same is true of the user
739 configuration file, if you have a file <code class="literal">.muttrc-0.88.6</code> in your home
740 directory, when you run Mutt version 0.88.6, it will source this file
741 instead of the default <code class="literal">.muttrc</code> file. The version number is the
742 same which is visible using the “<span class="quote">-v</span>” <a class="link" href="#commandline" title="1. Command-Line Options">command line</a> switch or using the <code class="literal">show-version</code> key (default:
743 V) from the index menu.
744 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="muttrc-syntax"></a>2. Syntax of Initialization Files</h2></div></div></div><p>
745 An initialization file consists of a series of <a class="link" href="#commands" title="2. Configuration Commands">commands</a>. Each line of the file may contain one or more commands.
746 When multiple commands are used, they must be separated by a semicolon
747 (“<span class="quote">;</span>”).
748 </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">
749 set realname='Mutt user' ; ignore x-
750 </pre></div></div><br class="example-break" /><p>
751 The hash mark, or pound sign
752 (“<span class="quote">#</span>”), is used as a “<span class="quote">comment</span>” character. You can use it to
753 annotate your initialization file. All text after the comment character
754 to the end of the line is ignored.
755 </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">
756 my_hdr X-Disclaimer: Why are you listening to me? # This is a comment
757 </pre></div></div><br class="example-break" /><p>
758 Single quotes (“<span class="quote">'</span>”) and double quotes (“<span class="quote">"</span>”) can be used to quote strings
759 which contain spaces or other special characters. The difference between
760 the two types of quotes is similar to that of many popular shell programs,
761 namely that a single quote is used to specify a literal string (one that is
762 not interpreted for shell variables or quoting with a backslash [see
763 next paragraph]), while double quotes indicate a string for which
764 should be evaluated. For example, backticks are evaluated inside of double
765 quotes, but <span class="emphasis"><em>not</em></span> for single quotes.
767 “<span class="quote">\</span>” quotes the next character, just as in shells such as bash and zsh.
768 For example, if want to put quotes “<span class="quote">"</span>” inside of a string, you can use
769 “<span class="quote">\</span>” to force the next character to be a literal instead of interpreted
771 </p><div class="example"><a id="ex-rc-quote"></a><p class="title"><b>Example 3.3. Escaping quotes in congfiguration files</b></p><div class="example-contents"><pre class="screen">
772 set realname="Michael \"MuttDude\" Elkins"
773 </pre></div></div><br class="example-break" /><p>
774 “<span class="quote">\\</span>” means to insert a literal “<span class="quote">\</span>” into the line.
775 “<span class="quote">\n</span>” and “<span class="quote">\r</span>” have their usual C meanings of linefeed and
776 carriage-return, respectively.
778 A “<span class="quote">\</span>” at the end of a line can be used to split commands over
779 multiple lines as it “<span class="quote">escapes</span>” the line end, provided that the split points don't appear in the
780 middle of command names. Lines are first concatenated before
781 interpretation so that a multi-line can be commented by commenting out
783 </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">
784 set status_format="some very \
787 </pre></div></div><br class="example-break" /><p>
788 It is also possible to substitute the output of a Unix command in an
789 initialization file. This is accomplished by enclosing the command in
790 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
791 Unix command “<span class="quote">uname -a</span>” will be substituted before the
793 Since initialization files are line oriented, only
794 the first line of output from the Unix command will be substituted.
795 </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">
796 my_hdr X-Operating-System: `uname -a`
797 </pre></div></div><br class="example-break" /><p>
798 Both environment variables and Mutt variables can be accessed by
799 prepending “<span class="quote">$</span>” to the name of the variable. For example,
800 </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">
801 set record=+sent_on_$HOSTNAME
802 </pre></div></div><br class="example-break" /><p>
803 will cause Mutt to save outgoing messages to a folder named
804 “<span class="quote">sent_on_kremvax</span>” if the environment variable <code class="literal">$HOSTNAME</code> is set to
805 “<span class="quote">kremvax.</span>” (See <a class="link" href="#record" title="3.211. record">$record</a> for
808 Mutt expands the variable when it is assigned, not when it is used. If
809 the value of a variable on the right-hand side of an assignment
810 changes after the assignment, the variable on the left-hand side will
813 The commands understood by Mutt are explained in the next paragraphs.
814 For a complete list, see the <a class="link" href="#commands" title="2. Configuration Commands">command reference</a>.
816 All configuration files are expected to be in the current locale as
817 specified by the <a class="link" href="#charset" title="3.25. charset">$charset</a> variable
818 which doesn't have a default value since it's determined by Mutt at startup.
819 If a configuration file is not encoded in the same character set the
820 <a class="link" href="#config-charset" title="3.30. config_charset">$config_charset</a>
821 variable should be used: all lines starting with the next are recoded
822 from <a class="link" href="#config-charset" title="3.30. config_charset">$config_charset</a>
823 to <a class="link" href="#charset" title="3.25. charset">$charset</a>.
825 This mechanism should be avoided if possible as it has the
826 following implications:
827 </p><div class="itemizedlist"><ul type="disc"><li><p>These variables should be set early in a configuration
828 file with <a class="link" href="#charset" title="3.25. charset">$charset</a> preceding
829 <a class="link" href="#config-charset" title="3.30. config_charset">$config_charset</a> so Mutt
830 knows what character set to convert to.</p></li><li><p>If <a class="link" href="#config-charset" title="3.30. config_charset">$config_charset</a> is set, it should be set
831 in each configuration file because the value is global and <span class="emphasis"><em>not</em></span>
832 per configuration file.</p></li><li><p>Because Mutt first recodes a line before it attempts to parse it,
833 a conversion introducing question marks or other characters as
834 part of errors (unconvertable characters, transliteration) may introduce syntax
835 errors or silently change the meaning of certain tokens (e.g. inserting
836 question marks into regular expressions).</p></li></ul></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="addrgroup"></a>3. Address Groups</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">group</code> [
837 <code class="option">-group</code>
838 <em class="replaceable"><code>name</code></em>
840 <code class="option">-rx</code>
841 <em class="replaceable"><code>expr</code></em>
843 <code class="option">-addr</code>
844 <em class="replaceable"><code>expr</code></em>
845 ... }<br /><code class="command">ungroup</code> [
846 <code class="option">-group</code>
847 <em class="replaceable"><code>name</code></em>
849 <em class="replaceable"><code>*</code></em>
851 <code class="option">-rx</code>
852 <em class="replaceable"><code>expr</code></em>
854 <code class="option">-addr</code>
855 <em class="replaceable"><code>expr</code></em>
857 <span class="command"><strong>group</strong></span> is used to directly add either addresses or
858 regular expressions to the specified group or groups. The different
859 categories of arguments to the <span class="command"><strong>group</strong></span> command can be
860 in any order. The flags <code class="literal">-rx</code> and
861 <code class="literal">-addr</code> specify what the following strings (that cannot
862 begin with a hyphen) should be interpreted as: either a regular
863 expression or an email address, respectively.
865 These address groups can also be created implicitly by the
866 <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">lists</a>,
867 <a class="link" href="#lists" title="12. Mailing Lists">subscribe</a> and
868 <a class="link" href="#alternates" title="11. Alternative Addresses"><span class="command"><strong>alternates</strong></span></a> commands by specifying the
869 optional <code class="literal">-group</code> option.
871 Once defined, these address groups can be used in
872 <a class="link" href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">patterns</a> to search for and limit the
873 display to messages matching a group.
875 <span class="command"><strong>ungroup</strong></span> is used to remove addresses or regular
876 expressions from the specified group or groups. The syntax is similar to
877 the <span class="command"><strong>group</strong></span> command, however the special character
878 <code class="literal">*</code> can be used to empty a group of all of its
880 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="alias"></a>4. Defining/Using Aliases</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">alias</code> [
881 <code class="option">-group</code>
882 <em class="replaceable"><code>name</code></em>
884 <em class="replaceable"><code>key</code></em>
886 <em class="replaceable"><code>address</code></em>
888 <em class="replaceable"><code>address</code></em>
889 ...]<br /><code class="command">unalias</code> [
890 <code class="option">-group</code>
891 <em class="replaceable"><code>name</code></em>
893 <em class="replaceable"><code>*</code></em>
895 <em class="replaceable"><code>key</code></em>
897 It's usually very cumbersome to remember or type out the address of someone
898 you are communicating with. Mutt allows you to create “<span class="quote">aliases</span>” which map
899 a short string to a full address.
900 </p><div class="note"><h3 class="title">Note</h3><p>
901 If you want to create an alias for more than
902 one address, you <span class="emphasis"><em>must</em></span> separate the addresses with a comma (“<span class="quote">,</span>”).
904 The optional <code class="literal">-group</code> argument to
905 <span class="command"><strong>alias</strong></span> causes the aliased address(es) to be added to
906 the named <span class="emphasis"><em>group</em></span>.
908 To remove an alias or aliases (“<span class="quote">*</span>” means all aliases):
909 </p><pre class="screen">
910 alias muttdude me@cs.hmc.edu (Michael Elkins)
911 alias theguys manny, moe, jack
913 Unlike other mailers, Mutt doesn't require aliases to be defined
914 in a special file. The <span class="command"><strong>alias</strong></span> command can appear anywhere in
915 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 can have multiple alias files, or
916 you can have all aliases defined in your <code class="literal">.muttrc</code>.
918 On the other hand, the <a class="link" href="#create-alias"><code class="literal"><create-alias></code></a>
919 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
920 <code class="literal">˜/.muttrc</code> by default). This file is not special either,
921 in the sense that Mutt will happily append aliases to any file, but in
922 order for the new aliases to take effect you need to explicitly <a class="link" href="#source" title="27. Reading Initialization Commands From Another File"><span class="command"><strong>source</strong></span></a> this file too.
923 </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">
924 source /usr/local/share/Mutt.aliases
925 source ~/.mail_aliases
926 set alias_file=~/.mail_aliases
927 </pre></div></div><br class="example-break" /><p>
928 To use aliases, you merely use the alias at any place in Mutt where Mutt
929 prompts for addresses, such as the <span class="emphasis"><em>To:</em></span> or <span class="emphasis"><em>Cc:</em></span> prompt. You can
930 also enter aliases in your editor at the appropriate headers if you have the
931 <a class="link" href="#edit-headers" title="3.57. edit_headers">$edit_headers</a> variable set.
933 In addition, at the various address prompts, you can use the tab character
934 to expand a partial alias to the full alias. If there are multiple matches,
935 Mutt will bring up a menu with the matching aliases. In order to be
936 presented with the full list of aliases, you must hit tab without a partial
937 alias, such as at the beginning of the prompt or after a comma denoting
940 In the alias menu, you can select as many aliases as you want with the
941 <code class="literal">select-entry</code> key (default: <Return>), and use the
942 <span class="emphasis"><em>exit</em></span> key (default: q) to return to the address prompt.
943 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="bind"></a>5. Changing the Default Key Bindings</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">bind</code>
944 <em class="replaceable"><code>map</code></em>
946 <em class="replaceable"><code>key</code></em>
948 <em class="replaceable"><code>function</code></em>
950 This command allows you to change the default key bindings (operation
951 invoked when pressing a key).
953 <span class="emphasis"><em>map</em></span> specifies in which menu the binding belongs. Multiple maps may
954 be specified by separating them with commas (no additional whitespace is
955 allowed). The currently defined maps are:
956 </p><a id="maps"></a><div class="variablelist"><dl><dt><span class="term">generic</span></dt><dd><p>
957 This is not a real menu, but is used as a fallback for all of the other
958 menus except for the pager and editor modes. If a key is not defined in
959 another menu, Mutt will look for a binding to use in this menu. This allows
960 you to bind a key to a certain function in multiple menus instead of having
961 multiple <span class="command"><strong>bind</strong></span> statements to accomplish the same task.
962 </p></dd><dt><span class="term">alias</span></dt><dd><p>
963 The alias menu is the list of your personal aliases as defined in your
964 <code class="literal">.muttrc</code>. It is the mapping from a short alias name to the full email
965 address(es) of the recipient(s).
966 </p></dd><dt><span class="term">attach</span></dt><dd><p>
967 The attachment menu is used to access the attachments on received messages.
968 </p></dd><dt><span class="term">browser</span></dt><dd><p>
969 The browser is used for both browsing the local directory structure, and for
970 listing all of your incoming mailboxes.
971 </p></dd><dt><span class="term">editor</span></dt><dd><p>
972 The editor is the line-based editor the user enters text data.
973 </p></dd><dt><span class="term">index</span></dt><dd><p>
974 The index is the list of messages contained in a mailbox.
975 </p></dd><dt><span class="term">compose</span></dt><dd><p>
976 The compose menu is the screen used when sending a new message.
977 </p></dd><dt><span class="term">pager</span></dt><dd><p>
978 The pager is the mode used to display message/attachment data, and help
980 </p></dd><dt><span class="term">pgp</span></dt><dd><p>
981 The pgp menu is used to select the OpenPGP keys used to encrypt outgoing
983 </p></dd><dt><span class="term">smime</span></dt><dd><p>
984 The smime menu is used to select the OpenSSL certificates used to encrypt outgoing
986 </p></dd><dt><span class="term">postpone</span></dt><dd><p>
987 The postpone menu is similar to the index menu, except is used when
988 recalling a message the user was composing, but saved until later.
989 </p></dd><dt><span class="term">query</span></dt><dd><p>
990 The query menu is the browser for results returned by
991 <a class="link" href="#query-command" title="3.203. query_command">$query_command</a>.
992 </p></dd><dt><span class="term">mix</span></dt><dd><p>
993 The mixmaster screen is used to select remailer options for outgoing
994 messages (if Mutt is compiled with Mixmaster support).
995 </p></dd></dl></div><p>
996 <span class="emphasis"><em>key</em></span> is the key (or key sequence) you wish to bind. To specify a
997 control character, use the sequence <span class="emphasis"><em>\Cx</em></span>, where <span class="emphasis"><em>x</em></span> is the
998 letter of the control character (for example, to specify control-A use
999 “<span class="quote">\Ca</span>”). Note that the case of <span class="emphasis"><em>x</em></span> as well as <span class="emphasis"><em>\C</em></span> is
1000 ignored, so that <span class="emphasis"><em>\CA</em></span>, <span class="emphasis"><em>\Ca</em></span>, <span class="emphasis"><em>\cA</em></span> and <span class="emphasis"><em>\ca</em></span> are all
1001 equivalent. An alternative form is to specify the key as a three digit
1002 octal number prefixed with a “<span class="quote">\</span>” (for example <span class="emphasis"><em>\177</em></span> is
1003 equivalent to <span class="emphasis"><em>\c?</em></span>). In addition, <span class="emphasis"><em>key</em></span> may
1004 be a symbolic name as shown in <a class="xref" href="#tab-key-names" title="Table 3.1. Symbolic key names">Table 3.1, “Symbolic key names”</a>.
1005 </p><div class="table"><a id="tab-key-names"></a><p class="title"><b>Table 3.1. Symbolic key names</b></p><div class="table-contents"><table summary="Symbolic key names" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Symbolic name</th><th>Meaning</th></tr></thead><tbody><tr><td>\t</td><td>tab</td></tr><tr><td><tab></td><td>tab</td></tr><tr><td><backtab></td><td>backtab / shift-tab</td></tr><tr><td>\r</td><td>carriage return</td></tr><tr><td>\n</td><td>newline</td></tr><tr><td>\e</td><td>escape</td></tr><tr><td><esc></td><td>escape</td></tr><tr><td><up></td><td>up arrow</td></tr><tr><td><down></td><td>down arrow</td></tr><tr><td><left></td><td>left arrow</td></tr><tr><td><right></td><td>right arrow</td></tr><tr><td><pageup></td><td>Page Up</td></tr><tr><td><pagedown></td><td>Page Down</td></tr><tr><td><backspace></td><td>Backspace</td></tr><tr><td><delete></td><td>Delete</td></tr><tr><td><insert></td><td>Insert</td></tr><tr><td><enter></td><td>Enter</td></tr><tr><td><return></td><td>Return</td></tr><tr><td><home></td><td>Home</td></tr><tr><td><end></td><td>End</td></tr><tr><td><space></td><td>Space bar</td></tr><tr><td><f1></td><td>function key 1</td></tr><tr><td><f10></td><td>function key 10</td></tr></tbody></table></div></div><br class="table-break" /><p>
1006 <span class="emphasis"><em>key</em></span> does not need to be enclosed in quotes unless it contains a
1007 space (“<span class="quote"> </span>”) or semi-colon (“<span class="quote">;</span>”).
1009 <span class="emphasis"><em>function</em></span> specifies which action to take when <span class="emphasis"><em>key</em></span> is pressed.
1010 For a complete list of functions, see the <a class="link" href="#functions" title="4. Functions">reference</a>. The special function <code class="literal"><noop></code> unbinds the specified key
1012 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="charset-hook"></a>6. Defining Aliases for Character Sets</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">charset-hook</code>
1013 <em class="replaceable"><code>alias</code></em>
1015 <em class="replaceable"><code>charset</code></em>
1016 <br /><code class="command">iconv-hook<a id="iconv-hook"></a></code>
1017 <em class="replaceable"><code>charset</code></em>
1019 <em class="replaceable"><code>local-charset</code></em>
1021 The <span class="command"><strong>charset-hook</strong></span> command defines an alias for a character set.
1022 This is useful to properly display messages which are tagged with a
1023 character set name not known to Mutt.
1025 The <span class="command"><strong>iconv-hook</strong></span> command defines a system-specific name for a
1026 character set. This is helpful when your systems character
1027 conversion library insists on using strange, system-specific names
1029 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="folder-hook"></a>7. Setting Variables Based Upon Mailbox</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">folder-hook</code>
1030 <em class="replaceable"><code>[!]regexp</code></em>
1032 <em class="replaceable"><code>command</code></em>
1034 It is often desirable to change settings based on which mailbox you are
1035 reading. The <span class="command"><strong>folder-hook</strong></span> command provides a method by which you can execute
1036 any configuration command. <span class="emphasis"><em>regexp</em></span> is a regular expression specifying
1037 in which mailboxes to execute <span class="emphasis"><em>command</em></span> before loading. If a mailbox
1038 matches multiple <span class="command"><strong>folder-hook</strong></span>s, they are executed in the order given in the
1039 <code class="literal">.muttrc</code>.
1040 </p><div class="note"><h3 class="title">Note</h3><p>
1041 If you use the “<span class="quote">!</span>” shortcut for <a class="link" href="#spoolfile" title="3.269. spoolfile">$spoolfile</a> at the beginning of the pattern, you must place it
1042 inside of double or single quotes in order to distinguish it from the
1043 logical <span class="emphasis"><em>not</em></span> operator for the expression.
1044 </p></div><div class="note"><h3 class="title">Note</h3><p>
1045 Settings are <span class="emphasis"><em>not</em></span> restored when you leave the mailbox.
1046 For example, a command action to perform is to change the sorting method
1047 based upon the mailbox being read:
1049 </p><pre class="screen">
1050 folder-hook mutt "set sort=threads"</pre><p>
1052 However, the sorting method is not restored to its previous value when
1053 reading a different mailbox. To specify a <span class="emphasis"><em>default</em></span> command, use the
1054 pattern “<span class="quote">.</span>” before other <span class="command"><strong>folder-hook</strong></span>s adjusting a value on a per-folder basis
1055 because <span class="command"><strong>folder-hook</strong></span>s are evaluated in the order given in the
1058 The following example will set the <a class="link" href="#sort" title="3.263. sort">sort</a> variable
1059 to <code class="literal">date-sent</code> for all folders but to <code class="literal">threads</code>
1060 for all folders containing “<span class="quote">mutt</span>” in their name.
1061 </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">
1062 folder-hook . "set sort=date-sent"
1063 folder-hook mutt "set sort=threads"
1064 </pre></div></div><br class="example-break" /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="macro"></a>8. Keyboard Macros</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">macro</code>
1065 <em class="replaceable"><code>menu</code></em>
1067 <em class="replaceable"><code>key</code></em>
1069 <em class="replaceable"><code>sequence</code></em>
1071 <em class="replaceable"><code>description</code></em>
1073 Macros are useful when you would like a single key to perform a series of
1074 actions. When you press <span class="emphasis"><em>key</em></span> in menu <span class="emphasis"><em>menu</em></span>, Mutt will behave as if
1075 you had typed <span class="emphasis"><em>sequence</em></span>. So if you have a common sequence of commands
1076 you type, you can create a macro to execute those commands with a single
1079 <span class="emphasis"><em>menu</em></span> is the <a class="link" href="#maps">map</a> which the macro will be bound in.
1080 Multiple maps may be specified by separating multiple menu arguments by
1081 commas. Whitespace may not be used in between the menu arguments and the
1082 commas separating them.
1084 <span class="emphasis"><em>key</em></span> and <span class="emphasis"><em>sequence</em></span> are expanded by the same rules as the
1085 <a class="link" href="#bind" title="5. Changing the Default Key Bindings">key bindings</a> with some additions. The
1086 first is that control characters in <span class="emphasis"><em>sequence</em></span> can also be specified
1087 as <span class="emphasis"><em>^x</em></span>. In order to get a caret (“<span class="quote">^</span>”) you need to use
1088 <span class="emphasis"><em>^^</em></span>. Secondly, to specify a certain key such as <span class="emphasis"><em>up</em></span>
1089 or to invoke a function directly, you can use the format
1090 <span class="emphasis"><em><key name></em></span> and <span class="emphasis"><em><function name></em></span>. For a listing of key
1091 names see the section on <a class="link" href="#bind" title="5. Changing the Default Key Bindings">key bindings</a>. Functions
1092 are listed in the <a class="link" href="#functions" title="4. Functions">reference</a>.
1094 The advantage with using function names directly is that the macros will
1095 work regardless of the current key bindings, so they are not dependent on
1096 the user having particular key definitions. This makes them more robust
1097 and portable, and also facilitates defining of macros in files used by more
1098 than one user (e.g., the system Muttrc).
1100 Optionally you can specify a descriptive text after <span class="emphasis"><em>sequence</em></span>,
1101 which is shown in the help screens if they contain a description.
1102 </p><div class="note"><h3 class="title">Note</h3><p>
1103 Macro definitions (if any) listed in the help screen(s), are
1104 silently truncated at the screen width, and are not wrapped.
1105 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="color"></a>9. Using Color and Mono Video Attributes</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">color</code>
1106 <em class="replaceable"><code>object</code></em>
1108 <em class="replaceable"><code>foreground</code></em>
1110 <em class="replaceable"><code>background</code></em>
1111 <br /><code class="command">color</code> {
1112 <code class="option">header</code>
1114 <code class="option">body</code>
1116 <em class="replaceable"><code>foreground</code></em>
1118 <em class="replaceable"><code>background</code></em>
1120 <em class="replaceable"><code>regexp</code></em>
1121 <br /><code class="command">color</code>
1122 <code class="option">index</code>
1124 <em class="replaceable"><code>foreground</code></em>
1126 <em class="replaceable"><code>background</code></em>
1128 <em class="replaceable"><code>pattern</code></em>
1129 <br /><code class="command">uncolor</code> {
1130 <code class="option">index</code>
1132 <code class="option">header</code>
1134 <code class="option">body</code>
1136 <em class="replaceable"><code>*</code></em>
1138 <em class="replaceable"><code>pattern</code></em>
1140 If your terminal supports color, you can spice up Mutt by creating your own
1141 color scheme. To define the color of an object (type of information), you
1142 must specify both a foreground color <span class="emphasis"><em>and</em></span> a background color (it is not
1143 possible to only specify one or the other).
1145 <span class="emphasis"><em>header</em></span> and <span class="emphasis"><em>body</em></span> match <span class="emphasis"><em>regexp</em></span>
1146 in the header/body of a message, <span class="emphasis"><em>index</em></span> matches <span class="emphasis"><em>pattern</em></span>
1147 (see <a class="xref" href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">Section 2, “Patterns: Searching, Limiting and Tagging”</a>) in the message index.
1149 <span class="emphasis"><em>object</em></span> can be one of:
1150 </p><div class="itemizedlist"><ul type="disc"><li><p>attachment</p></li><li><p>bold (hiliting bold patterns in the body of messages)</p></li><li><p>error (error messages printed by Mutt)</p></li><li><p>hdrdefault (default color of the message header in the pager)</p></li><li><p>indicator (arrow or bar used to indicate the current item in a menu)</p></li><li><p>markers (the “<span class="quote">+</span>” markers at the beginning of wrapped lines in the pager)</p></li><li><p>message (informational messages)</p></li><li><p>normal</p></li><li><p>quoted (text matching <a class="link" href="#quote-regexp" title="3.206. quote_regexp">$quote_regexp</a> in the body of a message)</p></li><li><p>quoted1, quoted2, ..., quoted<span class="emphasis"><em>N</em></span> (higher levels of quoting)</p></li><li><p>search (hiliting of words in the pager)</p></li><li><p>signature</p></li><li><p>status (mode lines used to display info about the mailbox or message)</p></li><li><p>tilde (the “<span class="quote">˜</span>” used to pad blank lines in the pager)</p></li><li><p>tree (thread tree drawn in the message index and attachment menu)</p></li><li><p>underline (hiliting underlined patterns in the body of messages)</p></li></ul></div><p>
1151 <span class="emphasis"><em>foreground</em></span> and <span class="emphasis"><em>background</em></span> can be one of the following:
1152 </p><div class="itemizedlist"><ul type="disc"><li><p>white</p></li><li><p>black</p></li><li><p>green</p></li><li><p>magenta</p></li><li><p>blue</p></li><li><p>cyan</p></li><li><p>yellow</p></li><li><p>red</p></li><li><p>default</p></li><li><p>color<span class="emphasis"><em>x</em></span></p></li></ul></div><p>
1153 <span class="emphasis"><em>foreground</em></span> can optionally be prefixed with the keyword <code class="literal">bright</code> to make
1154 the foreground color boldfaced (e.g., <code class="literal">brightred</code>).
1156 If your terminal supports it, the special keyword <span class="emphasis"><em>default</em></span> can be
1157 used as a transparent color. The value <span class="emphasis"><em>brightdefault</em></span> is also valid.
1158 If Mutt is linked against the <span class="emphasis"><em>S-Lang</em></span> library, you also need to set
1159 the <code class="literal">$COLORFGBG</code> environment variable to the default colors of your
1160 terminal for this to work; for example (for Bourne-like shells):
1161 </p><pre class="screen">
1162 set COLORFGBG="green;black"
1164 </pre><div class="note"><h3 class="title">Note</h3><p>
1165 The <span class="emphasis"><em>S-Lang</em></span> library requires you to use the <span class="emphasis"><em>lightgray</em></span>
1166 and <span class="emphasis"><em>brown</em></span> keywords instead of <span class="emphasis"><em>white</em></span> and <span class="emphasis"><em>yellow</em></span> when
1167 setting this variable.
1168 </p></div><div class="note"><h3 class="title">Note</h3><p>
1169 The <span class="command"><strong>uncolor</strong></span> command can be applied to the index, header and body objects only. It
1170 removes entries from the list. You <span class="emphasis"><em>must</em></span> specify the same pattern
1171 specified in the <span class="command"><strong>color</strong></span> command for it to be removed. The pattern “<span class="quote">*</span>” is
1172 a special token which means to clear the color list of all entries.
1174 Mutt also recognizes the keywords <span class="emphasis"><em>color0</em></span>, <span class="emphasis"><em>color1</em></span>, …,
1175 <span class="emphasis"><em>color</em></span><span class="emphasis"><em>N-1</em></span> (<span class="emphasis"><em>N</em></span> being the number of colors supported
1176 by your terminal). This is useful when you remap the colors for your
1177 display (for example by changing the color associated with <span class="emphasis"><em>color2</em></span>
1178 for your xterm), since color names may then lose their normal meaning.
1179 </p><a id="mono"></a><p>
1180 If your terminal does not support color, it is still possible change the video
1181 attributes through the use of the “<span class="quote">mono</span>” command. Usage:
1182 </p><div class="cmdsynopsis"><p><code class="command">mono</code>
1183 <em class="replaceable"><code>object</code></em>
1185 <em class="replaceable"><code>attribute</code></em>
1186 <br /><code class="command">mono</code> {
1187 <code class="option">header</code>
1189 <code class="option">body</code>
1191 <em class="replaceable"><code>attribute</code></em>
1193 <em class="replaceable"><code>regexp</code></em>
1194 <br /><code class="command">mono</code>
1195 <code class="option">index</code>
1197 <em class="replaceable"><code>attribute</code></em>
1199 <em class="replaceable"><code>pattern</code></em>
1200 <br /><code class="command">unmono</code> {
1201 <code class="option">index</code>
1203 <code class="option">header</code>
1205 <code class="option">body</code>
1207 <em class="replaceable"><code>*</code></em>
1209 <em class="replaceable"><code>pattern</code></em>
1211 For <span class="emphasis"><em>object</em></span>, see the <span class="command"><strong>color</strong></span> command. <span class="emphasis"><em>attribute</em></span>
1212 can be one of the following:
1213 </p><div class="itemizedlist"><ul type="disc"><li><p>none</p></li><li><p>bold</p></li><li><p>underline</p></li><li><p>reverse</p></li><li><p>standout</p></li></ul></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="msg-hdr-display"></a>10. Message Header Display</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ignore"></a>10.1. Selecting Headers</h3></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">ignore</code>
1214 <em class="replaceable"><code>pattern</code></em>
1216 <em class="replaceable"><code>pattern</code></em>
1217 ...]<br /><code class="command">unignore</code> {
1218 <em class="replaceable"><code>*</code></em>
1220 <em class="replaceable"><code>pattern</code></em>
1222 Messages often have many header fields added by automatic processing systems,
1223 or which may not seem useful to display on the screen. This command allows
1224 you to specify header fields which you don't normally want to see in the pager.
1226 You do not need to specify the full header field name. For example,
1227 “<span class="quote">ignore content-</span>” will ignore all header fields that begin with the pattern
1228 “<span class="quote">content-</span>”. “<span class="quote">ignore *</span>” will ignore all headers.
1230 To remove a previously added token from the list, use the “<span class="quote">unignore</span>” command.
1231 The “<span class="quote">unignore</span>” command will make Mutt display headers with the given pattern.
1232 For example, if you do “<span class="quote">ignore x-</span>” it is possible to “<span class="quote">unignore x-mailer</span>”.
1234 “<span class="quote">unignore *</span>” will remove all tokens from the ignore list.
1235 </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">
1236 # Sven's draconian header weeding
1238 unignore from date subject to cc
1239 unignore organization organisation x-mailer: x-newsreader: x-mailing-list:
1241 </pre></div></div><br class="example-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="hdr-order"></a>10.2. Ordering Displayed Headers</h3></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">hdr_order</code>
1242 <em class="replaceable"><code>header</code></em>
1244 <em class="replaceable"><code>header</code></em>
1245 ...]<br /><code class="command">unhdr_order</code> {
1246 <em class="replaceable"><code>*</code></em>
1248 <em class="replaceable"><code>header</code></em>
1250 With the <span class="command"><strong>hdr_order</strong></span> command you can specify an order in
1251 which Mutt will attempt to present these headers to you when viewing messages.
1253 “<span class="quote"><span class="command"><strong>unhdr_order</strong></span> *</span>” will clear all previous headers from the order list,
1254 thus removing the header order effects set by the system-wide startup file.
1255 </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">
1256 hdr_order From Date: From: To: Cc: Subject:
1257 </pre></div></div><br class="example-break" /></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="alternates"></a>11. Alternative Addresses</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">alternates</code> [
1258 <code class="option">-group</code>
1259 <em class="replaceable"><code>name</code></em>
1261 <em class="replaceable"><code>regexp</code></em>
1263 <em class="replaceable"><code>regexp</code></em>
1264 ...]<br /><code class="command">unalternates</code> [
1265 <code class="option">-group</code>
1266 <em class="replaceable"><code>name</code></em>
1268 <em class="replaceable"><code>*</code></em>
1270 <em class="replaceable"><code>regexp</code></em>
1272 With various functions, Mutt will treat messages differently,
1273 depending on whether you sent them or whether you received them from
1274 someone else. For instance, when replying to a message that you
1275 sent to a different party, Mutt will automatically suggest to send
1276 the response to the original message's recipients — responding to
1277 yourself won't make much sense in many cases. (See <a class="link" href="#reply-to" title="3.214. reply_to">$reply_to</a>.)
1279 Many users receive e-mail under a number of different addresses. To
1280 fully use Mutt's features here, the program must be able to
1281 recognize what e-mail addresses you receive mail under. That's the
1282 purpose of the <span class="command"><strong>alternates</strong></span> command: It takes a list of regular
1283 expressions, each of which can identify an address under which you
1286 As addresses are matched using regular expressions and not exact strict
1287 comparisons, you should make sure you specify your addresses as precise
1288 as possible to avoid mismatches. For example, if you specify:
1289 </p><pre class="screen">
1290 alternates user@example
1292 Mutt will consider “<span class="quote"><code class="literal">some-user@example</code></span>” as
1293 being your address, too which may not be desired. As a solution, in such
1294 cases addresses should be specified as:
1295 </p><pre class="screen">
1296 alternates '^user@example$'
1298 The <code class="literal">-group</code> flag causes all of the subsequent regular expressions
1299 to be added to the named group.
1301 The <span class="command"><strong>unalternates</strong></span> command can be used to write exceptions to
1302 <span class="command"><strong>alternates</strong></span> patterns. If an address matches something in an
1303 <span class="command"><strong>alternates</strong></span> command, but you nonetheless do not think it is
1304 from you, you can list a more precise pattern under an <span class="command"><strong>unalternates</strong></span>
1307 To remove a regular expression from the <span class="command"><strong>alternates</strong></span> list, use the
1308 <span class="command"><strong>unalternates</strong></span> command with exactly the same <span class="emphasis"><em>regexp</em></span>.
1309 Likewise, if the <span class="emphasis"><em>regexp</em></span> for an <span class="command"><strong>alternates</strong></span> command matches
1310 an entry on the <span class="command"><strong>unalternates</strong></span> list, that <span class="command"><strong>unalternates</strong></span>
1311 entry will be removed. If the <span class="emphasis"><em>regexp</em></span> for <span class="command"><strong>unalternates</strong></span>
1312 is “<span class="quote">*</span>”, <span class="emphasis"><em>all entries</em></span> on <span class="command"><strong>alternates</strong></span> will be removed.
1313 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="lists"></a>12. Mailing Lists</h2></div></div></div><a id="subscribe"></a><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">lists</code> [
1314 <code class="option">-group</code>
1315 <em class="replaceable"><code>name</code></em>
1317 <em class="replaceable"><code>regexp</code></em>
1319 <em class="replaceable"><code>regexp</code></em>
1320 ...]<br /><code class="command">unlists</code> [
1321 <code class="option">-group</code>
1322 <em class="replaceable"><code>name</code></em>
1324 <em class="replaceable"><code>*</code></em>
1326 <em class="replaceable"><code>regexp</code></em>
1327 ... }<br /><code class="command">subscribe</code> [
1328 <code class="option">-group</code>
1329 <em class="replaceable"><code>name</code></em>
1331 <em class="replaceable"><code>regexp</code></em>
1333 <em class="replaceable"><code>regexp</code></em>
1334 ...]<br /><code class="command">unsubscribe</code> [
1335 <code class="option">-group</code>
1336 <em class="replaceable"><code>name</code></em>
1338 <em class="replaceable"><code>*</code></em>
1340 <em class="replaceable"><code>regexp</code></em>
1342 Mutt has a few nice features for <a class="link" href="#using-lists" title="8. Handling Mailing Lists">handling mailing lists</a>. In order to take advantage of them, you must
1343 specify which addresses belong to mailing lists, and which mailing
1344 lists you are subscribed to. Mutt also has limited support for
1345 auto-detecting mailing lists: it supports parsing
1346 <code class="literal">mailto:</code> links in the common
1347 <code class="literal">List-Post:</code> header which has the same effect as
1348 specifying the list address via the <span class="command"><strong>lists</strong></span> command
1349 (except the group feature). Once you have done this, the
1350 <a class="link" href="#list-reply"><code class="literal"><list-reply></code></a>
1351 function will work for all known lists.
1352 Additionally, when you send a message to a subscribed list, Mutt will
1353 add a Mail-Followup-To header to tell other users' mail user agents
1354 not to send copies of replies to your personal address.
1355 </p><div class="note"><h3 class="title">Note</h3><p>
1356 The Mail-Followup-To header is a non-standard extension which is not
1357 supported by all mail user agents. Adding it is not bullet-proof against
1358 receiving personal CCs of list messages. Also note that the generation
1359 of the Mail-Followup-To header is controlled by the
1360 <a class="link" href="#followup-to" title="3.68. followup_to">$followup_to</a>
1361 configuration variable since it's common practice on some mailing lists
1362 to send Cc upons replies (which is more a group- than a list-reply).
1364 More precisely, Mutt maintains lists of patterns for the addresses
1365 of known and subscribed mailing lists. Every subscribed mailing
1366 list is known. To mark a mailing list as known, use the <span class="command"><strong>list</strong></span>
1367 command. To mark it as subscribed, use <span class="command"><strong>subscribe</strong></span>.
1369 You can use regular expressions with both commands. To mark all
1370 messages sent to a specific bug report's address on Debian's bug
1371 tracking system as list mail, for instance, you could say
1372 </p><pre class="screen">
1373 subscribe [0-9]*.*@bugs.debian.org</pre><p>
1374 as it's often, it's sufficient to just give a portion of the list's e-mail address.
1376 Specify as much of the address as you need to to remove ambiguity. For
1377 example, if you've subscribed to the Mutt mailing list, you will receive mail
1378 addressed to <code class="literal">mutt-users@mutt.org</code>. So, to tell Mutt
1379 that this is a mailing list, you could add <code class="literal">lists mutt-users@</code> to your
1380 initialization file. To tell Mutt that you are subscribed to it,
1381 add <code class="literal"><span class="command"><strong>subscribe</strong></span> mutt-users</code> to your initialization file instead.
1382 If you also happen to get mail from someone whose address is
1383 <code class="literal">mutt-users@example.com</code>, you could use
1384 <code class="literal"><span class="command"><strong>lists</strong></span> ^mutt-users@mutt\\.org$</code>
1385 or <code class="literal"><span class="command"><strong>subscribe</strong></span> ^mutt-users@mutt\\.org$</code> to
1386 match only mail from the actual list.
1388 The <code class="literal">-group</code> flag adds all of the subsequent regular expressions
1391 The “<span class="quote">unlists</span>” command is used to remove a token from the list of
1392 known and subscribed mailing-lists. Use “<span class="quote">unlists *</span>” to remove all
1395 To remove a mailing list from the list of subscribed mailing lists,
1396 but keep it on the list of known mailing lists, use <span class="command"><strong>unsubscribe</strong></span>.
1397 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="mbox-hook"></a>13. Using Multiple Spool Mailboxes</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">mbox-hook</code>
1398 <em class="replaceable"><code>[!]pattern</code></em>
1400 <em class="replaceable"><code>mailbox</code></em>
1402 This command is used to move read messages from a specified mailbox to a
1403 different mailbox automatically when you quit or change folders.
1404 <span class="emphasis"><em>pattern</em></span> is a regular expression specifying the mailbox to treat as a
1405 “<span class="quote">spool</span>” mailbox and <span class="emphasis"><em>mailbox</em></span> specifies where mail should be saved when
1408 Unlike some of the other <span class="emphasis"><em>hook</em></span> commands, only the <span class="emphasis"><em>first</em></span> matching
1409 pattern is used (it is not possible to save read mail in more than a single
1411 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="mailboxes"></a>14. Monitoring Incoming Mail</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">mailboxes</code>
1412 <em class="replaceable"><code>mailbox</code></em>
1414 <em class="replaceable"><code>mailbox</code></em>
1415 ...]<br /><code class="command">unmailboxes</code> {
1416 <em class="replaceable"><code>*</code></em>
1418 <em class="replaceable"><code>mailbox</code></em>
1420 This command specifies folders which can receive mail and
1421 which will be checked for new messages periodically.
1423 <span class="emphasis"><em>folder</em></span> can either be a local file or directory
1424 (Mbox/Mmdf or Maildir/Mh). If Mutt was built with POP and/or IMAP
1425 support, <span class="emphasis"><em>folder</em></span> can also be a POP/IMAP folder
1426 URL. The URL syntax is described in <a class="xref" href="#url-syntax" title="1.2. URL Syntax">Section 1.2, “URL Syntax”</a>,
1427 POP and IMAP are described in <a class="xref" href="#pop" title="3. POP3 Support">Section 3, “POP3 Support”</a> and <a class="xref" href="#imap" title="4. IMAP Support">Section 4, “IMAP Support”</a>
1430 Mutt provides a number of advanced features for handling (possibly many)
1431 folders and new mail within them, please refer to
1432 <a class="xref" href="#handling-folders" title="9. Handling multiple folders">Section 9, “Handling multiple folders”</a> for details (including in what
1433 situations and how often Mutt checks for new mail).
1435 The “<span class="quote">unmailboxes</span>” command is used to remove a token from the list
1436 of folders which receive mail. Use “<span class="quote">unmailboxes *</span>” to remove all
1438 </p><div class="note"><h3 class="title">Note</h3><p>
1439 The folders in the <span class="command"><strong>mailboxes</strong></span> command are resolved when
1440 the command is executed, so if these names contain <a class="link" href="#shortcuts" title="7. Mailbox Shortcuts">shortcut characters</a> (such as “<span class="quote">=</span>” and “<span class="quote">!</span>”), any variable
1441 definition that affects these characters (like <a class="link" href="#folder" title="3.66. folder">$folder</a> and <a class="link" href="#spoolfile" title="3.269. spoolfile">$spoolfile</a>)
1442 should be set before the <span class="command"><strong>mailboxes</strong></span> command. If
1443 none of these shorcuts are used, a local path should be absolute as
1444 otherwise Mutt tries to find it relative to the directory
1445 from where Mutt was started which may not always be desired.
1447 For Mbox and Mmdf folders, new mail is detected by comparing access and/or
1448 modification times of files: Mutt assumes a folder has new mail if it wasn't
1449 accessed after it was last modified. Utilities like <code class="literal">biff</code> or
1450 <code class="literal">frm</code> or any other program which accesses the mailbox might cause
1451 Mutt to never detect new mail for that mailbox if they do not properly reset the
1452 access time. Other possible causes of Mutt not detecting new mail in these folders
1453 are backup tools (updating access times) or filesystems mounted without
1454 access time update support.
1456 In cases where new mail detection for Mbox or Mmdf folders appears to be
1458 <a class="link" href="#check-mbox-size" title="3.26. check_mbox_size">$check_mbox_size</a>
1459 option can be used to make Mutt track and consult file sizes for new
1460 mail detection instead which won't work for size-neutral changes.
1461 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="my-hdr"></a>15. User-Defined Headers</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">my_hdr</code>
1462 <em class="replaceable"><code>string</code></em>
1463 <br /><code class="command">unmy_hdr</code> {
1464 <em class="replaceable"><code>*</code></em>
1466 <em class="replaceable"><code>field</code></em>
1468 The <span class="command"><strong>my_hdr</strong></span> command allows you to create your own header
1469 fields which will be added to every message you send and appear in the
1470 editor if <a class="link" href="#edit-headers" title="3.57. edit_headers">$edit_headers</a> is set.
1472 For example, if you would like to add an “<span class="quote">Organization:</span>” header field to
1473 all of your outgoing messages, you can put the command something like
1474 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 <code class="literal">.muttrc</code>.
1475 </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">
1476 my_hdr Organization: A Really Big Company, Anytown, USA
1477 </pre></div></div><br class="example-break" /><div class="note"><h3 class="title">Note</h3><p>
1478 Space characters are <span class="emphasis"><em>not</em></span> allowed between the keyword and
1479 the colon (“<span class="quote">:</span>”). The standard for electronic mail (RFC2822) says that
1480 space is illegal there, so Mutt enforces the rule.
1482 If you would like to add a header field to a single message, you should
1483 either set the <a class="link" href="#edit-headers" title="3.57. edit_headers">$edit_headers</a> variable,
1484 or use the <code class="literal"><edit-headers></code> function (default: “<span class="quote">E</span>”) in the compose menu so
1485 that you can edit the header of your message along with the body.
1487 To remove user defined header fields, use the <span class="command"><strong>unmy_hdr</strong></span>
1488 command. You may specify an asterisk (“<span class="quote">*</span>”) to remove all header
1489 fields, or the fields to remove. For example, to remove all “<span class="quote">To</span>” and
1490 “<span class="quote">Cc</span>” header fields, you could use:
1491 </p><pre class="screen">
1493 </pre></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="save-hook"></a>16. Specify Default Save Mailbox</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">save-hook</code>
1494 <em class="replaceable"><code>[!]pattern</code></em>
1496 <em class="replaceable"><code>mailbox</code></em>
1498 This command is used to override the default mailbox used when saving
1499 messages. <span class="emphasis"><em>mailbox</em></span> will be used as the default if the message
1500 matches <span class="emphasis"><em>pattern</em></span>, see <a class="xref" href="#pattern-hook" title="4.1. Message Matching in Hooks">Message Matching in Hooks</a> for information
1501 on the exact format.
1503 To provide more flexibility and good defaults, Mutt applies the
1504 expandos of <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> to
1505 <span class="emphasis"><em>mailbox</em></span> after it was expanded.
1506 </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">
1507 # default: save all to ~/Mail/<author name>
1508 save-hook . ~/Mail/%F
1510 # save from me@turing.cs.hmc.edu and me@cs.hmc.edu to $folder/elkins
1511 save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
1513 # save from aol.com to $folder/spam
1514 save-hook aol\\.com$ +spam
1515 </pre></div></div><br class="example-break" /><p>
1516 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.
1517 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="fcc-hook"></a>17. Specify Default Fcc: Mailbox When Composing</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">fcc-hook</code>
1518 <em class="replaceable"><code>[!]pattern</code></em>
1520 <em class="replaceable"><code>mailbox</code></em>
1522 This command is used to save outgoing mail in a mailbox other than
1523 <a class="link" href="#record" title="3.211. record">$record</a>. Mutt searches the initial list of
1524 message recipients for the first matching <span class="emphasis"><em>regexp</em></span> and uses <span class="emphasis"><em>mailbox</em></span>
1525 as the default Fcc: mailbox. If no match is found the message will be saved
1526 to <a class="link" href="#record" title="3.211. record">$record</a> mailbox.
1528 To provide more flexibility and good defaults, Mutt applies the
1529 expandos of <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> to
1530 <span class="emphasis"><em>mailbox</em></span> after it was expanded.
1532 See <a class="xref" href="#pattern-hook" title="4.1. Message Matching in Hooks">Message Matching in Hooks</a> for information on the exact format of <span class="emphasis"><em>pattern</em></span>.
1533 </p><pre class="screen">fcc-hook [@.]aol\\.com$ +spammers</pre><p>
1534 ...will save a copy of all messages going to the aol.com domain to
1535 the `+spammers' mailbox by default. Also see the <a class="link" href="#fcc-save-hook" title="18. Specify Default Save Filename and Default Fcc: Mailbox at Once"><span class="command"><strong>fcc-save-hook</strong></span></a> command.
1536 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="fcc-save-hook"></a>18. Specify Default Save Filename and Default Fcc: Mailbox at Once</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">fcc-save-hook</code>
1537 <em class="replaceable"><code>[!]pattern</code></em>
1539 <em class="replaceable"><code>mailbox</code></em>
1541 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>
1542 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 arguments,
1543 including %-expansion on <span class="emphasis"><em>mailbox</em></span> according
1544 to <a class="link" href="#index-format" title="3.114. index_format">$index_format</a>.
1545 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="send-hook"></a>19. Change Settings Based Upon Message Recipients</h2></div></div></div><a id="reply-hook"></a><a id="send2-hook"></a><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">reply-hook</code>
1546 <em class="replaceable"><code>[!]pattern</code></em>
1548 <em class="replaceable"><code>command</code></em>
1549 <br /><code class="command">send-hook</code>
1550 <em class="replaceable"><code>[!]pattern</code></em>
1552 <em class="replaceable"><code>command</code></em>
1553 <br /><code class="command">send2-hook</code>
1554 <em class="replaceable"><code>[!]pattern</code></em>
1556 <em class="replaceable"><code>command</code></em>
1558 These commands can be used to execute arbitrary configuration commands based
1559 upon recipients of the message. <span class="emphasis"><em>pattern</em></span> is used to match
1560 the message, see <a class="xref" href="#pattern-hook" title="4.1. Message Matching in Hooks">Message Matching in Hooks</a> for details. <span class="emphasis"><em>command</em></span>
1561 is executed when <span class="emphasis"><em>pattern</em></span> matches.
1563 <span class="command"><strong>reply-hook</strong></span> is matched against the message you are <span class="emphasis"><em>replying to</em></span>,
1564 instead of the message you are <span class="emphasis"><em>sending</em></span>. <span class="command"><strong>send-hook</strong></span> is
1565 matched against all messages, both <span class="emphasis"><em>new</em></span>
1566 and <span class="emphasis"><em>replies</em></span>.
1567 </p><div class="note"><h3 class="title">Note</h3><p>
1568 <span class="command"><strong>reply-hook</strong></span>s are matched <span class="emphasis"><em>before</em></span> the <span class="command"><strong>send-hook</strong></span>, <span class="emphasis"><em>regardless</em></span>
1569 of the order specified in the user's configuration file.
1571 <span class="command"><strong>send2-hook</strong></span> is matched every time a message is changed, either
1572 by editing it, or by using the compose menu to change its recipients
1573 or subject. <span class="command"><strong>send2-hook</strong></span> is executed after <span class="command"><strong>send-hook</strong></span>, and
1574 can, e.g., be used to set parameters such as the <a class="link" href="#sendmail" title="3.230. sendmail">$sendmail</a> variable depending on the message's sender
1577 For each type of <span class="command"><strong>send-hook</strong></span> or <span class="command"><strong>reply-hook</strong></span>, when multiple matches
1578 occur, commands are executed in the order they are specified in the <code class="literal">.muttrc</code>
1579 (for that type of hook).
1581 Example: <code class="literal"><span class="command"><strong>send-hook</strong></span> mutt "<span class="command"><strong>set</strong></span> mime_forward signature=''"</code>
1583 Another typical use for this command is to change the values of the
1584 <a class="link" href="#attribution" title="3.16. attribution">$attribution</a>, <a class="link" href="#signature" title="3.235. signature">$signature</a> and <a class="link" href="#locale" title="3.117. locale">$locale</a>
1585 variables in order to change the language of the attributions and
1586 signatures based upon the recipients.
1587 </p><div class="note"><h3 class="title">Note</h3><p>
1588 <span class="command"><strong>send-hook</strong></span>'s are only executed once after getting the
1589 initial list of recipients. Adding a recipient after replying or
1590 editing the message will not cause any <span class="command"><strong>send-hook</strong></span> to be executed,
1591 similarily if <a class="link" href="#autoedit" title="3.18. autoedit">$autoedit</a> is set
1592 (as then the initial list of recipients is empty). Also note that <a class="link" href="#my-hdr" title="15. User-Defined Headers"><span class="command"><strong>my_hdr</strong></span></a> commands which
1593 modify recipient headers, or the message's subject, don't have any
1594 effect on the current message when executed from a
1595 <span class="command"><strong>send-hook</strong></span>.
1596 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="message-hook"></a>20. Change Settings Before Formatting a Message</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">message-hook</code>
1597 <em class="replaceable"><code>[!]pattern</code></em>
1599 <em class="replaceable"><code>command</code></em>
1601 This command can be used to execute arbitrary configuration commands
1602 before viewing or formatting a message based upon information about the message.
1603 <span class="emphasis"><em>command</em></span> is executed if the <span class="emphasis"><em>pattern</em></span> matches the message to be
1604 displayed. When multiple matches occur, commands are executed in the order
1605 they are specified in the <code class="literal">.muttrc</code>.
1607 See <a class="xref" href="#pattern-hook" title="4.1. Message Matching in Hooks">Message Matching in Hooks</a> for
1608 information on the exact format of <span class="emphasis"><em>pattern</em></span>.
1611 </p><pre class="screen">
1612 message-hook ~A 'set pager=builtin'
1613 message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject: .*\""'
1614 </pre></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="crypt-hook"></a>21. Choosing the Cryptographic Key of the Recipient</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">crypt-hook</code>
1615 <em class="replaceable"><code>pattern</code></em>
1617 <em class="replaceable"><code>keyid</code></em>
1619 When encrypting messages with PGP/GnuPG or OpenSSL, you may want to associate a certain
1620 key with a given e-mail address automatically, either because the
1621 recipient's public key can't be deduced from the destination address,
1622 or because, for some reasons, you need to override the key Mutt would
1623 normally use. The <span class="command"><strong>crypt-hook</strong></span> command provides a
1624 method by which you can specify the ID of the public key to be used
1625 when encrypting messages to a certain recipient.
1627 The meaning of <span class="emphasis"><em>keyid</em></span> is to be taken broadly in this context: You
1628 can either put a numerical key ID here, an e-mail address, or even
1630 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="push"></a>22. Adding Key Sequences to the Keyboard Buffer</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">push</code>
1631 <em class="replaceable"><code>string</code></em>
1633 This command adds the named string to the keyboard buffer. The string may
1634 contain control characters, key names and function names like the sequence
1635 string in the <a class="link" href="#macro" title="8. Keyboard Macros">macro</a> command. You may use it to
1636 automatically run a sequence of commands at startup, or when entering
1637 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 push in folder-hook”</a>
1638 shows how to automatically collapse all threads when entering a folder.
1639 </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">
1640 folder-hook . 'push <collapse-all>'
1641 </pre></div></div><br class="example-break" /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="exec"></a>23. Executing Functions</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">exec</code>
1642 <em class="replaceable"><code>function</code></em>
1644 <em class="replaceable"><code>function</code></em>
1646 This command can be used to execute any function. Functions are
1647 listed in the <a class="link" href="#functions" title="4. Functions">function reference</a>.
1648 “<span class="quote"><span class="command"><strong>exec</strong></span><code class="literal">function</code></span>” is equivalent to
1649 “<span class="quote"><code class="literal">push <function></code></span>”.
1650 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="score-command"></a>24. Message Scoring</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">score</code>
1651 <em class="replaceable"><code>pattern</code></em>
1653 <em class="replaceable"><code>value</code></em>
1654 <br /><code class="command">unscore</code> {
1655 <em class="replaceable"><code>*</code></em>
1657 <em class="replaceable"><code>pattern</code></em>
1659 The <span class="command"><strong>score</strong></span> commands adds <span class="emphasis"><em>value</em></span> to a message's score if <span class="emphasis"><em>pattern</em></span>
1660 matches it. <span class="emphasis"><em>pattern</em></span> is a string in the format described in the <a class="link" href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">patterns</a> section (note: For efficiency reasons, patterns
1661 which scan information not available in the index, such as <code class="literal">˜b</code>,
1662 <code class="literal">˜B</code> or <code class="literal">˜h</code>, may not be used). <span class="emphasis"><em>value</em></span> is a
1663 positive or negative integer. A message's final score is the sum total of all
1664 matching <span class="command"><strong>score</strong></span> entries. However, you may optionally prefix <span class="emphasis"><em>value</em></span> with
1665 an equal sign (“<span class="quote">=</span>”) to cause evaluation to stop at a particular entry if there is
1666 a match. Negative final scores are rounded up to 0.
1668 The <span class="command"><strong>unscore</strong></span> command removes score entries from the list. You <span class="emphasis"><em>must</em></span>
1669 specify the same pattern specified in the <span class="command"><strong>score</strong></span> command for it to be
1670 removed. The pattern “<span class="quote">*</span>” is a special token which means to clear the list
1671 of all score entries.
1672 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="spam"></a>25. Spam Detection</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">spam</code>
1673 <em class="replaceable"><code>pattern</code></em>
1675 <em class="replaceable"><code>format</code></em>
1676 <br /><code class="command">nospam</code> {
1677 <em class="replaceable"><code>*</code></em>
1679 <em class="replaceable"><code>pattern</code></em>
1681 Mutt has generalized support for external spam-scoring filters.
1682 By defining your spam patterns with the <span class="command"><strong>spam</strong></span> and <code class="literal">nospam</code>
1683 commands, you can <span class="emphasis"><em>limit</em></span>, <span class="emphasis"><em>search</em></span>, and <span class="emphasis"><em>sort</em></span> your
1684 mail based on its spam attributes, as determined by the external
1685 filter. You also can display the spam attributes in your index
1686 display using the <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 <code class="literal">%?H?[%H] ?</code>
1687 to display spam tags only when they are defined for a given message.)
1689 Your first step is to define your external filter's spam patterns using
1690 the <span class="command"><strong>spam</strong></span> command. <span class="emphasis"><em>pattern</em></span> should be a regular expression
1691 that matches a header in a mail message. If any message in the mailbox
1692 matches this regular expression, it will receive a “<span class="quote">spam tag</span>” or
1693 “<span class="quote">spam attribute</span>” (unless it also matches a <span class="command"><strong>nospam</strong></span> pattern — see
1694 below.) The appearance of this attribute is entirely up to you, and is
1695 governed by the <span class="emphasis"><em>format</em></span> parameter. <span class="emphasis"><em>format</em></span> can be any static
1696 text, but it also can include back-references from the <span class="emphasis"><em>pattern</em></span>
1697 expression. (A regular expression “<span class="quote">back-reference</span>” refers to a
1698 sub-expression contained within parentheses.) <code class="literal">%1</code> is replaced with
1699 the first back-reference in the regex, <code class="literal">%2</code> with the second, etc.
1701 To match spam tags, mutt needs the corresponding header information
1702 which is always the case for local and POP folders but not for IMAP in
1703 the default configuration. Depending on the spam header to be analyzed,
1704 <a class="link" href="#imap-headers" title="3.99. imap_headers">$imap_headers</a> may need
1707 If you're using multiple spam filters, a message can have more than
1708 one spam-related header. You can define <span class="command"><strong>spam</strong></span> patterns for each
1709 filter you use. If a message matches two or more of these patterns, and
1710 the <a class="link" href="#spam-separator" title="3.268. spam_separator">$spam_separator</a> variable is set to a string, then the
1711 message's spam tag will consist of all the <span class="emphasis"><em>format</em></span> strings joined
1712 together, with the value of <a class="link" href="#spam-separator" title="3.268. spam_separator">$spam_separator</a> separating
1715 For example, suppose one uses DCC, SpamAssassin, and PureMessage, then
1716 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>.
1717 </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">
1718 spam "X-DCC-.*-Metrics:.*(....)=many" "90+/DCC-%1"
1719 spam "X-Spam-Status: Yes" "90+/SA"
1720 spam "X-PerlMX-Spam: .*Probability=([0-9]+)%" "%1/PM"
1721 set spam_separator=", "
1722 </pre></div></div><br class="example-break" /><p>
1723 If then a message is received that DCC registered with “<span class="quote">many</span>” hits
1724 under the “<span class="quote">Fuz2</span>” checksum, and that PureMessage registered with a
1725 97% probability of being spam, that message's spam tag would read
1726 <code class="literal">90+/DCC-Fuz2, 97/PM</code>. (The four characters before “<span class="quote">=many</span>” in a
1727 DCC report indicate the checksum used — in this case, “<span class="quote">Fuz2</span>”.)
1729 If the <a class="link" href="#spam-separator" title="3.268. spam_separator">$spam_separator</a> variable is unset, then each
1730 spam pattern match supersedes the previous one. Instead of getting
1731 joined <span class="emphasis"><em>format</em></span> strings, you'll get only the last one to match.
1733 The spam tag is what will be displayed in the index when you use
1734 <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
1735 string that the <code class="literal">˜H</code> pattern-matching expression matches against for
1736 <code class="literal"><search></code> and <code class="literal"><limit></code> functions. And it's what sorting by spam
1737 attribute will use as a sort key.
1739 That's a pretty complicated example, and most people's actual
1740 environments will have only one spam filter. The simpler your
1741 configuration, the more effective Mutt can be, especially when it comes
1744 Generally, when you sort by spam tag, Mutt will sort <span class="emphasis"><em>lexically</em></span> —
1745 that is, by ordering strings alphanumerically. However, if a spam tag
1746 begins with a number, Mutt will sort numerically first, and lexically
1747 only when two numbers are equal in value. (This is like UNIX's
1748 <code class="literal">sort -n</code>.) A message with no spam attributes at all — that is, one
1749 that didn't match <span class="emphasis"><em>any</em></span> of your <span class="command"><strong>spam</strong></span> patterns — is sorted at
1750 lowest priority. Numbers are sorted next, beginning with 0 and ranging
1751 upward. Finally, non-numeric strings are sorted, with “<span class="quote">a</span>” taking lower
1752 priority than “<span class="quote">z</span>”. Clearly, in general, sorting by spam tags is most
1753 effective when you can coerce your filter to give you a raw number. But
1754 in case you can't, Mutt can still do something useful.
1756 The <span class="command"><strong>nospam</strong></span> command can be used to write exceptions to <span class="command"><strong>spam</strong></span>
1757 patterns. If a header pattern matches something in a <span class="command"><strong>spam</strong></span> command,
1758 but you nonetheless do not want it to receive a spam tag, you can list a
1759 more precise pattern under a <span class="command"><strong>nospam</strong></span> command.
1761 If the <span class="emphasis"><em>pattern</em></span> given to <span class="command"><strong>nospam</strong></span> is exactly the same as the
1762 <span class="emphasis"><em>pattern</em></span> on an existing <span class="command"><strong>spam</strong></span> list entry, the effect will be to
1763 remove the entry from the spam list, instead of adding an exception.
1764 Likewise, if the <span class="emphasis"><em>pattern</em></span> for a <span class="command"><strong>spam</strong></span> command matches an entry
1765 on the <span class="command"><strong>nospam</strong></span> list, that nospam entry will be removed. If the
1766 <span class="emphasis"><em>pattern</em></span> for <span class="command"><strong>nospam</strong></span> is “<span class="quote">*</span>”, <span class="emphasis"><em>all entries on both lists</em></span>
1767 will be removed. This might be the default action if you use <span class="command"><strong>spam</strong></span>
1768 and <span class="command"><strong>nospam</strong></span> in conjunction with a <span class="command"><strong>folder-hook</strong></span>.
1770 You can have as many <span class="command"><strong>spam</strong></span> or <span class="command"><strong>nospam</strong></span> commands as you like.
1771 You can even do your own primitive <span class="command"><strong>spam</strong></span> detection within Mutt — for
1772 example, if you consider all mail from <code class="literal">MAILER-DAEMON</code> to be spam,
1773 you can use a <span class="command"><strong>spam</strong></span> command like this:
1774 </p><pre class="screen">
1775 spam "^From: .*MAILER-DAEMON" "999"
1776 </pre></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="set"></a>26. Setting and Querying Variables</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="var-types"></a>26.1. Variable Types</h3></div></div></div><p>
1777 Mutt supports these types of configuration variables:
1778 </p><div class="variablelist"><dl><dt><span class="term">boolean</span></dt><dd><p>
1779 A boolean expression, either “<span class="quote">yes</span>” or “<span class="quote">no</span>”.
1780 </p></dd><dt><span class="term">number</span></dt><dd><p>
1781 A signed integer number in the range -32768 to 32767.
1782 </p></dd><dt><span class="term">string</span></dt><dd><p>
1784 </p></dd><dt><span class="term">path</span></dt><dd><p>
1785 A specialized string for representing paths including support for
1786 mailbox shortcuts (see <a class="xref" href="#shortcuts" title="7. Mailbox Shortcuts">Section 7, “Mailbox Shortcuts”</a>) as well as tilde
1787 (“<span class="quote">˜</span>”) for a user's home directory and more.
1788 </p></dd><dt><span class="term">quadoption</span></dt><dd><p>
1789 Like a boolean but triggers a prompt when set to “<span class="quote">ask-yes</span>”
1790 or “<span class="quote">ask-no</span>” with “<span class="quote">yes</span>” and “<span class="quote">no</span>”
1791 preselected respectively.
1792 </p></dd><dt><span class="term">sort order</span></dt><dd><p>
1793 A specialized string allowing only particular words as values depending
1795 </p></dd><dt><span class="term">regular expression</span></dt><dd><p>
1796 A regular expression, see <a class="xref" href="#regexp" title="1. Regular Expressions">Section 1, “Regular Expressions”</a> for an introduction.
1797 </p></dd><dt><span class="term">folder magic</span></dt><dd><p>
1798 Specifies the type of folder to use: <span class="emphasis"><em>mbox</em></span>,
1799 <span class="emphasis"><em>mmdf</em></span>, <span class="emphasis"><em>mh</em></span>
1800 or <span class="emphasis"><em>maildir</em></span>.
1801 Currently only used to determine the type for newly created folders.
1802 </p></dd><dt><span class="term">e-mail address</span></dt><dd><p>
1803 An e-mail address either with or without
1804 realname. The older “<span class="quote"><code class="literal">user@example.org (Joe User)</code></span>”
1805 form is supported but strongly deprecated.
1806 </p></dd><dt><span class="term">user-defined</span></dt><dd><p>
1807 Arbitrary text, see <a class="xref" href="#set-myvar" title="26.3. User-Defined Variables">Section 26.3, “User-Defined Variables”</a> for details.
1808 </p></dd></dl></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="set-commands"></a>26.2. Commands</h3></div></div></div><p>
1809 The following commands are available to manipulate and query variables:
1810 </p><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">set</code> {
1811 [ <code class="option">no</code> | <code class="option">inv</code> ]
1812 <em class="replaceable"><code>variable</code></em>
1814 <em class="replaceable"><code>variable=value</code></em>
1815 } [...]<br /><code class="command">toggle</code>
1816 <em class="replaceable"><code>variable</code></em>
1818 <em class="replaceable"><code>variable</code></em>
1819 ...]<br /><code class="command">unset</code>
1820 <em class="replaceable"><code>variable</code></em>
1822 <em class="replaceable"><code>variable</code></em>
1823 ...]<br /><code class="command">reset</code>
1824 <em class="replaceable"><code>variable</code></em>
1826 <em class="replaceable"><code>variable</code></em>
1828 This command is used to set (and unset) <a class="link" href="#variables" title="3. Configuration Variables">configuration variables</a>. There are four basic types of variables:
1829 boolean, number, string and quadoption. <span class="emphasis"><em>boolean</em></span> variables can be
1830 <span class="emphasis"><em>set</em></span> (true) or <span class="emphasis"><em>unset</em></span> (false). <span class="emphasis"><em>number</em></span> variables can be
1831 assigned a positive integer value.
1832 <span class="emphasis"><em>string</em></span> variables consist of any number of printable characters and
1833 must be enclosed in quotes if they contain spaces or tabs. You
1834 may also use the escape sequences “<span class="quote">\n</span>” and “<span class="quote">\t</span>” for newline and tab, respectively.
1835 <span class="emphasis"><em>quadoption</em></span> variables are used to control whether or not to be prompted
1836 for certain actions, or to specify a default action. A value of <span class="emphasis"><em>yes</em></span>
1837 will cause the action to be carried out automatically as if you had answered
1838 yes to the question. Similarly, a value of <span class="emphasis"><em>no</em></span> will cause the
1839 action to be carried out as if you had answered “<span class="quote">no.</span>” A value of
1840 <span class="emphasis"><em>ask-yes</em></span> will cause a prompt with a default answer of “<span class="quote">yes</span>” and
1841 <span class="emphasis"><em>ask-no</em></span> will provide a default answer of “<span class="quote">no.</span>”
1843 Prefixing a variable with “<span class="quote">no</span>” will unset it. Example: <code class="literal"><span class="command"><strong>set</strong></span> noaskbcc</code>.
1845 For <span class="emphasis"><em>boolean</em></span> variables, you may optionally prefix the variable name with
1846 <code class="literal">inv</code> to toggle the value (on or off). This is useful when writing
1847 macros. Example: <code class="literal"><span class="command"><strong>set</strong></span> invsmart_wrap</code>.
1849 The <span class="command"><strong>toggle</strong></span> command automatically prepends the <code class="literal">inv</code> prefix to all
1850 specified variables.
1852 The <span class="command"><strong>unset</strong></span> command automatically prepends the <code class="literal">no</code> prefix to all
1853 specified variables.
1855 Using the <code class="literal"><enter-command></code> function in the <span class="emphasis"><em>index</em></span> menu, you can query the
1856 value of a variable by prefixing the name of the variable with a question
1858 </p><pre class="screen">
1861 The question mark is actually only required for boolean and quadoption
1864 The <span class="command"><strong>reset</strong></span> command resets all given variables to the compile time
1865 defaults (hopefully mentioned in this manual). If you use the command
1866 <span class="command"><strong>set</strong></span> and prefix the variable with “<span class="quote">&</span>” this has the same
1867 behavior as the <span class="command"><strong>reset</strong></span> command.
1869 With the <span class="command"><strong>reset</strong></span> command there exists the special variable “<span class="quote">all</span>”,
1870 which allows you to reset all variables to their system defaults.
1871 </p></div><div class="sect2" lang="en" xml:lang="en"><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" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="set-myvar-intro"></a>26.3.1. Introduction</h4></div></div></div><p>
1872 Along with the variables listed in the
1873 <a class="link" href="#variables" title="3. Configuration Variables">Configuration variables</a> section, Mutt
1874 supports user-defined variables with names starting
1875 with <code class="literal">my_</code> as in, for
1876 example, <code class="literal">my_cfgdir</code>.
1878 The <span class="command"><strong>set</strong></span> command either creates a
1879 custom <code class="literal">my_</code> variable or changes its
1880 value if it does exist already. The <span class="command"><strong>unset</strong></span> and <span class="command"><strong>reset</strong></span>
1881 commands remove the variable entirely.
1883 Since user-defined variables are expanded in the same way that
1884 environment variables are (except for
1885 the <a class="link" href="#shell-escape">shell-escape</a> command and
1886 backtick expansion), this feature can be used to make configuration
1887 files more readable.
1888 </p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="set-myvar-examples"></a>26.3.2. Examples</h4></div></div></div><p>
1889 The following example defines and uses the variable <code class="literal">my_cfgdir</code>
1890 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:
1891 </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">
1892 set my_cfgdir = $HOME/mutt/config
1894 source $my_cfgdir/hooks
1895 source $my_cfgdir/macros
1896 # more source commands...
1897 </pre></div></div><br class="example-break" /><p>
1898 A custom variable can also be used in macros to backup the current value
1899 of another variable. In the following example, the value of the
1900 <a class="link" href="#delete" title="3.49. delete">$delete</a> is changed temporarily
1901 while its original value is saved as <code class="literal">my_delete</code>.
1902 After the macro has executed all commands, the original value of <a class="link" href="#delete" title="3.49. delete">$delete</a> is restored.
1903 </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">
1905 <enter-command>set my_delete=$delete<enter>\
1906 <enter-command>set delete=yes<enter>\
1908 <enter-command>set delete=$my_delete<enter>'
1909 </pre></div></div><br class="example-break" /><p>
1910 Since Mutt expands such values already when parsing the configuration
1911 file(s), the value of <code class="literal">$my_delete</code> in the
1912 last example would be the value of <a class="link" href="#delete" title="3.49. delete">$delete</a> exactly
1913 as it was at that point during parsing the configuration file. If
1914 another statement would change the value for <a class="link" href="#delete" title="3.49. delete">$delete</a>
1915 later in the same or another file, it would have no effect on
1916 <code class="literal">$my_delete</code>. However, the expansion can
1917 be deferred to runtime, as shown in the next example, when escaping the
1919 </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">
1920 macro pager <PageDown> "\
1921 <enter-command> set my_old_pager_stop=\$pager_stop pager_stop<Enter>\
1923 <enter-command> set pager_stop=\$my_old_pager_stop<Enter>\
1924 <enter-command> unset my_old_pager_stop<Enter>"
1925 </pre></div></div><br class="example-break" /><p>
1926 Note that there is a space
1927 between <code class="literal"><enter-command></code> and
1928 the <span class="command"><strong>set</strong></span> configuration command, preventing Mutt from
1929 recording the <span class="command"><strong>macro</strong></span>'s commands into its history.
1930 </p></div></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="source"></a>27. Reading Initialization Commands From Another File</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">source</code>
1931 <em class="replaceable"><code>filename</code></em>
1933 This command allows the inclusion of initialization commands
1934 from other files. For example, I place all of my aliases in
1935 <code class="literal">˜/.mail_aliases</code> so that I can make my
1936 <code class="literal">˜/.muttrc</code> readable and keep my aliases private.
1938 If the filename begins with a tilde (“<span class="quote">˜</span>”), it will be expanded to the
1939 path of your home directory.
1941 If the filename ends with a vertical bar (“<span class="quote">|</span>”), then <span class="emphasis"><em>filename</em></span> is
1942 considered to be an executable program from which to read input (eg.
1943 <code class="literal"><span class="command"><strong>source</strong></span> ˜/bin/myscript|</code>).
1944 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="unhook"></a>28. Removing Hooks</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">unhook</code> {
1945 <em class="replaceable"><code>*</code></em>
1947 <em class="replaceable"><code>hook-type</code></em>
1949 This command permits you to flush hooks you have previously defined.
1950 You can either remove all hooks by giving the “<span class="quote">*</span>” character as an
1951 argument, or you can remove all hooks of a specific type by saying
1952 something like <code class="literal"><span class="command"><strong>unhook</strong></span> send-hook</code>.
1953 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="formatstrings"></a>29. Format Strings</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="formatstrings-basics"></a>29.1. Basic usage</h3></div></div></div><p>
1954 Format strings are a general concept you'll find in several locations
1955 through the Mutt configuration, especially in the
1956 <a class="link" href="#index-format" title="3.114. index_format">$index_format</a>,
1957 <a class="link" href="#pager-format" title="3.150. pager_format">$pager_format</a>,
1958 <a class="link" href="#status-format" title="3.282. status_format">$status_format</a>,
1959 and other related variables. These can be very straightforward,
1960 and it's quite possible you already know how to use them.
1962 The most basic format string element is a percent symbol followed
1963 by another character. For example, <code class="literal">%s</code>
1964 represents a message's Subject: header in the <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> variable. The
1965 “<span class="quote">expandos</span>” available are documented with each format variable, but
1966 there are general modifiers available with all formatting expandos,
1967 too. Those are our concern here.
1969 Some of the modifiers are borrowed right out of C (though you might
1970 know them from Perl, Python, shell, or another language). These are
1971 the <code class="literal">[-]m.n</code> modifiers, as in <code class="literal">%-12.12s</code>. As with
1972 such programming languages, these modifiers allow you to specify the
1973 minimum and maximum size of the resulting string, as well as its
1974 justification. If the “<span class="quote">-</span>” sign follows the percent, the string will
1975 be left-justified instead of right-justified. If there's a number
1976 immediately following that, it's the minimum amount of space the
1977 formatted string will occupy — if it's naturally smaller than that, it
1978 will be padded out with spaces. If a decimal point and another number
1979 follow, that's the maximum space allowable — the string will not be
1980 permitted to exceed that width, no matter its natural size. Each of
1981 these three elements is optional, so that all these are legal format
1982 strings: <code class="literal">%-12s</code>, <code class="literal">%4c</code>,
1983 <code class="literal">%.15F</code> and <code class="literal">%-12.15L</code>.
1985 Mutt adds some other modifiers to format strings. If you use an equals
1986 symbol (<code class="literal">=</code>) as a numeric prefix (like the minus
1987 above), it will force the string to be centered within its minimum
1988 space range. For example, <code class="literal">%=14y</code> will reserve 14
1989 characters for the %y expansion — that's the X-Label: header, in
1990 <a class="link" href="#index-format" title="3.114. index_format">$index_format</a>. If the expansion
1991 results in a string less than 14 characters, it will be centered in a
1992 14-character space. If the X-Label for a message were “<span class="quote">test</span>”, that
1993 expansion would look like “<span class="quote"> test </span>”.
1995 There are two very little-known modifiers that affect the way that an
1996 expando is replaced. If there is an underline (“<span class="quote">_</span>”) character
1997 between any format modifiers (as above) and the expando letter, it will
1998 expands in all lower case. And if you use a colon (“<span class="quote">:</span>”), it will
1999 replace all decimal points with underlines.
2000 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="formatstrings-conditionals"></a>29.2. Conditionals</h3></div></div></div><p>
2001 Depending on the format string variable, some of its sequences can be
2002 used to optionally print a string if their value is nonzero. For
2003 example, you may only want to see the number of flagged messages if such
2004 messages exist, since zero is not particularly meaningful. To optionally
2005 print a string based upon one of the above sequences, the following
2007 </p><pre class="screen">
2008 %?<sequence_char>?<optional_string>?</pre><p>
2009 where <span class="emphasis"><em>sequence_char</em></span> is an expando, and
2010 <span class="emphasis"><em>optional_string</em></span> is the string you would like printed if
2011 <span class="emphasis"><em>sequence_char</em></span> is nonzero.
2012 <span class="emphasis"><em>optional_string</em></span> may contain other
2013 sequences as well as normal text, but you may not nest optional
2016 Here is an example illustrating how to optionally print the number of
2017 new messages in a mailbox in
2018 <a class="link" href="#status-format" title="3.282. status_format">$status_format</a>:
2019 </p><pre class="screen">
2020 %?n?%n new messages.?</pre><p>
2021 You can also switch between two strings using the following construct:
2022 </p><pre class="screen">
2023 %?<sequence_char>?<if_string>&<else_string>?</pre><p>
2024 If the value of <span class="emphasis"><em>sequence_char</em></span> is
2025 non-zero, <span class="emphasis"><em>if_string</em></span> will be expanded,
2026 otherwise <span class="emphasis"><em>else_string</em></span> will be expanded.
2027 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="formatstrings-filters"></a>29.3. Filters</h3></div></div></div><p>
2028 Any format string ending in a vertical bar (“<span class="quote">|</span>”) will be
2029 expanded and piped through the first word in the string, using spaces
2030 as separator. The string returned will be used for display.
2031 If the returned string ends in %, it will be passed through
2032 the formatter a second time. This allows the filter to generate a
2033 replacement format string including % expandos.
2035 All % expandos in a format string are expanded before the script
2037 </p><div class="example"><a id="ex-fmtpipe"></a><p class="title"><b>Example 3.18. Using external filters in format strings</b></p><div class="example-contents"><pre class="screen">
2038 set status_format="script.sh '%r %f (%L)'|"
2039 </pre></div></div><br class="example-break" /><p>
2040 will make Mutt expand <code class="literal">%r</code>,
2041 <code class="literal">%f</code> and <code class="literal">%L</code>
2042 before calling the script. The example also shows that arguments can be
2043 quoted: the script will receive the expanded string between the single quotes
2044 as the only argument.
2046 A practical example is the <code class="literal">mutt_xtitle</code>
2047 script installed in the <code class="literal">samples</code>
2048 subdirectory of the Mutt documentation: it can be used as filter for
2049 <a class="link" href="#status-format" title="3.282. status_format">$status_format</a> to set the current
2050 terminal's title, if supported.
2051 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="formatstrings-padding"></a>29.4. Padding</h3></div></div></div><p>
2052 In most format strings, Mutt supports different types of padding using
2054 </p><div class="variablelist"><dl><dt><span class="term"><code class="literal">%|X</code></span></dt><dd><p>
2055 When this occurs, Mutt will fill the rest of the
2056 line with the character <code class="literal">X</code>. For
2057 example, filling the rest of the line with dashes is
2059 </p><pre class="screen">
2060 set status_format = "%v on %h: %B: %?n?%n&no? new messages %|-"</pre></dd><dt><span class="term">
2061 <code class="literal">%>X</code>
2063 Since the previous expando stops at the end of line, there must be a way
2064 to fill the gap between two items via the <code class="literal">%>X</code>
2065 expando: it puts as many characters <code class="literal">X</code> in between two
2066 items so that the rest of the line will be right-justified. For example,
2067 to not put the version string and hostname the above example on the left
2068 but on the right and fill the gap with spaces, one might use (note the
2069 space after <code class="literal">%></code>):
2070 </p><pre class="screen">
2071 set status_format = "%B: %?n?%n&no? new messages %> (%v on %h)"</pre></dd><dt><span class="term"><code class="literal">%*X</code>
2073 Normal right-justification will print everything to the left of the
2074 <code class="literal">%></code>, displaying padding and whatever lies to the
2075 right only if there's room. By contrast, “<span class="quote">soft-fill</span>” gives
2076 priority to the right-hand side, guaranteeing space to display it and
2077 showing padding only if there's still room. If necessary, soft-fill will
2078 eat text leftwards to make room for rightward text. For example, to
2079 right-justify the subject making sure as much as possible of it fits on
2080 screen, one might use (note two spaces after <code class="literal">%*
2081 </code>: the second ensures there's a space between the truncated
2082 right-hand side and the subject):
2083 </p><pre class="screen">
2084 set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s"</pre></dd></dl></div></div></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="advancedusage"></a>Chapter 4. Advanced Usage</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#regexp">1. Regular Expressions</a></span></dt><dt><span class="sect1"><a href="#patterns">2. Patterns: Searching, Limiting and Tagging</a></span></dt><dd><dl><dt><span class="sect2"><a href="#patterns-modifier">2.1. Pattern Modifier</a></span></dt><dt><span class="sect2"><a href="#simple-searches">2.2. Simple Searches</a></span></dt><dt><span class="sect2"><a href="#complex-patterns">2.3. Nesting and Boolean Operators</a></span></dt><dt><span class="sect2"><a href="#date-patterns">2.4. Searching by Date</a></span></dt></dl></dd><dt><span class="sect1"><a href="#tags">3. Using Tags</a></span></dt><dt><span class="sect1"><a href="#hooks">4. Using Hooks</a></span></dt><dd><dl><dt><span class="sect2"><a href="#pattern-hook">4.1. Message Matching in Hooks</a></span></dt></dl></dd><dt><span class="sect1"><a href="#query">5. External Address Queries</a></span></dt><dt><span class="sect1"><a href="#mailbox-formats">6. Mailbox Formats</a></span></dt><dt><span class="sect1"><a href="#shortcuts">7. Mailbox Shortcuts</a></span></dt><dt><span class="sect1"><a href="#using-lists">8. Handling Mailing Lists</a></span></dt><dt><span class="sect1"><a href="#handling-folders">9. Handling multiple folders</a></span></dt><dt><span class="sect1"><a href="#editing-threads">10. Editing Threads</a></span></dt><dd><dl><dt><span class="sect2"><a href="#link-threads">10.1. Linking Threads</a></span></dt><dt><span class="sect2"><a href="#break-threads">10.2. Breaking Threads</a></span></dt></dl></dd><dt><span class="sect1"><a href="#dsn">11. Delivery Status Notification (DSN) Support</a></span></dt><dt><span class="sect1"><a href="#urlview">12. Start a WWW Browser on URLs</a></span></dt><dt><span class="sect1"><a href="#misc-topics">13. Miscellany</a></span></dt></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="regexp"></a>1. Regular Expressions</h2></div></div></div><p>
2085 All string patterns in Mutt including those in more complex
2086 <a class="link" href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">patterns</a> must be specified
2087 using regular expressions (regexp) in the “<span class="quote">POSIX extended</span>” syntax (which
2088 is more or less the syntax used by egrep and GNU awk). For your
2089 convenience, we have included below a brief description of this syntax.
2091 The search is case sensitive if the pattern contains at least one upper
2092 case letter, and case insensitive otherwise.
2093 </p><div class="note"><h3 class="title">Note</h3><p>
2094 “<span class="quote">\</span>”
2095 must be quoted if used for a regular expression in an initialization
2096 command: “<span class="quote">\\</span>”.
2098 A regular expression is a pattern that describes a set of strings.
2099 Regular expressions are constructed analogously to arithmetic
2100 expressions, by using various operators to combine smaller expressions.
2101 </p><div class="note"><h3 class="title">Note</h3><p>
2102 The regular expression can be enclosed/delimited by either "
2103 or ' which is useful if the regular expression includes a white-space
2104 character. See <a class="xref" href="#muttrc-syntax" title="2. Syntax of Initialization Files">Syntax of Initialization Files</a>
2105 for more information on " and ' delimiter processing. To match a
2106 literal " or ' you must preface it with \ (backslash).
2108 The fundamental building blocks are the regular expressions that match
2109 a single character. Most characters, including all letters and digits,
2110 are regular expressions that match themselves. Any metacharacter with
2111 special meaning may be quoted by preceding it with a backslash.
2113 The period “<span class="quote">.</span>” matches any single character. The caret “<span class="quote">^</span>” and
2114 the dollar sign “<span class="quote">$</span>” are metacharacters that respectively match
2115 the empty string at the beginning and end of a line.
2117 A list of characters enclosed by “<span class="quote">[</span>” and “<span class="quote">]</span>” matches any
2118 single character in that list; if the first character of the list
2119 is a caret “<span class="quote">^</span>” then it matches any character <span class="emphasis"><em>not</em></span> in the
2120 list. For example, the regular expression <span class="emphasis"><em>[0123456789]</em></span>
2121 matches any single digit. A range of ASCII characters may be specified
2122 by giving the first and last characters, separated by a hyphen
2123 “<span class="quote">-</span>”. Most metacharacters lose their special meaning inside
2124 lists. To include a literal “<span class="quote">]</span>” place it first in the list.
2125 Similarly, to include a literal “<span class="quote">^</span>” place it anywhere but first.
2126 Finally, to include a literal hyphen “<span class="quote">-</span>” place it last.
2128 Certain named classes of characters are predefined. Character classes
2129 consist of “<span class="quote">[:</span>”, a keyword denoting the class, and “<span class="quote">:]</span>”.
2130 The following classes are defined by the POSIX standard in
2131 <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>
2132 </p><div class="table"><a id="posix-regex-char-classes"></a><p class="title"><b>Table 4.1. POSIX regular expression character classes</b></p><div class="table-contents"><table summary="POSIX regular expression character classes" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Character class</th><th>Description</th></tr></thead><tbody><tr><td>[:alnum:]</td><td>Alphanumeric characters</td></tr><tr><td>[:alpha:]</td><td>Alphabetic characters</td></tr><tr><td>[:blank:]</td><td>Space or tab characters</td></tr><tr><td>[:cntrl:]</td><td>Control characters</td></tr><tr><td>[:digit:]</td><td>Numeric characters</td></tr><tr><td>[:graph:]</td><td>Characters that are both printable and visible. (A space is printable, but not visible, while an “<span class="quote">a</span>” is both)</td></tr><tr><td>[:lower:]</td><td>Lower-case alphabetic characters</td></tr><tr><td>[:print:]</td><td>Printable characters (characters that are not control characters)</td></tr><tr><td>[:punct:]</td><td>Punctuation characters (characters that are not letter, digits, control characters, or space characters)</td></tr><tr><td>[:space:]</td><td>Space characters (such as space, tab and formfeed, to name a few)</td></tr><tr><td>[:upper:]</td><td>Upper-case alphabetic characters</td></tr><tr><td>[:xdigit:]</td><td>Characters that are hexadecimal digits</td></tr></tbody></table></div></div><br class="table-break" /><p>
2133 A character class is only valid in a regular expression inside the
2134 brackets of a character list.
2135 </p><div class="note"><h3 class="title">Note</h3><p>
2136 Note that the brackets in these
2137 class names are part of the symbolic names, and must be included
2138 in addition to the brackets delimiting the bracket list. For
2139 example, <span class="emphasis"><em>[[:digit:]]</em></span> is equivalent to
2140 <span class="emphasis"><em>[0-9]</em></span>.
2142 Two additional special sequences can appear in character lists. These
2143 apply to non-ASCII character sets, which can have single symbols (called
2144 collating elements) that are represented with more than one character,
2145 as well as several characters that are equivalent for collating or
2147 </p><div class="variablelist"><dl><dt><span class="term">Collating Symbols</span></dt><dd><p>
2148 A collating symbol is a multi-character collating element enclosed in
2149 “<span class="quote">[.</span>” and “<span class="quote">.]</span>”. For example, if “<span class="quote">ch</span>” is a collating
2150 element, then <span class="emphasis"><em>[[.ch.]]</em></span> is a regexp that matches
2151 this collating element, while <span class="emphasis"><em>[ch]</em></span> is a regexp that
2152 matches either “<span class="quote">c</span>” or “<span class="quote">h</span>”.
2153 </p></dd><dt><span class="term">Equivalence Classes</span></dt><dd><p>
2154 An equivalence class is a locale-specific name for a list of
2155 characters that are equivalent. The name is enclosed in “<span class="quote">[=</span>”
2156 and “<span class="quote">=]</span>”. For example, the name “<span class="quote">e</span>” might be used to
2157 represent all of “<span class="quote">è</span>” “<span class="quote">é</span>” and “<span class="quote">e</span>”. In this case,
2158 <span class="emphasis"><em>[[=e=]]</em></span> is a regexp that matches any of
2159 “<span class="quote">è</span>”, “<span class="quote">é</span>” and “<span class="quote">e</span>”.
2160 </p></dd></dl></div><p>
2161 A regular expression matching a single character may be followed by one
2162 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>.
2163 </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>
2164 Two regular expressions may be concatenated; the resulting regular
2165 expression matches any string formed by concatenating two substrings
2166 that respectively match the concatenated subexpressions.
2168 Two regular expressions may be joined by the infix operator “<span class="quote">|</span>”;
2169 the resulting regular expression matches any string matching either
2172 Repetition takes precedence over concatenation, which in turn takes
2173 precedence over alternation. A whole subexpression may be enclosed in
2174 parentheses to override these precedence rules.
2175 </p><div class="note"><h3 class="title">Note</h3><p>
2176 If you compile Mutt with the included regular expression engine, the
2177 following operators may also be used in regular expressions as described in <a class="xref" href="#regex-gnu-ext" title="Table 4.3. GNU regular expression extensions">Table 4.3, “GNU regular expression extensions”</a>.
2178 </p></div><div class="table"><a id="regex-gnu-ext"></a><p class="title"><b>Table 4.3. GNU regular expression extensions</b></p><div class="table-contents"><table summary="GNU regular expression extensions" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Expression</th><th>Description</th></tr></thead><tbody><tr><td>\\y</td><td>Matches the empty string at either the beginning or the end of a word</td></tr><tr><td>\\B</td><td>Matches the empty string within a word</td></tr><tr><td>\\<</td><td>Matches the empty string at the beginning of a word</td></tr><tr><td>\\></td><td>Matches the empty string at the end of a word</td></tr><tr><td>\\w</td><td>Matches any word-constituent character (letter, digit, or underscore)</td></tr><tr><td>\\W</td><td>Matches any character that is not word-constituent</td></tr><tr><td>\\`</td><td>Matches the empty string at the beginning of a buffer (string)</td></tr><tr><td>\\'</td><td>Matches the empty string at the end of a buffer</td></tr></tbody></table></div></div><br class="table-break" /><p>
2179 Please note however that these operators are not defined by POSIX, so
2180 they may or may not be available in stock libraries on various systems.
2181 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="patterns"></a>2. Patterns: Searching, Limiting and Tagging</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="patterns-modifier"></a>2.1. Pattern Modifier</h3></div></div></div><p>
2182 Many of Mutt's commands allow you to specify a pattern to match
2183 (<code class="literal">limit</code>, <code class="literal">tag-pattern</code>,
2184 <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>
2185 shows several ways to select messages.
2186 </p><div class="table"><a id="tab-patterns"></a><p class="title"><b>Table 4.4. Pattern modifiers</b></p><div class="table-contents"><table summary="Pattern modifiers" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Pattern modifier</th><th>Description</th></tr></thead><tbody><tr><td>~A</td><td>all messages</td></tr><tr><td>~b <span class="emphasis"><em>EXPR</em></span></td><td>messages which contain <span class="emphasis"><em>EXPR</em></span> in the message body</td></tr><tr><td>=b <span class="emphasis"><em>STRING</em></span></td><td>messages which contain <span class="emphasis"><em>STRING</em></span> in the message body. If IMAP is enabled, searches for <span class="emphasis"><em>STRING</em></span> on the server, rather than downloading each message and searching it locally.</td></tr><tr><td>~B <span class="emphasis"><em>EXPR</em></span></td><td>messages which contain <span class="emphasis"><em>EXPR</em></span> in the whole message</td></tr><tr><td>~c <span class="emphasis"><em>EXPR</em></span></td><td>messages carbon-copied to <span class="emphasis"><em>EXPR</em></span></td></tr><tr><td>%c <span class="emphasis"><em>GROUP</em></span></td><td>messages carbon-copied to any member of <span class="emphasis"><em>GROUP</em></span></td></tr><tr><td>~C <span class="emphasis"><em>EXPR</em></span></td><td>messages either to: or cc: <span class="emphasis"><em>EXPR</em></span></td></tr><tr><td>%C <span class="emphasis"><em>GROUP</em></span></td><td>messages either to: or cc: to any member of <span class="emphasis"><em>GROUP</em></span></td></tr><tr><td>~d [<span class="emphasis"><em>MIN</em></span>]-[<span class="emphasis"><em>MAX</em></span>]</td><td>messages with “<span class="quote">date-sent</span>” in a Date range</td></tr><tr><td>~D</td><td>deleted messages</td></tr><tr><td>~e <span class="emphasis"><em>EXPR</em></span></td><td>messages which contains <span class="emphasis"><em>EXPR</em></span> in the “<span class="quote">Sender</span>” field</td></tr><tr><td>%e <span class="emphasis"><em>GROUP</em></span></td><td>messages which contain a member of <span class="emphasis"><em>GROUP</em></span> in the “<span class="quote">Sender</span>” field</td></tr><tr><td>~E</td><td>expired messages</td></tr><tr><td>~F</td><td>flagged messages</td></tr><tr><td>~f <span class="emphasis"><em>EXPR</em></span></td><td>messages originating from <span class="emphasis"><em>EXPR</em></span></td></tr><tr><td>%f <span class="emphasis"><em>GROUP</em></span></td><td>messages originating from any member of <span class="emphasis"><em>GROUP</em></span></td></tr><tr><td>~g</td><td>cryptographically signed messages</td></tr><tr><td>~G</td><td>cryptographically encrypted messages</td></tr><tr><td>~h <span class="emphasis"><em>EXPR</em></span></td><td>messages which contain <span class="emphasis"><em>EXPR</em></span> in the message header</td></tr><tr><td>~H <span class="emphasis"><em>EXPR</em></span></td><td>messages with a spam attribute matching <span class="emphasis"><em>EXPR</em></span></td></tr><tr><td>~i <span class="emphasis"><em>EXPR</em></span></td><td>messages which match <span class="emphasis"><em>EXPR</em></span> in the “<span class="quote">Message-ID</span>” field</td></tr><tr><td>~k</td><td>messages which contain PGP key material</td></tr><tr><td>~L <span class="emphasis"><em>EXPR</em></span></td><td>messages either originated or received by <span class="emphasis"><em>EXPR</em></span></td></tr><tr><td>%L <span class="emphasis"><em>GROUP</em></span></td><td>message either originated or received by any member of <span class="emphasis"><em>GROUP</em></span></td></tr><tr><td>~l</td><td>messages addressed to a known mailing list</td></tr><tr><td>~m [<span class="emphasis"><em>MIN</em></span>]-[<span class="emphasis"><em>MAX</em></span>]</td><td>messages in the range <span class="emphasis"><em>MIN</em></span> to <span class="emphasis"><em>MAX</em></span> *)</td></tr><tr><td>~n [<span class="emphasis"><em>MIN</em></span>]-[<span class="emphasis"><em>MAX</em></span>]</td><td>messages with a score in the range <span class="emphasis"><em>MIN</em></span> to <span class="emphasis"><em>MAX</em></span> *)</td></tr><tr><td>~N</td><td>new messages</td></tr><tr><td>~O</td><td>old messages</td></tr><tr><td>~p</td><td>messages addressed to you (consults <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">date-received</span>” in a Date range</td></tr><tr><td>~R</td><td>read messages</td></tr><tr><td>~s <span class="emphasis"><em>EXPR</em></span></td><td>messages having <span class="emphasis"><em>EXPR</em></span> in the “<span class="quote">Subject</span>” field.</td></tr><tr><td>~S</td><td>superseded messages</td></tr><tr><td>~t <span class="emphasis"><em>EXPR</em></span></td><td>messages addressed to <span class="emphasis"><em>EXPR</em></span></td></tr><tr><td>~T</td><td>tagged messages</td></tr><tr><td>~u</td><td>messages addressed to a subscribed mailing list</td></tr><tr><td>~U</td><td>unread messages</td></tr><tr><td>~v</td><td>messages part of a collapsed thread.</td></tr><tr><td>~V</td><td>cryptographically verified messages</td></tr><tr><td>~x <span class="emphasis"><em>EXPR</em></span></td><td>messages which contain <span class="emphasis"><em>EXPR</em></span> in the “<span class="quote">References</span>” or “<span class="quote">In-Reply-To</span>” field</td></tr><tr><td>~X [<span class="emphasis"><em>MIN</em></span>]-[<span class="emphasis"><em>MAX</em></span>]</td><td>messages with <span class="emphasis"><em>MIN</em></span> to <span class="emphasis"><em>MAX</em></span> attachments *)</td></tr><tr><td>~y <span class="emphasis"><em>EXPR</em></span></td><td>messages which contain <span class="emphasis"><em>EXPR</em></span> in the “<span class="quote">X-Label</span>” field</td></tr><tr><td>~z [<span class="emphasis"><em>MIN</em></span>]-[<span class="emphasis"><em>MAX</em></span>]</td><td>messages with a size in the range <span class="emphasis"><em>MIN</em></span> to <span class="emphasis"><em>MAX</em></span> *) **)</td></tr><tr><td>~=</td><td>duplicated messages (see <a class="link" href="#duplicate-threads" title="3.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
2187 containing messages matching <span class="emphasis"><em>PATTERN</em></span>, e.g. all
2188 threads containing messages from you: ~(~P)</td></tr></tbody></table></div></div><br class="table-break" /><p>
2189 Where <span class="emphasis"><em>EXPR</em></span> is a
2190 <a class="link" href="#regexp" title="1. Regular Expressions">regular expression</a>.
2192 *) The forms “<span class="quote"><[<span class="emphasis"><em>MAX</em></span>]</span>”, “<span class="quote">>[<span class="emphasis"><em>MIN</em></span>]</span>”,
2193 “<span class="quote">[<span class="emphasis"><em>MIN</em></span>]-</span>” and “<span class="quote">-[<span class="emphasis"><em>MAX</em></span>]</span>”
2196 **) The suffixes “<span class="quote">K</span>” and “<span class="quote">M</span>” are allowed to specify kilobyte and megabyte respectively.
2198 Special attention has to be
2199 payed when using regular expressions inside of patterns. Specifically,
2200 Mutt's parser for these patterns will strip one level of backslash (“<span class="quote">\</span>”),
2201 which is normally used for quoting. If it is your intention to use a
2202 backslash in the regular expression, you will need to use two backslashes
2203 instead (“<span class="quote">\\</span>”). You can force Mutt to treat <span class="emphasis"><em>EXPR</em></span> as a simple string
2204 instead of a regular expression by using = instead of ˜ in the
2205 pattern name. For example, <code class="literal">=b *.*</code> will find all messages that contain
2206 the literal string “<span class="quote">*.*</span>”. Simple string matches are less powerful than
2207 regular expressions but can be considerably faster. This is especially
2208 true for IMAP folders, because string matches can be performed on the
2209 server instead of by fetching every message. IMAP treats <code class="literal">=h</code> specially:
2210 it must be of the form “<span class="quote">header: substring</span>” and will not partially
2211 match header names. The substring part may be omitted if you simply
2212 wish to find messages containing a particular header without regard to
2215 Patterns matching lists of addresses (notably c, C, p, P and t)
2216 match if there is at least one match in the whole list. If you want to
2217 make sure that all elements of that list match, you need to prefix your
2218 pattern with “<span class="quote">^</span>”.
2219 This example matches all mails which only has recipients from Germany.
2220 </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">
2222 </pre></div></div><br class="example-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="simple-searches"></a>2.2. Simple Searches</h3></div></div></div><p>
2223 Mutt supports two versions of so called “<span class="quote">simple searches</span>”. These are
2224 issued if the query entered for searching, limiting and similar
2225 operations does not seem to contain a valid pattern modifier (i.e. it does not contain
2226 one of these characters: “<span class="quote">˜</span>”, “<span class="quote">=</span>” or “<span class="quote">%</span>”). If the query is
2227 supposed to contain one of these special characters, they must be escaped
2228 by prepending a backslash (“<span class="quote">\</span>”).
2230 The first type is by checking whether the query string equals
2231 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>:
2232 If that is the case, Mutt will use the shown pattern modifier instead.
2233 If a keyword would conflict with your search keyword, you need to turn
2234 it into a regular expression to avoid matching the keyword table. For
2235 example, if you want to find all messages matching “<span class="quote">flag</span>”
2236 (using <a class="link" href="#simple-search" title="3.236. simple_search">$simple_search</a>)
2237 but don't want to match flagged messages, simply search for
2238 “<span class="quote"><code class="literal">[f]lag</code></span>”.
2239 </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>
2240 The second type of simple search is to build a complex search
2241 pattern using <a class="link" href="#simple-search" title="3.236. simple_search">$simple_search</a>
2242 as a template. Mutt will insert your query properly quoted and search
2243 for the composed complex query.
2244 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="complex-patterns"></a>2.3. Nesting and Boolean Operators</h3></div></div></div><p>
2245 Logical AND is performed by specifying more than one criterion. For
2247 </p><pre class="screen">
2250 would select messages which contain the word “<span class="quote">mutt</span>” in the list of
2251 recipients <span class="emphasis"><em>and</em></span> that have the word “<span class="quote">elkins</span>” in the “<span class="quote">From</span>” header
2254 Mutt also recognizes the following operators to create more complex search
2256 </p><div class="itemizedlist"><ul type="disc"><li><p>
2257 ! — logical NOT operator
2259 | — logical OR operator
2261 () — logical grouping operator
2262 </p></li></ul></div><p>
2263 Here is an example illustrating a complex search pattern. This pattern will
2264 select all messages which do not contain “<span class="quote">mutt</span>” in the “<span class="quote">To</span>” or “<span class="quote">Cc</span>”
2265 field and which are from “<span class="quote">elkins</span>”.
2266 </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">
2267 !(~t mutt|~c mutt) ~f elkins
2268 </pre></div></div><br class="example-break" /><p>
2269 Here is an example using white space in the regular expression (note
2270 the ' and " delimiters). For this to match, the mail's subject must
2271 match the “<span class="quote">^Junk +From +Me$</span>” and it must be from either “<span class="quote">Jim +Somebody</span>”
2272 or “<span class="quote">Ed +SomeoneElse</span>”:
2273 </p><pre class="screen">
2274 '~s "^Junk +From +Me$" ~f ("Jim +Somebody"|"Ed +SomeoneElse")'
2275 </pre><div class="note"><h3 class="title">Note</h3><p>
2276 If a regular expression contains parenthesis, or a vertical bar
2277 ("|"), you <span class="emphasis"><em>must</em></span> enclose the expression in double or single quotes since
2278 those characters are also used to separate different parts of Mutt's
2279 pattern language. For example: <code class="literal">~f "me@(mutt\.org|cs\.hmc\.edu)"</code>
2280 Without the quotes, the parenthesis wouldn't end.
2281 This would be separated to two OR'd patterns: <span class="emphasis"><em>˜f me@(mutt\.org</em></span>
2282 and <span class="emphasis"><em>cs\.hmc\.edu)</em></span>. They are never what you want.
2283 </p></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="date-patterns"></a>2.4. Searching by Date</h3></div></div></div><p>
2284 Mutt supports two types of dates, <span class="emphasis"><em>absolute</em></span> and <span class="emphasis"><em>relative</em></span>.
2285 </p><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="date-absolute"></a>2.4.1. Absolute Dates</h4></div></div></div><p>
2286 Dates <span class="emphasis"><em>must</em></span> be in DD/MM/YY format (month and year are
2287 optional, defaulting to the current month and year). An example of a valid
2289 </p><pre class="screen">
2290 Limit to messages matching: ~d 20/1/95-31/10
2292 If you omit the minimum (first) date, and just specify “<span class="quote">-DD/MM/YY</span>”, all
2293 messages <span class="emphasis"><em>before</em></span> the given date will be selected. If you omit the maximum
2294 (second) date, and specify “<span class="quote">DD/MM/YY-</span>”, all messages <span class="emphasis"><em>after</em></span> the given
2295 date will be selected. If you specify a single date with no dash (“<span class="quote">-</span>”),
2296 only messages sent on the given date will be selected.
2298 You can add error margins to absolute dates.
2299 An error margin is a sign (+ or -), followed by a digit, followed by
2300 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
2301 sign by a “<span class="quote">*</span>” character, which is equivalent to giving identical plus and minus error margins.
2302 </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>
2303 Example: To select any messages two weeks around January 15, 2001,
2304 you'd use the following pattern:
2305 </p><pre class="screen">
2306 Limit to messages matching: ~d 15/1/2001*2w
2307 </pre></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="dates-relative"></a>2.4.2. Relative Dates</h4></div></div></div><p>
2308 This type of date is relative to the current date, and may
2310 </p><div class="itemizedlist"><ul type="disc"><li><p>
2311 ><span class="emphasis"><em>offset</em></span> for messages older than <span class="emphasis"><em>offset</em></span> units
2313 <<span class="emphasis"><em>offset</em></span> for messages newer than <span class="emphasis"><em>offset</em></span> units
2315 =<span class="emphasis"><em>offset</em></span> for messages exactly <span class="emphasis"><em>offset</em></span> units old
2316 </p></li></ul></div><p>
2317 <span class="emphasis"><em>offset</em></span> is specified as a positive number with one of the units from <a class="xref" href="#tab-date-units" title="Table 4.6. Date units">Table 4.6, “Date units”</a>.
2319 Example: to select messages less than 1 month old, you would use
2320 </p><pre class="screen">
2321 Limit to messages matching: ~d <1m
2322 </pre><div class="note"><h3 class="title">Note</h3><p>
2323 All dates used when searching are relative to the
2324 <span class="emphasis"><em>local</em></span> time zone, so unless you change the setting of your <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> to include a
2325 <code class="literal">%[...]</code> format, these are <span class="emphasis"><em>not</em></span> the dates shown
2327 </p></div></div></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="tags"></a>3. Using Tags</h2></div></div></div><p>
2328 Sometimes it is desirable to perform an operation on a group of
2329 messages all at once rather than one at a time. An example might be
2330 to save messages to a mailing list to a separate folder, or to
2331 delete all messages with a given subject. To tag all messages
2332 matching a pattern, use the <code class="literal"><tag-pattern></code> function, which is bound to
2333 “<span class="quote">shift-T</span>” by default. Or you can select individual messages by
2334 hand using the <code class="literal"><tag-message></code> function, which is bound to “<span class="quote">t</span>” by
2335 default. See <a class="link" href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">patterns</a> for Mutt's pattern
2338 Once you have tagged the desired messages, you can use the
2339 “<span class="quote">tag-prefix</span>” operator, which is the “<span class="quote">;</span>” (semicolon) key by default.
2340 When the “<span class="quote">tag-prefix</span>” operator is used, the <span class="emphasis"><em>next</em></span> operation will
2341 be applied to all tagged messages if that operation can be used in that
2342 manner. If the <a class="link" href="#auto-tag" title="3.17. auto_tag">$auto_tag</a>
2343 variable is set, the next operation applies to the tagged messages
2344 automatically, without requiring the “<span class="quote">tag-prefix</span>”.
2346 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,
2347 you can use the <code class="literal"><tag-prefix-cond></code> operator. If there are no tagged
2348 messages, Mutt will “<span class="quote">eat</span>” the rest of the macro to abort it's execution.
2349 Mutt will stop “<span class="quote">eating</span>” the macro when it encounters the <code class="literal"><end-cond></code>
2350 operator; after this operator the rest of the macro will be executed as
2352 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="hooks"></a>4. Using Hooks</h2></div></div></div><p>
2353 A <span class="emphasis"><em>hook</em></span> is a concept found in many other programs which allows you to
2354 execute arbitrary commands before performing some operation. For example,
2355 you may wish to tailor your configuration based upon which mailbox you are
2356 reading, or to whom you are sending mail. In the Mutt world, a <span class="emphasis"><em>hook</em></span>
2357 consists of a <a class="link" href="#regexp" title="1. Regular Expressions">regular expression</a> or
2358 <a class="link" href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">pattern</a> along with a
2359 configuration option/command. See:
2361 </p><div class="itemizedlist"><ul type="disc"><li><p>
2362 <a class="link" href="#account-hook" title="6. Managing Multiple Accounts"><span class="command"><strong>account-hook</strong></span></a>
2364 <a class="link" href="#charset-hook" title="6. Defining Aliases for Character Sets"><span class="command"><strong>charset-hook</strong></span></a>
2366 <a class="link" href="#crypt-hook" title="21. Choosing the Cryptographic Key of the Recipient"><span class="command"><strong>crypt-hook</strong></span></a>
2368 <a class="link" href="#fcc-hook" title="17. Specify Default Fcc: Mailbox When Composing"><span class="command"><strong>fcc-hook</strong></span></a>
2370 <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>
2372 <a class="link" href="#folder-hook" title="7. Setting Variables Based Upon Mailbox"><span class="command"><strong>folder-hook</strong></span></a>
2374 <a class="link" href="#iconv-hook"><span class="command"><strong>iconv-hook</strong></span></a>
2376 <a class="link" href="#mbox-hook" title="13. Using Multiple Spool Mailboxes"><span class="command"><strong>mbox-hook</strong></span></a>
2378 <a class="link" href="#message-hook" title="20. Change Settings Before Formatting a Message"><span class="command"><strong>message-hook</strong></span></a>
2380 <a class="link" href="#reply-hook"><span class="command"><strong>reply-hook</strong></span></a>
2382 <a class="link" href="#save-hook" title="16. Specify Default Save Mailbox"><span class="command"><strong>save-hook</strong></span></a>
2384 <a class="link" href="#send-hook" title="19. Change Settings Based Upon Message Recipients"><span class="command"><strong>send-hook</strong></span></a>
2386 <a class="link" href="#send2-hook"><span class="command"><strong>send2-hook</strong></span></a>
2387 </p></li></ul></div><p>
2389 for specific details on each type of <span class="emphasis"><em>hook</em></span> available.
2390 </p><div class="note"><h3 class="title">Note</h3><p>
2391 If a hook changes configuration settings, these changes remain
2392 effective until the end of the current Mutt session. As this is generally
2393 not desired, a “<span class="quote">default</span>” hook needs to be added before all
2394 other hooks of that type to restore configuration defaults.
2395 </p></div><div class="example"><a id="ex-default-hook"></a><p class="title"><b>Example 4.3. Specifying a “<span class="quote">default</span>” hook</b></p><div class="example-contents"><pre class="screen">
2396 send-hook . 'unmy_hdr From:'
2397 send-hook ~C'^b@b\.b$' my_hdr from: c@c.c
2398 </pre></div></div><br class="example-break" /><p>
2399 In <a class="xref" href="#ex-default-hook" title="Example 4.3. Specifying a default hook">Example 4.3, “Specifying a default hook”</a>, by default the value of
2400 <a class="link" href="#from" title="3.75. from">$from</a>
2401 and <a class="link" href="#realname" title="3.209. realname">$realname</a>
2402 is not overridden. When sending messages either To: or Cc:
2403 to <code class="literal"><b@b.b></code>, the From: header is changed to
2404 <code class="literal"><c@c.c></code>.
2405 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pattern-hook"></a>4.1. Message Matching in Hooks</h3></div></div></div><p>
2406 Hooks that act upon messages (<span class="command"><strong>message-hook</strong></span>, <span class="command"><strong>reply-hook</strong></span>,
2407 <span class="command"><strong>send-hook</strong></span>, <span class="command"><strong>send2-hook</strong></span>, <span class="command"><strong>save-hook</strong></span>, <span class="command"><strong>fcc-hook</strong></span>) are evaluated in a
2408 slightly different manner. For the other
2409 types of hooks, a <a class="link" href="#regexp" title="1. Regular Expressions">regular expression</a> is
2410 sufficient. But in dealing with messages a finer grain of control is
2411 needed for matching since for different purposes you want to match
2414 Mutt allows the use of the <a class="link" href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">search pattern</a>
2415 language for matching messages in hook commands. This works in
2416 exactly the same way as it would when <span class="emphasis"><em>limiting</em></span> or
2417 <span class="emphasis"><em>searching</em></span> the mailbox, except that you are restricted to those
2418 operators which match information Mutt extracts from the header of
2419 the message (i.e., from, to, cc, date, subject, etc.).
2421 For example, if you wanted to set your return address based upon sending
2422 mail to a specific address, you could do something like:
2423 </p><pre class="screen">
2424 send-hook '~t ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt User <user@host>'
2426 which would execute the given command when sending mail to
2427 <span class="emphasis"><em>me@cs.hmc.edu</em></span>.
2429 However, it is not required that you write the pattern to match using the
2430 full searching language. You can still specify a simple <span class="emphasis"><em>regular
2431 expression</em></span> like the other hooks, in which case Mutt will translate your
2432 pattern into the full language, using the translation specified by the
2433 <a class="link" href="#default-hook" title="3.48. default_hook">$default_hook</a> variable. The
2434 pattern is translated at the time the hook is declared, so the value of
2435 <a class="link" href="#default-hook" title="3.48. default_hook">$default_hook</a> that is in effect
2436 at that time will be used.
2437 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="query"></a>5. External Address Queries</h2></div></div></div><p>
2438 Mutt supports connecting to external directory databases such as LDAP,
2439 ph/qi, bbdb, or NIS through a wrapper script which connects to Mutt
2440 using a simple interface. Using the <a class="link" href="#query-command" title="3.203. query_command">$query_command</a> variable, you specify the wrapper
2441 command to use. For example:
2442 </p><pre class="screen">
2443 set query_command = "mutt_ldap_query.pl '%s'"
2445 The wrapper script should accept the query on the command-line. It
2446 should return a one line message, then each matching response on a
2447 single line, each line containing a tab separated address then name then
2448 some other optional information. On error, or if there are no matching
2449 addresses, return a non-zero exit code and a one line error message.
2451 An example multiple response output:
2452 </p><pre class="screen">
2453 Searching database ... 20 entries ... 3 matching:
2454 me@cs.hmc.edu Michael Elkins mutt dude
2455 blong@fiction.net Brandon Long mutt and more
2456 roessler@does-not-exist.org Thomas Roessler mutt pgp
2458 There are two mechanisms for accessing the query function of Mutt. One
2459 is to do a query from the index menu using the <code class="literal"><query></code> function (default: Q).
2460 This will prompt for a query, then bring up the query menu which will
2461 list the matching responses. From the query menu, you can select
2462 addresses to create aliases, or to mail. You can tag multiple addresses
2463 to mail, start a new query, or have a new query appended to the current
2466 The other mechanism for accessing the query function is for address
2467 completion, similar to the alias completion. In any prompt for address
2468 entry, you can use the <code class="literal"><complete-query></code> function (default: ^T) to run a
2469 query based on the current address you have typed. Like aliases, Mutt
2470 will look for what you have typed back to the last space or comma. If
2471 there is a single response for that query, Mutt will expand the address
2472 in place. If there are multiple responses, Mutt will activate the query
2473 menu. At the query menu, you can select one or more addresses to be
2474 added to the prompt.
2475 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="mailbox-formats"></a>6. Mailbox Formats</h2></div></div></div><p>
2476 Mutt supports reading and writing of four different local mailbox formats:
2477 mbox, MMDF, MH and Maildir. The mailbox type is autodetected, so there
2478 is no need to use a flag for different mailbox types. When creating new
2479 mailboxes, Mutt uses the default specified with the
2480 <a class="link" href="#mbox-type" title="3.127. mbox_type">$mbox_type</a> variable. A
2481 short description of the formats follows.
2483 <span class="emphasis"><em>mbox</em></span>. This is a widely used mailbox format for UNIX. All
2484 messages are stored in a single file. Each message has a line of the form:
2485 </p><pre class="screen">
2486 From me@cs.hmc.edu Fri, 11 Apr 1997 11:44:56 PST
2488 to denote the start of a new message (this is often referred to as the
2489 “<span class="quote">From_</span>” line). The mbox format requires mailbox
2490 locking, is prone to mailbox corruption with concurrently writing
2491 clients or misinterpreted From_ lines. Depending on the
2492 environment, new mail detection can be unreliable. Mbox folders are fast
2493 to open and easy to archive.
2495 <span class="emphasis"><em>MMDF</em></span>. This is a variant of
2496 the <span class="emphasis"><em>mbox</em></span> format. Each message is surrounded by
2497 lines containing “<span class="quote">^A^A^A^A</span>” (four
2498 control-A's). The same problems as for mbox apply (also with finding the
2499 right message separator as four control-A's may appear in message
2502 <span class="emphasis"><em>MH</em></span>. A radical departure from <span class="emphasis"><em>mbox</em></span> and <span class="emphasis"><em>MMDF</em></span>, a mailbox
2503 consists of a directory and each message is stored in a separate file.
2504 The filename indicates the message number (however, this is may not
2505 correspond to the message number Mutt displays). Deleted messages are
2506 renamed with a comma (“<span class="quote">,</span>”) prepended to the filename. Mutt
2507 detects this type of mailbox by looking for either <code class="literal">.mh_sequences</code>
2508 or <code class="literal">.xmhcache</code> files (needed to distinguish normal directories from MH
2509 mailboxes). MH is more robust with concurrent clients writing the mailbox,
2510 but still may suffer from lost flags; message corruption is less likely
2511 to occur than with mbox/mmdf. It's usually slower to open compared to
2512 mbox/mmdf since many small files have to be read (Mutt provides
2513 <a class="xref" href="#header-caching" title="7.1. Header Caching">Section 7.1, “Header Caching”</a> to greatly speed this process up).
2514 Depending on the environment, MH is not very disk-space efficient.
2516 <span class="emphasis"><em>Maildir</em></span>. The newest of the mailbox formats, used by the Qmail MTA (a
2517 replacement for sendmail). Similar to <span class="emphasis"><em>MH</em></span>, except that it adds three
2518 subdirectories of the mailbox: <span class="emphasis"><em>tmp</em></span>, <span class="emphasis"><em>new</em></span> and <span class="emphasis"><em>cur</em></span>. Filenames
2519 for the messages are chosen in such a way they are unique, even when two
2520 programs are writing the mailbox over NFS, which means that no file locking
2521 is needed and corruption is very unlikely. Maildir maybe
2522 slower to open without caching in Mutt, it too is not very
2523 disk-space efficient depending on the environment. Since no additional
2524 files are used for metadata (which is embedded in the message filenames)
2525 and Maildir is locking-free, it's easy to sync across different machines
2526 using file-level synchronization tools.
2527 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="shortcuts"></a>7. Mailbox Shortcuts</h2></div></div></div><p>
2528 There are a number of built in shortcuts which refer to specific mailboxes.
2529 These shortcuts can be used anywhere you are prompted for a file or mailbox
2530 path or in path-related configuration variables. Note that these only
2531 work at the beginning of a string.
2532 </p><div class="itemizedlist"><ul type="disc"><li><p>
2533 ! — refers to your <a class="link" href="#spoolfile" title="3.269. spoolfile">$spoolfile</a> (incoming) mailbox
2535 > — refers to your <a class="link" href="#mbox" title="3.126. mbox">$mbox</a> file
2537 < — refers to your <a class="link" href="#record" title="3.211. record">$record</a> file
2539 ^ — refers to the current mailbox
2541 - or !! — refers to the file you've last visited
2543 ˜ — refers to your home directory
2545 = or + — refers to your <a class="link" href="#folder" title="3.66. folder">$folder</a> directory
2547 @<span class="emphasis"><em>alias</em></span> — refers to the <a class="link" href="#save-hook" title="16. Specify Default Save Mailbox">default save folder</a> as determined by the address of the alias
2548 </p></li></ul></div><p>
2549 For example, to store a copy of outgoing messages in the folder they
2551 a <a class="link" href="#folder-hook" title="7. Setting Variables Based Upon Mailbox"><span class="command"><strong>folder-hook</strong></span></a> can
2552 be used to set <a class="link" href="#record" title="3.211. record">$record</a>:
2553 </p><pre class="screen">
2554 folder-hook . 'set record=^'</pre></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="using-lists"></a>8. Handling Mailing Lists</h2></div></div></div><p>
2555 Mutt has a few configuration options that make dealing with large
2556 amounts of mail easier. The first thing you must do is to let Mutt
2557 know what addresses you consider to be mailing lists (technically
2558 this does not have to be a mailing list, but that is what it is most
2559 often used for), and what lists you are subscribed to. This is
2560 accomplished through the use of the <a class="link" href="#lists" title="12. Mailing Lists"><span class="command"><strong>lists</strong></span> and <span class="command"><strong>subscribe</strong></span></a> commands in your <code class="literal">.muttrc</code>.
2562 Now that Mutt knows what your mailing lists are, it can do several
2563 things, the first of which is the ability to show the name of a list
2564 through which you received a message (i.e., of a subscribed list) in
2565 the <span class="emphasis"><em>index</em></span> menu display. This is useful to distinguish between
2566 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 “<span class="quote">%L</span>”
2567 will print the string “<span class="quote">To <list></span>” when “<span class="quote">list</span>” appears in the
2568 “<span class="quote">To</span>” field, and “<span class="quote">Cc <list></span>” when it appears in the “<span class="quote">Cc</span>”
2569 field (otherwise it prints the name of the author).
2571 Often times the “<span class="quote">To</span>” and “<span class="quote">Cc</span>” fields in mailing list messages
2572 tend to get quite large. Most people do not bother to remove the
2573 author of the message they reply to from the list, resulting in
2574 two or more copies being sent to that person. The <code class="literal"><list-reply></code>
2575 function, which by default is bound to “<span class="quote">L</span>” in the <span class="emphasis"><em>index</em></span> menu
2576 and <span class="emphasis"><em>pager</em></span>, helps reduce the clutter by only replying to the
2577 known mailing list addresses instead of all recipients (except as
2578 specified by <code class="literal">Mail-Followup-To</code>, see below).
2580 Mutt also supports the <code class="literal">Mail-Followup-To</code> header. When you send
2581 a message to a list of recipients which includes one or several
2582 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 generate
2583 a Mail-Followup-To header which contains all the recipients to whom
2584 you send this message, but not your address. This indicates that
2585 group-replies or list-replies (also known as “<span class="quote">followups</span>”) to this
2586 message should only be sent to the original recipients of the
2587 message, and not separately to you - you'll receive your copy through
2588 one of the mailing lists you are subscribed to.
2590 Conversely, when group-replying or list-replying to a message which
2591 has a <code class="literal">Mail-Followup-To</code> header, Mutt will respect this header if
2592 the <a class="link" href="#honor-followup-to" title="3.92. honor_followup_to">$honor_followup_to</a> configuration
2593 variable is set. Using <a class="link" href="#list-reply">list-reply</a> will in this case also make sure
2594 that the reply goes to the mailing list, even if it's not specified
2595 in the list of recipients in the <code class="literal">Mail-Followup-To</code>.
2596 </p><div class="note"><h3 class="title">Note</h3><p>
2597 When header editing is enabled, you can create a
2598 <code class="literal">Mail-Followup-To</code> header manually. Mutt will only auto-generate
2599 this header if it doesn't exist when you send the message.
2601 The other method some mailing list admins use is to generate a
2602 “<span class="quote">Reply-To</span>” field which points back to the mailing list address rather
2603 than the author of the message. This can create problems when trying
2604 to reply directly to the author in private, since most mail clients
2605 will automatically reply to the address given in the “<span class="quote">Reply-To</span>”
2606 field. Mutt uses the <a class="link" href="#reply-to" title="3.214. reply_to">$reply_to</a>
2607 variable to help decide which address to use. If set to <span class="emphasis"><em>ask-yes</em></span> or
2608 <span class="emphasis"><em>ask-no</em></span>, you will be
2609 prompted as to whether or not you would like to use the address given in
2610 the “<span class="quote">Reply-To</span>” field, or reply directly to the address given in the
2611 “<span class="quote">From</span>” field. When set to <span class="emphasis"><em>yes</em></span>, the “<span class="quote">Reply-To</span>” field will be used when
2614 The “<span class="quote">X-Label:</span>” header field can be used to further identify mailing
2615 lists or list subject matter (or just to annotate messages
2616 individually). The <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> variable's “<span class="quote">%y</span>” and
2617 “<span class="quote">%Y</span>” expandos can be used to expand “<span class="quote">X-Label:</span>” fields in the
2618 index, and Mutt's pattern-matcher can match regular expressions to
2619 “<span class="quote">X-Label:</span>” fields with the “<span class="quote">˜y</span>” selector. “<span class="quote">X-Label:</span>” is not a
2620 standard message header field, but it can easily be inserted by procmail
2621 and other mail filtering agents.
2623 Lastly, Mutt has the ability to <a class="link" href="#sort" title="3.263. sort">sort</a> the mailbox into
2624 <a class="link" href="#threads" title="5.3. Threaded Mode">threads</a>. A thread is a group of messages which all relate to the same
2625 subject. This is usually organized into a tree-like structure where a
2626 message and all of its replies are represented graphically. If you've ever
2627 used a threaded news client, this is the same concept. It makes dealing
2628 with large volume mailing lists easier because you can easily delete
2629 uninteresting threads and quickly find topics of value.
2630 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="handling-folders"></a>9. Handling multiple folders</h2></div></div></div><p>
2631 Mutt supports setups with multiple folders, allowing all of them to
2632 be monitored for new mail (see <a class="xref" href="#mailboxes" title="14. Monitoring Incoming Mail">Section 14, “Monitoring Incoming Mail”</a> for details).
2634 When in the index menu and being idle (also see
2635 <a class="link" href="#timeout" title="3.291. timeout">$timeout</a>), Mutt periodically checks
2636 for new mail in all folders which have been configured via the
2637 <span class="command"><strong>mailboxes</strong></span> command. The interval depends on the folder
2638 type: for local/IMAP folders it consults
2639 <a class="link" href="#mail-check" title="3.118. mail_check">$mail_check</a> and
2640 <a class="link" href="#pop-checkinterval" title="3.187. pop_checkinterval">$pop_checkinterval</a>
2643 Outside the index menu the directory browser supports checking
2644 for new mail using the <code class="literal"><check-new></code> function which is
2645 unbound by default. Pressing TAB will bring up a
2646 menu showing the files specified by the <span class="command"><strong>mailboxes</strong></span> command,
2647 and indicate which contain new messages. Mutt will automatically enter this
2648 mode when invoked from the command line with the <code class="literal">-y</code> option.
2650 For the pager, index and directory browser menus, Mutt contains the
2651 <code class="literal"><buffy-list></code> function (bound to “<span class="quote">.</span>” by default)
2652 which will print a list of folders with new mail in the command line at
2653 the bottom of the screen.
2655 For the index, by default Mutt displays the number of mailboxes with new
2656 mail in the status bar, please refer to the
2657 <a class="link" href="#status-format" title="3.282. status_format">$status_format</a>
2658 variable for details.
2660 When changing folders, Mutt fills the prompt with the first folder from
2661 the mailboxes list containing new mail (if any), pressing
2662 <span class="emphasis"><em>space</em></span> will cycle through folders with new mail.
2663 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="editing-threads"></a>10. Editing Threads</h2></div></div></div><p>
2664 Mutt has the ability to dynamically restructure threads that are broken
2665 either by misconfigured software or bad behavior from some
2666 correspondents. This allows to clean your mailboxes from these
2667 annoyances which make it hard to follow a discussion.
2668 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="link-threads"></a>10.1. Linking Threads</h3></div></div></div><p>
2669 Some mailers tend to “<span class="quote">forget</span>” to correctly set the “<span class="quote">In-Reply-To:</span>” and
2670 “<span class="quote">References:</span>” headers when replying to a message. This results in broken
2671 discussions because Mutt has not enough information to guess the correct
2673 You can fix this by tagging the reply, then moving to the parent message
2674 and using the <code class="literal"><link-threads></code> function (bound to & by default). The
2675 reply will then be connected to this parent message.
2677 You can also connect multiple children at once, tagging them and using the
2678 <code class="literal"><tag-prefix></code> command (';') or the <a class="link" href="#auto-tag" title="3.17. auto_tag">$auto_tag</a> option.
2679 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="break-threads"></a>10.2. Breaking Threads</h3></div></div></div><p>
2680 On mailing lists, some people are in the bad habit of starting a new
2681 discussion by hitting “<span class="quote">reply</span>” to any message from the list and changing
2682 the subject to a totally unrelated one.
2683 You can fix such threads by using the <code class="literal"><break-thread></code> function (bound
2684 by default to #), which will turn the subthread starting from the
2685 current message into a whole different thread.
2686 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="dsn"></a>11. Delivery Status Notification (DSN) Support</h2></div></div></div><p>
2687 RFC1894 defines a set of MIME content types for relaying information
2688 about the status of electronic mail messages. These can be thought of as
2689 “<span class="quote">return receipts.</span>”
2691 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
2692 different results (such as failed message, message delivered, etc.).
2693 <a class="link" href="#dsn-return" title="3.55. dsn_return">$dsn_return</a> requests how much
2694 of your message should be returned with the receipt (headers or full
2697 When using <a class="link" href="#sendmail" title="3.230. sendmail">$sendmail</a> for mail
2698 delivery, you need to use either Berkeley sendmail 8.8.x (or greater) a MTA
2699 supporting DSN command line options compatible to Sendmail: The -N and -R
2700 options can be used by the mail client to make requests as to what type of
2701 status messages should be returned. Please consider your MTA documentation
2702 whether DSN is supported.
2704 For SMTP delivery using <a class="link" href="#smtp-url" title="3.262. smtp_url">$smtp_url</a>, it depends on the
2705 capabilities announced by the server whether Mutt will attempt to
2707 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="urlview"></a>12. Start a WWW Browser on URLs</h2></div></div></div><p>
2708 If a message contains URLs, it is efficient to get
2709 a menu with all the URLs and start a WWW browser on one of them. This
2710 functionality is provided by the external urlview program which can be
2712 <a class="ulink" href="ftp://ftp.mutt.org/mutt/contrib/" target="_top">ftp://ftp.mutt.org/mutt/contrib/</a>
2713 and the configuration commands:
2714 </p><pre class="screen">
2715 macro index \cb |urlview\n
2716 macro pager \cb |urlview\n
2717 </pre></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="misc-topics"></a>13. Miscellany</h2></div></div></div><p>
2718 This section documents various features that fit nowhere else.
2719 </p><div class="variablelist"><dl><dt><span class="term">
2720 Address normalization
2722 Mutt normalizes all e-mail addresses to the simplest form possible. If
2723 an address contains a realname, the form
2724 <span class="emphasis"><em>Joe User <joe@example.com></em></span> is used and the
2725 pure e-mail address without angle brackets otherwise, i.e. just
2726 <span class="emphasis"><em>joe@example.com</em></span>.
2728 This normalization affects all headers Mutt generates including aliases.
2729 </p></dd><dt><span class="term">
2730 Initial folder selection
2732 The folder Mutt opens at startup is determined as follows: the folder
2733 specified in the <code class="literal">$MAIL</code> environment variable if
2734 present. Otherwise, the value of <code class="literal">$MAILDIR</code> is taken
2735 into account. If that isn't present either, Mutt takes the user's
2736 mailbox in the mailspool as determined at compile-time (which may also
2737 reside in the home directory). The
2738 <a class="link" href="#spoolfile" title="3.269. spoolfile">$spoolfile</a> setting overrides
2739 this selection. Highest priority has the mailbox given with the
2740 <code class="literal">-f</code> command line option.
2741 </p></dd></dl></div></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="mimesupport"></a>Chapter 5. Mutt's MIME Support</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#using-mime">1. Using MIME in Mutt</a></span></dt><dd><dl><dt><span class="sect2"><a href="#mime-pager">1.1. Viewing MIME Messages in the Pager</a></span></dt><dt><span class="sect2"><a href="#attach-menu">1.2. The Attachment Menu</a></span></dt><dt><span class="sect2"><a href="#compose-menu">1.3. The Compose Menu</a></span></dt></dl></dd><dt><span class="sect1"><a href="#mime-types">2. MIME Type Configuration with mime.types</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>
2742 Quite a bit of effort has been made to make Mutt the premier text-mode
2743 MIME MUA. Every effort has been made to provide the functionality that
2744 the discerning MIME user requires, and the conformance to the standards
2745 wherever possible. When configuring Mutt for MIME, there are two extra
2746 types of configuration files which Mutt uses. One is the
2747 <code class="literal">mime.types</code> file, which contains the mapping of file extensions to
2748 IANA MIME types. The other is the <code class="literal">mailcap</code> file, which specifies
2749 the external commands to use for handling specific MIME types.
2750 </p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="using-mime"></a>1. Using MIME in Mutt</h2></div></div></div><p>
2751 There are three areas/menus in Mutt which deal with MIME, they are the
2752 pager (while viewing a message), the attachment menu and the compose
2754 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mime-pager"></a>1.1. Viewing MIME Messages in the Pager</h3></div></div></div><p>
2755 When you select a message from the index and view it in the pager, Mutt
2756 decodes the message to a text representation. Mutt internally supports
2757 a number of MIME types, including <code class="literal">text/plain, text/enriched,
2758 message/rfc822, and message/news</code>. In addition, the export
2759 controlled version of Mutt recognizes a variety of PGP MIME types,
2760 including PGP/MIME and application/pgp.
2762 Mutt will denote attachments with a couple lines describing them.
2763 These lines are of the form:
2764 </p><pre class="screen">
2765 [-- Attachment #1: Description --]
2766 [-- Type: text/plain, Encoding: 7bit, Size: 10000 --]
2768 Where the <code class="literal">Description</code> is the description or filename given for the
2769 attachment, and the <code class="literal">Encoding</code> is one of
2770 <code class="literal">7bit/8bit/quoted-printable/base64/binary</code>.
2772 If Mutt cannot deal with a MIME type, it will display a message like:
2773 </p><pre class="screen">
2774 [-- image/gif is unsupported (use 'v' to view this part) --]
2775 </pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="attach-menu"></a>1.2. The Attachment Menu</h3></div></div></div><p>
2776 The default binding for <code class="literal"><view-attachments></code> is “<span class="quote">v</span>”, which displays the
2777 attachment menu for a message. The attachment menu displays a list of
2778 the attachments in a message. From the attachment menu, you can save,
2779 print, pipe, delete, and view attachments. You can apply these
2780 operations to a group of attachments at once, by tagging the attachments
2781 and by using the <code class="literal"><tag-prefix></code> operator. You can also reply to the
2782 current message from this menu, and only the current attachment (or the
2783 attachments tagged) will be quoted in your reply. You can view
2784 attachments as text, or view them using the mailcap viewer definition.
2786 Finally, you can apply the usual message-related functions (like
2787 <a class="link" href="#resend-message"><code class="literal"><resend-message></code></a>, and the
2788 <code class="literal"><reply></code> and <code class="literal"><forward></code>
2789 functions) to attachments of type <code class="literal">message/rfc822</code>.
2791 See the help on the attachment menu for more information.
2792 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="compose-menu"></a>1.3. The Compose Menu</h3></div></div></div><p>
2793 The compose menu is the menu you see before you send a message. It
2794 allows you to edit the recipient list, the subject, and other aspects
2795 of your message. It also contains a list of the attachments of your
2796 message, including the main body. From this menu, you can print, copy,
2797 filter, pipe, edit, compose, review, and rename an attachment or a
2798 list of tagged attachments. You can also modifying the attachment
2799 information, notably the type, encoding and description.
2801 Attachments appear as follows:
2802 </p><pre class="screen">
2803 - 1 [text/plain, 7bit, 1K] /tmp/mutt-euler-8082-0 <no description>
2804 2 [applica/x-gunzip, base64, 422K] ~/src/mutt-0.85.tar.gz <no description>
2806 The '-' denotes that Mutt will delete the file after sending (or
2807 postponing, or canceling) the message. It can be toggled with the
2808 <code class="literal"><toggle-unlink></code> command (default: u). The next field is the MIME
2809 content-type, and can be changed with the <code class="literal"><edit-type></code> command
2810 (default: ^T). The next field is the encoding for the attachment,
2811 which allows a binary message to be encoded for transmission on 7bit
2812 links. It can be changed with the <code class="literal"><edit-encoding></code> command
2813 (default: ^E). The next field is the size of the attachment,
2814 rounded to kilobytes or megabytes. The next field is the filename,
2815 which can be changed with the <code class="literal"><rename-file></code> command (default: R).
2816 The final field is the description of the attachment, and can be
2817 changed with the <code class="literal"><edit-description></code> command (default: d).
2818 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="mime-types"></a>2. MIME Type Configuration with <code class="literal">mime.types</code></h2></div></div></div><p>
2819 When you add an attachment to your mail message, Mutt searches your
2820 personal <code class="literal">mime.types</code> file at <code class="literal">${HOME}/.mime.types</code>, and then
2821 the system <code class="literal">mime.types</code> file at <code class="literal">/usr/local/share/mutt/mime.types</code> or
2822 <code class="literal">/etc/mime.types</code>
2824 The <code class="literal">mime.types</code> file consist of lines containing a MIME type and a space
2825 separated list of extensions. For example:
2826 </p><pre class="screen">
2827 application/postscript ps eps
2829 audio/x-aiff aif aifc aiff
2831 A sample <code class="literal">mime.types</code> file comes with the Mutt distribution, and
2832 should contain most of the MIME types you are likely to use.
2834 If Mutt can not determine the mime type by the extension of the file you
2835 attach, it will look at the file. If the file is free of binary
2836 information, Mutt will assume that the file is plain text, and mark it
2837 as <code class="literal">text/plain</code>. If the file contains binary information, then Mutt will
2838 mark it as <code class="literal">application/octet-stream</code>. You can change the MIME
2839 type that Mutt assigns to an attachment by using the <code class="literal"><edit-type></code>
2840 command from the compose menu (default: ^T). The MIME type is actually a
2841 major mime type followed by the sub-type, separated by a '/'. 6 major
2842 types: application, text, image, video, audio, and model have been approved
2843 after various internet discussions. Mutt recognizes all of these if the
2844 appropriate entry is found in the <code class="literal">mime.types</code> file. It also recognizes other
2845 major mime types, such as the chemical type that is widely used in the
2846 molecular modeling community to pass molecular data in various forms to
2847 various molecular viewers. Non-recognized mime types should only be used
2848 if the recipient of the message is likely to be expecting such attachments.
2849 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="mailcap"></a>3. MIME Viewer Configuration with Mailcap</h2></div></div></div><p>
2850 Mutt supports RFC 1524 MIME Configuration, in particular the Unix
2851 specific format specified in Appendix A of RFC 1524. This file format
2852 is commonly referred to as the mailcap format. Many MIME compliant
2853 programs utilize the mailcap format, allowing you to specify handling
2854 for all MIME types in one place for all programs. Programs known to
2855 use this format include Firefox, lynx and metamail.
2857 In order to handle various MIME types that Mutt can not handle
2858 internally, Mutt parses a series of external configuration files to
2859 find an external handler. The default search string for these files
2860 is a colon delimited list containing the following files:
2861 </p><div class="orderedlist"><ol type="1"><li><p><code class="literal">$HOME/.mailcap</code></p></li><li><p><code class="literal">$PKGDATADIR/mailcap</code></p></li><li><p><code class="literal">$SYSCONFDIR/mailcap</code></p></li><li><p><code class="literal">/etc/mailcap</code></p></li><li><p><code class="literal">/usr/etc/mailcap</code></p></li><li><p><code class="literal">/usr/local/etc/mailcap</code></p></li></ol></div><p>
2862 where <code class="literal">$HOME</code> is your home directory. The
2863 <code class="literal">$PKGDATADIR</code> and the
2864 <code class="literal">$SYSCONFDIR</code> directories depend on where Mutt
2865 is installed: the former is the default for shared data, the
2866 latter for system configuration files.
2868 The default search path can be obtained by running the following
2870 </p><pre class="screen">
2871 mutt -nF /dev/null -Q mailcap_path
2873 In particular, the metamail distribution will install a mailcap file,
2874 usually as <code class="literal">/usr/local/etc/mailcap</code>, which contains some baseline
2876 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mailcap-basics"></a>3.1. The Basics of the Mailcap File</h3></div></div></div><p>
2877 A mailcap file consists of a series of lines which are comments, blank,
2880 A comment line consists of a # character followed by anything you want.
2882 A blank line is blank.
2884 A definition line consists of a content type, a view command, and any
2885 number of optional fields. Each field of a definition line is divided
2886 by a semicolon ';' character.
2888 The content type is specified in the MIME standard type/subtype method.
2890 <code class="literal">text/plain, text/html, image/gif, </code>
2891 etc. In addition, the mailcap format includes two formats for
2892 wildcards, one using the special '*' subtype, the other is the implicit
2893 wild, where you only include the major type. For example, <code class="literal">image/*</code>, or
2894 <code class="literal">video,</code> will match all image types and video types,
2897 The view command is a Unix command for viewing the type specified. There
2898 are two different types of commands supported. The default is to send
2899 the body of the MIME message to the command on stdin. You can change
2900 this behavior by using %s as a parameter to your view command.
2901 This will cause Mutt to save the body of the MIME message to a temporary
2902 file, and then call the view command with the %s replaced by
2903 the name of the temporary file. In both cases, Mutt will turn over the
2904 terminal to the view program until the program quits, at which time Mutt
2905 will remove the temporary file if it exists.
2907 So, in the simplest form, you can send a text/plain message to the
2908 external pager more on stdin:
2909 </p><pre class="screen">
2912 Or, you could send the message as a file:
2913 </p><pre class="screen">
2916 Perhaps you would like to use lynx to interactively view a text/html
2918 </p><pre class="screen">
2921 In this case, lynx does not support viewing a file from stdin, so you
2922 must use the %s syntax.
2923 </p><div class="note"><h3 class="title">Note</h3><p>
2924 <span class="emphasis"><em>Some older versions of lynx contain a bug where they
2925 will check the mailcap file for a viewer for text/html. They will find
2926 the line which calls lynx, and run it. This causes lynx to continuously
2927 spawn itself to view the object.</em></span>
2929 On the other hand, maybe you don't want to use lynx interactively, you
2930 just want to have it convert the text/html to text/plain, then you can
2932 </p><pre class="screen">
2933 text/html; lynx -dump %s | more
2935 Perhaps you wish to use lynx to view text/html files, and a pager on
2936 all other text formats, then you would use the following:
2937 </p><pre class="screen">
2941 This is the simplest form of a mailcap file.
2942 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="secure-mailcap"></a>3.2. Secure Use of Mailcap</h3></div></div></div><p>
2943 The interpretation of shell meta-characters embedded in MIME parameters
2944 can lead to security problems in general. Mutt tries to quote parameters
2945 in expansion of %s syntaxes properly, and avoids risky characters by
2946 substituting them, see the <a class="link" href="#mailcap-sanitize" title="3.120. mailcap_sanitize">$mailcap_sanitize</a> variable.
2948 Although Mutt's procedures to invoke programs with mailcap seem to be
2949 safe, there are other applications parsing mailcap, maybe taking less care
2950 of it. Therefore you should pay attention to the following rules:
2952 <span class="emphasis"><em>Keep the %-expandos away from shell quoting.</em></span>
2953 Don't quote them with single or double quotes. Mutt does this for
2954 you, the right way, as should any other program which interprets
2955 mailcap. Don't put them into backtick expansions. Be highly careful
2956 with eval statements, and avoid them if possible at all. Trying to fix
2957 broken behavior with quotes introduces new leaks - there is no
2958 alternative to correct quoting in the first place.
2960 If you have to use the %-expandos' values in context where you need
2961 quoting or backtick expansions, put that value into a shell variable
2962 and reference the shell variable where necessary, as in the following
2963 example (using <code class="literal">$charset</code> inside the backtick expansion is safe,
2964 since it is not itself subject to any further expansion):
2965 </p><pre class="screen">
2966 text/test-mailcap-bug; cat %s; copiousoutput; test=charset=%{charset} \
2967 && test "`echo $charset | tr '[A-Z]' '[a-z]'`" != iso-8859-1
2968 </pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="advanced-mailcap"></a>3.3. Advanced Mailcap Usage</h3></div></div></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="optional-mailcap-fields"></a>3.3.1. Optional Fields</h4></div></div></div><p>
2969 In addition to the required content-type and view command fields, you
2970 can add semi-colon ';' separated fields to set flags and other options.
2971 Mutt recognizes the following optional fields:
2972 </p><div class="variablelist"><dl><dt><span class="term">copiousoutput</span></dt><dd><p>
2973 This flag tells Mutt that the command passes possibly large amounts of
2974 text on stdout. This causes Mutt to invoke a pager (either the internal
2975 pager or the external pager defined by the pager variable) on the output
2976 of the view command. Without this flag, Mutt assumes that the command
2977 is interactive. One could use this to replace the pipe to <code class="literal">more</code>
2978 in the <code class="literal">lynx -dump</code> example in the Basic section:
2979 </p><pre class="screen">
2980 text/html; lynx -dump %s ; copiousoutput
2982 This will cause lynx to format the text/html output as text/plain
2983 and Mutt will use your standard pager to display the results.
2984 </p></dd><dt><span class="term">needsterminal</span></dt><dd><p>
2985 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 decide whether it should honor the setting
2986 of the <a class="link" href="#wait-key" title="3.304. wait_key">$wait_key</a> variable or
2987 not. When an attachment is viewed using an interactive program, and the
2988 corresponding mailcap entry has a <span class="emphasis"><em>needsterminal</em></span> flag, Mutt will use
2989 <a class="link" href="#wait-key" title="3.304. wait_key">$wait_key</a> and the exit status
2990 of the program to decide if it will ask you to press a key after the
2991 external program has exited. In all other situations it will not prompt
2993 </p></dd><dt><span class="term">compose=<command></span></dt><dd><p>
2994 This flag specifies the command to use to create a new attachment of a
2995 specific MIME type. Mutt supports this from the compose menu.
2996 </p></dd><dt><span class="term">composetyped=<command></span></dt><dd><p>
2997 This flag specifies the command to use to create a new attachment of a
2998 specific MIME type. This command differs from the compose command in
2999 that Mutt will expect standard MIME headers on the data. This can be
3000 used to specify parameters, filename, description, etc. for a new
3001 attachment. Mutt supports this from the compose menu.
3002 </p></dd><dt><span class="term">print=<command></span></dt><dd><p>
3003 This flag specifies the command to use to print a specific MIME type.
3004 Mutt supports this from the attachment and compose menus.
3005 </p></dd><dt><span class="term">edit=<command></span></dt><dd><p>
3006 This flag specifies the command to use to edit a specific MIME type.
3007 Mutt supports this from the compose menu, and also uses it to compose
3008 new attachments. Mutt will default to the defined editor for text
3010 </p></dd><dt><span class="term">nametemplate=<template></span></dt><dd><p>
3011 This field specifies the format for the file denoted by %s in the
3012 command fields. Certain programs will require a certain file extension,
3013 for instance, to correctly view a file. For instance, lynx will only
3014 interpret a file as <code class="literal">text/html</code> if the file ends in <code class="literal">.html</code>.
3015 So, you would specify lynx as a <code class="literal">text/html</code> viewer with a line in
3016 the mailcap file like:
3017 </p><pre class="screen">
3018 text/html; lynx %s; nametemplate=%s.html
3019 </pre></dd><dt><span class="term">test=<command></span></dt><dd><p>
3020 This field specifies a command to run to test whether this mailcap
3021 entry should be used. The command is defined with the command expansion
3022 rules defined in the next section. If the command returns 0, then the
3023 test passed, and Mutt uses this entry. If the command returns non-zero,
3024 then the test failed, and Mutt continues searching for the right entry.
3025 Note that the content-type must match before Mutt performs the test.
3027 </p><pre class="screen">
3028 text/html; firefox -remote 'openURL(%s)' ; test=RunningX
3031 In this example, Mutt will run the program RunningX which will return 0
3032 if the X Window manager is running, and non-zero if it isn't. If
3033 RunningX returns 0, then Mutt will call firefox to display the
3034 <code class="literal">text/html</code> object. If RunningX doesn't return 0, then Mutt will go on
3035 to the next entry and use lynx to display the <code class="literal">text/html</code> object.
3036 </p></dd></dl></div></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="mailcap-search-order"></a>3.3.2. Search Order</h4></div></div></div><p>
3037 When searching for an entry in the mailcap file, Mutt will search for
3038 the most useful entry for its purpose. For instance, if you are
3039 attempting to print an <code class="literal">image/gif</code>, and you have the following
3040 entries in your mailcap file, Mutt will search for an entry with the
3042 </p><pre class="screen">
3044 image/gif; ; print= anytopnm %s | pnmtops | lpr; \
3047 Mutt will skip the <code class="literal">image/*</code> entry and use the <code class="literal">image/gif</code>
3048 entry with the print command.
3050 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>
3051 to denote two commands for viewing an attachment, one to be viewed
3052 automatically, the other to be viewed interactively from the attachment
3053 menu. In addition, you can then use the test feature to determine which
3054 viewer to use interactively depending on your environment.
3055 </p><pre class="screen">
3056 text/html; firefox -remote 'openURL(%s)' ; test=RunningX
3057 text/html; lynx %s; nametemplate=%s.html
3058 text/html; lynx -dump %s; nametemplate=%s.html; copiousoutput
3060 For <a class="link" href="#auto-view" title="4. MIME Autoview"><span class="command"><strong>auto_view</strong></span></a>, Mutt will choose the third
3061 entry because of the copiousoutput tag. For interactive viewing, Mutt
3062 will run the program RunningX to determine if it should use the first
3063 entry. If the program returns non-zero, Mutt will use the second entry
3064 for interactive viewing.
3065 </p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="mailcap-command-expansion"></a>3.3.3. Command Expansion</h4></div></div></div><p>
3066 The various commands defined in the mailcap files are passed to the
3067 <code class="literal">/bin/sh</code> shell using the <code class="literal">system(3)</code> function. Before the
3068 command is passed to <code class="literal">/bin/sh -c</code>, it is parsed to expand
3069 various special parameters with information from Mutt. The keywords
3071 </p><div class="variablelist"><dl><dt><span class="term">%s</span></dt><dd><p>
3072 As seen in the basic mailcap section, this variable is expanded
3073 to a filename specified by the calling program. This file contains
3074 the body of the message to view/print/edit or where the composing
3075 program should place the results of composition. In addition, the
3076 use of this keyword causes Mutt to not pass the body of the message
3077 to the view/print/edit program on stdin.
3078 </p></dd><dt><span class="term">%t</span></dt><dd><p>
3079 Mutt will expand %t to the text representation of the content
3080 type of the message in the same form as the first parameter of the
3081 mailcap definition line, ie <code class="literal">text/html</code> or
3082 <code class="literal">image/gif</code>.
3083 </p></dd><dt><span class="term">%{<parameter>}</span></dt><dd><p>
3084 Mutt will expand this to the value of the specified parameter
3085 from the Content-Type: line of the mail message. For instance, if
3086 Your mail message contains:
3087 </p><pre class="screen">
3088 Content-Type: text/plain; charset=iso-8859-1
3090 then Mutt will expand %{charset} to iso-8859-1. The default metamail
3091 mailcap file uses this feature to test the charset to spawn an xterm
3092 using the right charset to view the message.
3093 </p></dd><dt><span class="term">\%</span></dt><dd><p>
3094 This will be replaced by a %
3095 </p></dd></dl></div><p>
3096 Mutt does not currently support the %F and %n keywords
3097 specified in RFC 1524. The main purpose of these parameters is for
3098 multipart messages, which is handled internally by Mutt.
3099 </p></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mailcap-example"></a>3.4. Example Mailcap Files</h3></div></div></div><p>
3100 This mailcap file is fairly simple and standard:
3101 </p><pre class="screen">
3102 # I'm always running X :)
3103 video/*; xanim %s > /dev/null
3104 image/*; xv %s > /dev/null
3106 # I'm always running firefox (if my computer had more memory, maybe)
3107 text/html; firefox -remote 'openURL(%s)'
3109 This mailcap file shows quite a number of examples:
3110 </p><pre class="screen">
3111 # Use xanim to view all videos Xanim produces a header on startup,
3112 # send that to /dev/null so I don't see it
3113 video/*; xanim %s > /dev/null
3115 # Send html to a running firefox by remote
3116 text/html; firefox -remote 'openURL(%s)'; test=RunningFirefox
3118 # If I'm not running firefox but I am running X, start firefox on the
3120 text/html; firefox %s; test=RunningX
3122 # Else use lynx to view it as text
3125 # This version would convert the text/html to text/plain
3126 text/html; lynx -dump %s; copiousoutput
3128 # I use enscript to print text in two columns to a page
3129 text/*; more %s; print=enscript -2Gr %s
3131 # Firefox adds a flag to tell itself to view jpegs internally
3132 image/jpeg;xv %s; x-mozilla-flags=internal
3134 # Use xv to view images if I'm running X
3135 # In addition, this uses the \ to extend the line and set my editor
3137 image/*;xv %s; test=RunningX; \
3140 # Convert images to text using the netpbm tools
3141 image/*; (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | pgmtopbm |
3142 pbmtoascii -1x2 ) 2>&1 ; copiousoutput
3144 # Send excel spreadsheets to my NT box
3145 application/ms-excel; open.pl %s
3146 </pre></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="auto-view"></a>4. MIME Autoview</h2></div></div></div><p>
3148 </p><div class="cmdsynopsis"><p><code class="command">auto-view</code>
3149 <em class="replaceable"><code>mimetype</code></em>
3151 <em class="replaceable"><code>mimetype</code></em>
3152 ...]<br /><code class="command">unauto-view</code> {
3153 <em class="replaceable"><code>*</code></em>
3155 <em class="replaceable"><code>mimetype</code></em>
3157 In addition to explicitly telling Mutt to view an attachment with the
3158 MIME viewer defined in the mailcap file, Mutt has support for
3159 automatically viewing MIME attachments while in the pager.
3161 To work, you must define a viewer in the mailcap file which uses the
3162 <code class="literal">copiousoutput</code> option to denote that it is non-interactive.
3163 Usually, you also use the entry to convert the attachment to a text
3164 representation which you can view in the pager.
3166 You then use the <span class="command"><strong>auto_view</strong></span> <code class="literal">.muttrc</code> command to list the
3167 content-types that you wish to view automatically. For instance, if you
3169 </p><pre class="screen">
3170 auto_view text/html application/x-gunzip \
3171 application/postscript image/gif application/x-tar-gz
3173 Mutt could use the following mailcap entries to automatically view
3174 attachments of these types.
3175 </p><pre class="screen">
3176 text/html; lynx -dump %s; copiousoutput; nametemplate=%s.html
3177 image/*; anytopnm %s | pnmscale -xsize 80 -ysize 50 | ppmtopgm | \
3178 pgmtopbm | pbmtoascii ; copiousoutput
3179 application/x-gunzip; gzcat; copiousoutput
3180 application/x-tar-gz; gunzip -c %s | tar -tf - ; copiousoutput
3181 application/postscript; ps2ascii %s; copiousoutput
3183 <span class="command"><strong>unauto_view</strong></span> can be used to remove previous entries from the autoview list.
3184 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 autoview messages based on size, etc.
3185 “<span class="quote"><span class="command"><strong>unauto_view</strong></span> *</span>” will remove all previous entries.
3186 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="alternative-order"></a>5. MIME Multipart/Alternative</h2></div></div></div><p>
3187 Mutt has some heuristics for determining which attachment of a
3188 <code class="literal">multipart/alternative</code> type to display. First, Mutt will check the
3189 <span class="command"><strong>alternative_order</strong></span> list
3190 to determine if one of the available types is preferred. It consists of
3191 a number of mimetypes in order, including support for implicit and
3192 explicit wildcards, for example:
3193 </p><pre class="screen">
3194 alternative_order text/enriched text/plain text application/postscript image/*
3196 Next, Mutt will check if any of the types have a defined
3197 <a class="link" href="#auto-view" title="4. MIME Autoview"><span class="command"><strong>auto_view</strong></span></a>, and use that. Failing
3198 that, Mutt will look for any text type. As a last attempt, Mutt will
3199 look for any type it knows how to handle.
3201 To remove a MIME type from the <span class="command"><strong>alternative_order</strong></span> list, use the
3202 <span class="command"><strong>unalternative_order</strong></span> command.
3203 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="attachments"></a>6. Attachment Searching and Counting</h2></div></div></div><p>
3204 If you ever lose track of attachments in your mailboxes, Mutt's
3205 attachment-counting and -searching support might be for you. You can
3206 make your message index display the number of qualifying attachments in
3207 each message, or search for messages by attachment count. You also can
3208 configure what kinds of attachments qualify for this feature with the
3209 <span class="command"><strong>attachments</strong></span> and <span class="command"><strong>unattachments</strong></span> commands.
3211 In order to provide this information, Mutt needs to fully MIME-parse
3212 all messages affected first. This can slow down operation especially for
3213 remote mail folders such as IMAP because all messages have to be
3214 downloaded first regardless whether the user really wants to view them
3218 </p><div class="cmdsynopsis"><p><code class="command">attachments</code>
3219 <em class="replaceable"><code>{ + | - }disposition</code></em>
3221 <em class="replaceable"><code>mime-type</code></em>
3222 <br /><code class="command">unattachments</code>
3223 <em class="replaceable"><code>{ + | - }disposition</code></em>
3225 <em class="replaceable"><code>mime-type</code></em>
3226 <br /><code class="command">attachments</code>
3227 <em class="replaceable"><code>?</code></em>
3229 <span class="emphasis"><em>disposition</em></span> is the attachment's Content-Disposition type — either
3230 <code class="literal">inline</code> or <code class="literal">attachment</code>.
3231 You can abbreviate this to <code class="literal">I</code> or <code class="literal">A</code>.
3233 Disposition is prefixed by either a + symbol or a - symbol. If it's
3234 a +, you're saying that you want to allow this disposition and MIME
3235 type to qualify. If it's a -, you're saying that this disposition
3236 and MIME type is an exception to previous + rules. There are examples
3237 below of how this is useful.
3239 <span class="emphasis"><em>mime-type</em></span> is, unsurprisingly, the MIME type of the attachment you want
3240 to affect. A MIME type is always of the format <code class="literal">major/minor</code>, where
3241 <code class="literal">major</code> describes the broad category of document you're looking at, and
3242 <code class="literal">minor</code> describes the specific type within that category. The major
3243 part of mime-type must be literal text (or the special token “<span class="quote"><code class="literal">*</code></span>”), but
3244 the minor part may be a regular expression. (Therefore, “<span class="quote"><code class="literal">*/.*</code></span>” matches
3247 The MIME types you give to the <span class="command"><strong>attachments</strong></span> directive are a kind of
3248 pattern. When you use the <span class="command"><strong>attachments</strong></span> directive, the patterns you
3249 specify are added to a list. When you use <span class="command"><strong>unattachments</strong></span>, the pattern
3250 is removed from the list. The patterns are not expanded and matched
3251 to specific MIME types at this time — they're just text in a list.
3252 They're only matched when actually evaluating a message.
3254 Some examples might help to illustrate. The examples that are not
3255 commented out define the default configuration of the lists.
3256 </p><div class="example"><a id="ex-attach-count"></a><p class="title"><b>Example 5.1. Attachment counting</b></p><div class="example-contents"><pre class="screen">
3257 ## Removing a pattern from a list removes that pattern literally. It
3258 ## does not remove any type matching the pattern.
3260 ## attachments +A */.*
3261 ## attachments +A image/jpeg
3262 ## unattachments +A */.*
3264 ## This leaves "attached" image/jpeg files on the allowed attachments
3265 ## list. It does not remove all items, as you might expect, because the
3266 ## second */.* is not a matching expression at this time.
3268 ## Remember: "unattachments" only undoes what "attachments" has done!
3269 ## It does not trigger any matching on actual messages.
3272 ## Qualify any MIME part with an "attachment" disposition, EXCEPT for
3273 ## text/x-vcard and application/pgp parts. (PGP parts are already known
3274 ## to mutt, and can be searched for with ~g, ~G, and ~k.)
3276 ## I've added x-pkcs7 to this, since it functions (for S/MIME)
3277 ## analogously to PGP signature attachments. S/MIME isn't supported
3278 ## in a stock mutt build, but we can still treat it specially here.
3281 attachments -A text/x-vcard application/pgp.*
3282 attachments -A application/x-pkcs7-.*
3284 ## Discount all MIME parts with an "inline" disposition, unless they're
3285 ## text/plain. (Why inline a text/plain part unless it's external to the
3288 attachments +I text/plain
3290 ## These two lines make Mutt qualify MIME containers. (So, for example,
3291 ## a message/rfc822 forward will count as an attachment.) The first
3292 ## line is unnecessary if you already have "attach-allow */.*", of
3293 ## course. These are off by default! The MIME elements contained
3294 ## within a message/* or multipart/* are still examined, even if the
3295 ## containers themseves don't qualify.
3297 #attachments +A message/.* multipart/.*
3298 #attachments +I message/.* multipart/.*
3300 ## You probably don't really care to know about deleted attachments.
3301 attachments -A message/external-body
3302 attachments -I message/external-body
3303 </pre></div></div><br class="example-break" /><p>
3304 Entering the command “<span class="quote"><span class="command"><strong>attachments</strong></span> ?</span>”
3305 as a command will list your current settings in Muttrc format, so that
3306 it can be pasted elsewhere.
3307 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="mime-lookup"></a>7. MIME Lookup</h2></div></div></div><p>
3309 </p><div class="cmdsynopsis"><p><code class="command">mime-lookup</code>
3310 <em class="replaceable"><code>mimetype</code></em>
3312 <em class="replaceable"><code>mimetype</code></em>
3313 ...]<br /><code class="command">unmime-lookup</code> {
3314 <em class="replaceable"><code>*</code></em>
3316 <em class="replaceable"><code>mimetype</code></em>
3318 Mutt's mime_lookup list specifies a list of mime-types that should not
3319 be treated according to their mailcap entry. This option is designed to
3320 deal with binary types such as <code class="literal">application/octet-stream</code>. When an attachment's
3321 mime-type is listed in mime_lookup, then the extension of the filename will
3322 be compared to the list of extensions in the <code class="literal">mime.types</code> file. The mime-type
3323 associated with this extension will then be used to process the attachment
3324 according to the rules in the mailcap file and according to any other configuration
3325 options (such as <span class="command"><strong>auto_view</strong></span>) specified. Common usage would be:
3326 </p><pre class="screen">
3327 mime_lookup application/octet-stream application/X-Lotus-Manuscript
3329 In addition, the <code class="literal">unmime_lookup</code> command may be
3330 used to disable this feature for any particular mime-type if it had been
3331 set, for example, in a global <code class="literal">.muttrc</code>.
3332 </p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="optionalfeatures"></a>Chapter 6. Optional Features</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#optionalfeatures-notes">1. General Notes</a></span></dt><dd><dl><dt><span class="sect2"><a href="#compile-time-features">1.1. Enabling/Disabling Features</a></span></dt><dt><span class="sect2"><a href="#url-syntax">1.2. URL Syntax</a></span></dt></dl></dd><dt><span class="sect1"><a href="#ssl">2. SSL/TLS Support</a></span></dt><dt><span class="sect1"><a href="#pop">3. POP3 Support</a></span></dt><dt><span class="sect1"><a href="#imap">4. IMAP Support</a></span></dt><dd><dl><dt><span class="sect2"><a href="#imap-browser">4.1. The 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="#maint-cache">7.3. Maintenance</a></span></dt></dl></dd><dt><span class="sect1"><a href="#exact-address">8. Exact Address Generation</a></span></dt><dt><span class="sect1"><a href="#sending-mixmaster">9. Sending Anonymous Messages via Mixmaster</a></span></dt></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="optionalfeatures-notes"></a>1. General Notes</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="compile-time-features"></a>1.1. Enabling/Disabling Features</h3></div></div></div><p>
3333 Mutt supports several of optional features which can be enabled or
3334 disabled at compile-time by giving the <span class="emphasis"><em>configure</em></span> script
3335 certain arguments. These are listed in the “<span class="quote">Optional features</span>” section of
3336 the <span class="emphasis"><em>configure --help</em></span> output.
3338 Which features are enabled or disabled can later be determined from the
3339 output of <code class="literal">mutt -v</code>. If a compile option starts with
3340 “<span class="quote">+</span>” it is enabled and disabled if prefixed with “<span class="quote">-</span>”. For example, if
3341 Mutt was compiled using GnuTLS for encrypted communication instead of
3342 OpenSSL, <code class="literal">mutt -v</code> would contain:
3343 </p><pre class="screen">
3344 -USE_SSL_OPENSSL +USE_SSL_GNUTLS</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="url-syntax"></a>1.2. URL Syntax</h3></div></div></div><p>
3345 Mutt optionally supports the IMAP, POP3 and SMTP protocols which require
3346 to access servers using URLs. The canonical syntax for specifying URLs
3347 in Mutt is (an item enclosed in <code class="literal">[]</code> means it is optional and
3349 </p><pre class="screen">
3350 proto[s]://[username[:password]@]server[:port]/[path]
3352 <span class="emphasis"><em>proto</em></span> is the communication protocol:
3353 <code class="literal">imap</code> for IMAP, <code class="literal">pop</code> for POP3 and
3354 <code class="literal">smtp</code> for SMTP. If “<span class="quote">s</span>” for “<span class="quote">secure
3355 communication</span>” is appended, Mutt will attempt to establish an
3356 encrypted communication using SSL or TLS.
3358 Since all protocols supported by Mutt support/require authentication,
3359 login credentials may be specified in the URL. This has the advantage
3360 that multiple IMAP, POP3 or SMTP servers may be specified (which isn't
3361 possible using, for example,
3362 <a class="link" href="#imap-user" title="3.109. imap_user">$imap_user</a>). The username
3363 may contain the “<span class="quote">@</span>” symbol being used by many mail systems
3364 as part of the login name. A password can be given, too but is not
3365 recommended if the URL is specified in a configuration file on disk.
3367 If no port number is given, Mutt will use the system's default for the
3368 given protocol (usually consulting <code class="literal">/etc/services</code>).
3370 The optional path is only relevant for IMAP.
3371 </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">
3373 imaps://user@host/INBOX/Sent
3374 smtp://user@host:587/
3375 </pre></div></div><br class="example-break" /></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="ssl"></a>2. SSL/TLS Support</h2></div></div></div><p>
3376 If Mutt is compiled with IMAP, POP3 and/or SMTP support, it can also be
3377 compiled with support for SSL or TLS using either OpenSSL or GnuTLS (
3378 by running the <span class="emphasis"><em>configure</em></span> script with the
3379 <span class="emphasis"><em>--enable-ssl=...</em></span> option for OpenSSL or
3380 <span class="emphasis"><em>--enable-gnutls=...</em></span> for GnuTLS). Mutt can then
3381 attempt to encrypt communication with remote servers if these protocols
3382 are suffixed with “<span class="quote">s</span>” for “<span class="quote">secure communication</span>”.
3383 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="pop"></a>3. POP3 Support</h2></div></div></div><p>
3384 If Mutt is compiled with POP3 support (by running the <span class="emphasis"><em>configure</em></span>
3385 script with the <span class="emphasis"><em>--enable-pop</em></span> flag), it has the ability to work
3386 with mailboxes located on a remote POP3 server and fetch mail for local
3389 Remote POP3 servers can be accessed using URLs with the <code class="literal">pop</code> protocol
3390 for unencrypted and <code class="literal">pops</code> for encrypted
3391 communication, see <a class="xref" href="#url-syntax" title="1.2. URL Syntax">Section 1.2, “URL Syntax”</a> for details.
3393 Polling for new mail is more expensive over POP3 than locally. For this
3394 reason the frequency at which Mutt will check for mail remotely can be
3396 <a class="link" href="#pop-checkinterval" title="3.187. pop_checkinterval">$pop_checkinterval</a>
3397 variable, which defaults to every 60 seconds.
3399 POP is read-only which doesn't allow for some features like editing
3400 messages or changing flags. However, using
3401 <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>
3402 Mutt simulates the new/old/read flags as well as flagged and replied.
3403 Mutt applies some logic on top of remote messages but cannot change
3404 them so that modifications of flags are lost when
3405 messages are downloaded from the POP server (either by Mutt or other
3407 </p><a id="fetch-mail"></a><p>
3408 Another way to access your POP3 mail is the <code class="literal"><fetch-mail></code> function
3409 (default: G). It allows to connect to <a class="link" href="#pop-host" title="3.189. pop_host">$pop_host</a>, fetch all your new mail and place it in the
3410 local <a class="link" href="#spoolfile" title="3.269. spoolfile">$spoolfile</a>. After this
3411 point, Mutt runs exactly as if the mail had always been local.
3412 </p><div class="note"><h3 class="title">Note</h3><p>
3413 If you only need to fetch all messages to a
3414 local mailbox you should consider using a specialized program, such as
3415 <code class="literal">fetchmail(1)</code>, <code class="literal">getmail(1)</code> or similar.
3416 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="imap"></a>4. IMAP Support</h2></div></div></div><p>
3417 If Mutt was compiled with IMAP support (by running the <span class="emphasis"><em>configure</em></span>
3418 script with the <span class="emphasis"><em>--enable-imap</em></span> flag), it has the ability to work
3419 with folders located on a remote IMAP server.
3421 You can access the remote inbox by selecting the folder by its URL
3422 (see <a class="xref" href="#url-syntax" title="1.2. URL Syntax">Section 1.2, “URL Syntax”</a> for details) using the
3423 <code class="literal">imap</code> or <code class="literal">imaps</code> protocol.
3424 Alternatively, a pine-compatible notation is also supported, ie
3425 <code class="literal">{[username@]imapserver[:port][/ssl]}path/to/folder</code>
3427 Note that not all servers use “<span class="quote">/</span>” as the hierarchy separator. Mutt should
3428 correctly notice which separator is being used by the server and convert
3431 When browsing folders on an IMAP server, you can toggle whether to look
3432 at only the folders you are subscribed to, or all folders with the
3433 <span class="emphasis"><em>toggle-subscribed</em></span> command. See also the
3434 <a class="link" href="#imap-list-subscribed" title="3.102. imap_list_subscribed">$imap_list_subscribed</a> variable.
3436 Polling for new mail on an IMAP server can cause noticeable delays. So, you'll
3437 want to carefully tune the
3438 <a class="link" href="#mail-check" title="3.118. mail_check">$mail_check</a>
3440 <a class="link" href="#timeout" title="3.291. timeout">$timeout</a>
3441 variables. Reasonable values are:
3442 </p><pre class="screen">
3446 with relatively good results even over slow modem lines.
3447 </p><div class="note"><h3 class="title">Note</h3><p>
3448 Note that if you are using mbox as the mail store on UW servers prior to
3449 v12.250, the server has been reported to disconnect a client if another client
3450 selects the same folder.
3451 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-browser"></a>4.1. The IMAP Folder Browser</h3></div></div></div><p>
3452 As of version 1.2, Mutt supports browsing mailboxes on an IMAP
3453 server. This is mostly the same as the local file browser, with the
3454 following differences:
3455 </p><div class="itemizedlist"><ul type="disc"><li><p>
3456 In lieu of file permissions, Mutt displays the string “<span class="quote">IMAP</span>”,
3457 possibly followed by the symbol “<span class="quote">+</span>”, indicating
3458 that the entry contains both messages and subfolders. On
3459 Cyrus-like servers folders will often contain both messages and
3462 For the case where an entry can contain both messages and
3463 subfolders, the selection key (bound to <code class="literal">enter</code> by default)
3464 will choose to descend into the subfolder view. If you wish to view
3465 the messages in that folder, you must use <code class="literal">view-file</code> instead
3466 (bound to <code class="literal">space</code> by default).
3468 You can create, delete and rename mailboxes with the
3469 <code class="literal"><create-mailbox></code>, <code class="literal"><delete-mailbox></code>, and
3470 <code class="literal"><rename-mailbox></code> commands (default bindings: <code class="literal">C</code>,
3471 <code class="literal">d</code> and <code class="literal">r</code>, respectively). You may also
3472 <code class="literal"><subscribe></code> and <code class="literal"><unsubscribe></code> to mailboxes (normally
3473 these are bound to <code class="literal">s</code> and <code class="literal">u</code>, respectively).
3474 </p></li></ul></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-authentication"></a>4.2. Authentication</h3></div></div></div><p>
3475 Mutt supports four authentication methods with IMAP servers: SASL,
3476 GSSAPI, CRAM-MD5, and LOGIN (there is a patch by Grant Edwards to add
3477 NTLM authentication for you poor exchange users out there, but it has
3478 yet to be integrated into the main tree). There is also support for
3479 the pseudo-protocol ANONYMOUS, which allows you to log in to a public
3480 IMAP server without having an account. To use ANONYMOUS, simply make
3481 your username blank or “<span class="quote">anonymous</span>”.
3483 SASL is a special super-authenticator, which selects among several protocols
3484 (including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the most secure
3485 method available on your host and the server. Using some of these methods
3486 (including DIGEST-MD5 and possibly GSSAPI), your entire session will be
3487 encrypted and invisible to those teeming network snoops. It is the best
3488 option if you have it. To use it, you must have the Cyrus SASL library
3489 installed on your system and compile Mutt with the <span class="emphasis"><em>--with-sasl</em></span> flag.
3491 Mutt will try whichever methods are compiled in and available on the server,
3492 in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5, LOGIN.
3494 There are a few variables which control authentication:
3495 </p><div class="itemizedlist"><ul type="disc"><li><p>
3496 <a class="link" href="#imap-user" title="3.109. imap_user">$imap_user</a> - controls
3497 the username under which you request authentication on the IMAP server,
3498 for all authenticators. This is overridden by an explicit username in
3499 the mailbox path (ie by using a mailbox name of the form
3500 <code class="literal">{user@host}</code>).
3502 <a class="link" href="#imap-pass" title="3.104. imap_pass">$imap_pass</a> - a
3503 password which you may preset, used by all authentication methods where
3504 a password is needed.
3506 <a class="link" href="#imap-authenticators" title="3.96. imap_authenticators">$imap_authenticators</a> - a colon-delimited list of IMAP
3507 authentication methods to try, in the order you wish to try them. If
3508 specified, this overrides Mutt's default (attempt everything, in the order
3510 </p></li></ul></div></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="smtp"></a>5. SMTP Support</h2></div></div></div><p>
3511 Besides supporting traditional mail delivery through a
3512 sendmail-compatible program, Mutt supports delivery through SMTP if it
3513 was configured and built with <code class="literal">--enable-smtp</code>.
3515 If the configuration variable
3516 <a class="link" href="#smtp-url" title="3.262. smtp_url">$smtp_url</a> is set, Mutt
3517 will contact the given SMTP server to deliver messages; if it is unset,
3518 Mutt will use the program specified by <a class="link" href="#sendmail" title="3.230. sendmail">$sendmail</a>.
3520 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>.
3522 The built-in SMTP support supports encryption (the <code class="literal">smtps</code> protocol
3523 using SSL or TLS) as well as SMTP authentication using SASL. The authentication mechanisms
3524 for SASL are specified in <a class="link" href="#smtp-authenticators" title="3.260. smtp_authenticators">$smtp_authenticators</a>
3525 defaulting to an empty list which makes Mutt try all available methods
3526 from most-secure to least-secure.
3527 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="account-hook"></a>6. Managing Multiple Accounts</h2></div></div></div><p>
3529 </p><div class="cmdsynopsis"><p><code class="command">account-hook</code>
3530 <em class="replaceable"><code>pattern</code></em>
3532 <em class="replaceable"><code>command</code></em>
3534 If you happen to have accounts on multiple IMAP, POP and/or SMTP servers,
3535 you may find managing all the authentication settings inconvenient and
3536 error-prone. The <a class="link" href="#account-hook" title="6. Managing Multiple Accounts"><span class="command"><strong>account-hook</strong></span></a> command may help. This hook works like
3537 <a class="link" href="#folder-hook" title="7. Setting Variables Based Upon Mailbox"><span class="command"><strong>folder-hook</strong></span></a> but is invoked whenever Mutt needs to access a remote mailbox
3538 (including inside the folder browser), not just when you open the
3539 mailbox. This includes (for example) polling for new mail, storing Fcc
3540 messages and saving messages to a folder. As a consequence,
3541 <a class="link" href="#account-hook" title="6. Managing Multiple Accounts"><span class="command"><strong>account-hook</strong></span></a> should only be used to set connection-related settings such
3542 as passwords or tunnel commands but not settings such as sender
3543 address or name (because in general it should be considered unpredictable
3544 which <a class="link" href="#account-hook" title="6. Managing Multiple Accounts"><span class="command"><strong>account-hook</strong></span></a> was last used).
3547 </p><pre class="screen">
3548 account-hook . 'unset imap_user; unset imap_pass; unset tunnel'
3549 account-hook imap://host1/ 'set imap_user=me1 imap_pass=foo'
3550 account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"'
3551 account-hook smtp://user@host3/ 'set tunnel="ssh host3 /usr/libexec/smtpd"'
3553 To manage multiple accounts with, for example, different values of
3554 <a class="link" href="#record" title="3.211. record">$record</a> or sender addresses,
3555 <a class="link" href="#folder-hook" title="7. Setting Variables Based Upon Mailbox"><span class="command"><strong>folder-hook</strong></span></a>
3556 has to be be used together with
3557 the <a class="link" href="#mailboxes" title="14. Monitoring Incoming Mail"><span class="command"><strong>mailboxes</strong></span></a> command.
3558 </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">
3559 mailboxes imap://user@host1/INBOX
3560 folder-hook imap://user@host1/ 'set folder=imap://host1/ ; set record=+INBOX/Sent'
3562 mailboxes imap://user@host2/INBOX
3563 folder-hook imap://user@host2/ 'set folder=imap://host2/ ; set record=+INBOX/Sent'
3564 </pre></div></div><br class="example-break" /><p>
3566 <a class="xref" href="#ex-multiaccount" title="Example 6.2. Managing multiple accounts">Example 6.2, “Managing multiple accounts”</a> the folders are defined using
3567 <a class="link" href="#mailboxes" title="14. Monitoring Incoming Mail"><span class="command"><strong>mailboxes</strong></span></a> so Mutt polls them for new
3568 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 when
3569 one mailbox below each IMAP account is opened and sets
3570 <a class="link" href="#folder" title="3.66. folder">$folder</a> to the account's root
3571 folder. Next, it sets <a class="link" href="#record" title="3.211. record">$record</a> to
3572 the <span class="emphasis"><em>INBOX/Sent</em></span> folder below the newly
3573 set <a class="link" href="#folder" title="3.66. folder">$folder</a>. Please notice that the
3574 value the “<span class="quote">+</span>”
3575 <a class="link" href="#shortcuts" title="7. Mailbox Shortcuts">mailbox shortcut</a> refers to depends on
3576 the <span class="emphasis"><em>current</em></span> value
3577 of <a class="link" href="#folder" title="3.66. folder">$folder</a> and therefore has to be set
3578 separatedly per account. Setting other values
3579 like <a class="link" href="#from" title="3.75. from">$from</a>
3580 or <a class="link" href="#signature" title="3.235. signature">$signature</a> is analogous to setting
3581 <a class="link" href="#record" title="3.211. record">$record</a>.
3582 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="caching"></a>7. Local Caching</h2></div></div></div><p>
3583 Mutt contains two types of local caching: <span class="emphasis"><em>(1)</em></span>
3584 the so-called “<span class="quote">header caching</span>” and <span class="emphasis"><em>(2)</em></span> the
3585 so-called “<span class="quote">body caching</span>” which are both described in this section.
3587 Header caching is optional as it depends on external libraries, body
3588 caching is always enabled if Mutt is compiled with POP and/or IMAP
3589 support as these use it (body caching requires no external library).
3590 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="header-caching"></a>7.1. Header Caching</h3></div></div></div><p>
3591 Mutt provides optional support for caching message headers for the
3592 following types of folders: IMAP, POP, Maildir and MH. Header caching
3593 greatly improves speed because for remote folders, headers
3594 usually only need to be downloaded once. For Maildir and MH, reading the
3595 headers from a single file is much faster than looking at possibly
3596 thousands of single files (since Maildir and MH use one file per message.)
3598 Header caching can be enabled via the configure script and the
3599 <span class="emphasis"><em>--enable-hcache</em></span> option. It's not turned on
3600 by default because external database libraries are required: one
3601 of tokyocabinet, qdbm, gdbm or bdb must be present.
3603 If enabled, <a class="link" href="#header-cache" title="3.79. header_cache">$header_cache</a> can be
3604 used to either point to a file or a directory. If set to point to
3605 a file, one database file for all folders will be used (which may
3606 result in lower performance), but one file per folder if it points
3608 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="body-caching"></a>7.2. Body Caching</h3></div></div></div><p>
3609 Both cache methods can be combined using the same directory for storage
3610 (and for IMAP/POP even provide meaningful file names) which simplifies
3611 manual maintenance tasks.
3613 In addition to caching message headers only, Mutt can also cache
3614 whole message bodies. This results in faster display of messages
3615 for POP and IMAP folders because messages usually have to be
3616 downloaded only once.
3618 For configuration, the variable <a class="link" href="#message-cachedir" title="3.132. message_cachedir">$message_cachedir</a> must point to a
3619 directory. There, Mutt will create a hierarchy of subdirectories
3620 named like: <code class="literal">proto:user@hostname</code> where
3621 <code class="literal">proto</code> is either “<span class="quote">pop</span>” or “<span class="quote">imap.</span>” Within
3622 there for each folder, Mutt stores messages in single files.
3623 All files can be removed as needed if the consumed disk space
3624 becomes an issue as Mutt will silently fetch missing items again.
3625 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="maint-cache"></a>7.3. Maintenance</h3></div></div></div><p>
3626 Mutt does not (yet) support maintenance features for header cache
3627 database files so that files have to be removed in case they grow too
3628 big. It depends on the database library used for header caching whether
3629 disk space freed by removing messages is re-used.
3631 For body caches, Mutt can keep the local cache in sync with the
3632 remote mailbox if the
3633 <a class="link" href="#message-cache-clean" title="3.131. message_cache_clean">$message_cache_clean</a>
3634 variable is set. Cleaning means to remove messages from the cache which
3635 are no longer present in the mailbox which only happens when other mail
3636 clients or instances of Mutt using a different body cache location
3637 delete messages (Mutt itself removes deleted messages from the cache
3638 when syncing a mailbox). As cleaning can take a noticeable amount of time,
3639 it should not be set in general but only occasionally.
3640 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="exact-address"></a>8. Exact Address Generation</h2></div></div></div><p>
3641 Mutt supports the “<span class="quote">Name <user@host></span>” address syntax for reading and
3642 writing messages, the older “<span class="quote">user@host (Name)</span>” syntax is only supported when
3643 reading messages. The <span class="emphasis"><em>--enable-exact-address</em></span>
3644 switch can be given to configure to build it with write-support
3645 for the latter syntax. <code class="literal">EXACT_ADDRESS</code> in the output of
3646 <code class="literal">mutt -v</code> indicates whether it's supported.
3647 </p></div><div class="sect1" lang="en" xml:lang="en"><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>
3648 You may also have compiled Mutt to co-operate with Mixmaster, an
3649 anonymous remailer. Mixmaster permits you to send your messages
3650 anonymously using a chain of remailers. Mixmaster support in Mutt is for
3651 mixmaster version 2.04 (beta 45 appears to be the latest) and 2.03.
3652 It does not support earlier versions or the later so-called version 3 betas,
3653 of which the latest appears to be called 2.9b23.
3655 To use it, you'll have to obey certain restrictions. Most
3656 important, you cannot use the <code class="literal">Cc</code> and <code class="literal">Bcc</code> headers. To tell
3657 Mutt to use mixmaster, you have to select a remailer chain, using
3658 the mix function on the compose menu.
3660 The chain selection screen is divided into two parts. In the
3661 (larger) upper part, you get a list of remailers you may use. In
3662 the lower part, you see the currently selected chain of remailers.
3664 You can navigate in the chain using the <code class="literal"><chain-prev></code> and
3665 <code class="literal"><chain-next></code> functions, which are by default bound to the left
3666 and right arrows and to the <code class="literal">h</code> and <code class="literal">l</code> keys (think vi
3667 keyboard bindings). To insert a remailer at the current chain
3668 position, use the <code class="literal"><insert></code> function. To append a remailer behind
3669 the current chain position, use <code class="literal"><select-entry></code> or <code class="literal"><append></code>.
3670 You can also delete entries from the chain, using the corresponding
3671 function. Finally, to abandon your changes, leave the menu, or
3672 <code class="literal"><accept></code> them pressing (by default) the <code class="literal">Return</code> key.
3674 Note that different remailers do have different capabilities,
3675 indicated in the %c entry of the remailer menu lines (see
3676 <a class="link" href="#mix-entry-format" title="3.143. mix_entry_format">$mix_entry_format</a>). Most important is
3677 the “<span class="quote">middleman</span>” capability, indicated by a capital “<span class="quote">M</span>”: This
3678 means that the remailer in question cannot be used as the final
3679 element of a chain, but will only forward messages to other
3680 mixmaster remailers. For details on the other capabilities, please
3681 have a look at the mixmaster documentation.
3682 </p></div></div><div class="chapter" lang="en" xml:lang="en"><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. mailto:-style Links</a></span></dt></dl></dd><dt><span class="sect1"><a href="#security-external">4. External Applications</a></span></dt></dl></div><p>
3683 First of all, Mutt contains no security holes included by intention but
3684 may contain unknown security holes. As a consequence, please run Mutt
3685 only with as few permissions as possible. Especially, do not run Mutt as
3688 When configuring Mutt, there're some points to note about secure setups
3689 so please read this chapter carefully.
3690 </p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="security-passwords"></a>1. Passwords</h2></div></div></div><p>
3691 Although Mutt can be told the various passwords for accounts, please
3692 never store passwords in configuration files. Besides the fact that the
3693 system's operator can always read them, you could forget to mask it out
3694 when reporting a bug or asking for help via a mailing list. Even worse,
3695 your mail including your password could be archived by internet search
3696 engines, mail-to-news gateways etc. It may already be too late before
3697 you notice your mistake.
3698 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="security-tempfiles"></a>2. Temporary Files</h2></div></div></div><p>
3699 Mutt uses many temporary files for viewing messages, verifying digital
3700 signatures, etc. As long as being used, these files are visible by other
3701 users and maybe even readable in case of misconfiguration. Also, a
3702 different location for these files may be desired which can be changed
3703 via the <a class="link" href="#tmpdir" title="3.292. tmpdir">$tmpdir</a> variable.
3704 </p></div><div class="sect1" lang="en" xml:lang="en"><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" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="security-leaks-mid"></a>3.1. Message-Id: headers</h3></div></div></div><p>
3705 Message-Id: headers contain a local part that is to be created in a
3706 unique fashion. In order to do so, Mutt will “<span class="quote">leak</span>” some
3707 information to the outside world when sending messages: the generation
3708 of this header includes a step counter which is increased (and rotated)
3709 with every message sent. In a longer running mutt session, others can
3710 make assumptions about your mailing habbits depending on the number of
3711 messages sent. If this is not desired, the header can be manually
3712 provided using <a class="link" href="#edit-headers" title="3.57. edit_headers">$edit_headers</a> (though not
3714 </p></div><div class="sect2" lang="en" xml:lang="en"><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>
3715 As Mutt be can be set up to be the mail client to handle
3716 <code class="literal">mailto:</code> style links in websites, there're security
3717 considerations, too. Arbitrary header fields can be embedded in these
3718 links which could override existing header fields or attach arbitrary
3719 files using <a class="link" href="#attach-header" title="6.2.2. Attach: Pseudo Header">the Attach:
3720 psuedoheader</a>. This may be problematic if the <a class="link" href="#edit-headers" title="3.57. edit_headers">$edit-headers</a> variable is
3721 <span class="emphasis"><em>unset</em></span>, i.e. the user doesn't want to see header
3722 fields while editing the message and doesn't pay enough attention to the
3723 compose menu's listing of attachments.
3725 For example, following a link like
3726 </p><pre class="screen">
3727 mailto:joe@host?Attach=~/.gnupg/secring.gpg</pre><p>
3728 will send out the user's private gnupg keyring to
3729 <code class="literal">joe@host</code> if the user doesn't follow the information
3730 on screen carefully enough.
3731 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="security-external"></a>4. External Applications</h2></div></div></div><p>
3732 Mutt in many places has to rely on external applications or for
3733 convenience supports mechanisms involving external applications.
3735 One of these is the <code class="literal">mailcap</code> mechanism as defined by
3736 RfC1524. Details about a secure use of the mailcap mechanisms is given
3737 in <a class="xref" href="#secure-mailcap" title="3.2. Secure Use of Mailcap">Section 3.2, “Secure Use of Mailcap”</a>.
3739 Besides the mailcap mechanism, Mutt uses a number of other external
3740 utilities for operation, for example to provide crypto support, in
3741 backtick expansion in configuration files or format string filters. The
3742 same security considerations apply for these as for tools involved via
3744 </p></div></div><div class="chapter" lang="en" xml:lang="en"><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" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="tuning-mailboxes"></a>1. Reading and Writing Mailboxes</h2></div></div></div><p>
3745 Mutt's performance when reading mailboxes can be improved in two ways:
3746 </p><div class="orderedlist"><ol type="1"><li><p>
3747 For remote folders (IMAP and POP) as well as folders using
3748 one-file-per message storage (Maildir and MH), Mutt's
3749 performance can be greatly improved using
3750 <a class="link" href="#header-caching" title="7.1. Header Caching">header caching</a>.
3751 using a single database per folder.
3753 Mutt provides the <a class="link" href="#read-inc" title="3.207. read_inc">$read_inc</a>
3754 and <a class="link" href="#write-inc" title="3.310. write_inc">$write_inc</a>
3755 variables to specify at which rate to update progress
3756 counters. If these values are too low, Mutt may spend more
3757 time on updating the progress counter than it spends on
3758 actually reading/writing folders.
3760 For example, when opening a maildir folder with a few
3761 thousand messages, the default value for
3762 <a class="link" href="#read-inc" title="3.207. read_inc">$read_inc</a>
3763 may be too low. It can be tuned on on a folder-basis using
3764 <a class="link" href="#folder-hook" title="7. Setting Variables Based Upon Mailbox"><span class="command"><strong>folder-hook</strong></span>s</a>:
3765 </p><pre class="screen">
3766 # use very high $read_inc to speed up reading hcache'd maildirs
3767 folder-hook . 'set read_inc=1000'
3768 # use lower value for reading slower remote IMAP folders
3769 folder-hook ^imap 'set read_inc=100'
3770 # use even lower value for reading even slower remote POP folders
3771 folder-hook ^pop 'set read_inc=1'</pre></li></ol></div><p>These settings work on a per-message basis. However, as messages may
3772 greatly differ in size and certain operations are much faster than others,
3773 even per-folder settings of the increment variables may not be
3774 desirable as they produce either too few or too much progress updates.
3775 Thus, Mutt allows to limit the number of progress updates per second it'll
3776 actually send to the terminal using the
3777 <a class="link" href="#time-inc" title="3.290. time_inc">$time_inc</a> variable.</p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="tuning-messages"></a>2. Reading Messages from Remote Folders</h2></div></div></div><p>
3778 Reading messages from remote folders such as IMAP an POP can be
3779 slow especially for large mailboxes since Mutt only caches a very
3780 limited number of recently viewed messages (usually 10) per
3781 session (so that it will be gone for the next session.)
3783 To improve performance and permanently cache whole messages,
3784 please refer to Mutt's so-called
3785 <a class="link" href="#body-caching" title="7.2. Body Caching">body caching</a> for details.
3786 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="tuning-search"></a>3. Searching and Limiting</h2></div></div></div><p>
3787 When searching mailboxes either via a search or a limit action, for
3788 some patterns Mutt distinguishes between regular expression and string
3789 searches. For regular expressions, patterns are prefixed with
3790 “<span class="quote">˜</span>” and with “<span class="quote">=</span>” for string searches.
3792 Even though a regular expression search is fast, it's several times
3793 slower than a pure string search which is noticeable especially on large
3794 folders. As a consequence, a string search should be used instead of a
3795 regular expression search if the user already knows enough about the
3798 For example, when limiting a large folder to all messages sent to or by
3799 an author, it's much faster to search for the initial part of an e-mail
3800 address via <code class="literal">=Luser@</code> instead of
3801 <code class="literal">˜Luser@</code>. This is especially true for searching
3802 message bodies since a larger amount of input has to be searched.
3804 As for regular expressions, a lower case string search pattern makes
3805 Mutt perform a case-insensitive search except for IMAP (because for IMAP
3806 Mutt performs server-side searches which don't support case-insensivity).
3807 </p></div></div><div class="chapter" lang="en" xml:lang="en"><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="#mailcap-path">3.119. mailcap_path</a></span></dt><dt><span class="sect2"><a href="#mailcap-sanitize">3.120. mailcap_sanitize</a></span></dt><dt><span class="sect2"><a href="#maildir-header-cache-verify">3.121. maildir_header_cache_verify</a></span></dt><dt><span class="sect2"><a href="#maildir-trash">3.122. maildir_trash</a></span></dt><dt><span class="sect2"><a href="#mark-old">3.123. mark_old</a></span></dt><dt><span class="sect2"><a href="#markers">3.124. markers</a></span></dt><dt><span class="sect2"><a href="#mask">3.125. mask</a></span></dt><dt><span class="sect2"><a href="#mbox">3.126. mbox</a></span></dt><dt><span class="sect2"><a href="#mbox-type">3.127. mbox_type</a></span></dt><dt><span class="sect2"><a href="#menu-context">3.128. menu_context</a></span></dt><dt><span class="sect2"><a href="#menu-move-off">3.129. menu_move_off</a></span></dt><dt><span class="sect2"><a href="#menu-scroll">3.130. menu_scroll</a></span></dt><dt><span class="sect2"><a href="#message-cache-clean">3.131. message_cache_clean</a></span></dt><dt><span class="sect2"><a href="#message-cachedir">3.132. message_cachedir</a></span></dt><dt><span class="sect2"><a href="#message-format">3.133. message_format</a></span></dt><dt><span class="sect2"><a href="#meta-key">3.134. meta_key</a></span></dt><dt><span class="sect2"><a href="#metoo">3.135. metoo</a></span></dt><dt><span class="sect2"><a href="#mh-purge">3.136. mh_purge</a></span></dt><dt><span class="sect2"><a href="#mh-seq-flagged">3.137. mh_seq_flagged</a></span></dt><dt><span class="sect2"><a href="#mh-seq-replied">3.138. mh_seq_replied</a></span></dt><dt><span class="sect2"><a href="#mh-seq-unseen">3.139. mh_seq_unseen</a></span></dt><dt><span class="sect2"><a href="#mime-forward">3.140. mime_forward</a></span></dt><dt><span class="sect2"><a href="#mime-forward-decode">3.141. mime_forward_decode</a></span></dt><dt><span class="sect2"><a href="#mime-forward-rest">3.142. mime_forward_rest</a></span></dt><dt><span class="sect2"><a href="#mix-entry-format">3.143. mix_entry_format</a></span></dt><dt><span class="sect2"><a href="#mixmaster">3.144. mixmaster</a></span></dt><dt><span class="sect2"><a href="#move">3.145. move</a></span></dt><dt><span class="sect2"><a href="#narrow-tree">3.146. narrow_tree</a></span></dt><dt><span class="sect2"><a href="#net-inc">3.147. net_inc</a></span></dt><dt><span class="sect2"><a href="#pager">3.148. pager</a></span></dt><dt><span class="sect2"><a href="#pager-context">3.149. pager_context</a></span></dt><dt><span class="sect2"><a href="#pager-format">3.150. pager_format</a></span></dt><dt><span class="sect2"><a href="#pager-index-lines">3.151. pager_index_lines</a></span></dt><dt><span class="sect2"><a href="#pager-stop">3.152. pager_stop</a></span></dt><dt><span class="sect2"><a href="#pgp-auto-decode">3.153. pgp_auto_decode</a></span></dt><dt><span class="sect2"><a href="#pgp-autoinline">3.154. pgp_autoinline</a></span></dt><dt><span class="sect2"><a href="#pgp-check-exit">3.155. pgp_check_exit</a></span></dt><dt><span class="sect2"><a href="#pgp-clearsign-command">3.156. pgp_clearsign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-decode-command">3.157. pgp_decode_command</a></span></dt><dt><span class="sect2"><a href="#pgp-decrypt-command">3.158. pgp_decrypt_command</a></span></dt><dt><span class="sect2"><a href="#pgp-encrypt-only-command">3.159. pgp_encrypt_only_command</a></span></dt><dt><span class="sect2"><a href="#pgp-encrypt-sign-command">3.160. pgp_encrypt_sign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-entry-format">3.161. pgp_entry_format</a></span></dt><dt><span class="sect2"><a href="#pgp-export-command">3.162. pgp_export_command</a></span></dt><dt><span class="sect2"><a href="#pgp-getkeys-command">3.163. pgp_getkeys_command</a></span></dt><dt><span class="sect2"><a href="#pgp-good-sign">3.164. pgp_good_sign</a></span></dt><dt><span class="sect2"><a href="#pgp-ignore-subkeys">3.165. pgp_ignore_subkeys</a></span></dt><dt><span class="sect2"><a href="#pgp-import-command">3.166. pgp_import_command</a></span></dt><dt><span class="sect2"><a href="#pgp-list-pubring-command">3.167. pgp_list_pubring_command</a></span></dt><dt><span class="sect2"><a href="#pgp-list-secring-command">3.168. pgp_list_secring_command</a></span></dt><dt><span class="sect2"><a href="#pgp-long-ids">3.169. pgp_long_ids</a></span></dt><dt><span class="sect2"><a href="#pgp-mime-auto">3.170. pgp_mime_auto</a></span></dt><dt><span class="sect2"><a href="#pgp-replyinline">3.171. pgp_replyinline</a></span></dt><dt><span class="sect2"><a href="#pgp-retainable-sigs">3.172. pgp_retainable_sigs</a></span></dt><dt><span class="sect2"><a href="#pgp-show-unusable">3.173. pgp_show_unusable</a></span></dt><dt><span class="sect2"><a href="#pgp-sign-as">3.174. pgp_sign_as</a></span></dt><dt><span class="sect2"><a href="#pgp-sign-command">3.175. pgp_sign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-sort-keys">3.176. pgp_sort_keys</a></span></dt><dt><span class="sect2"><a href="#pgp-strict-enc">3.177. pgp_strict_enc</a></span></dt><dt><span class="sect2"><a href="#pgp-timeout">3.178. pgp_timeout</a></span></dt><dt><span class="sect2"><a href="#pgp-use-gpg-agent">3.179. pgp_use_gpg_agent</a></span></dt><dt><span class="sect2"><a href="#pgp-verify-command">3.180. pgp_verify_command</a></span></dt><dt><span class="sect2"><a href="#pgp-verify-key-command">3.181. pgp_verify_key_command</a></span></dt><dt><span class="sect2"><a href="#pipe-decode">3.182. pipe_decode</a></span></dt><dt><span class="sect2"><a href="#pipe-sep">3.183. pipe_sep</a></span></dt><dt><span class="sect2"><a href="#pipe-split">3.184. pipe_split</a></span></dt><dt><span class="sect2"><a href="#pop-auth-try-all">3.185. pop_auth_try_all</a></span></dt><dt><span class="sect2"><a href="#pop-authenticators">3.186. pop_authenticators</a></span></dt><dt><span class="sect2"><a href="#pop-checkinterval">3.187. pop_checkinterval</a></span></dt><dt><span class="sect2"><a href="#pop-delete">3.188. pop_delete</a></span></dt><dt><span class="sect2"><a href="#pop-host">3.189. pop_host</a></span></dt><dt><span class="sect2"><a href="#pop-last">3.190. pop_last</a></span></dt><dt><span class="sect2"><a href="#pop-pass">3.191. pop_pass</a></span></dt><dt><span class="sect2"><a href="#pop-reconnect">3.192. pop_reconnect</a></span></dt><dt><span class="sect2"><a href="#pop-user">3.193. pop_user</a></span></dt><dt><span class="sect2"><a href="#post-indent-string">3.194. post_indent_string</a></span></dt><dt><span class="sect2"><a href="#postpone">3.195. postpone</a></span></dt><dt><span class="sect2"><a href="#postponed">3.196. postponed</a></span></dt><dt><span class="sect2"><a href="#preconnect">3.197. preconnect</a></span></dt><dt><span class="sect2"><a href="#print">3.198. print</a></span></dt><dt><span class="sect2"><a href="#print-command">3.199. print_command</a></span></dt><dt><span class="sect2"><a href="#print-decode">3.200. print_decode</a></span></dt><dt><span class="sect2"><a href="#print-split">3.201. print_split</a></span></dt><dt><span class="sect2"><a href="#prompt-after">3.202. prompt_after</a></span></dt><dt><span class="sect2"><a href="#query-command">3.203. query_command</a></span></dt><dt><span class="sect2"><a href="#query-format">3.204. query_format</a></span></dt><dt><span class="sect2"><a href="#quit">3.205. quit</a></span></dt><dt><span class="sect2"><a href="#quote-regexp">3.206. quote_regexp</a></span></dt><dt><span class="sect2"><a href="#read-inc">3.207. read_inc</a></span></dt><dt><span class="sect2"><a href="#read-only">3.208. read_only</a></span></dt><dt><span class="sect2"><a href="#realname">3.209. realname</a></span></dt><dt><span class="sect2"><a href="#recall">3.210. recall</a></span></dt><dt><span class="sect2"><a href="#record">3.211. record</a></span></dt><dt><span class="sect2"><a href="#reply-regexp">3.212. reply_regexp</a></span></dt><dt><span class="sect2"><a href="#reply-self">3.213. reply_self</a></span></dt><dt><span class="sect2"><a href="#reply-to">3.214. reply_to</a></span></dt><dt><span class="sect2"><a href="#resolve">3.215. resolve</a></span></dt><dt><span class="sect2"><a href="#reverse-alias">3.216. reverse_alias</a></span></dt><dt><span class="sect2"><a href="#reverse-name">3.217. reverse_name</a></span></dt><dt><span class="sect2"><a href="#reverse-realname">3.218. reverse_realname</a></span></dt><dt><span class="sect2"><a href="#rfc2047-parameters">3.219. rfc2047_parameters</a></span></dt><dt><span class="sect2"><a href="#save-address">3.220. save_address</a></span></dt><dt><span class="sect2"><a href="#save-empty">3.221. save_empty</a></span></dt><dt><span class="sect2"><a href="#save-history">3.222. save_history</a></span></dt><dt><span class="sect2"><a href="#save-name">3.223. save_name</a></span></dt><dt><span class="sect2"><a href="#score">3.224. score</a></span></dt><dt><span class="sect2"><a href="#score-threshold-delete">3.225. score_threshold_delete</a></span></dt><dt><span class="sect2"><a href="#score-threshold-flag">3.226. score_threshold_flag</a></span></dt><dt><span class="sect2"><a href="#score-threshold-read">3.227. score_threshold_read</a></span></dt><dt><span class="sect2"><a href="#search-context">3.228. search_context</a></span></dt><dt><span class="sect2"><a href="#send-charset">3.229. send_charset</a></span></dt><dt><span class="sect2"><a href="#sendmail">3.230. sendmail</a></span></dt><dt><span class="sect2"><a href="#sendmail-wait">3.231. sendmail_wait</a></span></dt><dt><span class="sect2"><a href="#shell">3.232. shell</a></span></dt><dt><span class="sect2"><a href="#sig-dashes">3.233. sig_dashes</a></span></dt><dt><span class="sect2"><a href="#sig-on-top">3.234. sig_on_top</a></span></dt><dt><span class="sect2"><a href="#signature">3.235. signature</a></span></dt><dt><span class="sect2"><a href="#simple-search">3.236. simple_search</a></span></dt><dt><span class="sect2"><a href="#sleep-time">3.237. sleep_time</a></span></dt><dt><span class="sect2"><a href="#smart-wrap">3.238. smart_wrap</a></span></dt><dt><span class="sect2"><a href="#smileys">3.239. smileys</a></span></dt><dt><span class="sect2"><a href="#smime-ask-cert-label">3.240. smime_ask_cert_label</a></span></dt><dt><span class="sect2"><a href="#smime-ca-location">3.241. smime_ca_location</a></span></dt><dt><span class="sect2"><a href="#smime-certificates">3.242. smime_certificates</a></span></dt><dt><span class="sect2"><a href="#smime-decrypt-command">3.243. smime_decrypt_command</a></span></dt><dt><span class="sect2"><a href="#smime-decrypt-use-default-key">3.244. smime_decrypt_use_default_key</a></span></dt><dt><span class="sect2"><a href="#smime-default-key">3.245. smime_default_key</a></span></dt><dt><span class="sect2"><a href="#smime-encrypt-command">3.246. smime_encrypt_command</a></span></dt><dt><span class="sect2"><a href="#smime-encrypt-with">3.247. smime_encrypt_with</a></span></dt><dt><span class="sect2"><a href="#smime-get-cert-command">3.248. smime_get_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-get-cert-email-command">3.249. smime_get_cert_email_command</a></span></dt><dt><span class="sect2"><a href="#smime-get-signer-cert-command">3.250. smime_get_signer_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-import-cert-command">3.251. smime_import_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-is-default">3.252. smime_is_default</a></span></dt><dt><span class="sect2"><a href="#smime-keys">3.253. smime_keys</a></span></dt><dt><span class="sect2"><a href="#smime-pk7out-command">3.254. smime_pk7out_command</a></span></dt><dt><span class="sect2"><a href="#smime-sign-command">3.255. smime_sign_command</a></span></dt><dt><span class="sect2"><a href="#smime-sign-opaque-command">3.256. smime_sign_opaque_command</a></span></dt><dt><span class="sect2"><a href="#smime-timeout">3.257. smime_timeout</a></span></dt><dt><span class="sect2"><a href="#smime-verify-command">3.258. smime_verify_command</a></span></dt><dt><span class="sect2"><a href="#smime-verify-opaque-command">3.259. smime_verify_opaque_command</a></span></dt><dt><span class="sect2"><a href="#smtp-authenticators">3.260. smtp_authenticators</a></span></dt><dt><span class="sect2"><a href="#smtp-pass">3.261. smtp_pass</a></span></dt><dt><span class="sect2"><a href="#smtp-url">3.262. smtp_url</a></span></dt><dt><span class="sect2"><a href="#sort">3.263. sort</a></span></dt><dt><span class="sect2"><a href="#sort-alias">3.264. sort_alias</a></span></dt><dt><span class="sect2"><a href="#sort-aux">3.265. sort_aux</a></span></dt><dt><span class="sect2"><a href="#sort-browser">3.266. sort_browser</a></span></dt><dt><span class="sect2"><a href="#sort-re">3.267. sort_re</a></span></dt><dt><span class="sect2"><a href="#spam-separator">3.268. spam_separator</a></span></dt><dt><span class="sect2"><a href="#spoolfile">3.269. spoolfile</a></span></dt><dt><span class="sect2"><a href="#ssl-ca-certificates-file">3.270. ssl_ca_certificates_file</a></span></dt><dt><span class="sect2"><a href="#ssl-client-cert">3.271. ssl_client_cert</a></span></dt><dt><span class="sect2"><a href="#ssl-force-tls">3.272. ssl_force_tls</a></span></dt><dt><span class="sect2"><a href="#ssl-min-dh-prime-bits">3.273. ssl_min_dh_prime_bits</a></span></dt><dt><span class="sect2"><a href="#ssl-starttls">3.274. ssl_starttls</a></span></dt><dt><span class="sect2"><a href="#ssl-use-sslv2">3.275. ssl_use_sslv2</a></span></dt><dt><span class="sect2"><a href="#ssl-use-sslv3">3.276. ssl_use_sslv3</a></span></dt><dt><span class="sect2"><a href="#ssl-use-tlsv1">3.277. ssl_use_tlsv1</a></span></dt><dt><span class="sect2"><a href="#ssl-usesystemcerts">3.278. ssl_usesystemcerts</a></span></dt><dt><span class="sect2"><a href="#ssl-verify-dates">3.279. ssl_verify_dates</a></span></dt><dt><span class="sect2"><a href="#ssl-verify-host">3.280. ssl_verify_host</a></span></dt><dt><span class="sect2"><a href="#status-chars">3.281. status_chars</a></span></dt><dt><span class="sect2"><a href="#status-format">3.282. status_format</a></span></dt><dt><span class="sect2"><a href="#status-on-top">3.283. status_on_top</a></span></dt><dt><span class="sect2"><a href="#strict-threads">3.284. strict_threads</a></span></dt><dt><span class="sect2"><a href="#suspend">3.285. suspend</a></span></dt><dt><span class="sect2"><a href="#text-flowed">3.286. text_flowed</a></span></dt><dt><span class="sect2"><a href="#thorough-search">3.287. thorough_search</a></span></dt><dt><span class="sect2"><a href="#thread-received">3.288. thread_received</a></span></dt><dt><span class="sect2"><a href="#tilde">3.289. tilde</a></span></dt><dt><span class="sect2"><a href="#time-inc">3.290. time_inc</a></span></dt><dt><span class="sect2"><a href="#timeout">3.291. timeout</a></span></dt><dt><span class="sect2"><a href="#tmpdir">3.292. tmpdir</a></span></dt><dt><span class="sect2"><a href="#to-chars">3.293. to_chars</a></span></dt><dt><span class="sect2"><a href="#tunnel">3.294. tunnel</a></span></dt><dt><span class="sect2"><a href="#uncollapse-jump">3.295. uncollapse_jump</a></span></dt><dt><span class="sect2"><a href="#use-8bitmime">3.296. use_8bitmime</a></span></dt><dt><span class="sect2"><a href="#use-domain">3.297. use_domain</a></span></dt><dt><span class="sect2"><a href="#use-envelope-from">3.298. use_envelope_from</a></span></dt><dt><span class="sect2"><a href="#use-from">3.299. use_from</a></span></dt><dt><span class="sect2"><a href="#use-idn">3.300. use_idn</a></span></dt><dt><span class="sect2"><a href="#use-ipv6">3.301. use_ipv6</a></span></dt><dt><span class="sect2"><a href="#user-agent">3.302. user_agent</a></span></dt><dt><span class="sect2"><a href="#visual">3.303. visual</a></span></dt><dt><span class="sect2"><a href="#wait-key">3.304. wait_key</a></span></dt><dt><span class="sect2"><a href="#weed">3.305. weed</a></span></dt><dt><span class="sect2"><a href="#wrap">3.306. wrap</a></span></dt><dt><span class="sect2"><a href="#wrap-search">3.307. wrap_search</a></span></dt><dt><span class="sect2"><a href="#wrapmargin">3.308. wrapmargin</a></span></dt><dt><span class="sect2"><a href="#write-bcc">3.309. write_bcc</a></span></dt><dt><span class="sect2"><a href="#write-inc">3.310. 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="#attach-map">4.6. Attach Menu</a></span></dt><dt><span class="sect2"><a href="#compose-map">4.7. Compose Menu</a></span></dt><dt><span class="sect2"><a href="#postpone-map">4.8. Postpone Menu</a></span></dt><dt><span class="sect2"><a href="#browser-map">4.9. Browser Menu</a></span></dt><dt><span class="sect2"><a href="#pgp-map">4.10. Pgp Menu</a></span></dt><dt><span class="sect2"><a href="#smime-map">4.11. Smime Menu</a></span></dt><dt><span class="sect2"><a href="#mix-map">4.12. Mix Menu</a></span></dt><dt><span class="sect2"><a href="#editor-map">4.13. Editor Menu</a></span></dt></dl></dd></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="commandline"></a>1. Command-Line Options</h2></div></div></div><p>
3808 Running <code class="literal">mutt</code> with no arguments will make Mutt attempt to read your spool
3809 mailbox. However, it is possible to read other mailboxes and
3810 to send messages from the command line as well.
3811 </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>
3812 To read messages in a mailbox
3813 </p><div class="cmdsynopsis"><p><code class="command">mutt</code> [<code class="option">-nz</code>] [<code class="option">-F</code>
3814 <em class="replaceable"><code>muttrc</code></em>
3815 ] [<code class="option">-m</code>
3816 <em class="replaceable"><code>type</code></em>
3817 ] [<code class="option">-f</code>
3818 <em class="replaceable"><code>mailbox</code></em>
3820 To compose a new message
3821 </p><div class="cmdsynopsis"><p><code class="command">mutt</code> [<code class="option">-n</code>] [<code class="option">-F</code>
3822 <em class="replaceable"><code>muttrc</code></em>
3823 ] [<code class="option">-c</code>
3824 <em class="replaceable"><code>address</code></em>
3825 ] [<code class="option">-i</code>
3826 <em class="replaceable"><code>filename</code></em>
3827 ] [<code class="option">-s</code>
3828 <em class="replaceable"><code>subject</code></em>
3830 <code class="option">-a</code>
3831 <em class="replaceable"><code>file</code></em>
3835 <em class="replaceable"><code>address</code></em>
3837 Mutt also supports a “<span class="quote">batch</span>” mode to send prepared messages. Simply redirect
3838 input from the file you wish to send. For example,
3839 </p><pre class="screen">
3840 mutt -s "data set for run #2" professor@bigschool.edu < ˜/run2.dat</pre><p>
3841 will send a message to <code class="literal"><professor@bigschool.edu></code> with a subject
3842 of “<span class="quote">data set for run #2</span>”. In the body of the message will be the contents
3843 of the file “<span class="quote">˜/run2.dat</span>”.
3845 All files passed with <code class="literal">-a</code> <span class="emphasis"><em>file</em></span> will be attached as a MIME
3846 part to the message. To attach a single or several files, use “<span class="quote">--</span>” to separate files and
3847 recipient addresses:
3848 </p><pre class="screen">
3849 mutt -a image.png -- some@one.org</pre><p>
3851 </p><pre class="screen">
3852 mutt -a *.png -- some@one.org</pre><div class="note"><h3 class="title">Note</h3><p>
3853 The <code class="literal">-a</code> option must be last in the option list.
3854 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="commands"></a>2. Configuration Commands</h2></div></div></div><p>
3855 The following are the commands understood by Mutt:
3856 </p><div class="itemizedlist"><ul type="disc"><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#account-hook" title="6. Managing Multiple Accounts">account-hook</a></code>
3857 <em class="replaceable"><code>pattern</code></em>
3858 <em class="replaceable"><code>command</code></em>
3859 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#alias" title="4. Defining/Using Aliases">alias</a></code> [
3860 <code class="option">-group</code>
3861 <em class="replaceable"><code>name</code></em>
3863 <em class="replaceable"><code>key</code></em>
3865 <em class="replaceable"><code>address</code></em>
3867 <em class="replaceable"><code>address</code></em>
3868 ...]<br /><code class="command"><a class="link" href="#alias" title="4. Defining/Using Aliases">unalias</a></code> [
3869 <code class="option">-group</code>
3870 <em class="replaceable"><code>name</code></em>
3872 <em class="replaceable"><code>*</code></em>
3874 <em class="replaceable"><code>key</code></em>
3875 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#alternates" title="11. Alternative Addresses">alternates</a></code> [
3876 <code class="option">-group</code>
3877 <em class="replaceable"><code>name</code></em>
3879 <em class="replaceable"><code>regexp</code></em>
3881 <em class="replaceable"><code>regexp</code></em>
3882 ...]<br /><code class="command"><a class="link" href="#alternates" title="11. Alternative Addresses">unalternates</a></code> [
3883 <code class="option">-group</code>
3884 <em class="replaceable"><code>name</code></em>
3886 <em class="replaceable"><code>*</code></em>
3888 <em class="replaceable"><code>regexp</code></em>
3889 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#alternative-order" title="5. MIME Multipart/Alternative">alternative-order</a></code>
3890 <em class="replaceable"><code>mimetype</code></em>
3892 <em class="replaceable"><code>mimetype</code></em>
3893 ...]<br /><code class="command"><a class="link" href="#alternative-order" title="5. MIME Multipart/Alternative">unalternative-order</a></code> {
3894 <em class="replaceable"><code>*</code></em>
3896 <em class="replaceable"><code>mimetype</code></em>
3897 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#attachments" title="6. Attachment Searching and Counting">attachments</a></code>
3898 <em class="replaceable"><code>{ + | - }disposition</code></em>
3900 <em class="replaceable"><code>mime-type</code></em>
3901 <br /><code class="command"><a class="link" href="#attachments" title="6. Attachment Searching and Counting">unattachments</a></code>
3902 <em class="replaceable"><code>{ + | - }disposition</code></em>
3904 <em class="replaceable"><code>mime-type</code></em>
3905 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#auto-view" title="4. MIME Autoview">auto-view</a></code>
3906 <em class="replaceable"><code>mimetype</code></em>
3908 <em class="replaceable"><code>mimetype</code></em>
3909 ...]<br /><code class="command"><a class="link" href="#auto-view" title="4. MIME Autoview">unauto-view</a></code> {
3910 <em class="replaceable"><code>*</code></em>
3912 <em class="replaceable"><code>mimetype</code></em>
3913 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#bind" title="5. Changing the Default Key Bindings">bind</a></code>
3914 <em class="replaceable"><code>map</code></em>
3916 <em class="replaceable"><code>key</code></em>
3918 <em class="replaceable"><code>function</code></em>
3919 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#charset-hook" title="6. Defining Aliases for Character Sets">charset-hook</a></code>
3920 <em class="replaceable"><code>alias</code></em>
3922 <em class="replaceable"><code>charset</code></em>
3923 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#iconv-hook">iconv-hook</a></code>
3924 <em class="replaceable"><code>charset</code></em>
3926 <em class="replaceable"><code>local-charset</code></em>
3927 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#color" title="9. Using Color and Mono Video Attributes">color</a></code>
3928 <em class="replaceable"><code>object</code></em>
3930 <em class="replaceable"><code>foreground</code></em>
3932 <em class="replaceable"><code>background</code></em>
3933 <br /><code class="command"><a class="link" href="#color" title="9. Using Color and Mono Video Attributes">color</a></code> {
3934 <code class="option">header</code>
3936 <code class="option">body</code>
3938 <em class="replaceable"><code>foreground</code></em>
3940 <em class="replaceable"><code>background</code></em>
3942 <em class="replaceable"><code>regexp</code></em>
3943 <br /><code class="command"><a class="link" href="#color" title="9. Using Color and Mono Video Attributes">color</a></code>
3944 <code class="option">index</code>
3946 <em class="replaceable"><code>foreground</code></em>
3948 <em class="replaceable"><code>background</code></em>
3950 <em class="replaceable"><code>pattern</code></em>
3951 <br /><code class="command"><a class="link" href="#color" title="9. Using Color and Mono Video Attributes">uncolor</a></code> {
3952 <code class="option">index</code>
3954 <code class="option">header</code>
3956 <code class="option">body</code>
3958 <em class="replaceable"><code>*</code></em>
3960 <em class="replaceable"><code>pattern</code></em>
3961 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#crypt-hook" title="21. Choosing the Cryptographic Key of the Recipient">crypt-hook</a></code>
3962 <em class="replaceable"><code>pattern</code></em>
3964 <em class="replaceable"><code>keyid</code></em>
3965 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#exec" title="23. Executing Functions">exec</a></code>
3966 <em class="replaceable"><code>function</code></em>
3968 <em class="replaceable"><code>function</code></em>
3969 ...]</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#fcc-hook" title="17. Specify Default Fcc: Mailbox When Composing">fcc-hook</a></code>
3970 <em class="replaceable"><code>[!]pattern</code></em>
3972 <em class="replaceable"><code>mailbox</code></em>
3973 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#fcc-save-hook" title="18. Specify Default Save Filename and Default Fcc: Mailbox at Once">fcc-save-hook</a></code>
3974 <em class="replaceable"><code>[!]pattern</code></em>
3976 <em class="replaceable"><code>mailbox</code></em>
3977 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#folder-hook" title="7. Setting Variables Based Upon Mailbox">folder-hook</a></code>
3978 <em class="replaceable"><code>[!]regexp</code></em>
3980 <em class="replaceable"><code>command</code></em>
3981 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#addrgroup" title="3. Address Groups">group</a></code> [
3982 <code class="option">-group</code>
3983 <em class="replaceable"><code>name</code></em>
3985 <code class="option">-rx</code>
3986 <em class="replaceable"><code>expr</code></em>
3988 <code class="option">-addr</code>
3989 <em class="replaceable"><code>expr</code></em>
3990 ... }<br /><code class="command"><a class="link" href="#addrgroup" title="3. Address Groups">ungroup</a></code> [
3991 <code class="option">-group</code>
3992 <em class="replaceable"><code>name</code></em>
3994 <em class="replaceable"><code>*</code></em>
3996 <code class="option">-rx</code>
3997 <em class="replaceable"><code>expr</code></em>
3999 <code class="option">-addr</code>
4000 <em class="replaceable"><code>expr</code></em>
4001 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#hdr-order" title="10.2. Ordering Displayed Headers">hdr_order</a></code>
4002 <em class="replaceable"><code>header</code></em>
4004 <em class="replaceable"><code>header</code></em>
4005 ...]<br /><code class="command"><a class="link" href="#hdr-order" title="10.2. Ordering Displayed Headers">unhdr_order</a></code> {
4006 <em class="replaceable"><code>*</code></em>
4008 <em class="replaceable"><code>header</code></em>
4009 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#ignore" title="10.1. Selecting Headers">ignore</a></code>
4010 <em class="replaceable"><code>pattern</code></em>
4012 <em class="replaceable"><code>pattern</code></em>
4013 ...]<br /><code class="command"><a class="link" href="#ignore" title="10.1. Selecting Headers">unignore</a></code> {
4014 <em class="replaceable"><code>*</code></em>
4016 <em class="replaceable"><code>pattern</code></em>
4017 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#lists" title="12. Mailing Lists">lists</a></code> [
4018 <code class="option">-group</code>
4019 <em class="replaceable"><code>name</code></em>
4021 <em class="replaceable"><code>regexp</code></em>
4023 <em class="replaceable"><code>regexp</code></em>
4024 ...]<br /><code class="command"><a class="link" href="#lists" title="12. Mailing Lists">unlists</a></code> [
4025 <code class="option">-group</code>
4026 <em class="replaceable"><code>name</code></em>
4028 <em class="replaceable"><code>*</code></em>
4030 <em class="replaceable"><code>regexp</code></em>
4031 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#macro" title="8. Keyboard Macros">macro</a></code>
4032 <em class="replaceable"><code>menu</code></em>
4034 <em class="replaceable"><code>key</code></em>
4036 <em class="replaceable"><code>sequence</code></em>
4038 <em class="replaceable"><code>description</code></em>
4039 ]</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#mailboxes" title="14. Monitoring Incoming Mail">mailboxes</a></code>
4040 <em class="replaceable"><code>mailbox</code></em>
4042 <em class="replaceable"><code>mailbox</code></em>
4043 ...]<br /><code class="command"><a class="link" href="#mailboxes" title="14. Monitoring Incoming Mail">unmailboxes</a></code> {
4044 <em class="replaceable"><code>*</code></em>
4046 <em class="replaceable"><code>mailbox</code></em>
4047 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#mbox-hook" title="13. Using Multiple Spool Mailboxes">mbox-hook</a></code>
4048 <em class="replaceable"><code>[!]pattern</code></em>
4050 <em class="replaceable"><code>mailbox</code></em>
4051 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#message-hook" title="20. Change Settings Before Formatting a Message">message-hook</a></code>
4052 <em class="replaceable"><code>[!]pattern</code></em>
4054 <em class="replaceable"><code>command</code></em>
4055 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#mime-lookup" title="7. MIME Lookup">mime-lookup</a></code>
4056 <em class="replaceable"><code>mimetype</code></em>
4058 <em class="replaceable"><code>mimetype</code></em>
4059 ...]<br /><code class="command"><a class="link" href="#mime-lookup" title="7. MIME Lookup">unmime-lookup</a></code> {
4060 <em class="replaceable"><code>*</code></em>
4062 <em class="replaceable"><code>mimetype</code></em>
4063 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#mono">mono</a></code>
4064 <em class="replaceable"><code>object</code></em>
4066 <em class="replaceable"><code>attribute</code></em>
4067 <br /><code class="command"><a class="link" href="#mono">mono</a></code> {
4068 <code class="option">header</code>
4070 <code class="option">body</code>
4072 <em class="replaceable"><code>attribute</code></em>
4074 <em class="replaceable"><code>regexp</code></em>
4075 <br /><code class="command"><a class="link" href="#mono">mono</a></code>
4076 <code class="option">index</code>
4078 <em class="replaceable"><code>attribute</code></em>
4080 <em class="replaceable"><code>pattern</code></em>
4081 <br /><code class="command"><a class="link" href="#mono">unmono</a></code> {
4082 <code class="option">index</code>
4084 <code class="option">header</code>
4086 <code class="option">body</code>
4088 <em class="replaceable"><code>*</code></em>
4090 <em class="replaceable"><code>pattern</code></em>
4091 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#my-hdr" title="15. User-Defined Headers">my_hdr</a></code>
4092 <em class="replaceable"><code>string</code></em>
4093 <br /><code class="command"><a class="link" href="#my-hdr" title="15. User-Defined Headers">unmy_hdr</a></code> {
4094 <em class="replaceable"><code>*</code></em>
4096 <em class="replaceable"><code>field</code></em>
4097 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#push" title="22. Adding Key Sequences to the Keyboard Buffer">push</a></code>
4098 <em class="replaceable"><code>string</code></em>
4099 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#save-hook" title="16. Specify Default Save Mailbox">save-hook</a></code>
4100 <em class="replaceable"><code>[!]pattern</code></em>
4102 <em class="replaceable"><code>mailbox</code></em>
4103 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#score" title="3.224. score">score</a></code>
4104 <em class="replaceable"><code>pattern</code></em>
4106 <em class="replaceable"><code>value</code></em>
4107 <br /><code class="command"><a class="link" href="#score" title="3.224. score">unscore</a></code> {
4108 <em class="replaceable"><code>*</code></em>
4110 <em class="replaceable"><code>pattern</code></em>
4111 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#reply-hook">reply-hook</a></code>
4112 <em class="replaceable"><code>[!]pattern</code></em>
4114 <em class="replaceable"><code>command</code></em>
4115 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#send-hook" title="19. Change Settings Based Upon Message Recipients">send-hook</a></code>
4116 <em class="replaceable"><code>[!]pattern</code></em>
4118 <em class="replaceable"><code>command</code></em>
4119 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#send2-hook">send2-hook</a></code>
4120 <em class="replaceable"><code>[!]pattern</code></em>
4122 <em class="replaceable"><code>command</code></em>
4123 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#set" title="26. Setting and Querying Variables">set</a></code> {
4124 [ <code class="option">no</code> | <code class="option">inv</code> ]
4125 <em class="replaceable"><code>variable</code></em>
4127 <em class="replaceable"><code>variable=value</code></em>
4128 } [...]<br /><code class="command"><a class="link" href="#set" title="26. Setting and Querying Variables">toggle</a></code>
4129 <em class="replaceable"><code>variable</code></em>
4131 <em class="replaceable"><code>variable</code></em>
4132 ...]<br /><code class="command"><a class="link" href="#set" title="26. Setting and Querying Variables">unset</a></code>
4133 <em class="replaceable"><code>variable</code></em>
4135 <em class="replaceable"><code>variable</code></em>
4136 ...]<br /><code class="command"><a class="link" href="#set" title="26. Setting and Querying Variables">reset</a></code>
4137 <em class="replaceable"><code>variable</code></em>
4139 <em class="replaceable"><code>variable</code></em>
4140 ...]</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#source" title="27. Reading Initialization Commands From Another File">source</a></code>
4141 <em class="replaceable"><code>filename</code></em>
4142 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#spam" title="25. Spam Detection">spam</a></code>
4143 <em class="replaceable"><code>pattern</code></em>
4145 <em class="replaceable"><code>format</code></em>
4146 <br /><code class="command"><a class="link" href="#spam" title="25. Spam Detection">nospam</a></code> {
4147 <em class="replaceable"><code>*</code></em>
4149 <em class="replaceable"><code>pattern</code></em>
4150 }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#subscribe">subscribe</a></code> [
4151 <code class="option">-group</code>
4152 <em class="replaceable"><code>name</code></em>
4154 <em class="replaceable"><code>regexp</code></em>
4156 <em class="replaceable"><code>regexp</code></em>
4157 ...]<br /><code class="command"><a class="link" href="#subscribe">unsubscribe</a></code> [
4158 <code class="option">-group</code>
4159 <em class="replaceable"><code>name</code></em>
4161 <em class="replaceable"><code>*</code></em>
4163 <em class="replaceable"><code>regexp</code></em>
4164 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#unhook" title="28. Removing Hooks">unhook</a></code> {
4165 <em class="replaceable"><code>*</code></em>
4167 <em class="replaceable"><code>hook-type</code></em>
4168 }</p></div></li></ul></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="variables"></a>3. Configuration Variables</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="abort-nosubject"></a>3.1. abort_nosubject</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4169 Default: ask-yes</p></div><p>
4170 If set to <span class="emphasis"><em>yes</em></span>, when composing messages and no subject is given
4171 at the subject prompt, composition will be aborted. If set to
4172 <span class="emphasis"><em>no</em></span>, composing messages with no subject given at the subject
4173 prompt will never be aborted.
4174 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="abort-unmodified"></a>3.2. abort_unmodified</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4175 Default: yes</p></div><p>
4176 If set to <span class="emphasis"><em>yes</em></span>, composition will automatically abort after
4177 editing the message body if no changes are made to the file (this
4178 check only happens after the <span class="emphasis"><em>first</em></span> edit of the file). When set
4179 to <span class="emphasis"><em>no</em></span>, composition will never be aborted.
4180 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="alias-file"></a>3.3. alias_file</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4181 Default: “<span class="quote"><code class="literal">˜/.muttrc</code></span>”</p></div><p>
4182 The default file in which to save aliases created by the
4183 <code class="literal"><a class="link" href="#create-alias"><create-alias></a></code> function. Entries added to this file are
4184 encoded in the character set specified by <a class="link" href="#config-charset" title="3.30. config_charset">$config_charset</a> if it
4185 is <span class="emphasis"><em>set</em></span> or the current character set otherwise.
4187 <span class="bold"><strong>Note:</strong></span> Mutt will not automatically source this file; you must
4188 explicitly use the “<span class="quote"><a class="link" href="#source" title="27. Reading Initialization Commands From Another File">source</a></span>” command for it to be executed in case
4189 this option points to a dedicated alias file.
4191 The default for this option is the currently used muttrc file, or
4192 “<span class="quote">˜/.muttrc</span>” if no user muttrc was found.
4193 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="alias-format"></a>3.4. alias_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4194 Default: “<span class="quote"><code class="literal">%4n %2f %t %-10a %r</code></span>”</p></div><p>
4195 Specifies the format of the data displayed for the “<span class="quote"><a class="link" href="#alias" title="4. Defining/Using Aliases">alias</a></span>” menu. The
4196 following <code class="literal">printf(3)</code>-style sequences are available:
4198 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>%a </td><td>alias name
4199 </td></tr><tr><td>%f </td><td>flags - currently, a “<span class="quote">d</span>” for an alias marked for deletion
4200 </td></tr><tr><td>%n </td><td>index number
4201 </td></tr><tr><td>%r </td><td>address which alias expands to
4202 </td></tr><tr><td>%t </td><td>character which indicates if the alias is tagged for inclusion
4203 </td></tr></tbody></table></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="allow-8bit"></a>3.5. allow_8bit</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4204 Default: yes</p></div><p>
4205 Controls whether 8-bit data is converted to 7-bit using either Quoted-
4206 Printable or Base64 encoding when sending mail.
4207 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="allow-ansi"></a>3.6. allow_ansi</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4208 Default: no</p></div><p>
4209 Controls whether ANSI color codes in messages (and color tags in
4210 rich text messages) are to be interpreted.
4211 Messages containing these codes are rare, but if this option is <span class="emphasis"><em>set</em></span>,
4212 their text will be colored accordingly. Note that this may override
4213 your color choices, and even present a security problem, since a
4214 message could include a line like
4216 </p><pre class="screen">
4217 [-- PGP output follows ...
4219 and give it the same color as your attachment color (see also
4220 <a class="link" href="#crypt-timestamp" title="3.43. crypt_timestamp">$crypt_timestamp</a>).
4221 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="arrow-cursor"></a>3.7. arrow_cursor</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4222 Default: no</p></div><p>
4223 When <span class="emphasis"><em>set</em></span>, an arrow (“<span class="quote">-></span>”) will be used to indicate the current entry
4224 in menus instead of highlighting the whole line. On slow network or modem
4225 links this will make response faster because there is less that has to
4226 be redrawn on the screen when moving to the next or previous entries
4228 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ascii-chars"></a>3.8. ascii_chars</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4229 Default: no</p></div><p>
4230 If <span class="emphasis"><em>set</em></span>, Mutt will use plain ASCII characters when displaying thread
4231 and attachment trees, instead of the default <span class="emphasis"><em>ACS</em></span> characters.
4232 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="askbcc"></a>3.9. askbcc</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4233 Default: no</p></div><p>
4234 If <span class="emphasis"><em>set</em></span>, Mutt will prompt you for blind-carbon-copy (Bcc) recipients
4235 before editing an outgoing message.
4236 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="askcc"></a>3.10. askcc</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4237 Default: no</p></div><p>
4238 If <span class="emphasis"><em>set</em></span>, Mutt will prompt you for carbon-copy (Cc) recipients before
4239 editing the body of an outgoing message.
4240 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="assumed-charset"></a>3.11. assumed_charset</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4241 Default: (empty)</p></div><p>
4242 This variable is a colon-separated list of character encoding
4243 schemes for messages without character encoding indication.
4244 Header field values and message body content without character encoding
4245 indication would be assumed that they are written in one of this list.
4246 By default, all the header fields and message body without any charset
4247 indication are assumed to be in “<span class="quote">us-ascii</span>”.
4249 For example, Japanese users might prefer this:
4251 </p><pre class="screen">
4252 set assumed_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
4254 However, only the first content is valid for the message body.
4255 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="attach-charset"></a>3.12. attach_charset</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4256 Default: (empty)</p></div><p>
4257 This variable is a colon-separated list of character encoding
4258 schemes for text file attachments. Mutt uses this setting to guess
4259 which encoding files being attached are encoded in to convert them to
4260 a proper character set given in <a class="link" href="#send-charset" title="3.229. send_charset">$send_charset</a>.
4262 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.
4263 For example, the following configuration would work for Japanese
4266 </p><pre class="screen">
4267 set attach_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
4269 Note: for Japanese users, “<span class="quote">iso-2022-*</span>” must be put at the head
4270 of the value as shown above if included.
4271 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="attach-format"></a>3.13. attach_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4272 Default: “<span class="quote"><code class="literal">%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] </code></span>”</p></div><p>
4273 This variable describes the format of the “<span class="quote">attachment</span>” menu. The
4274 following <code class="literal">printf(3)</code>-style sequences are understood:
4276 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>%C </td><td>charset
4277 </td></tr><tr><td>%c </td><td>requires charset conversion (“<span class="quote">n</span>” or “<span class="quote">c</span>”)
4278 </td></tr><tr><td>%D </td><td>deleted flag
4279 </td></tr><tr><td>%d </td><td>description
4280 </td></tr><tr><td>%e </td><td>MIME content-transfer-encoding
4281 </td></tr><tr><td>%f </td><td>filename
4282 </td></tr><tr><td>%I </td><td>disposition (“<span class="quote">I</span>” for inline, “<span class="quote">A</span>” for attachment)
4283 </td></tr><tr><td>%m </td><td>major MIME type
4284 </td></tr><tr><td>%M </td><td>MIME subtype
4285 </td></tr><tr><td>%n </td><td>attachment number
4286 </td></tr><tr><td>%Q </td><td>“<span class="quote">Q</span>”, if MIME part qualifies for attachment counting
4287 </td></tr><tr><td>%s </td><td>size
4288 </td></tr><tr><td>%t </td><td>tagged flag
4289 </td></tr><tr><td>%T </td><td>graphic tree characters
4290 </td></tr><tr><td>%u </td><td>unlink (=to delete) flag
4291 </td></tr><tr><td>%X </td><td>number of qualifying MIME parts in this part and its children
4292 (please see the “<span class="quote"><a class="link" href="#attachments" title="6. Attachment Searching and Counting">attachments</a></span>” section for possible speed effects)
4293 </td></tr><tr><td>%>X </td><td>right justify the rest of the string and pad with character “<span class="quote">X</span>”
4294 </td></tr><tr><td>%|X </td><td>pad to the end of the line with character “<span class="quote">X</span>”
4295 </td></tr><tr><td>%*X </td><td>soft-fill with character “<span class="quote">X</span>” as pad
4296 </td></tr></tbody></table></div><p>
4297 For an explanation of “<span class="quote">soft-fill</span>”, see the <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> documentation.
4298 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="attach-sep"></a>3.14. attach_sep</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4299 Default: “<span class="quote"><code class="literal">\n</code></span>”</p></div><p>
4300 The separator to add between attachments when operating (saving,
4301 printing, piping, etc) on a list of tagged attachments.
4302 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="attach-split"></a>3.15. attach_split</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4303 Default: yes</p></div><p>
4304 If this variable is <span class="emphasis"><em>unset</em></span>, when operating (saving, printing, piping,
4305 etc) on a list of tagged attachments, Mutt will concatenate the
4306 attachments and will operate on them as a single attachment. The
4307 <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>,
4308 Mutt will operate on the attachments one by one.
4309 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="attribution"></a>3.16. attribution</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4310 Default: “<span class="quote"><code class="literal">On %d, %n wrote:</code></span>”</p></div><p>
4311 This is the string that will precede a message which has been included
4312 in a reply. For a full listing of defined <code class="literal">printf(3)</code>-like sequences see
4313 the section on <a class="link" href="#index-format" title="3.114. index_format">$index_format</a>.
4314 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4315 Default: no</p></div><p>
4316 When <span class="emphasis"><em>set</em></span>, functions in the <span class="emphasis"><em>index</em></span> menu which affect a message
4317 will be applied to all tagged messages (if there are any). When
4318 unset, you must first use the <code class="literal"><tag-prefix></code> function (bound to “<span class="quote">;</span>”
4319 by default) to make the next function apply to all tagged messages.
4320 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4321 Default: no</p></div><p>
4322 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
4323 send-menu (prompting for subject and recipients) and allow you to
4324 immediately begin editing the body of your
4325 message. The send-menu may still be accessed once you have finished
4326 editing the body of your message.
4328 <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
4329 on the recipients when composing a new (non-reply) message, as the initial
4330 list of recipients is empty.
4332 Also see <a class="link" href="#fast-reply" title="3.63. fast_reply">$fast_reply</a>.
4333 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="beep"></a>3.19. beep</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4334 Default: yes</p></div><p>
4335 When this variable is <span class="emphasis"><em>set</em></span>, mutt will beep when an error occurs.
4336 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="beep-new"></a>3.20. beep_new</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4337 Default: no</p></div><p>
4338 When this variable is <span class="emphasis"><em>set</em></span>, mutt will beep whenever it prints a message
4339 notifying you of new mail. This is independent of the setting of the
4340 <a class="link" href="#beep" title="3.19. beep">$beep</a> variable.
4341 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="bounce"></a>3.21. bounce</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4342 Default: ask-yes</p></div><p>
4343 Controls whether you will be asked to confirm bouncing messages.
4344 If set to <span class="emphasis"><em>yes</em></span> you don't get asked if you want to bounce a
4345 message. Setting this variable to <span class="emphasis"><em>no</em></span> is not generally useful,
4346 and thus not recommended, because you are unable to bounce messages.
4347 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="bounce-delivered"></a>3.22. bounce_delivered</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4348 Default: yes</p></div><p>
4349 When this variable is <span class="emphasis"><em>set</em></span>, mutt will include Delivered-To headers when
4350 bouncing messages. Postfix users may wish to <span class="emphasis"><em>unset</em></span> this variable.
4351 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="braille-friendly"></a>3.23. braille_friendly</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4352 Default: no</p></div><p>
4353 When this variable is <span class="emphasis"><em>set</em></span>, mutt will place the cursor at the beginning
4354 of the current line in menus, even when the <a class="link" href="#arrow-cursor" title="3.7. arrow_cursor">$arrow_cursor</a> variable
4355 is <span class="emphasis"><em>unset</em></span>, making it easier for blind persons using Braille displays to
4356 follow these menus. The option is <span class="emphasis"><em>unset</em></span> by default because many
4357 visual terminals don't permit making the cursor invisible.
4358 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4359 Default: “<span class="quote"><code class="literal">˜/.mutt_certificates</code></span>”</p></div><p>
4360 This variable specifies the file where the certificates you trust
4361 are saved. When an unknown certificate is encountered, you are asked
4362 if you accept it or not. If you accept it, the certificate can also
4363 be saved in this file and further connections are automatically
4366 You can also manually add CA certificates in this file. Any server
4367 certificate that is signed with one of these CA certificates is
4368 also automatically accepted.
4372 </p><pre class="screen">
4373 set certificate_file=~/.mutt/certificates
4374 </pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="charset"></a>3.25. charset</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4375 Default: (empty)</p></div><p>
4376 Character set your terminal uses to display and enter textual data.
4377 It is also the fallback for <a class="link" href="#send-charset" title="3.229. send_charset">$send_charset</a>.
4379 Upon startup Mutt tries to derive this value from environment variables
4380 such as <code class="literal">$LC_CTYPE</code> or <code class="literal">$LANG</code>.
4382 <span class="bold"><strong>Note:</strong></span> It should only be set in case Mutt isn't abled to determine the
4383 character set used correctly.
4384 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="check-mbox-size"></a>3.26. check_mbox_size</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4385 Default: no</p></div><p>
4386 When this variable is <span class="emphasis"><em>set</em></span>, mutt will use file size attribute instead of
4387 access time when checking for new mail in mbox and mmdf folders.
4389 This variable is <span class="emphasis"><em>unset</em></span> by default and should only be enabled when
4390 new mail detection for these folder types is unreliable or doesn't work.
4392 Note that enabling this variable should happen before any “<span class="quote"><a class="link" href="#mailboxes" title="14. Monitoring Incoming Mail">mailboxes</a></span>”
4393 directives occur in configuration files regarding mbox or mmdf folders
4394 because mutt needs to determine the initial new mail status of such a
4395 mailbox by performing a fast mailbox scan when it is defined.
4396 Afterwards the new mail status is tracked by file size changes.
4397 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4398 Default: yes</p></div><p>
4399 <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
4402 When <span class="emphasis"><em>set</em></span>, Mutt will check for new mail delivered while the
4403 mailbox is open. Especially with MH mailboxes, this operation can
4404 take quite some time since it involves scanning the directory and
4405 checking each file to see if it has already been looked at. If
4406 this variable is <span class="emphasis"><em>unset</em></span>, no check for new mail is performed
4407 while the mailbox is open.
4408 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4409 Default: yes</p></div><p>
4410 When <span class="emphasis"><em>unset</em></span>, Mutt will not collapse a thread if it contains any
4412 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="compose-format"></a>3.29. compose_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4413 Default: “<span class="quote"><code class="literal">-- Mutt: Compose [Approx. msg size: %l Atts: %a]%>-</code></span>”</p></div><p>
4414 Controls the format of the status line displayed in the “<span class="quote">compose</span>”
4415 menu. This string is similar to <a class="link" href="#status-format" title="3.282. status_format">$status_format</a>, but has its own
4416 set of <code class="literal">printf(3)</code>-like sequences:
4418 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>%a </td><td>total number of attachments
4419 </td></tr><tr><td>%h </td><td>local hostname
4420 </td></tr><tr><td>%l </td><td>approximate size (in bytes) of the current message
4421 </td></tr><tr><td>%v </td><td>Mutt version string
4422 </td></tr></tbody></table></div><p>
4423 See the text describing the <a class="link" href="#status-format" title="3.282. status_format">$status_format</a> option for more
4424 information on how to set <a class="link" href="#compose-format" title="3.29. compose_format">$compose_format</a>.
4425 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="config-charset"></a>3.30. config_charset</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4426 Default: (empty)</p></div><p>
4427 When defined, Mutt will recode commands in rc files from this
4428 encoding to the current character set as specified by <a class="link" href="#charset" title="3.25. charset">$charset</a>
4429 and aliases written to <a class="link" href="#alias-file" title="3.3. alias_file">$alias_file</a> from the current character set.
4431 Please note that if setting <a class="link" href="#charset" title="3.25. charset">$charset</a> it must be done before
4432 setting <a class="link" href="#config-charset" title="3.30. config_charset">$config_charset</a>.
4434 Recoding should be avoided as it may render unconvertable
4435 characters as question marks which can lead to undesired
4436 side effects (for example in regular expressions).
4437 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="confirmappend"></a>3.31. confirmappend</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4438 Default: yes</p></div><p>
4439 When <span class="emphasis"><em>set</em></span>, Mutt will prompt for confirmation when appending messages to
4440 an existing mailbox.
4441 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="confirmcreate"></a>3.32. confirmcreate</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4442 Default: yes</p></div><p>
4443 When <span class="emphasis"><em>set</em></span>, Mutt will prompt for confirmation when saving messages to a
4444 mailbox which does not yet exist before creating it.
4445 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="connect-timeout"></a>3.33. connect_timeout</h3></div></div></div><div class="literallayout"><p>Type: number<br />
4446 Default: 30</p></div><p>
4447 Causes Mutt to timeout a network connection (for IMAP, POP or SMTP) after this
4448 many seconds if the connection is not able to be established. A negative
4449 value causes Mutt to wait indefinitely for the connection attempt to succeed.
4450 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="content-type"></a>3.34. content_type</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4451 Default: “<span class="quote"><code class="literal">text/plain</code></span>”</p></div><p>
4452 Sets the default Content-Type for the body of newly composed messages.
4453 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="copy"></a>3.35. copy</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4454 Default: yes</p></div><p>
4455 This variable controls whether or not copies of your outgoing messages
4456 will be saved for later references. Also see <a class="link" href="#record" title="3.211. record">$record</a>,
4457 <a class="link" href="#save-name" title="3.223. save_name">$save_name</a>, <a class="link" href="#force-name" title="3.69. force_name">$force_name</a> and “<span class="quote"><a class="link" href="#fcc-hook" title="17. Specify Default Fcc: Mailbox When Composing">fcc-hook</a></span>”.
4458 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4459 Default: no</p></div><p>
4460 Setting this variable will cause Mutt to always attempt to PGP
4461 encrypt outgoing messages. This is probably only useful in
4462 connection to the “<span class="quote"><a class="link" href="#send-hook" title="19. Change Settings Based Upon Message Recipients">send-hook</a></span>” command. It can be overridden
4463 by use of the pgp menu, when encryption is not required or
4464 signing is requested as well. If <a class="link" href="#smime-is-default" title="3.252. smime_is_default">$smime_is_default</a> is <span class="emphasis"><em>set</em></span>,
4465 then OpenSSL is used instead to create S/MIME messages and
4466 settings can be overridden by use of the smime menu instead.
4468 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4469 Default: yes</p></div><p>
4470 This variable controls whether or not mutt may automatically enable
4471 PGP encryption/signing for messages. See also <a class="link" href="#crypt-autoencrypt" title="3.36. crypt_autoencrypt">$crypt_autoencrypt</a>,
4472 <a class="link" href="#crypt-replyencrypt" title="3.40. crypt_replyencrypt">$crypt_replyencrypt</a>,
4473 <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.252. smime_is_default">$smime_is_default</a>.
4474 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4475 Default: no</p></div><p>
4476 Setting this variable will cause Mutt to always attempt to
4477 cryptographically sign outgoing messages. This can be overridden
4478 by use of the pgp menu, when signing is not required or
4479 encryption is requested as well. If <a class="link" href="#smime-is-default" title="3.252. smime_is_default">$smime_is_default</a> is <span class="emphasis"><em>set</em></span>,
4480 then OpenSSL is used instead to create S/MIME messages and settings can
4481 be overridden by use of the smime menu instead of the pgp menu.
4483 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-autosmime"></a>3.39. crypt_autosmime</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4484 Default: yes</p></div><p>
4485 This variable controls whether or not mutt may automatically enable
4486 S/MIME encryption/signing for messages. See also <a class="link" href="#crypt-autoencrypt" title="3.36. crypt_autoencrypt">$crypt_autoencrypt</a>,
4487 <a class="link" href="#crypt-replyencrypt" title="3.40. crypt_replyencrypt">$crypt_replyencrypt</a>,
4488 <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.252. smime_is_default">$smime_is_default</a>.
4489 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4490 Default: yes</p></div><p>
4491 If <span class="emphasis"><em>set</em></span>, automatically PGP or OpenSSL encrypt replies to messages which are
4494 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4495 Default: no</p></div><p>
4496 If <span class="emphasis"><em>set</em></span>, automatically PGP or OpenSSL sign replies to messages which are
4499 <span class="bold"><strong>Note:</strong></span> this does not work on messages that are encrypted
4500 <span class="emphasis"><em>and</em></span> signed!
4502 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4503 Default: no</p></div><p>
4504 If <span class="emphasis"><em>set</em></span>, automatically PGP or OpenSSL sign replies to messages
4505 which are encrypted. This makes sense in combination with
4506 <a class="link" href="#crypt-replyencrypt" title="3.40. crypt_replyencrypt">$crypt_replyencrypt</a>, because it allows you to sign all
4507 messages which are automatically encrypted. This works around
4508 the problem noted in <a class="link" href="#crypt-replysign" title="3.41. crypt_replysign">$crypt_replysign</a>, that mutt is not able
4509 to find out whether an encrypted message is also signed.
4511 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4512 Default: yes</p></div><p>
4513 If <span class="emphasis"><em>set</em></span>, mutt will include a time stamp in the lines surrounding
4514 PGP or S/MIME output, so spoofing such lines is more difficult.
4515 If you are using colors to mark these lines, and rely on these,
4516 you may <span class="emphasis"><em>unset</em></span> this setting.
4518 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-use-gpgme"></a>3.44. crypt_use_gpgme</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4519 Default: no</p></div><p>
4520 This variable controls the use of the GPGME-enabled crypto backends.
4521 If it is <span class="emphasis"><em>set</em></span> and Mutt was built with gpgme support, the gpgme code for
4522 S/MIME and PGP will be used instead of the classic code. Note that
4523 you need to set this option in .muttrc; it won't have any effect when
4525 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-use-pka"></a>3.45. crypt_use_pka</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4526 Default: no</p></div><p>
4527 Controls whether mutt uses PKA
4528 (see http://www.g10code.de/docs/pka-intro.de.pdf) during signature
4529 verification (only supported by the GPGME backend).
4530 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-verify-sig"></a>3.46. crypt_verify_sig</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4531 Default: yes</p></div><p>
4532 If <span class="emphasis"><em>“<span class="quote">yes</span>”</em></span>, always attempt to verify PGP or S/MIME signatures.
4533 If <span class="emphasis"><em>“<span class="quote">ask-*</span>”</em></span>, ask whether or not to verify the signature.
4534 If \Fi“<span class="quote">no</span>”, never attempt to verify cryptographic signatures.
4536 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4537 Default: “<span class="quote"><code class="literal">!%a, %b %d, %Y at %I:%M:%S%p %Z</code></span>”</p></div><p>
4538 This variable controls the format of the date printed by the “<span class="quote">%d</span>”
4539 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>
4540 function to process the date, see the man page for the proper syntax.
4542 Unless the first character in the string is a bang (“<span class="quote">!</span>”), the month
4543 and week day names are expanded according to the locale specified in
4544 the variable <a class="link" href="#locale" title="3.117. locale">$locale</a>. If the first character in the string is a
4545 bang, the bang is discarded, and the month and week day names in the
4546 rest of the string are expanded in the <span class="emphasis"><em>C</em></span> locale (that is in US
4548 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4549 Default: “<span class="quote"><code class="literal">˜f %s !˜P | (˜P ˜C %s)</code></span>”</p></div><p>
4550 This variable controls how “<span class="quote"><a class="link" href="#message-hook" title="20. Change Settings Before Formatting a Message">message-hook</a></span>”, “<span class="quote"><a class="link" href="#reply-hook">reply-hook</a></span>”, “<span class="quote"><a class="link" href="#send-hook" title="19. Change Settings Based Upon Message Recipients">send-hook</a></span>”,
4551 “<span class="quote"><a class="link" href="#send2-hook">send2-hook</a></span>”, “<span class="quote"><a class="link" href="#save-hook" title="16. Specify Default Save Mailbox">save-hook</a></span>”, and “<span class="quote"><a class="link" href="#fcc-hook" title="17. Specify Default Fcc: Mailbox When Composing">fcc-hook</a></span>” will
4552 be interpreted if they are specified with only a simple regexp,
4553 instead of a matching pattern. The hooks are expanded when they are
4554 declared, so a hook will be interpreted according to the value of this
4555 variable at the time the hook is declared.
4557 The default value matches
4558 if the message is either from a user matching the regular expression
4559 given, or if it is from you (if the from address matches
4560 “<span class="quote"><a class="link" href="#alternates" title="11. Alternative Addresses">alternates</a></span>”) and is to or cc'ed to a user matching the given
4562 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4563 Default: ask-yes</p></div><p>
4564 Controls whether or not messages are really deleted when closing or
4565 synchronizing a mailbox. If set to <span class="emphasis"><em>yes</em></span>, messages marked for
4566 deleting will automatically be purged without prompting. If set to
4567 <span class="emphasis"><em>no</em></span>, messages marked for deletion will be kept in the mailbox.
4568 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4569 Default: yes</p></div><p>
4570 If this option is <span class="emphasis"><em>set</em></span>, mutt will untag messages when marking them
4571 for deletion. This applies when you either explicitly delete a message,
4572 or when you save it to another folder.
4573 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4574 Default: yes</p></div><p>
4575 If this option is <span class="emphasis"><em>set</em></span>, mutt's received-attachments menu will not show the subparts of
4576 individual messages in a multipart/digest. To see these subparts, press “<span class="quote">v</span>” on that menu.
4577 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4578 Default: (empty)</p></div><p>
4579 When set, specifies a command used to filter messages. When a message
4580 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
4581 filtered message is read from the standard output.
4582 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4583 Default: “<span class="quote"><code class="literal">/usr/local/bin/mutt_dotlock</code></span>”</p></div><p>
4584 Contains the path of the <code class="literal">mutt_dotlock(8)</code> binary to be used by
4586 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4587 Default: (empty)</p></div><p>
4588 This variable sets the request for when notification is returned. The
4589 string consists of a comma separated list (no spaces!) of one or more
4590 of the following: <span class="emphasis"><em>never</em></span>, to never request notification,
4591 <span class="emphasis"><em>failure</em></span>, to request notification on transmission failure,
4592 <span class="emphasis"><em>delay</em></span>, to be notified of message delays, <span class="emphasis"><em>success</em></span>, to be
4593 notified of successful transmission.
4597 </p><pre class="screen">
4598 set dsn_notify="failure,delay"
4600 <span class="bold"><strong>Note:</strong></span> when using <a class="link" href="#sendmail" title="3.230. sendmail">$sendmail</a> for delivery, you should not enable
4601 this unless you are either using Sendmail 8.8.x or greater or a MTA
4602 providing a <code class="literal">sendmail(1)</code>-compatible interface supporting the <code class="literal">-N</code> option
4603 for DSN. For SMTP delivery, DSN support is autodetected so that it
4604 depends on the server whether DSN will be used or not.
4605 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4606 Default: (empty)</p></div><p>
4607 This variable controls how much of your message is returned in DSN
4608 messages. It may be set to either <span class="emphasis"><em>hdrs</em></span> to return just the
4609 message header, or <span class="emphasis"><em>full</em></span> to return the full message.
4613 </p><pre class="screen">
4616 <span class="bold"><strong>Note:</strong></span> when using <a class="link" href="#sendmail" title="3.230. sendmail">$sendmail</a> for delivery, you should not enable
4617 this unless you are either using Sendmail 8.8.x or greater or a MTA
4618 providing a <code class="literal">sendmail(1)</code>-compatible interface supporting the <code class="literal">-R</code> option
4619 for DSN. For SMTP delivery, DSN support is autodetected so that it
4620 depends on the server whether DSN will be used or not.
4621 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4622 Default: yes</p></div><p>
4623 This variable controls whether mutt, when <a class="link" href="#sort" title="3.263. sort">$sort</a> is set to <span class="emphasis"><em>threads</em></span>, threads
4624 messages with the same Message-Id together. If it is <span class="emphasis"><em>set</em></span>, it will indicate
4625 that it thinks they are duplicates of each other with an equals sign
4627 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4628 Default: no</p></div><p>
4629 This option allows you to edit the header of your outgoing messages
4630 along with the body of your message.
4632 <span class="bold"><strong>Note</strong></span> that changes made to the References: and Date: headers are
4633 ignored for interoperability reasons.
4634 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4635 Default: (empty)</p></div><p>
4636 This variable specifies which editor is used by mutt.
4637 It defaults to the value of the <code class="literal">$VISUAL</code>, or <code class="literal">$EDITOR</code>, environment
4638 variable, or to the string “<span class="quote">vi</span>” if neither of those are set.
4639 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4640 Default: no</p></div><p>
4641 When <span class="emphasis"><em>set</em></span>, mutt will quoted-printable encode messages when
4642 they contain the string “<span class="quote">From </span>” (note the trailing space) in the beginning of a line.
4643 This is useful to avoid the tampering certain mail delivery and transport
4644 agents tend to do with messages (in order to prevent tools from
4645 misinterpreting the line as a mbox message separator).
4646 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4647 Default: (empty)</p></div><p>
4648 The file which includes random data that is used to initialize SSL
4650 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="envelope-from-address"></a>3.61. envelope_from_address</h3></div></div></div><div class="literallayout"><p>Type: e-mail address<br />
4651 Default: (empty)</p></div><p>
4652 Manually sets the <span class="emphasis"><em>envelope</em></span> sender for outgoing messages.
4653 This value is ignored if <a class="link" href="#use-envelope-from" title="3.298. use_envelope_from">$use_envelope_from</a> is <span class="emphasis"><em>unset</em></span>.
4654 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4655 Default: “<span class="quote"><code class="literal">˜</code></span>”</p></div><p>
4656 Escape character to use for functions in the builtin editor.
4657 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4658 Default: no</p></div><p>
4659 When <span class="emphasis"><em>set</em></span>, the initial prompt for recipients and subject are skipped
4660 when replying to messages, and the initial prompt for subject is
4661 skipped when forwarding messages.
4663 <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>
4664 variable is <span class="emphasis"><em>set</em></span>.
4665 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4666 Default: yes</p></div><p>
4667 This variable controls whether or not attachments on outgoing messages
4668 are saved along with the main body of your message.
4669 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4670 Default: no</p></div><p>
4671 When this variable is <span class="emphasis"><em>set</em></span>, FCCs will be stored unencrypted and
4672 unsigned, even when the actual message is encrypted and/or
4675 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4676 Default: “<span class="quote"><code class="literal">˜/Mail</code></span>”</p></div><p>
4677 Specifies the default location of your mailboxes. A “<span class="quote">+</span>” or “<span class="quote">=</span>” at the
4678 beginning of a pathname will be expanded to the value of this
4679 variable. Note that if you change this variable (from the default)
4680 value you need to make sure that the assignment occurs <span class="emphasis"><em>before</em></span>
4681 you use “<span class="quote">+</span>” or “<span class="quote">=</span>” for any other variables since expansion takes place
4682 when handling the “<span class="quote"><a class="link" href="#mailboxes" title="14. Monitoring Incoming Mail">mailboxes</a></span>” command.
4683 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4684 Default: “<span class="quote"><code class="literal">%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f</code></span>”</p></div><p>
4685 This variable allows you to customize the file browser display to your
4686 personal taste. This string is similar to <a class="link" href="#index-format" title="3.114. index_format">$index_format</a>, but has
4687 its own set of <code class="literal">printf(3)</code>-like sequences:
4689 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>%C </td><td>current file number
4690 </td></tr><tr><td>%d </td><td>date/time folder was last modified
4691 </td></tr><tr><td>%f </td><td>filename (“<span class="quote">/</span>” is appended to directory names,
4692 “<span class="quote">@</span>” to symbolic links and “<span class="quote">*</span>” to executable
4694 </td></tr><tr><td>%F </td><td>file permissions
4695 </td></tr><tr><td>%g </td><td>group name (or numeric gid, if missing)
4696 </td></tr><tr><td>%l </td><td>number of hard links
4697 </td></tr><tr><td>%N </td><td>N if folder has new mail, blank otherwise
4698 </td></tr><tr><td>%s </td><td>size in bytes
4699 </td></tr><tr><td>%t </td><td>“<span class="quote">*</span>” if the file is tagged, blank otherwise
4700 </td></tr><tr><td>%u </td><td>owner name (or numeric uid, if missing)
4701 </td></tr><tr><td>%>X </td><td>right justify the rest of the string and pad with character “<span class="quote">X</span>”
4702 </td></tr><tr><td>%|X </td><td>pad to the end of the line with character “<span class="quote">X</span>”
4703 </td></tr><tr><td>%*X </td><td>soft-fill with character “<span class="quote">X</span>” as pad
4704 </td></tr></tbody></table></div><p>
4705 For an explanation of “<span class="quote">soft-fill</span>”, see the <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> documentation.
4706 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4707 Default: yes</p></div><p>
4708 Controls whether or not the “<span class="quote">Mail-Followup-To:</span>” header field is
4709 generated when sending mail. When <span class="emphasis"><em>set</em></span>, Mutt will generate this
4710 field when you are replying to a known mailing list, specified with
4711 the “<span class="quote"><a class="link" href="#subscribe">subscribe</a></span>” or “<span class="quote"><a class="link" href="#lists" title="12. Mailing Lists">lists</a></span>” commands.
4713 This field has two purposes. First, preventing you from
4714 receiving duplicate copies of replies to messages which you send
4715 to mailing lists, and second, ensuring that you do get a reply
4716 separately for any messages sent to known lists to which you are
4719 The header will contain only the list's address
4720 for subscribed lists, and both the list address and your own
4721 email address for unsubscribed lists. Without this header, a
4722 group reply to your message sent to a subscribed list will be
4723 sent to both the list and your address, resulting in two copies
4724 of the same email for you.
4725 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4726 Default: no</p></div><p>
4727 This variable is similar to <a class="link" href="#save-name" title="3.223. save_name">$save_name</a>, except that Mutt will
4728 store a copy of your outgoing message by the username of the address
4729 you are sending to even if that mailbox does not exist.
4731 Also see the <a class="link" href="#record" title="3.211. record">$record</a> variable.
4732 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4733 Default: yes</p></div><p>
4734 Controls the decoding of complex MIME messages into <code class="literal">text/plain</code> when
4735 forwarding a message. The message header is also RFC2047 decoded.
4736 This variable is only used, if <a class="link" href="#mime-forward" title="3.140. mime_forward">$mime_forward</a> is <span class="emphasis"><em>unset</em></span>,
4737 otherwise <a class="link" href="#mime-forward-decode" title="3.141. mime_forward_decode">$mime_forward_decode</a> is used instead.
4738 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4739 Default: yes</p></div><p>
4740 Controls the handling of encrypted messages when forwarding a message.
4741 When <span class="emphasis"><em>set</em></span>, the outer layer of encryption is stripped off. This
4742 variable is only used if <a class="link" href="#mime-forward" title="3.140. mime_forward">$mime_forward</a> is <span class="emphasis"><em>set</em></span> and
4743 <a class="link" href="#mime-forward-decode" title="3.141. mime_forward_decode">$mime_forward_decode</a> is <span class="emphasis"><em>unset</em></span>.
4745 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4746 Default: yes</p></div><p>
4747 This quadoption controls whether or not the user is automatically
4748 placed in the editor when forwarding messages. For those who always want
4749 to forward with no modification, use a setting of “<span class="quote">no</span>”.
4750 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4751 Default: “<span class="quote"><code class="literal">[%a: %s]</code></span>”</p></div><p>
4752 This variable controls the default subject when forwarding a message.
4753 It uses the same format sequences as the <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> variable.
4754 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4755 Default: no</p></div><p>
4756 When <span class="emphasis"><em>set</em></span>, forwarded messages included in the main body of the
4757 message (when <a class="link" href="#mime-forward" title="3.140. mime_forward">$mime_forward</a> is <span class="emphasis"><em>unset</em></span>) will be quoted using
4758 <a class="link" href="#indent-string" title="3.113. indent_string">$indent_string</a>.
4759 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4760 Default: (empty)</p></div><p>
4761 When <span class="emphasis"><em>set</em></span>, this variable contains a default from address. It
4762 can be overridden using “<span class="quote"><a class="link" href="#my-hdr" title="15. User-Defined Headers">my_hdr</a></span>” (including from a “<span class="quote"><a class="link" href="#send-hook" title="19. Change Settings Based Upon Message Recipients">send-hook</a></span>”) and
4763 <a class="link" href="#reverse-name" title="3.217. reverse_name">$reverse_name</a>. This variable is ignored if <a class="link" href="#use-from" title="3.299. use_from">$use_from</a> is <span class="emphasis"><em>unset</em></span>.
4765 This setting defaults to the contents of the environment variable <code class="literal">$EMAIL</code>.
4766 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4767 Default: “<span class="quote"><code class="literal">^[^,]*</code></span>”</p></div><p>
4768 A regular expression used by mutt to parse the GECOS field of a password
4769 entry when expanding the alias. The default value
4770 will return the string up to the first “<span class="quote">,</span>” encountered.
4771 If the GECOS field contains a string like “<span class="quote">lastname, firstname</span>” then you
4772 should set it to “<span class="quote"><code class="literal">.*</code></span>”.
4774 This can be useful if you see the following behavior: you address an e-mail
4775 to user ID “<span class="quote">stevef</span>” whose full name is “<span class="quote">Steve Franklin</span>”. If mutt expands
4776 “<span class="quote">stevef</span>” to “<span class="quote">"Franklin" stevef@foo.bar</span>” then you should set the <a class="link" href="#gecos-mask" title="3.76. gecos_mask">$gecos_mask</a> to
4777 a regular expression that will match the whole name so mutt will expand
4778 “<span class="quote">Franklin</span>” to “<span class="quote">Franklin, Steve</span>”.
4779 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4780 Default: yes</p></div><p>
4781 When <span class="emphasis"><em>unset</em></span>, the header fields normally added by the “<span class="quote"><a class="link" href="#my-hdr" title="15. User-Defined Headers">my_hdr</a></span>”
4782 command are not created. This variable <span class="emphasis"><em>must</em></span> be unset before
4783 composing a new message or replying in order to take effect. If <span class="emphasis"><em>set</em></span>,
4784 the user defined header fields are added to every new message.
4785 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4786 Default: no</p></div><p>
4787 When <span class="emphasis"><em>set</em></span>, this variable causes Mutt to include the header
4788 of the message you are replying to into the edit buffer.
4789 The <a class="link" href="#weed" title="3.305. weed">$weed</a> setting applies.
4790 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4791 Default: (empty)</p></div><p>
4792 This variable points to the header cache database.
4793 If pointing to a directory Mutt will contain a header cache
4794 database file per folder, if pointing to a file that file will
4795 be a single global header cache. By default it is <span class="emphasis"><em>unset</em></span> so no header
4796 caching will be used.
4798 Header caching can greatly improve speed when opening POP, IMAP
4799 MH or Maildir folders, see “<span class="quote"><a class="link" href="#caching" title="7. Local Caching">caching</a></span>” for details.
4800 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="header-cache-compress"></a>3.80. header_cache_compress</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4801 Default: yes</p></div><p>
4802 When mutt is compiled with qdbm or tokyocabinet as header cache backend,
4803 this option determines whether the database will be compressed.
4804 Compression results in database files roughly being one fifth
4805 of the usual diskspace, but the uncompression can result in a
4806 slower opening of cached folder(s) which in general is still
4807 much faster than opening non header cached folders.
4808 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="header-cache-pagesize"></a>3.81. header_cache_pagesize</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4809 Default: “<span class="quote"><code class="literal">16384</code></span>”</p></div><p>
4810 When mutt is compiled with either gdbm or bdb4 as the header cache backend,
4811 this option changes the database page size. Too large or too small
4812 values can waste space, memory, or CPU time. The default should be more
4813 or less optimal for most use cases.
4814 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4815 Default: yes</p></div><p>
4816 When <span class="emphasis"><em>set</em></span>, help lines describing the bindings for the major functions
4817 provided by each menu are displayed on the first line of the screen.
4819 <span class="bold"><strong>Note:</strong></span> The binding will not be displayed correctly if the
4820 function is bound to a sequence rather than a single keystroke. Also,
4821 the help line may not be updated if a binding is changed while Mutt is
4822 running. Since this variable is primarily aimed at new users, neither
4823 of these should present a major problem.
4824 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4825 Default: no</p></div><p>
4826 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
4827 when adding the domain part to addresses. This variable does not
4828 affect the generation of Message-IDs, and it will not lead to the
4829 cut-off of first-level domains.
4830 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4831 Default: no</p></div><p>
4832 When <span class="emphasis"><em>set</em></span>, mutt will not show the presence of messages that are hidden
4833 by limiting, in the thread tree.
4834 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4835 Default: yes</p></div><p>
4836 When <span class="emphasis"><em>set</em></span>, mutt will not show the presence of missing messages in the
4838 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="hide-thread-subject"></a>3.86. hide_thread_subject</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4839 Default: yes</p></div><p>
4840 When <span class="emphasis"><em>set</em></span>, mutt will not show the subject of messages in the thread
4841 tree that have the same subject as their parent or closest previously
4843 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="hide-top-limited"></a>3.87. hide_top_limited</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4844 Default: no</p></div><p>
4845 When <span class="emphasis"><em>set</em></span>, mutt will not show the presence of messages that are hidden
4846 by limiting, at the top of threads in the thread tree. Note that when
4847 <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.
4848 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="hide-top-missing"></a>3.88. hide_top_missing</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4849 Default: yes</p></div><p>
4850 When <span class="emphasis"><em>set</em></span>, mutt will not show the presence of missing messages at the
4851 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
4852 <span class="emphasis"><em>set</em></span>, this option will have no effect.
4853 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4854 Default: 10</p></div><p>
4855 This variable controls the size (in number of strings remembered) of
4856 the string history buffer per category. The buffer is cleared each time the
4858 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4859 Default: “<span class="quote"><code class="literal">˜/.mutthistory</code></span>”</p></div><p>
4860 The file in which Mutt will save its history.
4861 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4862 Default: no</p></div><p>
4863 When <span class="emphasis"><em>set</em></span>, Mutt will not display attachments with a
4864 disposition of “<span class="quote">attachment</span>” inline even if it could
4865 render the part to plain text. These MIME parts can only
4866 be viewed from the attachment menu.
4868 If <span class="emphasis"><em>unset</em></span>, Mutt will render all MIME parts it can
4869 properly transform to plain text.
4870 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="honor-followup-to"></a>3.92. honor_followup_to</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4871 Default: yes</p></div><p>
4872 This variable controls whether or not a Mail-Followup-To header is
4873 honored when group-replying to a message.
4874 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4875 Default: (empty)</p></div><p>
4876 Specifies the fully-qualified hostname of the system mutt is running on
4877 containing the host's name and the DNS domain it belongs to. It is used
4878 as the domain part (after “<span class="quote">@</span>”) for local email addresses as well as
4881 Its value is determined at startup as follows: If the node's name
4882 as returned by the <code class="literal">uname(3)</code> function contains the hostname and the
4883 domain, these are used to construct <a class="link" href="#hostname" title="3.93. hostname">$hostname</a>. If there is no
4884 domain part returned, Mutt will look for a “<span class="quote">domain</span>” or “<span class="quote">search</span>”
4885 line in <code class="literal">/etc/resolv.conf</code> to determine the domain. Optionally, Mutt
4886 can be compiled with a fixed domain name in which case a detected
4889 Also see <a class="link" href="#use-domain" title="3.297. use_domain">$use_domain</a> and <a class="link" href="#hidden-host" title="3.83. hidden_host">$hidden_host</a>.
4890 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ignore-linear-white-space"></a>3.94. ignore_linear_white_space</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4891 Default: no</p></div><p>
4892 This option replaces linear-white-space between encoded-word
4893 and text to a single space to prevent the display of MIME-encoded
4894 “<span class="quote">Subject:</span>” field from being divided into multiple lines.
4895 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ignore-list-reply-to"></a>3.95. ignore_list_reply_to</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4896 Default: no</p></div><p>
4897 Affects the behaviour of the <code class="literal"><reply></code> function when replying to
4898 messages from mailing lists (as defined by the “<span class="quote"><a class="link" href="#subscribe">subscribe</a></span>” or
4899 “<span class="quote"><a class="link" href="#lists" title="12. Mailing Lists">lists</a></span>” commands). When <span class="emphasis"><em>set</em></span>, if the “<span class="quote">Reply-To:</span>” field is
4900 set to the same value as the “<span class="quote">To:</span>” field, Mutt assumes that the
4901 “<span class="quote">Reply-To:</span>” field was set by the mailing list to automate responses
4902 to the list, and will ignore this field. To direct a response to the
4903 mailing list when this option is <span class="emphasis"><em>set</em></span>, use the <code class="literal"><a class="link" href="#list-reply"><list-reply></a></code>
4904 function; <code class="literal"><group-reply></code> will reply to both the sender and the
4906 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4907 Default: (empty)</p></div><p>
4908 This is a colon-delimited list of authentication methods mutt may
4909 attempt to use to log in to an IMAP server, in the order mutt should
4910 try them. Authentication methods are either “<span class="quote">login</span>” or the right
4911 side of an IMAP “<span class="quote">AUTH=xxx</span>” capability string, eg “<span class="quote">digest-md5</span>”, “<span class="quote">gssapi</span>”
4912 or “<span class="quote">cram-md5</span>”. This option is case-insensitive. If it's
4913 <span class="emphasis"><em>unset</em></span> (the default) mutt will try all available methods,
4914 in order from most-secure to least-secure.
4918 </p><pre class="screen">
4919 set imap_authenticators="gssapi:cram-md5:login"
4921 <span class="bold"><strong>Note:</strong></span> Mutt will only fall back to other authentication methods if
4922 the previous methods are unavailable. If a method is available but
4923 authentication fails, mutt will not connect to the IMAP server.
4924 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-check-subscribed"></a>3.97. imap_check_subscribed</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4925 Default: no</p></div><p>
4926 When <span class="emphasis"><em>set</em></span>, mutt will fetch the set of subscribed folders from
4927 your server on connection, and add them to the set of mailboxes
4928 it polls for new mail just as if you had issued individual “<span class="quote"><a class="link" href="#mailboxes" title="14. Monitoring Incoming Mail">mailboxes</a></span>”
4930 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-delim-chars"></a>3.98. imap_delim_chars</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4931 Default: “<span class="quote"><code class="literal">/.</code></span>”</p></div><p>
4932 This contains the list of characters which you would like to treat
4933 as folder separators for displaying IMAP paths. In particular it
4934 helps in using the “<span class="quote">=</span>” shortcut for your <span class="emphasis"><em>folder</em></span> variable.
4935 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4936 Default: (empty)</p></div><p>
4937 Mutt requests these header fields in addition to the default headers
4938 (“<span class="quote">Date:</span>”, “<span class="quote">From:</span>”, “<span class="quote">Subject:</span>”, “<span class="quote">To:</span>”, “<span class="quote">Cc:</span>”, “<span class="quote">Message-Id:</span>”,
4939 “<span class="quote">References:</span>”, “<span class="quote">Content-Type:</span>”, “<span class="quote">Content-Description:</span>”, “<span class="quote">In-Reply-To:</span>”,
4940 “<span class="quote">Reply-To:</span>”, “<span class="quote">Lines:</span>”, “<span class="quote">List-Post:</span>”, “<span class="quote">X-Label:</span>”) from IMAP
4941 servers before displaying the index menu. You may want to add more
4942 headers for spam detection.
4944 <span class="bold"><strong>Note:</strong></span> This is a space separated list, items should be uppercase
4945 and not contain the colon, e.g. “<span class="quote">X-BOGOSITY X-SPAM-STATUS</span>” for the
4946 “<span class="quote">X-Bogosity:</span>” and “<span class="quote">X-Spam-Status:</span>” header fields.
4947 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4948 Default: no</p></div><p>
4949 When <span class="emphasis"><em>set</em></span>, mutt will attempt to use the IMAP IDLE extension
4950 to check for new mail in the current mailbox. Some servers
4951 (dovecot was the inspiration for this option) react badly
4952 to mutt's implementation. If your connection seems to freeze
4953 up periodically, try unsetting this.
4954 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4955 Default: 900</p></div><p>
4956 This variable specifies the maximum amount of time in seconds that mutt
4957 will wait before polling open IMAP connections, to prevent the server
4958 from closing them before mutt has finished with them. The default is
4959 well within the RFC-specified minimum amount of time (30 minutes) before
4960 a server is allowed to do this, but in practice the RFC does get
4961 violated every now and then. Reduce this number if you find yourself
4962 getting disconnected from your IMAP server due to inactivity.
4963 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-list-subscribed"></a>3.102. imap_list_subscribed</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4964 Default: no</p></div><p>
4965 This variable configures whether IMAP folder browsing will look for
4966 only subscribed folders or all folders. This can be toggled in the
4967 IMAP browser with the <code class="literal"><toggle-subscribed></code> function.
4968 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4969 Default: (empty)</p></div><p>
4970 Your login name on the IMAP server.
4972 This variable defaults to the value of <a class="link" href="#imap-user" title="3.109. imap_user">$imap_user</a>.
4973 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4974 Default: (empty)</p></div><p>
4975 Specifies the password for your IMAP account. If <span class="emphasis"><em>unset</em></span>, Mutt will
4976 prompt you for your password when you invoke the <code class="literal"><imap-fetch-mail></code> function
4977 or try to open an IMAP folder.
4979 <span class="bold"><strong>Warning</strong></span>: you should only use this option when you are on a
4980 fairly secure machine, because the superuser can read your muttrc even
4981 if you are the only one who can read the file.
4982 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4983 Default: yes</p></div><p>
4984 When <span class="emphasis"><em>set</em></span>, mutt will not open new IMAP connections to check for new
4985 mail. Mutt will only check for new mail over existing IMAP
4986 connections. This is useful if you don't want to be prompted to
4987 user/password pairs on mutt invocation, or if opening the connection
4989 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
4990 Default: yes</p></div><p>
4991 When <span class="emphasis"><em>set</em></span>, mutt will avoid implicitly marking your mail as read whenever
4992 you fetch a message from the server. This is generally a good thing,
4993 but can make closing an IMAP folder somewhat slower. This option
4994 exists to appease speed freaks.
4995 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-pipeline-depth"></a>3.107. imap_pipeline_depth</h3></div></div></div><div class="literallayout"><p>Type: number<br />
4996 Default: 15</p></div><p>
4997 Controls the number of IMAP commands that may be queued up before they
4998 are sent to the server. A deeper pipeline reduces the amount of time
4999 mutt must wait for the server, and can make IMAP servers feel much
5000 more responsive. But not all servers correctly handle pipelined commands,
5001 so if you have problems you might want to try setting this variable to 0.
5003 <span class="bold"><strong>Note:</strong></span> Changes to this variable have no effect on open connections.
5004 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
5005 Default: yes</p></div><p>
5006 When <span class="emphasis"><em>set</em></span>, mutt will display warning messages from the IMAP
5007 server as error messages. Since these messages are often
5008 harmless, or generated due to configuration problems on the
5009 server which are out of the users' hands, you may wish to suppress
5011 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
5012 Default: (empty)</p></div><p>
5013 The name of the user whose mail you intend to access on the IMAP
5016 This variable defaults to your user name on the local machine.
5017 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
5018 Default: no</p></div><p>
5019 If set to “<span class="quote">yes</span>”, mutt will look for a mailcap entry with the
5020 “<span class="quote"><code class="literal">copiousoutput</code></span>” flag set for <span class="emphasis"><em>every</em></span> MIME attachment it doesn't have
5021 an internal viewer defined for. If such an entry is found, mutt will
5022 use the viewer defined in that entry to convert the body part to text
5024 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
5025 Default: ask-yes</p></div><p>
5026 Controls whether or not a copy of the message(s) you are replying to
5027 is included in your reply.
5028 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
5029 Default: no</p></div><p>
5030 Controls whether or not Mutt includes only the first attachment
5031 of the message you are replying.
5032 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
5033 Default: “<span class="quote"><code class="literal">> </code></span>”</p></div><p>
5034 Specifies the string to prepend to each line of text quoted in a
5035 message to which you are replying. You are strongly encouraged not to
5036 change this value, as it tends to agitate the more fanatical netizens.
5038 The value of this option is ignored if <a class="link" href="#text-flowed" title="3.286. text_flowed">$text_flowed</a> is set, too because
5039 the quoting mechanism is strictly defined for format=flowed.
5041 This option is a format string, please see the description of
5042 <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> for supported <code class="literal">printf(3)</code>-style sequences.
5043 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
5044 Default: “<span class="quote"><code class="literal">%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s</code></span>”</p></div><p>
5045 This variable allows you to customize the message index display to
5046 your personal taste.
5048 “<span class="quote">Format strings</span>” are similar to the strings used in the C
5049 function <code class="literal">printf(3)</code> to format output (see the man page for more details).
5050 The following sequences are defined in Mutt:
5052 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>%a </td><td>address of the author
5053 </td></tr><tr><td>%A </td><td>reply-to address (if present; otherwise: address of author)
5054 </td></tr><tr><td>%b </td><td>filename of the original message folder (think mailbox)
5055 </td></tr><tr><td>%B </td><td>the list to which the letter was sent, or else the folder name (%b).
5056 </td></tr><tr><td>%c </td><td>number of characters (bytes) in the message
5057 </td></tr><tr><td>%C </td><td>current message number
5058 </td></tr><tr><td>%d </td><td>date and time of the message in the format specified by
5059 <a class="link" href="#date-format" title="3.47. date_format">$date_format</a> converted to sender's time zone
5060 </td></tr><tr><td>%D </td><td>date and time of the message in the format specified by
5061 <a class="link" href="#date-format" title="3.47. date_format">$date_format</a> converted to the local time zone
5062 </td></tr><tr><td>%e </td><td>current message number in thread
5063 </td></tr><tr><td>%E </td><td>number of messages in current thread
5064 </td></tr><tr><td>%f </td><td>sender (address + real name), either From: or Return-Path:
5065 </td></tr><tr><td>%F </td><td>author name, or recipient name if the message is from you
5066 </td></tr><tr><td>%H </td><td>spam attribute(s) of this message
5067 </td></tr><tr><td>%i </td><td>message-id of the current message
5068 </td></tr><tr><td>%l </td><td>number of lines in the message (does not work with maildir,
5069 mh, and possibly IMAP folders)
5070 </td></tr><tr><td>%L </td><td>If an address in the “<span class="quote">To:</span>” or “<span class="quote">Cc:</span>” header field matches an address
5071 defined by the users “<span class="quote"><a class="link" href="#subscribe">subscribe</a></span>” command, this displays
5072 "To <list-name>", otherwise the same as %F.
5073 </td></tr><tr><td>%m </td><td>total number of message in the mailbox
5074 </td></tr><tr><td>%M </td><td>number of hidden messages if the thread is collapsed.
5075 </td></tr><tr><td>%N </td><td>message score
5076 </td></tr><tr><td>%n </td><td>author's real name (or address if missing)
5077 </td></tr><tr><td>%O </td><td>original save folder where mutt would formerly have
5078 stashed the message: list name or recipient name
5079 if not sent to a list
5080 </td></tr><tr><td>%P </td><td>progress indicator for the builtin pager (how much of the file has been displayed)
5081 </td></tr><tr><td>%s </td><td>subject of the message
5082 </td></tr><tr><td>%S </td><td>status of the message (“<span class="quote">N</span>”/“<span class="quote">D</span>”/“<span class="quote">d</span>”/“<span class="quote">!</span>”/“<span class="quote">r</span>”/*)
5083 </td></tr><tr><td>%t </td><td>“<span class="quote">To:</span>” field (recipients)
5084 </td></tr><tr><td>%T </td><td>the appropriate character from the <a class="link" href="#to-chars" title="3.293. to_chars">$to_chars</a> string
5085 </td></tr><tr><td>%u </td><td>user (login) name of the author
5086 </td></tr><tr><td>%v </td><td>first name of the author, or the recipient if the message is from you
5087 </td></tr><tr><td>%X </td><td>number of attachments
5088 (please see the “<span class="quote"><a class="link" href="#attachments" title="6. Attachment Searching and Counting">attachments</a></span>” section for possible speed effects)
5089 </td></tr><tr><td>%y </td><td>“<span class="quote">X-Label:</span>” field, if present
5090 </td></tr><tr><td>%Y </td><td>“<span class="quote">X-Label:</span>” field, if present, and <span class="emphasis"><em>(1)</em></span> not at part of a thread tree,
5091 <span class="emphasis"><em>(2)</em></span> at the top of a thread, or <span class="emphasis"><em>(3)</em></span> “<span class="quote">X-Label:</span>” is different from
5092 preceding message's “<span class="quote">X-Label:</span>”.
5093 </td></tr><tr><td>%Z </td><td>message status flags
5094 </td></tr><tr><td>%{fmt} </td><td>the date and time of the message is converted to sender's
5095 time zone, and “<span class="quote">fmt</span>” is expanded by the library function
5096 <code class="literal">strftime(3)</code>; a leading bang disables locales
5097 </td></tr><tr><td>%[fmt] </td><td>the date and time of the message is converted to the local
5098 time zone, and “<span class="quote">fmt</span>” is expanded by the library function
5099 <code class="literal">strftime(3)</code>; a leading bang disables locales
5100 </td></tr><tr><td>%(fmt) </td><td>the local date and time when the message was received.
5101 “<span class="quote">fmt</span>” is expanded by the library function <code class="literal">strftime(3)</code>;
5102 a leading bang disables locales
5103 </td></tr><tr><td>%<fmt> </td><td>the current local time. “<span class="quote">fmt</span>” is expanded by the library
5104 function <code class="literal">strftime(3)</code>; a leading bang disables locales.
5105 </td></tr><tr><td>%>X </td><td>right justify the rest of the string and pad with character “<span class="quote">X</span>”
5106 </td></tr><tr><td>%|X </td><td>pad to the end of the line with character “<span class="quote">X</span>”
5107 </td></tr><tr><td>%*X </td><td>soft-fill with character “<span class="quote">X</span>” as pad
5108 </td></tr></tbody></table></div><p>
5109 “<span class="quote">Soft-fill</span>” deserves some explanation: Normal right-justification
5110 will print everything to the left of the “<span class="quote">%></span>”, displaying padding and
5111 whatever lies to the right only if there's room. By contrast,
5112 soft-fill gives priority to the right-hand side, guaranteeing space
5113 to display it and showing padding only if there's still room. If
5114 necessary, soft-fill will eat text leftwards to make room for
5117 Note that these expandos are supported in
5118 “<span class="quote"><a class="link" href="#save-hook" title="16. Specify Default Save Mailbox">save-hook</a></span>”, “<span class="quote"><a class="link" href="#fcc-hook" title="17. Specify Default Fcc: Mailbox When Composing">fcc-hook</a></span>” and “<span class="quote"><a class="link" href="#fcc-save-hook" title="18. Specify Default Save Filename and Default Fcc: Mailbox at Once">fcc-save-hook</a></span>”, too.
5119 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
5120 Default: “<span class="quote"><code class="literal">ispell</code></span>”</p></div><p>
5121 How to invoke ispell (GNU's spell-checking software).
5122 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
5123 Default: no</p></div><p>
5124 If <span class="emphasis"><em>set</em></span>, read messages marked as flagged will not be moved
5125 from your spool mailbox to your <a class="link" href="#mbox" title="3.126. mbox">$mbox</a> mailbox, or as a result of
5126 a “<span class="quote"><a class="link" href="#mbox-hook" title="13. Using Multiple Spool Mailboxes">mbox-hook</a></span>” command.
5127 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
5128 Default: “<span class="quote"><code class="literal">C</code></span>”</p></div><p>
5129 The locale used by <code class="literal">strftime(3)</code> to format dates. Legal values are
5130 the strings your system accepts for the locale environment variable <code class="literal">$LC_TIME</code>.
5131 </p></div><div class="sect2" lang="en" xml:lang="en"><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 />
5132 Default: 5</p></div><p>
5133 This variable configures how often (in seconds) mutt should look for
5134 new mail. Also see the <a class="link" href="#timeout" title="3.291. timeout">$timeout</a> variable.
5135 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mailcap-path"></a>3.119. mailcap_path</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5136 Default: (empty)</p></div><p>
5137 This variable specifies which files to consult when attempting to
5138 display MIME bodies not directly supported by Mutt.
5139 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mailcap-sanitize"></a>3.120. mailcap_sanitize</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5140 Default: yes</p></div><p>
5141 If <span class="emphasis"><em>set</em></span>, mutt will restrict possible characters in mailcap % expandos
5142 to a well-defined set of safe characters. This is the safe setting,
5143 but we are not sure it doesn't break some more advanced MIME stuff.
5145 <span class="bold"><strong>DON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE
5146 DOING!</strong></span>
5147 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="maildir-header-cache-verify"></a>3.121. maildir_header_cache_verify</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5148 Default: yes</p></div><p>
5149 Check for Maildir unaware programs other than mutt having modified maildir
5150 files when the header cache is in use. This incurs one <code class="literal">stat(2)</code> per
5151 message every time the folder is opened (which can be very slow for NFS
5153 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="maildir-trash"></a>3.122. maildir_trash</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5154 Default: no</p></div><p>
5155 If <span class="emphasis"><em>set</em></span>, messages marked as deleted will be saved with the maildir
5156 trashed flag instead of unlinked. <span class="bold"><strong>Note:</strong></span> this only applies
5157 to maildir-style mailboxes. Setting it will have no effect on other
5159 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mark-old"></a>3.123. mark_old</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5160 Default: yes</p></div><p>
5161 Controls whether or not mutt marks <span class="emphasis"><em>new</em></span> <span class="bold"><strong>unread</strong></span>
5162 messages as <span class="emphasis"><em>old</em></span> if you exit a mailbox without reading them.
5163 With this option <span class="emphasis"><em>set</em></span>, the next time you start mutt, the messages
5164 will show up with an “<span class="quote">O</span>” next to them in the index menu,
5165 indicating that they are old.
5166 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="markers"></a>3.124. markers</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5167 Default: yes</p></div><p>
5168 Controls the display of wrapped lines in the internal pager. If set, a
5169 “<span class="quote">+</span>” marker is displayed at the beginning of wrapped lines.
5171 Also see the <a class="link" href="#smart-wrap" title="3.238. smart_wrap">$smart_wrap</a> variable.
5172 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mask"></a>3.125. mask</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
5173 Default: “<span class="quote"><code class="literal">!^\.[^.]</code></span>”</p></div><p>
5174 A regular expression used in the file browser, optionally preceded by
5175 the <span class="emphasis"><em>not</em></span> operator “<span class="quote">!</span>”. Only files whose names match this mask
5176 will be shown. The match is always case-sensitive.
5177 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mbox"></a>3.126. mbox</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5178 Default: “<span class="quote"><code class="literal">˜/mbox</code></span>”</p></div><p>
5179 This specifies the folder into which read mail in your <a class="link" href="#spoolfile" title="3.269. spoolfile">$spoolfile</a>
5180 folder will be appended.
5182 Also see the <a class="link" href="#move" title="3.145. move">$move</a> variable.
5183 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mbox-type"></a>3.127. mbox_type</h3></div></div></div><div class="literallayout"><p>Type: folder magic<br />
5184 Default: mbox</p></div><p>
5185 The default mailbox type used when creating new folders. May be any of
5186 “<span class="quote">mbox</span>”, “<span class="quote">MMDF</span>”, “<span class="quote">MH</span>” and “<span class="quote">Maildir</span>”. This is overriden by the
5187 <code class="literal">-m</code> command-line option.
5188 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="menu-context"></a>3.128. menu_context</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5189 Default: 0</p></div><p>
5190 This variable controls the number of lines of context that are given
5191 when scrolling through menus. (Similar to <a class="link" href="#pager-context" title="3.149. pager_context">$pager_context</a>.)
5192 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="menu-move-off"></a>3.129. menu_move_off</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5193 Default: yes</p></div><p>
5194 When <span class="emphasis"><em>unset</em></span>, the bottom entry of menus will never scroll up past
5195 the bottom of the screen, unless there are less entries than lines.
5196 When <span class="emphasis"><em>set</em></span>, the bottom entry may move off the bottom.
5197 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="menu-scroll"></a>3.130. menu_scroll</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5198 Default: no</p></div><p>
5199 When <span class="emphasis"><em>set</em></span>, menus will be scrolled up or down one line when you
5200 attempt to move across a screen boundary. If <span class="emphasis"><em>unset</em></span>, the screen
5201 is cleared and the next or previous page of the menu is displayed
5202 (useful for slow links to avoid many redraws).
5203 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="message-cache-clean"></a>3.131. message_cache_clean</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5204 Default: no</p></div><p>
5205 If <span class="emphasis"><em>set</em></span>, mutt will clean out obsolete entries from the message cache when
5206 the mailbox is synchronized. You probably only want to set it
5207 every once in a while, since it can be a little slow
5208 (especially for large folders).
5209 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="message-cachedir"></a>3.132. message_cachedir</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5210 Default: (empty)</p></div><p>
5211 Set this to a directory and mutt will cache copies of messages from
5212 your IMAP and POP servers here. You are free to remove entries at any
5215 When setting this variable to a directory, mutt needs to fetch every
5216 remote message only once and can perform regular expression searches
5217 as fast as for local folders.
5219 Also see the <a class="link" href="#message-cache-clean" title="3.131. message_cache_clean">$message_cache_clean</a> variable.
5220 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="message-format"></a>3.133. message_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5221 Default: “<span class="quote"><code class="literal">%s</code></span>”</p></div><p>
5222 This is the string displayed in the “<span class="quote">attachment</span>” menu for
5223 attachments of type <code class="literal">message/rfc822</code>. For a full listing of defined
5224 <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>.
5225 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="meta-key"></a>3.134. meta_key</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5226 Default: no</p></div><p>
5227 If <span class="emphasis"><em>set</em></span>, forces Mutt to interpret keystrokes with the high bit (bit 8)
5228 set as if the user had pressed the Esc key and whatever key remains
5229 after having the high bit removed. For example, if the key pressed
5230 has an ASCII value of <code class="literal">0xf8</code>, then this is treated as if the user had
5231 pressed Esc then “<span class="quote">x</span>”. This is because the result of removing the
5232 high bit from <code class="literal">0xf8</code> is <code class="literal">0x78</code>, which is the ASCII character
5233 “<span class="quote">x</span>”.
5234 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="metoo"></a>3.135. metoo</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5235 Default: no</p></div><p>
5236 If <span class="emphasis"><em>unset</em></span>, Mutt will remove your address (see the “<span class="quote"><a class="link" href="#alternates" title="11. Alternative Addresses">alternates</a></span>”
5237 command) from the list of recipients when replying to a message.
5238 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mh-purge"></a>3.136. mh_purge</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5239 Default: no</p></div><p>
5240 When <span class="emphasis"><em>unset</em></span>, mutt will mimic mh's behaviour and rename deleted messages
5241 to <span class="emphasis"><em>,<old file name></em></span> in mh folders instead of really deleting
5242 them. This leaves the message on disk but makes programs reading the folder
5243 ignore it. If the variable is <span class="emphasis"><em>set</em></span>, the message files will simply be
5246 This option is similar to <a class="link" href="#maildir-trash" title="3.122. maildir_trash">$maildir_trash</a> for Maildir folders.
5247 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mh-seq-flagged"></a>3.137. mh_seq_flagged</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5248 Default: “<span class="quote"><code class="literal">flagged</code></span>”</p></div><p>
5249 The name of the MH sequence used for flagged messages.
5250 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mh-seq-replied"></a>3.138. mh_seq_replied</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5251 Default: “<span class="quote"><code class="literal">replied</code></span>”</p></div><p>
5252 The name of the MH sequence used to tag replied messages.
5253 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mh-seq-unseen"></a>3.139. mh_seq_unseen</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5254 Default: “<span class="quote"><code class="literal">unseen</code></span>”</p></div><p>
5255 The name of the MH sequence used for unseen messages.
5256 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mime-forward"></a>3.140. mime_forward</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5257 Default: no</p></div><p>
5258 When <span class="emphasis"><em>set</em></span>, the message you are forwarding will be attached as a
5259 separate <code class="literal">message/rfc822</code> MIME part instead of included in the main body of the
5260 message. This is useful for forwarding MIME messages so the receiver
5261 can properly view the message as it was delivered to you. If you like
5262 to switch between MIME and not MIME from mail to mail, set this
5263 variable to “<span class="quote">ask-no</span>” or “<span class="quote">ask-yes</span>”.
5265 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.141. mime_forward_decode">$mime_forward_decode</a>.
5266 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mime-forward-decode"></a>3.141. mime_forward_decode</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5267 Default: no</p></div><p>
5268 Controls the decoding of complex MIME messages into <code class="literal">text/plain</code> when
5269 forwarding a message while <a class="link" href="#mime-forward" title="3.140. mime_forward">$mime_forward</a> is <span class="emphasis"><em>set</em></span>. Otherwise
5270 <a class="link" href="#forward-decode" title="3.70. forward_decode">$forward_decode</a> is used instead.
5271 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mime-forward-rest"></a>3.142. mime_forward_rest</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5272 Default: yes</p></div><p>
5273 When forwarding multiple attachments of a MIME message from the attachment
5274 menu, attachments which cannot be decoded in a reasonable manner will
5275 be attached to the newly composed message if this option is <span class="emphasis"><em>set</em></span>.
5276 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mix-entry-format"></a>3.143. mix_entry_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5277 Default: “<span class="quote"><code class="literal">%4n %c %-16s %a</code></span>”</p></div><p>
5278 This variable describes the format of a remailer line on the mixmaster
5279 chain selection screen. The following <code class="literal">printf(3)</code>-like sequences are
5282 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>%n </td><td>The running number on the menu.
5283 </td></tr><tr><td>%c </td><td>Remailer capabilities.
5284 </td></tr><tr><td>%s </td><td>The remailer's short name.
5285 </td></tr><tr><td>%a </td><td>The remailer's e-mail address.
5286 </td></tr></tbody></table></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mixmaster"></a>3.144. mixmaster</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5287 Default: “<span class="quote"><code class="literal">mixmaster</code></span>”</p></div><p>
5288 This variable contains the path to the Mixmaster binary on your
5289 system. It is used with various sets of parameters to gather the
5290 list of known remailers, and to finally send a message through the
5292 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="move"></a>3.145. move</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5293 Default: no</p></div><p>
5294 Controls whether or not Mutt will move read messages
5295 from your spool mailbox to your <a class="link" href="#mbox" title="3.126. mbox">$mbox</a> mailbox, or as a result of
5296 a “<span class="quote"><a class="link" href="#mbox-hook" title="13. Using Multiple Spool Mailboxes">mbox-hook</a></span>” command.
5297 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="narrow-tree"></a>3.146. narrow_tree</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5298 Default: no</p></div><p>
5299 This variable, when <span class="emphasis"><em>set</em></span>, makes the thread tree narrower, allowing
5300 deeper threads to fit on the screen.
5301 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="net-inc"></a>3.147. net_inc</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5302 Default: 10</p></div><p>
5303 Operations that expect to transfer a large amount of data over the
5304 network will update their progress every <a class="link" href="#net-inc" title="3.147. net_inc">$net_inc</a> kilobytes.
5305 If set to 0, no progress messages will be displayed.
5307 See also <a class="link" href="#read-inc" title="3.207. read_inc">$read_inc</a>, <a class="link" href="#write-inc" title="3.310. write_inc">$write_inc</a> and <a class="link" href="#net-inc" title="3.147. net_inc">$net_inc</a>.
5308 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pager"></a>3.148. pager</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5309 Default: “<span class="quote"><code class="literal">builtin</code></span>”</p></div><p>
5310 This variable specifies which pager you would like to use to view
5311 messages. The value “<span class="quote">builtin</span>” means to use the builtin pager, otherwise this
5312 variable should specify the pathname of the external pager you would
5315 Using an external pager may have some disadvantages: Additional
5316 keystrokes are necessary because you can't call mutt functions
5317 directly from the pager, and screen resizes cause lines longer than
5318 the screen width to be badly formatted in the help menu.
5319 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pager-context"></a>3.149. pager_context</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5320 Default: 0</p></div><p>
5321 This variable controls the number of lines of context that are given
5322 when displaying the next or previous page in the internal pager. By
5323 default, Mutt will display the line after the last one on the screen
5324 at the top of the next page (0 lines of context).
5326 This variable also specifies the amount of context given for search
5327 results. If positive, this many lines will be given before a match,
5328 if 0, the match will be top-aligned.
5329 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pager-format"></a>3.150. pager_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5330 Default: “<span class="quote"><code class="literal">-%Z- %C/%m: %-20.20n %s%* -- (%P)</code></span>”</p></div><p>
5331 This variable controls the format of the one-line message “<span class="quote">status</span>”
5332 displayed before each message in either the internal or an external
5333 pager. The valid sequences are listed in the <a class="link" href="#index-format" title="3.114. index_format">$index_format</a>
5335 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pager-index-lines"></a>3.151. pager_index_lines</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5336 Default: 0</p></div><p>
5337 Determines the number of lines of a mini-index which is shown when in
5338 the pager. The current message, unless near the top or bottom of the
5339 folder, will be roughly one third of the way down this mini-index,
5340 giving the reader the context of a few messages before and after the
5341 message. This is useful, for example, to determine how many messages
5342 remain to be read in the current thread. One of the lines is reserved
5343 for the status bar from the index, so a setting of 6
5344 will only show 5 lines of the actual index. A value of 0 results in
5345 no index being shown. If the number of messages in the current folder
5346 is less than <a class="link" href="#pager-index-lines" title="3.151. pager_index_lines">$pager_index_lines</a>, then the index will only use as
5347 many lines as it needs.
5348 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pager-stop"></a>3.152. pager_stop</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5349 Default: no</p></div><p>
5350 When <span class="emphasis"><em>set</em></span>, the internal-pager will <span class="bold"><strong>not</strong></span> move to the next message
5351 when you are at the end of a message and invoke the <code class="literal"><next-page></code>
5353 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-auto-decode"></a>3.153. pgp_auto_decode</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5354 Default: no</p></div><p>
5355 If <span class="emphasis"><em>set</em></span>, mutt will automatically attempt to decrypt traditional PGP
5356 messages whenever the user performs an operation which ordinarily would
5357 result in the contents of the message being operated on. For example,
5358 if the user displays a pgp-traditional message which has not been manually
5359 checked with the <code class="literal"><a class="link" href="#check-traditional-pgp"><check-traditional-pgp></a></code> function, mutt will automatically
5360 check the message for traditional pgp.
5361 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-autoinline"></a>3.154. pgp_autoinline</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5362 Default: no</p></div><p>
5363 This option controls whether Mutt generates old-style inline
5364 (traditional) PGP encrypted or signed messages under certain
5365 circumstances. This can be overridden by use of the pgp menu,
5366 when inline is not required.
5368 Note that Mutt might automatically use PGP/MIME for messages
5369 which consist of more than a single MIME part. Mutt can be
5370 configured to ask before sending PGP/MIME messages when inline
5371 (traditional) would not work.
5373 Also see the <a class="link" href="#pgp-mime-auto" title="3.170. pgp_mime_auto">$pgp_mime_auto</a> variable.
5375 Also note that using the old-style PGP message format is <span class="bold"><strong>strongly</strong></span>
5376 <span class="bold"><strong>deprecated</strong></span>.
5378 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-check-exit"></a>3.155. pgp_check_exit</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5379 Default: yes</p></div><p>
5380 If <span class="emphasis"><em>set</em></span>, mutt will check the exit code of the PGP subprocess when
5381 signing or encrypting. A non-zero exit code means that the
5384 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-clearsign-command"></a>3.156. pgp_clearsign_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5385 Default: (empty)</p></div><p>
5386 This format is used to create an old-style “<span class="quote">clearsigned</span>” PGP
5387 message. Note that the use of this format is <span class="bold"><strong>strongly</strong></span>
5388 <span class="bold"><strong>deprecated</strong></span>.
5390 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.157. pgp_decode_command">$pgp_decode_command</a> command for
5391 possible <code class="literal">printf(3)</code>-like sequences.
5393 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-decode-command"></a>3.157. pgp_decode_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5394 Default: (empty)</p></div><p>
5395 This format strings specifies a command which is used to decode
5396 application/pgp attachments.
5398 The PGP command formats have their own set of <code class="literal">printf(3)</code>-like sequences:
5400 </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
5401 string otherwise. Note: This may be used with a %? construct.
5402 </td></tr><tr><td>%f </td><td>Expands to the name of a file containing a message.
5403 </td></tr><tr><td>%s </td><td>Expands to the name of a file containing the signature part
5404 of a <code class="literal">multipart/signed</code> attachment when verifying it.
5405 </td></tr><tr><td>%a </td><td>The value of <a class="link" href="#pgp-sign-as" title="3.174. pgp_sign_as">$pgp_sign_as</a>.
5406 </td></tr><tr><td>%r </td><td>One or more key IDs.
5407 </td></tr></tbody></table></div><p>
5408 For examples on how to configure these formats for the various versions
5409 of PGP which are floating around, see the pgp and gpg sample configuration files in
5410 the <code class="literal">samples/</code> subdirectory which has been installed on your system
5411 alongside the documentation.
5413 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-decrypt-command"></a>3.158. pgp_decrypt_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5414 Default: (empty)</p></div><p>
5415 This command is used to decrypt a PGP encrypted message.
5417 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.157. pgp_decode_command">$pgp_decode_command</a> command for
5418 possible <code class="literal">printf(3)</code>-like sequences.
5420 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-encrypt-only-command"></a>3.159. pgp_encrypt_only_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5421 Default: (empty)</p></div><p>
5422 This command is used to encrypt a body part without signing it.
5424 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.157. pgp_decode_command">$pgp_decode_command</a> command for
5425 possible <code class="literal">printf(3)</code>-like sequences.
5427 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-encrypt-sign-command"></a>3.160. pgp_encrypt_sign_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5428 Default: (empty)</p></div><p>
5429 This command is used to both sign and encrypt a body part.
5431 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.157. pgp_decode_command">$pgp_decode_command</a> command for
5432 possible <code class="literal">printf(3)</code>-like sequences.
5434 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-entry-format"></a>3.161. pgp_entry_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5435 Default: “<span class="quote"><code class="literal">%4n %t%f %4l/0x%k %-4a %2c %u</code></span>”</p></div><p>
5436 This variable allows you to customize the PGP key selection menu to
5437 your personal taste. This string is similar to <a class="link" href="#index-format" title="3.114. index_format">$index_format</a>, but
5438 has its own set of <code class="literal">printf(3)</code>-like sequences:
5440 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>%n </td><td>number
5441 </td></tr><tr><td>%k </td><td>key id
5442 </td></tr><tr><td>%u </td><td>user id
5443 </td></tr><tr><td>%a </td><td>algorithm
5444 </td></tr><tr><td>%l </td><td>key length
5445 </td></tr><tr><td>%f </td><td>flags
5446 </td></tr><tr><td>%c </td><td>capabilities
5447 </td></tr><tr><td>%t </td><td>trust/validity of the key-uid association
5448 </td></tr><tr><td>%[<s>] </td><td>date of the key where <s> is an <code class="literal">strftime(3)</code> expression
5449 </td></tr></tbody></table></div><p>
5451 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-export-command"></a>3.162. pgp_export_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5452 Default: (empty)</p></div><p>
5453 This command is used to export a public key from the user's
5456 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.157. pgp_decode_command">$pgp_decode_command</a> command for
5457 possible <code class="literal">printf(3)</code>-like sequences.
5459 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-getkeys-command"></a>3.163. pgp_getkeys_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5460 Default: (empty)</p></div><p>
5461 This command is invoked whenever mutt will need public key information.
5462 Of the sequences supported by <a class="link" href="#pgp-decode-command" title="3.157. pgp_decode_command">$pgp_decode_command</a>, %r is the only
5463 <code class="literal">printf(3)</code>-like sequence used with this format.
5465 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-good-sign"></a>3.164. pgp_good_sign</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
5466 Default: (empty)</p></div><p>
5467 If you assign a text to this variable, then a PGP signature is only
5468 considered verified if the output from <a class="link" href="#pgp-verify-command" title="3.180. pgp_verify_command">$pgp_verify_command</a> contains
5469 the text. Use this variable if the exit code from the command is 0
5470 even for bad signatures.
5472 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-ignore-subkeys"></a>3.165. pgp_ignore_subkeys</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5473 Default: yes</p></div><p>
5474 Setting this variable will cause Mutt to ignore OpenPGP subkeys. Instead,
5475 the principal key will inherit the subkeys' capabilities. <span class="emphasis"><em>Unset</em></span> this
5476 if you want to play interesting key selection games.
5478 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-import-command"></a>3.166. pgp_import_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5479 Default: (empty)</p></div><p>
5480 This command is used to import a key from a message into
5481 the user's public key ring.
5483 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.157. pgp_decode_command">$pgp_decode_command</a> command for
5484 possible <code class="literal">printf(3)</code>-like sequences.
5486 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-list-pubring-command"></a>3.167. pgp_list_pubring_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5487 Default: (empty)</p></div><p>
5488 This command is used to list the public key ring's contents. The
5489 output format must be analogous to the one used by
5491 </p><pre class="screen">
5492 gpg --list-keys --with-colons.
5494 This format is also generated by the <code class="literal">pgpring</code> utility which comes
5497 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.157. pgp_decode_command">$pgp_decode_command</a> command for
5498 possible <code class="literal">printf(3)</code>-like sequences.
5500 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-list-secring-command"></a>3.168. pgp_list_secring_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5501 Default: (empty)</p></div><p>
5502 This command is used to list the secret key ring's contents. The
5503 output format must be analogous to the one used by:
5505 </p><pre class="screen">
5506 gpg --list-keys --with-colons.
5508 This format is also generated by the <code class="literal">pgpring</code> utility which comes
5511 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.157. pgp_decode_command">$pgp_decode_command</a> command for
5512 possible <code class="literal">printf(3)</code>-like sequences.
5514 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-long-ids"></a>3.169. pgp_long_ids</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5515 Default: no</p></div><p>
5516 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.
5518 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-mime-auto"></a>3.170. pgp_mime_auto</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5519 Default: ask-yes</p></div><p>
5520 This option controls whether Mutt will prompt you for
5521 automatically sending a (signed/encrypted) message using
5522 PGP/MIME when inline (traditional) fails (for any reason).
5524 Also note that using the old-style PGP message format is <span class="bold"><strong>strongly</strong></span>
5525 <span class="bold"><strong>deprecated</strong></span>.
5527 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-replyinline"></a>3.171. pgp_replyinline</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5528 Default: no</p></div><p>
5529 Setting this variable will cause Mutt to always attempt to
5530 create an inline (traditional) message when replying to a
5531 message which is PGP encrypted/signed inline. This can be
5532 overridden by use of the pgp menu, when inline is not
5533 required. This option does not automatically detect if the
5534 (replied-to) message is inline; instead it relies on Mutt
5535 internals for previously checked/flagged messages.
5537 Note that Mutt might automatically use PGP/MIME for messages
5538 which consist of more than a single MIME part. Mutt can be
5539 configured to ask before sending PGP/MIME messages when inline
5540 (traditional) would not work.
5542 Also see the <a class="link" href="#pgp-mime-auto" title="3.170. pgp_mime_auto">$pgp_mime_auto</a> variable.
5544 Also note that using the old-style PGP message format is <span class="bold"><strong>strongly</strong></span>
5545 <span class="bold"><strong>deprecated</strong></span>.
5547 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-retainable-sigs"></a>3.172. pgp_retainable_sigs</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5548 Default: no</p></div><p>
5549 If <span class="emphasis"><em>set</em></span>, signed and encrypted messages will consist of nested
5550 <code class="literal">multipart/signed</code> and <code class="literal">multipart/encrypted</code> body parts.
5552 This is useful for applications like encrypted and signed mailing
5553 lists, where the outer layer (<code class="literal">multipart/encrypted</code>) can be easily
5554 removed, while the inner <code class="literal">multipart/signed</code> part is retained.
5556 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-show-unusable"></a>3.173. pgp_show_unusable</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5557 Default: yes</p></div><p>
5558 If <span class="emphasis"><em>set</em></span>, mutt will display non-usable keys on the PGP key selection
5559 menu. This includes keys which have been revoked, have expired, or
5560 have been marked as “<span class="quote">disabled</span>” by the user.
5562 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-sign-as"></a>3.174. pgp_sign_as</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5563 Default: (empty)</p></div><p>
5564 If you have more than one key pair, this option allows you to specify
5565 which of your private keys to use. It is recommended that you use the
5566 keyid form to specify your key (e.g. <code class="literal">0x00112233</code>).
5568 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-sign-command"></a>3.175. pgp_sign_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5569 Default: (empty)</p></div><p>
5570 This command is used to create the detached PGP signature for a
5571 <code class="literal">multipart/signed</code> PGP/MIME body part.
5573 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.157. pgp_decode_command">$pgp_decode_command</a> command for
5574 possible <code class="literal">printf(3)</code>-like sequences.
5576 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-sort-keys"></a>3.176. pgp_sort_keys</h3></div></div></div><div class="literallayout"><p>Type: sort order<br />
5577 Default: address</p></div><p>
5578 Specifies how the entries in the pgp menu are sorted. The
5579 following are legal values:
5581 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>address </td><td>sort alphabetically by user id
5582 </td></tr><tr><td>keyid </td><td>sort alphabetically by key id
5583 </td></tr><tr><td>date </td><td>sort by key creation date
5584 </td></tr><tr><td>trust </td><td>sort by the trust of the key
5585 </td></tr></tbody></table></div><p>
5586 If you prefer reverse order of the above values, prefix it with
5587 “<span class="quote">reverse-</span>”.
5589 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-strict-enc"></a>3.177. pgp_strict_enc</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5590 Default: yes</p></div><p>
5591 If <span class="emphasis"><em>set</em></span>, Mutt will automatically encode PGP/MIME signed messages as
5592 quoted-printable. Please note that unsetting this variable may
5593 lead to problems with non-verifyable PGP signatures, so only change
5594 this if you know what you are doing.
5596 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-timeout"></a>3.178. pgp_timeout</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5597 Default: 300</p></div><p>
5598 The number of seconds after which a cached passphrase will expire if
5601 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-use-gpg-agent"></a>3.179. pgp_use_gpg_agent</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5602 Default: no</p></div><p>
5603 If <span class="emphasis"><em>set</em></span>, mutt will use a possibly-running <code class="literal">gpg-agent(1)</code> process.
5605 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-verify-command"></a>3.180. pgp_verify_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5606 Default: (empty)</p></div><p>
5607 This command is used to verify PGP signatures.
5609 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.157. pgp_decode_command">$pgp_decode_command</a> command for
5610 possible <code class="literal">printf(3)</code>-like sequences.
5612 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-verify-key-command"></a>3.181. pgp_verify_key_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5613 Default: (empty)</p></div><p>
5614 This command is used to verify key information from the key selection
5617 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.157. pgp_decode_command">$pgp_decode_command</a> command for
5618 possible <code class="literal">printf(3)</code>-like sequences.
5620 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pipe-decode"></a>3.182. pipe_decode</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5621 Default: no</p></div><p>
5622 Used in connection with the <code class="literal"><pipe-message></code> command. When <span class="emphasis"><em>unset</em></span>,
5623 Mutt will pipe the messages without any preprocessing. When <span class="emphasis"><em>set</em></span>, Mutt
5624 will weed headers and will attempt to decode the messages
5626 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pipe-sep"></a>3.183. pipe_sep</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5627 Default: “<span class="quote"><code class="literal">\n</code></span>”</p></div><p>
5628 The separator to add between messages when piping a list of tagged
5629 messages to an external Unix command.
5630 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pipe-split"></a>3.184. pipe_split</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5631 Default: no</p></div><p>
5632 Used in connection with the <code class="literal"><pipe-message></code> function following
5633 <code class="literal"><tag-prefix></code>. If this variable is <span class="emphasis"><em>unset</em></span>, when piping a list of
5634 tagged messages Mutt will concatenate the messages and will pipe them
5635 all concatenated. When <span class="emphasis"><em>set</em></span>, Mutt will pipe the messages one by one.
5636 In both cases the messages are piped in the current sorted order,
5637 and the <a class="link" href="#pipe-sep" title="3.183. pipe_sep">$pipe_sep</a> separator is added after each message.
5638 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-auth-try-all"></a>3.185. pop_auth_try_all</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5639 Default: yes</p></div><p>
5640 If <span class="emphasis"><em>set</em></span>, Mutt will try all available authentication methods.
5641 When <span class="emphasis"><em>unset</em></span>, Mutt will only fall back to other authentication
5642 methods if the previous methods are unavailable. If a method is
5643 available but authentication fails, Mutt will not connect to the POP server.
5644 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-authenticators"></a>3.186. pop_authenticators</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5645 Default: (empty)</p></div><p>
5646 This is a colon-delimited list of authentication methods mutt may
5647 attempt to use to log in to an POP server, in the order mutt should
5648 try them. Authentication methods are either “<span class="quote">user</span>”, “<span class="quote">apop</span>” or any
5649 SASL mechanism, eg “<span class="quote">digest-md5</span>”, “<span class="quote">gssapi</span>” or “<span class="quote">cram-md5</span>”.
5650 This option is case-insensitive. If this option is <span class="emphasis"><em>unset</em></span>
5651 (the default) mutt will try all available methods, in order from
5652 most-secure to least-secure.
5656 </p><pre class="screen">
5657 set pop_authenticators="digest-md5:apop:user"
5658 </pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-checkinterval"></a>3.187. pop_checkinterval</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5659 Default: 60</p></div><p>
5660 This variable configures how often (in seconds) mutt should look for
5661 new mail in the currently selected mailbox if it is a POP mailbox.
5662 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-delete"></a>3.188. pop_delete</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5663 Default: ask-no</p></div><p>
5664 If <span class="emphasis"><em>set</em></span>, Mutt will delete successfully downloaded messages from the POP
5665 server when using the <code class="literal"><a class="link" href="#fetch-mail"><fetch-mail></a></code> function. When <span class="emphasis"><em>unset</em></span>, Mutt will
5666 download messages but also leave them on the POP server.
5667 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-host"></a>3.189. pop_host</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5668 Default: (empty)</p></div><p>
5669 The name of your POP server for the <code class="literal"><a class="link" href="#fetch-mail"><fetch-mail></a></code> function. You
5670 can also specify an alternative port, username and password, ie:
5672 </p><pre class="screen">
5673 [pop[s]://][username[:password]@]popserver[:port]
5675 where “<span class="quote">[...]</span>” denotes an optional part.
5676 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-last"></a>3.190. pop_last</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5677 Default: no</p></div><p>
5678 If this variable is <span class="emphasis"><em>set</em></span>, mutt will try to use the “<span class="quote"><code class="literal">LAST</code></span>” POP command
5679 for retrieving only unread messages from the POP server when using
5680 the <code class="literal"><a class="link" href="#fetch-mail"><fetch-mail></a></code> function.
5681 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-pass"></a>3.191. pop_pass</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5682 Default: (empty)</p></div><p>
5683 Specifies the password for your POP account. If <span class="emphasis"><em>unset</em></span>, Mutt will
5684 prompt you for your password when you open a POP mailbox.
5686 <span class="bold"><strong>Warning</strong></span>: you should only use this option when you are on a
5687 fairly secure machine, because the superuser can read your muttrc
5688 even if you are the only one who can read the file.
5689 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-reconnect"></a>3.192. pop_reconnect</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5690 Default: ask-yes</p></div><p>
5691 Controls whether or not Mutt will try to reconnect to the POP server if
5692 the connection is lost.
5693 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-user"></a>3.193. pop_user</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5694 Default: (empty)</p></div><p>
5695 Your login name on the POP server.
5697 This variable defaults to your user name on the local machine.
5698 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="post-indent-string"></a>3.194. post_indent_string</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5699 Default: (empty)</p></div><p>
5700 Similar to the <a class="link" href="#attribution" title="3.16. attribution">$attribution</a> variable, Mutt will append this
5701 string after the inclusion of a message which is being replied to.
5702 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="postpone"></a>3.195. postpone</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5703 Default: ask-yes</p></div><p>
5704 Controls whether or not messages are saved in the <a class="link" href="#postponed" title="3.196. postponed">$postponed</a>
5705 mailbox when you elect not to send immediately.
5707 Also see the <a class="link" href="#recall" title="3.210. recall">$recall</a> variable.
5708 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="postponed"></a>3.196. postponed</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5709 Default: “<span class="quote"><code class="literal">˜/postponed</code></span>”</p></div><p>
5710 Mutt allows you to indefinitely “<span class="quote"><a class="link" href="#postpone" title="3.195. postpone">postpone</a> sending a message</span>” which
5711 you are editing. When you choose to postpone a message, Mutt saves it
5712 in the mailbox specified by this variable.
5714 Also see the <a class="link" href="#postpone" title="3.195. postpone">$postpone</a> variable.
5715 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="preconnect"></a>3.197. preconnect</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5716 Default: (empty)</p></div><p>
5717 If <span class="emphasis"><em>set</em></span>, a shell command to be executed if mutt fails to establish
5718 a connection to the server. This is useful for setting up secure
5719 connections, e.g. with <code class="literal">ssh(1)</code>. If the command returns a nonzero
5720 status, mutt gives up opening the server. Example:
5722 </p><pre class="screen">
5723 set preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net \
5724 sleep 20 < /dev/null > /dev/null"
5726 Mailbox “<span class="quote">foo</span>” on “<span class="quote">mailhost.net</span>” can now be reached
5727 as “<span class="quote">{localhost:1234}foo</span>”.
5729 Note: For this example to work, you must be able to log in to the
5730 remote machine without having to enter a password.
5731 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="print"></a>3.198. print</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5732 Default: ask-no</p></div><p>
5733 Controls whether or not Mutt really prints messages.
5734 This is set to “<span class="quote">ask-no</span>” by default, because some people
5735 accidentally hit “<span class="quote">p</span>” often.
5736 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="print-command"></a>3.199. print_command</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5737 Default: “<span class="quote"><code class="literal">lpr</code></span>”</p></div><p>
5738 This specifies the command pipe that should be used to print messages.
5739 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="print-decode"></a>3.200. print_decode</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5740 Default: yes</p></div><p>
5741 Used in connection with the <code class="literal"><print-message></code> command. If this
5742 option is <span class="emphasis"><em>set</em></span>, the message is decoded before it is passed to the
5743 external command specified by <a class="link" href="#print-command" title="3.199. print_command">$print_command</a>. If this option
5744 is <span class="emphasis"><em>unset</em></span>, no processing will be applied to the message when
5745 printing it. The latter setting may be useful if you are using
5746 some advanced printer filter which is able to properly format
5747 e-mail messages for printing.
5748 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="print-split"></a>3.201. print_split</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5749 Default: no</p></div><p>
5750 Used in connection with the <code class="literal"><print-message></code> command. If this option
5751 is <span class="emphasis"><em>set</em></span>, the command specified by <a class="link" href="#print-command" title="3.199. print_command">$print_command</a> is executed once for
5752 each message which is to be printed. If this option is <span class="emphasis"><em>unset</em></span>,
5753 the command specified by <a class="link" href="#print-command" title="3.199. print_command">$print_command</a> is executed only once, and
5754 all the messages are concatenated, with a form feed as the message
5757 Those who use the <code class="literal">enscript</code>(1) program's mail-printing mode will
5758 most likely want to <span class="emphasis"><em>set</em></span> this option.
5759 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="prompt-after"></a>3.202. prompt_after</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5760 Default: yes</p></div><p>
5761 If you use an <span class="emphasis"><em>external</em></span> <a class="link" href="#pager" title="3.148. pager">$pager</a>, setting this variable will
5762 cause Mutt to prompt you for a command when the pager exits rather
5763 than returning to the index menu. If <span class="emphasis"><em>unset</em></span>, Mutt will return to the
5764 index menu when the external pager exits.
5765 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="query-command"></a>3.203. query_command</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5766 Default: (empty)</p></div><p>
5767 This specifies the command that mutt will use to make external address
5768 queries. The string should contain a “<span class="quote">%s</span>”, which will be substituted
5769 with the query string the user types. See “<span class="quote"><a class="link" href="#query" title="5. External Address Queries">query</a></span>” for more
5771 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="query-format"></a>3.204. query_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5772 Default: “<span class="quote"><code class="literal">%4c %t %-25.25a %-25.25n %?e?(%e)?</code></span>”</p></div><p>
5773 This variable describes the format of the “<span class="quote">query</span>” menu. The
5774 following <code class="literal">printf(3)</code>-style sequences are understood:
5776 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>%a </td><td>destination address
5777 </td></tr><tr><td>%c </td><td>current entry number
5778 </td></tr><tr><td>%e </td><td>extra information *
5779 </td></tr><tr><td>%n </td><td>destination name
5780 </td></tr><tr><td>%t </td><td>“<span class="quote">*</span>” if current entry is tagged, a space otherwise
5781 </td></tr><tr><td>%>X </td><td>right justify the rest of the string and pad with “<span class="quote">X</span>”
5782 </td></tr><tr><td>%|X </td><td>pad to the end of the line with “<span class="quote">X</span>”
5783 </td></tr><tr><td>%*X </td><td>soft-fill with character “<span class="quote">X</span>” as pad
5784 </td></tr></tbody></table></div><p>
5785 For an explanation of “<span class="quote">soft-fill</span>”, see the <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> documentation.
5787 * = can be optionally printed if nonzero, see the <a class="link" href="#status-format" title="3.282. status_format">$status_format</a> documentation.
5788 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="quit"></a>3.205. quit</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5789 Default: yes</p></div><p>
5790 This variable controls whether “<span class="quote">quit</span>” and “<span class="quote">exit</span>” actually quit
5791 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
5792 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
5793 prompted for confirmation when you try to quit.
5794 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="quote-regexp"></a>3.206. quote_regexp</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
5795 Default: “<span class="quote"><code class="literal">^([ \t]*[|>:}#])+</code></span>”</p></div><p>
5796 A regular expression used in the internal pager to determine quoted
5797 sections of text in the body of a message. Quoted text may be filtered
5798 out using the <code class="literal"><toggle-quoted></code> command, or colored according to the
5799 “<span class="quote">color quoted</span>” family of directives.
5801 Higher levels of quoting may be colored differently (“<span class="quote">color quoted1</span>”,
5802 “<span class="quote">color quoted2</span>”, etc.). The quoting level is determined by removing
5803 the last character from the matched text and recursively reapplying
5804 the regular expression until it fails to produce a match.
5806 Match detection may be overridden by the <a class="link" href="#smileys" title="3.239. smileys">$smileys</a> regular expression.
5807 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="read-inc"></a>3.207. read_inc</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5808 Default: 10</p></div><p>
5809 If set to a value greater than 0, Mutt will display which message it
5810 is currently on when reading a mailbox or when performing search actions
5811 such as search and limit. The message is printed after
5812 this many messages have been read or searched (e.g., if set to 25, Mutt will
5813 print a message when it is at message 25, and then again when it gets
5814 to message 50). This variable is meant to indicate progress when
5815 reading or searching large mailboxes which may take some time.
5816 When set to 0, only a single message will appear before the reading
5819 Also see the <a class="link" href="#write-inc" title="3.310. write_inc">$write_inc</a>, <a class="link" href="#net-inc" title="3.147. net_inc">$net_inc</a> and <a class="link" href="#time-inc" title="3.290. time_inc">$time_inc</a> variables and the
5820 “<span class="quote"><a class="link" href="#tuning" title="Chapter 8. Performance Tuning">tuning</a></span>” section of the manual for performance considerations.
5821 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="read-only"></a>3.208. read_only</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5822 Default: no</p></div><p>
5823 If <span class="emphasis"><em>set</em></span>, all folders are opened in read-only mode.
5824 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="realname"></a>3.209. realname</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5825 Default: (empty)</p></div><p>
5826 This variable specifies what “<span class="quote">real</span>” or “<span class="quote">personal</span>” name should be used
5827 when sending messages.
5829 By default, this is the GECOS field from <code class="literal">/etc/passwd</code>. Note that this
5830 variable will <span class="emphasis"><em>not</em></span> be used when the user has set a real name
5831 in the <a class="link" href="#from" title="3.75. from">$from</a> variable.
5832 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="recall"></a>3.210. recall</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5833 Default: ask-yes</p></div><p>
5834 Controls whether or not Mutt recalls postponed messages
5835 when composing a new message.
5837 <span class="emphasis"><em>Setting</em></span> this variable to is not generally useful, and thus not
5840 Also see <a class="link" href="#postponed" title="3.196. postponed">$postponed</a> variable.
5841 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="record"></a>3.211. record</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5842 Default: “<span class="quote"><code class="literal">˜/sent</code></span>”</p></div><p>
5843 This specifies the file into which your outgoing messages should be
5844 appended. (This is meant as the primary method for saving a copy of
5845 your messages, but another way to do this is using the “<span class="quote"><a class="link" href="#my-hdr" title="15. User-Defined Headers">my_hdr</a></span>”
5846 command to create a “<span class="quote">Bcc:</span>” field with your email address in it.)
5848 The value of <span class="emphasis"><em><a class="link" href="#record" title="3.211. record">$record</a></em></span> is overridden by the <a class="link" href="#force-name" title="3.69. force_name">$force_name</a> and
5849 <a class="link" href="#save-name" title="3.223. save_name">$save_name</a> variables, and the “<span class="quote"><a class="link" href="#fcc-hook" title="17. Specify Default Fcc: Mailbox When Composing">fcc-hook</a></span>” command.
5850 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="reply-regexp"></a>3.212. reply_regexp</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
5851 Default: “<span class="quote"><code class="literal">^(re([\[0-9\]+])*|aw):[ \t]*</code></span>”</p></div><p>
5852 A regular expression used to recognize reply messages when threading
5853 and replying. The default value corresponds to the English "Re:" and
5855 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="reply-self"></a>3.213. reply_self</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5856 Default: no</p></div><p>
5857 If <span class="emphasis"><em>unset</em></span> and you are replying to a message sent by you, Mutt will
5858 assume that you want to reply to the recipients of that message rather
5861 Also see the “<span class="quote"><a class="link" href="#alternates" title="11. Alternative Addresses">alternates</a></span>” command.
5862 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="reply-to"></a>3.214. reply_to</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5863 Default: ask-yes</p></div><p>
5864 If <span class="emphasis"><em>set</em></span>, when replying to a message, Mutt will use the address listed
5865 in the Reply-to: header as the recipient of the reply. If <span class="emphasis"><em>unset</em></span>,
5866 it will use the address in the From: header field instead. This
5867 option is useful for reading a mailing list that sets the Reply-To:
5868 header field to the list address and you want to send a private
5869 message to the author of a message.
5870 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="resolve"></a>3.215. resolve</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5871 Default: yes</p></div><p>
5872 When <span class="emphasis"><em>set</em></span>, the cursor will be automatically advanced to the next
5873 (possibly undeleted) message whenever a command that modifies the
5874 current message is executed.
5875 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="reverse-alias"></a>3.216. reverse_alias</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5876 Default: no</p></div><p>
5877 This variable controls whether or not Mutt will display the “<span class="quote">personal</span>”
5878 name from your aliases in the index menu if it finds an alias that
5879 matches the message's sender. For example, if you have the following
5882 </p><pre class="screen">
5883 alias juser abd30425@somewhere.net (Joe User)
5885 and then you receive mail which contains the following header:
5887 </p><pre class="screen">
5888 From: abd30425@somewhere.net
5890 It would be displayed in the index menu as “<span class="quote">Joe User</span>” instead of
5891 “<span class="quote">abd30425@somewhere.net.</span>” This is useful when the person's e-mail
5892 address is not human friendly.
5893 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="reverse-name"></a>3.217. reverse_name</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5894 Default: no</p></div><p>
5895 It may sometimes arrive that you receive mail to a certain machine,
5896 move the messages to another machine, and reply to some the messages
5897 from there. If this variable is <span class="emphasis"><em>set</em></span>, the default <span class="emphasis"><em>From:</em></span> line of
5898 the reply messages is built using the address where you received the
5899 messages you are replying to <span class="bold"><strong>if</strong></span> that address matches your
5900 “<span class="quote"><a class="link" href="#alternates" title="11. Alternative Addresses">alternates</a></span>”. If the variable is <span class="emphasis"><em>unset</em></span>, or the address that would be
5901 used doesn't match your “<span class="quote"><a class="link" href="#alternates" title="11. Alternative Addresses">alternates</a></span>”, the <span class="emphasis"><em>From:</em></span> line will use
5902 your address on the current machine.
5904 Also see the “<span class="quote"><a class="link" href="#alternates" title="11. Alternative Addresses">alternates</a></span>” command.
5905 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="reverse-realname"></a>3.218. reverse_realname</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5906 Default: yes</p></div><p>
5907 This variable fine-tunes the behaviour of the <a class="link" href="#reverse-name" title="3.217. reverse_name">$reverse_name</a> feature.
5908 When it is <span class="emphasis"><em>set</em></span>, mutt will use the address from incoming messages as-is,
5909 possibly including eventual real names. When it is <span class="emphasis"><em>unset</em></span>, mutt will
5910 override any such real names with the setting of the <a class="link" href="#realname" title="3.209. realname">$realname</a> variable.
5911 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="rfc2047-parameters"></a>3.219. rfc2047_parameters</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5912 Default: no</p></div><p>
5913 When this variable is <span class="emphasis"><em>set</em></span>, Mutt will decode RFC2047-encoded MIME
5914 parameters. You want to set this variable when mutt suggests you
5915 to save attachments to files named like:
5917 </p><pre class="screen">
5918 =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?=
5920 When this variable is <span class="emphasis"><em>set</em></span> interactively, the change won't be
5921 active until you change folders.
5923 Note that this use of RFC2047's encoding is explicitly
5924 prohibited by the standard, but nevertheless encountered in the
5927 Also note that setting this parameter will <span class="emphasis"><em>not</em></span> have the effect
5928 that mutt <span class="emphasis"><em>generates</em></span> this kind of encoding. Instead, mutt will
5929 unconditionally use the encoding specified in RFC2231.
5930 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="save-address"></a>3.220. save_address</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>, mutt will take the sender's full address when choosing a
5933 default folder for saving a mail. If <a class="link" href="#save-name" title="3.223. save_name">$save_name</a> or <a class="link" href="#force-name" title="3.69. force_name">$force_name</a>
5934 is <span class="emphasis"><em>set</em></span> too, the selection of the Fcc folder will be changed as well.
5935 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="save-empty"></a>3.221. save_empty</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5936 Default: yes</p></div><p>
5937 When <span class="emphasis"><em>unset</em></span>, mailboxes which contain no saved messages will be removed
5938 when closed (the exception is <a class="link" href="#spoolfile" title="3.269. spoolfile">$spoolfile</a> which is never removed).
5939 If <span class="emphasis"><em>set</em></span>, mailboxes are never removed.
5941 <span class="bold"><strong>Note:</strong></span> This only applies to mbox and MMDF folders, Mutt does not
5942 delete MH and Maildir directories.
5943 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="save-history"></a>3.222. save_history</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5944 Default: 0</p></div><p>
5945 This variable controls the size of the history (per category) saved in the
5946 <a class="link" href="#history-file" title="3.90. history_file">$history_file</a> file.
5947 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="save-name"></a>3.223. save_name</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5948 Default: no</p></div><p>
5949 This variable controls how copies of outgoing messages are saved.
5950 When <span class="emphasis"><em>set</em></span>, a check is made to see if a mailbox specified by the
5951 recipient address exists (this is done by searching for a mailbox in
5952 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
5953 recipient address). If the mailbox exists, the outgoing message will
5954 be saved to that mailbox, otherwise the message is saved to the
5955 <a class="link" href="#record" title="3.211. record">$record</a> mailbox.
5957 Also see the <a class="link" href="#force-name" title="3.69. force_name">$force_name</a> variable.
5958 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="score"></a>3.224. score</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5959 Default: yes</p></div><p>
5960 When this variable is <span class="emphasis"><em>unset</em></span>, scoring is turned off. This can
5961 be useful to selectively disable scoring for certain folders when the
5962 <a class="link" href="#score-threshold-delete" title="3.225. score_threshold_delete">$score_threshold_delete</a> variable and related are used.
5963 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="score-threshold-delete"></a>3.225. score_threshold_delete</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5964 Default: -1</p></div><p>
5965 Messages which have been assigned a score equal to or lower than the value
5966 of this variable are automatically marked for deletion by mutt. Since
5967 mutt scores are always greater than or equal to zero, the default setting
5968 of this variable will never mark a message for deletion.
5969 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="score-threshold-flag"></a>3.226. score_threshold_flag</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5970 Default: 9999</p></div><p>
5971 Messages which have been assigned a score greater than or equal to this
5972 variable's value are automatically marked "flagged".
5973 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="score-threshold-read"></a>3.227. score_threshold_read</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5974 Default: -1</p></div><p>
5975 Messages which have been assigned a score equal to or lower than the value
5976 of this variable are automatically marked as read by mutt. Since
5977 mutt scores are always greater than or equal to zero, the default setting
5978 of this variable will never mark a message read.
5979 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="search-context"></a>3.228. search_context</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5980 Default: 0</p></div><p>
5981 For the pager, this variable specifies the number of lines shown
5982 before search results. By default, search results will be top-aligned.
5983 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="send-charset"></a>3.229. send_charset</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5984 Default: “<span class="quote"><code class="literal">us-ascii:iso-8859-1:utf-8</code></span>”</p></div><p>
5985 A colon-delimited list of character sets for outgoing messages. Mutt will use the
5986 first character set into which the text can be converted exactly.
5987 If your <a class="link" href="#charset" title="3.25. charset">$charset</a> is not “<span class="quote">iso-8859-1</span>” and recipients may not
5988 understand “<span class="quote">UTF-8</span>”, it is advisable to include in the list an
5989 appropriate widely used standard character set (such as
5990 “<span class="quote">iso-8859-2</span>”, “<span class="quote">koi8-r</span>” or “<span class="quote">iso-2022-jp</span>”) either instead of or after
5991 “<span class="quote">iso-8859-1</span>”.
5993 In case the text cannot be converted into one of these exactly,
5994 mutt uses <a class="link" href="#charset" title="3.25. charset">$charset</a> as a fallback.
5995 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sendmail"></a>3.230. sendmail</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5996 Default: “<span class="quote"><code class="literal">/usr/sbin/sendmail -oem -oi</code></span>”</p></div><p>
5997 Specifies the program and arguments used to deliver mail sent by Mutt.
5998 Mutt expects that the specified program interprets additional
5999 arguments as recipient addresses.
6000 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sendmail-wait"></a>3.231. sendmail_wait</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6001 Default: 0</p></div><p>
6002 Specifies the number of seconds to wait for the <a class="link" href="#sendmail" title="3.230. sendmail">$sendmail</a> process
6003 to finish before giving up and putting delivery in the background.
6005 Mutt interprets the value of this variable as follows:
6007 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>>0 </td><td>number of seconds to wait for sendmail to finish before continuing
6008 </td></tr><tr><td>0 </td><td>wait forever for sendmail to finish
6009 </td></tr><tr><td><0 </td><td>always put sendmail in the background without waiting
6010 </td></tr></tbody></table></div><p>
6011 Note that if you specify a value other than 0, the output of the child
6012 process will be put in a temporary file. If there is some error, you
6013 will be informed as to where to find the output.
6014 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="shell"></a>3.232. shell</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6015 Default: (empty)</p></div><p>
6016 Command to use when spawning a subshell. By default, the user's login
6017 shell from <code class="literal">/etc/passwd</code> is used.
6018 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sig-dashes"></a>3.233. sig_dashes</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6019 Default: yes</p></div><p>
6020 If <span class="emphasis"><em>set</em></span>, a line containing “<span class="quote">-- </span>” (note the trailing space) will be inserted before your
6021 <a class="link" href="#signature" title="3.235. signature">$signature</a>. It is <span class="bold"><strong>strongly</strong></span> recommended that you not <span class="emphasis"><em>unset</em></span>
6022 this variable unless your signature contains just your name. The
6023 reason for this is because many software packages use “<span class="quote">-- \n</span>” to
6024 detect your signature. For example, Mutt has the ability to highlight
6025 the signature in a different color in the builtin pager.
6026 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sig-on-top"></a>3.234. sig_on_top</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6027 Default: no</p></div><p>
6028 If <span class="emphasis"><em>set</em></span>, the signature will be included before any quoted or forwarded
6029 text. It is <span class="bold"><strong>strongly</strong></span> recommended that you do not set this variable
6030 unless you really know what you are doing, and are prepared to take
6031 some heat from netiquette guardians.
6032 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="signature"></a>3.235. signature</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6033 Default: “<span class="quote"><code class="literal">˜/.signature</code></span>”</p></div><p>
6034 Specifies the filename of your signature, which is appended to all
6035 outgoing messages. If the filename ends with a pipe (“<span class="quote">|</span>”), it is
6036 assumed that filename is a shell command and input should be read from
6037 its standard output.
6038 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="simple-search"></a>3.236. simple_search</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6039 Default: “<span class="quote"><code class="literal">˜f %s | ˜s %s</code></span>”</p></div><p>
6040 Specifies how Mutt should expand a simple search into a real search
6041 pattern. A simple search is one that does not contain any of the “<span class="quote">˜</span>” pattern
6042 operators. See “<span class="quote"><a class="link" href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">patterns</a></span>” for more information on search patterns.
6044 For example, if you simply type “<span class="quote">joe</span>” at a search or limit prompt, Mutt
6045 will automatically expand it to the value specified by this variable by
6046 replacing “<span class="quote">%s</span>” with the supplied string.
6047 For the default value, “<span class="quote">joe</span>” would be expanded to: “<span class="quote">˜f joe | ˜s joe</span>”.
6048 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sleep-time"></a>3.237. sleep_time</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6049 Default: 1</p></div><p>
6050 Specifies time, in seconds, to pause while displaying certain informational
6051 messages, while moving from folder to folder and after expunging
6052 messages from the current folder. The default is to pause one second, so
6053 a value of zero for this option suppresses the pause.
6054 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smart-wrap"></a>3.238. smart_wrap</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6055 Default: yes</p></div><p>
6056 Controls the display of lines longer than the screen width in the
6057 internal pager. If <span class="emphasis"><em>set</em></span>, long lines are wrapped at a word boundary. If
6058 <span class="emphasis"><em>unset</em></span>, lines are simply wrapped at the screen edge. Also see the
6059 <a class="link" href="#markers" title="3.124. markers">$markers</a> variable.
6060 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smileys"></a>3.239. smileys</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
6061 Default: “<span class="quote"><code class="literal">(>From )|(:[-^]?[][)(><}{|/DP])</code></span>”</p></div><p>
6062 The <span class="emphasis"><em>pager</em></span> uses this variable to catch some common false
6063 positives of <a class="link" href="#quote-regexp" title="3.206. quote_regexp">$quote_regexp</a>, most notably smileys and not consider
6064 a line quoted text if it also matches <a class="link" href="#smileys" title="3.239. smileys">$smileys</a>. This mostly
6065 happens at the beginning of a line.
6066 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-ask-cert-label"></a>3.240. smime_ask_cert_label</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6067 Default: yes</p></div><p>
6068 This flag controls whether you want to be asked to enter a label
6069 for a certificate about to be added to the database or not. It is
6070 <span class="emphasis"><em>set</em></span> by default.
6072 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-ca-location"></a>3.241. smime_ca_location</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6073 Default: (empty)</p></div><p>
6074 This variable contains the name of either a directory, or a file which
6075 contains trusted certificates for use with OpenSSL.
6077 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-certificates"></a>3.242. smime_certificates</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6078 Default: (empty)</p></div><p>
6079 Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle
6080 storage and retrieval of keys by itself. This is very basic right
6081 now, and keys and certificates are stored in two different
6082 directories, both named as the hash-value retrieved from
6083 OpenSSL. There is an index file which contains mailbox-address
6084 keyid pairs, and which can be manually edited. This option points to
6085 the location of the certificates.
6087 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-decrypt-command"></a>3.243. smime_decrypt_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6088 Default: (empty)</p></div><p>
6089 This format string specifies a command which is used to decrypt
6090 <code class="literal">application/x-pkcs7-mime</code> attachments.
6092 The OpenSSL command formats have their own set of <code class="literal">printf(3)</code>-like sequences
6095 </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.
6096 </td></tr><tr><td>%s </td><td>Expands to the name of a file containing the signature part
6097 of a <code class="literal">multipart/signed</code> attachment when verifying it.
6098 </td></tr><tr><td>%k </td><td>The key-pair specified with <a class="link" href="#smime-default-key" title="3.245. smime_default_key">$smime_default_key</a>
6099 </td></tr><tr><td>%c </td><td>One or more certificate IDs.
6100 </td></tr><tr><td>%a </td><td>The algorithm used for encryption.
6101 </td></tr><tr><td>%C </td><td>CA location: Depending on whether <a class="link" href="#smime-ca-location" title="3.241. smime_ca_location">$smime_ca_location</a>
6102 points to a directory or file, this expands to
6103 “<span class="quote">-CApath <a class="link" href="#smime-ca-location" title="3.241. smime_ca_location">$smime_ca_location</a></span>” or “<span class="quote">-CAfile <a class="link" href="#smime-ca-location" title="3.241. smime_ca_location">$smime_ca_location</a></span>”.
6104 </td></tr></tbody></table></div><p>
6105 For examples on how to configure these formats, see the <code class="literal">smime.rc</code> in
6106 the <code class="literal">samples/</code> subdirectory which has been installed on your system
6107 alongside the documentation.
6109 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-decrypt-use-default-key"></a>3.244. smime_decrypt_use_default_key</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6110 Default: yes</p></div><p>
6111 If <span class="emphasis"><em>set</em></span> (default) this tells mutt to use the default key for decryption. Otherwise,
6112 if managing multiple certificate-key-pairs, mutt will try to use the mailbox-address
6113 to determine the key to use. It will ask you to supply a key, if it can't find one.
6115 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-default-key"></a>3.245. smime_default_key</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6116 Default: (empty)</p></div><p>
6117 This is the default key-pair to use for signing. This must be set to the
6118 keyid (the hash-value that OpenSSL generates) to work properly
6120 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-encrypt-command"></a>3.246. smime_encrypt_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6121 Default: (empty)</p></div><p>
6122 This command is used to create encrypted S/MIME messages.
6124 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.243. smime_decrypt_command">$smime_decrypt_command</a> command for
6125 possible <code class="literal">printf(3)</code>-like sequences.
6127 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-encrypt-with"></a>3.247. smime_encrypt_with</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6128 Default: (empty)</p></div><p>
6129 This sets the algorithm that should be used for encryption.
6130 Valid choices are “<span class="quote">des</span>”, “<span class="quote">des3</span>”, “<span class="quote">rc2-40</span>”, “<span class="quote">rc2-64</span>”, “<span class="quote">rc2-128</span>”.
6131 If <span class="emphasis"><em>unset</em></span>, “<span class="quote">3des</span>” (TripleDES) is used.
6133 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-get-cert-command"></a>3.248. smime_get_cert_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6134 Default: (empty)</p></div><p>
6135 This command is used to extract X509 certificates from a PKCS7 structure.
6137 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.243. smime_decrypt_command">$smime_decrypt_command</a> command for
6138 possible <code class="literal">printf(3)</code>-like sequences.
6140 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-get-cert-email-command"></a>3.249. smime_get_cert_email_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6141 Default: (empty)</p></div><p>
6142 This command is used to extract the mail address(es) used for storing
6143 X509 certificates, and for verification purposes (to check whether the
6144 certificate was issued for the sender's mailbox).
6146 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.243. smime_decrypt_command">$smime_decrypt_command</a> command for
6147 possible <code class="literal">printf(3)</code>-like sequences.
6149 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-get-signer-cert-command"></a>3.250. smime_get_signer_cert_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6150 Default: (empty)</p></div><p>
6151 This command is used to extract only the signers X509 certificate from a S/MIME
6152 signature, so that the certificate's owner may get compared to the
6153 email's “<span class="quote">From:</span>” field.
6155 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.243. smime_decrypt_command">$smime_decrypt_command</a> command for
6156 possible <code class="literal">printf(3)</code>-like sequences.
6158 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-import-cert-command"></a>3.251. smime_import_cert_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6159 Default: (empty)</p></div><p>
6160 This command is used to import a certificate via smime_keys.
6162 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.243. smime_decrypt_command">$smime_decrypt_command</a> command for
6163 possible <code class="literal">printf(3)</code>-like sequences.
6165 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-is-default"></a>3.252. smime_is_default</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6166 Default: no</p></div><p>
6167 The default behaviour of mutt is to use PGP on all auto-sign/encryption
6168 operations. To override and to use OpenSSL instead this must be <span class="emphasis"><em>set</em></span>.
6169 However, this has no effect while replying, since mutt will automatically
6170 select the same application that was used to sign/encrypt the original
6171 message. (Note that this variable can be overridden by unsetting <a class="link" href="#crypt-autosmime" title="3.39. crypt_autosmime">$crypt_autosmime</a>.)
6173 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-keys"></a>3.253. smime_keys</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6174 Default: (empty)</p></div><p>
6175 Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle
6176 storage and retrieval of keys/certs by itself. This is very basic right now,
6177 and stores keys and certificates in two different directories, both
6178 named as the hash-value retrieved from OpenSSL. There is an index file
6179 which contains mailbox-address keyid pair, and which can be manually
6180 edited. This option points to the location of the private keys.
6182 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-pk7out-command"></a>3.254. smime_pk7out_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6183 Default: (empty)</p></div><p>
6184 This command is used to extract PKCS7 structures of S/MIME signatures,
6185 in order to extract the public X509 certificate(s).
6187 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.243. smime_decrypt_command">$smime_decrypt_command</a> command for
6188 possible <code class="literal">printf(3)</code>-like sequences.
6190 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-sign-command"></a>3.255. smime_sign_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6191 Default: (empty)</p></div><p>
6192 This command is used to created S/MIME signatures of type
6193 <code class="literal">multipart/signed</code>, which can be read by all mail clients.
6195 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.243. smime_decrypt_command">$smime_decrypt_command</a> command for
6196 possible <code class="literal">printf(3)</code>-like sequences.
6198 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-sign-opaque-command"></a>3.256. smime_sign_opaque_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6199 Default: (empty)</p></div><p>
6200 This command is used to created S/MIME signatures of type
6201 <code class="literal">application/x-pkcs7-signature</code>, which can only be handled by mail
6202 clients supporting the S/MIME extension.
6204 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.243. smime_decrypt_command">$smime_decrypt_command</a> command for
6205 possible <code class="literal">printf(3)</code>-like sequences.
6207 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-timeout"></a>3.257. smime_timeout</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6208 Default: 300</p></div><p>
6209 The number of seconds after which a cached passphrase will expire if
6212 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-verify-command"></a>3.258. smime_verify_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6213 Default: (empty)</p></div><p>
6214 This command is used to verify S/MIME signatures of type <code class="literal">multipart/signed</code>.
6216 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.243. smime_decrypt_command">$smime_decrypt_command</a> command for
6217 possible <code class="literal">printf(3)</code>-like sequences.
6219 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-verify-opaque-command"></a>3.259. smime_verify_opaque_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6220 Default: (empty)</p></div><p>
6221 This command is used to verify S/MIME signatures of type
6222 <code class="literal">application/x-pkcs7-mime</code>.
6224 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.243. smime_decrypt_command">$smime_decrypt_command</a> command for
6225 possible <code class="literal">printf(3)</code>-like sequences.
6227 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smtp-authenticators"></a>3.260. smtp_authenticators</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6228 Default: (empty)</p></div><p>
6229 This is a colon-delimited list of authentication methods mutt may
6230 attempt to use to log in to an SMTP server, in the order mutt should
6231 try them. Authentication methods are any SASL mechanism, eg
6232 “<span class="quote">digest-md5</span>”, “<span class="quote">gssapi</span>” or “<span class="quote">cram-md5</span>”.
6233 This option is case-insensitive. If it is “<span class="quote">unset</span>”
6234 (the default) mutt will try all available methods, in order from
6235 most-secure to least-secure.
6239 </p><pre class="screen">
6240 set smtp_authenticators="digest-md5:cram-md5"
6241 </pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smtp-pass"></a>3.261. smtp_pass</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6242 Default: (empty)</p></div><p>
6243 Specifies the password for your SMTP account. If <span class="emphasis"><em>unset</em></span>, Mutt will
6244 prompt you for your password when you first send mail via SMTP.
6245 See <a class="link" href="#smtp-url" title="3.262. smtp_url">$smtp_url</a> to configure mutt to send mail via SMTP.
6247 <span class="bold"><strong>Warning</strong></span>: you should only use this option when you are on a
6248 fairly secure machine, because the superuser can read your muttrc even
6249 if you are the only one who can read the file.
6250 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smtp-url"></a>3.262. smtp_url</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6251 Default: (empty)</p></div><p>
6252 Defines the SMTP smarthost where sent messages should relayed for
6253 delivery. This should take the form of an SMTP URL, eg:
6255 </p><pre class="screen">
6256 smtp[s]://[user[:pass]@]host[:port]/
6258 where “<span class="quote">[...]</span>” denotes an optional part.
6259 Setting this variable overrides the value of the <a class="link" href="#sendmail" title="3.230. sendmail">$sendmail</a>
6261 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sort"></a>3.263. sort</h3></div></div></div><div class="literallayout"><p>Type: sort order<br />
6262 Default: date</p></div><p>
6263 Specifies how to sort messages in the “<span class="quote">index</span>” menu. Valid values
6266 </p><div class="itemizedlist"><ul type="disc"><li><p>date or date-sent
6267 </p></li><li><p>date-received
6268 </p></li><li><p>from
6269 </p></li><li><p>mailbox-order (unsorted)
6270 </p></li><li><p>score
6271 </p></li><li><p>size
6272 </p></li><li><p>spam
6273 </p></li><li><p>subject
6274 </p></li><li><p>threads
6276 </p></li></ul></div><p>
6277 You may optionally use the “<span class="quote">reverse-</span>” prefix to specify reverse sorting
6278 order (example: “<span class="quote"><code class="literal">set sort=reverse-date-sent</code></span>”).
6279 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sort-alias"></a>3.264. sort_alias</h3></div></div></div><div class="literallayout"><p>Type: sort order<br />
6280 Default: alias</p></div><p>
6281 Specifies how the entries in the “<span class="quote">alias</span>” menu are sorted. The
6282 following are legal values:
6284 </p><div class="itemizedlist"><ul type="disc"><li><p>address (sort alphabetically by email address)
6285 </p></li><li><p>alias (sort alphabetically by alias name)
6286 </p></li><li><p>unsorted (leave in order specified in .muttrc)
6287 </p></li></ul></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sort-aux"></a>3.265. sort_aux</h3></div></div></div><div class="literallayout"><p>Type: sort order<br />
6288 Default: date</p></div><p>
6289 When sorting by threads, this variable controls how threads are sorted
6290 in relation to other threads, and how the branches of the thread trees
6291 are sorted. This can be set to any value that <a class="link" href="#sort" title="3.263. sort">$sort</a> can, except
6292 “<span class="quote">threads</span>” (in that case, mutt will just use “<span class="quote">date-sent</span>”). You can also
6293 specify the “<span class="quote">last-</span>” prefix in addition to the “<span class="quote">reverse-</span>” prefix, but “<span class="quote">last-</span>”
6294 must come after “<span class="quote">reverse-</span>”. The “<span class="quote">last-</span>” prefix causes messages to be
6295 sorted against its siblings by which has the last descendant, using
6296 the rest of <a class="link" href="#sort-aux" title="3.265. sort_aux">$sort_aux</a> as an ordering. For instance,
6298 </p><pre class="screen">
6299 set sort_aux=last-date-received
6301 would mean that if a new message is received in a
6302 thread, that thread becomes the last one displayed (or the first, if
6303 you have “<span class="quote"><code class="literal">set sort=reverse-threads</code></span>”.)
6305 Note: For reversed <a class="link" href="#sort" title="3.263. sort">$sort</a>
6306 order <a class="link" href="#sort-aux" title="3.265. sort_aux">$sort_aux</a> is reversed again (which is not the right thing to do,
6307 but kept to not break any existing configuration setting).
6308 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sort-browser"></a>3.266. sort_browser</h3></div></div></div><div class="literallayout"><p>Type: sort order<br />
6309 Default: alpha</p></div><p>
6310 Specifies how to sort entries in the file browser. By default, the
6311 entries are sorted alphabetically. Valid values:
6313 </p><div class="itemizedlist"><ul type="disc"><li><p>alpha (alphabetically)
6314 </p></li><li><p>date
6315 </p></li><li><p>size
6316 </p></li><li><p>unsorted
6317 </p></li></ul></div><p>
6318 You may optionally use the “<span class="quote">reverse-</span>” prefix to specify reverse sorting
6319 order (example: “<span class="quote"><code class="literal">set sort_browser=reverse-date</code></span>”).
6320 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sort-re"></a>3.267. sort_re</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6321 Default: yes</p></div><p>
6322 This variable is only useful when sorting by threads with
6323 <a class="link" href="#strict-threads" title="3.284. strict_threads">$strict_threads</a> <span class="emphasis"><em>unset</em></span>. In that case, it changes the heuristic
6324 mutt uses to thread messages by subject. With <a class="link" href="#sort-re" title="3.267. sort_re">$sort_re</a> <span class="emphasis"><em>set</em></span>, mutt will
6325 only attach a message as the child of another message by subject if
6326 the subject of the child message starts with a substring matching the
6327 setting of <a class="link" href="#reply-regexp" title="3.212. reply_regexp">$reply_regexp</a>. With <a class="link" href="#sort-re" title="3.267. sort_re">$sort_re</a> <span class="emphasis"><em>unset</em></span>, mutt will attach
6328 the message whether or not this is the case, as long as the
6329 non-<a class="link" href="#reply-regexp" title="3.212. reply_regexp">$reply_regexp</a> parts of both messages are identical.
6330 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="spam-separator"></a>3.268. spam_separator</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6331 Default: “<span class="quote"><code class="literal">,</code></span>”</p></div><p>
6332 This variable controls what happens when multiple spam headers
6333 are matched: if <span class="emphasis"><em>unset</em></span>, each successive header will overwrite any
6334 previous matches value for the spam label. If <span class="emphasis"><em>set</em></span>, each successive
6335 match will append to the previous, using this variable's value as a
6337 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="spoolfile"></a>3.269. spoolfile</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6338 Default: (empty)</p></div><p>
6339 If your spool mailbox is in a non-default place where Mutt cannot find
6340 it, you can specify its location with this variable. Mutt will
6341 initially set this variable to the value of the environment
6342 variable <code class="literal">$MAIL</code> or <code class="literal">$MAILDIR</code> if either is defined.
6343 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-ca-certificates-file"></a>3.270. ssl_ca_certificates_file</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6344 Default: (empty)</p></div><p>
6345 This variable specifies a file containing trusted CA certificates.
6346 Any server certificate that is signed with one of these CA
6347 certificates is also automatically accepted.
6351 </p><pre class="screen">
6352 set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt
6353 </pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-client-cert"></a>3.271. ssl_client_cert</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6354 Default: (empty)</p></div><p>
6355 The file containing a client certificate and its associated private
6357 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-force-tls"></a>3.272. ssl_force_tls</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6358 Default: no</p></div><p>
6359 If this variable is <span class="emphasis"><em>set</em></span>, Mutt will require that all connections
6360 to remote servers be encrypted. Furthermore it will attempt to
6361 negotiate TLS even if the server does not advertise the capability,
6362 since it would otherwise have to abort the connection anyway. This
6363 option supersedes <a class="link" href="#ssl-starttls" title="3.274. ssl_starttls">$ssl_starttls</a>.
6364 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-min-dh-prime-bits"></a>3.273. ssl_min_dh_prime_bits</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6365 Default: 0</p></div><p>
6366 This variable specifies the minimum acceptable prime size (in bits)
6367 for use in any Diffie-Hellman key exchange. A value of 0 will use
6368 the default from the GNUTLS library.
6369 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-starttls"></a>3.274. ssl_starttls</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
6370 Default: yes</p></div><p>
6371 If <span class="emphasis"><em>set</em></span> (the default), mutt will attempt to use <code class="literal">STARTTLS</code> on servers
6372 advertising the capability. When <span class="emphasis"><em>unset</em></span>, mutt will not attempt to
6373 use <code class="literal">STARTTLS</code> regardless of the server's capabilities.
6374 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-use-sslv2"></a>3.275. ssl_use_sslv2</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6375 Default: no</p></div><p>
6376 This variable specifies whether to attempt to use SSLv2 in the
6377 SSL authentication process.
6378 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-use-sslv3"></a>3.276. ssl_use_sslv3</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6379 Default: yes</p></div><p>
6380 This variable specifies whether to attempt to use SSLv3 in the
6381 SSL authentication process.
6382 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-use-tlsv1"></a>3.277. ssl_use_tlsv1</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6383 Default: yes</p></div><p>
6384 This variable specifies whether to attempt to use TLSv1 in the
6385 SSL authentication process.
6386 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-usesystemcerts"></a>3.278. ssl_usesystemcerts</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6387 Default: yes</p></div><p>
6388 If set to <span class="emphasis"><em>yes</em></span>, mutt will use CA certificates in the
6389 system-wide certificate store when checking if a server certificate
6390 is signed by a trusted CA.
6391 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-verify-dates"></a>3.279. ssl_verify_dates</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6392 Default: yes</p></div><p>
6393 If <span class="emphasis"><em>set</em></span> (the default), mutt will not automatically accept a server
6394 certificate that is either not yet valid or already expired. You should
6395 only unset this for particular known hosts, using the
6396 <code class="literal"><a class="link" href="#account-hook" title="6. Managing Multiple Accounts"><account-hook></a></code> function.
6397 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-verify-host"></a>3.280. ssl_verify_host</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6398 Default: yes</p></div><p>
6399 If <span class="emphasis"><em>set</em></span> (the default), mutt will not automatically accept a server
6400 certificate whose host name does not match the host used in your folder
6401 URL. You should only unset this for particular known hosts, using
6402 the <code class="literal"><a class="link" href="#account-hook" title="6. Managing Multiple Accounts"><account-hook></a></code> function.
6403 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="status-chars"></a>3.281. status_chars</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6404 Default: “<span class="quote"><code class="literal">-*%A</code></span>”</p></div><p>
6405 Controls the characters used by the “<span class="quote">%r</span>” indicator in
6406 <a class="link" href="#status-format" title="3.282. status_format">$status_format</a>. The first character is used when the mailbox is
6407 unchanged. The second is used when the mailbox has been changed, and
6408 it needs to be resynchronized. The third is used if the mailbox is in
6409 read-only mode, or if the mailbox will not be written when exiting
6410 that mailbox (You can toggle whether to write changes to a mailbox
6411 with the <code class="literal"><toggle-write></code> operation, bound by default to “<span class="quote">%</span>”). The fourth
6412 is used to indicate that the current folder has been opened in attach-
6413 message mode (Certain operations like composing a new mail, replying,
6414 forwarding, etc. are not permitted in this mode).
6415 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="status-format"></a>3.282. status_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6416 Default: “<span class="quote"><code class="literal">-%r-Mutt: %f [Msgs:%?M?%M/?%m%?n? New:%n?%?o? Old:%o?%?d? Del:%d?%?F? Flag:%F?%?t? Tag:%t?%?p? Post:%p?%?b? Inc:%b?%?l? %l?]---(%s/%S)-%>-(%P)---</code></span>”</p></div><p>
6417 Controls the format of the status line displayed in the “<span class="quote">index</span>”
6418 menu. This string is similar to <a class="link" href="#index-format" title="3.114. index_format">$index_format</a>, but has its own
6419 set of <code class="literal">printf(3)</code>-like sequences:
6421 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>%b </td><td>number of mailboxes with new mail *
6422 </td></tr><tr><td>%d </td><td>number of deleted messages *
6423 </td></tr><tr><td>%f </td><td>the full pathname of the current mailbox
6424 </td></tr><tr><td>%F </td><td>number of flagged messages *
6425 </td></tr><tr><td>%h </td><td>local hostname
6426 </td></tr><tr><td>%l </td><td>size (in bytes) of the current mailbox *
6427 </td></tr><tr><td>%L </td><td>size (in bytes) of the messages shown
6428 (i.e., which match the current limit) *
6429 </td></tr><tr><td>%m </td><td>the number of messages in the mailbox *
6430 </td></tr><tr><td>%M </td><td>the number of messages shown (i.e., which match the current limit) *
6431 </td></tr><tr><td>%n </td><td>number of new messages in the mailbox *
6432 </td></tr><tr><td>%o </td><td>number of old unread messages *
6433 </td></tr><tr><td>%p </td><td>number of postponed messages *
6434 </td></tr><tr><td>%P </td><td>percentage of the way through the index
6435 </td></tr><tr><td>%r </td><td>modified/read-only/won't-write/attach-message indicator,
6436 according to <a class="link" href="#status-chars" title="3.281. status_chars">$status_chars</a>
6437 </td></tr><tr><td>%s </td><td>current sorting mode (<a class="link" href="#sort" title="3.263. sort">$sort</a>)
6438 </td></tr><tr><td>%S </td><td>current aux sorting method (<a class="link" href="#sort-aux" title="3.265. sort_aux">$sort_aux</a>)
6439 </td></tr><tr><td>%t </td><td>number of tagged messages *
6440 </td></tr><tr><td>%u </td><td>number of unread messages *
6441 </td></tr><tr><td>%v </td><td>Mutt version string
6442 </td></tr><tr><td>%V </td><td>currently active limit pattern, if any *
6443 </td></tr><tr><td>%>X </td><td>right justify the rest of the string and pad with “<span class="quote">X</span>”
6444 </td></tr><tr><td>%|X </td><td>pad to the end of the line with “<span class="quote">X</span>”
6445 </td></tr><tr><td>%*X </td><td>soft-fill with character “<span class="quote">X</span>” as pad
6446 </td></tr></tbody></table></div><p>
6447 For an explanation of “<span class="quote">soft-fill</span>”, see the <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> documentation.
6449 * = can be optionally printed if nonzero
6451 Some of the above sequences can be used to optionally print a string
6452 if their value is nonzero. For example, you may only want to see the
6453 number of flagged messages if such messages exist, since zero is not
6454 particularly meaningful. To optionally print a string based upon one
6455 of the above sequences, the following construct is used:
6457 <code class="literal">%?<sequence_char>?<optional_string>?</code>
6459 where <span class="emphasis"><em>sequence_char</em></span> is a character from the table above, and
6460 <span class="emphasis"><em>optional_string</em></span> is the string you would like printed if
6461 <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
6462 other sequences as well as normal text, but you may <span class="bold"><strong>not</strong></span> nest
6465 Here is an example illustrating how to optionally print the number of
6466 new messages in a mailbox:
6468 <code class="literal">%?n?%n new messages.?</code>
6470 You can also switch between two strings using the following construct:
6472 <code class="literal">%?<sequence_char>?<if_string>&<else_string>?</code>
6474 If the value of <span class="emphasis"><em>sequence_char</em></span> is non-zero, <span class="emphasis"><em>if_string</em></span> will
6475 be expanded, otherwise <span class="emphasis"><em>else_string</em></span> will be expanded.
6477 You can force the result of any <code class="literal">printf(3)</code>-like sequence to be lowercase
6478 by prefixing the sequence character with an underscore (“<span class="quote">_</span>”) sign.
6479 For example, if you want to display the local hostname in lowercase,
6480 you would use: “<span class="quote"><code class="literal">%_h</code></span>”.
6482 If you prefix the sequence character with a colon (“<span class="quote">:</span>”) character, mutt
6483 will replace any dots in the expansion by underscores. This might be helpful
6484 with IMAP folders that don't like dots in folder names.
6485 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="status-on-top"></a>3.283. status_on_top</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6486 Default: no</p></div><p>
6487 Setting this variable causes the “<span class="quote">status bar</span>” to be displayed on
6488 the first line of the screen rather than near the bottom. If <a class="link" href="#help" title="3.82. help">$help</a>
6489 is <span class="emphasis"><em>set</em></span>, too it'll be placed at the bottom.
6490 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="strict-threads"></a>3.284. strict_threads</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6491 Default: no</p></div><p>
6492 If <span class="emphasis"><em>set</em></span>, threading will only make use of the “<span class="quote">In-Reply-To</span>” and
6493 “<span class="quote">References:</span>” fields when you <a class="link" href="#sort" title="3.263. sort">$sort</a> by message threads. By
6494 default, messages with the same subject are grouped together in
6495 “<span class="quote">pseudo threads.</span>”. This may not always be desirable, such as in a
6496 personal mailbox where you might have several unrelated messages with
6497 the subjects like “<span class="quote">hi</span>” which will get grouped together. See also
6498 <a class="link" href="#sort-re" title="3.267. sort_re">$sort_re</a> for a less drastic way of controlling this
6500 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="suspend"></a>3.285. suspend</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6501 Default: yes</p></div><p>
6502 When <span class="emphasis"><em>unset</em></span>, mutt won't stop when the user presses the terminal's
6503 <span class="emphasis"><em>susp</em></span> key, usually “<span class="quote">^Z</span>”. This is useful if you run mutt
6504 inside an xterm using a command like “<span class="quote"><code class="literal">xterm -e mutt</code></span>”.
6505 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="text-flowed"></a>3.286. text_flowed</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6506 Default: no</p></div><p>
6507 When <span class="emphasis"><em>set</em></span>, mutt will generate “<span class="quote">format=flowed</span>” bodies with a content type
6508 of “<span class="quote"><code class="literal">text/plain; format=flowed</code></span>”.
6509 This format is easier to handle for some mailing software, and generally
6510 just looks like ordinary text. To actually make use of this format's
6511 features, you'll need support in your editor.
6513 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>.
6514 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="thorough-search"></a>3.287. thorough_search</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6515 Default: no</p></div><p>
6516 Affects the <code class="literal">˜b</code> and <code class="literal">˜h</code> search operations described in
6517 section “<span class="quote"><a class="link" href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">patterns</a></span>”. If <span class="emphasis"><em>set</em></span>, the headers and body/attachments of
6518 messages to be searched are decoded before searching. If <span class="emphasis"><em>unset</em></span>,
6519 messages are searched as they appear in the folder.
6521 Users searching attachments or for non-ASCII characters should <span class="emphasis"><em>set</em></span>
6522 this value because decoding also includes MIME parsing/decoding and possible
6523 character set conversions. Otherwise mutt will attempt to match against the
6524 raw message received (for example quoted-printable encoded or with encoded
6525 headers) which may lead to incorrect search results.
6526 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="thread-received"></a>3.288. thread_received</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6527 Default: no</p></div><p>
6528 When <span class="emphasis"><em>set</em></span>, mutt uses the date received rather than the date sent
6529 to thread messages by subject.
6530 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="tilde"></a>3.289. tilde</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6531 Default: no</p></div><p>
6532 When <span class="emphasis"><em>set</em></span>, the internal-pager will pad blank lines to the bottom of the
6533 screen with a tilde (“<span class="quote">˜</span>”).
6534 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="time-inc"></a>3.290. time_inc</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6535 Default: 0</p></div><p>
6536 Along with <a class="link" href="#read-inc" title="3.207. read_inc">$read_inc</a>, <a class="link" href="#write-inc" title="3.310. write_inc">$write_inc</a>, and <a class="link" href="#net-inc" title="3.147. net_inc">$net_inc</a>, this
6537 variable controls the frequency with which progress updates are
6538 displayed. It suppresses updates less than <a class="link" href="#time-inc" title="3.290. time_inc">$time_inc</a> milliseconds
6539 apart. This can improve throughput on systems with slow terminals,
6540 or when running mutt on a remote system.
6542 Also see the “<span class="quote"><a class="link" href="#tuning" title="Chapter 8. Performance Tuning">tuning</a></span>” section of the manual for performance considerations.
6543 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="timeout"></a>3.291. timeout</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6544 Default: 600</p></div><p>
6545 When Mutt is waiting for user input either idleing in menus or
6546 in an interactive prompt, Mutt would block until input is
6547 present. Depending on the context, this would prevent certain
6548 operations from working, like checking for new mail or keeping
6549 an IMAP connection alive.
6551 This variable controls how many seconds Mutt will at most wait
6552 until it aborts waiting for input, performs these operations and
6553 continues to wait for input.
6555 A value of zero or less will cause Mutt to never time out.
6556 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="tmpdir"></a>3.292. tmpdir</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6557 Default: (empty)</p></div><p>
6558 This variable allows you to specify where Mutt will place its
6559 temporary files needed for displaying and composing messages. If
6560 this variable is not set, the environment variable <code class="literal">$TMPDIR</code> is
6561 used. If <code class="literal">$TMPDIR</code> is not set then “<span class="quote"><code class="literal">/tmp</code></span>” is used.
6562 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="to-chars"></a>3.293. to_chars</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6563 Default: “<span class="quote"><code class="literal"> +TCFL</code></span>”</p></div><p>
6564 Controls the character used to indicate mail addressed to you. The
6565 first character is the one used when the mail is <span class="emphasis"><em>not</em></span> addressed to your
6566 address. The second is used when you are the only
6567 recipient of the message. The third is when your address
6568 appears in the “<span class="quote">To:</span>” header field, but you are not the only recipient of
6569 the message. The fourth character is used when your
6570 address is specified in the “<span class="quote">Cc:</span>” header field, but you are not the only
6571 recipient. The fifth character is used to indicate mail that was sent
6572 by <span class="emphasis"><em>you</em></span>. The sixth character is used to indicate when a mail
6573 was sent to a mailing-list you subscribe to.
6574 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="tunnel"></a>3.294. tunnel</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6575 Default: (empty)</p></div><p>
6576 Setting this variable will cause mutt to open a pipe to a command
6577 instead of a raw socket. You may be able to use this to set up
6578 preauthenticated connections to your IMAP/POP3/SMTP server. Example:
6580 </p><pre class="screen">
6581 set tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"
6583 Note: For this example to work you must be able to log in to the remote
6584 machine without having to enter a password.
6586 When set, Mutt uses the tunnel for all remote connections.
6587 Please see “<span class="quote"><a class="link" href="#account-hook" title="6. Managing Multiple Accounts">account-hook</a></span>” in the manual for how to use different
6588 tunnel commands per connection.
6589 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="uncollapse-jump"></a>3.295. uncollapse_jump</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6590 Default: no</p></div><p>
6591 When <span class="emphasis"><em>set</em></span>, Mutt will jump to the next unread message, if any,
6592 when the current thread is <span class="emphasis"><em>un</em></span>collapsed.
6593 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="use-8bitmime"></a>3.296. use_8bitmime</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6594 Default: no</p></div><p>
6595 <span class="bold"><strong>Warning:</strong></span> do not set this variable unless you are using a version
6596 of sendmail which supports the <code class="literal">-B8BITMIME</code> flag (such as sendmail
6597 8.8.x) or you may not be able to send mail.
6599 When <span class="emphasis"><em>set</em></span>, Mutt will invoke <a class="link" href="#sendmail" title="3.230. sendmail">$sendmail</a> with the <code class="literal">-B8BITMIME</code>
6600 flag when sending 8-bit messages to enable ESMTP negotiation.
6601 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="use-domain"></a>3.297. use_domain</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6602 Default: yes</p></div><p>
6603 When <span class="emphasis"><em>set</em></span>, Mutt will qualify all local addresses (ones without the
6604 “<span class="quote">@host</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
6605 addresses will be qualified.
6606 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="use-envelope-from"></a>3.298. use_envelope_from</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6607 Default: no</p></div><p>
6608 When <span class="emphasis"><em>set</em></span>, mutt will set the <span class="emphasis"><em>envelope</em></span> sender of the message.
6609 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
6610 address. If <span class="emphasis"><em>unset</em></span>, mutt will attempt to derive the sender from the
6611 “<span class="quote">From:</span>” header.
6613 Note that this information is passed to sendmail command using the
6614 <code class="literal">-f</code> command line switch. Therefore setting this option is not useful
6615 if the <a class="link" href="#sendmail" title="3.230. sendmail">$sendmail</a> variable already contains <code class="literal">-f</code> or if the
6616 executable pointed to by <a class="link" href="#sendmail" title="3.230. sendmail">$sendmail</a> doesn't support the <code class="literal">-f</code> switch.
6617 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="use-from"></a>3.299. use_from</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6618 Default: yes</p></div><p>
6619 When <span class="emphasis"><em>set</em></span>, Mutt will generate the “<span class="quote">From:</span>” header field when
6620 sending messages. If <span class="emphasis"><em>unset</em></span>, no “<span class="quote">From:</span>” header field will be
6621 generated unless the user explicitly sets one using the “<span class="quote"><a class="link" href="#my-hdr" title="15. User-Defined Headers">my_hdr</a></span>”
6623 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="use-idn"></a>3.300. use_idn</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6624 Default: yes</p></div><p>
6625 When <span class="emphasis"><em>set</em></span>, Mutt will show you international domain names decoded.
6626 Note: You can use IDNs for addresses even if this is <span class="emphasis"><em>unset</em></span>.
6627 This variable only affects decoding.
6628 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="use-ipv6"></a>3.301. use_ipv6</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6629 Default: yes</p></div><p>
6630 When <span class="emphasis"><em>set</em></span>, Mutt will look for IPv6 addresses of hosts it tries to
6631 contact. If this option is <span class="emphasis"><em>unset</em></span>, Mutt will restrict itself to IPv4 addresses.
6632 Normally, the default should work.
6633 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="user-agent"></a>3.302. user_agent</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6634 Default: yes</p></div><p>
6635 When <span class="emphasis"><em>set</em></span>, mutt will add a “<span class="quote">User-Agent:</span>” header to outgoing
6636 messages, indicating which version of mutt was used for composing
6638 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="visual"></a>3.303. visual</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6639 Default: (empty)</p></div><p>
6640 Specifies the visual editor to invoke when the “<span class="quote"><code class="literal">˜v</code></span>” command is
6641 given in the builtin editor.
6642 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="wait-key"></a>3.304. wait_key</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6643 Default: yes</p></div><p>
6644 Controls whether Mutt will ask you to press a key after an external command
6645 has been invoked by these functions: <code class="literal"><shell-escape></code>,
6646 <code class="literal"><pipe-message></code>, <code class="literal"><pipe-entry></code>, <code class="literal"><print-message></code>,
6647 and <code class="literal"><print-entry></code> commands.
6649 It is also used when viewing attachments with “<span class="quote"><a class="link" href="#auto-view" title="4. MIME Autoview">auto_view</a></span>”, provided
6650 that the corresponding mailcap entry has a <span class="emphasis"><em>needsterminal</em></span> flag,
6651 and the external program is interactive.
6653 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
6654 for a key only if the external command returned a non-zero status.
6655 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="weed"></a>3.305. weed</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6656 Default: yes</p></div><p>
6657 When <span class="emphasis"><em>set</em></span>, mutt will weed headers when displaying, forwarding,
6658 printing, or replying to messages.
6659 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="wrap"></a>3.306. wrap</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6660 Default: 0</p></div><p>
6661 When set to a positive value, mutt will wrap text at <a class="link" href="#wrap" title="3.306. wrap">$wrap</a> characters.
6662 When set to a negative value, mutt will wrap text so that there are <a class="link" href="#wrap" title="3.306. wrap">$wrap</a>
6663 characters of empty space on the right side of the terminal.
6664 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="wrap-search"></a>3.307. wrap_search</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6665 Default: yes</p></div><p>
6666 Controls whether searches wrap around the end.
6668 When <span class="emphasis"><em>set</em></span>, searches will wrap around the first (or last) item. When
6669 <span class="emphasis"><em>unset</em></span>, incremental searches will not wrap.
6670 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="wrapmargin"></a>3.308. wrapmargin</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6671 Default: 0</p></div><p>
6672 (DEPRECATED) Equivalent to setting <a class="link" href="#wrap" title="3.306. wrap">$wrap</a> with a negative value.
6673 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="write-bcc"></a>3.309. write_bcc</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6674 Default: yes</p></div><p>
6675 Controls whether mutt writes out the “<span class="quote">Bcc:</span>” header when preparing
6676 messages to be sent. Exim users may wish to unset this. If mutt
6677 is set to deliver directly via SMTP (see <a class="link" href="#smtp-url" title="3.262. smtp_url">$smtp_url</a>), this
6678 option does nothing: mutt will never write out the “<span class="quote">Bcc:</span>” header
6680 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="write-inc"></a>3.310. write_inc</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6681 Default: 10</p></div><p>
6682 When writing a mailbox, a message will be printed every
6683 <a class="link" href="#write-inc" title="3.310. write_inc">$write_inc</a> messages to indicate progress. If set to 0, only a
6684 single message will be displayed before writing a mailbox.
6686 Also see the <a class="link" href="#read-inc" title="3.207. read_inc">$read_inc</a>, <a class="link" href="#net-inc" title="3.147. net_inc">$net_inc</a> and <a class="link" href="#time-inc" title="3.290. time_inc">$time_inc</a> variables and the
6687 “<span class="quote"><a class="link" href="#tuning" title="Chapter 8. Performance Tuning">tuning</a></span>” section of the manual for performance considerations.
6688 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="functions"></a>4. Functions</h2></div></div></div><p>
6689 The following is the list of available functions listed by the mapping
6690 in which they are available. The default key setting is given, and an
6691 explanation of what the function does. The key bindings of these
6692 functions can be changed with the <a class="link" href="#bind" title="5. Changing the Default Key Bindings">bind</a>
6694 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="generic-map"></a>4.1. Generic Menu</h3></div></div></div><p>
6695 The <span class="emphasis"><em>generic</em></span> menu is not a real menu, but specifies common functions
6696 (such as movement) available in all menus except for <span class="emphasis"><em>pager</em></span> and
6697 <span class="emphasis"><em>editor</em></span>. Changing settings for this menu will affect the default
6698 bindings for all menus (except as noted).
6699 </p><div class="table"><a id="generic-table"></a><p class="title"><b>Table 9.2. Default generic Function Bindings</b></p><div class="table-contents"><table summary="Default generic Function Bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><top-page></code></td><td>H</td><td>move to the top of the page</td></tr><tr><td><code class="literal"><next-entry></code></td><td>j</td><td>move to the next entry</td></tr><tr><td><code class="literal"><previous-entry></code></td><td>k</td><td>move to the previous entry</td></tr><tr><td><code class="literal"><bottom-page></code></td><td>L</td><td>move to the bottom of the page</td></tr><tr><td><code class="literal"><refresh></code></td><td>^L</td><td>clear and redraw the screen</td></tr><tr><td><code class="literal"><middle-page></code></td><td>M</td><td>move to the middle of the page</td></tr><tr><td><code class="literal"><search-next></code></td><td>n</td><td>search for next match</td></tr><tr><td><code class="literal"><exit></code></td><td>q</td><td>exit this menu</td></tr><tr><td><code class="literal"><tag-entry></code></td><td>t</td><td>tag the current entry</td></tr><tr><td><code class="literal"><next-page></code></td><td>z</td><td>move to the next page</td></tr><tr><td><code class="literal"><previous-page></code></td><td>Z</td><td>move to the previous page</td></tr><tr><td><code class="literal"><last-entry></code></td><td>*</td><td>move to the last entry</td></tr><tr><td><code class="literal"><first-entry></code></td><td>=</td><td>move to the first entry</td></tr><tr><td><code class="literal"><enter-command></code></td><td>:</td><td>enter a muttrc command</td></tr><tr><td><code class="literal"><next-line></code></td><td>></td><td>scroll down one line</td></tr><tr><td><code class="literal"><previous-line></code></td><td><</td><td>scroll up one line</td></tr><tr><td><code class="literal"><half-up></code></td><td>[</td><td>scroll up 1/2 page</td></tr><tr><td><code class="literal"><half-down></code></td><td>]</td><td>scroll down 1/2 page</td></tr><tr><td><code class="literal"><help></code></td><td>?</td><td>this screen</td></tr><tr><td><code class="literal"><tag-prefix></code></td><td>;</td><td>apply next function to tagged messages</td></tr><tr><td><code class="literal"><tag-prefix-cond></code></td><td> </td><td>apply next function ONLY to tagged messages</td></tr><tr><td><code class="literal"><end-cond></code></td><td> </td><td>end of conditional execution (noop)</td></tr><tr><td><code class="literal"><shell-escape></code></td><td>!</td><td>invoke a command in a subshell</td></tr><tr><td><code class="literal"><select-entry></code></td><td><Return></td><td>select the current entry</td></tr><tr><td><code class="literal"><search></code></td><td>/</td><td>search for a regular expression</td></tr><tr><td><code class="literal"><search-reverse></code></td><td>Esc /</td><td>search backwards for a regular expression</td></tr><tr><td><code class="literal"><search-opposite></code></td><td> </td><td>search for next match in opposite direction</td></tr><tr><td><code class="literal"><jump></code></td><td> </td><td>jump to an index number</td></tr><tr><td><code class="literal"><current-top></code></td><td> </td><td>move entry to top of screen</td></tr><tr><td><code class="literal"><current-middle></code></td><td> </td><td>move entry to middle of screen</td></tr><tr><td><code class="literal"><current-bottom></code></td><td> </td><td>move entry to bottom of screen</td></tr><tr><td><code class="literal"><what-key></code></td><td> </td><td>display the keycode for a key press</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="index-map"></a>4.2. Index Menu</h3></div></div></div><div class="table"><a id="index-table"></a><p class="title"><b>Table 9.3. Default index Function Bindings</b></p><div class="table-contents"><table summary="Default index Function Bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><create-alias></code></td><td>a</td><td>create an alias from a message sender</td></tr><tr><td><code class="literal"><bounce-message></code></td><td>b</td><td>remail a message to another user</td></tr><tr><td><code class="literal"><break-thread></code></td><td>#</td><td>break the thread in two</td></tr><tr><td><code class="literal"><change-folder></code></td><td>c</td><td>open a different folder</td></tr><tr><td><code class="literal"><change-folder-readonly></code></td><td>Esc c</td><td>open a different folder in read only mode</td></tr><tr><td><code class="literal"><next-unread-mailbox></code></td><td> </td><td>open next mailbox with new mail</td></tr><tr><td><code class="literal"><collapse-thread></code></td><td>Esc v</td><td>collapse/uncollapse current thread</td></tr><tr><td><code class="literal"><collapse-all></code></td><td>Esc V</td><td>collapse/uncollapse all threads</td></tr><tr><td><code class="literal"><copy-message></code></td><td>C</td><td>copy a message to a file/mailbox</td></tr><tr><td><code class="literal"><decode-copy></code></td><td>Esc C</td><td>make decoded (text/plain) copy</td></tr><tr><td><code class="literal"><decode-save></code></td><td>Esc s</td><td>make decoded copy (text/plain) and delete</td></tr><tr><td><code class="literal"><delete-message></code></td><td>d</td><td>delete the current entry</td></tr><tr><td><code class="literal"><delete-pattern></code></td><td>D</td><td>delete messages matching a pattern</td></tr><tr><td><code class="literal"><delete-thread></code></td><td>^D</td><td>delete all messages in thread</td></tr><tr><td><code class="literal"><delete-subthread></code></td><td>Esc d</td><td>delete all messages in subthread</td></tr><tr><td><code class="literal"><edit></code></td><td>e</td><td>edit the raw message</td></tr><tr><td><code class="literal"><edit-type></code></td><td>^E</td><td>edit attachment content type</td></tr><tr><td><code class="literal"><forward-message></code></td><td>f</td><td>forward a message with comments</td></tr><tr><td><code class="literal"><flag-message></code></td><td>F</td><td>toggle a message's 'important' flag</td></tr><tr><td><code class="literal"><group-reply></code></td><td>g</td><td>reply to all recipients</td></tr><tr><td><code class="literal"><fetch-mail></code></td><td>G</td><td>retrieve mail from POP server</td></tr><tr><td><code class="literal"><imap-fetch-mail></code></td><td> </td><td>force retrieval of mail from IMAP server</td></tr><tr><td><code class="literal"><display-toggle-weed></code></td><td>h</td><td>display message and toggle header weeding</td></tr><tr><td><code class="literal"><next-undeleted></code></td><td>j</td><td>move to the next undeleted message</td></tr><tr><td><code class="literal"><previous-undeleted></code></td><td>k</td><td>move to the previous undeleted message</td></tr><tr><td><code class="literal"><limit></code></td><td>l</td><td>show only messages matching a pattern</td></tr><tr><td><code class="literal"><link-threads></code></td><td>&</td><td>link tagged message to the current one</td></tr><tr><td><code class="literal"><list-reply></code></td><td>L</td><td>reply to specified mailing list</td></tr><tr><td><code class="literal"><mail></code></td><td>m</td><td>compose a new mail message</td></tr><tr><td><code class="literal"><toggle-new></code></td><td>N</td><td>toggle a message's 'new' flag</td></tr><tr><td><code class="literal"><toggle-write></code></td><td>%</td><td>toggle whether the mailbox will be rewritten</td></tr><tr><td><code class="literal"><next-thread></code></td><td>^N</td><td>jump to the next thread</td></tr><tr><td><code class="literal"><next-subthread></code></td><td>Esc n</td><td>jump to the next subthread</td></tr><tr><td><code class="literal"><query></code></td><td>Q</td><td>query external program for addresses</td></tr><tr><td><code class="literal"><quit></code></td><td>q</td><td>save changes to mailbox and quit</td></tr><tr><td><code class="literal"><reply></code></td><td>r</td><td>reply to a message</td></tr><tr><td><code class="literal"><show-limit></code></td><td>Esc l</td><td>show currently active limit pattern</td></tr><tr><td><code class="literal"><sort-mailbox></code></td><td>o</td><td>sort messages</td></tr><tr><td><code class="literal"><sort-reverse></code></td><td>O</td><td>sort messages in reverse order</td></tr><tr><td><code class="literal"><print-message></code></td><td>p</td><td>print the current entry</td></tr><tr><td><code class="literal"><previous-thread></code></td><td>^P</td><td>jump to previous thread</td></tr><tr><td><code class="literal"><previous-subthread></code></td><td>Esc p</td><td>jump to previous subthread</td></tr><tr><td><code class="literal"><recall-message></code></td><td>R</td><td>recall a postponed message</td></tr><tr><td><code class="literal"><read-thread></code></td><td>^R</td><td>mark the current thread as read</td></tr><tr><td><code class="literal"><read-subthread></code></td><td>Esc r</td><td>mark the current subthread as read</td></tr><tr><td><code class="literal"><resend-message></code></td><td>Esc e</td><td>use the current message as a template for a new one</td></tr><tr><td><code class="literal"><save-message></code></td><td>s</td><td>save message/attachment to a mailbox/file</td></tr><tr><td><code class="literal"><tag-pattern></code></td><td>T</td><td>tag messages matching a pattern</td></tr><tr><td><code class="literal"><tag-subthread></code></td><td> </td><td>tag the current subthread</td></tr><tr><td><code class="literal"><tag-thread></code></td><td>Esc t</td><td>tag the current thread</td></tr><tr><td><code class="literal"><untag-pattern></code></td><td>^T</td><td>untag messages matching a pattern</td></tr><tr><td><code class="literal"><undelete-message></code></td><td>u</td><td>undelete the current entry</td></tr><tr><td><code class="literal"><undelete-pattern></code></td><td>U</td><td>undelete messages matching a pattern</td></tr><tr><td><code class="literal"><undelete-subthread></code></td><td>Esc u</td><td>undelete all messages in subthread</td></tr><tr><td><code class="literal"><undelete-thread></code></td><td>^U</td><td>undelete all messages in thread</td></tr><tr><td><code class="literal"><view-attachments></code></td><td>v</td><td>show MIME attachments</td></tr><tr><td><code class="literal"><show-version></code></td><td>V</td><td>show the Mutt version number and date</td></tr><tr><td><code class="literal"><set-flag></code></td><td>w</td><td>set a status flag on a message</td></tr><tr><td><code class="literal"><clear-flag></code></td><td>W</td><td>clear a status flag from a message</td></tr><tr><td><code class="literal"><display-message></code></td><td><Return></td><td>display a message</td></tr><tr><td><code class="literal"><buffy-list></code></td><td>.</td><td>list mailboxes with new mail</td></tr><tr><td><code class="literal"><sync-mailbox></code></td><td>$</td><td>save changes to mailbox</td></tr><tr><td><code class="literal"><display-address></code></td><td>@</td><td>display full address of sender</td></tr><tr><td><code class="literal"><pipe-message></code></td><td>|</td><td>pipe message/attachment to a shell command</td></tr><tr><td><code class="literal"><next-new></code></td><td> </td><td>jump to the next new message</td></tr><tr><td><code class="literal"><next-new-then-unread></code></td><td><Tab></td><td>jump to the next new or unread message</td></tr><tr><td><code class="literal"><previous-new></code></td><td> </td><td>jump to the previous new message</td></tr><tr><td><code class="literal"><previous-new-then-unread></code></td><td>Esc <Tab></td><td>jump to the previous new or unread message</td></tr><tr><td><code class="literal"><next-unread></code></td><td> </td><td>jump to the next unread message</td></tr><tr><td><code class="literal"><previous-unread></code></td><td> </td><td>jump to the previous unread message</td></tr><tr><td><code class="literal"><parent-message></code></td><td>P</td><td>jump to parent message in thread</td></tr><tr><td><code class="literal"><extract-keys></code></td><td>^K</td><td>extract supported public keys</td></tr><tr><td><code class="literal"><forget-passphrase></code></td><td>^F</td><td>wipe passphrase(s) from memory</td></tr><tr><td><code class="literal"><check-traditional-pgp></code></td><td>Esc P</td><td>check for classic PGP</td></tr><tr><td><code class="literal"><mail-key></code></td><td>Esc k</td><td>mail a PGP public key</td></tr><tr><td><code class="literal"><decrypt-copy></code></td><td> </td><td>make decrypted copy</td></tr><tr><td><code class="literal"><decrypt-save></code></td><td> </td><td>make decrypted copy and delete</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pager-map"></a>4.3. Pager Menu</h3></div></div></div><div class="table"><a id="pager-table"></a><p class="title"><b>Table 9.4. Default pager Function Bindings</b></p><div class="table-contents"><table summary="Default pager Function Bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><break-thread></code></td><td>#</td><td>break the thread in two</td></tr><tr><td><code class="literal"><create-alias></code></td><td>a</td><td>create an alias from a message sender</td></tr><tr><td><code class="literal"><bounce-message></code></td><td>b</td><td>remail a message to another user</td></tr><tr><td><code class="literal"><change-folder></code></td><td>c</td><td>open a different folder</td></tr><tr><td><code class="literal"><change-folder-readonly></code></td><td>Esc c</td><td>open a different folder in read only mode</td></tr><tr><td><code class="literal"><next-unread-mailbox></code></td><td> </td><td>open next mailbox with new mail</td></tr><tr><td><code class="literal"><copy-message></code></td><td>C</td><td>copy a message to a file/mailbox</td></tr><tr><td><code class="literal"><decode-copy></code></td><td>Esc C</td><td>make decoded (text/plain) copy</td></tr><tr><td><code class="literal"><delete-message></code></td><td>d</td><td>delete the current entry</td></tr><tr><td><code class="literal"><delete-thread></code></td><td>^D</td><td>delete all messages in thread</td></tr><tr><td><code class="literal"><delete-subthread></code></td><td>Esc d</td><td>delete all messages in subthread</td></tr><tr><td><code class="literal"><set-flag></code></td><td>w</td><td>set a status flag on a message</td></tr><tr><td><code class="literal"><clear-flag></code></td><td>W</td><td>clear a status flag from a message</td></tr><tr><td><code class="literal"><edit></code></td><td>e</td><td>edit the raw message</td></tr><tr><td><code class="literal"><edit-type></code></td><td>^E</td><td>edit attachment content type</td></tr><tr><td><code class="literal"><forward-message></code></td><td>f</td><td>forward a message with comments</td></tr><tr><td><code class="literal"><flag-message></code></td><td>F</td><td>toggle a message's 'important' flag</td></tr><tr><td><code class="literal"><group-reply></code></td><td>g</td><td>reply to all recipients</td></tr><tr><td><code class="literal"><imap-fetch-mail></code></td><td> </td><td>force retrieval of mail from IMAP server</td></tr><tr><td><code class="literal"><display-toggle-weed></code></td><td>h</td><td>display message and toggle header weeding</td></tr><tr><td><code class="literal"><next-undeleted></code></td><td>j</td><td>move to the next undeleted message</td></tr><tr><td><code class="literal"><next-entry></code></td><td>J</td><td>move to the next entry</td></tr><tr><td><code class="literal"><previous-undeleted></code></td><td>k</td><td>move to the previous undeleted message</td></tr><tr><td><code class="literal"><previous-entry></code></td><td>K</td><td>move to the previous entry</td></tr><tr><td><code class="literal"><link-threads></code></td><td>&</td><td>link tagged message to the current one</td></tr><tr><td><code class="literal"><list-reply></code></td><td>L</td><td>reply to specified mailing list</td></tr><tr><td><code class="literal"><redraw-screen></code></td><td>^L</td><td>clear and redraw the screen</td></tr><tr><td><code class="literal"><mail></code></td><td>m</td><td>compose a new mail message</td></tr><tr><td><code class="literal"><mark-as-new></code></td><td>N</td><td>toggle a message's 'new' flag</td></tr><tr><td><code class="literal"><search-next></code></td><td>n</td><td>search for next match</td></tr><tr><td><code class="literal"><next-thread></code></td><td>^N</td><td>jump to the next thread</td></tr><tr><td><code class="literal"><next-subthread></code></td><td>Esc n</td><td>jump to the next subthread</td></tr><tr><td><code class="literal"><print-message></code></td><td>p</td><td>print the current entry</td></tr><tr><td><code class="literal"><previous-thread></code></td><td>^P</td><td>jump to previous thread</td></tr><tr><td><code class="literal"><previous-subthread></code></td><td>Esc p</td><td>jump to previous subthread</td></tr><tr><td><code class="literal"><quit></code></td><td>Q</td><td>save changes to mailbox and quit</td></tr><tr><td><code class="literal"><exit></code></td><td>q</td><td>exit this menu</td></tr><tr><td><code class="literal"><reply></code></td><td>r</td><td>reply to a message</td></tr><tr><td><code class="literal"><recall-message></code></td><td>R</td><td>recall a postponed message</td></tr><tr><td><code class="literal"><read-thread></code></td><td>^R</td><td>mark the current thread as read</td></tr><tr><td><code class="literal"><read-subthread></code></td><td>Esc r</td><td>mark the current subthread as read</td></tr><tr><td><code class="literal"><resend-message></code></td><td>Esc e</td><td>use the current message as a template for a new one</td></tr><tr><td><code class="literal"><save-message></code></td><td>s</td><td>save message/attachment to a mailbox/file</td></tr><tr><td><code class="literal"><skip-quoted></code></td><td>S</td><td>skip beyond quoted text</td></tr><tr><td><code class="literal"><decode-save></code></td><td>Esc s</td><td>make decoded copy (text/plain) and delete</td></tr><tr><td><code class="literal"><tag-message></code></td><td>t</td><td>tag the current entry</td></tr><tr><td><code class="literal"><toggle-quoted></code></td><td>T</td><td>toggle display of quoted text</td></tr><tr><td><code class="literal"><undelete-message></code></td><td>u</td><td>undelete the current entry</td></tr><tr><td><code class="literal"><undelete-subthread></code></td><td>Esc u</td><td>undelete all messages in subthread</td></tr><tr><td><code class="literal"><undelete-thread></code></td><td>^U</td><td>undelete all messages in thread</td></tr><tr><td><code class="literal"><view-attachments></code></td><td>v</td><td>show MIME attachments</td></tr><tr><td><code class="literal"><show-version></code></td><td>V</td><td>show the Mutt version number and date</td></tr><tr><td><code class="literal"><search-toggle></code></td><td>\\</td><td>toggle search pattern coloring</td></tr><tr><td><code class="literal"><display-address></code></td><td>@</td><td>display full address of sender</td></tr><tr><td><code class="literal"><next-new></code></td><td> </td><td>jump to the next new message</td></tr><tr><td><code class="literal"><pipe-message></code></td><td>|</td><td>pipe message/attachment to a shell command</td></tr><tr><td><code class="literal"><help></code></td><td>?</td><td>this screen</td></tr><tr><td><code class="literal"><next-page></code></td><td><Space></td><td>move to the next page</td></tr><tr><td><code class="literal"><previous-page></code></td><td>-</td><td>move to the previous page</td></tr><tr><td><code class="literal"><top></code></td><td>^</td><td>jump to the top of the message</td></tr><tr><td><code class="literal"><sync-mailbox></code></td><td>$</td><td>save changes to mailbox</td></tr><tr><td><code class="literal"><shell-escape></code></td><td>!</td><td>invoke a command in a subshell</td></tr><tr><td><code class="literal"><enter-command></code></td><td>:</td><td>enter a muttrc command</td></tr><tr><td><code class="literal"><buffy-list></code></td><td>.</td><td>list mailboxes with new mail</td></tr><tr><td><code class="literal"><search></code></td><td>/</td><td>search for a regular expression</td></tr><tr><td><code class="literal"><search-reverse></code></td><td>Esc /</td><td>search backwards for a regular expression</td></tr><tr><td><code class="literal"><search-opposite></code></td><td> </td><td>search for next match in opposite direction</td></tr><tr><td><code class="literal"><next-line></code></td><td><Return></td><td>scroll down one line</td></tr><tr><td><code class="literal"><jump></code></td><td> </td><td>jump to an index number</td></tr><tr><td><code class="literal"><next-unread></code></td><td> </td><td>jump to the next unread message</td></tr><tr><td><code class="literal"><previous-new></code></td><td> </td><td>jump to the previous new message</td></tr><tr><td><code class="literal"><previous-unread></code></td><td> </td><td>jump to the previous unread message</td></tr><tr><td><code class="literal"><half-up></code></td><td> </td><td>scroll up 1/2 page</td></tr><tr><td><code class="literal"><half-down></code></td><td> </td><td>scroll down 1/2 page</td></tr><tr><td><code class="literal"><previous-line></code></td><td> </td><td>scroll up one line</td></tr><tr><td><code class="literal"><bottom></code></td><td> </td><td>jump to the bottom of the message</td></tr><tr><td><code class="literal"><parent-message></code></td><td>P</td><td>jump to parent message in thread</td></tr><tr><td><code class="literal"><check-traditional-pgp></code></td><td>Esc P</td><td>check for classic PGP</td></tr><tr><td><code class="literal"><mail-key></code></td><td>Esc k</td><td>mail a PGP public key</td></tr><tr><td><code class="literal"><extract-keys></code></td><td>^K</td><td>extract supported public keys</td></tr><tr><td><code class="literal"><forget-passphrase></code></td><td>^F</td><td>wipe passphrase(s) from memory</td></tr><tr><td><code class="literal"><decrypt-copy></code></td><td> </td><td>make decrypted copy</td></tr><tr><td><code class="literal"><decrypt-save></code></td><td> </td><td>make decrypted copy and delete</td></tr><tr><td><code class="literal"><what-key></code></td><td> </td><td>display the keycode for a key press</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="alias-map"></a>4.4. Alias Menu</h3></div></div></div><div class="table"><a id="alias-table"></a><p class="title"><b>Table 9.5. Default alias Function Bindings</b></p><div class="table-contents"><table summary="Default alias Function Bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><delete-entry></code></td><td>d</td><td>delete the current entry</td></tr><tr><td><code class="literal"><undelete-entry></code></td><td>u</td><td>undelete the current entry</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="query-map"></a>4.5. Query Menu</h3></div></div></div><div class="table"><a id="query-table"></a><p class="title"><b>Table 9.6. Default query Function Bindings</b></p><div class="table-contents"><table summary="Default query Function Bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><create-alias></code></td><td>a</td><td>create an alias from a message sender</td></tr><tr><td><code class="literal"><mail></code></td><td>m</td><td>compose a new mail message</td></tr><tr><td><code class="literal"><query></code></td><td>Q</td><td>query external program for addresses</td></tr><tr><td><code class="literal"><query-append></code></td><td>A</td><td>append new query results to current results</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="attach-map"></a>4.6. Attach Menu</h3></div></div></div><div class="table"><a id="attach-table"></a><p class="title"><b>Table 9.7. Default attach Function Bindings</b></p><div class="table-contents"><table summary="Default attach Function Bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><bounce-message></code></td><td>b</td><td>remail a message to another user</td></tr><tr><td><code class="literal"><display-toggle-weed></code></td><td>h</td><td>display message and toggle header weeding</td></tr><tr><td><code class="literal"><edit-type></code></td><td>^E</td><td>edit attachment content type</td></tr><tr><td><code class="literal"><print-entry></code></td><td>p</td><td>print the current entry</td></tr><tr><td><code class="literal"><save-entry></code></td><td>s</td><td>save message/attachment to a mailbox/file</td></tr><tr><td><code class="literal"><pipe-entry></code></td><td>|</td><td>pipe message/attachment to a shell command</td></tr><tr><td><code class="literal"><view-mailcap></code></td><td>m</td><td>force viewing of attachment using mailcap</td></tr><tr><td><code class="literal"><reply></code></td><td>r</td><td>reply to a message</td></tr><tr><td><code class="literal"><resend-message></code></td><td>Esc e</td><td>use the current message as a template for a new one</td></tr><tr><td><code class="literal"><group-reply></code></td><td>g</td><td>reply to all recipients</td></tr><tr><td><code class="literal"><list-reply></code></td><td>L</td><td>reply to specified mailing list</td></tr><tr><td><code class="literal"><forward-message></code></td><td>f</td><td>forward a message with comments</td></tr><tr><td><code class="literal"><view-text></code></td><td>T</td><td>view attachment as text</td></tr><tr><td><code class="literal"><view-attach></code></td><td><Return></td><td>view attachment using mailcap entry if necessary</td></tr><tr><td><code class="literal"><delete-entry></code></td><td>d</td><td>delete the current entry</td></tr><tr><td><code class="literal"><undelete-entry></code></td><td>u</td><td>undelete the current entry</td></tr><tr><td><code class="literal"><collapse-parts></code></td><td>v</td><td>Toggle display of subparts</td></tr><tr><td><code class="literal"><check-traditional-pgp></code></td><td>Esc P</td><td>check for classic PGP</td></tr><tr><td><code class="literal"><extract-keys></code></td><td>^K</td><td>extract supported public keys</td></tr><tr><td><code class="literal"><forget-passphrase></code></td><td>^F</td><td>wipe passphrase(s) from memory</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="compose-map"></a>4.7. Compose Menu</h3></div></div></div><div class="table"><a id="compose-table"></a><p class="title"><b>Table 9.8. Default compose Function Bindings</b></p><div class="table-contents"><table summary="Default compose Function Bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><attach-file></code></td><td>a</td><td>attach file(s) to this message</td></tr><tr><td><code class="literal"><attach-message></code></td><td>A</td><td>attach message(s) to this message</td></tr><tr><td><code class="literal"><edit-bcc></code></td><td>b</td><td>edit the BCC list</td></tr><tr><td><code class="literal"><edit-cc></code></td><td>c</td><td>edit the CC list</td></tr><tr><td><code class="literal"><copy-file></code></td><td>C</td><td>save message/attachment to a mailbox/file</td></tr><tr><td><code class="literal"><detach-file></code></td><td>D</td><td>delete the current entry</td></tr><tr><td><code class="literal"><toggle-disposition></code></td><td>^D</td><td>toggle disposition between inline/attachment</td></tr><tr><td><code class="literal"><edit-description></code></td><td>d</td><td>edit attachment description</td></tr><tr><td><code class="literal"><edit-message></code></td><td>e</td><td>edit the message</td></tr><tr><td><code class="literal"><edit-headers></code></td><td>E</td><td>edit the message with headers</td></tr><tr><td><code class="literal"><edit-file></code></td><td>^X e</td><td>edit the file to be attached</td></tr><tr><td><code class="literal"><edit-encoding></code></td><td>^E</td><td>edit attachment transfer-encoding</td></tr><tr><td><code class="literal"><edit-from></code></td><td>Esc f</td><td>edit the from field</td></tr><tr><td><code class="literal"><edit-fcc></code></td><td>f</td><td>enter a file to save a copy of this message in</td></tr><tr><td><code class="literal"><filter-entry></code></td><td>F</td><td>filter attachment through a shell command</td></tr><tr><td><code class="literal"><get-attachment></code></td><td>G</td><td>get a temporary copy of an attachment</td></tr><tr><td><code class="literal"><display-toggle-weed></code></td><td>h</td><td>display message and toggle header weeding</td></tr><tr><td><code class="literal"><ispell></code></td><td>i</td><td>run ispell on the message</td></tr><tr><td><code class="literal"><print-entry></code></td><td>l</td><td>print the current entry</td></tr><tr><td><code class="literal"><edit-mime></code></td><td>m</td><td>edit attachment using mailcap entry</td></tr><tr><td><code class="literal"><new-mime></code></td><td>n</td><td>compose new attachment using mailcap entry</td></tr><tr><td><code class="literal"><postpone-message></code></td><td>P</td><td>save this message to send later</td></tr><tr><td><code class="literal"><edit-reply-to></code></td><td>r</td><td>edit the Reply-To field</td></tr><tr><td><code class="literal"><rename-file></code></td><td>R</td><td>rename/move an attached file</td></tr><tr><td><code class="literal"><edit-subject></code></td><td>s</td><td>edit the subject of this message</td></tr><tr><td><code class="literal"><edit-to></code></td><td>t</td><td>edit the TO list</td></tr><tr><td><code class="literal"><edit-type></code></td><td>^T</td><td>edit attachment content type</td></tr><tr><td><code class="literal"><write-fcc></code></td><td>w</td><td>write the message to a folder</td></tr><tr><td><code class="literal"><toggle-unlink></code></td><td>u</td><td>toggle whether to delete file after sending it</td></tr><tr><td><code class="literal"><toggle-recode></code></td><td> </td><td>toggle recoding of this attachment</td></tr><tr><td><code class="literal"><update-encoding></code></td><td>U</td><td>update an attachment's encoding info</td></tr><tr><td><code class="literal"><view-attach></code></td><td><Return></td><td>view attachment using mailcap entry if necessary</td></tr><tr><td><code class="literal"><send-message></code></td><td>y</td><td>send the message</td></tr><tr><td><code class="literal"><pipe-entry></code></td><td>|</td><td>pipe message/attachment to a shell command</td></tr><tr><td><code class="literal"><attach-key></code></td><td>Esc k</td><td>attach a PGP public key</td></tr><tr><td><code class="literal"><pgp-menu></code></td><td>p</td><td>show PGP options</td></tr><tr><td><code class="literal"><forget-passphrase></code></td><td>^F</td><td>wipe passphrase(s) from memory</td></tr><tr><td><code class="literal"><smime-menu></code></td><td>S</td><td>show S/MIME options</td></tr><tr><td><code class="literal"><mix></code></td><td>M</td><td>send the message through a mixmaster remailer chain</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="postpone-map"></a>4.8. Postpone Menu</h3></div></div></div><div class="table"><a id="postpone-table"></a><p class="title"><b>Table 9.9. Default postpone Function Bindings</b></p><div class="table-contents"><table summary="Default postpone Function Bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><delete-entry></code></td><td>d</td><td>delete the current entry</td></tr><tr><td><code class="literal"><undelete-entry></code></td><td>u</td><td>undelete the current entry</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="browser-map"></a>4.9. Browser Menu</h3></div></div></div><div class="table"><a id="browser-table"></a><p class="title"><b>Table 9.10. Default browser Function Bindings</b></p><div class="table-contents"><table summary="Default browser Function Bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><change-dir></code></td><td>c</td><td>change directories</td></tr><tr><td><code class="literal"><display-filename></code></td><td>@</td><td>display the currently selected file's name</td></tr><tr><td><code class="literal"><enter-mask></code></td><td>m</td><td>enter a file mask</td></tr><tr><td><code class="literal"><sort></code></td><td>o</td><td>sort messages</td></tr><tr><td><code class="literal"><sort-reverse></code></td><td>O</td><td>sort messages in reverse order</td></tr><tr><td><code class="literal"><select-new></code></td><td>N</td><td>select a new file in this directory</td></tr><tr><td><code class="literal"><check-new></code></td><td> </td><td>check mailboxes for new mail</td></tr><tr><td><code class="literal"><toggle-mailboxes></code></td><td><Tab></td><td>toggle whether to browse mailboxes or all files</td></tr><tr><td><code class="literal"><view-file></code></td><td><Space></td><td>view file</td></tr><tr><td><code class="literal"><buffy-list></code></td><td>.</td><td>list mailboxes with new mail</td></tr><tr><td><code class="literal"><create-mailbox></code></td><td>C</td><td>create a new mailbox (IMAP only)</td></tr><tr><td><code class="literal"><delete-mailbox></code></td><td>d</td><td>delete the current mailbox (IMAP only)</td></tr><tr><td><code class="literal"><rename-mailbox></code></td><td>r</td><td>rename the current mailbox (IMAP only)</td></tr><tr><td><code class="literal"><subscribe></code></td><td>s</td><td>subscribe to current mailbox (IMAP only)</td></tr><tr><td><code class="literal"><unsubscribe></code></td><td>u</td><td>unsubscribe from current mailbox (IMAP only)</td></tr><tr><td><code class="literal"><toggle-subscribed></code></td><td>T</td><td>toggle view all/subscribed mailboxes (IMAP only)</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-map"></a>4.10. Pgp Menu</h3></div></div></div><div class="table"><a id="pgp-table"></a><p class="title"><b>Table 9.11. Default pgp Function Bindings</b></p><div class="table-contents"><table summary="Default pgp Function Bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><verify-key></code></td><td>c</td><td>verify a PGP public key</td></tr><tr><td><code class="literal"><view-name></code></td><td>%</td><td>view the key's user id</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-map"></a>4.11. Smime Menu</h3></div></div></div><div class="table"><a id="smime-table"></a><p class="title"><b>Table 9.12. Default smime Function Bindings</b></p><div class="table-contents"><table summary="Default smime Function Bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><verify-key></code></td><td>c</td><td>verify a PGP public key</td></tr><tr><td><code class="literal"><view-name></code></td><td>%</td><td>view the key's user id</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mix-map"></a>4.12. Mix Menu</h3></div></div></div><div class="table"><a id="mix-table"></a><p class="title"><b>Table 9.13. Default mix Function Bindings</b></p><div class="table-contents"><table summary="Default mix Function Bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><accept></code></td><td><Return></td><td>Accept the chain constructed</td></tr><tr><td><code class="literal"><append></code></td><td>a</td><td>Append a remailer to the chain</td></tr><tr><td><code class="literal"><insert></code></td><td>i</td><td>Insert a remailer into the chain</td></tr><tr><td><code class="literal"><delete></code></td><td>d</td><td>Delete a remailer from the chain</td></tr><tr><td><code class="literal"><chain-prev></code></td><td><Left></td><td>Select the previous element of the chain</td></tr><tr><td><code class="literal"><chain-next></code></td><td><Right></td><td>Select the next element of the chain</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="editor-map"></a>4.13. Editor Menu</h3></div></div></div><div class="table"><a id="editor-table"></a><p class="title"><b>Table 9.14. Default editor Function Bindings</b></p><div class="table-contents"><table summary="Default editor Function Bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><bol></code></td><td>^A</td><td>jump to the beginning of the line</td></tr><tr><td><code class="literal"><backward-char></code></td><td>^B</td><td>move the cursor one character to the left</td></tr><tr><td><code class="literal"><backward-word></code></td><td>Esc b</td><td>move the cursor to the beginning of the word</td></tr><tr><td><code class="literal"><capitalize-word></code></td><td>Esc c</td><td>capitalize the word</td></tr><tr><td><code class="literal"><downcase-word></code></td><td>Esc l</td><td>convert the word to lower case</td></tr><tr><td><code class="literal"><upcase-word></code></td><td>Esc u</td><td>convert the word to upper case</td></tr><tr><td><code class="literal"><delete-char></code></td><td>^D</td><td>delete the char under the cursor</td></tr><tr><td><code class="literal"><eol></code></td><td>^E</td><td>jump to the end of the line</td></tr><tr><td><code class="literal"><forward-char></code></td><td>^F</td><td>move the cursor one character to the right</td></tr><tr><td><code class="literal"><forward-word></code></td><td>Esc f</td><td>move the cursor to the end of the word</td></tr><tr><td><code class="literal"><backspace></code></td><td><Backspace></td><td>delete the char in front of the cursor</td></tr><tr><td><code class="literal"><kill-eol></code></td><td>^K</td><td>delete chars from cursor to end of line</td></tr><tr><td><code class="literal"><kill-eow></code></td><td>Esc d</td><td>delete chars from the cursor to the end of the word</td></tr><tr><td><code class="literal"><kill-line></code></td><td>^U</td><td>delete all chars on the line</td></tr><tr><td><code class="literal"><quote-char></code></td><td>^V</td><td>quote the next typed key</td></tr><tr><td><code class="literal"><kill-word></code></td><td>^W</td><td>delete the word in front of the cursor</td></tr><tr><td><code class="literal"><complete></code></td><td><Tab></td><td>complete filename or alias</td></tr><tr><td><code class="literal"><complete-query></code></td><td>^T</td><td>complete address with query</td></tr><tr><td><code class="literal"><buffy-cycle></code></td><td><Space></td><td>cycle among incoming mailboxes</td></tr><tr><td><code class="literal"><history-up></code></td><td> </td><td>scroll up through the history list</td></tr><tr><td><code class="literal"><history-down></code></td><td> </td><td>scroll down through the history list</td></tr><tr><td><code class="literal"><transpose-chars></code></td><td> </td><td>transpose character under cursor with previous</td></tr></tbody></table></div></div><br class="table-break" /></div></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="miscellany"></a>Chapter 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" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="acknowledgements"></a>1. Acknowledgements</h2></div></div></div><p>
6700 Kari Hurtta <code class="email"><<a class="email" href="mailto:kari.hurtta@fmi.fi">kari.hurtta@fmi.fi</a>></code>
6701 co-developed the original MIME parsing code back in the ELM-ME days.
6703 The following people have been very helpful to the development of Mutt:
6704 </p><div class="itemizedlist"><ul type="disc"><li><p>Vikas Agnihotri <code class="email"><<a class="email" href="mailto:vikasa@writeme.com">vikasa@writeme.com</a>></code></p></li><li><p>Francois Berjon <code class="email"><<a class="email" href="mailto:Francois.Berjon@aar.alcatel-alsthom.fr">Francois.Berjon@aar.alcatel-alsthom.fr</a>></code></p></li><li><p>Aric Blumer <code class="email"><<a class="email" href="mailto:aric@fore.com">aric@fore.com</a>></code></p></li><li><p>John Capo <code class="email"><<a class="email" href="mailto:jc@irbs.com">jc@irbs.com</a>></code></p></li><li><p>David Champion <code class="email"><<a class="email" href="mailto:dgc@uchicago.edu">dgc@uchicago.edu</a>></code></p></li><li><p>Brendan Cully <code class="email"><<a class="email" href="mailto:brendan@kublai.com">brendan@kublai.com</a>></code></p></li><li><p>Liviu Daia <code class="email"><<a class="email" href="mailto:daia@stoilow.imar.ro">daia@stoilow.imar.ro</a>></code></p></li><li><p>Thomas E. Dickey <code class="email"><<a class="email" href="mailto:dickey@herndon4.his.com">dickey@herndon4.his.com</a>></code></p></li><li><p>David DeSimone <code class="email"><<a class="email" href="mailto:fox@convex.hp.com">fox@convex.hp.com</a>></code></p></li><li><p>Nickolay N. Dudorov <code class="email"><<a class="email" href="mailto:nnd@wint.itfs.nsk.su">nnd@wint.itfs.nsk.su</a>></code></p></li><li><p>Ruslan Ermilov <code class="email"><<a class="email" href="mailto:ru@freebsd.org">ru@freebsd.org</a>></code></p></li><li><p>Edmund Grimley Evans <code class="email"><<a class="email" href="mailto:edmundo@rano.org">edmundo@rano.org</a>></code></p></li><li><p>Michael Finken <code class="email"><<a class="email" href="mailto:finken@conware.de">finken@conware.de</a>></code></p></li><li><p>Sven Guckes <code class="email"><<a class="email" href="mailto:guckes@math.fu-berlin.de">guckes@math.fu-berlin.de</a>></code></p></li><li><p>Lars Hecking <code class="email"><<a class="email" href="mailto:lhecking@nmrc.ie">lhecking@nmrc.ie</a>></code></p></li><li><p>Mark Holloman <code class="email"><<a class="email" href="mailto:holloman@nando.net">holloman@nando.net</a>></code></p></li><li><p>Andreas Holzmann <code class="email"><<a class="email" href="mailto:holzmann@fmi.uni-passau.de">holzmann@fmi.uni-passau.de</a>></code></p></li><li><p>Marco d'Itri <code class="email"><<a class="email" href="mailto:md@linux.it">md@linux.it</a>></code></p></li><li><p>Björn Jacke <code class="email"><<a class="email" href="mailto:bjacke@suse.com">bjacke@suse.com</a>></code></p></li><li><p>Byrial Jensen <code class="email"><<a class="email" href="mailto:byrial@image.dk">byrial@image.dk</a>></code></p></li><li><p>David Jeske <code class="email"><<a class="email" href="mailto:jeske@igcom.net">jeske@igcom.net</a>></code></p></li><li><p>Christophe Kalt <code class="email"><<a class="email" href="mailto:kalt@hugo.int-evry.fr">kalt@hugo.int-evry.fr</a>></code></p></li><li><p>Tommi Komulainen <code class="email"><<a class="email" href="mailto:Tommi.Komulainen@iki.fi">Tommi.Komulainen@iki.fi</a>></code></p></li><li><p>Felix von Leitner (a.k.a “<span class="quote">Fefe</span>”) <code class="email"><<a class="email" href="mailto:leitner@math.fu-berlin.de">leitner@math.fu-berlin.de</a>></code></p></li><li><p>Brandon Long <code class="email"><<a class="email" href="mailto:blong@fiction.net">blong@fiction.net</a>></code></p></li><li><p>Jimmy Mäkelä <code class="email"><<a class="email" href="mailto:jmy@flashback.net">jmy@flashback.net</a>></code></p></li><li><p>Lars Marowsky-Bree <code class="email"><<a class="email" href="mailto:lmb@pointer.in-minden.de">lmb@pointer.in-minden.de</a>></code></p></li><li><p>Thomas “<span class="quote">Mike</span>” Michlmayr <code class="email"><<a class="email" href="mailto:mike@cosy.sbg.ac.at">mike@cosy.sbg.ac.at</a>></code></p></li><li><p>Andrew W. Nosenko <code class="email"><<a class="email" href="mailto:awn@bcs.zp.ua">awn@bcs.zp.ua</a>></code></p></li><li><p>David O'Brien <code class="email"><<a class="email" href="mailto:obrien@Nuxi.cs.ucdavis.edu">obrien@Nuxi.cs.ucdavis.edu</a>></code></p></li><li><p>Clint Olsen <code class="email"><<a class="email" href="mailto:olsenc@ichips.intel.com">olsenc@ichips.intel.com</a>></code></p></li><li><p>Park Myeong Seok <code class="email"><<a class="email" href="mailto:pms@romance.kaist.ac.kr">pms@romance.kaist.ac.kr</a>></code></p></li><li><p>Thomas Parmelan <code class="email"><<a class="email" href="mailto:tom@ankh.fr.eu.org">tom@ankh.fr.eu.org</a>></code></p></li><li><p>Ollivier Robert <code class="email"><<a class="email" href="mailto:roberto@keltia.freenix.fr">roberto@keltia.freenix.fr</a>></code></p></li><li><p>Thomas Roessler <code class="email"><<a class="email" href="mailto:roessler@does-not-exist.org">roessler@does-not-exist.org</a>></code></p></li><li><p>Roland Rosenfeld <code class="email"><<a class="email" href="mailto:roland@spinnaker.de">roland@spinnaker.de</a>></code></p></li><li><p>Rocco Rutte <code class="email"><<a class="email" href="mailto:pdmef@gmx.net">pdmef@gmx.net</a>></code></p></li><li><p>TAKIZAWA Takashi <code class="email"><<a class="email" href="mailto:taki@luna.email.ne.jp">taki@luna.email.ne.jp</a>></code></p></li><li><p>Allain Thivillon <code class="email"><<a class="email" href="mailto:Allain.Thivillon@alma.fr">Allain.Thivillon@alma.fr</a>></code></p></li><li><p>Gero Treuner <code class="email"><<a class="email" href="mailto:gero@70t.de">gero@70t.de</a>></code></p></li><li><p>Vsevolod Volkov <code class="email"><<a class="email" href="mailto:vvv@lucky.net">vvv@lucky.net</a>></code></p></li><li><p>Ken Weinert <code class="email"><<a class="email" href="mailto:kenw@ihs.com">kenw@ihs.com</a>></code></p></li></ul></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="about"></a>2. About This Document</h2></div></div></div><p>
6705 This document was written in <a class="ulink" href="http://docbook.sourceforge.net" target="_top">DocBook</a>,
6706 and then rendered using the <a class="ulink" href="http://xmlsoft.org/XSLT/" target="_top">Gnome XSLT toolkit</a>.
6707 </p></div></div></div></body></html>
projects / software / mutt-debian.git / blob