2 * Copyright notice from original mutt:
3 * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
4 * Copyright (C) 2004 g10 Code GmbH
6 * Parts were writte/modified by:
7 * Nico Golde <nico@ngolde.de>
9 * This file is part of mutt-ng, see http://www.muttng.org/.
10 * It's licensed under the GNU General Public License,
11 * please see the file GPL in the top level source directory.
19 #define DT_BOOL 1 /* boolean option */
20 #define DT_NUM 2 /* a number */
21 #define DT_STR 3 /* a string */
22 #define DT_PATH 4 /* a pathname */
23 #define DT_QUAD 5 /* quad-option (yes/no/ask-yes/ask-no) */
24 #define DT_SORT 6 /* sorting methods */
25 #define DT_RX 7 /* regular expressions */
26 #define DT_MAGIC 8 /* mailbox type */
28 #define DTYPE(x) ((x) & DT_MASK)
31 #define DT_SUBTYPE_MASK 0xf0
32 #define DT_SORT_ALIAS 0x10
33 #define DT_SORT_BROWSER 0x20
34 #define DT_SORT_KEYS 0x40
35 #define DT_SORT_AUX 0x80
37 /* flags to parse_set() */
38 #define M_SET_INV (1<<0) /* default is to invert all vars */
39 #define M_SET_UNSET (1<<1) /* default is to unset all vars */
40 #define M_SET_RESET (1<<2) /* default is to reset all vars to default */
42 /* forced redraw/resort types */
44 #define R_INDEX (1<<0)
45 #define R_PAGER (1<<1)
46 #define R_BOTH (R_INDEX|R_PAGER)
48 /* TODO:MC: will go in the the thread module */
49 #define R_RESORT (1<<2) /* resort the mailbox */
50 #define R_RESORT_SUB (1<<3) /* resort subthreads */
51 #define R_RESORT_INIT (1<<4) /* resort from scratch */
52 #define R_TREE (1<<5) /* redraw the thread tree */
53 #define R_RESORT_BOTH (R_RESORT|R_RESORT_SUB)
63 #define UL (unsigned long)
67 /* build complete documentation */
69 struct option_t MuttVars[] = {
71 {"abort_noattach", DT_QUAD, R_NONE, OPT_ATTACH, "no" },
74 ** This variable specifies whether to abort sending if no attachment
75 ** was made but the content references them, i.e. the content
76 ** matches the regular expression given in
77 ** $$attach_remind_regexp. If a match was found and this
78 ** variable is set to \fIyes\fP, message sending will be aborted
79 ** but the mail will be send nevertheless if set to \fIno\fP.
82 ** This variable and $$attach_remind_regexp are intended to
83 ** remind the user to attach files if the message's text
87 ** See also the $$attach_remind_regexp variable.
89 {"abort_nosubject", DT_QUAD, R_NONE, OPT_SUBJECT, "ask-yes" },
92 ** If set to \fIyes\fP, when composing messages and no subject is given
93 ** at the subject prompt, composition will be aborted. If set to
94 ** \fIno\fP, composing messages with no subject given at the subject
95 ** prompt will never be aborted.
97 {"abort_unmodified", DT_QUAD, R_NONE, OPT_ABORT, "yes" },
100 ** If set to \fIyes\fP, composition will automatically abort after
101 ** editing the message body if no changes are made to the file (this
102 ** check only happens after the \fIfirst\fP edit of the file). When set
103 ** to \fIno\fP, composition will never be aborted.
105 {"allow_8bit", DT_BOOL, R_NONE, OPTALLOW8BIT, "yes" },
108 ** Controls whether 8-bit data is converted to 7-bit using either
109 ** \fTquoted-printable\fP or \fTbase64\fP encoding when sending mail.
111 {"askbcc", DT_BOOL, R_NONE, OPTASKBCC, "no" },
114 ** If \fIset\fP, Madmutt will prompt you for blind-carbon-copy (Bcc) recipients
115 ** before editing an outgoing message.
117 {"askcc", DT_BOOL, R_NONE, OPTASKCC, "no" },
120 ** If \fIset\fP, Madmutt will prompt you for carbon-copy (Cc) recipients before
121 ** editing the body of an outgoing message.
123 {"attach_format", DT_STR, R_NONE, UL &AttachFormat, "%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] "},
126 ** This variable describes the format of the ``attachment'' menu. The
127 ** following \fTprintf(3)\fP-style sequences are understood:
130 ** .dt %C .dd charset
131 ** .dt %c .dd requires charset conversion (n or c)
132 ** .dt %D .dd deleted flag
133 ** .dt %d .dd description
134 ** .dt %e .dd MIME \fTContent-Transfer-Encoding:\fP header field
135 ** .dt %f .dd filename
136 ** .dt %I .dd MIME \fTContent-Disposition:\fP header field (\fTI\fP=inline, \fTA\fP=attachment)
137 ** .dt %m .dd major MIME type
138 ** .dt %M .dd MIME subtype
139 ** .dt %n .dd attachment number
140 ** .dt %Q .dd "Q", if MIME part qualifies for attachment counting
142 ** .dt %t .dd tagged flag
143 ** .dt %T .dd graphic tree characters
144 ** .dt %u .dd unlink (=to delete) flag
145 ** .dt %X .dd number of qualifying MIME parts in this part and its children
146 ** .dt %>X .dd right justify the rest of the string and pad with character "X"
147 ** .dt %|X .dd pad to the end of the line with character "X"
150 {"attach_remind_regexp", DT_RX, R_NONE, UL &AttachRemindRegexp, "attach"},
153 ** If this variable is non-empty, madmutt will scan a message's contents
154 ** before sending for this regular expression. If it is found, it will
155 ** ask for what to do depending on the setting of $$abort_noattach.
157 ** This variable and $$abort_noattach are intended to remind the user
158 ** to attach files if the message's text references them.
160 {"attach_sep", DT_STR, R_NONE, UL &AttachSep, "\n"},
163 ** The separator to add between attachments when operating (saving,
164 ** printing, piping, etc) on a list of tagged attachments.
166 {"attach_split", DT_BOOL, R_NONE, OPTATTACHSPLIT, "yes" },
169 ** If this variable is \fIunset\fP, when operating (saving, printing, piping,
170 ** etc) on a list of tagged attachments, Madmutt will concatenate the
171 ** attachments and will operate on them as a single attachment. The
172 ** ``$$attach_sep'' separator is added after each attachment. When \fIset\fP,
173 ** Madmutt will operate on the attachments one by one.
175 {"attribution", DT_STR, R_NONE, UL &Attribution, "On %d, %n wrote:"},
178 ** This is the string that will precede a message which has been included
179 ** in a reply. For a full listing of defined \fTprintf(3)\fP-like sequences see
180 ** the section on ``$$index_format''.
182 {"autoedit", DT_BOOL, R_NONE, OPTAUTOEDIT, "no" },
185 ** When \fIset\fP along with ``$$edit_headers'', Madmutt will skip the initial
186 ** send-menu and allow you to immediately begin editing the body of your
187 ** message. The send-menu may still be accessed once you have finished
188 ** editing the body of your message.
190 ** Also see ``$$fast_reply''.
192 {"auto_tag", DT_BOOL, R_NONE, OPTAUTOTAG, "no" },
195 ** When \fIset\fP, functions in the \fIindex\fP menu which affect a message
196 ** will be applied to all tagged messages (if there are any). When
197 ** unset, you must first use the ``tag-prefix'' function (default: "\fT;\fP") to
198 ** make the next function apply to all tagged messages.
200 {"bounce", DT_QUAD, R_NONE, OPT_BOUNCE, "ask-yes" },
203 ** Controls whether you will be asked to confirm bouncing messages.
204 ** If set to \fIyes\fP you don't get asked if you want to bounce a
205 ** message. Setting this variable to \fIno\fP is not generally useful,
206 ** and thus not recommended, because you are unable to bounce messages.
208 {"bounce_delivered", DT_BOOL, R_NONE, OPTBOUNCEDELIVERED, "yes" },
211 ** When this variable is \fIset\fP, Madmutt will include
212 ** \fTDelivered-To:\fP header fields when bouncing messages.
213 ** Postfix users may wish to \fIunset\fP this variable.
215 {"check_new", DT_BOOL, R_NONE, OPTCHECKNEW, "yes" },
218 ** \fBNote:\fP this option only affects \fImaildir\fP and \fIMH\fP style
221 ** When \fIset\fP, Madmutt will check for new mail delivered while the
222 ** mailbox is open. Especially with MH mailboxes, this operation can
223 ** take quite some time since it involves scanning the directory and
224 ** checking each file to see if it has already been looked at. If it's
225 ** \fIunset\fP, no check for new mail is performed while the mailbox is open.
227 {"collapse_unread", DT_BOOL, R_NONE, OPTCOLLAPSEUNREAD, "yes" },
230 ** When \fIunset\fP, Madmutt will not collapse a thread if it contains any
233 {"uncollapse_jump", DT_BOOL, R_NONE, OPTUNCOLLAPSEJUMP, "no" },
236 ** When \fIset\fP, Madmutt will jump to the next unread message, if any,
237 ** when the current thread is \fIun\fPcollapsed.
239 {"compose_format", DT_STR, R_BOTH, UL &ComposeFormat, "-- Madmutt: Compose [Approx. msg size: %l Atts: %a]%>-"},
242 ** Controls the format of the status line displayed in the ``compose''
243 ** menu. This string is similar to ``$$status_format'', but has its own
244 ** set of \fTprintf(3)\fP-like sequences:
247 ** .dt %a .dd total number of attachments
248 ** .dt %h .dd local hostname
249 ** .dt %l .dd approximate size (in bytes) of the current message
250 ** .dt %v .dd Madmutt version string
253 ** See the text describing the ``$$status_format'' option for more
254 ** information on how to set ``$$compose_format''.
256 {"config_charset", DT_STR, R_NONE, UL &ConfigCharset, "" },
259 ** When defined, Madmutt will recode commands in rc files from this
262 {"confirmappend", DT_BOOL, R_NONE, OPTCONFIRMAPPEND, "yes" },
265 ** When \fIset\fP, Madmutt will prompt for confirmation when appending messages to
266 ** an existing mailbox.
268 {"confirmcreate", DT_BOOL, R_NONE, OPTCONFIRMCREATE, "yes" },
271 ** When \fIset\fP, Madmutt will prompt for confirmation when saving messages to a
272 ** mailbox which does not yet exist before creating it.
274 {"connect_timeout", DT_NUM, R_NONE, UL &ConnectTimeout, "30" },
277 ** Causes Madmutt to timeout a network connection (for IMAP or POP) after this
278 ** many seconds if the connection is not able to be established. A negative
279 ** value causes Madmutt to wait indefinitely for the connection to succeed.
281 {"content_type", DT_STR, R_NONE, UL &ContentType, "text/plain"},
284 ** Sets the default \fTContent-Type:\fP header field for the body
285 ** of newly composed messages.
287 {"copy", DT_QUAD, R_NONE, OPT_COPY, "yes" },
290 ** This variable controls whether or not copies of your outgoing messages
291 ** will be saved for later references. Also see ``$$record'',
292 ** and ``$fcc-hook''.
294 {"date_format", DT_STR, R_BOTH, UL &DateFmt, "!%a, %b %d, %Y at %I:%M:%S%p %Z"},
297 ** This variable controls the format of the date printed by the ``\fT%d\fP''
298 ** sequence in ``$$index_format''. This is passed to \fTstrftime(3)\fP
299 ** to process the date.
301 ** Unless the first character in the string is a bang (``\fT!\fP''), the month
302 ** and week day names are expanded according to the locale specified in
303 ** the variable ``$$locale''. If the first character in the string is a
304 ** bang, the bang is discarded, and the month and week day names in the
305 ** rest of the string are expanded in the \fIC\fP locale (that is in US
308 {"default_hook", DT_STR, R_NONE, UL &DefaultHook, "~f %s !~P | (~P ~C %s)"},
311 ** This variable controls how send-hooks, message-hooks, save-hooks,
312 ** and fcc-hooks will
313 ** be interpreted if they are specified with only a simple regexp,
314 ** instead of a matching pattern. The hooks are expanded when they are
315 ** declared, so a hook will be interpreted according to the value of this
316 ** variable at the time the hook is declared. The default value matches
317 ** if the message is either from a user matching the regular expression
318 ** given, or if it is from you (if the from address matches
319 ** ``alternates'') and is to or cc'ed to a user matching the given
320 ** regular expression.
322 {"delete", DT_QUAD, R_NONE, OPT_DELETE, "ask-yes" },
325 ** Controls whether or not messages are really deleted when closing or
326 ** synchronizing a mailbox. If set to \fIyes\fP, messages marked for
327 ** deleting will automatically be purged without prompting. If set to
328 ** \fIno\fP, messages marked for deletion will be kept in the mailbox.
330 {"delete_space", DT_BOOL, R_NONE, OPTDELSP, "no" },
333 ** When sending messages with \fTformat=flowed\fP by \fIsetting\fP the
334 ** $$text_flowed variable, this variable specifies whether to also
335 ** set the \fTDelSp\fP parameter to \fTyes\fP. If this is \fIunset\fP,
336 ** no additional parameter will be send as a value of \fTno\fP already
337 ** is the default behavior.
340 ** \fBNote:\fP this variable only has an effect on \fIoutgoing\fP messages
341 ** (if $$text_flowed is \fIset\fP) but not on incomming.
343 {"delete_untag", DT_BOOL, R_NONE, OPTDELETEUNTAG, "yes" },
346 ** If this option is \fIset\fP, Madmutt will untag messages when marking them
347 ** for deletion. This applies when you either explicitly delete a message,
348 ** or when you save it to another folder.
350 {"digest_collapse", DT_BOOL, R_NONE, OPTDIGESTCOLLAPSE, "yes" },
353 ** If this option is \fIset\fP, Madmutt's received-attachments menu will not show the subparts of
354 ** individual messages in a multipart/digest. To see these subparts, press 'v' on that menu.
356 {"display_filter", DT_PATH, R_PAGER, UL &DisplayFilter, ""},
359 ** When \fIset\fP, specifies a command used to filter messages. When a message
360 ** is viewed it is passed as standard input to $$display_filter, and the
361 ** filtered message is read from the standard output.
363 {"duplicate_threads", DT_BOOL, R_RESORT|R_RESORT_INIT|R_INDEX, OPTDUPTHREADS, "yes" },
366 ** This variable controls whether Madmutt, when sorting by threads, threads
367 ** messages with the same \fTMessage-ID:\fP header field together.
368 ** If it is \fIset\fP, it will indicate that it thinks they are duplicates
369 ** of each other with an equals sign in the thread diagram.
371 {"edit_headers", DT_BOOL, R_NONE, OPTEDITHDRS, "no" },
374 ** This option allows you to edit the header of your outgoing messages
375 ** along with the body of your message.
378 ** Which empty header fields to show is controlled by the
379 ** $$editor_headers option.
382 {"editor_headers", DT_STR, R_NONE, UL &EditorHeaders, "From: To: Cc: Bcc: Subject: Reply-To: Newsgroups: Followup-To: X-Comment-To:" },
384 {"editor_headers", DT_STR, R_NONE, UL &EditorHeaders, "From: To: Cc: Bcc: Subject: Reply-To:" },
388 ** If $$edit_headers is \fIset\fP, this space-separated list specifies
389 ** which \fInon-empty\fP header fields to edit in addition to
390 ** user-defined headers.
393 ** Note: if $$edit_headers had to be turned on by force because
394 ** $$strict_mailto is \fIunset\fP, this option has no effect.
396 {"encode_from", DT_BOOL, R_NONE, OPTENCODEFROM, "no" },
399 ** When \fIset\fP, Madmutt will \fTquoted-printable\fP encode messages when
400 ** they contain the string ``\fTFrom \fP'' (note the trailing space)
401 ** in the beginning of a line. Useful to avoid the tampering certain mail
402 ** delivery and transport agents tend to do with messages.
405 ** \fBNote:\fP as Madmutt currently violates RfC3676 defining
406 ** \fTformat=flowed\fP, it's <em/strongly/ advised to \fIset\fP
407 ** this option although discouraged by the standard. Alternatively,
408 ** you must take care of space-stuffing <tt/From / lines (with a trailing
411 {"fast_reply", DT_BOOL, R_NONE, OPTFASTREPLY, "no" },
414 ** When \fIset\fP, the initial prompt for recipients and subject are skipped
415 ** when replying to messages, and the initial prompt for subject is
416 ** skipped when forwarding messages.
418 ** \fBNote:\fP this variable has no effect when the ``$$autoedit''
419 ** variable is \fIset\fP.
421 {"fcc_attach", DT_BOOL, R_NONE, OPTFCCATTACH, "yes" },
424 ** This variable controls whether or not attachments on outgoing messages
425 ** are saved along with the main body of your message.
427 {"fcc_clear", DT_BOOL, R_NONE, OPTFCCCLEAR, "no" },
430 ** When this variable is \fIset\fP, FCCs will be stored unencrypted and
431 ** unsigned, even when the actual message is encrypted and/or
435 {"folder", DT_PATH, R_NONE, UL &Maildir, "~/Mail"},
438 ** Specifies the default location of your mailboxes. A ``\fT+\fP'' or ``\fT=\fP'' at the
439 ** beginning of a pathname will be expanded to the value of this
440 ** variable. Note that if you change this variable from the default
441 ** value you need to make sure that the assignment occurs \fIbefore\fP
442 ** you use ``+'' or ``='' for any other variables since expansion takes place
443 ** during the ``set'' command.
445 {"folder_format", DT_STR, R_INDEX, UL &FolderFormat, "%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f"},
448 ** This variable allows you to customize the file browser display to your
449 ** personal taste. This string is similar to ``$$index_format'', but has
450 ** its own set of \fTprintf(3)\fP-like sequences:
453 ** .dt %C .dd current file number
454 ** .dt %d .dd date/time folder was last modified
455 ** .dt %f .dd filename
456 ** .dt %F .dd file permissions
457 ** .dt %g .dd group name (or numeric gid, if missing)
458 ** .dt %l .dd number of hard links
459 ** .dt %N .dd N if folder has new mail, blank otherwise
460 ** .dt %s .dd size in bytes
461 ** .dt %t .dd * if the file is tagged, blank otherwise
462 ** .dt %u .dd owner name (or numeric uid, if missing)
463 ** .dt %>X .dd right justify the rest of the string and pad with character "X"
464 ** .dt %|X .dd pad to the end of the line with character "X"
467 {"followup_to", DT_BOOL, R_NONE, OPTFOLLOWUPTO, "yes" },
470 ** Controls whether or not the \fTMail-Followup-To:\fP header field is
471 ** generated when sending mail. When \fIset\fP, Madmutt will generate this
472 ** field when you are replying to a known mailing list, specified with
473 ** the ``subscribe'' or ``$lists'' commands or detected by common mailing list
476 ** This field has two purposes. First, preventing you from
477 ** receiving duplicate copies of replies to messages which you send
478 ** to mailing lists. Second, ensuring that you do get a reply
479 ** separately for any messages sent to known lists to which you are
480 ** not subscribed. The header will contain only the list's address
481 ** for subscribed lists, and both the list address and your own
482 ** email address for unsubscribed lists. Without this header, a
483 ** group reply to your message sent to a subscribed list will be
484 ** sent to both the list and your address, resulting in two copies
485 ** of the same email for you.
487 {"force_buffy_check", DT_BOOL, R_NONE, OPTFORCEBUFFYCHECK, "no" },
490 ** When \fIset\fP, it causes Madmutt to check for new mail when the
491 ** \fIbuffy-list\fP command is invoked. When \fIunset\fP, \fIbuffy_list\fP
492 ** will just list all mailboxes which are already known to have new mail.
494 ** Also see the following variables: ``$$timeout'', ``$$mail_check'' and
495 ** ``$$imap_mail_check''.
497 {"forward_decode", DT_BOOL, R_NONE, OPTFORWDECODE, "yes" },
500 ** Controls the decoding of complex MIME messages into \fTtext/plain\fP when
501 ** forwarding a message. The message header is also RFC2047 decoded.
502 ** This variable is only used, if ``$$mime_forward'' is \fIunset\fP,
503 ** otherwise ``$$mime_forward_decode'' is used instead.
505 {"forward_edit", DT_QUAD, R_NONE, OPT_FORWEDIT, "yes" },
508 ** This quadoption controls whether or not the user is automatically
509 ** placed in the editor when forwarding messages. For those who always want
510 ** to forward with no modification, use a setting of \fIno\fP.
512 {"forward_format", DT_STR, R_NONE, UL &ForwFmt, "[%a: %s]"},
515 ** This variable controls the default subject when forwarding a message.
516 ** It uses the same format sequences as the ``$$index_format'' variable.
518 {"forward_quote", DT_BOOL, R_NONE, OPTFORWQUOTE, "no" },
521 ** When \fIset\fP forwarded messages included in the main body of the
522 ** message (when ``$$mime_forward'' is \fIunset\fP) will be quoted using
523 ** ``$$indent_string''.
525 {"header", DT_BOOL, R_NONE, OPTHEADER, "no" },
528 ** When \fIset\fP, this variable causes Madmutt to include the header
529 ** of the message you are replying to into the edit buffer.
530 ** The ``$$weed'' setting applies.
532 {"hidden_host", DT_BOOL, R_NONE, OPTHIDDENHOST, "no" },
535 ** When \fIset\fP, Madmutt will skip the host name part of ``$$hostname'' variable
536 ** when adding the domain part to addresses. This variable does not
537 ** affect the generation of \fTMessage-ID:\fP header fields, and it will not lead to the
538 ** cut-off of first-level domains.
540 {"hide_limited", DT_BOOL, R_TREE|R_INDEX, OPTHIDELIMITED, "no" },
543 ** When \fIset\fP, Madmutt will not show the presence of messages that are hidden
544 ** by limiting, in the thread tree.
546 {"hide_missing", DT_BOOL, R_TREE|R_INDEX, OPTHIDEMISSING, "yes" },
549 ** When \fIset\fP, Madmutt will not show the presence of missing messages in the
552 {"hide_thread_subject", DT_BOOL, R_TREE|R_INDEX, OPTHIDETHREADSUBJECT, "yes" },
555 ** When \fIset\fP, Madmutt will not show the subject of messages in the thread
556 ** tree that have the same subject as their parent or closest previously
557 ** displayed sibling.
559 {"hide_top_limited", DT_BOOL, R_TREE|R_INDEX, OPTHIDETOPLIMITED, "no" },
562 ** When \fIset\fP, Madmutt will not show the presence of messages that are hidden
563 ** by limiting, at the top of threads in the thread tree. Note that when
564 ** $$hide_missing is \fIset\fP, this option will have no effect.
566 {"hide_top_missing", DT_BOOL, R_TREE|R_INDEX, OPTHIDETOPMISSING, "yes" },
569 ** When \fIset\fP, Madmutt will not show the presence of missing messages at the
570 ** top of threads in the thread tree. Note that when $$hide_limited is
571 ** \fIset\fP, this option will have no effect.
573 {"history", DT_NUM, R_NONE, UL &HistSize, "10" },
576 ** This variable controls the size (in number of strings remembered) of
577 ** the string history buffer. The buffer is cleared each time the
578 ** variable is changed.
580 {"honor_followup_to", DT_QUAD, R_NONE, OPT_MFUPTO, "yes" },
583 ** This variable controls whether or not a \fTMail-Followup-To:\fP header field is
584 ** honored when group-replying to a message.
586 {"ignore_list_reply_to", DT_BOOL, R_NONE, OPTIGNORELISTREPLYTO, "no" },
589 ** Affects the behaviour of the \fIreply\fP function when replying to
590 ** messages from mailing lists. When \fIset\fP, if the ``\fTReply-To:\fP'' header field is
591 ** set to the same value as the ``\fTTo:\fP'' header field, Madmutt assumes that the
592 ** ``\fTReply-To:\fP'' header field was set by the mailing list to automate responses
593 ** to the list, and will ignore this field. To direct a response to the
594 ** mailing list when this option is set, use the \fIlist-reply\fP
595 ** function; \fIgroup-reply\fP will reply to both the sender and the
597 ** Remember: This option works only for mailing lists which are explicitly set in your madmuttrc
598 ** configuration file.
600 {"imap_authenticators", DT_STR, R_NONE, UL &ImapAuthenticators, "" },
603 ** This is a colon-delimited list of authentication methods Madmutt may
604 ** attempt to use to log in to an IMAP server, in the order Madmutt should
605 ** try them. Authentication methods are either ``\fTlogin\fP'' or the right
606 ** side of an IMAP ``\fTAUTH=\fP'' capability string, e.g. ``\fTdigest-md5\fP'',
607 ** ``\fTgssapi\fP'' or ``\fTcram-md5\fP''. This parameter is case-insensitive.
610 ** parameter is \fIunset\fP (the default) Madmutt will try all available methods,
611 ** in order from most-secure to least-secure.
613 ** Example: \fTset imap_authenticators="gssapi:cram-md5:login"\fP
615 ** \fBNote:\fP Madmutt will only fall back to other authentication methods if
616 ** the previous methods are unavailable. If a method is available but
617 ** authentication fails, Madmutt will not connect to the IMAP server.
619 { "imap_check_subscribed", DT_BOOL, R_NONE, OPTIMAPCHECKSUBSCRIBED, "no" },
622 ** When \fIset\fP, mutt will fetch the set of subscribed folders from
623 ** your server on connection, and add them to the set of mailboxes
624 ** it polls for new mail. See also the ``$mailboxes'' command.
626 {"imap_delim_chars", DT_STR, R_NONE, UL &ImapDelimChars, "/."},
629 ** This contains the list of characters which you would like to treat
630 ** as folder separators for displaying IMAP paths. In particular it
631 ** helps in using the '\fT=\fP' shortcut for your $$folder variable.
633 {"imap_headers", DT_STR, R_INDEX, UL &ImapHeaders, "" },
636 ** Madmutt requests these header fields in addition to the default headers
637 ** (``DATE FROM SUBJECT TO CC MESSAGE-ID REFERENCES CONTENT-TYPE
638 ** CONTENT-DESCRIPTION IN-REPLY-TO REPLY-TO LINES X-LABEL'') from IMAP
639 ** servers before displaying the ``index'' menu. You may want to add more
640 ** headers for spam detection.
642 ** \fBNote:\fP This is a space separated list.
644 {"imap_keepalive", DT_NUM, R_NONE, UL &ImapKeepalive, "900" },
647 ** This variable specifies the maximum amount of time in seconds that Madmutt
648 ** will wait before polling open IMAP connections, to prevent the server
649 ** from closing them before Madmutt has finished with them.
652 ** well within the RFC-specified minimum amount of time (30 minutes) before
653 ** a server is allowed to do this, but in practice the RFC does get
654 ** violated every now and then.
656 ** Reduce this number if you find yourself
657 ** getting disconnected from your IMAP server due to inactivity.
659 {"imap_login", DT_STR, R_NONE, UL &ImapLogin, "" },
662 ** Your login name on the IMAP server.
664 ** This variable defaults to the value of ``$$imap_user.''
666 {"imap_list_subscribed", DT_BOOL, R_NONE, OPTIMAPLSUB, "no" },
669 ** This variable configures whether IMAP folder browsing will look for
670 ** only subscribed folders or all folders. This can be toggled in the
671 ** IMAP browser with the \fItoggle-subscribed\fP function.
673 {"imap_mail_check", DT_NUM, R_NONE, UL &ImapBuffyTimeout, "300" },
676 ** This variable configures how often (in seconds) Madmutt should look for
677 ** new mail in IMAP folders. This is split from the ``$mail_check'' variable
678 ** to generate less traffic and get more accurate information for local folders.
680 {"imap_pass", DT_STR, R_NONE, UL &ImapPass, "" },
683 ** Specifies the password for your IMAP account. If \fIunset\fP, Madmutt will
684 ** prompt you for your password when you invoke the fetch-mail function.
686 ** \fBWarning\fP: you should only use this option when you are on a
687 ** fairly secure machine, because the superuser can read your configuration even
688 ** if you are the only one who can read the file.
690 {"imap_passive", DT_BOOL, R_NONE, OPTIMAPPASSIVE, "yes" },
693 ** When \fIset\fP, Madmutt will not open new IMAP connections to check for new
694 ** mail. Madmutt will only check for new mail over existing IMAP
695 ** connections. This is useful if you don't want to be prompted to
696 ** user/password pairs on Madmutt invocation, or if opening the connection
699 {"imap_reconnect", DT_QUAD, R_NONE, OPT_IMAPRECONNECT, "ask-yes" },
702 ** Controls whether or not Madmutt will try to reconnect to IMAP server when
703 ** the connection is lost.
705 {"imap_servernoise", DT_BOOL, R_NONE, OPTIMAPSERVERNOISE, "yes" },
708 ** When \fIset\fP, Madmutt will display warning messages from the IMAP
709 ** server as error messages. Since these messages are often
710 ** harmless, or generated due to configuration problems on the
711 ** server which are out of the users' hands, you may wish to suppress
712 ** them at some point.
714 {"imap_user", DT_STR, R_NONE, UL &ImapUser, "" },
717 ** The name of the user whose mail you intend to access on the IMAP
720 ** This variable defaults to your user name on the local machine.
722 {"implicit_autoview", DT_BOOL, R_NONE, OPTIMPLICITAUTOVIEW, "no" },
725 ** If \fIset\fP, Madmutt will look for a mailcap entry with the
726 ** ``\fTcopiousoutput\fP'' flag set for \fIevery\fP MIME attachment it doesn't have
727 ** an internal viewer defined for. If such an entry is found, Madmutt will
728 ** use the viewer defined in that entry to convert the body part to text
731 {"include", DT_QUAD, R_NONE, OPT_INCLUDE, "ask-yes" },
734 ** Controls whether or not a copy of the message(s) you are replying to
735 ** is included in your reply.
737 {"indent_string", DT_STR, R_NONE, UL &Prefix, "> "},
740 ** Specifies the string to prepend to each line of text quoted in a
741 ** message to which you are replying. You are strongly encouraged not to
742 ** change this value, as it tends to agitate the more fanatical netizens.
744 {"index_format", DT_STR, R_BOTH, UL &HdrFmt, "%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s"},
747 ** This variable allows you to customize the message index display to
748 ** your personal taste.
750 ** ``Format strings'' are similar to the strings used in the ``C''
751 ** function \fTprintf(3)\fP to format output (see the man page for more detail).
752 ** The following sequences are defined in Madmutt:
755 ** .dt %a .dd address of the author
756 ** .dt %A .dd reply-to address (if present; otherwise: address of author)
757 ** .dt %b .dd filename of the original message folder (think mailBox)
758 ** .dt %B .dd the list to which the letter was sent, or else the folder name (%b).
759 ** .dt %c .dd number of characters (bytes) in the message
760 ** .dt %C .dd current message number
761 ** .dt %d .dd date and time of the message in the format specified by
762 ** ``date_format'' converted to sender's time zone
763 ** .dt %D .dd date and time of the message in the format specified by
764 ** ``date_format'' converted to the local time zone
765 ** .dt %e .dd current message number in thread
766 ** .dt %E .dd number of messages in current thread
767 ** .dt %f .dd entire From: line (address + real name)
768 ** .dt %F .dd author name, or recipient name if the message is from you
769 ** .dt %H .dd spam attribute(s) of this message
770 ** .dt %g .dd newsgroup name (if compiled with nntp support)
771 ** .dt %i .dd message-id of the current message
772 ** .dt %l .dd number of lines in the message (does not work with maildir,
773 ** mh, and possibly IMAP folders)
774 ** .dt %L .dd If an address in the To or CC header field matches an address
775 ** defined by the users ``subscribe'' command, this displays
776 ** "To <list-name>", otherwise the same as %F.
777 ** .dt %m .dd total number of message in the mailbox
778 ** .dt %M .dd number of hidden messages if the thread is collapsed.
779 ** .dt %N .dd message score
780 ** .dt %n .dd author's real name (or address if missing)
781 ** .dt %O .dd (_O_riginal save folder) Where Madmutt would formerly have
782 ** stashed the message: list name or recipient name if no list
783 ** .dt %s .dd subject of the message
784 ** .dt %S .dd status of the message (N/D/d/!/r/\(as)
785 ** .dt %t .dd `to:' field (recipients)
786 ** .dt %T .dd the appropriate character from the $$to_chars string
787 ** .dt %u .dd user (login) name of the author
788 ** .dt %v .dd first name of the author, or the recipient if the message is from you
789 ** .dt %W .dd name of organization of author (`organization:' field)
790 ** .dt %X .dd number of attachments
791 ** .dt %y .dd `x-label:' field, if present
792 ** .dt %Y .dd `x-label' field, if present, and (1) not at part of a thread tree,
793 ** (2) at the top of a thread, or (3) `x-label' is different from
794 ** preceding message's `x-label'.
795 ** .dt %Z .dd message status flags
796 ** .dt %{fmt} .dd the date and time of the message is converted to sender's
797 ** time zone, and ``fmt'' is expanded by the library function
798 ** ``strftime''; a leading bang disables locales
799 ** .dt %[fmt] .dd the date and time of the message is converted to the local
800 ** time zone, and ``fmt'' is expanded by the library function
801 ** ``strftime''; a leading bang disables locales
802 ** .dt %(fmt) .dd the local date and time when the message was received.
803 ** ``fmt'' is expanded by the library function ``strftime'';
804 ** a leading bang disables locales
805 ** .dt %<fmt> .dd the current local time. ``fmt'' is expanded by the library
806 ** function ``strftime''; a leading bang disables locales.
807 ** .dt %>X .dd right justify the rest of the string and pad with character "X"
808 ** .dt %|X .dd pad to the end of the line with character "X"
811 ** See also: ``$$to_chars''.
813 {"keep_flagged", DT_BOOL, R_NONE, OPTKEEPFLAGGED, "no" },
816 ** If \fIset\fP, read messages marked as flagged will not be moved
817 ** from your spool mailbox to your ``$$mbox'' mailbox, or as a result of
818 ** a ``$mbox-hook'' command.
820 {"locale", DT_STR, R_BOTH, UL &Locale, "C"},
823 ** The locale used by \fTstrftime(3)\fP to format dates. Legal values are
824 ** the strings your system accepts for the locale variable \fTLC_TIME\fP.
826 {"force_list_reply", DT_QUAD, R_NONE, OPT_LISTREPLY, "ask-no" },
829 ** This variable controls what effect ordinary replies have on mailing list
830 ** messages: if \fIset\fP, a normal reply will be interpreted as list-reply
831 ** while if it's \fIunset\fP the reply functions work as usual.
833 {"max_display_recips", DT_NUM, R_PAGER, UL &MaxDispRecips, "0" },
836 ** When set non-zero, this specifies the maximum number of recipient header
837 ** lines (\fTTo:\fP, \fTCc:\fP and \fTBcc:\fP) to display in the pager if header
838 ** weeding is turned on. In case the number of lines exeeds its value, the
839 ** last line will have 3 dots appended.
841 {"max_line_length", DT_NUM, R_PAGER, UL &MaxLineLength, "0" },
844 ** When \fIset\fP, the maximum line length for displaying ``format = flowed'' messages is limited
845 ** to this length. A value of 0 (which is also the default) means that the
846 ** maximum line length is determined by the terminal width and $$wrapmargin.
848 {"maildir_trash", DT_BOOL, R_NONE, OPTMAILDIRTRASH, "no" },
851 ** If \fIset\fP, messages marked as deleted will be saved with the maildir
852 ** (T)rashed flag instead of physically deleted.
854 ** \fBNOTE:\fP this only applies
855 ** to maildir-style mailboxes. Setting it will have no effect on other
858 ** It is similiar to the trash option.
860 {"mark_old", DT_BOOL, R_BOTH, OPTMARKOLD, "yes" },
863 ** Controls whether or not Madmutt marks \fInew\fP \fBunread\fP
864 ** messages as \fIold\fP if you exit a mailbox without reading them.
866 ** With this option \fIset\fP, the next time you start Madmutt, the messages
867 ** will show up with an "O" next to them in the ``index'' menu,
868 ** indicating that they are old.
870 {"markers", DT_BOOL, R_PAGER, OPTMARKERS, "yes" },
873 ** Controls the display of wrapped lines in the internal pager. If set, a
874 ** ``\fT+\fP'' marker is displayed at the beginning of wrapped lines. Also see
875 ** the ``$$smart_wrap'' variable.
877 {"mask", DT_RX, R_NONE, UL &Mask, "!^\\.[^.]"},
880 ** A regular expression used in the file browser, optionally preceded by
881 ** the \fInot\fP operator ``\fT!\fP''. Only files whose names match this mask
882 ** will be shown. The match is always case-sensitive.
884 {"mbox", DT_PATH, R_BOTH, UL &Inbox, "~/mbox"},
887 ** This specifies the folder into which read mail in your ``$$spoolfile''
888 ** folder will be appended.
890 {"sidebar_boundary", DT_STR, R_BOTH, UL &SidebarBoundary, "." },
893 ** When the sidebar is displayed and $$sidebar_shorten_hierarchy is \fIset\fP, this
894 ** variable specifies the characters at which to split a folder name into
895 ** ``hierarchy items.''
897 {"sidebar_visible", DT_BOOL, R_BOTH, OPTMBOXPANE, "no" },
900 ** This specifies whether or not to show the sidebar (a list of folders specified
901 ** with the ``mailboxes'' command).
903 {"sidebar_width", DT_NUM, R_BOTH, UL &SidebarWidth, "0" },
906 ** The width of the sidebar.
908 {"sidebar_newmail_only", DT_BOOL, R_BOTH, OPTSIDEBARNEWMAILONLY, "no" },
911 ** If \fIset\fP, only folders with new mail will be shown in the sidebar.
913 {"sidebar_number_format", DT_STR, R_BOTH, UL &SidebarNumberFormat, "%m%?n?(%n)?%?f?[%f]?"},
916 ** This variable controls how message counts are printed when the sidebar
917 ** is enabled. If this variable is \fIempty\fP (\fIand only if\fP), no numbers
918 ** will be printed \fIand\fP Madmutt won't frequently count mail (which
919 ** may be a great speedup esp. with mbox-style mailboxes.)
921 ** The following \fTprintf(3)\fP-like sequences are supported all of which
922 ** may be printed non-zero:
925 ** .dt %d .dd Number of deleted messages. 1)
926 ** .dt %F .dd Number of flagged messages.
927 ** .dt %m .dd Total number of messages.
928 ** .dt %M .dd Total number of messages shown, i.e. not hidden by a limit. 1)
929 ** .dt %n .dd Number of new messages.
930 ** .dt %t .dd Number of tagged messages. 1)
931 ** .dt %u .dd Number of unread messages.
934 ** 1) These expandos only have a non-zero value for the current mailbox and
935 ** will always be zero otherwise.
937 {"sidebar_shorten_hierarchy", DT_BOOL, R_NONE, OPTSHORTENHIERARCHY, "no" },
940 ** When \fIset\fP, the ``hierarchy'' of the sidebar entries will be shortened
941 ** only if they cannot be printed in full length (because ``$$sidebar_width''
942 ** is set to a too low value). For example, if the newsgroup name
943 ** ``de.alt.sysadmin.recovery'' doesn't fit on the screen, it'll get shortened
944 ** ``d.a.s.recovery'' while ``de.alt.d0'' still would and thus will not get
947 ** At which characters this compression is done is controled via the
948 ** $$sidebar_boundary variable.
950 {"mbox_type", DT_MAGIC, R_NONE, UL &DefaultMagic, "mbox" },
953 ** The default mailbox type used when creating new folders. May be any of
954 ** \fTmbox\fP, \fTMH\fP and \fTMaildir\fP.
956 {"metoo", DT_BOOL, R_NONE, OPTMETOO, "no" },
959 ** If \fIunset\fP, Madmutt will remove your address (see the ``alternates''
960 ** command) from the list of recipients when replying to a message.
962 {"menu_context", DT_NUM, R_NONE, UL &MenuContext, "0" },
965 ** This variable controls the number of lines of context that are given
966 ** when scrolling through menus. (Similar to ``$$pager_context''.)
968 {"mh_purge", DT_BOOL, R_NONE, OPTMHPURGE, "no" },
971 ** When \fIunset\fP, Madmutt will mimic mh's behaviour and rename deleted messages
972 ** to \fI,<old file name>\fP in mh folders instead of really deleting
973 ** them. If the variable is set, the message files will simply be
976 {"mh_seq_flagged", DT_STR, R_NONE, UL &MhFlagged, "flagged"},
979 ** The name of the MH sequence used for flagged messages.
981 {"mh_seq_replied", DT_STR, R_NONE, UL &MhReplied, "replied"},
984 ** The name of the MH sequence used to tag replied messages.
986 {"mh_seq_unseen", DT_STR, R_NONE, UL &MhUnseen, "unseen"},
989 ** The name of the MH sequence used for unseen messages.
991 {"mime_forward", DT_QUAD, R_NONE, OPT_MIMEFWD, "no" },
994 ** When \fIset\fP, the message you are forwarding will be attached as a
995 ** separate MIME part instead of included in the main body of the
998 ** This is useful for forwarding MIME messages so the receiver
999 ** can properly view the message as it was delivered to you. If you like
1000 ** to switch between MIME and not MIME from mail to mail, set this
1001 ** variable to ask-no or ask-yes.
1003 ** Also see ``$$forward_decode'' and ``$$mime_forward_decode''.
1005 {"mime_forward_decode", DT_BOOL, R_NONE, OPTMIMEFORWDECODE, "no" },
1008 ** Controls the decoding of complex MIME messages into \fTtext/plain\fP when
1009 ** forwarding a message while ``$$mime_forward'' is \fIset\fP. Otherwise
1010 ** ``$$forward_decode'' is used instead.
1012 {"mime_forward_rest", DT_QUAD, R_NONE, OPT_MIMEFWDREST, "yes" },
1015 ** When forwarding multiple attachments of a MIME message from the recvattach
1016 ** menu, attachments which cannot be decoded in a reasonable manner will
1017 ** be attached to the newly composed message if this option is set.
1019 {"move", DT_QUAD, R_NONE, OPT_MOVE, "ask-no" },
1022 ** Controls whether or not Madmutt will move read messages
1023 ** from your spool mailbox to your ``$$mbox'' mailbox, or as a result of
1024 ** a ``$mbox-hook'' command.
1026 {"message_format", DT_STR, R_NONE, UL &MsgFmt, "%s"},
1029 ** This is the string displayed in the ``attachment'' menu for
1030 ** attachments of type \fTmessage/rfc822\fP. For a full listing of defined
1031 ** \fTprintf(3)\fP-like sequences see the section on ``$$index_format''.
1033 {"msgid_format", DT_STR, R_NONE, UL &MsgIdFormat, "%Y%m%d%h%M%s.G%P%p"},
1036 ** This is the format for the ``local part'' of the \fTMessage-ID:\fP header
1037 ** field generated by Madmutt. If this variable is empty, no \fTMessage-ID:\fP
1038 ** headers will be generated. The '%'
1039 ** character marks that certain data will be added to the string, similar to
1040 ** \fTprintf(3)\fP. The following characters are allowed:
1043 ** .dt %d .dd the current day of month
1044 ** .dt %h .dd the current hour
1045 ** .dt %m .dd the current month
1046 ** .dt %M .dd the current minute
1047 ** .dt %O .dd the current UNIX timestamp (octal)
1048 ** .dt %p .dd the process ID
1049 ** .dt %P .dd the current Message-ID prefix (a character rotating with
1050 ** every Message-ID being generated)
1051 ** .dt %r .dd a random integer value (decimal)
1052 ** .dt %R .dd a random integer value (hexadecimal)
1053 ** .dt %s .dd the current second
1054 ** .dt %T .dd the current UNIX timestamp (decimal)
1055 ** .dt %X .dd the current UNIX timestamp (hexadecimal)
1056 ** .dt %Y .dd the current year (Y2K compliant)
1057 ** .dt %% .dd the '%' character
1060 ** \fBNote:\fP Please only change this setting if you know what you are doing.
1061 ** Also make sure to consult RFC2822 to produce technically \fIvalid\fP strings.
1063 {"narrow_tree", DT_BOOL, R_TREE|R_INDEX, OPTNARROWTREE, "no" },
1066 ** This variable, when \fIset\fP, makes the thread tree narrower, allowing
1067 ** deeper threads to fit on the screen.
1069 { "net_inc", DT_NUM, R_NONE, UL &NetInc, "10" },
1072 ** Operations that expect to transfer a large amount of data over the
1073 ** network will update their progress every \fInet_inc\fP kilobytes.
1074 ** If set to 0, no progress messages will be displayed.
1076 ** See also ``$$read_inc'' and ``$$write_inc''.
1078 {"pager_context", DT_NUM, R_NONE, UL &PagerContext, "0" },
1081 ** This variable controls the number of lines of context that are given
1082 ** when displaying the next or previous page in the internal pager. By
1083 ** default, Madmutt will display the line after the last one on the screen
1084 ** at the top of the next page (0 lines of context).
1086 {"pager_format", DT_STR, R_PAGER, UL &PagerFmt, "-%Z- %C/%m: %-20.20n %s"},
1089 ** This variable controls the format of the one-line message ``status''
1090 ** displayed before each message in either the internal or an external
1091 ** pager. The valid sequences are listed in the ``$$index_format''
1094 {"pager_index_lines", DT_NUM, R_PAGER, UL &PagerIndexLines, "0" },
1097 ** Determines the number of lines of a mini-index which is shown when in
1098 ** the pager. The current message, unless near the top or bottom of the
1099 ** folder, will be roughly one third of the way down this mini-index,
1100 ** giving the reader the context of a few messages before and after the
1101 ** message. This is useful, for example, to determine how many messages
1102 ** remain to be read in the current thread. One of the lines is reserved
1103 ** for the status bar from the index, so a \fIpager_index_lines\fP of 6
1104 ** will only show 5 lines of the actual index. A value of 0 results in
1105 ** no index being shown. If the number of messages in the current folder
1106 ** is less than \fIpager_index_lines\fP, then the index will only use as
1107 ** many lines as it needs.
1109 {"pager_stop", DT_BOOL, R_NONE, OPTPAGERSTOP, "no" },
1112 ** When \fIset\fP, the internal-pager will \fBnot\fP move to the next message
1113 ** when you are at the end of a message and invoke the \fInext-page\fP
1116 {"pgp_retainable_sigs", DT_BOOL, R_NONE, OPTPGPRETAINABLESIG, "no" },
1119 ** If \fIset\fP, signed and encrypted messages will consist of nested
1120 ** multipart/signed and multipart/encrypted body parts.
1122 ** This is useful for applications like encrypted and signed mailing
1123 ** lists, where the outer layer (multipart/encrypted) can be easily
1124 ** removed, while the inner multipart/signed part is retained.
1127 {"pgp_show_unusable", DT_BOOL, R_NONE, OPTPGPSHOWUNUSABLE, "yes" },
1130 ** If \fIset\fP, Madmutt will display non-usable keys on the PGP key selection
1131 ** menu. This includes keys which have been revoked, have expired, or
1132 ** have been marked as ``disabled'' by the user.
1135 {"pgp_sign_as", DT_STR, R_NONE, UL &PgpSignAs, "" },
1138 ** If you have more than one key pair, this option allows you to specify
1139 ** which of your private keys to use. It is recommended that you use the
1140 ** keyid form to specify your key (e.g., ``\fT0x00112233\fP'').
1143 {"pgp_sort_keys", DT_SORT|DT_SORT_KEYS, R_NONE, UL &PgpSortKeys, "address" },
1146 ** Specifies how the entries in the ``pgp keys'' menu are sorted. The
1147 ** following are legal values:
1150 ** .dt address .dd sort alphabetically by user id
1151 ** .dt keyid .dd sort alphabetically by key id
1152 ** .dt date .dd sort by key creation date
1153 ** .dt trust .dd sort by the trust of the key
1156 ** If you prefer reverse order of the above values, prefix it with
1160 {"forward_decrypt", DT_BOOL, R_NONE, OPTFORWDECRYPT, "yes" },
1163 ** Controls the handling of encrypted messages when forwarding a message.
1164 ** When \fIset\fP, the outer layer of encryption is stripped off. This
1165 ** variable is only used if ``$$mime_forward'' is \fIset\fP and
1166 ** ``$$mime_forward_decode'' is \fIunset\fP.
1169 {"smime_encrypt_with", DT_STR, R_NONE, UL &SmimeCryptAlg, "" },
1172 ** This sets the algorithm that should be used for encryption.
1173 ** Valid choices are ``\fTdes\fP'', ``\fTdes3\fP'', ``\fTrc2-40\fP'',
1174 ** ``\fTrc2-64\fP'', ``\frc2-128\fP''.
1176 ** If \fIunset\fP ``\fI3des\fP'' (TripleDES) is used.
1179 {"smime_default_key", DT_STR, R_NONE, UL &SmimeDefaultKey, "" },
1182 ** This is the default key-pair to use for signing. This must be set to the
1183 ** keyid (the hash-value that OpenSSL generates) to work properly
1186 {"pipe_split", DT_BOOL, R_NONE, OPTPIPESPLIT, "no" },
1189 ** Used in connection with the \fIpipe-message\fP command and the ``tag-
1190 ** prefix'' or ``tag-prefix-cond'' operators.
1191 ** If this variable is \fIunset\fP, when piping a list of
1192 ** tagged messages Madmutt will concatenate the messages and will pipe them
1193 ** as a single folder. When \fIset\fP, Madmutt will pipe the messages one by one.
1194 ** In both cases the messages are piped in the current sorted order,
1195 ** and the ``$$pipe_sep'' separator is added after each message.
1197 {"pipe_decode", DT_BOOL, R_NONE, OPTPIPEDECODE, "no" },
1200 ** Used in connection with the \fIpipe-message\fP command. When \fIunset\fP,
1201 ** Madmutt will pipe the messages without any preprocessing. When \fIset\fP, Madmutt
1202 ** will weed headers and will attempt to PGP/MIME decode the messages
1205 {"pipe_sep", DT_STR, R_NONE, UL &PipeSep, "\n"},
1208 ** The separator to add between messages when piping a list of tagged
1209 ** messages to an external Unix command.
1211 {"pop_authenticators", DT_STR, R_NONE, UL &PopAuthenticators, "" },
1214 ** This is a colon-delimited list of authentication methods Madmutt may
1215 ** attempt to use to log in to an POP server, in the order Madmutt should
1216 ** try them. Authentication methods are either ``\fTuser\fP'', ``\fTapop\fP''
1217 ** or any SASL mechanism, eg ``\fTdigest-md5\fP'', ``\fTgssapi\fP'' or ``\fTcram-md5\fP''.
1219 ** This parameter is case-insensitive. If this parameter is \fIunset\fP
1220 ** (the default) Madmutt will try all available methods, in order from
1221 ** most-secure to least-secure.
1223 ** Example: \fTset pop_authenticators="digest-md5:apop:user"\fP
1225 {"pop_mail_check", DT_NUM, R_NONE, UL &PopCheckTimeout, "60" },
1228 ** This variable configures how often (in seconds) Madmutt should look for
1231 {"pop_delete", DT_QUAD, R_NONE, OPT_POPDELETE, "ask-no" },
1234 ** If \fIset\fP, Madmutt will delete successfully downloaded messages from the POP
1235 ** server when using the ``fetch-mail'' function. When \fIunset\fP, Madmutt will
1236 ** download messages but also leave them on the POP server.
1238 {"pop_host", DT_STR, R_NONE, UL &PopHost, ""},
1241 ** The name of your POP server for the ``fetch-mail'' function. You
1242 ** can also specify an alternative port, username and password, i.e.:
1244 ** \fT[pop[s]://][username[:password]@]popserver[:port]\fP
1246 ** \fBNote:\fP Storing passwords in a configuration file
1247 ** presents a security risk since the superuser of your machine may read it
1248 ** regardless of the file's permissions.
1250 {"pop_last", DT_BOOL, R_NONE, OPTPOPLAST, "no" },
1253 ** If this variable is \fIset\fP, Madmutt will try to use the ``\fTLAST\fP'' POP command
1254 ** for retrieving only unread messages from the POP server when using
1255 ** the ``fetch-mail'' function.
1257 {"pop_reconnect", DT_QUAD, R_NONE, OPT_POPRECONNECT, "ask-yes" },
1260 ** Controls whether or not Madmutt will try to reconnect to a POP server if the
1261 ** connection is lost.
1263 {"pop_user", DT_STR, R_NONE, UL &PopUser, "" },
1266 ** Your login name on the POP server.
1268 ** This variable defaults to your user name on the local machine.
1270 {"pop_pass", DT_STR, R_NONE, UL &PopPass, ""},
1273 ** Specifies the password for your POP account. If \fIunset\fP, Madmutt will
1274 ** prompt you for your password when you open POP mailbox.
1276 ** \fBNote:\fP Storing passwords in a configuration file
1277 ** presents a security risk since the superuser of your machine may read it
1278 ** regardless of the file's permissions.
1280 {"postpone", DT_QUAD, R_NONE, OPT_POSTPONE, "ask-yes" },
1283 ** Controls whether or not messages are saved in the ``$$postponed''
1284 ** mailbox when you elect not to send immediately.
1286 {"postponed", DT_PATH, R_NONE, UL &Postponed, "~/postponed"},
1289 ** Madmutt allows you to indefinitely ``$postpone sending a message'' which
1290 ** you are editing. When you choose to postpone a message, Madmutt saves it
1291 ** in the mailbox specified by this variable. Also see the ``$$postpone''
1294 {"preconnect", DT_STR, R_NONE, UL &Preconnect, "" },
1297 ** If \fIset\fP, a shell command to be executed if Madmutt fails to establish
1298 ** a connection to the server. This is useful for setting up secure
1299 ** connections, e.g. with \fTssh(1)\fP. If the command returns a nonzero
1300 ** status, Madmutt gives up opening the server. Example:
1302 ** \fTpreconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net
1303 ** sleep 20 < /dev/null > /dev/null"\fP
1305 ** Mailbox ``foo'' on mailhost.net can now be reached
1306 ** as ``{localhost:1234}foo''.
1308 ** \fBNote:\fP For this example to work, you must be able to log in to the
1309 ** remote machine without having to enter a password.
1311 {"print", DT_QUAD, R_NONE, OPT_PRINT, "ask-no" },
1314 ** Controls whether or not Madmutt really prints messages.
1315 ** This is set to \fIask-no\fP by default, because some people
1316 ** accidentally hit ``p'' often.
1318 {"print_command", DT_PATH, R_NONE, UL &PrintCmd, "lpr"},
1321 ** This specifies the command pipe that should be used to print messages.
1323 {"print_decode", DT_BOOL, R_NONE, OPTPRINTDECODE, "yes" },
1326 ** Used in connection with the print-message command. If this
1327 ** option is \fIset\fP, the message is decoded before it is passed to the
1328 ** external command specified by $$print_command. If this option
1329 ** is \fIunset\fP, no processing will be applied to the message when
1330 ** printing it. The latter setting may be useful if you are using
1331 ** some advanced printer filter which is able to properly format
1332 ** e-mail messages for printing.
1334 {"print_split", DT_BOOL, R_NONE, OPTPRINTSPLIT, "no" },
1337 ** Used in connection with the print-message command. If this option
1338 ** is \fIset\fP, the command specified by $$print_command is executed once for
1339 ** each message which is to be printed. If this option is \fIunset\fP,
1340 ** the command specified by $$print_command is executed only once, and
1341 ** all the messages are concatenated, with a form feed as the message
1344 ** Those who use the \fTenscript(1)\fP program's mail-printing mode will
1345 ** most likely want to set this option.
1347 {"prompt_after", DT_BOOL, R_NONE, OPTPROMPTAFTER, "yes" },
1350 ** If you use an \fIexternal\fP ``$$pager'', setting this variable will
1351 ** cause Madmutt to prompt you for a command when the pager exits rather
1352 ** than returning to the index menu. If \fIunset\fP, Madmutt will return to the
1353 ** index menu when the external pager exits.
1355 {"query_command", DT_PATH, R_NONE, UL &QueryCmd, ""},
1358 ** This specifies the command that Madmutt will use to make external address
1359 ** queries. The string should contain a \fT%s\fP, which will be substituted
1360 ** with the query string the user types. See ``$query'' for more
1363 {"quote_empty", DT_BOOL, R_NONE, OPTQUOTEEMPTY, "yes" },
1366 ** Controls whether or not empty lines will be quoted using
1367 ** ``$indent_string''.
1369 {"quote_quoted", DT_BOOL, R_NONE, OPTQUOTEQUOTED, "no" },
1372 ** Controls how quoted lines will be quoted. If \fIset\fP, one quote
1373 ** character will be added to the end of existing prefix. Otherwise,
1374 ** quoted lines will be prepended by ``$indent_string''.
1376 {"quote_regexp", DT_RX, R_PAGER, UL &QuoteRegexp, "^([ \t]*[|>:}#])+"},
1379 ** A regular expression used in the internal-pager to determine quoted
1380 ** sections of text in the body of a message.
1382 ** \fBNote:\fP In order to use the \fIquoted\fP\fBx\fP patterns in the
1383 ** internal pager, you need to set this to a regular expression that
1384 ** matches \fIexactly\fP the quote characters at the beginning of quoted
1387 {"read_inc", DT_NUM, R_NONE, UL &ReadInc, "10" },
1390 ** If set to a value greater than 0, Madmutt will display which message it
1391 ** is currently on when reading a mailbox. The message is printed after
1392 ** \fIread_inc\fP messages have been read (e.g., if set to 25, Madmutt will
1393 ** print a message when it reads message 25, and then again when it gets
1394 ** to message 50). This variable is meant to indicate progress when
1395 ** reading large mailboxes which may take some time.
1396 ** When set to 0, only a single message will appear before the reading
1399 ** Also see the ``$$write_inc'' variable.
1401 {"realname", DT_STR, R_BOTH, UL &Realname, "" },
1404 ** This variable specifies what ``real'' or ``personal'' name should be used
1405 ** when sending messages.
1407 ** By default, this is the GECOS field from \fT/etc/passwd\fP.
1410 ** variable will \fInot\fP be used when the user has set a real name
1411 ** in the $$from variable.
1413 {"recall", DT_QUAD, R_NONE, OPT_RECALL, "ask-yes" },
1416 ** Controls whether or not Madmutt recalls postponed messages
1417 ** when composing a new message. Also see ``$$postponed''.
1419 ** Setting this variable to \fIyes\fP is not generally useful, and thus not
1422 {"reply_regexp", DT_RX, R_INDEX|R_RESORT, UL &ReplyRegexp, "^(re([\\[0-9\\]+])*|aw):[ \t]*"},
1425 ** A regular expression used to recognize reply messages when threading
1426 ** and replying. The default value corresponds to the English ``Re:'' and
1427 ** the German ``Aw:''.
1429 {"reply_to", DT_QUAD, R_NONE, OPT_REPLYTO, "ask-yes" },
1432 ** If \fIset\fP, when replying to a message, Madmutt will use the address listed
1433 ** in the ``\fTReply-To:\fP'' header field as the recipient of the reply. If \fIunset\fP,
1434 ** it will use the address in the ``\fTFrom:\fP'' header field instead.
1437 ** option is useful for reading a mailing list that sets the ``\fTReply-To:\fP''
1438 ** header field to the list address and you want to send a private
1439 ** message to the author of a message.
1441 {"resolve", DT_BOOL, R_NONE, OPTRESOLVE, "yes" },
1444 ** When set, the cursor will be automatically advanced to the next
1445 ** (possibly undeleted) message whenever a command that modifies the
1446 ** current message is executed.
1448 {"reverse_alias", DT_BOOL, R_BOTH, OPTREVALIAS, "no" },
1451 ** This variable controls whether or not Madmutt will display the ``personal''
1452 ** name from your aliases in the index menu if it finds an alias that
1453 ** matches the message's sender. For example, if you have the following
1456 ** \fTalias juser abd30425@somewhere.net (Joe User)\fP
1458 ** and then you receive mail which contains the following header:
1460 ** \fTFrom: abd30425@somewhere.net\fP
1462 ** It would be displayed in the index menu as ``Joe User'' instead of
1463 ** ``abd30425@somewhere.net.'' This is useful when the person's e-mail
1464 ** address is not human friendly (like CompuServe addresses).
1466 {"reverse_name", DT_BOOL, R_BOTH, OPTREVNAME, "no" },
1469 ** It may sometimes arrive that you receive mail to a certain machine,
1470 ** move the messages to another machine, and reply to some the messages
1471 ** from there. If this variable is \fIset\fP, the default \fTFrom:\fP line of
1472 ** the reply messages is built using the address where you received the
1473 ** messages you are replying to \fBif\fP that address matches your
1474 ** alternates. If the variable is \fIunset\fP, or the address that would be
1475 ** used doesn't match your alternates, the \fTFrom:\fP line will use
1476 ** your address on the current machine.
1478 {"reverse_realname", DT_BOOL, R_BOTH, OPTREVREAL, "yes" },
1481 ** This variable fine-tunes the behaviour of the $reverse_name feature.
1482 ** When it is \fIset\fP, Madmutt will use the address from incoming messages as-is,
1483 ** possibly including eventual real names. When it is \fIunset\fP, Madmutt will
1484 ** override any such real names with the setting of the $realname variable.
1486 {"sig_dashes", DT_BOOL, R_NONE, OPTSIGDASHES, "yes" },
1489 ** If set, a line containing ``\fT-- \fP'' (dash, dash, space)
1490 ** will be inserted before your ``$$signature''. It is \fBstrongly\fP
1491 ** recommended that you not unset this variable unless your ``signature''
1492 ** contains just your name. The reason for this is because many software
1493 ** packages use ``\fT-- \n\fP'' to detect your signature.
1495 ** For example, Madmutt has the ability to highlight
1496 ** the signature in a different color in the builtin pager.
1498 {"signoff_string", DT_STR, R_NONE, UL &SignOffString, "" },
1501 ** If \fIset\fP, this string will be inserted before the signature. This is useful
1502 ** for people that want to sign off every message they send with their name.
1504 ** If you want to insert your website's URL, additional contact information or
1505 ** witty quotes into your mails, better use a signature file instead of
1506 ** the signoff string.
1508 {"simple_search", DT_STR, R_NONE, UL &SimpleSearch, "~f %s | ~s %s"},
1511 ** Specifies how Madmutt should expand a simple search into a real search
1512 ** pattern. A simple search is one that does not contain any of the ~
1513 ** operators. See ``$patterns'' for more information on search patterns.
1515 ** For example, if you simply type ``joe'' at a search or limit prompt, Madmutt
1516 ** will automatically expand it to the value specified by this variable.
1517 ** For the default value it would be:
1519 ** \fT~f joe | ~s joe\fP
1521 {"smart_wrap", DT_BOOL, R_PAGER, OPTWRAP, "yes" },
1524 ** Controls the display of lines longer than the screen width in the
1525 ** internal pager. If \fIset\fP, long lines are wrapped at a word boundary.
1526 ** If \fIunset\fP, lines are simply wrapped at the screen edge. Also see the
1527 ** ``$$markers'' variable.
1529 {"smileys", DT_RX, R_PAGER, UL &Smileys, "(>From )|(:[-^]?[][)(><}{|/DP])"},
1532 ** The \fIpager\fP uses this variable to catch some common false
1533 ** positives of ``$$quote_regexp'', most notably smileys in the beginning
1536 {"sleep_time", DT_NUM, R_NONE, UL &SleepTime, "1" },
1539 ** Specifies time, in seconds, to pause while displaying certain informational
1540 ** messages, while moving from folder to folder and after expunging
1541 ** messages from the current folder. The default is to pause one second, so
1542 ** a value of zero for this option suppresses the pause.
1544 {"sort", DT_SORT, R_INDEX|R_RESORT, UL &Sort, "date" },
1547 ** Specifies how to sort messages in the \fIindex\fP menu. Valid values
1551 ** . date or date-sent
1554 ** . mailbox-order (unsorted)
1563 ** You may optionally use the ``reverse-'' prefix to specify reverse sorting
1564 ** order (example: \fTset sort=reverse-date-sent\fP).
1566 {"sort_alias", DT_SORT|DT_SORT_ALIAS, R_NONE, UL &SortAlias, "alias" },
1569 ** Specifies how the entries in the ``alias'' menu are sorted. The
1570 ** following are legal values:
1573 ** . address (sort alphabetically by email address)
1574 ** . alias (sort alphabetically by alias name)
1575 ** . unsorted (leave in order specified in .muttrc)
1578 {"sort_aux", DT_SORT|DT_SORT_AUX, R_INDEX|R_RESORT_BOTH, UL &SortAux, "date" },
1581 ** When sorting by threads, this variable controls how threads are sorted
1582 ** in relation to other threads, and how the branches of the thread trees
1583 ** are sorted. This can be set to any value that ``$$sort'' can, except
1584 ** threads (in that case, Madmutt will just use date-sent). You can also
1585 ** specify the ``last-'' prefix in addition to ``reverse-'' prefix, but last-
1586 ** must come after reverse-. The last- prefix causes messages to be
1587 ** sorted against its siblings by which has the last descendant, using
1588 ** the rest of sort_aux as an ordering.
1590 ** For instance, \fTset sort_aux=last-date-received\fP would mean that if
1591 ** a new message is received in a thread, that thread becomes the last one
1592 ** displayed (or the first, if you have \fTset sort=reverse-threads\fP.)
1594 ** \fBNote:\fP For reversed ``$$sort'' order $$sort_aux is reversed again
1595 ** (which is not the right thing to do, but kept to not break any existing
1596 ** configuration setting).
1598 {"sort_browser", DT_SORT|DT_SORT_BROWSER, R_NONE, UL &BrowserSort, "alpha" },
1601 ** Specifies how to sort entries in the file browser. By default, the
1602 ** entries are sorted alphabetically. Valid values:
1605 ** . alpha (alphabetically)
1611 ** You may optionally use the ``reverse-'' prefix to specify reverse sorting
1612 ** order (example: \fTset sort_browser=reverse-date\fP).
1614 {"sort_re", DT_BOOL, R_INDEX|R_RESORT|R_RESORT_INIT, OPTSORTRE, "yes" },
1617 ** This variable is only useful when sorting by threads with
1618 ** ``$$strict_threads'' \fIunset\fP. In that case, it changes the heuristic
1619 ** Madmutt uses to thread messages by subject. With $$sort_re \fIset\fP,
1620 ** Madmutt will only attach a message as the child of another message by
1621 ** subject if the subject of the child message starts with a substring
1622 ** matching the setting of ``$$reply_regexp''. With $$sort_re \fIunset\fP,
1623 ** Madmutt will attach the message whether or not this is the case,
1624 ** as long as the non-``$$reply_regexp'' parts of both messages are identical.
1626 {"spoolfile", DT_PATH, R_NONE, UL &Spoolfile, "" },
1629 ** If your spool mailbox is in a non-default place where Madmutt cannot find
1630 ** it, you can specify its location with this variable. Madmutt will
1631 ** automatically set this variable to the value of the environment
1632 ** variable $$$MAIL if it is not set.
1634 {"status_chars", DT_STR, R_BOTH, UL &StChars, "-*%A"},
1637 ** Controls the characters used by the ``\fT%r\fP'' indicator in
1638 ** ``$$status_format''. The first character is used when the mailbox is
1639 ** unchanged. The second is used when the mailbox has been changed, and
1640 ** it needs to be resynchronized. The third is used if the mailbox is in
1641 ** read-only mode, or if the mailbox will not be written when exiting
1642 ** that mailbox (You can toggle whether to write changes to a mailbox
1643 ** with the toggle-write operation, bound by default to ``\fT%\fP'').
1644 ** The fourth is used to indicate that the current folder has been
1645 ** opened in attach-message mode (Certain operations like composing
1646 ** a new mail, replying, forwarding, etc. are not permitted in this mode).
1648 {"status_format", DT_STR, R_BOTH, UL &Status, "-%r-Madmutt: %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)---"},
1651 ** Controls the format of the status line displayed in the \fIindex\fP
1652 ** menu. This string is similar to ``$$index_format'', but has its own
1653 ** set of \fTprintf(3)\fP-like sequences:
1656 ** .dt %b .dd number of mailboxes with new mail *
1657 ** .dt %B .dd the short pathname of the current mailbox
1658 ** .dt %d .dd number of deleted messages *
1659 ** .dt %f .dd the full pathname of the current mailbox
1660 ** .dt %F .dd number of flagged messages *
1661 ** .dt %h .dd local hostname
1662 ** .dt %l .dd size (in bytes) of the current mailbox *
1663 ** .dt %L .dd size (in bytes) of the messages shown
1664 ** (i.e., which match the current limit) *
1665 ** .dt %m .dd the number of messages in the mailbox *
1666 ** .dt %M .dd the number of messages shown (i.e., which match the current limit) *
1667 ** .dt %n .dd number of new messages in the mailbox *
1668 ** .dt %o .dd number of old unread messages *
1669 ** .dt %p .dd number of postponed messages *
1670 ** .dt %P .dd percentage of the way through the index
1671 ** .dt %r .dd modified/read-only/won't-write/attach-message indicator,
1672 ** according to $$status_chars
1673 ** .dt %s .dd current sorting mode ($$sort)
1674 ** .dt %S .dd current aux sorting method ($$sort_aux)
1675 ** .dt %t .dd number of tagged messages *
1676 ** .dt %u .dd number of unread messages *
1677 ** .dt %v .dd Madmutt version string
1678 ** .dt %V .dd currently active limit pattern, if any *
1679 ** .dt %>X .dd right justify the rest of the string and pad with "X"
1680 ** .dt %|X .dd pad to the end of the line with "X"
1683 ** * = can be optionally printed if nonzero
1685 ** Some of the above sequences can be used to optionally print a string
1686 ** if their value is nonzero. For example, you may only want to see the
1687 ** number of flagged messages if such messages exist, since zero is not
1688 ** particularly meaningful. To optionally print a string based upon one
1689 ** of the above sequences, the following construct is used
1691 ** \fT%?<sequence_char>?<optional_string>?\fP
1693 ** where \fIsequence_char\fP is a character from the table above, and
1694 ** \fIoptional_string\fP is the string you would like printed if
1695 ** \fIsequence_char\fP is nonzero. \fIoptional_string\fP \fBmay\fP contain
1696 ** other sequences as well as normal text, but you may \fBnot\fP nest
1697 ** optional strings.
1699 ** Here is an example illustrating how to optionally print the number of
1700 ** new messages in a mailbox:
1702 ** \fT%?n?%n new messages.?\fP
1704 ** Additionally you can switch between two strings, the first one, if a
1705 ** value is zero, the second one, if the value is nonzero, by using the
1706 ** following construct:
1708 ** \fT%?<sequence_char>?<if_string>&<else_string>?\fP
1710 ** You can additionally force the result of any \fTprintf(3)\fP-like sequence
1711 ** to be lowercase by prefixing the sequence character with an underscore
1712 ** (\fT_\fP) sign. For example, if you want to display the local hostname in
1713 ** lowercase, you would use:
1717 ** If you prefix the sequence character with a colon (\fT:\fP) character, Madmutt
1718 ** will replace any dots in the expansion by underscores. This might be helpful
1719 ** with IMAP folders that don't like dots in folder names.
1721 {"strict_mailto", DT_BOOL, R_NONE, OPTSTRICTMAILTO, "yes" },
1725 ** With mailto: style links, a body as well as arbitrary header information
1726 ** may be embedded. This may lead to (user) headers being overwriten without note
1727 ** if ``$$edit_headers'' is unset.
1730 ** If this variable is \fIset\fP, Madmutt is strict and allows anything to be
1731 ** changed. If it's \fIunset\fP, all headers given will be prefixed with
1732 ** ``X-Mailto-'' and the message including headers will be shown in the editor
1733 ** regardless of what ``$$edit_headers'' is set to.
1735 {"strict_threads", DT_BOOL, R_RESORT|R_RESORT_INIT|R_INDEX, OPTSTRICTTHREADS, "no" },
1738 ** If \fIset\fP, threading will only make use of the ``\fTIn-Reply-To:\fP'' and
1739 ** ``\fTReferences:\fP'' header fields when you ``$$sort'' by message threads. By
1740 ** default, messages with the same subject are grouped together in
1741 ** ``pseudo threads.'' This may not always be desirable, such as in a
1742 ** personal mailbox where you might have several unrelated messages with
1743 ** the subject ``hi'' which will get grouped together. See also
1744 ** ``$$sort_re'' for a less drastic way of controlling this
1747 {"strip_was", DT_BOOL, R_NONE, OPTSTRIPWAS, "no" },
1750 ** When \fIset\fP, Madmutt will remove the trailing part of the ``\fTSubject:\fP''
1751 ** line which matches $$strip_was_regex when replying. This is useful to
1752 ** properly react on subject changes and reduce ``subject noise.'' (esp. in Usenet)
1754 {"strip_was_regex", DT_RX, R_NONE, UL &StripWasRegexp, "\\([Ww][Aa][RrSs]: .*\\)[ ]*$"},
1757 ** When non-empty and $$strip_was is \fIset\fP, Madmutt will remove this
1758 ** trailing part of the ``Subject'' line when replying if it won't be empty
1761 {"stuff_quoted", DT_BOOL, R_BOTH, OPTSTUFFQUOTED, "no" },
1764 ** If \fIset\fP, attachments with flowed format will have their quoting ``stuffed'',
1765 ** i.e. a space will be inserted between the quote characters and the actual
1768 {"text_flowed", DT_BOOL, R_NONE, OPTTEXTFLOWED, "no" },
1771 ** When \fIset\fP, Madmutt will generate \fTtext/plain; format=flowed\fP attachments.
1772 ** This format is easier to handle for some mailing software, and generally
1773 ** just looks like ordinary text. To actually make use of this format's
1774 ** features, you'll need support in your editor.
1776 ** Note that $$indent_string is ignored when this option is set.
1778 {"thread_received", DT_BOOL, R_RESORT|R_RESORT_INIT|R_INDEX, OPTTHREADRECEIVED, "no" },
1781 ** When \fIset\fP, Madmutt uses the date received rather than the date sent
1782 ** to thread messages by subject.
1784 {"thorough_search", DT_BOOL, R_NONE, OPTTHOROUGHSRC, "no" },
1787 ** Affects the \fT~b\fP and \fT~h\fP search operations described in
1788 ** section ``$patterns'' above. If \fIset\fP, the headers and attachments of
1789 ** messages to be searched are decoded before searching. If \fIunset\fP,
1790 ** messages are searched as they appear in the folder.
1792 {"tilde", DT_BOOL, R_PAGER, OPTTILDE, "no" },
1795 ** When \fIset\fP, the internal-pager will pad blank lines to the bottom of the
1796 ** screen with a tilde (~).
1798 {"timeout", DT_NUM, R_NONE, UL &Timeout, "600" },
1801 ** This variable controls the \fInumber of seconds\fP Madmutt will wait
1802 ** for a key to be pressed in the main menu before timing out and
1803 ** checking for new mail. A value of zero or less will cause Madmutt
1804 ** to never time out.
1806 {"to_chars", DT_STR, R_BOTH, UL &Tochars, " +TCFL"},
1809 ** Controls the character used to indicate mail addressed to you. The
1810 ** first character is the one used when the mail is NOT addressed to your
1811 ** address (default: space). The second is used when you are the only
1812 ** recipient of the message (default: +). The third is when your address
1813 ** appears in the ``\fTTo:\fP'' header field, but you are not the only recipient of
1814 ** the message (default: T). The fourth character is used when your
1815 ** address is specified in the ``\fTCc:\fP'' header field, but you are not the only
1816 ** recipient. The fifth character is used to indicate mail that was sent
1817 ** by \fIyou\fP. The sixth character is used to indicate when a mail
1818 ** was sent to a mailing-list you're subscribe to (default: L).
1820 {"trash", DT_PATH, R_NONE, UL &TrashPath, "" },
1823 ** If \fIset\fP, this variable specifies the path of the trash folder where the
1824 ** mails marked for deletion will be moved, instead of being irremediably
1827 ** \fBNote\fP: When you delete a message in the trash folder, it is really
1828 ** deleted, so that there is no way to recover mail.
1830 {"tunnel", DT_STR, R_NONE, UL &Tunnel, "" },
1833 ** Setting this variable will cause Madmutt to open a pipe to a command
1834 ** instead of a raw socket. You may be able to use this to set up
1835 ** preauthenticated connections to your IMAP/POP3 server. Example:
1837 ** \fTtunnel="ssh -q mailhost.net /usr/local/libexec/imapd"\fP
1839 ** \fBNote:\fP For this example to work you must be able to log in to the remote
1840 ** machine without having to enter a password.
1842 {"umask", DT_NUM, R_NONE, UL &Umask, "0077" },
1845 ** This sets the umask that will be used by Madmutt when creating all
1846 ** kinds of files. If \fIunset\fP, the default value is \fT077\fP.
1848 {"use_from", DT_BOOL, R_NONE, OPTUSEFROM, "yes" },
1851 ** When \fIset\fP, Madmutt will generate the ``\fTFrom:\fP'' header field when
1852 ** sending messages. If \fIunset\fP, no ``\fTFrom:\fP'' header field will be
1853 ** generated unless the user explicitly sets one using the ``$my_hdr''
1857 {"use_idn", DT_BOOL, R_BOTH, OPTUSEIDN, "yes" },
1860 ** Availability: IDN
1863 ** When \fIset\fP, Madmutt will show you international domain names decoded.
1865 ** \fBNote:\fP You can use IDNs for addresses even if this is \fIunset\fP.
1866 ** This variable only affects decoding.
1868 #endif /* HAVE_LIBIDN */
1869 {"agent_string", DT_BOOL, R_NONE, OPTXMAILER, "yes" },
1872 ** When \fIset\fP, Madmutt will add a ``\fTUser-Agent:\fP'' header to outgoing
1873 ** messages, indicating which version of Madmutt was used for composing
1876 {"wait_key", DT_BOOL, R_NONE, OPTWAITKEY, "yes" },
1879 ** Controls whether Madmutt will ask you to press a key after \fIshell-
1880 ** escape\fP, \fIpipe-message\fP, \fIpipe-entry\fP, \fIprint-message\fP,
1881 ** and \fIprint-entry\fP commands.
1883 ** It is also used when viewing attachments with ``$auto_view'', provided
1884 ** that the corresponding mailcap entry has a \fTneedsterminal\fP flag,
1885 ** and the external program is interactive.
1887 ** When \fIset\fP, Madmutt will always ask for a key. When \fIunset\fP, Madmutt will wait
1888 ** for a key only if the external command returned a non-zero status.
1890 {"weed", DT_BOOL, R_NONE, OPTWEED, "yes" },
1893 ** When \fIset\fP, Madmutt will weed headers when displaying, forwarding,
1894 ** printing, or replying to messages.
1896 {"wrap_search", DT_BOOL, R_NONE, OPTWRAPSEARCH, "yes" },
1899 ** Controls whether searches wrap around the end of the mailbox.
1901 ** When \fIset\fP, searches will wrap around the first (or last) message. When
1902 ** \fIunset\fP, searches will not wrap.
1904 {"wrapmargin", DT_NUM, R_PAGER, UL &WrapMargin, "0" },
1907 ** Controls the size of the margin remaining at the right side of
1908 ** the terminal when Madmutt's pager does smart wrapping.
1910 {"write_inc", DT_NUM, R_NONE, UL &WriteInc, "10" },
1913 ** When writing a mailbox, a message will be printed every
1914 ** \fIwrite_inc\fP messages to indicate progress. If set to 0, only a
1915 ** single message will be displayed before writing a mailbox.
1917 ** Also see the ``$$read_inc'' variable.
1919 {"write_bcc", DT_BOOL, R_NONE, OPTWRITEBCC, "yes" },
1922 ** Controls whether Madmutt writes out the Bcc header when preparing
1923 ** messages to be sent. Exim users may wish to \fIunset\fP this.
1925 {"xterm_icon", DT_STR, R_BOTH, UL &XtermIcon, "M%?n?AIL&ail?"},
1928 ** Controls the format of the X11 icon title, as long as $$xterm_set_titles
1929 ** is \fIset\fP. This string is identical in formatting to the one used by
1930 ** ``$$status_format''.
1932 {"xterm_set_titles", DT_BOOL, R_BOTH, OPTXTERMSETTITLES, "no" },
1935 ** Controls whether Madmutt sets the xterm title bar and icon name
1936 ** (as long as you're in an appropriate terminal). The default must
1937 ** be \fIunset\fP to force in the validity checking.
1939 {"xterm_leave", DT_STR, R_BOTH, UL &XtermLeave, "" },
1942 ** If $$xterm_set_titles is \fIset\fP, this string will be used to
1943 ** set the title when leaving Madmutt. For terminal-based programs,
1944 ** there's no easy and portable way to read the current title so Madmutt
1945 ** cannot read it upon startup and restore it when exiting.
1948 ** Based on the xterm FAQ, the following might work:
1951 ** \fTset xterm_leave = "`test x$$$DISPLAY != x && xprop -id $$$WINDOWID | grep WM_NAME | cut -d '"' -f 2`"\fP
1953 {"xterm_title", DT_STR, R_BOTH, UL &XtermTitle, "Madmutt with %?m?%m messages&no messages?%?n? [%n New]?"},
1956 ** Controls the format of the title bar of the xterm provided that
1957 ** $$xterm_set_titles has been \fIset\fP. This string is identical in formatting
1958 ** to the one used by ``$$status_format''.
1961 {"nntp_post_moderated", DT_QUAD, R_NONE, OPT_TOMODERATED, "ask-yes" },
1964 ** Availability: NNTP
1967 ** If set to \fIyes\fP, Madmutt will post articles to newsgroup that have
1968 ** not permissions to post (e.g. moderated).
1970 ** \fBNote:\fP if the newsserver
1971 ** does not support posting to that newsgroup or a group is totally read-only, that
1972 ** posting will not have any effect.
1974 {"nntp_host", DT_STR, R_NONE, UL &NewsServer, "" },
1977 ** Availability: NNTP
1980 ** This variable specifies the name (or address) of the NNTP server to be used.
1983 ** defaults to the value specified via the environment variable
1984 ** \fT$$$NNTPSERVER\fP or contained in the file \fT/etc/nntpserver\fP.
1987 ** specify a username and an alternative port for each newsserver, e.g.
1989 ** \fT[nntp[s]://][username[:password]@]newsserver[:port]\fP
1991 ** \fBNote:\fP Using a password as shown and stored in a configuration file
1992 ** presents a security risk since the superuser of your machine may read it
1993 ** regardless of the file's permissions.
1995 {"nntp_context", DT_NUM, R_NONE, UL &NntpContext, "1000" },
1998 ** Availability: NNTP
2001 ** This variable controls how many news articles to cache per newsgroup
2002 ** (if caching is enabled, see $$nntp_cache_dir) and how many news articles
2003 ** to show in the ``index'' menu.
2005 ** If there're more articles than defined with $$nntp_context, all older ones
2006 ** will be removed/not shown in the index.
2008 {"nntp_load_description", DT_BOOL, R_NONE, OPTLOADDESC, "yes" },
2011 ** Availability: NNTP
2014 ** This variable controls whether or not descriptions for newsgroups
2015 ** are to be loaded when subscribing to a newsgroup.
2017 {"nntp_user", DT_STR, R_NONE, UL &NntpUser, ""},
2020 ** Availability: NNTP
2023 ** Your login name on the NNTP server. If \fIunset\fP and the server requires
2024 ** authentification, Madmutt will prompt you for your account name.
2026 {"nntp_pass", DT_STR, R_NONE, UL &NntpPass, ""},
2029 ** Availability: NNTP
2032 ** Your password for NNTP account.
2034 ** \fBNote:\fP Storing passwords in a configuration file
2035 ** presents a security risk since the superuser of your machine may read it
2036 ** regardless of the file's permissions.
2038 {"nntp_mail_check", DT_NUM, R_NONE, UL &NewsPollTimeout, "60" },
2041 ** Availability: NNTP
2044 ** The time in seconds until any operations on a newsgroup except posting a new
2045 ** article will cause a recheck for new news. If set to 0, Madmutt will
2046 ** recheck on each operation in index (stepping, read article, etc.).
2048 {"nntp_reconnect", DT_QUAD, R_NONE, OPT_NNTPRECONNECT, "ask-yes" },
2051 ** Availability: NNTP
2054 ** Controls whether or not Madmutt will try to reconnect to a newsserver when the
2055 ** was connection lost.
2057 {"nntp_group_index_format", DT_STR, R_BOTH, UL &GroupFormat, "%4C %M%N %5s %-45.45f %d"},
2060 ** Availability: NNTP
2063 ** This variable allows you to customize the newsgroup browser display to
2064 ** your personal taste. This string is similar to ``$index_format'', but
2065 ** has its own set of \fTprintf(3)\fP-like sequences:
2068 ** %C current newsgroup number
2069 ** %d description of newsgroup (retrieved from server)
2070 ** %f newsgroup name
2071 ** %M ``-'' if newsgroup not allowed for direct post (moderated for example)
2072 ** %N ``N'' if newsgroup is new, ``u'' if unsubscribed, blank otherwise
2073 ** %n number of new articles in newsgroup
2074 ** %s number of unread articles in newsgroup
2075 ** %>X right justify the rest of the string and pad with character "X"
2076 ** %|X pad to the end of the line with character "X"
2079 {"nntp_followup_to_poster", DT_QUAD, R_NONE, OPT_FOLLOWUPTOPOSTER, "ask-yes" },
2082 ** Availability: NNTP
2085 ** If this variable is \fIset\fP and the keyword "\fTposter\fP" is present in
2086 ** the \fTFollowup-To:\fP header field, a follow-up to the newsgroup is not
2087 ** permitted. The message will be mailed to the submitter of the
2088 ** message via mail.
2090 {"nntp_catchup", DT_QUAD, R_NONE, OPT_CATCHUP, "ask-yes" },
2093 ** Availability: NNTP
2096 ** If this variable is \fIset\fP, Madmutt will mark all articles in a newsgroup
2097 ** as read when you leaving it.
2099 {"nntp_ask_followup_to", DT_BOOL, R_NONE, OPTASKFOLLOWUP, "no" },
2102 ** Availability: NNTP
2105 ** If \fIset\fP, Madmutt will prompt you for the \fTFollowup-To:\fP header
2106 ** field before editing the body of an outgoing news article.
2108 {"nntp_show_new_news", DT_BOOL, R_NONE, OPTSHOWNEWNEWS, "yes" },
2111 ** Availability: NNTP
2114 ** If \fIset\fP, the newsserver will be asked for new newsgroups on entering
2115 ** the browser. Otherwise, it will be done only once for a newsserver.
2116 ** Also controls whether or not the number of new articles of subscribed
2117 ** newsgroups will be checked.
2119 {"nntp_show_only_unread", DT_BOOL, R_NONE, OPTSHOWONLYUNREAD, "no" },
2122 ** Availability: NNTP
2125 ** If \fIset\fP, only subscribed newsgroups that contain unread articles
2126 ** will be displayed in the newsgroup browser.
2130 { NULL, -1, R_NONE, -1, NULL }
2133 const struct mapping_t SortMethods[] = {
2134 {"date", SORT_DATE},
2135 {"date-sent", SORT_DATE},
2136 {"date-received", SORT_RECEIVED},
2137 {"mailbox-order", SORT_ORDER},
2138 {"subject", SORT_SUBJECT},
2139 {"from", SORT_FROM},
2140 {"size", SORT_SIZE},
2141 {"threads", SORT_THREADS},
2143 {"score", SORT_SCORE},
2144 {"spam", SORT_SPAM},
2148 /* same as SortMethods, but with "threads" replaced by "date" */
2150 const struct mapping_t SortAuxMethods[] = {
2151 {"date", SORT_DATE},
2152 {"date-sent", SORT_DATE},
2153 {"date-received", SORT_RECEIVED},
2154 {"mailbox-order", SORT_ORDER},
2155 {"subject", SORT_SUBJECT},
2156 {"from", SORT_FROM},
2157 {"size", SORT_SIZE},
2158 {"threads", SORT_DATE}, /* note: sort_aux == threads
2162 {"score", SORT_SCORE},
2163 {"spam", SORT_SPAM},
2168 const struct mapping_t SortBrowserMethods[] = {
2169 {"alpha", SORT_SUBJECT},
2170 {"date", SORT_DATE},
2171 {"size", SORT_SIZE},
2172 {"unsorted", SORT_ORDER},
2176 const struct mapping_t SortAliasMethods[] = {
2177 {"alias", SORT_ALIAS},
2178 {"address", SORT_ADDRESS},
2179 {"unsorted", SORT_ORDER},
2183 const struct mapping_t SortKeyMethods[] = {
2184 {"address", SORT_ADDRESS},
2185 {"date", SORT_DATE},
2186 {"keyid", SORT_KEYID},
2187 {"trust", SORT_TRUST},
2192 /* functions used to parse commands in a rc file */
2194 static int parse_attachments (BUFFER *, BUFFER *, unsigned long, BUFFER *);
2195 static int parse_unattachments (BUFFER *, BUFFER *, unsigned long, BUFFER *);
2196 static int parse_alias (BUFFER *, BUFFER *, unsigned long, BUFFER *);
2197 static int parse_unalias (BUFFER *, BUFFER *, unsigned long, BUFFER *);
2198 static int parse_source (BUFFER *, BUFFER *, unsigned long, BUFFER *);
2199 static int parse_set (BUFFER *, BUFFER *, unsigned long, BUFFER *);
2200 static int parse_my_hdr (BUFFER *, BUFFER *, unsigned long, BUFFER *);
2201 static int parse_unmy_hdr (BUFFER *, BUFFER *, unsigned long, BUFFER *);
2205 int (*func) (BUFFER *, BUFFER *, unsigned long, BUFFER *);
2209 struct command_t Commands[] = {
2210 {"bind", mutt_parse_bind, 0},
2211 {"color", mutt_parse_color, 0},
2212 {"exec", mutt_parse_exec, 0},
2213 {"append-hook", mutt_parse_hook, M_APPENDHOOK},
2214 {"close-hook", mutt_parse_hook, M_CLOSEHOOK},
2215 {"crypt-hook", mutt_parse_hook, M_CRYPTHOOK},
2216 {"fcc-hook", mutt_parse_hook, M_FCCHOOK},
2217 {"fcc-save-hook", mutt_parse_hook, M_FCCHOOK|M_SAVEHOOK},
2218 {"folder-hook", mutt_parse_hook, M_FOLDERHOOK},
2219 {"mbox-hook", mutt_parse_hook, M_MBOXHOOK},
2220 {"message-hook", mutt_parse_hook, M_MESSAGEHOOK},
2221 {"open-hook", mutt_parse_hook, M_OPENHOOK},
2222 {"pgp-hook", mutt_parse_hook, M_CRYPTHOOK},
2223 {"reply-hook", mutt_parse_hook, M_REPLYHOOK},
2224 {"save-hook", mutt_parse_hook, M_SAVEHOOK},
2225 {"send2-hook", mutt_parse_hook, M_SEND2HOOK},
2226 {"send-hook", mutt_parse_hook, M_SENDHOOK},
2227 {"macro", mutt_parse_macro, 0},
2228 {"mono", mutt_parse_mono, 0},
2229 {"push", mutt_parse_push, 0},
2230 {"uncolor", mutt_parse_uncolor, 0},
2231 {"unhook", mutt_parse_unhook, 0},
2232 {"unmono", mutt_parse_unmono, 0},
2233 {"alias", parse_alias, 0},
2234 {"attachments", parse_attachments, 0 },
2235 {"my_hdr", parse_my_hdr, 0},
2236 {"reset", parse_set, M_SET_RESET},
2237 {"set", parse_set, 0},
2238 {"toggle", parse_set, M_SET_INV},
2239 {"unset", parse_set, M_SET_UNSET},
2240 {"source", parse_source, 0},
2241 {"unalias", parse_unalias, 0},
2242 {"unattachments", parse_unattachments, 0},
2243 {"unmy_hdr", parse_unmy_hdr, 0},