Security Considerations

From: Richard Russon Date: Tue, 12 Apr 2016 13:18:17 +0000 (+0100) Subject: merge: ifdef X-Git-Tag: neomutt-20160416~16 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=2cd92a63fb33af9d823a4b727e7f73d5015127dc;p=neomutt merge: ifdef * change wiki references to website --- 2cd92a63fb33af9d823a4b727e7f73d5015127dc diff --cc doc/manual.xml.head index 94242d410,807d63f95..a062c3d9e --- a/doc/manual.xml.head +++ b/doc/manual.xml.head @@@ -8888,2580 -8242,40 +8888,2580 @@@ bind index,pager Q quasi-delet - - - -Security Considerations + + Progress Bar Patch + Show a visual progress bar on slow operations - -First of all, Mutt contains no security holes included by intention but -may contain unknown security holes. As a consequence, please run Mutt -only with as few permissions as possible. Especially, do not run Mutt as -the super user. - + + Patch - -When configuring Mutt, there're some points to note about secure setups -so please read this chapter carefully. - + + To check if Mutt supports Progress Bar, look for + patch-progress in the mutt version. + See: . + - -Passwords + + Dependencies: + mutt-1.5.24 + - -Although Mutt can be told the various passwords for accounts, please -never store passwords in configuration files. Besides the fact that the -system's operator can always read them, you could forget to mask it out -when reporting a bug or asking for help via a mailing list. Even worse, -your mail including your password could be archived by internet search -engines, mail-to-news gateways etc. It may already be too late before -you notice your mistake. - + This patch is part of the NeoMutt Project. + - + + Introduction - -Temporary Files + + The progress patch shows a visual progress bar on slow + tasks, such as indexing a large folder over the net. + + + + + + + Colors + + Progress Colors + + + + Name + Default Color + Description + + + + + progress + default + Visual progress bar + + + +

+ + + + + + Muttrc + +# Example Mutt config file for the 'progress' patch. + +# The 'progress' patch provides clear visual feedback for +# slow tasks, such as indexing a large folder over the net. + +# Set the color of the progress bar +# White text on a red background +color progress white red + +# vim: syntax=muttrc + + + + + See Also + + + NeoMutt Project + Color command + + + + + Known Bugs + None + + + + Credits + + Rocco Rutte pdmef@gmx.net + Vincent Lefevre vincent@vinc17.org + Stefan Kuhn wuodan@hispeed.ch + Karel Zak kzak@redhat.com + Richard Russon rich@flatcap.org + + + + + + Status Color Patch + Custom rules for theming the status bar + + + Patch + + + To check if Mutt supports Status Color, look for + patch-status-color in the mutt version. + See: . + + + + Dependencies: + mutt-1.5.24 + + + This patch is part of the NeoMutt Project. + + + + Introduction + + + The status-color patch allows you to theme different + parts of the status bar (also when it's used by the index). + + + + Unlike normal color commands, color status can now + take up to 2 extra parameters (regex, num). + + + + + + + Commands + + color + + + + + foreground + + + background + + + + regex + + + + num + + + + + + + With zero parameters, Mutt will set the default color for the entire + status bar. + + + + With one parameter, Mutt will only color the parts matching the + regex. + + + + With two parameters, Mutt will only color the num'th sub-match of + the regex. + + + + + Colors + + + Status Colors + + + + Name + Default Color + Description + + + + + status + reverse + Status bar + + + +

+ + + + + + Muttrc + +# Example Mutt config file for the 'status-color' patch. + +# The 'status-color' patch allows you to theme different parts of +# the status bar (also when it's used by the index). + +# For the examples below, set some defaults +set status_format='-%r-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)---' +set index_format='%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s' +set sort=threads +set sort_aux=last-date-received + +# 'status color' can take up to 2 extra parameters + +# color status foreground background [ regex [ num ]] + +# 0 extra parameters +# Set the default color for the entire status line +color status blue white + +# 1 extra parameter +# Set the color for a matching pattern +# color status foreground background regexp + +# Highlight New, Deleted, or Flagged emails +color status brightred white '(New|Del|Flag):[0-9]+' + +# Highlight mailbox ordering if it's different from the default +# First, highlight anything (*/*) +color status brightred default '$[^)]+/[^)]+$' + +# Then override the color for one specfic case +color status default default '$threads/last-date-received$' + +# 2 extra parameters +# Set the color for the nth submatch of a pattern +# color status foreground background regexp num + +# Highlight the contents of the []s but not the [] themselves +color status red default '\[([^]]+)\]' 1 + +# The '1' refers to the first regex submatch, which is the inner +# part in ()s + +# Highlight the mailbox +color status brightwhite default 'Mutt: ([^ ]+)' 1 + +# Search for 'Mutt: ' but only highlight what comes after it + +# vim: syntax=muttrc + + + + + See Also + + + NeoMutt Project + Compile-Time Features + Regular Expressions + Patterns + index-color patch + Color command + + + + + Known Bugs + None + + + + Credits + + David Sterba dsterba@suse.cz + Thomas Glanzmann thomas@glanzmann.de + Kirill A. Shutemov kirill@shutemov.name + Richard Russon rich@flatcap.org + + + + + + Index Color Patch + Custom rules for theming the email index + + + Patch + + + To check if Mutt supports Index Color, look for + patch-index-color in the mutt version. + See: . + + + + Dependencies: + mutt-1.5.24 + status-color patch + + + This patch is part of the NeoMutt Project. + + + + Introduction + + + The index-color patch allows you to specify colors for + individual parts of the email index. e.g. Subject, Author, Flags. + + + + First choose which part of the index you'd like to color. + Then, if needed, pick a pattern to match. + + + + Note: The pattern does not have to refer to the object you wish to + color. e.g. + + + +color index_author red default "~smutt" + + + + The author appears red when the subject (~s) contains mutt. + + + + + + + Colors + + + All the colors default to default, i.e. unset. + + + + The index objects can be themed using the color command. + Some objects require a pattern. + + + +color index-object foreground background +color index-object foreground background pattern + + + + Index Colors + + + + Object + Pattern + Highlights + + + + + index + yes + Entire index line + + + index_author + yes + Author name, %A %a %F %L %n + + + index_collapsed + no + Number of messages in a collapsed thread, %M + + + index_date + no + Date field + + + index_flags + yes + Message flags, %S %Z + + + index_label + no + Message label, %y %Y + + + index_number + no + Message number, %C + + + index_size + no + Message size, %c %l + + + index_subject + yes + Subject, %s + + + +

+ + + + + + Muttrc + +# Example Mutt config file for the 'index-color' feature. + +# Entire index line +color index white black '.*' + +# Author name, %A %a %F %L %n + +# Give the author column a dark grey background +color index_author default color234 '.*' + +# Highlight a particular from (~f) +color index_author brightyellow color234 '~fRay Charles' + +# Message flags, %S %Z +# Highlight the flags for flagged (~F) emails +color index_flags default red '~F' + +# Subject, %s +# Look for a particular subject (~s) +color index_subject brightcyan default '~s$closes #[0-9]+$' + +# Number of messages in a collapsed thread, %M +color index_collapsed default brightblue + +# Date field +color index_date green default + +# Message label, %y %Y +color index_label default brightgreen + +# Message number, %C +color index_number red default + +# Message size, %c %l +color index_size cyan default + +# vim: syntax=muttrc + + + + + See Also + + + NeoMutt Project + Regular Expressions + Patterns + $index_format + Color command + Status-Color patch + Keywords patch + + + + + Known Bugs + None + + + + Credits + + Christian Aichinger Greek0@gmx.net + Christoph Myon Berg myon@debian.org + Elimar Riesebieter riesebie@lxtec.de + Eric Davis edavis@insanum.com + Vladimir Marek Vladimir.Marek@oracle.com + Richard Russon rich@flatcap.org + + + + + + Nested If Patch + Allow complex nested conditions in format strings + + + Patch + + + To check if Mutt supports Nested If, look for + patch-nested-if in the mutt version. + See: . + + + + Dependencies: + mutt-1.5.24 + + + This patch is part of the NeoMutt Project. + + + + Introduction + + + Mutt's format strings can contain embedded if-then-else conditions. + They are of the form: + + + +%?VAR?TRUE&FALSE? + + + + If the variable VAR has a value greater than zero, + print the TRUE string, otherwise print the + FALSE string. + + + + e.g. %?S?Size: %S&Empty? + + + Which can be read as: + + + if (%S > 0) { + print "Size: %S" + } else { + print "Empty" + } + + + + These conditions are useful, but in Mutt they cannot be nested + within one another. This patch uses the notation + %<VAR?TRUE&FALSE> and allows them to be nested. + + + + The %<...> notation was used to format the + current local time. but that's not really very useful since mutt + has no means of refreshing the screen periodically. + + + + A simple nested condition might be: + (Some whitespace has been introduced for clarity) + + + + %<x? %<y? XY & X > & %<y? Y & NONE > > Conditions + %<y? XY & X > x>0 + XY x>0,y>0 + X x>0,y=0 + + + + %<x? %<y? XY & X > & %<y? Y & NONE > > Conditions + %<y? Y & NONE > x=0 + Y x=0,y>0 + NONE x=0,y=0 + + + Equivalent to: + + + if (x > 0) { + if (y > 0) { + print 'XY' + } else { + print 'X' + } + } else { + if (y > 0) { + print 'Y' + } else { + print 'NONE' + } + } + + + Examples: + + +set index_format='%4C %Z %{%b %d} %-25.25n %s%> %<M?%M Msgs &%<l?%l Lines&%c Bytes>>' + + + + if a thread is folded + display the number of messages (%M) + else if we know how many lines in the message + display lines in message (%l) + else + display the size of the message in bytes (%c) + + + +set index_format='%4C %Z %{%b %d} %-25.25n %<M?[%M] %s&%s%* %<l?%l&%c>>' + + + + if a thread is folded + display the number of messages (%M) + display the subject (%s) + else if we know how many lines in the message + display lines in message (%l) + else + display the size of the message in bytes (%c) + + + + + + Variables + The nested-if patch doesn't have any config of its own. + It modifies the behavior of the format strings. + + + + + + Muttrc + +# Example Mutt config file for the 'nested-if' feature. + +# This patch uses the format: '%<VAR?TRUE&FALSE>' for conditional +# format strings that can be nested. + +# Example 1 +# if a thread is folded +# display the number of messages (%M) +# else if we know how many lines in the message +# display lines in message (%l) +# else display the size of the message in bytes (%c) +set index_format='%4C %Z %{%b %d} %-25.25n %s%> %<M?%M Msgs &%<l?%l Lines&%c Bytes>>' + +# Example 2 +# if a thread is folded +# display the number of messages (%M) +# display the subject (%s) +# else if we know how many lines in the message +# display lines in message (%l) +# else +# display the size of the message in bytes (%c) +set index_format='%4C %Z %{%b %d} %-25.25n %<M?[%M] %s&%s%* %<l?%l&%c>>' + +# vim: syntax=muttrc + + + + + See Also + + + NeoMutt Project + cond-date patch + $index_format + $status_format + + + + + Known Bugs + Patch overwrites $<fmt> handler in $index_format + + + + Credits + + David Champion dgc@uchicago.edu + Richard Russon rich@flatcap.org + + + + + + Conditional Dates Patch + Use rules to choose date format + + + Patch + + + To check if Mutt supports Conditional Dates, look for + patch-cond-date in the mutt version. + See: . + + + + Dependencies: + mutt-1.5.24 + nested-if patch + + + + This patch is part of the NeoMutt Project. + + + + + Introduction + + + The cond-date patch allows you to construct + $index_format expressions based on the age of the email. + + + + Mutt's default $index_format displays email dates in the + form: abbreviated-month day-of-month — Jan 14. + + + + The format is configurable but only per-mailbox. This patch allows you + to configure the display depending on the age of the email. + + + + Potential Formatting Scheme + + + + Email Sent + Format + Example + + + + + Today + %H:%M + 13:23 + + + This Month + %a %d + Thu 17 + + + This Year + %b %d + Dec 10 + + + Older than 1 Year + %m/%y + 06/14 + + + +

+ + + For an explanation of the date formatting strings, see + strftime(3). + + + + By carefully picking your formats, the dates can remain + unambiguous and compact. + + + + Mutt's conditional format strings have the form: + (whitespace introduced for clarity) + + + %? TEST ? TRUE & FALSE ? + + + The examples below use the test %[ — the date + of the message in the local timezone. They will also work with + %( — the local time that the message arrived. + + + + The date tests are of the form: + + + %[nX? TRUE & FALSE ? + + + n is an optional count (defaults to 1 if missing) + X is the time period + + + + Date Formatting Codes + + + + Letter + Time Period + + + + + y + Years + + + m + Months + + + w + Weeks + + + d + Days + + + H + Hours + + + M + Minutes + + + +

+ + + Example Date Tests + + + + Test + Meaning + + + + + %[y + This year + + + %[1y + This year + + + %[6m + In the last 6 months + + + %[w + This week + + + %[d + Today + + + %[4H + In the last 4 hours + + + +

+ + + Example 1 + + We start with a one-condition test. + + + Example 1 + + + + Test + Date Range + Format String + Example + + + + + %[1m + This month + %[%b %d] + Dec 10 + + + + Older + %[%Y-%m-%d] + 2015-04-23 + + + +

+ + The $index_format string would contain: + +%?[1m?%[%b %d]&%[%Y-%m-%d]? + + + + Reparsed a little, for clarity, you can see the + test condition and the two format strings. + + + +%?[1m? & ? + %[%b %d] %[%Y-%m-%d] + + + + + + Example 2 + + + This example contains three test conditions and four date formats. + + + + Example 2 + + + + Test + Date Range + Format String + Example + + + + + %[d + Today + %[%H:%M ] + 12:34 + + + %[m + This month + %[%a %d] + Thu 12 + + + %[y + This year + %[%b %d] + Dec 10 + + + + Older + %[%m/%y ] + 06/15 + + + +

+ + The $index_format string would contain: + + +%<[y?%<[m?%<[d?%[%H:%M ]&%[%a %d]>&%[%b %d]>&%[%m/%y ]> + + + + Reparsed a little, for clarity, you can see the + test conditions and the four format strings. + + + +%<[y? &%[%m/%y ]> Older + %<[m? &%[%b %d]> This year + %<[d? &%[%a %d]> This month + %[%H:%M ] Today + + + + This a another view of the same example, with some whitespace + for clarity. + + + +%<[y? %<[m? %<[d? AAA & BBB > & CCC > & DDD > + + + +AAA = %[%H:%M ] +BBB = %[%a %d] +CCC = %[%b %d] +DDD = %[%m/%y ] + + + + + + Variables + + + The cond-date patch doesn't have any config of its own. + It modifies the behavior of the format strings. + + + + + + + Muttrc + +# Example Mutt config file for the 'index-color' feature. +# +# The default index_format is: +# '%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s' +# +# We replace the date field '%{%b %d}', giving: +set index_format='%4C %Z %<[y?%<[m?%<[d?%[%H:%M ]&%[%a %d]>&%[%b %d]>&%[%m/%y ]> %-15.15L (%?l?%4l&%4c?) %s' + +# Test Date Range Format String Example +# -------------------------------------------- +# %[d Today %[%H:%M ] 12:34 +# %[m This month %[%a %d] Thu 12 +# %[y This year %[%b %d] Dec 10 +# - Older %[%m/%y ] 06/15 + +# vim: syntax=muttrc + + + + + See Also + + + NeoMutt Project + $index_format + nested-if patch + strftime(3) + + + + + Known Bugs + + + Date parsing doesn't quite do what you expect. + 1w doesn't mean the in the last 7 days, but + this week. This doesn't match + the normal Mutt behaviour: for example ~d>1w + means emails dated in the last 7 days. + + + + + + Credits + + Aaron Schrab aaron@schrab.com + Eric Davis edavis@insanum.com + Richard Russon rich@flatcap.org + + + + + + TLS-SNI Patch + Negotiate with a server for a TSL/SSL certificate + + + Patch + + + To check if Mutt supports TLS-SNI, look for + patch-tls-sni in the mutt version. + See: . + + + + Dependencies: + mutt-1.5.24 + OpenSSL + + + This patch is part of the NeoMutt Project. + + + + Introduction + + + The TLS-SNI patch adds support for TLS virtual hosting. + If your mail server doesn't support this everything will still work + normally. + + + + TLS supports sending the expected server hostname during the + handshake, via the SNI extension. This can be used to select a + server certificate to issue to the client, permitting + virtual-hosting without requiring multiple IP addresses. + + + + This has been tested against Exim 4.80, which optionally logs SNI + and can perform vhosting. + + + + To verify TLS SNI support by a server, you can use: + + + +openssl s_client -host <imap server> -port <port> -tls1 -servername <imap server> + + + + + + + Muttrc + None + + + + See Also + + + NeoMutt Project + + + + + Known Bugs + None + + + + Credits + + Jeremy Katz katzj@linuxpower.org + Phil Pennock mutt-dev@spodhuis.demon.nl + Richard Russon rich@flatcap.org + + + + + + Sidebar Patch + Overview of mailboxes + + + + + Introduction + + + The Sidebar shows a list of all your mailboxes. The list can be + turned on and off, it can be themed and the list style can be + configured. + + + + This part of the manual is a reference guide. + If you want a simple introduction with examples see the + Sidebar Howto. + If you just want to get started, you could use the sample + Sidebar muttrc. + + + + This version of Sidebar is based on Terry Chan's + 2015-11-11 release. + It contains many + new features, + lots of + bugfixes. + + + + + Variables + + + Sidebar Variables + + + + Name + Type + Default + + + + + sidebar_delim_chars + string + /. + + + sidebar_divider_char + string + | + + + sidebar_folder_indent + boolean + no + + + sidebar_format + string + %B%?F? [%F]?%* %?N?%N/?%S + + + sidebar_indent_string + string + (two spaces) + + + sidebar_new_mail_only + boolean + no + + + sidebar_next_new_wrap + boolean + no + + + sidebar_refresh_time + number + 60 + + + sidebar_short_path + boolean + no + + + sidebar_sort_method + enum + SORT_ORDER + + + sidebar_visible + boolean + no + + + sidebar_whitelist + list + (empty) + + + sidebar_width + number + 20 + + + + + + + + Functions + + + Sidebar adds the following functions to Mutt. + By default, none of them are bound to keys. + + + + Sidebar Functions + + + + Menus + Function + Description + + + + + index,pager + <sidebar-next> + Move the highlight to next mailbox + + + index,pager + <sidebar-next-new> + Move the highlight to next mailbox with new mail + + + index,pager + <sidebar-open> + Open highlighted mailbox + + + index,pager + <sidebar-page-down> + Scroll the Sidebar down 1 page + + + index,pager + <sidebar-page-up> + Scroll the Sidebar up 1 page + + + index,pager + <sidebar-prev> + Move the highlight to previous mailbox + + + index,pager + <sidebar-prev-new> + Move the highlight to previous mailbox with new mail + + + index,pager + <sidebar-toggle-visible> + Make the Sidebar (in)visible + + + + + + + + + + Colors + + + Sidebar Colors + + + + Name + Default Color + Description + + + + + sidebar_divider + default + The dividing line between the Sidebar and the Index/Pager panels + + + sidebar_flagged + default + Mailboxes containing flagged mail + + + sidebar_highlight + underline + Cursor to select a mailbox + + + sidebar_indicator + mutt indicator + The mailbox open in the Index panel + + + sidebar_new + default + Mailboxes containing new mail + + + sidebar_spoolfile + default + Mailbox that receives incoming mail + + + + + + If the sidebar_indicator color isn't set, then the default Mutt + indicator color will be used (the color used in the index panel). + + + + Sort + + + Sidebar Sort + + + + Sort + Description + + + + + alpha + Alphabetically by path + + + count + Total number of messages + + + flagged + Number of flagged messages + + + name + Alphabetically by path + + + new + Number of new messages + + + path + Alphabetically by path + + + unsorted + Do not resort the paths + + + + + + + + Muttrc + +# This is a complete list of sidebar-related configuration. + +# -------------------------------------------------------------------------- +# VARIABLES - shown with their default values +# -------------------------------------------------------------------------- + +# Should the Sidebar be shown? +set sidebar_visible = no + +# How wide should the Sidebar be in screen columns? +# Note: Some characters, e.g. Chinese, take up two columns each. +set sidebar_width = 20 + +# Should the mailbox paths be abbreviated? +set sidebar_short_path = no + +# When abbreviating mailbox path names, use any of these characters as path +# separators. Only the part after the last separators will be shown. +# For file folders '/' is good. For IMAP folders, often '.' is useful. +set sidebar_delim_chars = '/.' + +# If the mailbox path is abbreviated, should it be indented? +set sidebar_folder_indent = no + +# Indent mailbox paths with this string. +set sidebar_indent_string = ' ' + +# Make the Sidebar only display mailboxes that contain new, or flagged, +# mail. +set sidebar_new_mail_only = no + +# Any mailboxes that are whitelisted will always be visible, even if the +# sidebar_new_mail_only option is enabled. +sidebar_whitelist '/home/user/mailbox1' +sidebar_whitelist '/home/user/mailbox2' + +# When searching for mailboxes containing new mail, should the search wrap +# around when it reaches the end of the list? +set sidebar_next_new_wrap = no + +# The character to use as the divider between the Sidebar and the other Mutt +# panels. +# Note: Only the first character of this string is used. +set sidebar_divider_char = '|' + +# Display the Sidebar mailboxes using this format string. +set sidebar_format = '%B%?F? [%F]?%* %?N?%N/?%S' + +# Sidebar will not refresh its list of mailboxes any more frequently than +# this number of seconds. This will help reduce disk/network traffic. +set sidebar_refresh_time = 60 + +# Sort the mailboxes in the Sidebar using this method: +# count - total number of messages +# flagged - number of flagged messages +# new - number of new messages +# path - mailbox path +# unsorted - do not sort the mailboxes +set sidebar_sort_method = 'unsorted' + +# -------------------------------------------------------------------------- +# FUNCTIONS - shown with an example mapping +# -------------------------------------------------------------------------- + +# Move the highlight to the previous mailbox +bind index,pager \Cp sidebar-prev + +# Move the highlight to the next mailbox +bind index,pager \Cn sidebar-next + +# Open the highlighted mailbox +bind index,pager \Co sidebar-open + +# Move the highlight to the previous page +# This is useful if you have a LOT of mailboxes. +bind index,pager <F3> sidebar-page-up + +# Move the highlight to the next page +# This is useful if you have a LOT of mailboxes. +bind index,pager <F4> sidebar-page-down + +# Move the highlight to the previous mailbox containing new, or flagged, +# mail. +bind index,pager <F5> sidebar-prev-new + +# Move the highlight to the next mailbox containing new, or flagged, mail. +bind index,pager <F6> sidebar-next-new + +# Toggle the visibility of the Sidebar. +bind index,pager B sidebar-toggle-visible + +# -------------------------------------------------------------------------- +# COLORS - some unpleasant examples are given +# -------------------------------------------------------------------------- +# Note: All color operations are of the form: +# color OBJECT FOREGROUND BACKGROUND + +# Color of the current, open, mailbox +# Note: This is a general Mutt option which colors all selected items. +color indicator cyan black + +# Color of the highlighted, but not open, mailbox. +color sidebar_highlight black color8 + +# Color of the divider separating the Sidebar from Mutt panels +color sidebar_divider color8 black + +# Color to give mailboxes containing flagged mail +color sidebar_flagged red black + +# Color to give mailboxes containing new mail +color sidebar_new green black + +# -------------------------------------------------------------------------- + +# vim: syntax=muttrc + + + + + + + + + + + + Ifdef Patch + Conditional config options + + + Patch + + + To check if Mutt supports ifdef, look for + patch-ifdef in the mutt version. + See: . + + + + Dependencies: + mutt-1.5.24 + + - This patch is part of the NeoMutt Project. ++ This patch is part of the NeoMutt Project. + + + + Introduction + + + The ifdef patch introduces three new commands to + Mutt and allow you to share one config file between versions of Mutt + that may have different features compiled in. + + + +ifdef symbol config-command [args...] # If a symbol is defined +ifndef symbol config-command [args...] # If a symbol is not defined +finish # Finish reading the current file + + + + Here a symbol can be a $variable, + <function>, + command or compile-time symbol, such + as USE_IMAP. + + + + finish is particularly useful when combined with + ifndef. e.g. + + + +# Sidebar config file +ifndef USE_SIDEBAR finish + + + + + + + + Commands + + ifdef + + symbol + + + "config-command [args]" + + ifndef + + symbol + + + "config-command [args]" + + finish + + + + + + + Muttrc + +# Example Mutt config file for the 'ifdef' feature. + +# This feature introduces three useful commands which allow you to share +# one config file between versions of Mutt that may have different +# features compiled in. + +# ifdef symbol config-command [args...] +# ifndef symbol config-command [args...] +# finish + +# The 'ifdef' command tests whether Mutt understands the name of +# a variable, function, command or compile-time symbol. +# If it does, then it executes a config command. + +# The 'ifndef' command tests whether a symbol does NOT exist. + +# The 'finish' command tells Mutt to stop reading current config file. + +# If the 'trash' variable exists, set it. +ifdef trash 'set trash=~/Mail/trash' + +# If the 'tag-pattern' function exists, bind a key to it. +ifdef tag-pattern 'bind index <F6> tag-pattern' + +# If the 'imap-fetch-mail' command exists, read my IMAP config. +ifdef imap-fetch-mail 'source ~/.mutt/imap.rc' + +# If the compile-time symbol 'USE_SIDEBAR' does not exist, then +# stop reading the current config file. +ifndef USE_SIDEBAR finish + +# vim: syntax=muttrc + + + + + See Also + + - NeoMutt Project ++ NeoMutt Project + + + + + Known Bugs + None + + + + Credits + + Cedric Duval cedricduval@free.fr + Matteo F. Vescovi mfvescovi@gmail.com + Richard Russon rich@flatcap.org + + + + + + Fmemopen Patch + Replace some temporary files with memory buffers + + + Patch + + + To check if Mutt supports fmemopen, look for + patch-fmemopen in the mutt version. + See: . + + + + Dependencies: + mutt-1.5.24 + open_memstream(), fmemopen() from glibc + + + This patch is part of the NeoMutt Project. + + + + Introduction + + + The fmemopen patch speeds up some searches. + + + + This patch changes a few places where Mutt creates temporary files. + It replaces them with in-memory buffers. This should improve the + performance when searching the header or body using the + $thorough_search option. + + + + There are no user-configurable parts. + + + + This patch depends on open_memstream() and + fmemopen(). They are provided by glibc. Without + them, Mutt will simply create temporary files. + + + + + + + Muttrc + None + + + + See Also + + + NeoMutt Project + Compile-Time Features + fmemopen(3) + + + + + Known Bugs + None + + + + Credits + + Julius Plenz plenz@cis.fu-berlin.de + Richard Russon rich@flatcap.org + + + + + + Initials Expando Patch + Expando for author's initials + + + Patch + + + To check if Mutt supports Initials, look for + patch-initials in the mutt version. + See: . + + + + Dependencies: + mutt-1.5.24 + + + This patch is part of the NeoMutt Project. + + + + Introduction + + + The initials patch adds an expando (%I) for an author's + initials. + + + + The index panel displays a list of emails. Its layout is controlled by + the $index_format variable. Using + this expando saves space in the index panel. This can be useful if you + are regularly working with a small set of people. + + + + + Variables + + + This patch has no config of its own. It adds an expando which can be + used in the $index_format variable. + + + + + + + Muttrc + +# Example Mutt config file for the 'initials' patch. + +# The 'initials' patch has no config of its own. +# It adds an expando for an author's initials, +# which can be used in the 'index_format' variable. + +# The default 'index_format' is: +set index_format='%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s' + +# Where %L represents the author/recipient + +# This might look like: +# 1 + Nov 17 David Bowie Changesbowie ( 689) +# 2 ! Nov 17 Stevie Nicks Rumours ( 555) +# 3 + Nov 16 Jimi Hendrix Voodoo Child ( 263) +# 4 + Nov 16 Debbie Harry Parallel Lines ( 540) + +# Using the %I expando: +set index_format='%4C %Z %{%b %d} %I (%?l?%4l&%4c?) %s' + +# This might look like: +# 1 + Nov 17 DB Changesbowie ( 689) +# 2 ! Nov 17 SN Rumours ( 555) +# 3 + Nov 16 JH Voodoo Child ( 263) +# 4 + Nov 16 DH Parallel Lines ( 540) + +# vim: syntax=muttrc + + + + + See Also + + + NeoMutt Project + $index_format + index-color patch + folder-hook + + + + + Known Bugs + None + + + + Credits + + Vsevolod Volkov vvv@mutt.org.ua + Richard Russon rich@flatcap.org + + + + + + Trash Folder Patch + Automatically move "deleted" emails to a trash bin + + + Patch + + + To check if Mutt supports Trash Folder, look for + patch-trash in the mutt version. + See: . + + + If IMAP is enabled, this patch will use it + + + Dependencies: + mutt-1.5.24 + IMAP support + + + This patch is part of the NeoMutt Project. + + + + Introduction + + + In Mutt, when you delete an email it is first marked + deleted. The email isn't really gone until + <sync-mailbox> is called. + This happens when the user leaves the folder, or the function is called + manually. + + + + After <sync-mailbox> has been called the email is gone forever. + + + + The $trash variable defines a folder in + which to keep old emails. As before, first you mark emails for + deletion. When <sync-mailbox> is called the emails are moved to + the trash folder. + + + + The $trash path can be either a full directory, + or be relative to the $folder + variable, like the mailboxes command. + + + + Emails deleted from the trash folder are gone forever. + + + + + Variables + + Trash Variables + + + + Name + Type + Default + + + + + trash + string + (none) + + + +

+ + + + Functions + + Trash Functions + + + + Menus + Default Key + Function + Description + + + + + index,pager + (none) + <purge-message> + really delete the current entry, bypassing the trash folder + + + +

+ + + + + + Muttrc + +# Example Mutt config file for the 'trash' feature. + +# This feature defines a new 'trash' folder. +# When mail is deleted it will be moved to this folder. + +# Folder in which to put deleted emails +set trash='+Trash' +set trash='/home/flatcap/Mail/Trash' + +# The default delete key 'd' will move an email to the 'trash' folder +# Bind 'D' to REALLY delete an email +bind index D purge-message + +# Note: Deleting emails from the 'trash' folder will REALLY delete them. + +# vim: syntax=muttrc + + + + + See Also + + + NeoMutt Project + folder-hook + + + + + Known Bugs + None + + + + Credits + + Cedric Duval cedricduval@free.fr + Benjamin Kuperman kuperman@acm.org + Paul Miller paul@voltar.org + Richard Russon rich@flatcap.org + + + + + + Limit-Current-Thread Patch + Focus on one Email Thread + + + Patch + + + To check if Mutt supports limit-current-thread, look for + patch-limit-current-thread in the mutt version. + See: . + + + + Dependencies: + mutt-1.5.24 + + + This patch is part of the NeoMutt Project. + + + + Introduction + + + This patch adds a new way of using the + Limit Command. + The <limit-current-thread> + function restricts the view to just the current thread. + Setting the limit (the l key) to + all will restore the full email list. + + + + + + + Functions + + + Limit-Current-Thread Functions + + + + Menus + Default Key + Function + Description + + + + + index + <Esc> L + <limit-current-thread> + Limit view to current thread + + + +

+ + + + + + Muttrc + + +# Example Mutt config file for the 'limit-current-thread' patch. + +# Limit view to current thread +bind index <esc>L limit-current-thread + +# vim: syntax=muttrc + + + + + See Also + + + NeoMutt Project + + + + + Known Bugs + None + + + + Credits + + David Sterba dsterba@suse.cz + Richard Russon rich@flatcap.org + + + + + + Skip-Quoted Patch + Leave some context visible + + + Patch + + + To check if Mutt supports skip-quoted, look for + patch-skip-quoted in the mutt version. + See: . + + + + Dependencies: + mutt-1.5.24 + + + This patch is part of the NeoMutt Project. + + + + Introduction + + + When viewing an email, the + <skip-to-quoted> function (by default the + S key) will scroll past any quoted text. + Sometimes, a little context is useful. + + + + By setting the $skip_quoted_offset variable, you + can select how much of the quoted text is left visible. + + + + + Variables + + Skip-Quoted Variables + + + + Name + Type + Default + + + + + skip_quoted_offset + number + 0 + + + +

+ + + + + + Muttrc + + +# Example Mutt config file for the 'skip-quoted' patch. + +# The 'S' (skip-quoted) command scrolls the pager past the quoted text (usually +# indented with '> '. Setting 'skip_quoted_offset' leaves some lines of quoted +# text on screen for context. + +# Show three quoted lines before the reply +set skip_quoted_offset = 3 + +# vim: syntax=muttrc + + + + + See Also + + + NeoMutt Project + + + + + Known Bugs + None + + + + Credits + + David Sterba dsterba@suse.cz + Richard Russon rich@flatcap.org + + + + + + + +Security Considerations + + +First of all, Mutt contains no security holes included by intention but +may contain unknown security holes. As a consequence, please run Mutt +only with as few permissions as possible. Especially, do not run Mutt as +the super user. + + + +When configuring Mutt, there're some points to note about secure setups +so please read this chapter carefully. + + + +Passwords + + +Although Mutt can be told the various passwords for accounts, please +never store passwords in configuration files. Besides the fact that the +system's operator can always read them, you could forget to mask it out +when reporting a bug or asking for help via a mailing list. Even worse, +your mail including your password could be archived by internet search +engines, mail-to-news gateways etc. It may already be too late before +you notice your mistake. + + + + + +Temporary Files Mutt uses many temporary files for viewing messages, verifying digital