README

 Spamcup - A tool for automatic Spamcop reporting
 ------------------------------------------------

WEBSITE:

 http://sourceforge.net/projects/spamcup/


THE THING:

 Everybody receives spam, but most of us don't know what to do to 
 spam. Well, deleting it does not count.

 Spamcop is a great tool to report spam to spammer's ISP. However if you 
 receive lot's of spam it's very slow to report them all even with help 
 of Spamcop.

 To speed up using Spamcop I wrote the Spamcup - a tool for automating 
 Spamcop reports.

 The script does basicly the same that you would do when you report spam 
 with  your browser in Spamcop.net.

 So, this script does not send mail to Spamcop or to 
 spammers. This just fetches few HTML pages from Spamcop website.


DISCLAIMER:

  The script does NOT know where the spam report will be sent so
   IT'S YOUR RESPONSIBILITY!

  If the script asks spamcop to send reports to wrong places
   IT'S YOUR FAULT!

  If the script has a bug that causes same report being sent thousand times
   IT'S YOUR MAIL ADDRESSES!

  DO NOT USE THIS SCRIPT IF YOU DON'T UNDERSTAND WHAT IT DOES!
   IT'S YOUR SHAME!

  And finally: If Spamcop does not like this kind of scripts they may
  deactivate your account. Use with your own risk. However this script
  is not supposed to do any harm to Spamcop as this works just like
  any regular web browser from Spamcop's point of view.


USAGE:

Usage: ./spamcup.pl [options] <Spamcop-Username>
 
 ./spamcup.pl <options> <Spamcop-Username>
 
 Options:
  -n Does nothing, just shows if you have unreported spam or not.
  -a Run in a loop untill all spam is reported.
  -s Stupid. Runs without asking confirmation. Use with care.
  -q Be quiet.
  -c Alternate method for signifying code. (Unpaid users WITHOUT username & password)
  -l Alternate method for providing username. (Paid & unpaid users with password)
  -p Method for providing password. (Required for users with password)
  -d Debug mode. Prints all kinds of funny things.
  -D Even more debug mode. Dumps also HTML.
  -v Show version and quit.
  -h You are reading it.
 

 By default the script confirms every spam its about to report. 
 With option -s it does not ask for confirmation.

 You can combine one or more options. You MUST put options before the code.

 Example:
./spamcup.pl -as -p YourPassword your@emailaddress.com.invalid



CONFIGURATION FILE:

 As of version 1.05, the Spamcup script has a support for optional
 configuration file. When using configuration file you don't need to
 provide command line options anymore.

 The file is called '.spamcup', and should be located in the user's home 
 directory. The configuration file should contain something like this:

  # Options:
  -a
 
  # Your spamcop.net code:
  YOURCODEGOESHERE

 You can add any options you like. Lines starting with # are comments.
 The code must be in the last line followed by linefeed.


LATEST VERSION:

You'll find the latest version of the software always from here:

 http://sourceforge.net/projects/spamcup/



BUGS and FEATURE REQUESTS:

 Report bugs and feature requests to Spamcup's bug tracker in the website!
                                               ===========================


AUTHOR:

 Toni Willberg <toniw@iki.fi> http://toniw.iki.fi/


LICENCE:

 GPL.
