# SpamBOT

SpamBOT is an automatic email response robot that reports spam email to the SpamCGI. You set SpamBOT up on your mail server either as an address users can forward spam email to and/or a catch address that should never receive email (thus if it does you know it is spam).

It helps to advertise the catcher address on your website with a note telling users not to send email to it, or as an invisible mailto: link. eg:
<a href="mailto:johnsmith@netwin.co.nz"></a>
(as spammers often use web crawlers to harvest email addresses to spam) then simply configure spambot in the catcher style shown below for the above email i.e. "johnsmith@netwin.co.nz"

### Command line options

-version | Prints version number and exits.
-host x | Name/ip of web server running SpamCGI. Default=www.smitespam.com
-smtphost x | Name/ip of SurgeMail. Default=127.0.0.1
-debug | Enables debug logging. (debugging feature)
-port x | Port number for web server running SpamCGI. Default=80
-smtpport x | Port number for SurgeMails SMTP. Default=25
-script x | Script (link to SpamCGI) to POST spam to. Default=/scripts/spamcgi.exe
-email x | Email address to inform SpamCGI is reporting spam. (surgemail registration email address)
-pass x | Password for above email address. (surgemail registration number)
-header | Email header containing CRC. Default=X-Smite-CRC
-notspam | Email is a message that has been wrongly reported as spam. see example.
-save x | Path to save messages that are processed. (debugging feature)
-catcher | Enables catcher style email processing. As opposed to reporter style.

#### Details

The -email and -pass options are required, and MUST be set to a valid account and password. You can signup for an account on smitespam.com here, BUT, an easier way to do it is to simply use your SurgeMail registration email and number as the -email and -pass i.e. if you registered as user@domain.com with number N12345 then you would use "-email user@domain.com -pass N12345"

#### Examples

The examples below are example SurgeMail Global Redirection Rules. (g_redirect). You can set it up in catcher or reporter mode. The only difference between these modes, is that in reporter mode SpamBOT will bounce any reported spam that does not contain the required X-Smite-CRC header back to the reporter. And catcher mode does not do this. This informs them that either the message has not been processed by SmiteCRC or they have reported it in a manner that does not include the header.

Reporter Example
This example is an address users can send email to if they think it is spam.
g_redirect was="spambot@netwin.co.nz" to="|d:\surgemail\spambot.exe -email spambot@netwin.co.nz -pass secret -smtphost netwin.co.nz"

Catcher Example

This example is a catcher. It is an address that is NOT intended to get email so any email it does recieve is considered to be spam.
g_redirect was="johnsmith@netwin.co.nz" to="|d:\surgemail\spambot.exe -email johnsmith@netwin.co.nz -pass secret -catcher"

Notspam Example

This example is an address users can send email if it has been wrongly reported as spam.
g_redirect was="notspam@netwin.co.nz" to="|d:\surgemail\spambot.exe -email johnsmith@netwin.co.nz -pass secret -notspam"