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.
25 #define DT_BOOL 1 /* boolean option */
26 #define DT_NUM 2 /* a number */
27 #define DT_STR 3 /* a string */
28 #define DT_PATH 4 /* a pathname */
29 #define DT_QUAD 5 /* quad-option (yes/no/ask-yes/ask-no) */
30 #define DT_SORT 6 /* sorting methods */
31 #define DT_RX 7 /* regular expressions */
32 #define DT_MAGIC 8 /* mailbox type */
33 #define DT_SYN 9 /* synonym for another variable */
34 #define DT_ADDR 10 /* e-mail address */
36 #define DTYPE(x) ((x) & DT_MASK)
39 #define DT_SUBTYPE_MASK 0xf0
40 #define DT_SORT_ALIAS 0x10
41 #define DT_SORT_BROWSER 0x20
42 #define DT_SORT_KEYS 0x40
43 #define DT_SORT_AUX 0x80
45 /* flags to parse_set() */
46 #define M_SET_INV (1<<0) /* default is to invert all vars */
47 #define M_SET_UNSET (1<<1) /* default is to unset all vars */
48 #define M_SET_RESET (1<<2) /* default is to reset all vars to default */
50 /* forced redraw/resort types */
52 #define R_INDEX (1<<0)
53 #define R_PAGER (1<<1)
54 #define R_BOTH (R_INDEX|R_PAGER)
56 /* TODO:MC: will go in the the thread module */
57 #define R_RESORT (1<<2) /* resort the mailbox */
58 #define R_RESORT_SUB (1<<3) /* resort subthreads */
59 #define R_RESORT_INIT (1<<4) /* resort from scratch */
60 #define R_TREE (1<<5) /* redraw the thread tree */
61 #define R_RESORT_BOTH (R_RESORT|R_RESORT_SUB)
71 #define UL (unsigned long)
76 #define ISPELL "ispell"
79 /* build complete documentation */
100 # ifndef HAVE_GETADDRINFO
101 # define HAVE_GETADDRINFO
105 struct option_t MuttVars[] = {
107 {"abort_noattach", DT_QUAD, R_NONE, OPT_ATTACH, "no" },
110 ** This variable specifies whether to abort sending if no attachment
111 ** was made but the content references them, i.e. the content
112 ** matches the regular expression given in
113 ** $$attach_remind_regexp. If a match was found and this
114 ** variable is set to \fIyes\fP, message sending will be aborted
115 ** but the mail will be send nevertheless if set to \fIno\fP.
118 ** This variable and $$attach_remind_regexp are intended to
119 ** remind the user to attach files if the message's text
123 ** See also the $$attach_remind_regexp variable.
125 {"abort_nosubject", DT_QUAD, R_NONE, OPT_SUBJECT, "ask-yes" },
128 ** If set to \fIyes\fP, when composing messages and no subject is given
129 ** at the subject prompt, composition will be aborted. If set to
130 ** \fIno\fP, composing messages with no subject given at the subject
131 ** prompt will never be aborted.
133 {"abort_unmodified", DT_QUAD, R_NONE, OPT_ABORT, "yes" },
136 ** If set to \fIyes\fP, composition will automatically abort after
137 ** editing the message body if no changes are made to the file (this
138 ** check only happens after the \fIfirst\fP edit of the file). When set
139 ** to \fIno\fP, composition will never be aborted.
141 {"alias_file", DT_PATH, R_NONE, UL &AliasFile, "~/.madmuttrc"},
144 ** The default file in which to save aliases created by the
145 ** ``$create-alias'' function.
147 ** \fBNote:\fP Madmutt will not automatically source this file; you must
148 ** explicitly use the ``$source'' command for it to be executed.
150 {"alias_format", DT_STR, R_NONE, UL &AliasFmt, "%4n %2f %t %-10a %r"},
153 ** Specifies the format of the data displayed for the ``alias'' menu. The
154 ** following \fTprintf(3)\fP-style sequences are available:
157 ** .dt %a .dd alias name
158 ** .dt %f .dd flags - currently, a "d" for an alias marked for deletion
159 ** .dt %n .dd index number
160 ** .dt %r .dd address which alias expands to
161 ** .dt %t .dd character which indicates if the alias is tagged for inclusion
164 {"allow_8bit", DT_BOOL, R_NONE, OPTALLOW8BIT, "yes" },
167 ** Controls whether 8-bit data is converted to 7-bit using either
168 ** \fTquoted-printable\fP or \fTbase64\fP encoding when sending mail.
170 {"allow_ansi", DT_BOOL, R_NONE, OPTALLOWANSI, "no" },
173 ** Controls whether ANSI color codes in messages (and color tags in
174 ** rich text messages) are to be interpreted.
175 ** Messages containing these codes are rare, but if this option is set,
176 ** their text will be colored accordingly. Note that this may override
177 ** your color choices, and even present a security problem, since a
178 ** message could include a line like ``\fT[-- PGP output follows ...\fP" and
179 ** give it the same color as your attachment color.
181 {"arrow_cursor", DT_BOOL, R_BOTH, OPTARROWCURSOR, "no" },
184 ** When \fIset\fP, an arrow (``\fT->\fP'') will be used to indicate the current entry
185 ** in menus instead of highlighting the whole line. On slow network or modem
186 ** links this will make response faster because there is less that has to
187 ** be redrawn on the screen when moving to the next or previous entries
190 {"ascii_chars", DT_BOOL, R_BOTH, OPTASCIICHARS, "no" },
193 ** If \fIset\fP, Madmutt will use plain ASCII characters when displaying thread
194 ** and attachment trees, instead of the default \fTACS\fP characters.
196 {"askbcc", DT_BOOL, R_NONE, OPTASKBCC, "no" },
199 ** If \fIset\fP, Madmutt will prompt you for blind-carbon-copy (Bcc) recipients
200 ** before editing an outgoing message.
202 {"askcc", DT_BOOL, R_NONE, OPTASKCC, "no" },
205 ** If \fIset\fP, Madmutt will prompt you for carbon-copy (Cc) recipients before
206 ** editing the body of an outgoing message.
208 {"assumed_charset", DT_STR, R_NONE, UL &AssumedCharset, "us-ascii"},
211 ** This variable is a colon-separated list of character encoding
212 ** schemes for messages without character encoding indication.
213 ** Header field values and message body content without character encoding
214 ** indication would be assumed that they are written in one of this list.
215 ** By default, all the header fields and message body without any charset
216 ** indication are assumed to be in \fTus-ascii\fP.
218 ** For example, Japanese users might prefer this:
220 ** \fTset assumed_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"\fP
222 ** However, only the first content is valid for the message body.
223 ** This variable is valid only if $$strict_mime is unset.
226 {"nntp_ask_followup_to", DT_BOOL, R_NONE, OPTASKFOLLOWUP, "no" },
229 ** Availability: NNTP
232 ** If \fIset\fP, Madmutt will prompt you for the \fTFollowup-To:\fP header
233 ** field before editing the body of an outgoing news article.
235 {"nntp_ask_x_comment_to", DT_BOOL, R_NONE, OPTASKXCOMMENTTO, "no" },
238 ** Availability: NNTP
241 ** If \fIset\fP, Madmutt will prompt you for the \fTX-Comment-To:\fP header
242 ** field before editing the body of an outgoing news article.
245 {"attach_format", DT_STR, R_NONE, UL &AttachFormat, "%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] "},
248 ** This variable describes the format of the ``attachment'' menu. The
249 ** following \fTprintf(3)\fP-style sequences are understood:
252 ** .dt %C .dd charset
253 ** .dt %c .dd requires charset conversion (n or c)
254 ** .dt %D .dd deleted flag
255 ** .dt %d .dd description
256 ** .dt %e .dd MIME \fTContent-Transfer-Encoding:\fP header field
257 ** .dt %f .dd filename
258 ** .dt %I .dd MIME \fTContent-Disposition:\fP header field (\fTI\fP=inline, \fTA\fP=attachment)
259 ** .dt %m .dd major MIME type
260 ** .dt %M .dd MIME subtype
261 ** .dt %n .dd attachment number
262 ** .dt %Q .dd "Q", if MIME part qualifies for attachment counting
264 ** .dt %t .dd tagged flag
265 ** .dt %T .dd graphic tree characters
266 ** .dt %u .dd unlink (=to delete) flag
267 ** .dt %X .dd number of qualifying MIME parts in this part and its children
268 ** .dt %>X .dd right justify the rest of the string and pad with character "X"
269 ** .dt %|X .dd pad to the end of the line with character "X"
272 {"attach_remind_regexp", DT_RX, R_NONE, UL &AttachRemindRegexp, "attach"},
275 ** If this variable is non-empty, madmutt will scan a message's contents
276 ** before sending for this regular expression. If it is found, it will
277 ** ask for what to do depending on the setting of $$abort_noattach.
279 ** This variable and $$abort_noattach are intended to remind the user
280 ** to attach files if the message's text references them.
282 {"attach_sep", DT_STR, R_NONE, UL &AttachSep, "\n"},
285 ** The separator to add between attachments when operating (saving,
286 ** printing, piping, etc) on a list of tagged attachments.
288 {"attach_split", DT_BOOL, R_NONE, OPTATTACHSPLIT, "yes" },
291 ** If this variable is \fIunset\fP, when operating (saving, printing, piping,
292 ** etc) on a list of tagged attachments, Madmutt will concatenate the
293 ** attachments and will operate on them as a single attachment. The
294 ** ``$$attach_sep'' separator is added after each attachment. When \fIset\fP,
295 ** Madmutt will operate on the attachments one by one.
297 {"attribution", DT_STR, R_NONE, UL &Attribution, "On %d, %n wrote:"},
300 ** This is the string that will precede a message which has been included
301 ** in a reply. For a full listing of defined \fTprintf(3)\fP-like sequences see
302 ** the section on ``$$index_format''.
304 {"autoedit", DT_BOOL, R_NONE, OPTAUTOEDIT, "no" },
307 ** When \fIset\fP along with ``$$edit_headers'', Madmutt will skip the initial
308 ** send-menu and allow you to immediately begin editing the body of your
309 ** message. The send-menu may still be accessed once you have finished
310 ** editing the body of your message.
312 ** Also see ``$$fast_reply''.
314 {"auto_tag", DT_BOOL, R_NONE, OPTAUTOTAG, "no" },
317 ** When \fIset\fP, functions in the \fIindex\fP menu which affect a message
318 ** will be applied to all tagged messages (if there are any). When
319 ** unset, you must first use the ``tag-prefix'' function (default: "\fT;\fP") to
320 ** make the next function apply to all tagged messages.
322 {"bounce", DT_QUAD, R_NONE, OPT_BOUNCE, "ask-yes" },
325 ** Controls whether you will be asked to confirm bouncing messages.
326 ** If set to \fIyes\fP you don't get asked if you want to bounce a
327 ** message. Setting this variable to \fIno\fP is not generally useful,
328 ** and thus not recommended, because you are unable to bounce messages.
330 {"bounce_delivered", DT_BOOL, R_NONE, OPTBOUNCEDELIVERED, "yes" },
333 ** When this variable is \fIset\fP, Madmutt will include
334 ** \fTDelivered-To:\fP header fields when bouncing messages.
335 ** Postfix users may wish to \fIunset\fP this variable.
337 { "braille_friendly", DT_BOOL, R_NONE, OPTBRAILLEFRIENDLY, "no" },
340 ** When this variable is set, mutt will place the cursor at the beginning
341 ** of the current line in menus, even when the arrow_cursor variable
342 ** is unset, making it easier for blind persons using Braille displays to
343 ** follow these menus. The option is disabled by default because many
344 ** visual terminals don't permit making the cursor invisible.
347 {"nntp_catchup", DT_QUAD, R_NONE, OPT_CATCHUP, "ask-yes" },
350 ** Availability: NNTP
353 ** If this variable is \fIset\fP, Madmutt will mark all articles in a newsgroup
354 ** as read when you leaving it.
357 {"charset", DT_STR, R_NONE, UL &Charset, "" },
360 ** Character set your terminal uses to display and enter textual data.
362 {"check_new", DT_BOOL, R_NONE, OPTCHECKNEW, "yes" },
365 ** \fBNote:\fP this option only affects \fImaildir\fP and \fIMH\fP style
368 ** When \fIset\fP, Madmutt will check for new mail delivered while the
369 ** mailbox is open. Especially with MH mailboxes, this operation can
370 ** take quite some time since it involves scanning the directory and
371 ** checking each file to see if it has already been looked at. If it's
372 ** \fIunset\fP, no check for new mail is performed while the mailbox is open.
374 {"collapse_unread", DT_BOOL, R_NONE, OPTCOLLAPSEUNREAD, "yes" },
377 ** When \fIunset\fP, Madmutt will not collapse a thread if it contains any
380 {"uncollapse_jump", DT_BOOL, R_NONE, OPTUNCOLLAPSEJUMP, "no" },
383 ** When \fIset\fP, Madmutt will jump to the next unread message, if any,
384 ** when the current thread is \fIun\fPcollapsed.
386 {"compose_format", DT_STR, R_BOTH, UL &ComposeFormat, "-- Madmutt: Compose [Approx. msg size: %l Atts: %a]%>-"},
389 ** Controls the format of the status line displayed in the ``compose''
390 ** menu. This string is similar to ``$$status_format'', but has its own
391 ** set of \fTprintf(3)\fP-like sequences:
394 ** .dt %a .dd total number of attachments
395 ** .dt %h .dd local hostname
396 ** .dt %l .dd approximate size (in bytes) of the current message
397 ** .dt %v .dd Madmutt version string
400 ** See the text describing the ``$$status_format'' option for more
401 ** information on how to set ``$$compose_format''.
403 {"config_charset", DT_STR, R_NONE, UL &ConfigCharset, "" },
406 ** When defined, Madmutt will recode commands in rc files from this
409 {"confirmappend", DT_BOOL, R_NONE, OPTCONFIRMAPPEND, "yes" },
412 ** When \fIset\fP, Madmutt will prompt for confirmation when appending messages to
413 ** an existing mailbox.
415 {"confirmcreate", DT_BOOL, R_NONE, OPTCONFIRMCREATE, "yes" },
418 ** When \fIset\fP, Madmutt will prompt for confirmation when saving messages to a
419 ** mailbox which does not yet exist before creating it.
421 {"connect_timeout", DT_NUM, R_NONE, UL &ConnectTimeout, "30" },
424 ** Causes Madmutt to timeout a network connection (for IMAP or POP) after this
425 ** many seconds if the connection is not able to be established. A negative
426 ** value causes Madmutt to wait indefinitely for the connection to succeed.
428 {"content_type", DT_STR, R_NONE, UL &ContentType, "text/plain"},
431 ** Sets the default \fTContent-Type:\fP header field for the body
432 ** of newly composed messages.
434 {"copy", DT_QUAD, R_NONE, OPT_COPY, "yes" },
437 ** This variable controls whether or not copies of your outgoing messages
438 ** will be saved for later references. Also see ``$$record'',
439 ** ``$$save_name'', ``$$force_name'' and ``$fcc-hook''.
441 {"crypt_use_gpgme", DT_BOOL, R_NONE, OPTCRYPTUSEGPGME, "no" },
444 ** This variable controls the use the GPGME enabled crypto backends.
445 ** If it is \fIset\fP and Madmutt was build with gpgme support, the gpgme code for
446 ** S/MIME and PGP will be used instead of the classic code.
448 ** \fBNote\fP: You need to use this option in your \fT.madmuttrc\fP configuration
449 ** file as it won't have any effect when used interactively.
451 {"crypt_autopgp", DT_BOOL, R_NONE, OPTCRYPTAUTOPGP, "yes" },
454 ** This variable controls whether or not Madmutt may automatically enable
455 ** PGP encryption/signing for messages. See also ``$$crypt_autoencrypt'',
456 ** ``$$crypt_replyencrypt'',
457 ** ``$$crypt_autosign'', ``$$crypt_replysign'' and ``$$smime_is_default''.
459 {"crypt_autosmime", DT_BOOL, R_NONE, OPTCRYPTAUTOSMIME, "yes" },
462 ** This variable controls whether or not Madmutt may automatically enable
463 ** S/MIME encryption/signing for messages. See also ``$$crypt_autoencrypt'',
464 ** ``$$crypt_replyencrypt'',
465 ** ``$$crypt_autosign'', ``$$crypt_replysign'' and ``$$smime_is_default''.
467 {"date_format", DT_STR, R_BOTH, UL &DateFmt, "!%a, %b %d, %Y at %I:%M:%S%p %Z"},
470 ** This variable controls the format of the date printed by the ``\fT%d\fP''
471 ** sequence in ``$$index_format''. This is passed to \fTstrftime(3)\fP
472 ** to process the date.
474 ** Unless the first character in the string is a bang (``\fT!\fP''), the month
475 ** and week day names are expanded according to the locale specified in
476 ** the variable ``$$locale''. If the first character in the string is a
477 ** bang, the bang is discarded, and the month and week day names in the
478 ** rest of the string are expanded in the \fIC\fP locale (that is in US
481 {"default_hook", DT_STR, R_NONE, UL &DefaultHook, "~f %s !~P | (~P ~C %s)"},
484 ** This variable controls how send-hooks, message-hooks, save-hooks,
485 ** and fcc-hooks will
486 ** be interpreted if they are specified with only a simple regexp,
487 ** instead of a matching pattern. The hooks are expanded when they are
488 ** declared, so a hook will be interpreted according to the value of this
489 ** variable at the time the hook is declared. The default value matches
490 ** if the message is either from a user matching the regular expression
491 ** given, or if it is from you (if the from address matches
492 ** ``alternates'') and is to or cc'ed to a user matching the given
493 ** regular expression.
495 {"delete", DT_QUAD, R_NONE, OPT_DELETE, "ask-yes" },
498 ** Controls whether or not messages are really deleted when closing or
499 ** synchronizing a mailbox. If set to \fIyes\fP, messages marked for
500 ** deleting will automatically be purged without prompting. If set to
501 ** \fIno\fP, messages marked for deletion will be kept in the mailbox.
503 {"delete_space", DT_BOOL, R_NONE, OPTDELSP, "no" },
506 ** When sending messages with \fTformat=flowed\fP by \fIsetting\fP the
507 ** $$text_flowed variable, this variable specifies whether to also
508 ** set the \fTDelSp\fP parameter to \fTyes\fP. If this is \fIunset\fP,
509 ** no additional parameter will be send as a value of \fTno\fP already
510 ** is the default behavior.
513 ** \fBNote:\fP this variable only has an effect on \fIoutgoing\fP messages
514 ** (if $$text_flowed is \fIset\fP) but not on incomming.
516 {"delete_untag", DT_BOOL, R_NONE, OPTDELETEUNTAG, "yes" },
519 ** If this option is \fIset\fP, Madmutt will untag messages when marking them
520 ** for deletion. This applies when you either explicitly delete a message,
521 ** or when you save it to another folder.
523 {"digest_collapse", DT_BOOL, R_NONE, OPTDIGESTCOLLAPSE, "yes" },
526 ** If this option is \fIset\fP, Madmutt's received-attachments menu will not show the subparts of
527 ** individual messages in a multipart/digest. To see these subparts, press 'v' on that menu.
529 {"display_filter", DT_PATH, R_PAGER, UL &DisplayFilter, ""},
532 ** When \fIset\fP, specifies a command used to filter messages. When a message
533 ** is viewed it is passed as standard input to $$display_filter, and the
534 ** filtered message is read from the standard output.
536 {"duplicate_threads", DT_BOOL, R_RESORT|R_RESORT_INIT|R_INDEX, OPTDUPTHREADS, "yes" },
539 ** This variable controls whether Madmutt, when sorting by threads, threads
540 ** messages with the same \fTMessage-ID:\fP header field together.
541 ** If it is \fIset\fP, it will indicate that it thinks they are duplicates
542 ** of each other with an equals sign in the thread diagram.
544 {"edit_headers", DT_BOOL, R_NONE, OPTEDITHDRS, "no" },
547 ** This option allows you to edit the header of your outgoing messages
548 ** along with the body of your message.
551 ** Which empty header fields to show is controlled by the
552 ** $$editor_headers option.
555 {"editor_headers", DT_STR, R_NONE, UL &EditorHeaders, "From: To: Cc: Bcc: Subject: Reply-To: Newsgroups: Followup-To: X-Comment-To:" },
557 {"editor_headers", DT_STR, R_NONE, UL &EditorHeaders, "From: To: Cc: Bcc: Subject: Reply-To:" },
561 ** If $$edit_headers is \fIset\fP, this space-separated list specifies
562 ** which \fInon-empty\fP header fields to edit in addition to
563 ** user-defined headers.
566 ** Note: if $$edit_headers had to be turned on by force because
567 ** $$strict_mailto is \fIunset\fP, this option has no effect.
569 {"encode_from", DT_BOOL, R_NONE, OPTENCODEFROM, "no" },
572 ** When \fIset\fP, Madmutt will \fTquoted-printable\fP encode messages when
573 ** they contain the string ``\fTFrom \fP'' (note the trailing space)
574 ** in the beginning of a line. Useful to avoid the tampering certain mail
575 ** delivery and transport agents tend to do with messages.
578 ** \fBNote:\fP as Madmutt currently violates RfC3676 defining
579 ** \fTformat=flowed\fP, it's <em/strongly/ advised to \fIset\fP
580 ** this option although discouraged by the standard. Alternatively,
581 ** you must take care of space-stuffing <tt/From / lines (with a trailing
584 {"envelope_from", DT_SYN, R_NONE, UL "use_envelope_from", 0 },
585 {"use_envelope_from", DT_BOOL, R_NONE, OPTENVFROM, "no" },
588 ** When \fIset\fP, Madmutt will use ``$$envelope_from_address'' as the
589 ** \fIenvelope\fP sender if that is set, otherwise it will attempt to
590 ** derive it from the "From:" header.
593 ** \fBNote:\fP This information is passed
594 ** to sendmail command using the "-f" command line switch and
595 ** passed to the SMTP server for libESMTP (if support is compiled in).
597 {"envelope_from_address", DT_ADDR, R_NONE, UL &EnvFrom, "" },
600 ** Manually sets the \fIenvelope\fP sender for outgoing messages.
601 ** This value is ignored if ``$$use_envelope_from'' is unset.
603 {"fast_reply", DT_BOOL, R_NONE, OPTFASTREPLY, "no" },
606 ** When \fIset\fP, the initial prompt for recipients and subject are skipped
607 ** when replying to messages, and the initial prompt for subject is
608 ** skipped when forwarding messages.
610 ** \fBNote:\fP this variable has no effect when the ``$$autoedit''
611 ** variable is \fIset\fP.
613 {"fcc_attach", DT_BOOL, R_NONE, OPTFCCATTACH, "yes" },
616 ** This variable controls whether or not attachments on outgoing messages
617 ** are saved along with the main body of your message.
619 {"fcc_clear", DT_BOOL, R_NONE, OPTFCCCLEAR, "no" },
622 ** When this variable is \fIset\fP, FCCs will be stored unencrypted and
623 ** unsigned, even when the actual message is encrypted and/or
627 {"file_charset", DT_STR, R_NONE, UL &FileCharset, "" },
630 ** This variable is a colon-separated list of character encoding
631 ** schemes for text file attatchments.
632 ** If \fIunset\fP, $$charset value will be used instead.
633 ** For example, the following configuration would work for Japanese
636 ** \fTset file_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"\fP
638 ** Note: ``\fTiso-2022-*\fP'' must be put at the head of the value as shown above
641 {"folder", DT_PATH, R_NONE, UL &Maildir, "~/Mail"},
644 ** Specifies the default location of your mailboxes. A ``\fT+\fP'' or ``\fT=\fP'' at the
645 ** beginning of a pathname will be expanded to the value of this
646 ** variable. Note that if you change this variable from the default
647 ** value you need to make sure that the assignment occurs \fIbefore\fP
648 ** you use ``+'' or ``='' for any other variables since expansion takes place
649 ** during the ``set'' command.
651 {"folder_format", DT_STR, R_INDEX, UL &FolderFormat, "%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f"},
654 ** This variable allows you to customize the file browser display to your
655 ** personal taste. This string is similar to ``$$index_format'', but has
656 ** its own set of \fTprintf(3)\fP-like sequences:
659 ** .dt %C .dd current file number
660 ** .dt %d .dd date/time folder was last modified
661 ** .dt %f .dd filename
662 ** .dt %F .dd file permissions
663 ** .dt %g .dd group name (or numeric gid, if missing)
664 ** .dt %l .dd number of hard links
665 ** .dt %N .dd N if folder has new mail, blank otherwise
666 ** .dt %s .dd size in bytes
667 ** .dt %t .dd * if the file is tagged, blank otherwise
668 ** .dt %u .dd owner name (or numeric uid, if missing)
669 ** .dt %>X .dd right justify the rest of the string and pad with character "X"
670 ** .dt %|X .dd pad to the end of the line with character "X"
673 {"followup_to", DT_BOOL, R_NONE, OPTFOLLOWUPTO, "yes" },
676 ** Controls whether or not the \fTMail-Followup-To:\fP header field is
677 ** generated when sending mail. When \fIset\fP, Madmutt will generate this
678 ** field when you are replying to a known mailing list, specified with
679 ** the ``subscribe'' or ``$lists'' commands or detected by common mailing list
682 ** This field has two purposes. First, preventing you from
683 ** receiving duplicate copies of replies to messages which you send
684 ** to mailing lists. Second, ensuring that you do get a reply
685 ** separately for any messages sent to known lists to which you are
686 ** not subscribed. The header will contain only the list's address
687 ** for subscribed lists, and both the list address and your own
688 ** email address for unsubscribed lists. Without this header, a
689 ** group reply to your message sent to a subscribed list will be
690 ** sent to both the list and your address, resulting in two copies
691 ** of the same email for you.
694 {"nntp_followup_to_poster", DT_QUAD, R_NONE, OPT_FOLLOWUPTOPOSTER, "ask-yes" },
697 ** Availability: NNTP
700 ** If this variable is \fIset\fP and the keyword "\fTposter\fP" is present in
701 ** the \fTFollowup-To:\fP header field, a follow-up to the newsgroup is not
702 ** permitted. The message will be mailed to the submitter of the
706 {"force_name", DT_BOOL, R_NONE, OPTFORCENAME, "no" },
709 ** This variable is similar to ``$$save_name'', except that Madmutt will
710 ** store a copy of your outgoing message by the username of the address
711 ** you are sending to even if that mailbox does not exist.
713 ** Also see the ``$$record'' variable.
715 {"force_buffy_check", DT_BOOL, R_NONE, OPTFORCEBUFFYCHECK, "no" },
718 ** When \fIset\fP, it causes Madmutt to check for new mail when the
719 ** \fIbuffy-list\fP command is invoked. When \fIunset\fP, \fIbuffy_list\fP
720 ** will just list all mailboxes which are already known to have new mail.
722 ** Also see the following variables: ``$$timeout'', ``$$mail_check'' and
723 ** ``$$imap_mail_check''.
725 {"forward_decode", DT_BOOL, R_NONE, OPTFORWDECODE, "yes" },
728 ** Controls the decoding of complex MIME messages into \fTtext/plain\fP when
729 ** forwarding a message. The message header is also RFC2047 decoded.
730 ** This variable is only used, if ``$$mime_forward'' is \fIunset\fP,
731 ** otherwise ``$$mime_forward_decode'' is used instead.
733 {"forward_edit", DT_QUAD, R_NONE, OPT_FORWEDIT, "yes" },
736 ** This quadoption controls whether or not the user is automatically
737 ** placed in the editor when forwarding messages. For those who always want
738 ** to forward with no modification, use a setting of \fIno\fP.
740 {"forward_format", DT_STR, R_NONE, UL &ForwFmt, "[%a: %s]"},
743 ** This variable controls the default subject when forwarding a message.
744 ** It uses the same format sequences as the ``$$index_format'' variable.
746 {"forward_quote", DT_BOOL, R_NONE, OPTFORWQUOTE, "no" },
749 ** When \fIset\fP forwarded messages included in the main body of the
750 ** message (when ``$$mime_forward'' is \fIunset\fP) will be quoted using
751 ** ``$$indent_string''.
753 {"from", DT_ADDR, R_NONE, UL &From, "" },
756 ** This variable contains a default from address. It
757 ** can be overridden using my_hdr (including from send-hooks) and
758 ** ``$$reverse_name''. This variable is ignored if ``$$use_from''
762 ** \fTsend-hook Madmutt-devel@lists.berlios.de 'my_hdr From: Foo Bar <foo@bar.fb>'\fP
763 ** when replying to the Madmutt developer's mailing list and Madmutt takes this email address.
765 ** Defaults to the contents of the environment variable \fT$$$EMAIL\fP.
767 {"gecos_mask", DT_RX, R_NONE, UL &GecosMask, "^[^,]*"},
770 ** A regular expression used by Madmutt to parse the GECOS field of a password
771 ** entry when expanding the alias. By default the regular expression is set
772 ** to ``\fT^[^,]*\fP'' which will return the string up to the first ``\fT,\fP'' encountered.
773 ** If the GECOS field contains a string like "lastname, firstname" then you
774 ** should do: \fTset gecos_mask=".*"\fP.
776 ** This can be useful if you see the following behavior: you address a e-mail
777 ** to user ID stevef whose full name is Steve Franklin. If Madmutt expands
778 ** stevef to ``Franklin'' stevef@foo.bar then you should set the gecos_mask to
779 ** a regular expression that will match the whole name so Madmutt will expand
780 ** ``Franklin'' to ``Franklin, Steve''.
783 {"nntp_group_index_format", DT_STR, R_BOTH, UL &GroupFormat, "%4C %M%N %5s %-45.45f %d"},
786 ** Availability: NNTP
789 ** This variable allows you to customize the newsgroup browser display to
790 ** your personal taste. This string is similar to ``$index_format'', but
791 ** has its own set of \fTprintf(3)\fP-like sequences:
794 ** %C current newsgroup number
795 ** %d description of newsgroup (retrieved from server)
797 ** %M ``-'' if newsgroup not allowed for direct post (moderated for example)
798 ** %N ``N'' if newsgroup is new, ``u'' if unsubscribed, blank otherwise
799 ** %n number of new articles in newsgroup
800 ** %s number of unread articles in newsgroup
801 ** %>X right justify the rest of the string and pad with character "X"
802 ** %|X pad to the end of the line with character "X"
806 {"hdrs", DT_BOOL, R_NONE, OPTHDRS, "yes" },
809 ** When \fIunset\fP, the header fields normally added by the ``$my_hdr''
810 ** command are not created. This variable \fImust\fP be \fIunset\fP before
811 ** composing a new message or replying in order to take effect. If \fIset\fP,
812 ** the user defined header fields are added to every new message.
814 {"header", DT_BOOL, R_NONE, OPTHEADER, "no" },
817 ** When \fIset\fP, this variable causes Madmutt to include the header
818 ** of the message you are replying to into the edit buffer.
819 ** The ``$$weed'' setting applies.
821 {"help", DT_BOOL, R_BOTH, OPTHELP, "yes" },
824 ** When \fIset\fP, help lines describing the bindings for the major functions
825 ** provided by each menu are displayed on the first line of the screen.
827 ** \fBNote:\fP The binding will not be displayed correctly if the
828 ** function is bound to a sequence rather than a single keystroke. Also,
829 ** the help line may not be updated if a binding is changed while Madmutt is
830 ** running. Since this variable is primarily aimed at new users, neither
831 ** of these should present a major problem.
833 {"hidden_host", DT_BOOL, R_NONE, OPTHIDDENHOST, "no" },
836 ** When \fIset\fP, Madmutt will skip the host name part of ``$$hostname'' variable
837 ** when adding the domain part to addresses. This variable does not
838 ** affect the generation of \fTMessage-ID:\fP header fields, and it will not lead to the
839 ** cut-off of first-level domains.
841 {"hide_limited", DT_BOOL, R_TREE|R_INDEX, OPTHIDELIMITED, "no" },
844 ** When \fIset\fP, Madmutt will not show the presence of messages that are hidden
845 ** by limiting, in the thread tree.
847 {"hide_missing", DT_BOOL, R_TREE|R_INDEX, OPTHIDEMISSING, "yes" },
850 ** When \fIset\fP, Madmutt will not show the presence of missing messages in the
853 {"hide_thread_subject", DT_BOOL, R_TREE|R_INDEX, OPTHIDETHREADSUBJECT, "yes" },
856 ** When \fIset\fP, Madmutt will not show the subject of messages in the thread
857 ** tree that have the same subject as their parent or closest previously
858 ** displayed sibling.
860 {"hide_top_limited", DT_BOOL, R_TREE|R_INDEX, OPTHIDETOPLIMITED, "no" },
863 ** When \fIset\fP, Madmutt will not show the presence of messages that are hidden
864 ** by limiting, at the top of threads in the thread tree. Note that when
865 ** $$hide_missing is \fIset\fP, this option will have no effect.
867 {"hide_top_missing", DT_BOOL, R_TREE|R_INDEX, OPTHIDETOPMISSING, "yes" },
870 ** When \fIset\fP, Madmutt will not show the presence of missing messages at the
871 ** top of threads in the thread tree. Note that when $$hide_limited is
872 ** \fIset\fP, this option will have no effect.
874 {"history", DT_NUM, R_NONE, UL &HistSize, "10" },
877 ** This variable controls the size (in number of strings remembered) of
878 ** the string history buffer. The buffer is cleared each time the
879 ** variable is changed.
881 {"honor_followup_to", DT_QUAD, R_NONE, OPT_MFUPTO, "yes" },
884 ** This variable controls whether or not a \fTMail-Followup-To:\fP header field is
885 ** honored when group-replying to a message.
887 {"hostname", DT_STR, R_NONE, UL &Fqdn, "" },
890 ** Specifies the hostname to use after the ``\fT@\fP'' in local e-mail
891 ** addresses and during generation of \fTMessage-ID:\fP headers.
893 ** Please be sure to really know what you are doing when changing this variable
894 ** to configure a custom domain part of Message-IDs.
896 {"ignore_list_reply_to", DT_BOOL, R_NONE, OPTIGNORELISTREPLYTO, "no" },
899 ** Affects the behaviour of the \fIreply\fP function when replying to
900 ** messages from mailing lists. When \fIset\fP, if the ``\fTReply-To:\fP'' header field is
901 ** set to the same value as the ``\fTTo:\fP'' header field, Madmutt assumes that the
902 ** ``\fTReply-To:\fP'' header field was set by the mailing list to automate responses
903 ** to the list, and will ignore this field. To direct a response to the
904 ** mailing list when this option is set, use the \fIlist-reply\fP
905 ** function; \fIgroup-reply\fP will reply to both the sender and the
907 ** Remember: This option works only for mailing lists which are explicitly set in your madmuttrc
908 ** configuration file.
910 {"imap_authenticators", DT_STR, R_NONE, UL &ImapAuthenticators, "" },
913 ** This is a colon-delimited list of authentication methods Madmutt may
914 ** attempt to use to log in to an IMAP server, in the order Madmutt should
915 ** try them. Authentication methods are either ``\fTlogin\fP'' or the right
916 ** side of an IMAP ``\fTAUTH=\fP'' capability string, e.g. ``\fTdigest-md5\fP'',
917 ** ``\fTgssapi\fP'' or ``\fTcram-md5\fP''. This parameter is case-insensitive.
920 ** parameter is \fIunset\fP (the default) Madmutt will try all available methods,
921 ** in order from most-secure to least-secure.
923 ** Example: \fTset imap_authenticators="gssapi:cram-md5:login"\fP
925 ** \fBNote:\fP Madmutt will only fall back to other authentication methods if
926 ** the previous methods are unavailable. If a method is available but
927 ** authentication fails, Madmutt will not connect to the IMAP server.
929 { "imap_check_subscribed", DT_BOOL, R_NONE, OPTIMAPCHECKSUBSCRIBED, "no" },
932 ** When \fIset\fP, mutt will fetch the set of subscribed folders from
933 ** your server on connection, and add them to the set of mailboxes
934 ** it polls for new mail. See also the ``$mailboxes'' command.
936 {"imap_delim_chars", DT_STR, R_NONE, UL &ImapDelimChars, "/."},
939 ** This contains the list of characters which you would like to treat
940 ** as folder separators for displaying IMAP paths. In particular it
941 ** helps in using the '\fT=\fP' shortcut for your $$folder variable.
943 {"imap_headers", DT_STR, R_INDEX, UL &ImapHeaders, "" },
946 ** Madmutt requests these header fields in addition to the default headers
947 ** (``DATE FROM SUBJECT TO CC MESSAGE-ID REFERENCES CONTENT-TYPE
948 ** CONTENT-DESCRIPTION IN-REPLY-TO REPLY-TO LINES X-LABEL'') from IMAP
949 ** servers before displaying the ``index'' menu. You may want to add more
950 ** headers for spam detection.
952 ** \fBNote:\fP This is a space separated list.
954 {"imap_home_namespace", DT_STR, R_NONE, UL &ImapHomeNamespace, "" },
957 ** You normally want to see your personal folders alongside
958 ** your \fTINBOX\fP in the IMAP browser. If you see something else, you may set
959 ** this variable to the IMAP path to your folders.
961 {"imap_keepalive", DT_NUM, R_NONE, UL &ImapKeepalive, "900" },
964 ** This variable specifies the maximum amount of time in seconds that Madmutt
965 ** will wait before polling open IMAP connections, to prevent the server
966 ** from closing them before Madmutt has finished with them.
969 ** well within the RFC-specified minimum amount of time (30 minutes) before
970 ** a server is allowed to do this, but in practice the RFC does get
971 ** violated every now and then.
973 ** Reduce this number if you find yourself
974 ** getting disconnected from your IMAP server due to inactivity.
976 {"imap_login", DT_STR, R_NONE, UL &ImapLogin, "" },
979 ** Your login name on the IMAP server.
981 ** This variable defaults to the value of ``$$imap_user.''
983 {"imap_list_subscribed", DT_BOOL, R_NONE, OPTIMAPLSUB, "no" },
986 ** This variable configures whether IMAP folder browsing will look for
987 ** only subscribed folders or all folders. This can be toggled in the
988 ** IMAP browser with the \fItoggle-subscribed\fP function.
990 {"imap_mail_check", DT_NUM, R_NONE, UL &ImapBuffyTimeout, "300" },
993 ** This variable configures how often (in seconds) Madmutt should look for
994 ** new mail in IMAP folders. This is split from the ``$mail_check'' variable
995 ** to generate less traffic and get more accurate information for local folders.
997 {"imap_pass", DT_STR, R_NONE, UL &ImapPass, "" },
1000 ** Specifies the password for your IMAP account. If \fIunset\fP, Madmutt will
1001 ** prompt you for your password when you invoke the fetch-mail function.
1003 ** \fBWarning\fP: you should only use this option when you are on a
1004 ** fairly secure machine, because the superuser can read your configuration even
1005 ** if you are the only one who can read the file.
1007 {"imap_passive", DT_BOOL, R_NONE, OPTIMAPPASSIVE, "yes" },
1010 ** When \fIset\fP, Madmutt will not open new IMAP connections to check for new
1011 ** mail. Madmutt will only check for new mail over existing IMAP
1012 ** connections. This is useful if you don't want to be prompted to
1013 ** user/password pairs on Madmutt invocation, or if opening the connection
1016 {"imap_peek", DT_BOOL, R_NONE, OPTIMAPPEEK, "yes" },
1019 ** If \fIset\fP, Madmutt will avoid implicitly marking your mail as read whenever
1020 ** you fetch a message from the server. This is generally a good thing,
1021 ** but can make closing an IMAP folder somewhat slower. This option
1022 ** exists to appease speed freaks.
1024 {"imap_reconnect", DT_QUAD, R_NONE, OPT_IMAPRECONNECT, "ask-yes" },
1027 ** Controls whether or not Madmutt will try to reconnect to IMAP server when
1028 ** the connection is lost.
1030 {"imap_servernoise", DT_BOOL, R_NONE, OPTIMAPSERVERNOISE, "yes" },
1033 ** When \fIset\fP, Madmutt will display warning messages from the IMAP
1034 ** server as error messages. Since these messages are often
1035 ** harmless, or generated due to configuration problems on the
1036 ** server which are out of the users' hands, you may wish to suppress
1037 ** them at some point.
1039 {"imap_user", DT_STR, R_NONE, UL &ImapUser, "" },
1042 ** The name of the user whose mail you intend to access on the IMAP
1045 ** This variable defaults to your user name on the local machine.
1047 {"implicit_autoview", DT_BOOL, R_NONE, OPTIMPLICITAUTOVIEW, "no" },
1050 ** If \fIset\fP, Madmutt will look for a mailcap entry with the
1051 ** ``\fTcopiousoutput\fP'' flag set for \fIevery\fP MIME attachment it doesn't have
1052 ** an internal viewer defined for. If such an entry is found, Madmutt will
1053 ** use the viewer defined in that entry to convert the body part to text
1056 {"include", DT_QUAD, R_NONE, OPT_INCLUDE, "ask-yes" },
1059 ** Controls whether or not a copy of the message(s) you are replying to
1060 ** is included in your reply.
1062 {"include_onlyfirst", DT_BOOL, R_NONE, OPTINCLUDEONLYFIRST, "no" },
1065 ** Controls whether or not Madmutt includes only the first attachment
1066 ** of the message you are replying.
1068 {"indent_string", DT_STR, R_NONE, UL &Prefix, "> "},
1071 ** Specifies the string to prepend to each line of text quoted in a
1072 ** message to which you are replying. You are strongly encouraged not to
1073 ** change this value, as it tends to agitate the more fanatical netizens.
1075 {"index_format", DT_STR, R_BOTH, UL &HdrFmt, "%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s"},
1078 ** This variable allows you to customize the message index display to
1079 ** your personal taste.
1081 ** ``Format strings'' are similar to the strings used in the ``C''
1082 ** function \fTprintf(3)\fP to format output (see the man page for more detail).
1083 ** The following sequences are defined in Madmutt:
1086 ** .dt %a .dd address of the author
1087 ** .dt %A .dd reply-to address (if present; otherwise: address of author)
1088 ** .dt %b .dd filename of the original message folder (think mailBox)
1089 ** .dt %B .dd the list to which the letter was sent, or else the folder name (%b).
1090 ** .dt %c .dd number of characters (bytes) in the message
1091 ** .dt %C .dd current message number
1092 ** .dt %d .dd date and time of the message in the format specified by
1093 ** ``date_format'' converted to sender's time zone
1094 ** .dt %D .dd date and time of the message in the format specified by
1095 ** ``date_format'' converted to the local time zone
1096 ** .dt %e .dd current message number in thread
1097 ** .dt %E .dd number of messages in current thread
1098 ** .dt %f .dd entire From: line (address + real name)
1099 ** .dt %F .dd author name, or recipient name if the message is from you
1100 ** .dt %H .dd spam attribute(s) of this message
1101 ** .dt %g .dd newsgroup name (if compiled with nntp support)
1102 ** .dt %i .dd message-id of the current message
1103 ** .dt %l .dd number of lines in the message (does not work with maildir,
1104 ** mh, and possibly IMAP folders)
1105 ** .dt %L .dd If an address in the To or CC header field matches an address
1106 ** defined by the users ``subscribe'' command, this displays
1107 ** "To <list-name>", otherwise the same as %F.
1108 ** .dt %m .dd total number of message in the mailbox
1109 ** .dt %M .dd number of hidden messages if the thread is collapsed.
1110 ** .dt %N .dd message score
1111 ** .dt %n .dd author's real name (or address if missing)
1112 ** .dt %O .dd (_O_riginal save folder) Where Madmutt would formerly have
1113 ** stashed the message: list name or recipient name if no list
1114 ** .dt %s .dd subject of the message
1115 ** .dt %S .dd status of the message (N/D/d/!/r/\(as)
1116 ** .dt %t .dd `to:' field (recipients)
1117 ** .dt %T .dd the appropriate character from the $$to_chars string
1118 ** .dt %u .dd user (login) name of the author
1119 ** .dt %v .dd first name of the author, or the recipient if the message is from you
1120 ** .dt %W .dd name of organization of author (`organization:' field)
1121 ** .dt %X .dd number of attachments
1122 ** .dt %y .dd `x-label:' field, if present
1123 ** .dt %Y .dd `x-label' field, if present, and (1) not at part of a thread tree,
1124 ** (2) at the top of a thread, or (3) `x-label' is different from
1125 ** preceding message's `x-label'.
1126 ** .dt %Z .dd message status flags
1127 ** .dt %{fmt} .dd the date and time of the message is converted to sender's
1128 ** time zone, and ``fmt'' is expanded by the library function
1129 ** ``strftime''; a leading bang disables locales
1130 ** .dt %[fmt] .dd the date and time of the message is converted to the local
1131 ** time zone, and ``fmt'' is expanded by the library function
1132 ** ``strftime''; a leading bang disables locales
1133 ** .dt %(fmt) .dd the local date and time when the message was received.
1134 ** ``fmt'' is expanded by the library function ``strftime'';
1135 ** a leading bang disables locales
1136 ** .dt %<fmt> .dd the current local time. ``fmt'' is expanded by the library
1137 ** function ``strftime''; a leading bang disables locales.
1138 ** .dt %>X .dd right justify the rest of the string and pad with character "X"
1139 ** .dt %|X .dd pad to the end of the line with character "X"
1142 ** See also: ``$$to_chars''.
1145 {"nntp_inews", DT_PATH, R_NONE, UL &Inews, ""},
1148 ** Availability: NNTP
1151 ** If \fIset\fP, specifies the program and arguments used to deliver news posted
1152 ** by Madmutt. Otherwise, Madmutt posts article using current connection.
1153 ** The following \fTprintf(3)\fP-style sequence is understood:
1156 ** %s newsserver name
1159 ** Example: \fTset inews="/usr/local/bin/inews -hS"\fP
1162 {"ispell", DT_PATH, R_NONE, UL &Ispell, ISPELL},
1165 ** How to invoke ispell (GNU's spell-checking software).
1167 {"keep_flagged", DT_BOOL, R_NONE, OPTKEEPFLAGGED, "no" },
1170 ** If \fIset\fP, read messages marked as flagged will not be moved
1171 ** from your spool mailbox to your ``$$mbox'' mailbox, or as a result of
1172 ** a ``$mbox-hook'' command.
1174 {"locale", DT_STR, R_BOTH, UL &Locale, "C"},
1177 ** The locale used by \fTstrftime(3)\fP to format dates. Legal values are
1178 ** the strings your system accepts for the locale variable \fTLC_TIME\fP.
1180 {"force_list_reply", DT_QUAD, R_NONE, OPT_LISTREPLY, "ask-no" },
1183 ** This variable controls what effect ordinary replies have on mailing list
1184 ** messages: if \fIset\fP, a normal reply will be interpreted as list-reply
1185 ** while if it's \fIunset\fP the reply functions work as usual.
1187 {"max_display_recips", DT_NUM, R_PAGER, UL &MaxDispRecips, "0" },
1190 ** When set non-zero, this specifies the maximum number of recipient header
1191 ** lines (\fTTo:\fP, \fTCc:\fP and \fTBcc:\fP) to display in the pager if header
1192 ** weeding is turned on. In case the number of lines exeeds its value, the
1193 ** last line will have 3 dots appended.
1195 {"max_line_length", DT_NUM, R_PAGER, UL &MaxLineLength, "0" },
1198 ** When \fIset\fP, the maximum line length for displaying ``format = flowed'' messages is limited
1199 ** to this length. A value of 0 (which is also the default) means that the
1200 ** maximum line length is determined by the terminal width and $$wrapmargin.
1202 {"mail_check", DT_NUM, R_NONE, UL &BuffyTimeout, "5" },
1205 ** This variable configures how often (in seconds) Madmutt should look for
1208 ** \fBNote:\fP This does not apply to IMAP mailboxes, see $$imap_mail_check.
1210 {"mailcap_path", DT_STR, R_NONE, UL &MailcapPath, "" },
1213 ** This variable specifies which files to consult when attempting to
1214 ** display MIME bodies not directly supported by Madmutt.
1216 {"mailcap_sanitize", DT_BOOL, R_NONE, OPTMAILCAPSANITIZE, "yes" },
1219 ** If \fIset\fP, Madmutt will restrict possible characters in mailcap \fT%\fP expandos
1220 ** to a well-defined set of safe characters. This is the safe setting,
1221 ** but we are not sure it doesn't break some more advanced MIME stuff.
1223 ** \fBDON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE
1227 {"header_cache", DT_PATH, R_NONE, UL &HeaderCache, "" },
1230 ** Availability: Header Cache
1233 ** The $$header_cache variable points to the header cache database.
1235 ** If $$header_cache points to a directory it will contain a header cache
1236 ** database per folder. If $$header_cache points to a file that file will
1237 ** be a single global header cache. By default it is \fIunset\fP so no
1238 ** header caching will be used.
1240 {"maildir_header_cache_verify", DT_BOOL, R_NONE, OPTHCACHEVERIFY, "yes" },
1243 ** Availability: Header Cache
1246 ** Check for Maildir unaware programs other than Madmutt having modified maildir
1247 ** files when the header cache is in use. This incurs one \fTstat(2)\fP per
1248 ** message every time the folder is opened.
1250 #if defined(HAVE_GDBM) || defined(HAVE_DB4)
1251 {"header_cache_pagesize", DT_STR, R_NONE, UL &HeaderCachePageSize, "16384"},
1254 ** Availability: Header Cache
1257 ** Change the maildir header cache database page size.
1260 ** or too small of a page size for the common header can waste
1261 ** space, memory effectiveness, or CPU time. The default should be more or
1262 ** less the best you can get. For details google for mutt header
1263 ** cache (first hit).
1265 #endif /* HAVE_GDBM || HAVE_DB 4 */
1267 { "header_cache_compress", DT_BOOL, R_NONE, OPTHCACHECOMPRESS, "no" },
1270 ** If enabled the header cache will be compressed. So only one fifth of the usual
1271 ** diskspace is used, but the uncompression can result in a slower open of the
1274 #endif /* HAVE_QDBM */
1275 #endif /* USE_HCACHE */
1276 {"maildir_trash", DT_BOOL, R_NONE, OPTMAILDIRTRASH, "no" },
1279 ** If \fIset\fP, messages marked as deleted will be saved with the maildir
1280 ** (T)rashed flag instead of physically deleted.
1282 ** \fBNOTE:\fP this only applies
1283 ** to maildir-style mailboxes. Setting it will have no effect on other
1286 ** It is similiar to the trash option.
1288 {"mark_old", DT_BOOL, R_BOTH, OPTMARKOLD, "yes" },
1291 ** Controls whether or not Madmutt marks \fInew\fP \fBunread\fP
1292 ** messages as \fIold\fP if you exit a mailbox without reading them.
1294 ** With this option \fIset\fP, the next time you start Madmutt, the messages
1295 ** will show up with an "O" next to them in the ``index'' menu,
1296 ** indicating that they are old.
1298 {"markers", DT_BOOL, R_PAGER, OPTMARKERS, "yes" },
1301 ** Controls the display of wrapped lines in the internal pager. If set, a
1302 ** ``\fT+\fP'' marker is displayed at the beginning of wrapped lines. Also see
1303 ** the ``$$smart_wrap'' variable.
1305 {"mask", DT_RX, R_NONE, UL &Mask, "!^\\.[^.]"},
1308 ** A regular expression used in the file browser, optionally preceded by
1309 ** the \fInot\fP operator ``\fT!\fP''. Only files whose names match this mask
1310 ** will be shown. The match is always case-sensitive.
1312 {"mbox", DT_PATH, R_BOTH, UL &Inbox, "~/mbox"},
1315 ** This specifies the folder into which read mail in your ``$$spoolfile''
1316 ** folder will be appended.
1318 {"operating_system", DT_STR, R_NONE, UL &OperatingSystem, "" },
1321 ** This specifies the operating system name for the \fTUser-Agent:\fP header field. If
1322 ** this is \fIunset\fP, it will be set to the operating system name that \fTuname(2)\fP
1323 ** returns. If \fTuname(2)\fP fails, ``UNIX'' will be used.
1325 ** It may, for example, look as: ``\fTMadmutt 1.5.9i (Linux)\fP''.
1327 {"sidebar_boundary", DT_STR, R_BOTH, UL &SidebarBoundary, "." },
1330 ** When the sidebar is displayed and $$sidebar_shorten_hierarchy is \fIset\fP, this
1331 ** variable specifies the characters at which to split a folder name into
1332 ** ``hierarchy items.''
1334 {"sidebar_delim", DT_STR, R_BOTH, UL &SidebarDelim, "|"},
1337 ** This specifies the delimiter between the sidebar (if visible) and
1340 {"sidebar_visible", DT_BOOL, R_BOTH, OPTMBOXPANE, "no" },
1343 ** This specifies whether or not to show the sidebar (a list of folders specified
1344 ** with the ``mailboxes'' command).
1346 {"sidebar_width", DT_NUM, R_BOTH, UL &SidebarWidth, "0" },
1349 ** The width of the sidebar.
1351 {"sidebar_newmail_only", DT_BOOL, R_BOTH, OPTSIDEBARNEWMAILONLY, "no" },
1354 ** If \fIset\fP, only folders with new mail will be shown in the sidebar.
1356 {"sidebar_number_format", DT_STR, R_BOTH, UL &SidebarNumberFormat, "%m%?n?(%n)?%?f?[%f]?"},
1359 ** This variable controls how message counts are printed when the sidebar
1360 ** is enabled. If this variable is \fIempty\fP (\fIand only if\fP), no numbers
1361 ** will be printed \fIand\fP Madmutt won't frequently count mail (which
1362 ** may be a great speedup esp. with mbox-style mailboxes.)
1364 ** The following \fTprintf(3)\fP-like sequences are supported all of which
1365 ** may be printed non-zero:
1368 ** .dt %d .dd Number of deleted messages. 1)
1369 ** .dt %F .dd Number of flagged messages.
1370 ** .dt %m .dd Total number of messages.
1371 ** .dt %M .dd Total number of messages shown, i.e. not hidden by a limit. 1)
1372 ** .dt %n .dd Number of new messages.
1373 ** .dt %t .dd Number of tagged messages. 1)
1374 ** .dt %u .dd Number of unread messages.
1377 ** 1) These expandos only have a non-zero value for the current mailbox and
1378 ** will always be zero otherwise.
1380 {"sidebar_shorten_hierarchy", DT_BOOL, R_NONE, OPTSHORTENHIERARCHY, "no" },
1383 ** When \fIset\fP, the ``hierarchy'' of the sidebar entries will be shortened
1384 ** only if they cannot be printed in full length (because ``$$sidebar_width''
1385 ** is set to a too low value). For example, if the newsgroup name
1386 ** ``de.alt.sysadmin.recovery'' doesn't fit on the screen, it'll get shortened
1387 ** ``d.a.s.recovery'' while ``de.alt.d0'' still would and thus will not get
1390 ** At which characters this compression is done is controled via the
1391 ** $$sidebar_boundary variable.
1393 {"mbox_type", DT_MAGIC, R_NONE, UL &DefaultMagic, "mbox" },
1396 ** The default mailbox type used when creating new folders. May be any of
1397 ** \fTmbox\fP, \fTMMDF\fP, \fTMH\fP and \fTMaildir\fP.
1399 {"metoo", DT_BOOL, R_NONE, OPTMETOO, "no" },
1402 ** If \fIunset\fP, Madmutt will remove your address (see the ``alternates''
1403 ** command) from the list of recipients when replying to a message.
1405 {"menu_context", DT_NUM, R_NONE, UL &MenuContext, "0" },
1408 ** This variable controls the number of lines of context that are given
1409 ** when scrolling through menus. (Similar to ``$$pager_context''.)
1411 {"menu_move_off", DT_BOOL, R_NONE, OPTMENUMOVEOFF, "yes" },
1414 ** When \fIunset\fP, the bottom entry of menus will never scroll up past
1415 ** the bottom of the screen, unless there are less entries than lines.
1416 ** When \fIset\fP, the bottom entry may move off the bottom.
1418 {"menu_scroll", DT_BOOL, R_NONE, OPTMENUSCROLL, "no" },
1421 ** When \fIset\fP, menus will be scrolled up or down one line when you
1422 ** attempt to move across a screen boundary. If \fIunset\fP, the screen
1423 ** is cleared and the next or previous page of the menu is displayed
1424 ** (useful for slow links to avoid many redraws).
1426 {"meta_key", DT_BOOL, R_NONE, OPTMETAKEY, "no" },
1429 ** If \fIset\fP, forces Madmutt to interpret keystrokes with the high bit (bit 8)
1430 ** set as if the user had pressed the \fTESC\fP key and whatever key remains
1431 ** after having the high bit removed. For example, if the key pressed
1432 ** has an ASCII value of \fT0xf8\fP, then this is treated as if the user had
1433 ** pressed \fTESC\fP then ``\fTx\fP''. This is because the result of removing the
1434 ** high bit from ``\fT0xf8\fP'' is ``\fT0x78\fP'', which is the ASCII character
1437 {"mh_purge", DT_BOOL, R_NONE, OPTMHPURGE, "no" },
1440 ** When \fIunset\fP, Madmutt will mimic mh's behaviour and rename deleted messages
1441 ** to \fI,<old file name>\fP in mh folders instead of really deleting
1442 ** them. If the variable is set, the message files will simply be
1445 {"mh_seq_flagged", DT_STR, R_NONE, UL &MhFlagged, "flagged"},
1448 ** The name of the MH sequence used for flagged messages.
1450 {"mh_seq_replied", DT_STR, R_NONE, UL &MhReplied, "replied"},
1453 ** The name of the MH sequence used to tag replied messages.
1455 {"mh_seq_unseen", DT_STR, R_NONE, UL &MhUnseen, "unseen"},
1458 ** The name of the MH sequence used for unseen messages.
1460 {"mime_forward", DT_QUAD, R_NONE, OPT_MIMEFWD, "no" },
1463 ** When \fIset\fP, the message you are forwarding will be attached as a
1464 ** separate MIME part instead of included in the main body of the
1467 ** This is useful for forwarding MIME messages so the receiver
1468 ** can properly view the message as it was delivered to you. If you like
1469 ** to switch between MIME and not MIME from mail to mail, set this
1470 ** variable to ask-no or ask-yes.
1472 ** Also see ``$$forward_decode'' and ``$$mime_forward_decode''.
1474 {"mime_forward_decode", DT_BOOL, R_NONE, OPTMIMEFORWDECODE, "no" },
1477 ** Controls the decoding of complex MIME messages into \fTtext/plain\fP when
1478 ** forwarding a message while ``$$mime_forward'' is \fIset\fP. Otherwise
1479 ** ``$$forward_decode'' is used instead.
1481 {"mime_forward_rest", DT_QUAD, R_NONE, OPT_MIMEFWDREST, "yes" },
1484 ** When forwarding multiple attachments of a MIME message from the recvattach
1485 ** menu, attachments which cannot be decoded in a reasonable manner will
1486 ** be attached to the newly composed message if this option is set.
1489 {"nntp_mime_subject", DT_BOOL, R_NONE, OPTMIMESUBJECT, "yes" },
1492 ** Availability: NNTP
1495 ** If \fIunset\fP, an 8-bit ``\fTSubject:\fP'' header field in a news article
1496 ** will not be encoded according to RFC2047.
1498 ** \fBNote:\fP Only change this setting if you know what you are doing.
1501 {"mix_entry_format", DT_STR, R_NONE, UL &MixEntryFormat, "%4n %c %-16s %a"},
1504 ** This variable describes the format of a remailer line on the mixmaster
1505 ** chain selection screen. The following \fTprintf(3)\fP-like sequences are
1509 ** .dt %n .dd The running number on the menu.
1510 ** .dt %c .dd Remailer capabilities.
1511 ** .dt %s .dd The remailer's short name.
1512 ** .dt %a .dd The remailer's e-mail address.
1515 {"mixmaster", DT_PATH, R_NONE, UL &Mixmaster, MIXMASTER},
1518 ** This variable contains the path to the Mixmaster binary on your
1519 ** system. It is used with various sets of parameters to gather the
1520 ** list of known remailers, and to finally send a message through the
1523 {"move", DT_QUAD, R_NONE, OPT_MOVE, "ask-no" },
1526 ** Controls whether or not Madmutt will move read messages
1527 ** from your spool mailbox to your ``$$mbox'' mailbox, or as a result of
1528 ** a ``$mbox-hook'' command.
1530 {"message_format", DT_STR, R_NONE, UL &MsgFmt, "%s"},
1533 ** This is the string displayed in the ``attachment'' menu for
1534 ** attachments of type \fTmessage/rfc822\fP. For a full listing of defined
1535 ** \fTprintf(3)\fP-like sequences see the section on ``$$index_format''.
1537 {"msgid_format", DT_STR, R_NONE, UL &MsgIdFormat, "%Y%m%d%h%M%s.G%P%p"},
1540 ** This is the format for the ``local part'' of the \fTMessage-ID:\fP header
1541 ** field generated by Madmutt. If this variable is empty, no \fTMessage-ID:\fP
1542 ** headers will be generated. The '%'
1543 ** character marks that certain data will be added to the string, similar to
1544 ** \fTprintf(3)\fP. The following characters are allowed:
1547 ** .dt %d .dd the current day of month
1548 ** .dt %h .dd the current hour
1549 ** .dt %m .dd the current month
1550 ** .dt %M .dd the current minute
1551 ** .dt %O .dd the current UNIX timestamp (octal)
1552 ** .dt %p .dd the process ID
1553 ** .dt %P .dd the current Message-ID prefix (a character rotating with
1554 ** every Message-ID being generated)
1555 ** .dt %r .dd a random integer value (decimal)
1556 ** .dt %R .dd a random integer value (hexadecimal)
1557 ** .dt %s .dd the current second
1558 ** .dt %T .dd the current UNIX timestamp (decimal)
1559 ** .dt %X .dd the current UNIX timestamp (hexadecimal)
1560 ** .dt %Y .dd the current year (Y2K compliant)
1561 ** .dt %% .dd the '%' character
1564 ** \fBNote:\fP Please only change this setting if you know what you are doing.
1565 ** Also make sure to consult RFC2822 to produce technically \fIvalid\fP strings.
1567 {"narrow_tree", DT_BOOL, R_TREE|R_INDEX, OPTNARROWTREE, "no" },
1570 ** This variable, when \fIset\fP, makes the thread tree narrower, allowing
1571 ** deeper threads to fit on the screen.
1574 {"nntp_cache_dir", DT_PATH, R_NONE, UL &NewsCacheDir, "~/.madmutt"},
1577 ** Availability: NNTP
1580 ** This variable points to directory where Madmutt will cache news
1581 ** article headers. If \fIunset\fP, headers will not be saved at all
1582 ** and will be reloaded each time when you enter a newsgroup.
1584 ** As for the header caching in connection with IMAP and/or Maildir,
1585 ** this drastically increases speed and lowers traffic.
1587 {"nntp_host", DT_STR, R_NONE, UL &NewsServer, "" },
1590 ** Availability: NNTP
1593 ** This variable specifies the name (or address) of the NNTP server to be used.
1596 ** defaults to the value specified via the environment variable
1597 ** \fT$$$NNTPSERVER\fP or contained in the file \fT/etc/nntpserver\fP.
1600 ** specify a username and an alternative port for each newsserver, e.g.
1602 ** \fT[nntp[s]://][username[:password]@]newsserver[:port]\fP
1604 ** \fBNote:\fP Using a password as shown and stored in a configuration file
1605 ** presents a security risk since the superuser of your machine may read it
1606 ** regardless of the file's permissions.
1608 {"nntp_newsrc", DT_PATH, R_NONE, UL &NewsRc, "~/.newsrc"},
1611 ** Availability: NNTP
1614 ** This file contains information about subscribed newsgroup and
1615 ** articles read so far.
1617 ** To ease the use of multiple news servers, the following \fTprintf(3)\fP-style
1618 ** sequence is understood:
1621 ** %s newsserver name
1624 {"nntp_context", DT_NUM, R_NONE, UL &NntpContext, "1000" },
1627 ** Availability: NNTP
1630 ** This variable controls how many news articles to cache per newsgroup
1631 ** (if caching is enabled, see $$nntp_cache_dir) and how many news articles
1632 ** to show in the ``index'' menu.
1634 ** If there're more articles than defined with $$nntp_context, all older ones
1635 ** will be removed/not shown in the index.
1637 {"nntp_load_description", DT_BOOL, R_NONE, OPTLOADDESC, "yes" },
1640 ** Availability: NNTP
1643 ** This variable controls whether or not descriptions for newsgroups
1644 ** are to be loaded when subscribing to a newsgroup.
1646 {"nntp_user", DT_STR, R_NONE, UL &NntpUser, ""},
1649 ** Availability: NNTP
1652 ** Your login name on the NNTP server. If \fIunset\fP and the server requires
1653 ** authentification, Madmutt will prompt you for your account name.
1655 {"nntp_pass", DT_STR, R_NONE, UL &NntpPass, ""},
1658 ** Availability: NNTP
1661 ** Your password for NNTP account.
1663 ** \fBNote:\fP Storing passwords in a configuration file
1664 ** presents a security risk since the superuser of your machine may read it
1665 ** regardless of the file's permissions.
1667 {"nntp_mail_check", DT_NUM, R_NONE, UL &NewsPollTimeout, "60" },
1670 ** Availability: NNTP
1673 ** The time in seconds until any operations on a newsgroup except posting a new
1674 ** article will cause a recheck for new news. If set to 0, Madmutt will
1675 ** recheck on each operation in index (stepping, read article, etc.).
1677 {"nntp_reconnect", DT_QUAD, R_NONE, OPT_NNTPRECONNECT, "ask-yes" },
1680 ** Availability: NNTP
1683 ** Controls whether or not Madmutt will try to reconnect to a newsserver when the
1684 ** was connection lost.
1687 { "net_inc", DT_NUM, R_NONE, UL &NetInc, "10" },
1690 ** Operations that expect to transfer a large amount of data over the
1691 ** network will update their progress every \fInet_inc\fP kilobytes.
1692 ** If set to 0, no progress messages will be displayed.
1694 ** See also ``$$read_inc'' and ``$$write_inc''.
1696 {"pager", DT_PATH, R_NONE, UL &Pager, "builtin"},
1699 ** This variable specifies which pager you would like to use to view
1700 ** messages. ``builtin'' means to use the builtin pager, otherwise this
1701 ** variable should specify the pathname of the external pager you would
1704 ** Using an external pager may have some disadvantages: Additional
1705 ** keystrokes are necessary because you can't call Madmutt functions
1706 ** directly from the pager, and screen resizes cause lines longer than
1707 ** the screen width to be badly formatted in the help menu.
1709 {"pager_context", DT_NUM, R_NONE, UL &PagerContext, "0" },
1712 ** This variable controls the number of lines of context that are given
1713 ** when displaying the next or previous page in the internal pager. By
1714 ** default, Madmutt will display the line after the last one on the screen
1715 ** at the top of the next page (0 lines of context).
1717 {"pager_format", DT_STR, R_PAGER, UL &PagerFmt, "-%Z- %C/%m: %-20.20n %s"},
1720 ** This variable controls the format of the one-line message ``status''
1721 ** displayed before each message in either the internal or an external
1722 ** pager. The valid sequences are listed in the ``$$index_format''
1725 {"pager_index_lines", DT_NUM, R_PAGER, UL &PagerIndexLines, "0" },
1728 ** Determines the number of lines of a mini-index which is shown when in
1729 ** the pager. The current message, unless near the top or bottom of the
1730 ** folder, will be roughly one third of the way down this mini-index,
1731 ** giving the reader the context of a few messages before and after the
1732 ** message. This is useful, for example, to determine how many messages
1733 ** remain to be read in the current thread. One of the lines is reserved
1734 ** for the status bar from the index, so a \fIpager_index_lines\fP of 6
1735 ** will only show 5 lines of the actual index. A value of 0 results in
1736 ** no index being shown. If the number of messages in the current folder
1737 ** is less than \fIpager_index_lines\fP, then the index will only use as
1738 ** many lines as it needs.
1740 {"pager_stop", DT_BOOL, R_NONE, OPTPAGERSTOP, "no" },
1743 ** When \fIset\fP, the internal-pager will \fBnot\fP move to the next message
1744 ** when you are at the end of a message and invoke the \fInext-page\fP
1747 {"crypt_autosign", DT_BOOL, R_NONE, OPTCRYPTAUTOSIGN, "no" },
1750 ** Setting this variable will cause Madmutt to always attempt to
1751 ** cryptographically sign outgoing messages. This can be overridden
1752 ** by use of the \fIpgp-menu\fP, when signing is not required or
1753 ** encryption is requested as well. If ``$$smime_is_default'' is \fIset\fP,
1754 ** then OpenSSL is used instead to create S/MIME messages and settings can
1755 ** be overridden by use of the \fIsmime-menu\fP.
1758 {"crypt_autoencrypt", DT_BOOL, R_NONE, OPTCRYPTAUTOENCRYPT, "no" },
1761 ** Setting this variable will cause Madmutt to always attempt to PGP
1762 ** encrypt outgoing messages. This is probably only useful in
1763 ** connection to the \fIsend-hook\fP command. It can be overridden
1764 ** by use of the \fIpgp-menu\fP, when encryption is not required or
1765 ** signing is requested as well. If ``$$smime_is_default'' is \fIset\fP,
1766 ** then OpenSSL is used instead to create S/MIME messages and
1767 ** settings can be overridden by use of the \fIsmime-menu\fP.
1770 {"pgp_ignore_subkeys", DT_BOOL, R_NONE, OPTPGPIGNORESUB, "yes" },
1773 ** Setting this variable will cause Madmutt to ignore OpenPGP subkeys. Instead,
1774 ** the principal key will inherit the subkeys' capabilities. \fIUnset\fP this
1775 ** if you want to play interesting key selection games.
1778 {"crypt_replyencrypt", DT_BOOL, R_NONE, OPTCRYPTREPLYENCRYPT, "yes" },
1781 ** If \fIset\fP, automatically PGP or OpenSSL encrypt replies to messages which are
1785 {"crypt_replysign", DT_BOOL, R_NONE, OPTCRYPTREPLYSIGN, "no" },
1788 ** If \fIset\fP, automatically PGP or OpenSSL sign replies to messages which are
1791 ** \fBNote:\fP this does not work on messages that are encrypted \fBand\fP signed!
1794 {"crypt_replysignencrypted", DT_BOOL, R_NONE, OPTCRYPTREPLYSIGNENCRYPTED, "no" },
1797 ** If \fIset\fP, automatically PGP or OpenSSL sign replies to messages
1798 ** which are encrypted. This makes sense in combination with
1799 ** ``$$crypt_replyencrypt'', because it allows you to sign all
1800 ** messages which are automatically encrypted. This works around
1801 ** the problem noted in ``$$crypt_replysign'', that Madmutt is not able
1802 ** to find out whether an encrypted message is also signed.
1805 {"crypt_timestamp", DT_BOOL, R_NONE, OPTCRYPTTIMESTAMP, "yes" },
1808 ** If \fIset\fP, Madmutt will include a time stamp in the lines surrounding
1809 ** PGP or S/MIME output, so spoofing such lines is more difficult.
1810 ** If you are using colors to mark these lines, and rely on these,
1811 ** you may \fIunset\fP this setting.
1814 {"pgp_use_gpg_agent", DT_BOOL, R_NONE, OPTUSEGPGAGENT, "no" },
1817 ** If \fIset\fP, Madmutt will use a possibly-running gpg-agent process.
1820 {"crypt_verify_sig", DT_QUAD, R_NONE, OPT_VERIFYSIG, "yes" },
1823 ** If ``\fIyes\fP'', always attempt to verify PGP or S/MIME signatures.
1824 ** If ``\fIask\fP'', ask whether or not to verify the signature.
1825 ** If ``\fIno\fP'', never attempt to verify cryptographic signatures.
1828 {"smime_is_default", DT_BOOL, R_NONE, OPTSMIMEISDEFAULT, "no" },
1831 ** The default behaviour of Madmutt is to use PGP on all auto-sign/encryption
1832 ** operations. To override and to use OpenSSL instead this must be \fIset\fP.
1834 ** However, this has no effect while replying, since Madmutt will automatically
1835 ** select the same application that was used to sign/encrypt the original
1838 ** (Note that this variable can be overridden by unsetting $$crypt_autosmime.)
1841 {"smime_ask_cert_label", DT_BOOL, R_NONE, OPTASKCERTLABEL, "yes" },
1844 ** This flag controls whether you want to be asked to enter a label
1845 ** for a certificate about to be added to the database or not. It is
1846 ** \fIset\fP by default.
1849 {"smime_decrypt_use_default_key", DT_BOOL, R_NONE, OPTSDEFAULTDECRYPTKEY, "yes" },
1852 ** If \fIset\fP (default) this tells Madmutt to use the default key for decryption. Otherwise,
1853 ** if manage multiple certificate-key-pairs, Madmutt will try to use the mailbox-address
1854 ** to determine the key to use. It will ask you to supply a key, if it can't find one.
1857 {"pgp_entry_format", DT_STR, R_NONE, UL &PgpEntryFormat, "%4n %t%f %4l/0x%k %-4a %2c %u"},
1860 ** This variable allows you to customize the PGP key selection menu to
1861 ** your personal taste. This string is similar to ``$$index_format'', but
1862 ** has its own set of \fTprintf(3)\fP-like sequences:
1865 ** .dt %n .dd number
1866 ** .dt %k .dd key id
1867 ** .dt %u .dd user id
1868 ** .dt %a .dd algorithm
1869 ** .dt %l .dd key length
1871 ** .dt %c .dd capabilities
1872 ** .dt %t .dd trust/validity of the key-uid association
1873 ** .dt %[<s>] .dd date of the key where <s> is an \fTstrftime(3)\fP expression
1878 {"pgp_good_sign", DT_RX, R_NONE, UL &PgpGoodSign, "" },
1881 ** If you assign a text to this variable, then a PGP signature is only
1882 ** considered verified if the output from $$pgp_verify_command contains
1883 ** the text. Use this variable if the exit code from the command is 0
1884 ** even for bad signatures.
1887 {"pgp_check_exit", DT_BOOL, R_NONE, OPTPGPCHECKEXIT, "yes" },
1890 ** If \fIset\fP, Madmutt will check the exit code of the PGP subprocess when
1891 ** signing or encrypting. A non-zero exit code means that the
1892 ** subprocess failed.
1895 {"pgp_long_ids", DT_BOOL, R_NONE, OPTPGPLONGIDS, "no" },
1898 ** If \fIset\fP, use 64 bit PGP key IDs. \fIUnset\fP uses the normal 32 bit Key IDs.
1901 {"pgp_retainable_sigs", DT_BOOL, R_NONE, OPTPGPRETAINABLESIG, "no" },
1904 ** If \fIset\fP, signed and encrypted messages will consist of nested
1905 ** multipart/signed and multipart/encrypted body parts.
1907 ** This is useful for applications like encrypted and signed mailing
1908 ** lists, where the outer layer (multipart/encrypted) can be easily
1909 ** removed, while the inner multipart/signed part is retained.
1912 {"pgp_autoinline", DT_BOOL, R_NONE, OPTPGPAUTOINLINE, "no" },
1915 ** This option controls whether Madmutt generates old-style inline
1916 ** (traditional) PGP encrypted or signed messages under certain
1917 ** circumstances. This can be overridden by use of the \fIpgp-menu\fP,
1918 ** when inline is not required.
1920 ** Note that Madmutt might automatically use PGP/MIME for messages
1921 ** which consist of more than a single MIME part. Madmutt can be
1922 ** configured to ask before sending PGP/MIME messages when inline
1923 ** (traditional) would not work.
1924 ** See also: ``$$pgp_mime_auto''.
1926 ** Also note that using the old-style PGP message format is \fBstrongly\fP
1927 ** \fBdeprecated\fP.
1930 {"pgp_replyinline", DT_BOOL, R_NONE, OPTPGPREPLYINLINE, "no" },
1933 ** Setting this variable will cause Madmutt to always attempt to
1934 ** create an inline (traditional) message when replying to a
1935 ** message which is PGP encrypted/signed inline. This can be
1936 ** overridden by use of the \fIpgp-menu\fP, when inline is not
1937 ** required. This option does not automatically detect if the
1938 ** (replied-to) message is inline; instead it relies on Madmutt
1939 ** internals for previously checked/flagged messages.
1941 ** Note that Madmutt might automatically use PGP/MIME for messages
1942 ** which consist of more than a single MIME part. Madmutt can be
1943 ** configured to ask before sending PGP/MIME messages when inline
1944 ** (traditional) would not work.
1945 ** See also: ``$$pgp_mime_auto''.
1947 ** Also note that using the old-style PGP message format is \fBstrongly\fP
1948 ** \fBdeprecated\fP.
1952 {"pgp_show_unusable", DT_BOOL, R_NONE, OPTPGPSHOWUNUSABLE, "yes" },
1955 ** If \fIset\fP, Madmutt will display non-usable keys on the PGP key selection
1956 ** menu. This includes keys which have been revoked, have expired, or
1957 ** have been marked as ``disabled'' by the user.
1960 {"pgp_sign_as", DT_STR, R_NONE, UL &PgpSignAs, "" },
1963 ** If you have more than one key pair, this option allows you to specify
1964 ** which of your private keys to use. It is recommended that you use the
1965 ** keyid form to specify your key (e.g., ``\fT0x00112233\fP'').
1968 {"pgp_strict_enc", DT_BOOL, R_NONE, OPTPGPSTRICTENC, "yes" },
1971 ** If \fIset\fP, Madmutt will automatically encode PGP/MIME signed messages as
1972 ** \fTquoted-printable\fP. Please note that unsetting this variable may
1973 ** lead to problems with non-verifyable PGP signatures, so only change
1974 ** this if you know what you are doing.
1977 {"pgp_timeout", DT_NUM, R_NONE, UL &PgpTimeout, "300" },
1980 ** The number of seconds after which a cached passphrase will expire if
1981 ** not used. Default: 300.
1984 {"pgp_sort_keys", DT_SORT|DT_SORT_KEYS, R_NONE, UL &PgpSortKeys, "address" },
1987 ** Specifies how the entries in the ``pgp keys'' menu are sorted. The
1988 ** following are legal values:
1991 ** .dt address .dd sort alphabetically by user id
1992 ** .dt keyid .dd sort alphabetically by key id
1993 ** .dt date .dd sort by key creation date
1994 ** .dt trust .dd sort by the trust of the key
1997 ** If you prefer reverse order of the above values, prefix it with
2001 {"pgp_mime_auto", DT_QUAD, R_NONE, OPT_PGPMIMEAUTO, "ask-yes" },
2004 ** This option controls whether Madmutt will prompt you for
2005 ** automatically sending a (signed/encrypted) message using
2006 ** PGP/MIME when inline (traditional) fails (for any reason).
2008 ** Also note that using the old-style PGP message format is \fBstrongly\fP
2009 ** \fBdeprecated\fP.
2012 {"pgp_auto_decode", DT_BOOL, R_NONE, OPTPGPAUTODEC, "no" },
2015 ** If \fIset\fP, Madmutt will automatically attempt to decrypt traditional PGP
2016 ** messages whenever the user performs an operation which ordinarily would
2017 ** result in the contents of the message being operated on. For example,
2018 ** if the user displays a pgp-traditional message which has not been manually
2019 ** checked with the check-traditional-pgp function, Madmutt will automatically
2020 ** check the message for traditional pgp.
2022 /* XXX Default values! */
2023 {"pgp_decode_command", DT_STR, R_NONE, UL &PgpDecodeCommand, "" },
2026 ** This format strings specifies a command which is used to decode
2027 ** application/pgp attachments.
2029 ** The PGP command formats have their own set of \fTprintf(3)\fP-like sequences:
2032 ** .dt %p .dd Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty
2033 ** string otherwise. Note: This may be used with a %? construct.
2034 ** .dt %f .dd Expands to the name of a file containing a message.
2035 ** .dt %s .dd Expands to the name of a file containing the signature part
2036 ** . of a multipart/signed attachment when verifying it.
2037 ** .dt %a .dd The value of $$pgp_sign_as.
2038 ** .dt %r .dd One or more key IDs.
2041 ** For examples on how to configure these formats for the various versions
2042 ** of PGP which are floating around, see the pgp*.rc and gpg.rc files in
2043 ** the \fTsamples/\fP subdirectory which has been installed on your system
2044 ** alongside the documentation.
2047 {"pgp_getkeys_command", DT_STR, R_NONE, UL &PgpGetkeysCommand, "" },
2050 ** This command is invoked whenever Madmutt will need public key information.
2051 ** \fT%r\fP is the only \fTprintf(3)\fP-like sequence used with this format.
2054 {"pgp_verify_command", DT_STR, R_NONE, UL &PgpVerifyCommand, "" },
2057 ** This command is used to verify PGP signatures.
2060 {"pgp_decrypt_command", DT_STR, R_NONE, UL &PgpDecryptCommand, "" },
2063 ** This command is used to decrypt a PGP encrypted message.
2066 {"pgp_clearsign_command", DT_STR, R_NONE, UL &PgpClearSignCommand, "" },
2069 ** This format is used to create a old-style ``clearsigned'' PGP message.
2071 ** Note that the use of this format is \fBstrongly\fP \fBdeprecated\fP.
2074 {"pgp_sign_command", DT_STR, R_NONE, UL &PgpSignCommand, "" },
2077 ** This command is used to create the detached PGP signature for a
2078 ** multipart/signed PGP/MIME body part.
2081 {"pgp_encrypt_sign_command", DT_STR, R_NONE, UL &PgpEncryptSignCommand, "" },
2084 ** This command is used to both sign and encrypt a body part.
2087 {"pgp_encrypt_only_command", DT_STR, R_NONE, UL &PgpEncryptOnlyCommand, "" },
2090 ** This command is used to encrypt a body part without signing it.
2093 {"pgp_import_command", DT_STR, R_NONE, UL &PgpImportCommand, "" },
2096 ** This command is used to import a key from a message into
2097 ** the user's public key ring.
2100 {"pgp_export_command", DT_STR, R_NONE, UL &PgpExportCommand, "" },
2103 ** This command is used to export a public key from the user's
2107 {"pgp_verify_key_command", DT_STR, R_NONE, UL &PgpVerifyKeyCommand, "" },
2110 ** This command is used to verify key information from the key selection
2114 {"pgp_list_secring_command", DT_STR, R_NONE, UL &PgpListSecringCommand, "" },
2117 ** This command is used to list the secret key ring's contents. The
2118 ** output format must be analogous to the one used by
2119 ** \fTgpg --list-keys --with-colons\fP.
2121 ** This format is also generated by the \fTpgpring\fP utility which comes
2125 {"pgp_list_pubring_command", DT_STR, R_NONE, UL &PgpListPubringCommand, "" },
2128 ** This command is used to list the public key ring's contents. The
2129 ** output format must be analogous to the one used by
2130 ** \fTgpg --list-keys --with-colons\fP.
2132 ** This format is also generated by the \fTpgpring\fP utility which comes
2136 {"forward_decrypt", DT_BOOL, R_NONE, OPTFORWDECRYPT, "yes" },
2139 ** Controls the handling of encrypted messages when forwarding a message.
2140 ** When \fIset\fP, the outer layer of encryption is stripped off. This
2141 ** variable is only used if ``$$mime_forward'' is \fIset\fP and
2142 ** ``$$mime_forward_decode'' is \fIunset\fP.
2145 {"smime_timeout", DT_NUM, R_NONE, UL &SmimeTimeout, "300" },
2148 ** The number of seconds after which a cached passphrase will expire if
2152 {"smime_encrypt_with", DT_STR, R_NONE, UL &SmimeCryptAlg, "" },
2155 ** This sets the algorithm that should be used for encryption.
2156 ** Valid choices are ``\fTdes\fP'', ``\fTdes3\fP'', ``\fTrc2-40\fP'',
2157 ** ``\fTrc2-64\fP'', ``\frc2-128\fP''.
2159 ** If \fIunset\fP ``\fI3des\fP'' (TripleDES) is used.
2162 {"smime_keys", DT_PATH, R_NONE, UL &SmimeKeys, "" },
2165 ** Since there is no pubring/secring as with PGP, Madmutt has to handle
2166 ** storage ad retrieval of keys/certs by itself. This is very basic right now,
2167 ** and stores keys and certificates in two different directories, both
2168 ** named as the hash-value retrieved from OpenSSL. There is an index file
2169 ** which contains mailbox-address keyid pair, and which can be manually
2170 ** edited. This one points to the location of the private keys.
2173 {"smime_ca_location", DT_PATH, R_NONE, UL &SmimeCALocation, "" },
2176 ** This variable contains the name of either a directory, or a file which
2177 ** contains trusted certificates for use with OpenSSL.
2180 {"smime_certificates", DT_PATH, R_NONE, UL &SmimeCertificates, "" },
2183 ** Since there is no pubring/secring as with PGP, Madmutt has to handle
2184 ** storage and retrieval of keys by itself. This is very basic right
2185 ** now, and keys and certificates are stored in two different
2186 ** directories, both named as the hash-value retrieved from
2187 ** OpenSSL. There is an index file which contains mailbox-address
2188 ** keyid pairs, and which can be manually edited. This one points to
2189 ** the location of the certificates.
2192 {"smime_decrypt_command", DT_STR, R_NONE, UL &SmimeDecryptCommand, "" },
2195 ** This format string specifies a command which is used to decrypt
2196 ** \fTapplication/x-pkcs7-mime\fP attachments.
2198 ** The OpenSSL command formats have their own set of \fTprintf(3)\fP-like sequences
2199 ** similar to PGP's:
2202 ** .dt %f .dd Expands to the name of a file containing a message.
2203 ** .dt %s .dd Expands to the name of a file containing the signature part
2204 ** . of a multipart/signed attachment when verifying it.
2205 ** .dt %k .dd The key-pair specified with $$smime_default_key
2206 ** .dt %c .dd One or more certificate IDs.
2207 ** .dt %a .dd The algorithm used for encryption.
2208 ** .dt %C .dd CA location: Depending on whether $$smime_ca_location
2209 ** . points to a directory or file, this expands to
2210 ** . "-CApath $$smime_ca_location" or "-CAfile $$smime_ca_location".
2213 ** For examples on how to configure these formats, see the smime.rc in
2214 ** the \fTsamples/\fP subdirectory which has been installed on your system
2215 ** alongside the documentation.
2218 {"smime_verify_command", DT_STR, R_NONE, UL &SmimeVerifyCommand, "" },
2221 ** This command is used to verify S/MIME signatures of type \fTmultipart/signed\fP.
2224 {"smime_verify_opaque_command", DT_STR, R_NONE, UL &SmimeVerifyOpaqueCommand, "" },
2227 ** This command is used to verify S/MIME signatures of type
2228 ** \fTapplication/x-pkcs7-mime\fP.
2231 {"smime_sign_command", DT_STR, R_NONE, UL &SmimeSignCommand, "" },
2234 ** This command is used to created S/MIME signatures of type
2235 ** \fTmultipart/signed\fP, which can be read by all mail clients.
2238 {"smime_sign_opaque_command", DT_STR, R_NONE, UL &SmimeSignOpaqueCommand, "" },
2241 ** This command is used to created S/MIME signatures of type
2242 ** \fTapplication/x-pkcs7-signature\fP, which can only be handled by mail
2243 ** clients supporting the S/MIME extension.
2246 {"smime_encrypt_command", DT_STR, R_NONE, UL &SmimeEncryptCommand, "" },
2249 ** This command is used to create encrypted S/MIME messages.
2252 {"smime_pk7out_command", DT_STR, R_NONE, UL &SmimePk7outCommand, "" },
2255 ** This command is used to extract PKCS7 structures of S/MIME signatures,
2256 ** in order to extract the public X509 certificate(s).
2259 {"smime_get_cert_command", DT_STR, R_NONE, UL &SmimeGetCertCommand, "" },
2262 ** This command is used to extract X509 certificates from a PKCS7 structure.
2265 {"smime_get_signer_cert_command", DT_STR, R_NONE, UL &SmimeGetSignerCertCommand, "" },
2268 ** This command is used to extract only the signers X509 certificate from a S/MIME
2269 ** signature, so that the certificate's owner may get compared to the
2270 ** email's ``\fTFrom:\fP'' header field.
2273 {"smime_import_cert_command", DT_STR, R_NONE, UL &SmimeImportCertCommand, "" },
2276 ** This command is used to import a certificate via \fTsmime_keysng\fP.
2279 {"smime_get_cert_email_command", DT_STR, R_NONE, UL &SmimeGetCertEmailCommand, "" },
2282 ** This command is used to extract the mail address(es) used for storing
2283 ** X509 certificates, and for verification purposes (to check whether the
2284 ** certificate was issued for the sender's mailbox).
2287 {"smime_default_key", DT_STR, R_NONE, UL &SmimeDefaultKey, "" },
2290 ** This is the default key-pair to use for signing. This must be set to the
2291 ** keyid (the hash-value that OpenSSL generates) to work properly
2294 #if defined(USE_LIBESMTP)
2295 {"smtp_auth_username", DT_SYN, R_NONE, UL "smtp_user", 0},
2296 {"smtp_user", DT_STR, R_NONE, UL &SmtpAuthUser, "" },
2299 ** Availability: SMTP
2302 ** Defines the username to use with SMTP AUTH. Setting this variable will
2303 ** cause Madmutt to attempt to use SMTP AUTH when sending.
2305 {"smtp_auth_password", DT_SYN, R_NONE, UL "smtp_pass", 0},
2306 {"smtp_pass", DT_STR, R_NONE, UL &SmtpAuthPass, "" },
2309 ** Availability: SMTP
2312 ** Defines the password to use with SMTP AUTH. If ``$$smtp_user''
2313 ** is set, but this variable is not, you will be prompted for a password
2316 ** \fBNote:\fP Storing passwords in a configuration file
2317 ** presents a security risk since the superuser of your machine may read it
2318 ** regardless of the file's permissions.
2320 {"smtp_envelope", DT_SYN, R_NONE, UL "envelope_from_address", 0 },
2321 {"smtp_host", DT_STR, R_NONE, UL &SmtpHost, "" },
2324 ** Availability: SMTP
2327 ** Defines the SMTP host which will be used to deliver mail, as opposed
2328 ** to invoking the sendmail binary. Setting this variable overrides the
2329 ** value of ``$$sendmail'', and any associated variables.
2331 {"smtp_port", DT_NUM, R_NONE, UL &SmtpPort, "25" },
2334 ** Availability: SMTP
2337 ** Defines the port that the SMTP host is listening on for mail delivery.
2338 ** Must be specified as a number.
2340 ** Defaults to 25, the standard SMTP port, but RFC 2476-compliant SMTP
2341 ** servers will probably desire 587, the mail submission port.
2343 {"smtp_use_tls", DT_STR, R_NONE, UL &SmtpUseTLS, "" },
2346 ** Availability: SMTP (and SSL)
2349 ** Defines wether to use STARTTLS. If this option is set to ``\fIrequired\fP''
2350 ** and the server does not support STARTTLS or there is an error in the
2351 ** TLS Handshake, the connection will fail. Setting this to ``\fIenabled\fP''
2352 ** will try to start TLS and continue without TLS in case of an error.
2355 ** Madmutt still needs to have SSL support enabled in order to use it.
2358 #if defined(USE_SSL) || defined(USE_GNUTLS)
2360 {"ssl_client_cert", DT_PATH, R_NONE, UL &SslClientCert, "" },
2363 ** Availability: SSL
2366 ** The file containing a client certificate and its associated private
2369 #endif /* USE_SSL */
2370 {"ssl_force_tls", DT_BOOL, R_NONE, OPTSSLFORCETLS, "no" },
2373 ** If this variable is \fIset\fP, Madmutt will require that all connections
2374 ** to remote servers be encrypted. Furthermore it will attempt to
2375 ** negotiate TLS even if the server does not advertise the capability,
2376 ** since it would otherwise have to abort the connection anyway. This
2377 ** option supersedes ``$$ssl_starttls''.
2379 {"ssl_starttls", DT_QUAD, R_NONE, OPT_SSLSTARTTLS, "yes" },
2382 ** Availability: SSL or GNUTLS
2385 ** If \fIset\fP (the default), Madmutt will attempt to use STARTTLS on servers
2386 ** advertising the capability. When \fIunset\fP, Madmutt will not attempt to
2387 ** use STARTTLS regardless of the server's capabilities.
2389 {"certificate_file", DT_PATH, R_NONE, UL &SslCertFile, "~/.mutt_certificates"},
2392 ** Availability: SSL or GNUTLS
2395 ** This variable specifies the file where the certificates you trust
2396 ** are saved. When an unknown certificate is encountered, you are asked
2397 ** if you accept it or not. If you accept it, the certificate can also
2398 ** be saved in this file and further connections are automatically
2401 ** You can also manually add CA certificates in this file. Any server
2402 ** certificate that is signed with one of these CA certificates are
2403 ** also automatically accepted.
2405 ** Example: \fTset certificate_file=~/.madmutt/certificates\fP
2407 # if defined(_MAKEDOC) || !defined (USE_GNUTLS)
2408 {"ssl_usesystemcerts", DT_BOOL, R_NONE, OPTSSLSYSTEMCERTS, "yes" },
2411 ** Availability: SSL
2414 ** If set to \fIyes\fP, Madmutt will use CA certificates in the
2415 ** system-wide certificate store when checking if server certificate
2416 ** is signed by a trusted CA.
2418 {"entropy_file", DT_PATH, R_NONE, UL &SslEntropyFile, "" },
2421 ** Availability: SSL
2424 ** The file which includes random data that is used to initialize SSL
2425 ** library functions.
2427 {"ssl_use_sslv2", DT_BOOL, R_NONE, OPTSSLV2, "no" },
2430 ** Availability: SSL
2433 ** This variables specifies whether to attempt to use SSLv2 in the
2434 ** SSL authentication process.
2436 # endif /* _MAKEDOC || !USE_GNUTLS */
2437 {"ssl_use_sslv3", DT_BOOL, R_NONE, OPTSSLV3, "yes" },
2440 ** Availability: SSL or GNUTLS
2443 ** This variables specifies whether to attempt to use SSLv3 in the
2444 ** SSL authentication process.
2446 {"ssl_use_tlsv1", DT_BOOL, R_NONE, OPTTLSV1, "yes" },
2449 ** Availability: SSL or GNUTLS
2452 ** This variables specifies whether to attempt to use TLSv1 in the
2453 ** SSL authentication process.
2456 {"ssl_min_dh_prime_bits", DT_NUM, R_NONE, UL &SslDHPrimeBits, "0" },
2459 ** Availability: GNUTLS
2462 ** This variable specifies the minimum acceptable prime size (in bits)
2463 ** for use in any Diffie-Hellman key exchange. A value of 0 will use
2464 ** the default from the GNUTLS library.
2466 {"ssl_ca_certificates_file", DT_PATH, R_NONE, UL &SslCACertFile, "" },
2469 ** This variable specifies a file containing trusted CA certificates.
2470 ** Any server certificate that is signed with one of these CA
2471 ** certificates are also automatically accepted.
2473 ** Example: \fTset ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt\fP
2475 # endif /* USE_GNUTLS */
2476 # endif /* USE_SSL || USE_GNUTLS */
2477 {"pipe_split", DT_BOOL, R_NONE, OPTPIPESPLIT, "no" },
2480 ** Used in connection with the \fIpipe-message\fP command and the ``tag-
2481 ** prefix'' or ``tag-prefix-cond'' operators.
2482 ** If this variable is \fIunset\fP, when piping a list of
2483 ** tagged messages Madmutt will concatenate the messages and will pipe them
2484 ** as a single folder. When \fIset\fP, Madmutt will pipe the messages one by one.
2485 ** In both cases the messages are piped in the current sorted order,
2486 ** and the ``$$pipe_sep'' separator is added after each message.
2488 {"pipe_decode", DT_BOOL, R_NONE, OPTPIPEDECODE, "no" },
2491 ** Used in connection with the \fIpipe-message\fP command. When \fIunset\fP,
2492 ** Madmutt will pipe the messages without any preprocessing. When \fIset\fP, Madmutt
2493 ** will weed headers and will attempt to PGP/MIME decode the messages
2496 {"pipe_sep", DT_STR, R_NONE, UL &PipeSep, "\n"},
2499 ** The separator to add between messages when piping a list of tagged
2500 ** messages to an external Unix command.
2502 {"pop_authenticators", DT_STR, R_NONE, UL &PopAuthenticators, "" },
2505 ** This is a colon-delimited list of authentication methods Madmutt may
2506 ** attempt to use to log in to an POP server, in the order Madmutt should
2507 ** try them. Authentication methods are either ``\fTuser\fP'', ``\fTapop\fP''
2508 ** or any SASL mechanism, eg ``\fTdigest-md5\fP'', ``\fTgssapi\fP'' or ``\fTcram-md5\fP''.
2510 ** This parameter is case-insensitive. If this parameter is \fIunset\fP
2511 ** (the default) Madmutt will try all available methods, in order from
2512 ** most-secure to least-secure.
2514 ** Example: \fTset pop_authenticators="digest-md5:apop:user"\fP
2516 {"pop_auth_try_all", DT_BOOL, R_NONE, OPTPOPAUTHTRYALL, "yes" },
2519 ** If \fIset\fP, Madmutt will try all available methods. When \fIunset\fP, Madmutt will
2520 ** only fall back to other authentication methods if the previous
2521 ** methods are unavailable. If a method is available but authentication
2522 ** fails, Madmutt will not connect to the POP server.
2524 {"pop_checkinterval", DT_SYN, R_NONE, UL "pop_mail_check", 0},
2525 {"pop_mail_check", DT_NUM, R_NONE, UL &PopCheckTimeout, "60" },
2528 ** This variable configures how often (in seconds) Madmutt should look for
2531 {"pop_delete", DT_QUAD, R_NONE, OPT_POPDELETE, "ask-no" },
2534 ** If \fIset\fP, Madmutt will delete successfully downloaded messages from the POP
2535 ** server when using the ``fetch-mail'' function. When \fIunset\fP, Madmutt will
2536 ** download messages but also leave them on the POP server.
2538 {"pop_host", DT_STR, R_NONE, UL &PopHost, ""},
2541 ** The name of your POP server for the ``fetch-mail'' function. You
2542 ** can also specify an alternative port, username and password, i.e.:
2544 ** \fT[pop[s]://][username[:password]@]popserver[:port]\fP
2546 ** \fBNote:\fP Storing passwords in a configuration file
2547 ** presents a security risk since the superuser of your machine may read it
2548 ** regardless of the file's permissions.
2550 {"pop_last", DT_BOOL, R_NONE, OPTPOPLAST, "no" },
2553 ** If this variable is \fIset\fP, Madmutt will try to use the ``\fTLAST\fP'' POP command
2554 ** for retrieving only unread messages from the POP server when using
2555 ** the ``fetch-mail'' function.
2557 {"pop_reconnect", DT_QUAD, R_NONE, OPT_POPRECONNECT, "ask-yes" },
2560 ** Controls whether or not Madmutt will try to reconnect to a POP server if the
2561 ** connection is lost.
2563 {"pop_user", DT_STR, R_NONE, UL &PopUser, "" },
2566 ** Your login name on the POP server.
2568 ** This variable defaults to your user name on the local machine.
2570 {"pop_pass", DT_STR, R_NONE, UL &PopPass, ""},
2573 ** Specifies the password for your POP account. If \fIunset\fP, Madmutt will
2574 ** prompt you for your password when you open POP mailbox.
2576 ** \fBNote:\fP Storing passwords in a configuration file
2577 ** presents a security risk since the superuser of your machine may read it
2578 ** regardless of the file's permissions.
2580 {"post_indent_string", DT_STR, R_NONE, UL &PostIndentString, ""},
2583 ** Similar to the ``$$attribution'' variable, Madmutt will append this
2584 ** string after the inclusion of a message which is being replied to.
2587 {"nntp_post_moderated", DT_QUAD, R_NONE, OPT_TOMODERATED, "ask-yes" },
2590 ** Availability: NNTP
2593 ** If set to \fIyes\fP, Madmutt will post articles to newsgroup that have
2594 ** not permissions to post (e.g. moderated).
2596 ** \fBNote:\fP if the newsserver
2597 ** does not support posting to that newsgroup or a group is totally read-only, that
2598 ** posting will not have any effect.
2601 {"postpone", DT_QUAD, R_NONE, OPT_POSTPONE, "ask-yes" },
2604 ** Controls whether or not messages are saved in the ``$$postponed''
2605 ** mailbox when you elect not to send immediately.
2607 {"postponed", DT_PATH, R_NONE, UL &Postponed, "~/postponed"},
2610 ** Madmutt allows you to indefinitely ``$postpone sending a message'' which
2611 ** you are editing. When you choose to postpone a message, Madmutt saves it
2612 ** in the mailbox specified by this variable. Also see the ``$$postpone''
2615 {"preconnect", DT_STR, R_NONE, UL &Preconnect, "" },
2618 ** If \fIset\fP, a shell command to be executed if Madmutt fails to establish
2619 ** a connection to the server. This is useful for setting up secure
2620 ** connections, e.g. with \fTssh(1)\fP. If the command returns a nonzero
2621 ** status, Madmutt gives up opening the server. Example:
2623 ** \fTpreconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net
2624 ** sleep 20 < /dev/null > /dev/null"\fP
2626 ** Mailbox ``foo'' on mailhost.net can now be reached
2627 ** as ``{localhost:1234}foo''.
2629 ** \fBNote:\fP For this example to work, you must be able to log in to the
2630 ** remote machine without having to enter a password.
2632 {"print", DT_QUAD, R_NONE, OPT_PRINT, "ask-no" },
2635 ** Controls whether or not Madmutt really prints messages.
2636 ** This is set to \fIask-no\fP by default, because some people
2637 ** accidentally hit ``p'' often.
2639 {"print_command", DT_PATH, R_NONE, UL &PrintCmd, "lpr"},
2642 ** This specifies the command pipe that should be used to print messages.
2644 {"print_decode", DT_BOOL, R_NONE, OPTPRINTDECODE, "yes" },
2647 ** Used in connection with the print-message command. If this
2648 ** option is \fIset\fP, the message is decoded before it is passed to the
2649 ** external command specified by $$print_command. If this option
2650 ** is \fIunset\fP, no processing will be applied to the message when
2651 ** printing it. The latter setting may be useful if you are using
2652 ** some advanced printer filter which is able to properly format
2653 ** e-mail messages for printing.
2655 {"print_split", DT_BOOL, R_NONE, OPTPRINTSPLIT, "no" },
2658 ** Used in connection with the print-message command. If this option
2659 ** is \fIset\fP, the command specified by $$print_command is executed once for
2660 ** each message which is to be printed. If this option is \fIunset\fP,
2661 ** the command specified by $$print_command is executed only once, and
2662 ** all the messages are concatenated, with a form feed as the message
2665 ** Those who use the \fTenscript(1)\fP program's mail-printing mode will
2666 ** most likely want to set this option.
2668 {"prompt_after", DT_BOOL, R_NONE, OPTPROMPTAFTER, "yes" },
2671 ** If you use an \fIexternal\fP ``$$pager'', setting this variable will
2672 ** cause Madmutt to prompt you for a command when the pager exits rather
2673 ** than returning to the index menu. If \fIunset\fP, Madmutt will return to the
2674 ** index menu when the external pager exits.
2676 {"query_command", DT_PATH, R_NONE, UL &QueryCmd, ""},
2679 ** This specifies the command that Madmutt will use to make external address
2680 ** queries. The string should contain a \fT%s\fP, which will be substituted
2681 ** with the query string the user types. See ``$query'' for more
2684 {"quote_empty", DT_BOOL, R_NONE, OPTQUOTEEMPTY, "yes" },
2687 ** Controls whether or not empty lines will be quoted using
2688 ** ``$indent_string''.
2690 {"quote_quoted", DT_BOOL, R_NONE, OPTQUOTEQUOTED, "no" },
2693 ** Controls how quoted lines will be quoted. If \fIset\fP, one quote
2694 ** character will be added to the end of existing prefix. Otherwise,
2695 ** quoted lines will be prepended by ``$indent_string''.
2697 {"quote_regexp", DT_RX, R_PAGER, UL &QuoteRegexp, "^([ \t]*[|>:}#])+"},
2700 ** A regular expression used in the internal-pager to determine quoted
2701 ** sections of text in the body of a message.
2703 ** \fBNote:\fP In order to use the \fIquoted\fP\fBx\fP patterns in the
2704 ** internal pager, you need to set this to a regular expression that
2705 ** matches \fIexactly\fP the quote characters at the beginning of quoted
2708 {"read_inc", DT_NUM, R_NONE, UL &ReadInc, "10" },
2711 ** If set to a value greater than 0, Madmutt will display which message it
2712 ** is currently on when reading a mailbox. The message is printed after
2713 ** \fIread_inc\fP messages have been read (e.g., if set to 25, Madmutt will
2714 ** print a message when it reads message 25, and then again when it gets
2715 ** to message 50). This variable is meant to indicate progress when
2716 ** reading large mailboxes which may take some time.
2717 ** When set to 0, only a single message will appear before the reading
2720 ** Also see the ``$$write_inc'' variable.
2722 {"read_only", DT_BOOL, R_NONE, OPTREADONLY, "no" },
2725 ** If set, all folders are opened in read-only mode.
2727 {"realname", DT_STR, R_BOTH, UL &Realname, "" },
2730 ** This variable specifies what ``real'' or ``personal'' name should be used
2731 ** when sending messages.
2733 ** By default, this is the GECOS field from \fT/etc/passwd\fP.
2736 ** variable will \fInot\fP be used when the user has set a real name
2737 ** in the $$from variable.
2739 {"recall", DT_QUAD, R_NONE, OPT_RECALL, "ask-yes" },
2742 ** Controls whether or not Madmutt recalls postponed messages
2743 ** when composing a new message. Also see ``$$postponed''.
2745 ** Setting this variable to \fIyes\fP is not generally useful, and thus not
2748 {"record", DT_PATH, R_NONE, UL &Outbox, ""},
2751 ** This specifies the file into which your outgoing messages should be
2752 ** appended. (This is meant as the primary method for saving a copy of
2753 ** your messages, but another way to do this is using the ``$my_hdr''
2754 ** command to create a \fTBcc:\fP header field with your email address in it.)
2756 ** The value of \fI$$record\fP is overridden by the ``$$force_name'' and
2757 ** ``$$save_name'' variables, and the ``$fcc-hook'' command.
2759 {"reply_regexp", DT_RX, R_INDEX|R_RESORT, UL &ReplyRegexp, "^(re([\\[0-9\\]+])*|aw):[ \t]*"},
2762 ** A regular expression used to recognize reply messages when threading
2763 ** and replying. The default value corresponds to the English ``Re:'' and
2764 ** the German ``Aw:''.
2766 {"reply_self", DT_BOOL, R_NONE, OPTREPLYSELF, "no" },
2769 ** If \fIunset\fP and you are replying to a message sent by you, Madmutt will
2770 ** assume that you want to reply to the recipients of that message rather
2771 ** than to yourself.
2773 {"reply_to", DT_QUAD, R_NONE, OPT_REPLYTO, "ask-yes" },
2776 ** If \fIset\fP, when replying to a message, Madmutt will use the address listed
2777 ** in the ``\fTReply-To:\fP'' header field as the recipient of the reply. If \fIunset\fP,
2778 ** it will use the address in the ``\fTFrom:\fP'' header field instead.
2781 ** option is useful for reading a mailing list that sets the ``\fTReply-To:\fP''
2782 ** header field to the list address and you want to send a private
2783 ** message to the author of a message.
2785 {"resolve", DT_BOOL, R_NONE, OPTRESOLVE, "yes" },
2788 ** When set, the cursor will be automatically advanced to the next
2789 ** (possibly undeleted) message whenever a command that modifies the
2790 ** current message is executed.
2792 {"reverse_alias", DT_BOOL, R_BOTH, OPTREVALIAS, "no" },
2795 ** This variable controls whether or not Madmutt will display the ``personal''
2796 ** name from your aliases in the index menu if it finds an alias that
2797 ** matches the message's sender. For example, if you have the following
2800 ** \fTalias juser abd30425@somewhere.net (Joe User)\fP
2802 ** and then you receive mail which contains the following header:
2804 ** \fTFrom: abd30425@somewhere.net\fP
2806 ** It would be displayed in the index menu as ``Joe User'' instead of
2807 ** ``abd30425@somewhere.net.'' This is useful when the person's e-mail
2808 ** address is not human friendly (like CompuServe addresses).
2810 {"reverse_name", DT_BOOL, R_BOTH, OPTREVNAME, "no" },
2813 ** It may sometimes arrive that you receive mail to a certain machine,
2814 ** move the messages to another machine, and reply to some the messages
2815 ** from there. If this variable is \fIset\fP, the default \fTFrom:\fP line of
2816 ** the reply messages is built using the address where you received the
2817 ** messages you are replying to \fBif\fP that address matches your
2818 ** alternates. If the variable is \fIunset\fP, or the address that would be
2819 ** used doesn't match your alternates, the \fTFrom:\fP line will use
2820 ** your address on the current machine.
2822 {"reverse_realname", DT_BOOL, R_BOTH, OPTREVREAL, "yes" },
2825 ** This variable fine-tunes the behaviour of the $reverse_name feature.
2826 ** When it is \fIset\fP, Madmutt will use the address from incoming messages as-is,
2827 ** possibly including eventual real names. When it is \fIunset\fP, Madmutt will
2828 ** override any such real names with the setting of the $realname variable.
2830 {"save_address", DT_BOOL, R_NONE, OPTSAVEADDRESS, "no" },
2833 ** If \fIset\fP, Madmutt will take the sender's full address when choosing a
2834 ** default folder for saving a mail. If ``$$save_name'' or ``$$force_name''
2835 ** is \fIset\fP too, the selection of the fcc folder will be changed as well.
2837 {"save_empty", DT_BOOL, R_NONE, OPTSAVEEMPTY, "yes" },
2840 ** When \fIunset\fP, mailboxes which contain no saved messages will be removed
2841 ** when closed (the exception is ``$$spoolfile'' which is never removed).
2842 ** If \fIset\fP, mailboxes are never removed.
2844 ** \fBNote:\fP This only applies to mbox and MMDF folders, Madmutt does not
2845 ** delete MH and Maildir directories.
2847 {"save_name", DT_BOOL, R_NONE, OPTSAVENAME, "no" },
2850 ** This variable controls how copies of outgoing messages are saved.
2851 ** When set, a check is made to see if a mailbox specified by the
2852 ** recipient address exists (this is done by searching for a mailbox in
2853 ** the ``$$folder'' directory with the \fIusername\fP part of the
2854 ** recipient address). If the mailbox exists, the outgoing message will
2855 ** be saved to that mailbox, otherwise the message is saved to the
2856 ** ``$$record'' mailbox.
2858 ** Also see the ``$$force_name'' variable.
2860 {"score", DT_BOOL, R_NONE, OPTSCORE, "yes" },
2863 ** When this variable is \fIunset\fP, scoring is turned off. This can
2864 ** be useful to selectively disable scoring for certain folders when the
2865 ** ``$$score_threshold_delete'' variable and friends are used.
2868 {"score_threshold_delete", DT_NUM, R_NONE, UL &ScoreThresholdDelete, "-1" },
2871 ** Messages which have been assigned a score equal to or lower than the value
2872 ** of this variable are automatically marked for deletion by Madmutt. Since
2873 ** Madmutt scores are always greater than or equal to zero, the default setting
2874 ** of this variable will never mark a message for deletion.
2876 {"score_threshold_flag", DT_NUM, R_NONE, UL &ScoreThresholdFlag, "9999" },
2879 ** Messages which have been assigned a score greater than or equal to this
2880 ** variable's value are automatically marked ``flagged''.
2882 {"score_threshold_read", DT_NUM, R_NONE, UL &ScoreThresholdRead, "-1" },
2885 ** Messages which have been assigned a score equal to or lower than the value
2886 ** of this variable are automatically marked as read by Madmutt. Since
2887 ** Madmutt scores are always greater than or equal to zero, the default setting
2888 ** of this variable will never mark a message read.
2890 {"send_charset", DT_STR, R_NONE, UL &SendCharset, "us-ascii:iso-8859-1:utf-8"},
2893 ** A list of character sets for outgoing messages. Madmutt will use the
2894 ** first character set into which the text can be converted exactly.
2895 ** If your ``$$charset'' is not \fTiso-8859-1\fP and recipients may not
2896 ** understand \fTUTF-8\fP, it is advisable to include in the list an
2897 ** appropriate widely used standard character set (such as
2898 ** \fTiso-8859-2\fP, \fTkoi8-r\fP or \fTiso-2022-jp\fP) either
2899 ** instead of or after \fTiso-8859-1\fP.
2901 {"sendmail_wait", DT_NUM, R_NONE, UL &SendmailWait, "0" },
2904 ** Specifies the number of seconds to wait for the ``$$sendmail'' process
2905 ** to finish before giving up and putting delivery in the background.
2907 ** Madmutt interprets the value of this variable as follows:
2909 ** .dt >0 .dd number of seconds to wait for sendmail to finish before continuing
2910 ** .dt 0 .dd wait forever for sendmail to finish
2911 ** .dt <0 .dd always put sendmail in the background without waiting
2914 ** Note that if you specify a value other than 0, the output of the child
2915 ** process will be put in a temporary file. If there is some error, you
2916 ** will be informed as to where to find the output.
2919 {"nntp_save_unsubscribed", DT_BOOL, R_NONE, OPTSAVEUNSUB, "no" },
2922 ** Availability: NNTP
2925 ** When \fIset\fP, info about unsubscribed newsgroups will be saved into the
2926 ** ``newsrc'' file and into the news cache.
2930 {"nntp_show_new_news", DT_BOOL, R_NONE, OPTSHOWNEWNEWS, "yes" },
2933 ** Availability: NNTP
2936 ** If \fIset\fP, the newsserver will be asked for new newsgroups on entering
2937 ** the browser. Otherwise, it will be done only once for a newsserver.
2938 ** Also controls whether or not the number of new articles of subscribed
2939 ** newsgroups will be checked.
2941 {"nntp_show_only_unread", DT_BOOL, R_NONE, OPTSHOWONLYUNREAD, "no" },
2944 ** Availability: NNTP
2947 ** If \fIset\fP, only subscribed newsgroups that contain unread articles
2948 ** will be displayed in the newsgroup browser.
2951 {"sig_dashes", DT_BOOL, R_NONE, OPTSIGDASHES, "yes" },
2954 ** If set, a line containing ``\fT-- \fP'' (dash, dash, space)
2955 ** will be inserted before your ``$$signature''. It is \fBstrongly\fP
2956 ** recommended that you not unset this variable unless your ``signature''
2957 ** contains just your name. The reason for this is because many software
2958 ** packages use ``\fT-- \n\fP'' to detect your signature.
2960 ** For example, Madmutt has the ability to highlight
2961 ** the signature in a different color in the builtin pager.
2963 {"sig_on_top", DT_BOOL, R_NONE, OPTSIGONTOP, "no" },
2966 ** If \fIset\fP, the signature will be included before any quoted or forwarded
2967 ** text. It is \fBstrongly\fP recommended that you do not set this variable
2968 ** unless you really know what you are doing, and are prepared to take
2969 ** some heat from netiquette guardians.
2971 {"signature", DT_PATH, R_NONE, UL &Signature, "~/.signature"},
2974 ** Specifies the filename of your signature, which is appended to all
2975 ** outgoing messages. If the filename ends with a pipe (``\fT|\fP''), it is
2976 ** assumed that filename is a shell command and input should be read from
2979 {"signoff_string", DT_STR, R_NONE, UL &SignOffString, "" },
2982 ** If \fIset\fP, this string will be inserted before the signature. This is useful
2983 ** for people that want to sign off every message they send with their name.
2985 ** If you want to insert your website's URL, additional contact information or
2986 ** witty quotes into your mails, better use a signature file instead of
2987 ** the signoff string.
2989 {"simple_search", DT_STR, R_NONE, UL &SimpleSearch, "~f %s | ~s %s"},
2992 ** Specifies how Madmutt should expand a simple search into a real search
2993 ** pattern. A simple search is one that does not contain any of the ~
2994 ** operators. See ``$patterns'' for more information on search patterns.
2996 ** For example, if you simply type ``joe'' at a search or limit prompt, Madmutt
2997 ** will automatically expand it to the value specified by this variable.
2998 ** For the default value it would be:
3000 ** \fT~f joe | ~s joe\fP
3002 {"smart_wrap", DT_BOOL, R_PAGER, OPTWRAP, "yes" },
3005 ** Controls the display of lines longer than the screen width in the
3006 ** internal pager. If \fIset\fP, long lines are wrapped at a word boundary.
3007 ** If \fIunset\fP, lines are simply wrapped at the screen edge. Also see the
3008 ** ``$$markers'' variable.
3010 {"smileys", DT_RX, R_PAGER, UL &Smileys, "(>From )|(:[-^]?[][)(><}{|/DP])"},
3013 ** The \fIpager\fP uses this variable to catch some common false
3014 ** positives of ``$$quote_regexp'', most notably smileys in the beginning
3017 {"sleep_time", DT_NUM, R_NONE, UL &SleepTime, "1" },
3020 ** Specifies time, in seconds, to pause while displaying certain informational
3021 ** messages, while moving from folder to folder and after expunging
3022 ** messages from the current folder. The default is to pause one second, so
3023 ** a value of zero for this option suppresses the pause.
3025 {"sort", DT_SORT, R_INDEX|R_RESORT, UL &Sort, "date" },
3028 ** Specifies how to sort messages in the \fIindex\fP menu. Valid values
3032 ** . date or date-sent
3035 ** . mailbox-order (unsorted)
3044 ** You may optionally use the ``reverse-'' prefix to specify reverse sorting
3045 ** order (example: \fTset sort=reverse-date-sent\fP).
3047 {"sort_alias", DT_SORT|DT_SORT_ALIAS, R_NONE, UL &SortAlias, "alias" },
3050 ** Specifies how the entries in the ``alias'' menu are sorted. The
3051 ** following are legal values:
3054 ** . address (sort alphabetically by email address)
3055 ** . alias (sort alphabetically by alias name)
3056 ** . unsorted (leave in order specified in .muttrc)
3059 {"sort_aux", DT_SORT|DT_SORT_AUX, R_INDEX|R_RESORT_BOTH, UL &SortAux, "date" },
3062 ** When sorting by threads, this variable controls how threads are sorted
3063 ** in relation to other threads, and how the branches of the thread trees
3064 ** are sorted. This can be set to any value that ``$$sort'' can, except
3065 ** threads (in that case, Madmutt will just use date-sent). You can also
3066 ** specify the ``last-'' prefix in addition to ``reverse-'' prefix, but last-
3067 ** must come after reverse-. The last- prefix causes messages to be
3068 ** sorted against its siblings by which has the last descendant, using
3069 ** the rest of sort_aux as an ordering.
3071 ** For instance, \fTset sort_aux=last-date-received\fP would mean that if
3072 ** a new message is received in a thread, that thread becomes the last one
3073 ** displayed (or the first, if you have \fTset sort=reverse-threads\fP.)
3075 ** \fBNote:\fP For reversed ``$$sort'' order $$sort_aux is reversed again
3076 ** (which is not the right thing to do, but kept to not break any existing
3077 ** configuration setting).
3079 {"sort_browser", DT_SORT|DT_SORT_BROWSER, R_NONE, UL &BrowserSort, "alpha" },
3082 ** Specifies how to sort entries in the file browser. By default, the
3083 ** entries are sorted alphabetically. Valid values:
3086 ** . alpha (alphabetically)
3092 ** You may optionally use the ``reverse-'' prefix to specify reverse sorting
3093 ** order (example: \fTset sort_browser=reverse-date\fP).
3095 {"sort_re", DT_BOOL, R_INDEX|R_RESORT|R_RESORT_INIT, OPTSORTRE, "yes" },
3098 ** This variable is only useful when sorting by threads with
3099 ** ``$$strict_threads'' \fIunset\fP. In that case, it changes the heuristic
3100 ** Madmutt uses to thread messages by subject. With $$sort_re \fIset\fP,
3101 ** Madmutt will only attach a message as the child of another message by
3102 ** subject if the subject of the child message starts with a substring
3103 ** matching the setting of ``$$reply_regexp''. With $$sort_re \fIunset\fP,
3104 ** Madmutt will attach the message whether or not this is the case,
3105 ** as long as the non-``$$reply_regexp'' parts of both messages are identical.
3107 {"spam_separator", DT_STR, R_NONE, UL &SpamSep, ","},
3110 ** ``$spam_separator'' controls what happens when multiple spam headers
3111 ** are matched: if \fIunset\fP, each successive header will overwrite any
3112 ** previous matches value for the spam label. If \fIset\fP, each successive
3113 ** match will append to the previous, using ``$spam_separator'' as a
3116 {"spoolfile", DT_PATH, R_NONE, UL &Spoolfile, "" },
3119 ** If your spool mailbox is in a non-default place where Madmutt cannot find
3120 ** it, you can specify its location with this variable. Madmutt will
3121 ** automatically set this variable to the value of the environment
3122 ** variable $$$MAIL if it is not set.
3124 {"status_chars", DT_STR, R_BOTH, UL &StChars, "-*%A"},
3127 ** Controls the characters used by the ``\fT%r\fP'' indicator in
3128 ** ``$$status_format''. The first character is used when the mailbox is
3129 ** unchanged. The second is used when the mailbox has been changed, and
3130 ** it needs to be resynchronized. The third is used if the mailbox is in
3131 ** read-only mode, or if the mailbox will not be written when exiting
3132 ** that mailbox (You can toggle whether to write changes to a mailbox
3133 ** with the toggle-write operation, bound by default to ``\fT%\fP'').
3134 ** The fourth is used to indicate that the current folder has been
3135 ** opened in attach-message mode (Certain operations like composing
3136 ** a new mail, replying, forwarding, etc. are not permitted in this mode).
3138 {"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)---"},
3141 ** Controls the format of the status line displayed in the \fIindex\fP
3142 ** menu. This string is similar to ``$$index_format'', but has its own
3143 ** set of \fTprintf(3)\fP-like sequences:
3146 ** .dt %b .dd number of mailboxes with new mail *
3147 ** .dt %B .dd the short pathname of the current mailbox
3148 ** .dt %d .dd number of deleted messages *
3149 ** .dt %f .dd the full pathname of the current mailbox
3150 ** .dt %F .dd number of flagged messages *
3151 ** .dt %h .dd local hostname
3152 ** .dt %l .dd size (in bytes) of the current mailbox *
3153 ** .dt %L .dd size (in bytes) of the messages shown
3154 ** (i.e., which match the current limit) *
3155 ** .dt %m .dd the number of messages in the mailbox *
3156 ** .dt %M .dd the number of messages shown (i.e., which match the current limit) *
3157 ** .dt %n .dd number of new messages in the mailbox *
3158 ** .dt %o .dd number of old unread messages *
3159 ** .dt %p .dd number of postponed messages *
3160 ** .dt %P .dd percentage of the way through the index
3161 ** .dt %r .dd modified/read-only/won't-write/attach-message indicator,
3162 ** according to $$status_chars
3163 ** .dt %s .dd current sorting mode ($$sort)
3164 ** .dt %S .dd current aux sorting method ($$sort_aux)
3165 ** .dt %t .dd number of tagged messages *
3166 ** .dt %u .dd number of unread messages *
3167 ** .dt %v .dd Madmutt version string
3168 ** .dt %V .dd currently active limit pattern, if any *
3169 ** .dt %>X .dd right justify the rest of the string and pad with "X"
3170 ** .dt %|X .dd pad to the end of the line with "X"
3173 ** * = can be optionally printed if nonzero
3175 ** Some of the above sequences can be used to optionally print a string
3176 ** if their value is nonzero. For example, you may only want to see the
3177 ** number of flagged messages if such messages exist, since zero is not
3178 ** particularly meaningful. To optionally print a string based upon one
3179 ** of the above sequences, the following construct is used
3181 ** \fT%?<sequence_char>?<optional_string>?\fP
3183 ** where \fIsequence_char\fP is a character from the table above, and
3184 ** \fIoptional_string\fP is the string you would like printed if
3185 ** \fIsequence_char\fP is nonzero. \fIoptional_string\fP \fBmay\fP contain
3186 ** other sequences as well as normal text, but you may \fBnot\fP nest
3187 ** optional strings.
3189 ** Here is an example illustrating how to optionally print the number of
3190 ** new messages in a mailbox:
3192 ** \fT%?n?%n new messages.?\fP
3194 ** Additionally you can switch between two strings, the first one, if a
3195 ** value is zero, the second one, if the value is nonzero, by using the
3196 ** following construct:
3198 ** \fT%?<sequence_char>?<if_string>&<else_string>?\fP
3200 ** You can additionally force the result of any \fTprintf(3)\fP-like sequence
3201 ** to be lowercase by prefixing the sequence character with an underscore
3202 ** (\fT_\fP) sign. For example, if you want to display the local hostname in
3203 ** lowercase, you would use:
3207 ** If you prefix the sequence character with a colon (\fT:\fP) character, Madmutt
3208 ** will replace any dots in the expansion by underscores. This might be helpful
3209 ** with IMAP folders that don't like dots in folder names.
3211 {"status_on_top", DT_BOOL, R_BOTH, OPTSTATUSONTOP, "no" },
3214 ** Setting this variable causes the ``status bar'' to be displayed on
3215 ** the first line of the screen rather than near the bottom.
3217 {"strict_mailto", DT_BOOL, R_NONE, OPTSTRICTMAILTO, "yes" },
3221 ** With mailto: style links, a body as well as arbitrary header information
3222 ** may be embedded. This may lead to (user) headers being overwriten without note
3223 ** if ``$$edit_headers'' is unset.
3226 ** If this variable is \fIset\fP, Madmutt is strict and allows anything to be
3227 ** changed. If it's \fIunset\fP, all headers given will be prefixed with
3228 ** ``X-Mailto-'' and the message including headers will be shown in the editor
3229 ** regardless of what ``$$edit_headers'' is set to.
3231 {"strict_threads", DT_BOOL, R_RESORT|R_RESORT_INIT|R_INDEX, OPTSTRICTTHREADS, "no" },
3234 ** If \fIset\fP, threading will only make use of the ``\fTIn-Reply-To:\fP'' and
3235 ** ``\fTReferences:\fP'' header fields when you ``$$sort'' by message threads. By
3236 ** default, messages with the same subject are grouped together in
3237 ** ``pseudo threads.'' This may not always be desirable, such as in a
3238 ** personal mailbox where you might have several unrelated messages with
3239 ** the subject ``hi'' which will get grouped together. See also
3240 ** ``$$sort_re'' for a less drastic way of controlling this
3243 {"strip_was", DT_BOOL, R_NONE, OPTSTRIPWAS, "no" },
3246 ** When \fIset\fP, Madmutt will remove the trailing part of the ``\fTSubject:\fP''
3247 ** line which matches $$strip_was_regex when replying. This is useful to
3248 ** properly react on subject changes and reduce ``subject noise.'' (esp. in Usenet)
3250 {"strip_was_regex", DT_RX, R_NONE, UL &StripWasRegexp, "\\([Ww][Aa][RrSs]: .*\\)[ ]*$"},
3253 ** When non-empty and $$strip_was is \fIset\fP, Madmutt will remove this
3254 ** trailing part of the ``Subject'' line when replying if it won't be empty
3257 {"stuff_quoted", DT_BOOL, R_BOTH, OPTSTUFFQUOTED, "no" },
3260 ** If \fIset\fP, attachments with flowed format will have their quoting ``stuffed'',
3261 ** i.e. a space will be inserted between the quote characters and the actual
3264 {"suspend", DT_BOOL, R_NONE, OPTSUSPEND, "yes" },
3267 ** When \fIunset\fP, Madmutt won't stop when the user presses the terminal's
3268 ** \fIsusp\fP key, usually \fTCTRL+Z\fP. This is useful if you run Madmutt
3269 ** inside an xterm using a command like ``\fTxterm -e madmutt\fP.''
3271 {"text_flowed", DT_BOOL, R_NONE, OPTTEXTFLOWED, "no" },
3274 ** When \fIset\fP, Madmutt will generate \fTtext/plain; format=flowed\fP attachments.
3275 ** This format is easier to handle for some mailing software, and generally
3276 ** just looks like ordinary text. To actually make use of this format's
3277 ** features, you'll need support in your editor.
3279 ** Note that $$indent_string is ignored when this option is set.
3281 {"thread_received", DT_BOOL, R_RESORT|R_RESORT_INIT|R_INDEX, OPTTHREADRECEIVED, "no" },
3284 ** When \fIset\fP, Madmutt uses the date received rather than the date sent
3285 ** to thread messages by subject.
3287 {"thorough_search", DT_BOOL, R_NONE, OPTTHOROUGHSRC, "no" },
3290 ** Affects the \fT~b\fP and \fT~h\fP search operations described in
3291 ** section ``$patterns'' above. If \fIset\fP, the headers and attachments of
3292 ** messages to be searched are decoded before searching. If \fIunset\fP,
3293 ** messages are searched as they appear in the folder.
3295 {"tilde", DT_BOOL, R_PAGER, OPTTILDE, "no" },
3298 ** When \fIset\fP, the internal-pager will pad blank lines to the bottom of the
3299 ** screen with a tilde (~).
3301 {"timeout", DT_NUM, R_NONE, UL &Timeout, "600" },
3304 ** This variable controls the \fInumber of seconds\fP Madmutt will wait
3305 ** for a key to be pressed in the main menu before timing out and
3306 ** checking for new mail. A value of zero or less will cause Madmutt
3307 ** to never time out.
3309 {"to_chars", DT_STR, R_BOTH, UL &Tochars, " +TCFL"},
3312 ** Controls the character used to indicate mail addressed to you. The
3313 ** first character is the one used when the mail is NOT addressed to your
3314 ** address (default: space). The second is used when you are the only
3315 ** recipient of the message (default: +). The third is when your address
3316 ** appears in the ``\fTTo:\fP'' header field, but you are not the only recipient of
3317 ** the message (default: T). The fourth character is used when your
3318 ** address is specified in the ``\fTCc:\fP'' header field, but you are not the only
3319 ** recipient. The fifth character is used to indicate mail that was sent
3320 ** by \fIyou\fP. The sixth character is used to indicate when a mail
3321 ** was sent to a mailing-list you're subscribe to (default: L).
3323 {"trash", DT_PATH, R_NONE, UL &TrashPath, "" },
3326 ** If \fIset\fP, this variable specifies the path of the trash folder where the
3327 ** mails marked for deletion will be moved, instead of being irremediably
3330 ** \fBNote\fP: When you delete a message in the trash folder, it is really
3331 ** deleted, so that there is no way to recover mail.
3333 {"tunnel", DT_STR, R_NONE, UL &Tunnel, "" },
3336 ** Setting this variable will cause Madmutt to open a pipe to a command
3337 ** instead of a raw socket. You may be able to use this to set up
3338 ** preauthenticated connections to your IMAP/POP3 server. Example:
3340 ** \fTtunnel="ssh -q mailhost.net /usr/local/libexec/imapd"\fP
3342 ** \fBNote:\fP For this example to work you must be able to log in to the remote
3343 ** machine without having to enter a password.
3345 {"umask", DT_NUM, R_NONE, UL &Umask, "0077" },
3348 ** This sets the umask that will be used by Madmutt when creating all
3349 ** kinds of files. If \fIunset\fP, the default value is \fT077\fP.
3351 {"use_8bitmime", DT_BOOL, R_NONE, OPTUSE8BITMIME, "no" },
3354 ** \fBWarning:\fP do not set this variable unless you are using a version
3355 ** of sendmail which supports the \fT-B8BITMIME\fP flag (such as sendmail
3356 ** 8.8.x) or in connection with the SMTP support via libESMTP.
3357 ** Otherwise you may not be able to send mail.
3359 ** When \fIset\fP, Madmutt will either invoke ``$$sendmail'' with the \fT-B8BITMIME\fP
3360 ** flag when sending 8-bit messages to enable ESMTP negotiation or tell
3361 ** libESMTP to do so.
3363 {"use_domain", DT_BOOL, R_NONE, OPTUSEDOMAIN, "yes" },
3366 ** When \fIset\fP, Madmutt will qualify all local addresses (ones without the
3367 ** @host portion) with the value of ``$$hostname''. If \fIunset\fP, no
3368 ** addresses will be qualified.
3370 {"use_from", DT_BOOL, R_NONE, OPTUSEFROM, "yes" },
3373 ** When \fIset\fP, Madmutt will generate the ``\fTFrom:\fP'' header field when
3374 ** sending messages. If \fIunset\fP, no ``\fTFrom:\fP'' header field will be
3375 ** generated unless the user explicitly sets one using the ``$my_hdr''
3379 {"use_idn", DT_BOOL, R_BOTH, OPTUSEIDN, "yes" },
3382 ** Availability: IDN
3385 ** When \fIset\fP, Madmutt will show you international domain names decoded.
3387 ** \fBNote:\fP You can use IDNs for addresses even if this is \fIunset\fP.
3388 ** This variable only affects decoding.
3390 #endif /* HAVE_LIBIDN */
3391 #ifdef HAVE_GETADDRINFO
3392 {"use_ipv6", DT_BOOL, R_NONE, OPTUSEIPV6, "yes" },
3395 ** When \fIset\fP, Madmutt will look for IPv6 addresses of hosts it tries to
3396 ** contact. If this option is \fIunset\fP, Madmutt will restrict itself to IPv4 addresses.
3397 ** Normally, the default should work.
3399 #endif /* HAVE_GETADDRINFO */
3400 {"user_agent", DT_SYN, R_NONE, UL "agent_string", 0 },
3401 {"agent_string", DT_BOOL, R_NONE, OPTXMAILER, "yes" },
3404 ** When \fIset\fP, Madmutt will add a ``\fTUser-Agent:\fP'' header to outgoing
3405 ** messages, indicating which version of Madmutt was used for composing
3408 {"wait_key", DT_BOOL, R_NONE, OPTWAITKEY, "yes" },
3411 ** Controls whether Madmutt will ask you to press a key after \fIshell-
3412 ** escape\fP, \fIpipe-message\fP, \fIpipe-entry\fP, \fIprint-message\fP,
3413 ** and \fIprint-entry\fP commands.
3415 ** It is also used when viewing attachments with ``$auto_view'', provided
3416 ** that the corresponding mailcap entry has a \fTneedsterminal\fP flag,
3417 ** and the external program is interactive.
3419 ** When \fIset\fP, Madmutt will always ask for a key. When \fIunset\fP, Madmutt will wait
3420 ** for a key only if the external command returned a non-zero status.
3422 {"weed", DT_BOOL, R_NONE, OPTWEED, "yes" },
3425 ** When \fIset\fP, Madmutt will weed headers when displaying, forwarding,
3426 ** printing, or replying to messages.
3428 {"wrap_search", DT_BOOL, R_NONE, OPTWRAPSEARCH, "yes" },
3431 ** Controls whether searches wrap around the end of the mailbox.
3433 ** When \fIset\fP, searches will wrap around the first (or last) message. When
3434 ** \fIunset\fP, searches will not wrap.
3436 {"wrapmargin", DT_NUM, R_PAGER, UL &WrapMargin, "0" },
3439 ** Controls the size of the margin remaining at the right side of
3440 ** the terminal when Madmutt's pager does smart wrapping.
3442 {"write_inc", DT_NUM, R_NONE, UL &WriteInc, "10" },
3445 ** When writing a mailbox, a message will be printed every
3446 ** \fIwrite_inc\fP messages to indicate progress. If set to 0, only a
3447 ** single message will be displayed before writing a mailbox.
3449 ** Also see the ``$$read_inc'' variable.
3451 {"write_bcc", DT_BOOL, R_NONE, OPTWRITEBCC, "yes" },
3454 ** Controls whether Madmutt writes out the Bcc header when preparing
3455 ** messages to be sent. Exim users may wish to \fIunset\fP this.
3457 {"xterm_icon", DT_STR, R_BOTH, UL &XtermIcon, "M%?n?AIL&ail?"},
3460 ** Controls the format of the X11 icon title, as long as $$xterm_set_titles
3461 ** is \fIset\fP. This string is identical in formatting to the one used by
3462 ** ``$$status_format''.
3464 {"xterm_set_titles", DT_BOOL, R_BOTH, OPTXTERMSETTITLES, "no" },
3467 ** Controls whether Madmutt sets the xterm title bar and icon name
3468 ** (as long as you're in an appropriate terminal). The default must
3469 ** be \fIunset\fP to force in the validity checking.
3471 {"xterm_leave", DT_STR, R_BOTH, UL &XtermLeave, "" },
3474 ** If $$xterm_set_titles is \fIset\fP, this string will be used to
3475 ** set the title when leaving Madmutt. For terminal-based programs,
3476 ** there's no easy and portable way to read the current title so Madmutt
3477 ** cannot read it upon startup and restore it when exiting.
3480 ** Based on the xterm FAQ, the following might work:
3483 ** \fTset xterm_leave = "`test x$$$DISPLAY != x && xprop -id $$$WINDOWID | grep WM_NAME | cut -d '"' -f 2`"\fP
3485 {"xterm_title", DT_STR, R_BOTH, UL &XtermTitle, "Madmutt with %?m?%m messages&no messages?%?n? [%n New]?"},
3488 ** Controls the format of the title bar of the xterm provided that
3489 ** $$xterm_set_titles has been \fIset\fP. This string is identical in formatting
3490 ** to the one used by ``$$status_format''.
3493 {"nntp_x_comment_to", DT_BOOL, R_NONE, OPTXCOMMENTTO, "no" },
3496 ** Availability: NNTP
3499 ** If \fIset\fP, Madmutt will add a ``\fTX-Comment-To:\fP'' header field
3500 ** (that contains full name of the original article author) to articles that
3505 {"strict_mime", DT_BOOL, R_NONE, OPTSTRICTMIME, "no" },
3506 {"rfc2047_parameters", DT_BOOL, R_NONE, OPTRFC2047PARAMS, "yes"},
3507 { NULL, -1, R_NONE, -1, NULL }
3510 const struct mapping_t SortMethods[] = {
3511 {"date", SORT_DATE},
3512 {"date-sent", SORT_DATE},
3513 {"date-received", SORT_RECEIVED},
3514 {"mailbox-order", SORT_ORDER},
3515 {"subject", SORT_SUBJECT},
3516 {"from", SORT_FROM},
3517 {"size", SORT_SIZE},
3518 {"threads", SORT_THREADS},
3520 {"score", SORT_SCORE},
3521 {"spam", SORT_SPAM},
3525 /* same as SortMethods, but with "threads" replaced by "date" */
3527 const struct mapping_t SortAuxMethods[] = {
3528 {"date", SORT_DATE},
3529 {"date-sent", SORT_DATE},
3530 {"date-received", SORT_RECEIVED},
3531 {"mailbox-order", SORT_ORDER},
3532 {"subject", SORT_SUBJECT},
3533 {"from", SORT_FROM},
3534 {"size", SORT_SIZE},
3535 {"threads", SORT_DATE}, /* note: sort_aux == threads
3539 {"score", SORT_SCORE},
3540 {"spam", SORT_SPAM},
3545 const struct mapping_t SortBrowserMethods[] = {
3546 {"alpha", SORT_SUBJECT},
3547 {"date", SORT_DATE},
3548 {"size", SORT_SIZE},
3549 {"unsorted", SORT_ORDER},
3553 const struct mapping_t SortAliasMethods[] = {
3554 {"alias", SORT_ALIAS},
3555 {"address", SORT_ADDRESS},
3556 {"unsorted", SORT_ORDER},
3560 const struct mapping_t SortKeyMethods[] = {
3561 {"address", SORT_ADDRESS},
3562 {"date", SORT_DATE},
3563 {"keyid", SORT_KEYID},
3564 {"trust", SORT_TRUST},
3569 /* functions used to parse commands in a rc file */
3571 static int parse_list (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3572 static int parse_spam_list (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3573 static int parse_unlist (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3574 static int parse_attachments (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3575 static int parse_unattachments (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3576 static int parse_lists (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3577 static int parse_unlists (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3578 static int parse_alias (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3579 static int parse_unalias (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3580 static int parse_ignore (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3581 static int parse_unignore (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3582 static int parse_source (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3583 static int parse_set (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3584 static int parse_my_hdr (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3585 static int parse_unmy_hdr (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3586 static int parse_subscribe (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3587 static int parse_unsubscribe (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3589 static int parse_alternates (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3590 static int parse_unalternates (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3594 int (*func) (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3598 struct command_t Commands[] = {
3599 {"mailboxes", buffy_parse_mailboxes, M_MAILBOXES},
3600 {"unmailboxes", buffy_parse_mailboxes, M_UNMAILBOXES},
3601 {"bind", mutt_parse_bind, 0},
3602 {"color", mutt_parse_color, 0},
3603 {"exec", mutt_parse_exec, 0},
3604 {"account-hook", mutt_parse_hook, M_ACCOUNTHOOK},
3605 {"append-hook", mutt_parse_hook, M_APPENDHOOK},
3606 {"charset-hook", mutt_parse_hook, M_CHARSETHOOK},
3607 {"close-hook", mutt_parse_hook, M_CLOSEHOOK},
3608 {"crypt-hook", mutt_parse_hook, M_CRYPTHOOK},
3609 {"fcc-hook", mutt_parse_hook, M_FCCHOOK},
3610 {"fcc-save-hook", mutt_parse_hook, M_FCCHOOK|M_SAVEHOOK},
3611 {"folder-hook", mutt_parse_hook, M_FOLDERHOOK},
3613 {"iconv-hook", mutt_parse_hook, M_ICONVHOOK},
3615 {"mbox-hook", mutt_parse_hook, M_MBOXHOOK},
3616 {"message-hook", mutt_parse_hook, M_MESSAGEHOOK},
3617 {"open-hook", mutt_parse_hook, M_OPENHOOK},
3618 {"pgp-hook", mutt_parse_hook, M_CRYPTHOOK},
3619 {"reply-hook", mutt_parse_hook, M_REPLYHOOK},
3620 {"save-hook", mutt_parse_hook, M_SAVEHOOK},
3621 {"send2-hook", mutt_parse_hook, M_SEND2HOOK},
3622 {"send-hook", mutt_parse_hook, M_SENDHOOK},
3623 {"macro", mutt_parse_macro, 0},
3624 {"mono", mutt_parse_mono, 0},
3625 {"push", mutt_parse_push, 0},
3626 {"score", mutt_parse_score, 0},
3627 {"uncolor", mutt_parse_uncolor, 0},
3628 {"unhook", mutt_parse_unhook, 0},
3629 {"unmono", mutt_parse_unmono, 0},
3630 {"unscore", mutt_parse_unscore, 0},
3631 {"alias", parse_alias, 0},
3632 {"alternates", parse_alternates, 0},
3633 {"attachments", parse_attachments, 0 },
3634 {"ignore", parse_ignore, 0},
3635 {"alternative_order", parse_list, UL &AlternativeOrderList},
3636 {"auto_view", parse_list, UL &AutoViewList},
3637 {"hdr_order", parse_list, UL &HeaderOrderList},
3638 {"mime_lookup", parse_list, UL &MimeLookupList},
3639 {"lists", parse_lists, 0},
3640 {"my_hdr", parse_my_hdr, 0},
3641 {"reset", parse_set, M_SET_RESET},
3642 {"set", parse_set, 0},
3643 {"toggle", parse_set, M_SET_INV},
3644 {"unset", parse_set, M_SET_UNSET},
3645 {"source", parse_source, 0},
3646 {"nospam", parse_spam_list, M_NOSPAM},
3647 {"spam", parse_spam_list, M_SPAM},
3648 {"subscribe", parse_subscribe, 0},
3649 {"unalias", parse_unalias, 0},
3650 {"unalternates", parse_unalternates, 0},
3651 {"unattachments", parse_unattachments, 0},
3652 {"unignore", parse_unignore, 0},
3653 {"unlists", parse_unlists, 0},
3654 {"unalternative_order", parse_unlist, UL &AlternativeOrderList},
3655 {"unauto_view", parse_unlist, UL &AutoViewList},
3656 {"unhdr_order", parse_unlist, UL &HeaderOrderList},
3657 {"unmime_lookup", parse_unlist, UL &MimeLookupList},
3658 {"unmy_hdr", parse_unmy_hdr, 0},
3659 {"unsubscribe", parse_unsubscribe, 0},