cgit.sxemacs.org Git - gnus/blob - lisp/spam-stat.el

   1 ;;; spam-stat.el --- detecting spam based on statistics
   2
   3 ;; Copyright (C) 2002-2015 Free Software Foundation, Inc.
   4
   5 ;; Author: Alex Schroeder <alex@gnu.org>
   6 ;; Keywords: network
   7 ;; URL: http://www.emacswiki.org/cgi-bin/wiki.pl?SpamStat
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software: you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation, either version 3 of the License, or
  14 ;; (at your option) any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 ;;; Commentary:
  25
  26 ;; This implements spam analysis according to Paul Graham in "A Plan
  27 ;; for Spam".  The basis for all this is a statistical distribution of
  28 ;; words for your spam and non-spam mails.  We need this information
  29 ;; in a hash-table so that the analysis can use the information when
  30 ;; looking at your mails.  Therefore, before you begin, you need tons
  31 ;; of mails (Graham uses 4000 non-spam and 4000 spam mails for his
  32 ;; experiments).
  33 ;;
  34 ;; The main interface to using spam-stat, are the following functions:
  35 ;;
  36 ;; `spam-stat-buffer-is-spam' -- called in a buffer, that buffer is
  37 ;; considered to be a new spam mail; use this for new mail that has
  38 ;; not been processed before
  39 ;;
  40 ;; `spam-stat-buffer-is-non-spam' -- called in a buffer, that buffer
  41 ;; is considered to be a new non-spam mail; use this for new mail that
  42 ;; has not been processed before
  43 ;;
  44 ;; `spam-stat-buffer-change-to-spam' -- called in a buffer, that
  45 ;; buffer is no longer considered to be normal mail but spam; use this
  46 ;; to change the status of a mail that has already been processed as
  47 ;; non-spam
  48 ;;
  49 ;; `spam-stat-buffer-change-to-non-spam' -- called in a buffer, that
  50 ;; buffer is no longer considered to be spam but normal mail; use this
  51 ;; to change the status of a mail that has already been processed as
  52 ;; spam
  53 ;;
  54 ;; `spam-stat-save' -- save the hash table to the file; the filename
  55 ;; used is stored in the variable `spam-stat-file'
  56 ;;