Configuration Variables

Under Construction Under Construction

When this is complete, it will contain a detailed description of every configuration variable in the SpamBouncer, what it does, what the default setting is, what other settings are available, and anything else you might want to know about it.

Note: To find a variable, click the letter that it begins with, and scroll down the section. Variables are listed in alphabetical order. To get more information about a variable, click the plus sign () to the left of the variable's name.

A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z

Variable	Description	Default Value
A
ADMINFOLDER	The directory or folder on your mail server where the SpamBouncer stores administrative email, such as mail from admin, abuse, MAILER-DAEMON, postmaster, root, and webmaster.	${DEFAULT}
AHBLCGICHECK	Enables support for the AHBL insecure CGI and web forms blocklist.	no
AHBLDDOSCHECK	Enables support for the AHBL distributed denial-of-service (DDOS) blocklist.	no
AHBLDOMAINCHECK	Enables support for the AHBL abusive domains RHBSL blocklist.	no
AHBLEXEMPTCHECK	Enables support for the AHBL exemptions whitelist.	no
AHBLPROXYCHECK	Enables support for the AHBL open proxies blocklist.	no
AHBLRELAYCHECK	Enables support for the AHBL open SMTP relays blocklist.	no
AHBLPSSLCHECK	Enables support for the AHBL current spam floods blocklist.	no
AHBLSPAMCHECK	Enables support for the AHBL spam sources blocklist.	no
ALTFROM	Alternate email address used as From: address in blocked email notifications.	${LOGNAME}@${HOST}.${DOMAIN}
ALWAYSBLOCK	Sets the path and filename of the user's .alwaysblock file, a text file of email addresses, hosts and domains from which you want to block all email.	${HOME}/.alwaysblock
ARABIC	Tells the SpamBouncer whether you expect to receive any legitimate email in Arabic.	no

Variable	Description	Default Value
B
BASE64BLOCK	Tells the SpamBouncer whether to block email that has base64-encoded text sections that are not also in Chinese, Japanese, Korean, or Unicode.	yes
BLOCKFOLDER	The directory or folder on your mail server where the SpamBouncer stores email that it scores at or above your BLOCKLEVEL, but not at or above your SPAMLEVEL.	${DEFAULT}
BLOCKLEVEL	The score at or above which the SpamBouncer treats email as suspicious/possible spam.	5
BLOCKREPLY	Tells the SpamBouncer whether you want to notify senders when email they send is scored at or above your designated BLOCKLEVEL.	SILENT
BSPCHECK	Tells the SpamBouncer to check the Bonded Sender Plus whitelist, and whitelist email that comes from a server on it.	yes
BULKFOLDER	The directory or folder on your mail server where the SpamBouncer stores legitimate bulk email.	${DEFAULT}
BYPASSWD	A password that an email sender can include on the Subject: line of an email to bypass the SpamBouncer if it is blocking his or her email.	zeugma

Variable	Description	Default Value
C
CAT	Provides the SpamBouncer with an explicit path and filename for the Unix cat utility.	cat
CBLCHECK	Enables support for the CBL blocklist of computers running open proxies, trojans or exploits.	yes
CD	Provides the SpamBouncer with an explicit path and filename for the Unix cd utility.	cd
CHINESE	Tells the system whether you expect to receive any legitimate email in Chinese.	no
CHMEXPLOITCHECKING	Enables the CHM exploit dangerous content filter.	no
CLSIDCHECKING	Enables the CLSID dangerous content filter.	yes
CWHOISBOGONCHECK	Enables support for the CWHOIS bogus and non-routable IPS (bogons) blocklist.	no
CWHOISHIJACKCHECK	Enables support for the CWHOIS hijacked netblocks blocklist.	no
CYRILLIC	Tells the system whether you expect to receive any legitimate email in any language using any variant of the Cyrillic alphabet.	no

Variable	Description	Default Value
D
DANGEROUSCHECKING	Enables the SpamBouncer's "dangerous content" filters, which block email patterns and content types that are likely to contain email viruses and/or trojans.	yes
DATE	Provides the SpamBouncer with an explicit path and filename for the Unix date utility.	date
DOMAIN	Tells the SpamBouncer what your primary local domain is.	UNSET
DSBLCHECK	Enables support for the DSBL blocklist of open proxies and open SMTP relays.	no
DSBLMULTICHECK	Enables support for the DSBL blocklist of multi-level open SMTP relays.	no
DULCHECK	Enables support for the Kelkea MAPS DUL blocklist of dial-up and dynamic IPs.	no

Variable	Description	Default Value
E
ECHO	Provides the SpamBouncer with an explicit path and filename for the Unix echo utility.	echo
EGREP	Provides the SpamBouncer with an explicit path and filename for the Unix egrep utility.	egrep
EXECHECKING	Enables the executable file attachment dangerous content filter.	yes
EXEDOCCHECKING	Enables the executable document attachment dangerous content filter.	no
EXELINKCHECKING	Enables the executable hyperlink dangerous content filter.	no

Variable	Description	Default Value
F
FREEMAIL	Tells the SpamBouncer whether to negatively score email from providers of free email accounts, and which list of those providers to use.	INTERNAL
FREEMAIL	Tells the SpamBouncer whether to negatively score email from providers of free email accounts, and which list of those providers to use.	INTERNAL
FREEWEB	Tells the SpamBouncer whether to negatively score email containing URIs hosted at free web providers.	yes
FTSGDIALCHECK	Enables support for the Five-Ten Software Group's blocklist of dial-up and dynamic IPs.	no
FTSGIGNORECHECK	Enables support for the Five-Ten Software Group's blocklist of ISPs that ignore spam complaints.	no
FTSGMULTICHECK	Enables support for the Five-Ten Software Group's blocklist of multi-level open SMTP relays.	no
FTSGOPTOUTCHECK	Enables support for the Five-Ten Software Group's blocklist of opt-out ESPs and bulk email senders.	no
FTSGOTHERCHECK	Enables support for the Five-Ten Software Group's blocklist of email senders with unspecified spam problems.	no
FTSGRSSCHECK	Enables support for the Five-Ten Software Group's blocklist of open SMTP relays.	no
FTSGSRCCHECK	Enables support for the Five-Ten Software Group's blocklist of spam sources.	no
FTSGWEBFORMCHECK	Enables support for the Five-Ten Software Group's blocklist of insecure CGI email sources.	no

Variable	Description	Default Value
G
GLOBALNOBOUNCE	Sets the path and filename of the system .globalnobounce file, a text file of email addresses, hosts and domains which should be whitelisted on your entire system.	${HOME}/.globalnobounce
GREEK	Tells the system whether you expect to receive any legitimate email in Greek.	no
GREP	Provides the SpamBouncer with an explicit path and filename for the Unix fgrep utility.	fgrep

Variable	Description	Default Value
H
HABEASVERIFIED	Enables support for the Habeas whitelist for email with an Accreditor: Habeas header.	COI
HEBREW	Tells the system whether you expect to receive any legitimate email in Hebrew.	no

Variable	Description	Default Value
I
IADBCHECK	Enables support for the ISIPP's IADB reputation list, and whitelists email listed as coming from sources that require closed-loop confirmed opt-in (COI).	COI
IADB2CHECK	Enables support for the ISIPP's IADB2 reputation list, an alternate form of the IADB.	no
IBSCHECK	Enables support for the Bonded Sender whitelist.	no
IFRAMECHECKING	Enables the IFRAME dangerous content filter.	yes
IPRDNSCHECKING	Tells the SpamBouncer to check the first external IP to see if it has an IP as rDNS instead of a hostname, and block email from hosts that do.	yes

Variable	Description	Default Value
J
JAPANESE	Tells the system whether you expect to receive any legitimate email in Japanese.	no

Variable	Description	Default Value
K
KOREAN	Tells the system whether you expect to receive any legitimate email in Korean.	no

Variable	Description	Default Value
M
MAINSLEAZE	Tells the SpamBouncer how to treat email that comes from or contains references to: mainstream, otherwise legitimate companies that also spam; email sending providers (ESPs) that also spam; and internet service providers (ISPs) and web hosting providers who have multiple, long-term spamming customers they have failed to control, but who also have significant numbers of legitimate, non-spamming customers. In SpamBouncer 2.1 beta, this variable applies only to mainstream, otherwise legitimate companies that also spam.	BLOCK
MHDELIVER	Sets the path and filename of the MH Mail package's rcvstore program.	/usr/lib/mh/rcvstore +
MYEMAIL	Sets the path and filename of the .myemail file, a text file of all of your own email addresses.	${HOME}/.myemail

Variable	Description	Default Value
O
OPMBLITZEDCHECK	Enables support for the Blitzed.org OPM (Open Proxy Monitor) blocklist of open proxies.	yes
OPTOUT	Tells the SpamBouncer how to treat email that comes from email sending providers (ESPs) who (unlike legitimate ESPs) knowingly send spam for other companies, but also have a significant number of legitimate, non-spamming companies as customers.	BLOCK
ORDBCHECK	Enables support for the ORDB (Open Relay Database) blocklist of open SMTP relays.	no
OUTLOOKTAGGING	Tells the SpamBouncer to embed X-SBClass: Spam and X-SBClass: Blocked headers in the Subject: line of incoming email, to allow earlier versions of Microsoft Outlook to filter out this email.	no

Variable	Description	Default Value
P
PATTERNMATCHING	Tells the SpamBouncer whether to run its generic pattern matching filters on incoming email, and (if it does) whether to send Block notifications for email that matches one of these filters.	NONE
PINKISP	Tells the SpamBouncer how to treat email that comes from internet service providers (ISPs) that have a significant number of spamming customers that they have failed to control or disconnect, but that also have a significant number of legitimate, non-spamming customers.	BLOCK

Variable	Description	Default Value
L
LANGFILTER	Tells the SpamBouncer whether you want to block email in languages that you do not speak and in which you do not expect to receive legitimate email.	yes
LEAN	Tells the SpamBouncer whether you want to skip message body filtering of email larger than 250 KB in size.	yes
LEGITLISTS	Sets the path and filename of the system .legitlists file, a text file of the email addresses of legitimate bulk email lists to which you are subscribed.	${HOME}/.legitlists
LOCALHELOCHECKING	Tells the SpamBouncer whether to check the HELO string in incoming email headers against your .localhostfile to catch spam from software that HELOs with your local domain or IP.	no
LOCALHOSTCHECKING	Tells the SpamBouncer what sort of data to expect in the user's .localhostfile file. If set to RELAXED, the .localhostfile can contain domains, FQDNs, or IPs of local mail servers. In addition, the SpamBouncer will treat any IP within the same /24 as a listed IP as local. If set to STRICT, the .localhostfile can contain only the FQDNs and IPs of local mail servers, and the SpamBouncer will match only those exact values.	RELAXED
LOCALHOSTFILE	Sets the path and filename of the .localhostfile file, a text file of the IPs and FQDNs of local mail servers.	${HOME}/.localhostfile
LS	Provides the SpamBouncer with an explicit path and filename for the Unix ls utility.	ls

Variable	Description	Default Value
N
NJABLCGICHECK	Enables support for the NJABL blocklist of web servers with insecure CGI and/or web forms.	no
NJABLDULCHECK	Enables support for the NJABL blocklist of dial-up and dynamic IP pools.	yes
NJABLMULTICHECK	Enables support for the NJABL blocklist of multi-level SMTP relays ("smarthosts").	no
NJABLPROXYCHECK	Enables support for the NJABL blocklist of open proxies.	yes
NJABLRSSCHECK	Enables support for the NJABL blocklist of open SMTP relays.	no
NJABLSRCCHECK	Enables support for the NJABL blocklist of spam sources.	no
NOBOUNCE	Sets the path and filename of the .nobounce file, a text file whitelist of email addresses of people you regularly correspond with and that the SpamBouncer should not filter except for viruses and dangerous content.	${HOME}/.nobounce
NOLOOP	Sets the value used by the SpamBouncer in the X-Loop: header when sending block notifications.	${ALTFROM}
NORDNSCHECKING	Tells the SpamBouncer to block email when the first external IP (the host that sent the email directly to your server) does not have rDNS.	yes
NUKEBOUNCES	Tells the SpamBouncer to discard bounce messages generated by its block notifications.	no

Variable	Description	Default Value
R
RBLCHECK	Enables support for the Kelkea MAPS RBL blocklist of spam sources.	no
RFCABUSECHECK	Enables support for the RFC Ignorant blocklist of domains that lack a working abuse@ email address or filter email sent to that address.	no
RFCDSNCHECK	Enables support for the RFC Ignorant blocklist of IPs that do not accept legitimate bounce messages.	no
RFCPOSTMASTERCHECK	Enables support for the RFC Ignorant blocklist of domains that lack a working postmaster@ email address or filter email sent to that address.	no
RFCWHOISCHECK	Enables support for the RFC Ignorant blocklist of domains that lack a valid WHOIS record.	no
RM	Provides the SpamBouncer with an explicit path and filename for the Unix rm utility.	rm
RUSSIAN	Tells the system whether you expect to receive any legitimate email in Russian.	no

Variable	Description	Default Value
S
SBCONFIG	Tells the SpamBouncer which base configuration to use.	Default
SBDELIVERY (SB 2.2) SBDELIVERY	Tells the SpamBouncer whether to deliver filtered email to Unix-style flat files, to MH Mail-style folders, or to just filter the email and leave it undelivered so that the user can set up his or her own delivery filters. (SB 2.2) Provides a fourth delivery option: delivery to a spamtrap directory sorted by spam source, spam havens, and other criteria, for those who run catchall spamtrap accounts and want to monitor or analyze the spam that their spamtrap account receives.	FILE
SBHEADERS	Tells the SpamBouncer whether to use brief or complete headers.	BRIEF
SBHOST	Tells the SpamBouncer whether to use the Unix host program or the Unix nslookup program when looking up IPs and checking blocklists, and the exact path and filename to the program.	host
SBLOGFILE	Tells the SpamBouncer which file to use for its logs. You set this variable only if you want to save the SpamBouncer logs to a different file than your other Procmail logs.	${LOGFILE}
SBLOGLEVEL	Tells the SpamBouncer what level of detail you want in the logs it keeps.	3
SBNAMESRVR	Tells the SpamBouncer to use a specific nameserver when doing DNS lookups. You set this only if you want the SpamBouncer to use a different nameserver then than the default nameserver on your system.	'' (Null string)
SBRETIRED	If SBCONFIG=Analyze is set, tells the SpamBouncer to check the list of retired spammers in addition to the other identified spammers.	No
SBSHELL	Provides the SpamBouncer with an explicit path and filename for the Unix /bin/sh shell and any options it should use when running a program in a subshell.	/bin/sh -c
SBTEMP	Tells the SpamBouncer to use a specific directory for its temporary files.	/tmp
SCRIPTCHECKING	Tells the SpamBouncer whether to treat embedded JavaScript and other types of scripts in email as dangerous content.	yes
SED	Provides the SpamBouncer with an explicit path and filename for the Unix sed utility.	sed
SENDMAIL	Provides the SpamBouncer with an explicit path and filename for the Unix sendmail program.	/usr/sbin/sendmail
SORBSCGICHECK	Enables support for the SORBS blocklist of web servers that contain insecure CGI or web forms.	no
SORBSDYNCHECK	Enables support for the SORBS blocklist of dial-up and dynamic IP ranges.	no
SORBSPROXYCHECK	Enables support for the SORBS blocklist of open proxies.	no
SORBSPROXY2CHECK	Enables support for the SORBS blocklist of compromized servers or servers running trojan programs.	no
SORBSRELAYCHECK	Enables support for the SORBS blocklist of open SMTP relays.	no
SORBSSOCKSCHECK	Enables support for the SORBS blocklist of open Wingate proxies.	no
SORBSSPAMCHECK	Enables support for the SORBS blocklist of spam sources.	no
SORBSZOMBIECHECK	Enables support for the SORBS blocklist of hijacked and zombie netblocks.	no
SORT	Provides the SpamBouncer with an explicit path and filename for the Unix sort utility.	sort
SPAMCOPCHECK	Enables support for the SpamCop blocklist.	no
SPAMCOPEMAIL	Tells the SpamBouncer your registered SpamCop reports email address. You set this variable only if you have enabled SpamCop Reports.	noemail@example.com
SPAMCOPREPORT	Tells the SpamBouncer to report spam to SpamCop, and configures the type of report to use.	NONE
SPAMFOLDER	Tells the SpamBouncer where to store email that it classifies as spam.	${DEFAULT}
SPAMHAUSORGCHECK	Enables support for the SpamHaus SBL blocklist.	yes
SPAMLEVEL	Tells the SpamBouncer the score to use to classify an email as spam.	10
(SB 2.2) SPAMTRAPROOT	(SB 2.2) When SBDELIVERY=SPAMTRAP is set, tells the SpamBouncer the location of the spamtrap root directory, the main directory containing the directories (folders) and files to which spam sent to your spamtrap is delivered.	(none)
SPANISH	Tells the system whether you expect to receive any legitimate email in Spanish.	no
SPEWSCHECK	Enables support for the SPEWS Level-1 blocklist.	no
SPEWSL2CHECK	Enables support for the SPEWS Level-2 blocklist.	no
SURBLABCHECK	Enables support for the SURBL Abuse Butler data blocklist.	yes
SURBLOBCHECK	Enables support for the SURBL Outblaze data blocklist.	yes
SURBLPHCHECK	Enables support for the SURBL Phishing data blocklist.	yes
SURBLPJCHECK	Enables support for the SURBL Wein/Dijkxhoorn data blocklist.	yes
SURBLSCCHECK	Enables support for the SURBL Spamcop data blocklist.	yes
SURBLWSCHECK	Enables support for the SURBL William Stearns data blocklist.	yes

Variable	Description	Default Value
T
TEST	Provides the SpamBouncer with an explicit path and filename for the Unix test utility.	test
TOUCH	Provides the SpamBouncer with an explicit path and filename for the Unix touch utility.	touch
TR	Provides the SpamBouncer with an explicit path and filename for the Unix tr utility.	tr
TURKISH	Tells the system whether you expect to receive any legitimate email in Turkish.	no

Variable	Description	Default Value
U
URIBLCHECK	Enables support for the URIBL black blocklist.	yes
URIBLGREYCHECK	Enables support for the URIBL grey blocklist.	no
URIBLREDCHECK	Enables support for the URIBL red blocklist.	no

Variable	Description	Default Value
V
VIRUSCHECKING	Tells the SpamBouncer whether to run its email virus checking filters or not.	yes
VIRUSFOLDER	Tells the SpamBouncer where to store email it classifies as a virus.	${SPAMFOLDER}

Variable	Description	Default Value
W
WHITELISTLOCAL	Tells the SpamBouncer whether to skip spam filtering for email that originated on the local server.	no
WHITELISTMYEMAIL	Tells the SpamBouncer whether to skip spam filtering for email that I sent.	no
WHOIS	Tells the SpamBouncer which Whois server to use.	no

Variable	Description	Default Value
X
XBLCHECK	Enables support for the SpamHaus XBL blocklist of open proxies and trojaned servers.	yes

Variable	Description	Default Value
Z
ZIPCHECKING	Tells the SpamBouncer whether to treat email with attached archive files, such as .ZIP files, as dangerous content.	yes