NAME
spasm - spasm configuration editor
SYNOPSIS
spasm
[-f --list-filters]
spasm
{--help | --version}
DESCRIPTION
spasm
is a curses-based filter/blacklist/whitelist editor for the spasm
anti-spam milter. When started, the user is presented with a list
of menu items, each of which is briefly described next.
- Filter
-
Configures all available anti-spam filters, associated options,
and parameters.
Each supported anti-spam filter may be set to one of four states:
-
- Disabled
-
filter disabled.
- Tagged
-
filter enabled and when triggered, affected email
is tagged with X-spasm headers and delivered to intended recipient.
- Quarantined
-
filter enabled and when triggered, affected email
is quarantined for later retrieval (message is also tagged as
above).
- Rejected
-
filter enabled and when triggered, affected email
is rejected--not delivered, not saved.
- Blacklist
-
Creates and/or updates a list of entities
(hosts, IP addresses, or explicit e-mail addreses)
that may not deliver e-mail to your inbox. The format of
allowed entities is described below. This list
does not affect e-mail delivery until the Blacklist
filter is enabled via the aforementioned Filter menu.
- Whitelist
-
Creates and/or updates a list of entities
that are given unconditional access to your inbox (i.e., whitelist entries
are never subjected to filtering).
- Rejection Logs
-
View a list of senders whose e-mail has been blocked by one or more
filters, and optionally whitelist the senders or clear the log.
- View Quarantine
-
View a list of messages currently in the quarantine. The menu lists
messages by internal message ID. When viewing a message, the user
can delete the message, forward the message to his/her inbox,
or whitelist the message sender.
- Spamtrap (root privileges required)
-
Creates and/or updates a list of regular expression or e-mail address
entries which define spamtrap addresses. Any server which sends mail to
a spamtrap address will be added to the spamtrap blacklist.
- Envelope Sender Menu (root privileges required)
-
Creates and/or updates a list of regular expression or e-mail address
entries which define senders who may not deliver e-mail. The
addition of regular expressions allow more powerful blocking of
e-mail sender addresses than that which can be done in the local
blacklist.
- Global IP Whitelist (root privileges required)
-
Creates and/or updates a list of IP addresses which are allowed to
bypass all filters. Used to whitelist machines within a local network.
- Change Username (root privileges required)
-
Allows the system administrator to assume the identity of another user,
for the purposes of modifying/updating the spasm settings of said
user.
ACCESS CONTROLS
Non-root users may only modify their own settings and only for the default
domain specified by the systems administrator. Users with virtual domains
may not modify settings for their virtual domain addresses.
The superuser (root) may modify all user settings.
OPTIONS
- -f, --list-filters
-
List all supported anti-spam filters on stdout and exit. For each
supported filter, the listing includes spasm's corresponding
internal database name, as well as the equivalent human interface name
displayed via the Filter menu.
WHITELIST/BLACKLIST FORMATS
Whitelist and blacklist entries may be specified as envelope senders
(i.e., simple e-mail addresses), hostnames, and IPv4 addresses in
CIDR or classful substring notations, in the following forms:
- myfriend@mail.domain.com
-
Envelope sender, exact matches only.
- server.domain.com
-
Server hostname matching any host ending in server.domain.com
- domain.com
-
Hostname matching any host ending in domain.com
- 10.9.8.7
-
IP address of a single server
- 10.9.8
-
IP address of 256 servers, matches 10.9.8.*
- 10.9
-
IP address of 65,536 servers, matches 10.9.*.*
- 10
-
IP address of 16,777,216 servers, matches 10.*.*.*
- 10.1.2.0/25
-
IP address of 128 servers, in CIDR notation
SEE ALSO
spasmd(8),
spasmdb(1)
AUTHOR
Sean Hanson
BUGS
None that I know of. ;)