Added spamcop so that it can get translated and hundreds of other
[squirrelmail.git] / plugins / spamcop / README
diff --git a/plugins/spamcop/README b/plugins/spamcop/README
new file mode 100755 (executable)
index 0000000..d0a6e5c
--- /dev/null
@@ -0,0 +1,62 @@
+SpamCop Reporting -- Version 1.5
+
+Helps you identify spam and send a proper message to the correct address to
+SpamCop.  (See http://spamcop.net/ for more information)
+
+
+Features
+========
+
+* Quick one-click interface to report spam via email
+* Alternate, but immediate form-based processing
+
+
+Description
+===========
+
+Tired of getting spam?  SpamCop helps you report it to the proper people.
+It even creates spam reports and will mail them off for you.  All that is
+required to send a spam report is about a few seconds of your time and about
+five clicks.
+
+It is strongly suggested you set up a mail forwarder account and have it
+forwarded to your current mailbox.  Sometimes mail reported with SpamCop
+gets on weird spam mailing lists.  If your happens to get on the list, you
+can then just delete the forwarder and get a new one.  Make sure to use the
+forwarder to sign up for SpamCop and get the required information for the
+plugin.
+
+This plugin is also an example of how to use the identity hooks.  Just open
+up setup.php and read the comments.
+
+
+Future Work
+===========
+
+* Dunno
+
+
+Installation
+============
+
+As with other plugins, just uncompress the archive in the plugins
+directory, go back to the main directory, run configure and add the plugin.
+
+Questions/comments/flames/etc can be sent to the SquirrelMail Plugins list.
+
+
+Changes
+=======
+1.5 - Reworked system to match up with SpamCop changes.  Modified code to
+      keep it up-to-date with current SquirrelMail changes.
+
+1.4 - Added forms-based reporting, thanks to Stefan Sels
+
+1.3 - Fixed table rendition -- added  
+
+1.2 - Added support for the multiple identities in SquirrelMail 1.1.2
+      (not required to use the plugin)
+      
+1.1 - Fixed a stupid bug
+
+1.0 - Initial version