filter-spool - Filter incoming mail into raw archives |
filter-spool - Filter incoming mail into raw archives
filter-spool filter-spool [options]
This program is part of mharc and has the responsibility of filtering incoming mail into the raw message archives. This script is called by the read-mail script before web-archive is invoked.
This program is generally called without any command-line options
since it will read <mharc-root>/lib/config.sh
for all configurable
options. However, the following command-line options are
available:
-help
Print out usage information.
-home
pathname
Root pathname of archiving software and data. If not specified,
SW_ROOT
variable in config.sh
is used, else the parent directory
that contains this program is used.
-html-dir
pathname
Root pathname containing HTML archives. If not specified,
MBOX_DIR
variable in config.sh
is used, else -home/html
is used.
Note: This program does not do any processing of the HTML archives. This option is used to insure that the HTML archive root directory exists for subsequent processing by other mharc scripts.
-is-spool
Specifies that -mail
represents a mail spool file. If not
specified, the value of the IS_MAIL_SPOOL
variable in config.sh
is used, else -mail
is assumed to be a mail spool file.
-lock-timeout
seconds
The age of a lock before it is forceably removed. This is used to help deal with stale locks.
If this option is not specified, ORGMAIL_LOCK_TIMEOUT
variable in
config.sh
is used, else 3600
is used.
-log-dir
pathname
Root pathname to place log files. If not specified,
LOG_DIR
variable in config.sh
is used, else -home/log
is used.
-mail
pathname
Pathname to incoming mailbox file.
If not specified, ORGMAIL
variable in config.sh
is used,
else /var/mail/$LOGNAME
is used, where $LOGNAME
represents the
value of the LOGNAME
environment variable.
-man
Print out entire manpage.
-mbox-dir
pathname
Root pathname containing raw mailbox archives. If not specified,
MBOX_DIR
variable in config.sh
is used, else -home/mbox
is used.
-procmailrc
pathname
Pathname to procmailrc file to use when filtering mail.
If not specified, PROCMAILRC
variable in config.sh
is used,
else -home/procmailrc.mharc
is used.
-procmailvars
variable-list
Additional variables to pass into procmail
.
If not specified, PROCMAILVARS
variable in config.sh
is used.
-verbose
Print out status messages.
If there was mail to process, and no errors occurred during processing, a zero exit status will be returned. Otherwise, a non-zero exit status will be returned.
<mharc-root>/lib/config.sh
Main configuration file for mharc.
$Id: filter-spool,v 1.13 2015/12/21 19:07:50 ehood Exp $
Earl Hood, earl@earlhood.com
This program is part of the mharc archiving system and comes with ABSOLUTELY NO WARRANTY and may be copied only under the terms of the GNU General Public License, which may be found in the mharc distribution.
filter-spool - Filter incoming mail into raw archives |