[Per Simtel:
1. This program is an e-mail "spam" filter for DOS Waffle systems.
2. Installation directions are found in this file.  All files are ASCII text.
3. This program is "freeware."
4. It may be freely distributed.
5. The author may be contacted via postings to comp.bbs.waffle
   or at nospam@cygnus.wa.com.
]



This file describes the installation of the NoSpam Waffle spam filter.
File nospam.txt describes the basic operation of the filter; this file provides
the basic overview of the filter itself, the source of which is in the text
file nospam.pl.

This software is freeware, offered to demonstrate a concept of a way to
filter unwanted junk e-mail from one's mailbox, based on a platform (Waffle)
whose mailbox file architecture can be handled in a relatively simple way.

Apologies in advance for the poor quality of the documentation; I am not a
manual writer (though this program seems to produce more writer's block than
most).  Questions or problems to comp.bbs.waffle will elicit answers, and
hopefully point the way to better documentation.


Installing NoSpam:

	Warning:  This software is undergoing testing and further development;
	it is being distributed solely for experimental and instructional
	purposes.  Intalling it on a real Waffle account could result in the
	loss of e-mail messages.  No responsibility is assumed by the author
	for such loss.

	Please post useful comments, improvements, bugfixes, etc. to
        comp.bbs.waffle.


NoSpam Requirements:

  Waffle DOS v1.65 installed and running
  Perl 5 installed (www.perl.org, www.perl.com/perl/, www.perl.hip.com)

  Note: This installation description is only for Waffle machines which
  initiate all UUCP calls.

------------------------------------------------------------------------------

In the examples below, items in uppercase are default examples: your system
could be configured differently.


1. In a temporary directory (such as C:\TEMP), unpack this archive:

  C:\TEMP> pkunzip -e nospam.zip


2. Copy NOSPAM.PL to the Waffle bin directory:

  C:\TEMP> copy nospam.pl C:\WAFFLE\BIN


3. Edit the Waffle POLL.BAT file, prepending and appending a line for each
   user for whom the spamfilter is to be installed, saving the file when done.

  C:\TEMP>  edit C:\WAFFLE\BIN\poll.bat

  (the revised file:)
   C:\PERL5\perl \WAFFLE\bin\nospam.pl -nUSER -d
   C:\PERL5\perl \WAFFLE\bin\nospam.pl -nJOHN -d
   C:\PERL5\perl \WAFFLE\bin\nospam.pl -nIAN  -d
   C:\PERL5\perl \WAFFLE\bin\nospam.pl -nJUAN -d
   batch -sNEIGHBOUR
   uucico -S ALL
   BSCAN		(If you use it...)
   uuxqt
   C:\PERL5\perl \WAFFLE\bin\nospam.pl -nUSER -s
   C:\PERL5\perl \WAFFLE\bin\nospam.pl -nJOHN -s
   C:\PERL5\perl \WAFFLE\bin\nospam.pl -nIAN  -s
   C:\PERL5\perl \WAFFLE\bin\nospam.pl -nJUAN -s


4. In each user's directory, unpack a copy of the USERDIR.ZIP file:
  C:\TEMP> cd \USER\JOHN
  C:\USER\JOHN> pkunzip -e C:\TEMP\userdir

------------------------------------------------------------------------------

Additional "tunings" possible in the poll.bat file:


Before outgoing mail is sent, it is searched for possible new recipients
which, if found, are automatically registered.  It is assumed that if you
send e-mail to someone it is okay for them to respond.

  Options applicable to processing outgoing mail:
  nospam -n<login> -d [-o] [-v]
	-n<login>	User's login name. (Required)
	-d		Look for new e-mail destinations.
	-o		Show Option settings.
	-v		Verbose mode (may be helpful if problem arises).


Mailboxes are searched after incoming mail is delivered in order to locate
and divert (or drop) messages from unknown senders.  The -s option is
especially encouraged.

  Options applicable to processing mailbox after incoming e-mail:
  nospam -n<login> [-s] [-p<hours>] [-r<retries>] [-o] [-v]
	-n<login>	User's login name. (Required)
	-s		Save presumed spam in mailbox folder SPAM.
	-r<retries>	Number of retires a probationer gets.
	-o		Show Option settings.
	-v		Verbose mode.

------------------------------------------------------------------------------

Additional information for the user:

The user will find four ASCII text files in his directory, which he is
encouraged to edit.  These are:

  NOSPAM.KEY	is a list of words or phrases, one of which will be randomly
  		selected and sent back to a previously unknown sender.  That
  		sender must respond with e-mail containing that key in the
  		first line, within the timeout period (default: 72 hours), in
  		order to have all subsequent passed through the spamfilter.
  NOSPAM.Mnn	One of these files will be randomly selected to be sent to an
  		unknown sender.  More of these can be created; "%e" will be
  		automatically replaced with the date and time by which the
  		unknown sender must send the key, "%k" will be replaced by the
  		randomly chosen key, and "%u" by the user's e-mail address.
  		More such files can be created.
  NOSPAM.OK	This file is sent when the unknown sender returns the key.


The user will eventually see two other important files appear in his home
directory, NOSPAM.REG and NOSPAM.PRO.

  NOSPAM.REG is a list of addresses, mail from which the spamfilter will
  automatically pass.  If he wants, he can manually add addresses with an
  ASCII editor, one per line. The date and time are only there to tell when
  that address was registered; he may leave that item blank.

  NOSPAM.PRO tells who is currently "on probation"; they have attempted to
  send e-mail but were rejected.  If the sender is to be permanently
  rejected, change the date and time text to "FOREVER".  Warning: tabs in
  this file MUST be preserved.  (Another utility to be written...?)

  Other files will also appear in the directory after nospam.pl has been
  invoked.  Not all files will be present at any one time, and some (the
  temporary files) the user should never see.  These files are:

	mailbox.f         Normal Waffle mailbox file.
	mailbox.i         Index file.
	spam.f            Spam mailbox file (created if -s option is used).
	spam.i            Index file.

	nospam.pro        Probationed senders file created/altered by NoSpam.
	nospam.reg        Registry of approved senders.  Editable by user.
	nospam.key        List of keys.  Editable by user.
	nospam.m00..99    Spamfilter messages. Creatable/editable by user.
	nospam.ok         Spamfilter "approved" message. Editable by user.

	mailspam.bat      Temporary outgoing mail sender batch file.
	mailspam.000..999 Temporary outgoing messages.

	mailbox.bak       Backup mailbox.
	nospam.pr1        Backup probationed senders file.
	nospam.re1        Backup registry.

	mailbox.new       Temporary mailbox.
	nospam.tmp        Temporary working file.

------------------------------------------------------------------------------

end

