1 ;;; mh-junk.el --- MH-E interface to anti-spam measures
3 ;; Copyright (C) 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
5 ;; Author: Satyaki Das <satyaki@theforce.stanford.edu>,
6 ;; Bill Wohler <wohler@newt.com>
7 ;; Maintainer: Bill Wohler <wohler@newt.com>
8 ;; Keywords: mail, spam
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
29 ;; Spam handling in MH-E.
40 (defun mh-junk-blacklist (range)
41 "Blacklist RANGE as spam.
43 This command trains the spam program in use (see the option
44 `mh-junk-program') with the content of RANGE and then handles the
45 message(s) as specified by the option `mh-junk-disposition'.
47 Check the documentation of `mh-interactive-range' to see how RANGE is
48 read in interactive use.
50 For more information about using your particular spam fighting
53 - `mh-spamassassin-blacklist'
54 - `mh-bogofilter-blacklist'
55 - `mh-spamprobe-blacklist'"
56 (interactive (list (mh-interactive-range "Blacklist")))
57 (let ((blacklist-func (nth 1 (assoc mh-junk-choice mh-junk-function-alist
))))
58 (unless blacklist-func
59 (error "Customize `mh-junk-program' appropriately"))
60 (let ((dest (cond ((null mh-junk-disposition
) nil
)
61 ((equal mh-junk-disposition
"") "+")
62 ((eq (aref mh-junk-disposition
0) ?
+)
64 ((eq (aref mh-junk-disposition
0) ?
@)
65 (concat mh-current-folder
"/"
66 (substring mh-junk-disposition
1)))
67 (t (concat "+" mh-junk-disposition
)))))
68 (mh-iterate-on-range msg range
69 (message "Blacklisting message %d..." msg
)
70 (funcall (symbol-function blacklist-func
) msg
)
71 (message "Blacklisting message %d...done" msg
)
72 (if (not (memq msg mh-seen-list
))
73 (setq mh-seen-list
(cons msg mh-seen-list
)))
75 (mh-refile-a-msg nil
(intern dest
))
76 (mh-delete-a-msg nil
)))
80 (defun mh-junk-whitelist (range)
81 "Whitelist RANGE as ham.
83 This command reclassifies the RANGE as ham if it were incorrectly
84 classified as spam (see the option `mh-junk-program'). It then
85 refiles the message into the \"+inbox\" folder.
87 Check the documentation of `mh-interactive-range' to see how
88 RANGE is read in interactive use."
89 (interactive (list (mh-interactive-range "Whitelist")))
90 (let ((whitelist-func (nth 2 (assoc mh-junk-choice mh-junk-function-alist
))))
91 (unless whitelist-func
92 (error "Customize `mh-junk-program' appropriately"))
93 (mh-iterate-on-range msg range
94 (message "Whitelisting message %d..." msg
)
95 (funcall (symbol-function whitelist-func
) msg
)
96 (message "Whitelisting message %d...done" msg
)
97 (mh-refile-a-msg nil
(intern mh-inbox
)))
102 ;; Spamassassin Interface
104 (defvar mh-spamassassin-executable
(executable-find "spamassassin"))
105 (defvar mh-sa-learn-executable
(executable-find "sa-learn"))
108 (defun mh-spamassassin-blacklist (msg)
109 "Blacklist MSG with SpamAssassin.
111 SpamAssassin is one of the more popular spam filtering programs.
112 Get it from your local distribution or from
113 http://spamassassin.org/.
115 To use SpamAssassin, add the following recipes to
118 MAILDIR=$HOME/`mhparam Path`
120 # Fight spam with SpamAssassin.
124 # Anything with a spam level of 10 or more is junked immediately.
126 * ^X-Spam-Level: ..........
130 * ^X-Spam-Status: Yes
133 If you don't use \"spamc\", use \"spamassassin -P -a\".
135 Note that one of the recipes above throws away messages with a
136 score greater than or equal to 10. Here's how you can determine a
137 value that works best for you.
139 First, run \"spamassassin -t\" on every mail message in your
140 archive and use Gnumeric to verify that the average plus the
141 standard deviation of good mail is under 5, the SpamAssassin
142 default for \"spam\".
144 Using Gnumeric, sort the messages by score and view the messages
145 with the highest score. Determine the score which encompasses all
146 of your interesting messages and add a couple of points to be
147 conservative. Add that many dots to the \"X-Spam-Level:\" header
148 field above to send messages with that score down the drain.
150 In the example above, messages with a score of 5-9 are set aside
151 in the \"+spam\" folder for later review. The major weakness of
152 rules-based filters is a plethora of false positives so it is
155 If SpamAssassin classifies a message incorrectly, or is unsure,
156 you can use the MH-E commands \\[mh-junk-blacklist] and
157 \\[mh-junk-whitelist].
159 The command \\[mh-junk-blacklist] adds a \"blacklist_from\" entry
160 to \"~/spamassassin/user_prefs\", deletes the message, and sends
161 the message to the Razor, so that others might not see this spam.
162 If the \"sa-learn\" command is available, the message is also
163 recategorized as spam.
165 The command \\[mh-junk-whitelist] adds a \"whitelist_from\" rule
166 to the \"~/.spamassassin/user_prefs\" file. If the \"sa-learn\"
167 command is available, the message is also recategorized as ham.
169 Over time, you'll observe that the same host or domain occurs
170 repeatedly in the \"blacklist_from\" entries, so you might think
171 that you could avoid future spam by blacklisting all mail from a
172 particular domain. The utility function
173 `mh-spamassassin-identify-spammers' helps you do precisely that.
174 This function displays a frequency count of the hosts and domains
175 in the \"blacklist_from\" entries from the last blank line in
176 \"~/.spamassassin/user_prefs\" to the end of the file. This
177 information can be used so that you can replace multiple
178 \"blacklist_from\" entries with a single wildcard entry such as:
180 blacklist_from *@*amazingoffersdirect2u.com
182 In versions of SpamAssassin (2.50 and on) that support a Bayesian
183 classifier, \\[mh-junk-blacklist] uses the program \"sa-learn\"
184 to recategorize the message as spam. Neither MH-E, nor
185 SpamAssassin, rebuilds the database after adding words, so you
186 will need to run \"sa-learn --rebuild\" periodically. This can be
187 done by adding the following to your crontab:
189 0 * * * * sa-learn --rebuild > /dev/null 2>&1"
190 (unless mh-spamassassin-executable
191 (error "Unable to find the spamassassin executable"))
192 (let ((current-folder mh-current-folder
)
193 (msg-file (mh-msg-filename msg mh-current-folder
))
196 (message "Reporting message %d..." msg
)
197 (mh-truncate-log-buffer)
198 (call-process mh-spamassassin-executable msg-file mh-log-buffer nil
199 ;;"--report" "--remove-from-whitelist"
200 "-r" "-R") ; spamassassin V2.20
201 (when mh-sa-learn-executable
202 (message "Recategorizing this message as spam...")
203 (call-process mh-sa-learn-executable msg-file mh-log-buffer nil
204 "--single" "--spam" "--local" "--no-rebuild"))
205 (message "Blacklisting message %d..." msg
)
206 (set-buffer (get-buffer-create mh-temp-buffer
))
208 (call-process (expand-file-name mh-scan-prog mh-progs
)
209 nil mh-junk-background nil
210 (format "%s" msg
) current-folder
211 "-format" "%<(mymbox{from})%|%(addr{from})%>")
212 (goto-char (point-min))
213 (if (search-forward-regexp "^\\(.+\\)$" nil t
)
215 (setq sender
(match-string 0))
216 (mh-spamassassin-add-rule "blacklist_from" sender
)
217 (message "Blacklisting message %d...done" msg
))
218 (message "Blacklisting message %d...not done (from my address)" msg
)))))
221 (defun mh-spamassassin-whitelist (msg)
222 "Whitelist MSG with SpamAssassin.
224 The \\[mh-junk-whitelist] command adds a \"whitelist_from\" rule to
225 the \"~/.spamassassin/user_prefs\" file. If the \"sa-learn\" command
226 is available, the message is also recategorized as ham.
228 See `mh-spamassassin-blacklist' for more information."
229 (unless mh-spamassassin-executable
230 (error "Unable to find the spamassassin executable"))
231 (let ((msg-file (mh-msg-filename msg mh-current-folder
))
232 (show-buffer (get-buffer mh-show-buffer
))
235 (set-buffer (get-buffer-create mh-temp-buffer
))
237 (message "Removing spamassassin markup from message...")
238 (call-process mh-spamassassin-executable msg-file mh-temp-buffer nil
240 "-d") ; spamassassin V2.20
242 (kill-buffer show-buffer
))
243 (write-file msg-file
)
244 (when mh-sa-learn-executable
245 (message "Recategorizing this message as ham...")
246 (call-process mh-sa-learn-executable msg-file mh-temp-buffer nil
247 "--single" "--ham" "--local --no-rebuild"))
248 (message "Whitelisting message %d..." msg
)
250 (car (mh-funcall-if-exists
251 ietf-drums-parse-address
(mh-get-header-field "From:"))))
253 (unless (or (null from
) (equal from
""))
254 (mh-spamassassin-add-rule "whitelist_from" from
))
255 (message "Whitelisting message %d...done" msg
))))
257 (defun mh-spamassassin-add-rule (rule body
)
258 "Add a new rule to \"~/.spamassassin/user_prefs\".
259 The name of the rule is RULE and its body is BODY."
260 (save-window-excursion
261 (let* ((line (format "%s\t%s\n" rule body
))
263 (file (expand-file-name "~/.spamassassin/user_prefs"))
264 (buffer-exists (find-buffer-visiting file
)))
266 (if (not (search-forward (format "\n%s" line
) nil t
))
268 (goto-char (point-max))
269 (insert (if (bolp) "" "\n") line
)
271 (if (not buffer-exists
)
272 (kill-buffer nil
)))))
275 (defun mh-spamassassin-identify-spammers ()
276 "Identify spammers who are repeat offenders.
278 This function displays a frequency count of the hosts and domains
279 in the \"blacklist_from\" entries from the last blank line in
280 \"~/.spamassassin/user_prefs\" to the end of the file. This
281 information can be used so that you can replace multiple
282 \"blacklist_from\" entries with a single wildcard entry such as:
284 blacklist_from *@*amazingoffersdirect2u.com"
286 (let* ((file (expand-file-name "~/.spamassassin/user_prefs"))
287 (domains (make-hash-table :test
'equal
)))
289 ;; Only consider entries between last blank line and end of file.
290 (goto-char (1- (point-max)))
291 (search-backward-regexp "^$")
292 ;; Perform frequency count.
294 (while (search-forward-regexp "^blacklist_from\\s-*\\(.*\\)@\\(.*\\)$"
296 (let ((host (match-string 2))
298 ;; Remove top-level-domain from hostname.
299 (setq host
(cdr (reverse (split-string host
"\\."))))
300 ;; Add counts for each host and domain part.
302 (setq value
(gethash (car host
) domains
))
303 (setf (gethash (car host
) domains
) (1+ (if (not value
) 0 value
)))
304 (setq host
(cdr host
))))))
307 (delete-other-windows)
308 (pop-to-buffer (get-buffer-create "*MH-E Spammer Frequencies*"))
310 (maphash '(lambda (key value
) ""
312 (insert (format "%s %s\n" key value
))))
314 (sort-numeric-fields 2 (point-min) (point-max))
315 (reverse-region (point-min) (point-max))
316 (goto-char (point-min))))
320 ;; Bogofilter Interface
322 (defvar mh-bogofilter-executable
(executable-find "bogofilter"))
325 (defun mh-bogofilter-blacklist (msg)
326 "Blacklist MSG with bogofilter.
328 Bogofilter is a Bayesian spam filtering program. Get it from your
329 local distribution or from http://bogofilter.sourceforge.net/.
331 Bogofilter is taught by running:
333 bogofilter -n < good-message
335 on every good message, and
337 bogofilter -s < spam-message
339 on every spam message. This is called a full training; three other
340 training methods are described in the FAQ that is distributed with
341 bogofilter. Note that most Bayesian filters need 1000 to 5000 of each
342 type of message to start doing a good job.
344 To use bogofilter, add the following recipes to \".procmailrc\":
346 MAILDIR=$HOME/`mhparam Path`
348 # Fight spam with bogofilter.
350 | bogofilter -3 -e -p
353 * ^X-Bogosity: Yes, tests=bogofilter
357 * ^X-Bogosity: Unsure, tests=bogofilter
360 If bogofilter classifies a message incorrectly, or is unsure, you can
361 use the MH-E commands \\[mh-junk-blacklist] and \\[mh-junk-whitelist]
362 to update bogofilter's training.
364 The \"Bogofilter FAQ\" suggests that you run the following
365 occasionally to shrink the database:
367 bogoutil -d wordlist.db | bogoutil -l wordlist.db.new
368 mv wordlist.db wordlist.db.prv
369 mv wordlist.db.new wordlist.db
371 The \"Bogofilter tuning HOWTO\" describes how you can fine-tune Bogofilter."
372 (unless mh-bogofilter-executable
373 (error "Unable to find the bogofilter executable"))
374 (let ((msg-file (mh-msg-filename msg mh-current-folder
)))
375 (call-process mh-bogofilter-executable msg-file mh-junk-background
379 (defun mh-bogofilter-whitelist (msg)
380 "Whitelist MSG with bogofilter.
382 See `mh-bogofilter-blacklist' for more information."
383 (unless mh-bogofilter-executable
384 (error "Unable to find the bogofilter executable"))
385 (let ((msg-file (mh-msg-filename msg mh-current-folder
)))
386 (call-process mh-bogofilter-executable msg-file mh-junk-background
391 ;; Spamprobe Interface
393 (defvar mh-spamprobe-executable
(executable-find "spamprobe"))
396 (defun mh-spamprobe-blacklist (msg)
397 "Blacklist MSG with SpamProbe.
399 SpamProbe is a Bayesian spam filtering program. Get it from your local
400 distribution or from http://spamprobe.sourceforge.net.
402 To use SpamProbe, add the following recipes to \".procmailrc\":
404 MAILDIR=$HOME/`mhparam Path`
406 # Fight spam with SpamProbe.
408 SCORE=| spamprobe receive
411 | formail -I \"X-SpamProbe: $SCORE\"
417 If SpamProbe classifies a message incorrectly, you can use the
418 MH-E commands \\[mh-junk-blacklist] and \\[mh-junk-whitelist] to
419 update SpamProbe's training."
420 (unless mh-spamprobe-executable
421 (error "Unable to find the spamprobe executable"))
422 (let ((msg-file (mh-msg-filename msg mh-current-folder
)))
423 (call-process mh-spamprobe-executable msg-file mh-junk-background
427 (defun mh-spamprobe-whitelist (msg)
428 "Whitelist MSG with SpamProbe.
430 See `mh-spamprobe-blacklist' for more information."
431 (unless mh-spamprobe-executable
432 (error "Unable to find the spamprobe executable"))
433 (let ((msg-file (mh-msg-filename msg mh-current-folder
)))
434 (call-process mh-spamprobe-executable msg-file mh-junk-background
440 ;; indent-tabs-mode: nil
441 ;; sentence-end-double-space: nil
444 ;; arch-tag: 603335f1-77ff-4306-8828-5d3dad51abe1
445 ;;; mh-junk.el ends here