~ubuntu-branches/ubuntu/precise/dspam/precise

« back to all changes in this revision

Viewing changes to doc/pop3filter.txt

  • Committer: Bazaar Package Importer
  • Author(s): Trent Lloyd
  • Date: 2006-03-21 07:23:12 UTC
  • Revision ID: james.westby@ubuntu.com-20060321072312-jba9a1avit4r1y6s
Tags: upstream-3.6.4
ImportĀ upstreamĀ versionĀ 3.6.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
$Id: pop3filter.txt,v 1.1 2005/03/11 21:16:03 jonz Exp $
 
2
 
 
3
POP3FILTER INTEGRATION
 
4
 
 
5
Please follow the instructions in the README for building DSPAM. Once DSPAM
 
6
has been built, the following instructions may be used to integrate it with
 
7
pop3filter.
 
8
 
 
9
pop3filter is an open-source POP3 proxy tool which can be used to provide
 
10
spam filtering without the need for inbound mail server integration.  The
 
11
software is configured to run as a "proxy"; that is, users are directed to
 
12
check their email using the proxy's ip address (or are transparently
 
13
redirected there) at which point the proxy will open up a connection to
 
14
the mail server and filter mail as it is being downloaded by the user.
 
15
 
 
16
pop3filter can be downloaded from http://pop3filter.sourceforge.net/.
 
17
 
 
18
The easiest way to set up pop3filter is to have it call DSPAM using the
 
19
--stdout command, at which point DSPAM will check the message and return
 
20
it with X-DSPAM headers identifying the message as spam or innocent.  To
 
21
do this, follow these steps:
 
22
 
 
23
1. Compile and install pop3filter
 
24
2. Compile and install DSPAM on the same machine
 
25
 
 
26
   You may optionally wish to the spamSubject and spamAction=tag preferences
 
27
   so that a tag will be prepended to the subject header of messages
 
28
   suspected to be spam.
 
29
 
 
30
3. Configure pop3filter to run as follows:
 
31
 
 
32
 pop3filter --fork [mail server IP] 110 110 "/usr/local/bin/dspam --user \
 
33
  \$POP3_USERNAME --stdout --deliver=innocent,spam "
 
34
 
 
35
a full blown example would look like:
 
36
 
 
37
 pop3filter --fork 10.0.0.1 110 110 "/usr/local/bin/dspam --user \
 
38
  \$POP3_USERNAME --stdout --deliver=innocent,spam"
 
39
 
 
40
The POP3_USERNAME variable will be automatically replaced with the username
 
41
provided by the client at connect time.
 
42
 
 
43
Mail will then be checked by DSPAM and an X-DSPAM-Result field will be
 
44
appended to the message headers identifying the classification of the
 
45
message.
 
46