###############################################################################
#
# $Id: default-settings,v 1.10 1998/01/13 05:20:04 bcwhite Exp $
#
# .procmailrc
#
# Originally by:           Lars Wirzenius <liw@iki.fi>
# Modified extensively by: Behan Webster <behanw@pobox.com>
# Modified extensively by: Brian White <bcwhite@pobox.com>
#
###############################################################################



#
# Defaults
#
# This file is included so that any changes to the Debian package can have
# default values that work through the remainder of the rules even if the
# user does not incorporate those changes into the copy of this file in
# their home directory.  Do not remove this line!
#
# To make the incorporation of changes easier, a copy of the original defaults
# file was placed under the "rules" subdirectory as "default-settings.orig".
# To find out what changes have been made to the package since the filter
# was installed into a user account, go to the local .procmail directory
# and do the following:
#
#   diff -u rules/default-settings.orig SPAMRULES/default-settings
#
# This will give display of the differences.  Once incorporation of any changes
# is complete, be sure to do a
#
#   cp SPAMRULES/default-settings rules/default-settings.orig
#
# so that the next time you wish to do a diff it will be from the latest time
# the incorporation of changes was done.
#
#INCLUDERC=SPAMRULES/default-settings


#
# Directories
#
PM_HOME=$HOME/.procmail
PM_ETC=$PM_HOME/etc
PM_RULES=$PM_HOME/rules
PM_TEXT=$PM_ETC
PM_VAR=$PM_HOME
PM_BACKUP=$PM_VAR/backup
PM_LOCK=$PM_VAR/run
PM_LOG=$PM_VAR/log
PM_RUN=$PM_VAR/run
PM_MAIL=$PM_VAR/spool

PATH=SPAMBIN:$HOME/bin:/usr/local/bin:/usr/bin:/bin


#
# Procmail variables
#
# If the global lockfile has been disabled, be sure to use local lockfiles
# where appropriate.  You may wish to enable this if your load goes too
# high because of large volumes of mail.  Some 'movemail' scripts (including
# the one available within the spamfilter package) require global locking.
#
MAILDIR=$PM_MAIL
DEFAULT=$MAILDIR/Inbox
LOCKFILE=$PM_LOCK/procmail.lock

#
# Move mail variables (used by SPAMBIN/movemail)
#
# MBOXDIR	Destination to which to copy filtered mailboxes.
# MOVEDMSG	Display xmessage with message counts? (yes/no)
#
MBOXDIR=$HOME/Mail
MOVEDMSG=yes

#
# Other definitions
#
CACHELOCK=$PM_LOCK/cache.lock
BACKUPLOCK=$PM_LOCK/backup.lock


#
# Default mailboxes.  Once fully running, you may want to set these
# directly to /dev/null, thus discarding the mail altogether.
#
# You can also set any of these to $DEFAULT if you want it delivered
# directly into your standard inbox.
#
ADMINBOX=Admin
NOPWBOX=Nopassword
SPAMBOX=Spam



#
# This is my singing and dancing Procmail configuration file.
# In addition to the usual things, it tries to stamp out e-mail spam.
# I've also tried to make it easily configurable, but you should
# carefully read all of it.
#
# Features:
#
#	discards mail from unknown people (unless they use password)
#	lets people know when they can reach me without password
#	easy vacation message (just create the message file)
#	sorts bounces in separate folder
#
# This is rather an aggressive mail filter. You probably don't want
# to employ it unless you are really disgusted by the amount of junkmail
# you get.
#
# I'd be grateful if you dropped me a note if you use this file as the
# basis of your own configuration. See also the following URL's:
#
#	* <URL:http://www.iki.fi/liw/mail-to-lasu.html>
#		What you should know before sending me mail.
#	* <URL:http://www.iki.fi/liw/mailfilter.html>
#		A general description of my mail filtering scheme
#		(describes this file on a bit higher level).
#
# Lars Wirzenius
# 



#################################################################
# Configuration section
#
# You need to configure all the following variables. Also read
# through the rest of the file, because you may not like all
# the filtering decisions I've made.
#
# Any settings that could involve shell meta-characters (like
# the pipe "|" symbol used for "or" in regular expressions)
# should be placed within double-quotes.
#
#################################################################

#
# The name of the blacklist file. The file should have one address
# per line.
#
#BLACKLIST=$PM_ETC/blacklist.db
BLACKLIST="/var/spamdb/SpamDomains /var/spamdb/Spammers $PM_ETC/blacklist.db"

#
# The whitelist and the greylist. The greylist is like the whitelist,
# but my setup maintains it automatically. The format for both is the
# same as for the blacklist.
#
WHITELIST=$PM_ETC/whitelist.db
GREYLIST=$PM_ETC/greylist.db

#
# Password that unknown people (those not on the whitelist) must include
# in subject to reach me. It doesn't need to be a great secret or very
# complicated. It's fine to have any shortish, unusual word as the password.
# NOTE that this does _not_ apply to normal passwords, only for this one.
#
PASSWORD=xyzzy

#
# USERID is your common userid
#
USERID=myuserid
FQDN=mydomain.com

#
# MYADDR is a regular expression matching all my email addresses.
#
MYADDR="($USERID( |,|\$|@.*($FQDN|debian.org))|otheraddr@otherdomain.com)"

#
# OFFADDR is the official address (used in From and X-Loop headers for
# automatic replies). 
OFFADDR=$USERID@$FQDN

# PWDADDR is the same, but the username has xyzzy appended (where
# xyzzy is the password). PWDADDR is an alternative to having the
# password in the subject. This circumvents some autoresponses
# that change the subject and have a different From and Sender
# addresses than the one I sent mail to. To use this, you need to
# have _personal_ letters have a Reply-to that is $PWDADDR. Don't
# do it for news articles or mailing lists, because then spammers
# will pick up the passworded address, and you don't want that.
# This does not work on all mail systems.
#
PWDADDR="$USERID-$PASSWORD@$FQDN"

#
# VACATION is the name of vacation file. Creating this file triggers 
# vacation responses.
#
VACATION=$PM_TEXT/vacation.txt

#
# Name of the database of people who have recently sent me mail.
# You should probably remove this file when you create or change
# the vacation message. (Ditto for AUTORESPONSE.)
#
VACATIONDB=$PM_RUN/vacation.cache
AUTORESPONSEDB=$PM_RUN/autoresponse.cache

#
# Text file to send to people who should be using the password.
#
USEPASSWORD=$PM_TEXT/use-passwd.txt

#
# Text file to send back to spammers.
#
SPAMREPLY=$PM_TEXT/spam-reply.txt

#
# What comes after @ in the Message-ID for locally generated mail.
# (Used by the rules that filter locally generated mail.)
#
MYHOST="(myhostname|$FQDN)"

#
# Procmail logging.
#
LOGFILE=$PM_LOG/procmail.log
LOGABSTRACT=all
CACHE=$PM_RUN/procmail.cache
#VERBOSE=yes


#
# Are we debugging?  Set to "yes" or "no" (without the quotes).
# If set to yes, then mail is stored in a mail-backup folder in
# the home directory, and nothing is automatically deleted.
# However, automatic responses _will_ be sent.
#
DEBUG=no


#
# The LISTCC variable sets how mail that is destined to both you and
# a mailing list should get delivered locally.  Valid settings are:
#
# normal	Ignore "list.rules" and deliver the mail as though
#		it were coming only to you.
#
# both		Put a copy of the mail in the appropriate list box
#		(via "list.rules") and deliver another copy as though
#		it were coming only to you.
#
# list		Deliver the mail into the list (via "list.rules") as
#		though you were not among the recipients.
#
LISTCC=normal


#
# Okay, now load and run the primary filter.
#

# The mainline program does the following (up until delivery takes place):
#  - if (DEBUG==yes) make backup of mail into $PM_BACKUP
#  - execute $PM_RULES/priority.rules to handle special actions
#  - check for mail sent by you and update the greylist
#  - execute $PM_RULES/adjust.rules to update/alter mail
#  - execute $PM_RULES/list.rules to filter out mailing lists
#  - execute $PM_RULES/black.rules on mail with blacklisted addresses/domains
#  - execute $PM_RULES/user.rules
#  - execute $PM_RULES/white.rules on mail if it's from a whitelisted address
#  - execute $PM_RULES/password.rules on mail if it contained the password
#  - execute $PM_RULES/nopassword.rules (on any yet uncategorized mail)

#INCLUDERC=SPAMRULES/mainline
