1Mail::SpamAssassin::PerUssiesrteCnotnAtdrdirbLuitsetdM(a3Pi)elr:l:SDpoacmuAmsesnatsastiino:n:PersistentAddrList(3)
2
3
4

NAME

6       Mail::SpamAssassin::PersistentAddrList - persistent address list base
7       class
8

SYNOPSIS

10         my $factory = PersistentAddrListSubclass->new();
11         $spamtest->set_persistent_addr_list_factory ($factory);
12         ... call into SpamAssassin classes...
13
14       SpamAssassin will call:
15
16         my $addrlist = $factory->new_checker($spamtest);
17         $entry = $addrlist->get_addr_entry ($addr);
18         ...
19

DESCRIPTION

21       All persistent address list implementations, used by the auto-whitelist
22       code to track known-good email addresses, use this as a base class.
23
24       See "Mail::SpamAssassin::DBBasedAddrList" for an example.
25

METHODS

27       $factory = PersistentAddrListSubclass->new();
28           This creates a factory object, which SpamAssassin will call to
29           create a new checker object for the persistent address list.
30
31       my $addrlist = $factory->new_checker();
32           Create a new address-list checker object from the factory. Called
33           by the SpamAssassin classes.
34
35       $entry = $addrlist->get_addr_entry ($addr);
36           Given an email address $addr, return an entry object with the
37           details of that address.
38
39           The entry object is a reference to a hash, which must contain at
40           least two keys: "count", which is the count of times that address
41           has been encountered before; and "totscore", which is the total of
42           all scores for messages associated with that address.  From these
43           two fields, an average score will be calculated, and the score for
44           the current message will be regressed towards that mean message
45           score.
46
47           The hash can contain whatever other data your back-end needs to
48           store, under other keys.
49
50           The method should never return "undef", or a hash that does not
51           contain a "count" key and a "totscore" key.
52
53       $entry = $addrlist->add_score($entry, $score);
54           This method should add the given score to the whitelist database
55           for the given entry, and then return the new entry.
56
57       $entry = $addrlist->remove_entry ($entry);
58           This method should remove the given entry from the whitelist
59           database.
60
61       $entry = $addrlist->finish ();
62           Clean up, if necessary.  Called by SpamAssassin when it has
63           finished checking, or adding to, the auto-whitelist database.
64
65
66
67perl v5.32.1                      2021M-a0i3l-:2:5SpamAssassin::PersistentAddrList(3)
Impressum