home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / shackos2.zip / blamspam.doc < prev    next >
Text File  |  1997-05-21  |  9KB  |  179 lines
  1.  
  2.                =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  3.                               BlamSpam Version 1.0
  4.                         InnoVal Systems Solutions, Inc.
  5.                                   May 5, 1997
  6.           -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  7.  
  8.      BlamSpam is a Spam Filter (or Twit Filter) for use with Hacksaw.  It
  9.      will blow away the spam messages, right on your POP3 server, before
  10.      your regular email program has to deal with them.  By default, it goes
  11.      to the POP3 account specified in the HACKSAW.INI file, every 15
  12.      minutes, compares all the mail against the entries in the BlamSpam.Cfg
  13.      file, finds any and all matches, and deletes the matching messages
  14.      from the POP3 server.
  15.  
  16.      If executed with a /F:d:\dirname\filename.ext parameter, the matching
  17.      messages will be stored in that file before they're deleted from the
  18.      POP3 server, so that you can doublecheck them yourself, later.  If
  19.      d:\dirname\filename.ext is an existing file, the new messages will be
  20.      appended to the end of it rather than overwriting it.
  21.  
  22.                =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  23.                              The BLAMSPAM.CFG File
  24.           -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  25.  
  26.      A sample BlamSpam.Cfg file is included, which contains entries for
  27.      many internet addresses that are known to send spam messages.
  28.  
  29.      Blank lines, and lines which begin with /* are ignored.
  30.  
  31.      There are two other types of lines in a BlamSpam.Cfg file:
  32.  
  33.      The only required lines in this file are the lines which tell the
  34.      program which messages to delete.  Each of these lines contains a
  35.      single search string, which can be the author's email address, a word
  36.      or phrase in the subject line, or even a string of text from the body
  37.      of the message.  Choose a string which will appear in the messages you
  38.      want deleted but which will not ever, under any circumstances, appear
  39.      in the applicable part(s) of any other messages.
  40.  
  41.      If you don't tell it otherwise, the program will find these strings in
  42.      any message header line (which, by definition, means any line before
  43.      the first blank line of the message) but not in any of the message
  44.      body text (past the first blank line, which is the divider between the
  45.      headers and the body of the message).  If you need to make the program
  46.      search the message body text as well as (or instead of) the header
  47.      lines, or if you need to make it search only certain ones of the
  48.      header lines instead of all of them, you can do that, too, using a
  49.      HEADERLINES parameter.
  50.  
  51.      To make the program apply a HEADERLINES parameter to one single line
  52.      of the BlamSpam.Cfg file, you can put it on that same line of the
  53.      file, after a <TAB> character.  For example:
  54.  
  55.         spamco.com<TAB>From:
  56.  
  57.      This example would kill all the messages with "spamco.com" in the
  58.      From: header, but no messages with that string in the Subject: header
  59.      or anywhere else in the message.
  60.  
  61.      In order for that to work, you must create the BlamSpam.Cfg file with
  62.      a text editor which actually places <TAB> characters into the file,
  63.      rather than converting them to a certain number of spaces the way so
  64.      many text editors do!  OS/2's E.EXE and Windows's NOTEPAD.EXE, for
  65.      example, are both safe for this purpose.
  66.  
  67.      In order to make a HEADERLINES parameter apply to all subsequent lines
  68.      of the BlamSpam.Cfg file instead of only the one line, you insert a
  69.      line such as this one:
  70.  
  71.         <headerlines>=From:
  72.  
  73.      before the first of the lines to which you want it to apply.  That is
  74.      the third possible type of line in a BlamSpam.Cfg file.  It will
  75.      change the HEADERLINES parameter for all BlamSpam.Cfg lines below it,
  76.      until the next <headerlines>= line in the file (if any).  Except, of
  77.      course, for any lines which have their own HEADERLINES parameters
  78.      (that is, a <TAB> character and another string, following the search
  79.      string).  A HEADERLINES parameter on a search string line overrides
  80.      whatever global HEADERLINES parameter default is in effect in that
  81.      part of the BlamSpam.Cfg file.
  82.  
  83.      The reason the default behavior of BlamSpam is to look for matches in
  84.      all the header lines and none of the message body text, is because the
  85.      default HEADERLINES value is NOBODY.  NOBODY means not to search the
  86.      body text, just the header lines.
  87.  
  88.      Another valid value for HEADERLINES is ENTIRE.  This means that the
  89.      entire message will be searched:  The header lines and the message
  90.      body text.
  91.  
  92.      The other possible values for HEADERLINES are MSGTEXT which means just
  93.      the message body text and no header lines; or any valid internet
  94.      message header tag such as TO, FROM, SUBJECT, X-MAILER, REPLY-TO,
  95.      RECEIVED, etc.  These must be spelled the same way as they are spelled
  96.      in the headers of the messages, though they're case insensitive and
  97.      the colon is optional. That is, the program will treat "FROM:" and
  98.      "From:" and "FrOm" and "from" identically.
  99.  
  100.      Except for NOBODY and ENTIRE, all other possible HEADERLINES values
  101.      can be combined, using spaces or commas.  For example, you can say
  102.      "FROM,REPLY-TO" or "REPLY-TO FROM" to have the program search only
  103.      both of those header lines in each of the messages.
  104.  
  105.      Remember, when using the ENTIRE or MSGTEXT value for the HEADERLINES
  106.      parameter, keep the search string as short as possible.  If the string
  107.      is more than one word long, it can occur with a carriage return in the
  108.      middle of it instead of a space, in which case the program will not
  109.      recognize it as a match!  If the string is only one word long, then
  110.      the only way it can be missed is if it's hyphenated and split across
  111.      two lines of the message.
  112.  
  113.                =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  114.                            Example BLAMSPAM.CFG File
  115.           -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  116.  
  117.      spamco@isp.com
  118.      Spamco<TAB>Sender: Reply-To:
  119.      Spamco, Inc.<TAB>subject,msgtext
  120.      <headerlines>=msgtext
  121.      Spamco Product Name
  122.      111.222.333.444<TAB>Received
  123.      foul language<TAB>entire
  124.      4letterword
  125.      spamco2@elsewhere.com<TAB>NoBody
  126.  
  127.      Since NOBODY is the default HEADERLINES parameter value, the program
  128.      will search only the header lines, and not the message body text, for
  129.      spamco@isp.com.  It will search for Spamco in only the Sender: and
  130.      Reply-to: header lines.  It will search only the Subject: header line
  131.      and all of the message body text for Spamco, Inc.  The next line,
  132.      <headerlines>=msgtext, causes the default HEADERLINES parameter to be
  133.      changed from NOBODY to MSGTEXT for all future entries which don't have
  134.      their own HEADERLINES parameter on them.  So the phrase "Spamco
  135.      Product Name" will be searched for only in the message body text, not
  136.      in any header lines.  The same will be true for the word 4letterword.
  137.      The IP address 111.222.333.444 will be searched in only the Received:
  138.      lines, and the phrase "foul language" will be searched for in all
  139.      header lines and the message body text as well.  Finally,
  140.      spamco2@elsewhere.com will be searched for in all the header lines but
  141.      not the message body text.  The only reason the NOBODY parameter is
  142.      needed there is because the global default had been changed from
  143.      NOBODY to MSGTEXT by the earlier <headerlines>= line of the file.
  144.  
  145.                =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  146.                              Further Customization
  147.           -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  148.  
  149.      1.  For use with multiple POP3 accounts:
  150.  
  151.      Specify HOST(), USERID(), and PASSWORD() arguments, on BlamSpam's
  152.      command line just as you would on Hacksaw's.  If you use a BlamSpam
  153.      /F:filename.ext parameter, it must come before these other arguments
  154.      on BlamSpam's command line.  The program will exit as soon as it's
  155.      done, instead of waiting 15 minutes and starting over.  So you will
  156.      want to run it from a batch file or REXX program which runs a BlamSpam
  157.      command for one account, a BlamSpam command for the next account,
  158.      etc., and then waits 15 minutes (or however long you like) and starts
  159.      over, since BlamSpam won't do that itself when those other arguments
  160.      are used.
  161.  
  162.      2.  To change the frequency with which the program checks the mail:
  163.  
  164.      Just edit the INTERVAL=900 line of the program file, to change the
  165.      number of seconds to whatever you prefer.
  166.  
  167.      Or if you want the program to just do its thing once and exit rather
  168.      than sleeping for a certain length of time and starting over, then
  169.      feed it HOST(), USERID(), and PASSWORD() arguments and that's what it
  170.      will do.
  171.  
  172.      3.  PORT() argument:
  173.  
  174.      If you need to use Hacksaw's PORT() argument, you'll need to specify
  175.      it on BlamSpam's command line as well.  If you use a BlamSpam
  176.      /F:filename.ext parameter, it must come before the PORT() argument on
  177.      BlamSpam's command line.
  178.  
  179.