1Mail::SpamAssassin::PerUssiesrteCnotnAtdrdirbLuitsetdM(a3Pi)elr:l:SDpoacmuAmsesnatsastiino:n:PersistentAddrList(3)
2
3
4
6 Mail::SpamAssassin::PersistentAddrList - persistent address list base
7 class
8
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
21 All persistent address list implementations, used by the auto-
22 welcomelist code to track known-good email addresses, use this as a
23 base class.
24
25 See "Mail::SpamAssassin::DBBasedAddrList" for an example.
26
28 $factory = PersistentAddrListSubclass->new();
29 This creates a factory object, which SpamAssassin will call to
30 create a new checker object for the persistent address list.
31
32 my $addrlist = $factory->new_checker();
33 Create a new address-list checker object from the factory. Called
34 by the SpamAssassin classes.
35
36 $entry = $addrlist->get_addr_entry ($addr);
37 Given an email address $addr, return an entry object with the
38 details of that address.
39
40 The entry object is a reference to a hash, which must contain at
41 least two keys: "count", which is the count of times that address
42 has been encountered before; and "totscore", which is the total of
43 all scores for messages associated with that address. From these
44 two fields, an average score will be calculated, and the score for
45 the current message will be regressed towards that mean message
46 score.
47
48 The hash can contain whatever other data your back-end needs to
49 store, under other keys.
50
51 The method should never return "undef", or a hash that does not
52 contain a "count" key and a "totscore" key.
53
54 $entry = $addrlist->add_score($entry, $score);
55 This method should add the given score to the welcomelist database
56 for the given entry, and then return the new entry.
57
58 $entry = $addrlist->remove_entry ($entry);
59 This method should remove the given entry from the welcomelist
60 database.
61
62 $entry = $addrlist->finish ();
63 Clean up, if necessary. Called by SpamAssassin when it has
64 finished checking, or adding to, the auto-welcomelist database.
65
66
67
68perl v5.36.0 2023M-a0i1l-:2:1SpamAssassin::PersistentAddrList(3)