/* build complete documentation */
#ifdef _MAKEDOC
-# ifndef USE_SSL
-# define USE_SSL
-# endif
# ifndef USE_LIBESMTP
# define USE_LIBESMTP
# endif
# ifndef USE_NNTP
# define USE_NNTP
# endif
-# ifndef USE_GNUTLS
-# define USE_GNUTLS
-# endif
# ifndef USE_HCACHE
# define USE_HCACHE
# endif
# ifndef HAVE_LIBIDN
# define HAVE_LIBIDN
# endif
-# ifndef HAVE_GETADDRINFO
-# define HAVE_GETADDRINFO
-# endif
#endif
struct option_t MuttVars[] = {
** .pp
** This variable controls whether or not copies of your outgoing messages
** will be saved for later references. Also see ``$$record'',
- ** ``$$save_name'', ``$$force_name'' and ``$fcc-hook''.
- */
- {"crypt_autopgp", DT_BOOL, R_NONE, OPTCRYPTAUTOPGP, "yes" },
- /*
- ** .pp
- ** This variable controls whether or not Madmutt may automatically enable
- ** PGP encryption/signing for messages. See also ``$$crypt_autoencrypt'',
- ** ``$$crypt_replyencrypt'',
- ** ``$$crypt_autosign'', ``$$crypt_replysign'' and ``$$smime_is_default''.
- */
- {"crypt_autosmime", DT_BOOL, R_NONE, OPTCRYPTAUTOSMIME, "yes" },
- /*
- ** .pp
- ** This variable controls whether or not Madmutt may automatically enable
- ** S/MIME encryption/signing for messages. See also ``$$crypt_autoencrypt'',
- ** ``$$crypt_replyencrypt'',
- ** ``$$crypt_autosign'', ``$$crypt_replysign'' and ``$$smime_is_default''.
+ ** and ``$fcc-hook''.
*/
{"date_format", DT_STR, R_BOTH, UL &DateFmt, "!%a, %b %d, %Y at %I:%M:%S%p %Z"},
/*
** message via mail.
*/
#endif
- {"force_name", DT_BOOL, R_NONE, OPTFORCENAME, "no" },
- /*
- ** .pp
- ** This variable is similar to ``$$save_name'', except that Madmutt will
- ** store a copy of your outgoing message by the username of the address
- ** you are sending to even if that mailbox does not exist.
- ** .pp
- ** Also see the ``$$record'' variable.
- */
{"force_buffy_check", DT_BOOL, R_NONE, OPTFORCEBUFFYCHECK, "no" },
/*
** .pp
** maximum line length is determined by the terminal width and $$wrapmargin.
*/
#ifdef USE_HCACHE
- {"header_cache", DT_PATH, R_NONE, UL &HeaderCache, "" },
+ {"header_cache", DT_PATH, R_NONE, UL &HeaderCache, "~/.cache/madmutt/" },
/*
** .pp
** Availability: Header Cache
** be a single global header cache. By default it is \fIunset\fP so no
** header caching will be used.
*/
- {"maildir_header_cache_verify", DT_BOOL, R_NONE, OPTHCACHEVERIFY, "yes" },
- /*
- ** .pp
- ** Availability: Header Cache
- **
- ** .pp
- ** Check for Maildir unaware programs other than Madmutt having modified maildir
- ** files when the header cache is in use. This incurs one \fTstat(2)\fP per
- ** message every time the folder is opened.
- */
-#if defined(HAVE_GDBM) || defined(HAVE_DB4)
+#if defined(HAVE_GDBM)
{"header_cache_pagesize", DT_STR, R_NONE, UL &HeaderCachePageSize, "16384"},
/*
** .pp
** less the best you can get. For details google for mutt header
** cache (first hit).
*/
-#endif /* HAVE_GDBM || HAVE_DB 4 */
+#endif /* HAVE_GDBM */
#ifdef HAVE_QDBM
{ "header_cache_compress", DT_BOOL, R_NONE, OPTHCACHECOMPRESS, "no" },
/*
/*
** .pp
** The default mailbox type used when creating new folders. May be any of
- ** \fTmbox\fP, \fTMMDF\fP, \fTMH\fP and \fTMaildir\fP.
+ ** \fTmbox\fP, \fTMH\fP and \fTMaildir\fP.
*/
{"metoo", DT_BOOL, R_NONE, OPTMETOO, "no" },
/*
** .pp
** See also ``$$read_inc'' and ``$$write_inc''.
*/
- {"pager", DT_PATH, R_NONE, UL &Pager, "builtin"},
- /*
- ** .pp
- ** This variable specifies which pager you would like to use to view
- ** messages. ``builtin'' means to use the builtin pager, otherwise this
- ** variable should specify the pathname of the external pager you would
- ** like to use.
- ** .pp
- ** Using an external pager may have some disadvantages: Additional
- ** keystrokes are necessary because you can't call Madmutt functions
- ** directly from the pager, and screen resizes cause lines longer than
- ** the screen width to be badly formatted in the help menu.
- */
{"pager_context", DT_NUM, R_NONE, UL &PagerContext, "0" },
/*
** .pp
** when you are at the end of a message and invoke the \fInext-page\fP
** function.
*/
- {"crypt_autosign", DT_BOOL, R_NONE, OPTCRYPTAUTOSIGN, "no" },
- /*
- ** .pp
- ** Setting this variable will cause Madmutt to always attempt to
- ** cryptographically sign outgoing messages. This can be overridden
- ** by use of the \fIpgp-menu\fP, when signing is not required or
- ** encryption is requested as well. If ``$$smime_is_default'' is \fIset\fP,
- ** then OpenSSL is used instead to create S/MIME messages and settings can
- ** be overridden by use of the \fIsmime-menu\fP.
- ** (Crypto only)
- */
- {"crypt_autoencrypt", DT_BOOL, R_NONE, OPTCRYPTAUTOENCRYPT, "no" },
- /*
- ** .pp
- ** Setting this variable will cause Madmutt to always attempt to PGP
- ** encrypt outgoing messages. This is probably only useful in
- ** connection to the \fIsend-hook\fP command. It can be overridden
- ** by use of the \fIpgp-menu\fP, when encryption is not required or
- ** signing is requested as well. If ``$$smime_is_default'' is \fIset\fP,
- ** then OpenSSL is used instead to create S/MIME messages and
- ** settings can be overridden by use of the \fIsmime-menu\fP.
- ** (Crypto only)
- */
- {"pgp_ignore_subkeys", DT_BOOL, R_NONE, OPTPGPIGNORESUB, "yes" },
- /*
- ** .pp
- ** Setting this variable will cause Madmutt to ignore OpenPGP subkeys. Instead,
- ** the principal key will inherit the subkeys' capabilities. \fIUnset\fP this
- ** if you want to play interesting key selection games.
- ** (PGP only)
- */
- {"crypt_replyencrypt", DT_BOOL, R_NONE, OPTCRYPTREPLYENCRYPT, "yes" },
- /*
- ** .pp
- ** If \fIset\fP, automatically PGP or OpenSSL encrypt replies to messages which are
- ** encrypted.
- ** (Crypto only)
- */
- {"crypt_replysign", DT_BOOL, R_NONE, OPTCRYPTREPLYSIGN, "no" },
- /*
- ** .pp
- ** If \fIset\fP, automatically PGP or OpenSSL sign replies to messages which are
- ** signed.
- ** .pp
- ** \fBNote:\fP this does not work on messages that are encrypted \fBand\fP signed!
- ** (Crypto only)
- */
- {"crypt_replysignencrypted", DT_BOOL, R_NONE, OPTCRYPTREPLYSIGNENCRYPTED, "no" },
- /*
- ** .pp
- ** If \fIset\fP, automatically PGP or OpenSSL sign replies to messages
- ** which are encrypted. This makes sense in combination with
- ** ``$$crypt_replyencrypt'', because it allows you to sign all
- ** messages which are automatically encrypted. This works around
- ** the problem noted in ``$$crypt_replysign'', that Madmutt is not able
- ** to find out whether an encrypted message is also signed.
- ** (Crypto only)
- */
- {"crypt_verify_sig", DT_QUAD, R_NONE, OPT_VERIFYSIG, "yes" },
- /*
- ** .pp
- ** If ``\fIyes\fP'', always attempt to verify PGP or S/MIME signatures.
- ** If ``\fIask\fP'', ask whether or not to verify the signature.
- ** If ``\fIno\fP'', never attempt to verify cryptographic signatures.
- ** (Crypto only)
- */
- {"smime_is_default", DT_BOOL, R_NONE, OPTSMIMEISDEFAULT, "no" },
- /*
- ** .pp
- ** The default behaviour of Madmutt is to use PGP on all auto-sign/encryption
- ** operations. To override and to use OpenSSL instead this must be \fIset\fP.
- ** .pp
- ** However, this has no effect while replying, since Madmutt will automatically
- ** select the same application that was used to sign/encrypt the original
- ** message.
- ** .pp
- ** (Note that this variable can be overridden by unsetting $$crypt_autosmime.)
- ** (S/MIME only)
- */
- {"smime_ask_cert_label", DT_BOOL, R_NONE, OPTASKCERTLABEL, "yes" },
- /*
- ** .pp
- ** This flag controls whether you want to be asked to enter a label
- ** for a certificate about to be added to the database or not. It is
- ** \fIset\fP by default.
- ** (S/MIME only)
- */
- {"smime_decrypt_use_default_key", DT_BOOL, R_NONE, OPTSDEFAULTDECRYPTKEY, "yes" },
- /*
- ** .pp
- ** If \fIset\fP (default) this tells Madmutt to use the default key for decryption. Otherwise,
- ** if manage multiple certificate-key-pairs, Madmutt will try to use the mailbox-address
- ** to determine the key to use. It will ask you to supply a key, if it can't find one.
- ** (S/MIME only)
- */
- {"pgp_entry_format", DT_STR, R_NONE, UL &PgpEntryFormat, "%4n %t%f %4l/0x%k %-4a %2c %u"},
- /*
- ** .pp
- ** This variable allows you to customize the PGP key selection menu to
- ** your personal taste. This string is similar to ``$$index_format'', but
- ** has its own set of \fTprintf(3)\fP-like sequences:
- ** .pp
- ** .dl
- ** .dt %n .dd number
- ** .dt %k .dd key id
- ** .dt %u .dd user id
- ** .dt %a .dd algorithm
- ** .dt %l .dd key length
- ** .dt %f .dd flags
- ** .dt %c .dd capabilities
- ** .dt %t .dd trust/validity of the key-uid association
- ** .dt %[<s>] .dd date of the key where <s> is an \fTstrftime(3)\fP expression
- ** .de
- ** .pp
- ** (PGP only)
- */
- {"pgp_check_exit", DT_BOOL, R_NONE, OPTPGPCHECKEXIT, "yes" },
- /*
- ** .pp
- ** If \fIset\fP, Madmutt will check the exit code of the PGP subprocess when
- ** signing or encrypting. A non-zero exit code means that the
- ** subprocess failed.
- ** (PGP only)
- */
- {"pgp_long_ids", DT_BOOL, R_NONE, OPTPGPLONGIDS, "no" },
- /*
- ** .pp
- ** If \fIset\fP, use 64 bit PGP key IDs. \fIUnset\fP uses the normal 32 bit Key IDs.
- ** (PGP only)
- */
{"pgp_retainable_sigs", DT_BOOL, R_NONE, OPTPGPRETAINABLESIG, "no" },
/*
** .pp
{"smtp_use_tls", DT_STR, R_NONE, UL &SmtpUseTLS, "" },
/*
** .pp
- ** Availability: SMTP (and SSL)
+ ** Availability: SMTP
**
** .pp
** Defines wether to use STARTTLS. If this option is set to ``\fIrequired\fP''
** and the server does not support STARTTLS or there is an error in the
** TLS Handshake, the connection will fail. Setting this to ``\fIenabled\fP''
** will try to start TLS and continue without TLS in case of an error.
- **
- **.pp
- ** Madmutt still needs to have SSL support enabled in order to use it.
*/
#endif
-#if defined(USE_SSL) || defined(USE_GNUTLS)
-#ifdef USE_SSL
- {"ssl_client_cert", DT_PATH, R_NONE, UL &SslClientCert, "" },
- /*
- ** .pp
- ** Availability: SSL
- **
- ** .pp
- ** The file containing a client certificate and its associated private
- ** key.
- */
-#endif /* USE_SSL */
- {"ssl_force_tls", DT_BOOL, R_NONE, OPTSSLFORCETLS, "no" },
- /*
- ** .pp
- ** If this variable is \fIset\fP, Madmutt will require that all connections
- ** to remote servers be encrypted. Furthermore it will attempt to
- ** negotiate TLS even if the server does not advertise the capability,
- ** since it would otherwise have to abort the connection anyway. This
- ** option supersedes ``$$ssl_starttls''.
- */
- {"ssl_starttls", DT_QUAD, R_NONE, OPT_SSLSTARTTLS, "yes" },
- /*
- ** .pp
- ** Availability: SSL or GNUTLS
- **
- ** .pp
- ** If \fIset\fP (the default), Madmutt will attempt to use STARTTLS on servers
- ** advertising the capability. When \fIunset\fP, Madmutt will not attempt to
- ** use STARTTLS regardless of the server's capabilities.
- */
- {"certificate_file", DT_PATH, R_NONE, UL &SslCertFile, "~/.mutt_certificates"},
- /*
- ** .pp
- ** Availability: SSL or GNUTLS
- **
- ** .pp
- ** This variable specifies the file where the certificates you trust
- ** are saved. When an unknown certificate is encountered, you are asked
- ** if you accept it or not. If you accept it, the certificate can also
- ** be saved in this file and further connections are automatically
- ** accepted.
- ** .pp
- ** You can also manually add CA certificates in this file. Any server
- ** certificate that is signed with one of these CA certificates are
- ** also automatically accepted.
- ** .pp
- ** Example: \fTset certificate_file=~/.madmutt/certificates\fP
- */
-# if defined(_MAKEDOC) || !defined (USE_GNUTLS)
- {"ssl_usesystemcerts", DT_BOOL, R_NONE, OPTSSLSYSTEMCERTS, "yes" },
- /*
- ** .pp
- ** Availability: SSL
- **
- ** .pp
- ** If set to \fIyes\fP, Madmutt will use CA certificates in the
- ** system-wide certificate store when checking if server certificate
- ** is signed by a trusted CA.
- */
- {"entropy_file", DT_PATH, R_NONE, UL &SslEntropyFile, "" },
- /*
- ** .pp
- ** Availability: SSL
- **
- ** .pp
- ** The file which includes random data that is used to initialize SSL
- ** library functions.
- */
- {"ssl_use_sslv2", DT_BOOL, R_NONE, OPTSSLV2, "no" },
- /*
- ** .pp
- ** Availability: SSL
- **
- ** .pp
- ** This variables specifies whether to attempt to use SSLv2 in the
- ** SSL authentication process.
- */
-# endif /* _MAKEDOC || !USE_GNUTLS */
- {"ssl_use_sslv3", DT_BOOL, R_NONE, OPTSSLV3, "yes" },
- /*
- ** .pp
- ** Availability: SSL or GNUTLS
- **
- ** .pp
- ** This variables specifies whether to attempt to use SSLv3 in the
- ** SSL authentication process.
- */
- {"ssl_use_tlsv1", DT_BOOL, R_NONE, OPTTLSV1, "yes" },
- /*
- ** .pp
- ** Availability: SSL or GNUTLS
- **
- ** .pp
- ** This variables specifies whether to attempt to use TLSv1 in the
- ** SSL authentication process.
- */
-# ifdef USE_GNUTLS
- {"ssl_min_dh_prime_bits", DT_NUM, R_NONE, UL &SslDHPrimeBits, "0" },
- /*
- ** .pp
- ** Availability: GNUTLS
- **
- ** .pp
- ** This variable specifies the minimum acceptable prime size (in bits)
- ** for use in any Diffie-Hellman key exchange. A value of 0 will use
- ** the default from the GNUTLS library.
- */
- {"ssl_ca_certificates_file", DT_PATH, R_NONE, UL &SslCACertFile, "" },
- /*
- ** .pp
- ** This variable specifies a file containing trusted CA certificates.
- ** Any server certificate that is signed with one of these CA
- ** certificates are also automatically accepted.
- ** .pp
- ** Example: \fTset ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt\fP
- */
-# endif /* USE_GNUTLS */
-# endif /* USE_SSL || USE_GNUTLS */
{"pipe_split", DT_BOOL, R_NONE, OPTPIPESPLIT, "no" },
/*
** .pp
** .pp
** Example: \fTset pop_authenticators="digest-md5:apop:user"\fP
*/
- {"pop_auth_try_all", DT_BOOL, R_NONE, OPTPOPAUTHTRYALL, "yes" },
- /*
- ** .pp
- ** If \fIset\fP, Madmutt will try all available methods. When \fIunset\fP, Madmutt will
- ** only fall back to other authentication methods if the previous
- ** methods are unavailable. If a method is available but authentication
- ** fails, Madmutt will not connect to the POP server.
- */
{"pop_mail_check", DT_NUM, R_NONE, UL &PopCheckTimeout, "60" },
/*
** .pp
** presents a security risk since the superuser of your machine may read it
** regardless of the file's permissions.
*/
- {"post_indent_string", DT_STR, R_NONE, UL &PostIndentString, ""},
- /*
- ** .pp
- ** Similar to the ``$$attribution'' variable, Madmutt will append this
- ** string after the inclusion of a message which is being replied to.
- */
#ifdef USE_NNTP
{"nntp_post_moderated", DT_QUAD, R_NONE, OPT_TOMODERATED, "ask-yes" },
/*
** possibly including eventual real names. When it is \fIunset\fP, Madmutt will
** override any such real names with the setting of the $realname variable.
*/
- {"save_address", DT_BOOL, R_NONE, OPTSAVEADDRESS, "no" },
- /*
- ** .pp
- ** If \fIset\fP, Madmutt will take the sender's full address when choosing a
- ** default folder for saving a mail. If ``$$save_name'' or ``$$force_name''
- ** is \fIset\fP too, the selection of the fcc folder will be changed as well.
- */
- {"save_empty", DT_BOOL, R_NONE, OPTSAVEEMPTY, "yes" },
- /*
- ** .pp
- ** When \fIunset\fP, mailboxes which contain no saved messages will be removed
- ** when closed (the exception is ``$$spoolfile'' which is never removed).
- ** If \fIset\fP, mailboxes are never removed.
- ** .pp
- ** \fBNote:\fP This only applies to mbox and MMDF folders, Madmutt does not
- ** delete MH and Maildir directories.
- */
- {"save_name", DT_BOOL, R_NONE, OPTSAVENAME, "no" },
- /*
- ** .pp
- ** This variable controls how copies of outgoing messages are saved.
- ** When set, a check is made to see if a mailbox specified by the
- ** recipient address exists (this is done by searching for a mailbox in
- ** the ``$$folder'' directory with the \fIusername\fP part of the
- ** recipient address). If the mailbox exists, the outgoing message will
- ** be saved to that mailbox, otherwise the message is saved to the
- ** ``$$record'' mailbox.
- ** .pp
- ** Also see the ``$$force_name'' variable.
- */
{"score", DT_BOOL, R_NONE, OPTSCORE, "yes" },
/*
** .pp
** This variable only affects decoding.
*/
#endif /* HAVE_LIBIDN */
-#ifdef HAVE_GETADDRINFO
{"use_ipv6", DT_BOOL, R_NONE, OPTUSEIPV6, "yes" },
/*
** .pp
** contact. If this option is \fIunset\fP, Madmutt will restrict itself to IPv4 addresses.
** Normally, the default should work.
*/
-#endif /* HAVE_GETADDRINFO */
{"agent_string", DT_BOOL, R_NONE, OPTXMAILER, "yes" },
/*
** .pp