path: root/UPDATING

This file lists incompatible changes and additional/new features made to
mutt. Please read this file carefully when upgrading your installation.

The description of changes are intentionally brief.  For a more detailed
explanation of features, please refer to the manual at
http://www.mutt.org/doc/manual/

The keys used are:
  !: modified feature, -: deleted feature, +: new feature

1.9.1 (2017-09-23):

  ! Bug fix release.

1.9.0 (2017-09-02):

  + $ssl_verify_partial_chains permits verifying partial certificate chains.
    This allows the storage of only intermediate/host certificates in the
    $certificate_file. (OpenSSL 1.0.2b and newer only)
  ! SNI support added for OpenSSL and GnuTLS.
  + Choice and confirmation prompts can now wrap across multiple lines.
  + Window resizes are handled while in the line editor.
  + "color compose" can color the compose menu header fields and the
    security status.  See "Using Color and Mono Video Attributes" in the
    manual for more details.
  + Setting $header_color_partial allows partial coloring of headers in the
    pager.  This can be used to color just the header labels, or strings
    inside the headers.  hdrdefault controls the color of the unmatched part.
  + When $history_remove_dups is set, duplicates in the history ring will
    be scanned and removed each time a new entry is added.
  ! IMAP header downloading was improved to support out-of-order and
    missing MSN entries.
  ! $message_cache_clean should be faster for large mailboxes.
  + Self-encryption can be enabled using the $pgp_self_encrypt,
    $pgp_self_encrypt_as, $smime_self_encrypt, and $smime_self_encrypt_as
    options.
  ! $postpone_encrypt now will use the $pgp_self_encrypt_as or
    $smime_self_encrypt_as option values first.  $postpone_encrypt_as will
    be checked second, but should be considered deprecated.
  + $forward_attribution_intro and $forward_attribution_trailer can be used
    to customize the message preceding and following a forwarded message.
  + The ~<() and ~>() pattern operators match messages whose immediate parent,
    or immediate children respectively, match the subpattern inside ().
    They are more specific versions of the ~() pattern operator.
  + $imap_poll_timeout allow IMAP mailbox polling to time out.  This defaults
    to 15 seconds.
  + The attachment menu now supports nested encryption.  This allows
    attachments in nested encrypted messages to be saved or operated on.
  + $mime_type_query_command specifies a command to run to determine
    a new attachment's mime type.  When $mime_type_query_first is set,
    this command will be run before looking at the mime.types file.

1.8.3 (2017-05-30):

  ! Bug fix release.

1.8.2 (2017-04-18):

  ! Bug fix release.

1.8.1 (2017-04-13):

  ! Bug fix release.

1.8.0 (2017-02-24):

  - $locale has been removed.  Mutt now respects the LC_TIME setting
    instead.  See also $attribution_locale.
  + $attribution_locale can be used to override the date formatting in
    attribution strings.  When unset, Mutt will use the locale
    environment, but note the default value of $date_format has a
    leading '!' which says to use the C-locale.
  ! Message-id and mail-followup-to headers are now preserved for recalled
    messages.
  + <unsidebar_whitelist> added to complement <sidebar_whitelist>.
  ! The pager position is reset to the top when toggling header-weed.
  ! IMAP messages moved to $trash via server-side copy are marked as read.
  + <root-message> jumps to the root message of a thread.
  ! Piped text attachments are charset converted.
  + Added %F to $attach_format, to show the content-disposition filename.
    %d will fall back to %F which will fall back to %f.
  + <rename-attachment> allows an attachment name to be changed, without
    modifying the underlying file's name.
  ! Mutt will look for the user's muttrc additionally in
    $XDG_CONFIG_HOME/mutt/.
  + Compressed mbox and mmdf files are now supported via open-hook,
    close-hook, and append-hook.  See contrib/sample.muttrc-compress
    for suggested settings.  Note this is a compile-time option:
    --enable-compressed.
  + When $flag_safe is set, flagged messages cannot be deleted.
  + The '@' pattern modifier can be used to limit matches to known aliases.
  + <mark-message> creates a hotkey binding to a specific message.  The hotkey
    prefix is specified via $mark_macro_prefix.
  + <setenv> and <unsetenv> can be used to add/remove environment variables
    passed to children.
  ! Mutt will now use the built-in OpenSSL SSL_set_verify() callback
    to verify certificates.  This allows better support for verifying
    chains, including alternative chain support.
  + $uncollapse_new controls whether a thread will be uncollapsed when a new
    message arrives.
  ! $to_chars and $status_chars now accept multibyte characters.
  + <subjectrx> allows replacing matching subjects with something else.
    This can be used to declutter subject lines in the index.
  + <edit-label> can be used to add, change, or delete a message's X-Label.
  ! Pattern expressions with ~y support label tab completion.
  + The header cache now also supports Kyoto Cabinet and LMDB as
    backend databases.

1.7.2 (2016-12-04):

  ! Bug fix release.  No features were modified or added.
  ! Fixes for OpenSSL 1.1.  Versions less than 0.9.6 are no longer supported.

1.7.1 (2016-10-08):

  ! Bug fix release.  No features were modified or added.

1.7.0 (2016-08-18):

  ! Improved alignment when using multi-column characters with
    soft-fill (%*X) and right-justified (%>X) format strings.
  + The COLUMNS environment variable will be set to the width of the
    pager when invoking display filters.  This can be used in
    copiousoutput mailcap entries to allow their output to match the
    pager width.
  + The sidebar patch has been merged.  Please watch for airborne
    bovine.  See the documentation for all the options, or simply
    enable it with 'set sidebar_visible'.
  + $mail_check_stats and $mail_check_stats_interval control whether,
    and how often, to scan for unread, flagged, and total message
    counts when checking for new mail in mailboxes.  These statistics
    can be displayed in the sidebar and browser.
  + $trash, when set, specifies the path of the folder where mails
    marked for deletion will be moved, instead of being irremediably
    purged.
  + The <purge-message> function can be used to delete an entry and
    bypass the trash folder.
  + $folder_format has new format strings %m and %n, to display
    total and unread message counts for mailboxes.  Note that
    $mail_check_stats should be enabled to use these.
  ! When browsing IMAP, %N will now display 'N', instead of the unread
    message count.  Please use %n to display unread messages.

1.6.2 (2016-07-06):

  ! Bug fix release.  No features were modified or added.

1.6.1 (2016-05-01):

  ! Bug fix release.  No features were modified or added.

1.6.0 (2016-04-04):

  + Enabled utf-8 mailbox support for IMAP.
  + New expandos %r and %R for comma separated list of To: and Cc:
    recipients respectively.
  + Improved support for internationalized email and SMTPUTF8 (RFC653[0-3]).
  ! $use_idn has been renamed to $idn_decode.
  + $idn_encode controls whether outgoing email address domains will
    be IDNA encoded.  If your MTA supports it, unset to use utf-8
    email address domains.
  + The S/MIME message digest algorithm is now specified using the
    option $smime_sign_digest_alg.  Note that $smime_sign_command
    should be modified to include "-md %d".  Please see
    contrib/smime.rc.
  + $reflow_space_quotes allows format=flowed email quotes to be
    displayed with spacing between them.
  ! multipart draft files are now supported.
  + The "-E" command line argument causes mutt to edit draft or include files.
    All changes made in mutt will be saved back out to those files.
  + $resume_draft_files and $resume_edited_draft_files control how
    mutt processes draft files.
  + For classic gpg mode, $pgp_decryption_okay should be set to verify
    multipart/encrypted are actually encrypted.  Please see
    contrib/gpg.rc for the suggested value.
  ! mailto URL header parameters by default are now restricted to
    'body' and 'subject'.
  + mailto_allow and unmailto_allow can be used to add or remove
    allowed mailto header parameters.
  ! The method of setting $hostname has been changed.  Rather than
    scanning /etc/resolv.conf, the domain will now be determined using
    DNS calls.

1.5.24 (2015-08-31):

  + terminal status-line (TS) support, a.k.a. xterm title. see the
    following variables: $ts_enabled, $ts_icon_format, $ts_status_format
  ! $ssl_use_sslv3 is disabled by default.
  ! command-line arguments: -H now combines template and command-line
    address arguments.
  ! GnuPG signature name is set to signature.asc
  + New color object "prompt" added.
  + Ability to encrypt postponed messages.  See $postpone_encrypt and
    $postpone_encrypt_as.
  ! History ring now has a scratch buffer.
  ! mail-key is implemented for GPGME.  (Requires a recent GPGME).
  ! Removed GPG_AGENT_INFO check for GnuPG 2.1 compatibility.  Please
    set pgp_use_gpg_agent if using GnuPG 2.1 or later.
  ! $smime_encrypt_with now defaults to aes256.
  ! GnuPG fingerprints are used internally when possible.
    "--with-fingerprint" should be added to $pgp_list_pubring_command and
    $pgp_list_secring_command to enable this.  Please see contrib/gpg.rc.
    Fingerprints may also be used at the prompts for key selection.
  + $crypt_opportunistic_encrypt automatically enables/disables encryption
    based on message recipients.
  ! Attachments for signed, unencrypted emails may be deleted.
  ! Multiple crypt-hooks may be defined for the same regexp.
    This means multiple keys may be used for a recipient.
  + $crypt_confirmhook allows the confirmation prompt for crypt-hooks to
    be disabled.
  + $ssl_ciphers allows the SSL ciphers to be directly set.
  ! sime_keys better handles importing certificate chains.
  ! sime_keys now records certificate purposes (sign/encrypt).  Run
    "sime_keys refresh" to update smime index files.
  + $maildir_check_cur polls the maildir "cur" directory for new mail.

1.5.23 (2014-03-11):

  ! FCC is now preserved when postponing a message.
  ! Mail-Followup-To is now preserved when recalling a postponed message.
  ! Allow filename prompt when saving multiple attachments to a directory.

1.5.22 (2013-10-18):

  ! $imap_keepalive default lowered to 300
  + $reflow_text, $reflow_wrap for finer control of flowed wrapping
  + Support for TLSv1.1 and TLSv1.2.  $ssl_use_tlsv1_1 and $ssl_tlsv1_2
    variables control whether the new protocols are used.
  ! $ssl_use_tlsv1 now specifically refers to TLSv1.0.

1.5.21 (2010-09-15):

  + $mail_check_recent controls whether all unread mail or only new mail
    since the last mailbox visit will be reported as new
  + %D format expando for $folder_format
  ! $thorough_search defaults to yes
  + imap-logout-all closes all open IMAP connections
  ! header/body cache paths are always UTF-8
  + $wrap_headers to control outgoing message's header length
  + all text/* parts can be displayed inline without mailcap
  + send-hooks now run in batch mode; previously only send2-hooks ran.

1.5.20 (2009-06-14):

  ! mbox/mmdf new mail flag is kept when leaving folders with new mail
  ! $fcc_attach is a quadoption now
  + $honor_disposition to honor Content-Disposition headers
  + $search_context specifies number of context lines for search results
    in pager/page-based menus
  ! ssl_use_sslv2 defaults to no
  + uncolor works for header + body objects, too
  + the "flagged" and "replied" flags are enabled/supported for
    POP when built with header caching
  ! browser correctly displays maildir's mtime
  + <set-flag> and <clear-flag> work in the pager, too
  + ~x pattern also matches against In-Reply-To
  + lower case patterns for string searches perform case-insensitive
    search as regex patterns do (except IMAP)
  + $ssl_verify_dates controls whether mutt checks the validity period of
    SSL certificates
  + $ssl_verify_host controls whether mutt will accept certificates whose
    host names do not match the host name in the folder URL.

1.5.19 (2009-01-05):

  ! command-line arguments: -a now mandates -- at end of file list
  + support for SSL certificate chains
  + <what-key> function works in pager, too
  + support for tokyocabinet (qdbm successor)
  ! $move now defaults to "no" instead of "ask-no"
  + $imap_pipeline_depth controls the number of commands that mutt can issue
    to an IMAP server before it must collect the responses
  + $ssl_client_cert available with gnutls as well as openssl
  + 'mime_lookup application/octet-stream' added to system Muttrc

1.5.18 (2008-05-17):

  ! header caches internally are utf-8 regardless of current locale
  + $query_format (customize external query menu)
  ! inode sorting is always enabled
  + $time_inc suppresses progress updates less than $time_inc
    milliseconds apart.
  + X-Label: headers must now be RfC2047-encoded

1.5.17 (2007-11-01):

  ! --enable-exact-address works again

1.5.16 (2007-06-09):

  + next-unread-mailbox
  + $message_cache_clean (clean cache on sync)
  + $smtp_pass
  ! $header_cache_compress defaults to yes

1.5.15 (2007-04-06):

  - $imap_home_namespace (useless clutter)
  + $check_mbox_size (use size change instead of atime for new mail)
  ! improved f=f support wraps lines at $wrap if $wrap is not 0
  + $wrap (>0 wraps at $wrap, <0 = $wrapmargin)
  + $assumed_charset, $attach_charset, $ignore_linear_white_space
  + $save_history, $history_file (save history across sessions)
  + $smtp_url (ESMTP relay support)
  + $crypt_use_pka (use GPGME PKA signature verification)
  ! format pipe support: format strings ending in | are filtered
  ! buffy size is configurable at runtime (no --enable-buffy-size
    configure option, new $check_mbox_size variable)

1.5.13 (2006-08-14):

  + thread patterns.  Use ~(...) to match all threads that
    contain a message that matches ...

1.5.12 (2006-07-14):

  - $imap_cachedir replaced with $message_cachedir
  + Header/body caching for POP ($message_cachedir)
  + Header caching for MH folders 
  ! $record now defaults to ~/sent
  ! $imap_idle now defaults to "yes" instead of "no"
  + Tab-completion for $my_* variable names and values
  + Expansion of mutt variables (except shell escape)
  + Self-defined variables with $my_* prefix 
  + Pattern group support 
  + $imap_cachedir
  + 'old' flag on IMAP folders
  + SASL-IR support for IMAP
  + IMAP IDLE support and $imap_idle
  + Pipeline-based IMAP communicaton
  + Full large file support
  + Attachment counting: attachments and unattachments commands,
    %Q and %X for $attach_format, %X for $index_format
  + Basque translation
  + QDBM backend for header caching
  + Irish translation

1.5.11 (2005-09-15):

  ! $envelope_from_address has been added, $envelope_from has been renamed
    to $use_envelope_from
  + Progress bar via $net_inc
  + IMAP server-side simple string search
  + Simple string matches instead of full regex matches for '=' instead
    of '~' with pattern modifiers
  ! ~l matches all known lists, ~u only subscribed
  - SASL 1.5 support
  ! The manual is now build from DocBook/XML instead of Linuxdoc/SGML source

1.5.10 (2005-08-11):

  + $imap_check_subscribed
  + Tab-completion for IMAP hosts
  ! $imap_force_ssl has been replaced without synonym by $ssl_force_tls
  - NSS support
  ! The default for $menu_move_off has been changed from "no" to "yes"
  ! An empty <limit> now cancels the current limit
  + Editing threads via <break-thread> and <link-threads>
  + -D command line option
  + the folder shortcut '^' refers to the currently opened folder
  + $imap_login
  + $braille_friendly
  + Header caching for Maildir folders

Mutt 1.5.9 (2005-03-13):

  + $menu_move_off
  + <rename-mailbox> function for IMAP

Mutt 1.5.8 (2005-02-12):

  + $menu_context
  ! IDNA decoding is now optional via $use_idn defaulting to "yes"
  + GPGME support via $crypt_use_gpgme

Mutt 1.5.7 (2005-01-28):

  + SSL support via GNUTLS
  + Header caching for IMAP via $header_cache and $header_cache_pagesize
  + send2-hook
  + $ssl_client_cert
  + $hide_thread_subject
  + Generic spam detection: new configuration commands: 'spam' and
    'nospam', new options: $spam_separator, new expando: %H (for
    $index_format), new pattern: ~H pattern
  + $include_onlyfirst
  ! $pgp_mime_ask has been renamed without synonym to $pgp_mime_auto,
    new default is "ask-yes" rather than "no"
  + Inline PGP creation support via $pgp_replyinline, $pgp_autoinline
    and $pgp_mime_ask
  ! the 'bind' command can now be used on multiple menus at once
  + $config_charset
  + ~$ pattern

1.5.6 (2004-02-01):

  ! the 'list' and 'subscribe' commands now take regular expression
    rather than string lists
  ! the $alternates option is replaced by the 'alternates' command
    taking lists of regular expressions
  ! mailing lists can be recognized via domain matching when
    starting with '@'
  + STLS (STARTTLS) support for POP3

1.5.5 (2003-11-05):

  + Bulgarian translation
  - Kendra mailbox support
  + <tag-prefix-cond> and <cond-end>
  + ':' as expando modifier (e.g. '%:A')
  + $crypt_autopgp and $crypt_autosmime
  + $pgp_check_exit

1.5.4 (2003-03-19):

  + IDNA support
  + $bounce
  ! $crypt_replyencrypt and $pgp_replyencrypt now default
    to "yes" instead of "no"
  + $pgp_auto_traditional
  + %A for $index_format

1.5.3 (2002-12-17):

  + <next-new-then-unread> and <previous-new-then-unread>
  ! $mark_old: it only controls whether new messages
    are marked as old when leaving the mailbox
  + <what-key>

1.5.2 (2002-12-06):

  + -A command line option
  + SASL2 support
  + <buffy-list>
  + $forward_edit
  + $content_type
  + unmailboxes command
  + unalternative_order command
  + reply-hook

1.5.1 (2002-01-24):

  + $smime_default_key
  + $narrow_tree
  + -Q command line option
  + $crypt_timestamp
  + ~V pattern
  + S/MIME support
  + mime_lookup command