my $factory = Mail::SpamAssassin::SQLBasedAddrList->new() $spamtest->set_persistent_addr_list_factory ($factory); ... call into SpamAssassin classes...
SpamAssassin will call:
my $addrlist = $factory->new_checker($spamtest); $entry = $addrlist->get_addr_entry ($addr, $origip); ...
See "Mail::SpamAssassin::PersistentAddrList" for more information.
Uses DBI::DBD module access to your favorite database (tested with MySQL, SQLite and PostgreSQL) to store user auto-whitelists.
The default table structure looks like this:
CREATE TABLE awl (
username VARCHAR NOT NULL,
email VARCHAR NOT NULL,
ip VARCHAR NOT NULL,
count INT NOT NULL,
totscore FLOAT NOT NULL,
PRIMARY KEY (username, email, ip) )
You're table definition may change depending on which database driver you choose. There is a config option to override the table name.
This module introduces several new config variables:
see "Mail::SpamAssassin::Conf" for more information.
Description: This method creates a new instance of the SQLBasedAddrList factory and calls the parent's (PersistentAddrList) new method.
Description: This method is called to setup a new checker interface and return a blessed copy of itself. Here is where we setup the SQL database connection based on the config values.
Description: This method takes a given $addr and splits it between the email address component and the ip component and performs a lookup in the database. If nothing is found in the database then a blank entry hash is created and returned, otherwise an entry containing the found information is returned.
A key, "exists_p", is set to 1 if an entry already exists in the database, otherwise it is set to 0.
Description: This method adds a given $score to a given $entry. If the entry was marked as not existing in the database then an entry will be inserted, otherwise a simple update will be performed.
NOTE: This code uses a self referential SQL call (ie set foo = foo + 1) which is supported by most modern database backends, but not everything calling itself a SQL database.
Description: This method removes a given $entry from the database. If the ip portion of the entry address is equal to ``none'' then remove any perl-IP entries for this address as well.
Description: This method provides the necessary cleanup for the address list.
Description: This method splits an autowhitelist address into it's two components, email and ip address.