# Last updated: Jan 18, 2009 # This is a sample Mailmin configuration file for version 0.4. Copy it to # $HOME/.mailmin and edit it appropriately. An alternate configuration file can # be specified on the command line with the '-c' option: 'mailmin -c filename'. # Some options take arbitrary string values, like this: 'option = value' (DO # NOT use quotes). Others are Boolean (flags) and can be either on or off; # setting them to anything (except 'off' and 0), or simply specifyng them with no # value, turns them on, while setting them to 'off' or 0 (NOT 'no'), or just # prefacing them with 'no', turns them off. Most options have defaults, which # are generally okay. The option settings commented out in this file are the # defaults, unless otherwise stated; to keep them you don't need to do # anything. To use other values, uncomment and adjust them apropriately. Note # that use of '=' is optional. Option processing is handled by the AppConfig # Perl module; see its documentation for more information. # Most options can also be specified on the command line (cli); some have # aliases # '~' will be expanded into the user's home directory when used in options in # the configuration file ######################################################################## # Mailmin spawns shells to which it feeds the the lines of incoming messages # (it can actually spawn any program, but a shell is typical). The 'shell' # option (cli '-s') specifies the program spawned: # shell = /bin/sh # Mailmin can echo your commands in its response, interleaving them with the # output. The (Boolean) 'echo' option (cli '-e') controls this: # echo # The Boolean 'debug' (cli '-D') option causes Mailmin to print debug messages # to standard error; it is off by default. Note that from version 0.4, this # option is handled by the Log::Dispatcher framework, and will dump to STDERR # all messages that Mailmin logs with level debug or greater, i.e., all # messages period (see the section on logging below). # nodebug # Mailmin prints a banner, currently consisting of the hostname on which # Mailmin is running and the Mailmin version. This is controlled by the # boolean 'banner' (cli '-B'), on by default. # banner # From the Gnu Privacy Guard FAQ: # "Simplifying a bit, there are two ways mail can be encrypted with GnuPG: the # "old style" ASCII armor (i.e. cleartext encryption), and RFC 2015 style # (previously PGP/MIME, now OpenPGP). The latter has full MIME support. Some # MUAs support only one of them, so whichever you actually use depends on your # needs as well as the capabilities of your addressee." # Mailmin can use either of these methods; the (Boolean) 'use_mime' option (cli # '-u') controls this: # use_mime # Note that this option only affects how Mailmin signs and encrypts its # replies; Mailmin will correctly interpret incoming messages in either format # regardless of the value of this option. Also note that if you attach files to # the reply (via the '@attach' Mailmin directive) then Mailmin will disregard # this setting and automatically use MIME. # # When the Mailmin '@save' directive is used without a destination specified, a # default save directory is used; you can specify it with the 'save_dir' option # (cli '-d'): # save_dir = $HOME ################################################################ # Wget options # The path to GNU wget (used by the @wget directive) # wget = /usr/bin/wget # Some standard wget options; you might also want '-Hr -l #' (hint: 'man # wget'). Any options given in the wget directive itself, e.g. '@wget # --no-convert-links example.com', will be appended to the options given here # and therefore override them. # wget_opts = -qkEp # Wget options can be set separately for restricted mode (see below); by # default they're the same: # rm_wget_opts = -qkEp # Mailmin puts anything downloaded by wget (as well as directories given as # arguments to the '@attach' directive) into a compressed archive which is then # attached to the Mailmin reply. This can be .tar.gz, .tar.bz2 or .zip. Set # 'archive_type' (alias 'at', cli '-v') to 'gzip', 'bzip2' or 'zip' # respectively, and Mailmin will invoke the appropriate tar or zip commands, # provided, of course, that they are present on your system. # archive_type = gzip ################################################################ # Restricted mode (RM) and anonymous access: # Beginning with version 0.3, Mailmin can operate in RM, in which a severely # limited subset of Mailmin functionality is available; see # 'restricted_mode.html' for more information. # In RM, all arguments to the '@wattach' directive are assumed to be URLs (use # the form 'http://example.com'), and are passed to wget (which is invoked with # '-i -') on its standard input. Additionally, URLs can optionally be checked # against a list of regular expressions for blacklisting and whitelisting. If # 'rm_filter_file' is set to a filename, patterns will be read from the # specified file; if it is unset (the default), no URL checking will be done. # See 'restricted_mode.html' for more information. # rm_filter_file = /path/to/filter/file # Anonymous access # WARNING! anonymous access may be insecure, and is definitely vulnerable to DoS # attacks! # # If 'anon_enable' is set, Mailmin will accept unsigned mail (and mail signed by # arbitrary keys) and enter restricted mode. # anon_enable = off ################################################################ # Key Specification # See 'key_setup.html' for instructions on key specification (no keys are set # by default). # mailmin_key = ABCD1234 # authorized_key = DCBA5678 # restricted_key = EFEF9090 ################################################################ # Logging # Mailmin offers robust and flexible logging through the Log::Dispatcher # framework. Logging is not enabled by default; to activate it, set 'log_file' # to the file to log to: # log_file # From the Lod::Dispatch documentation: # "The log levels that Log::Dispatch uses are taken directly from the syslog # man pages (except that I expanded them to full words). Valid levels are: # debug # info # notice # warning # error # critical # alert # emergency # Alternately, the numbers 0 through 7 may be used (debug is 0 and # emergency is 7). The syslog standard of ’err’, ’crit’, and ’emerg’ is # also acceptable." # The desired level of logging is set using the 'log_level' variable: # log_level = notice ################################################################ # Response options # Mailmin sends its response to the sender of the original message, as given in # the 'From' header. You can specify additional recipients with the 'cc' # option: # cc # If the original message is signed, Mailmin encrypts the response. By # default, it is encrypted to the owner of the signing key. You can specify # additional identities to encrypt to with the 'encrypt_to' option: # encrypt_to