Clarifying a TODO.
[squirrelmail.git] / plugins / spamcop / README
1 SpamCop Reporting
2
3 Helps you identify spam and send a proper message to the correct address to
4 SpamCop. (See http://spamcop.net/ for more information)
5
6
7 Features
8 ========
9
10 * Quick one-click interface to report spam via email
11 * Alternate, but immediate form-based processing
12
13
14 Description
15 ===========
16
17 Tired of getting spam? SpamCop helps you report it to the proper people.
18 It even creates spam reports and will mail them off for you. All that is
19 required to send a spam report is about a few seconds of your time and about
20 five clicks.
21
22 It is strongly suggested you set up a mail forwarder account and have it
23 forwarded to your current mailbox. Sometimes mail reported with SpamCop
24 gets on weird spam mailing lists. If your happens to get on the list, you
25 can then just delete the forwarder and get a new one. Make sure to use the
26 forwarder to sign up for SpamCop and get the required information for the
27 plugin.
28
29
30 Installation
31 ============
32
33 Go back to the main directory, run configure and add the plugin.
34
35
36 API
37 ===
38
39 SquirrelMail hooks used by plugin:
40 * loading_prefs
41 * optpage_register_block
42 * read_body_header_right
43 * compose_send
44
45 Plugin preference keys:
46 * spamcop_enabled
47 * spamcop_delete
48 * spamcop_save
49 * spamcop_method
50 * spamcop_type
51 * spamcop_id