source: trunk/xmspamc/readme-en.txt @ 3

Revision 3, 3.8 KB checked in by oki, 3 years ago (diff)
Line 
1////////////////////////////////////////////
2/// SpamAssassin Filter for XMailServer  ///
3////////////////////////////////////////////
4
5This document is written "2008-01-16".
6
7    please contact blade2001jp@ybb.ne.jp
8
9  http://www.hunes.co.jp/oki/trac/xmspamc/
10
11** Introduction
12
13  This filter had written based on SpamAssassin-3.0.2's spamc.c.
14  Why spamc base? Because spamassassin command costs is too high.
15
16  xmspamc.exe (windows platform) work well
17        XMailServer-1.21, 1.22, 1.23, 1.24
18        SpamAssassin-3.0.2, 3.0.3, 3.0.4, 3.1.7, 3.1.8, 3.2.3, 3.2.4
19
20  This filter may be work other platforms, building xmspamc.c .
21  But only _splitpath in xmspamc.c may be need to fix.
22  To build xmspamc.exe rewrite "makefile" spamc -> xmspamc.
23
24
25** IMPORTANT
26
27  >>>  Please use this own risk!  <<<
28
29  This project is not Apache.
30
31
32** HISTORY
33
34ver 0.11
35 2005/01/13 FIX bug -b option always enabled.
36ver 0.12
37 2005/01/23 FIX unmuch perl path between this document and spamd.bat.
38ver 0.2
39 2005/08/20 FIX miss comment on spamd.bat.
40 2005/08/20 FIX bug change filter result code 5 to 4
41                (change "reject and spool" to "reject without spool")
42 2005/08/20 FIX report_safe = 0 is no longer needed on local.cf
43 2005/08/24 FIX modify last few bytes of LF code to CR+LF code.
44                (i don't know why. but some mailer causes a timeout error)
45 2005/08/26 stable release
46ver 0.21
47 2005/08/31 ADD -P option.
48var 0.22
49 2005/11/01 FIX 0.21 bug (no effects -D option. always rejected)
50
51** xmspamc.exe
52
53SpamAssassin Client Filter ver 0.22 for XMailServer
54  based on spamc 3.0.2 mixed spamc 3.0.4
55
56Usage: xmspamc [@@FILE] [tempdir] [options]
57
58Options:
59  -d host             Specify host to connect to.
60                      [default: localhost]
61  -H                  Randomize IP addresses for the looked-up
62                      hostname.
63  -p port             Specify port for connection to spamd.
64                      [default: 783]
65  -t timeout          Timeout in seconds for communications to
66                      spamd. [default: 600]
67  -s size             Specify maximum message size, in k-bytes.
68                      [default: 250k]
69  -u username         User for spamd to process this message under.
70                      [default: current user]
71  -x                  Don't fallback safely.
72  -l                  Log errors and warnings to stderr.
73  -D remove_score     Spam Score that reject and remove mail.
74                      [default:11.0]
75  -b                  Reject on error EX_TOOBIG and filterd IS_SPAM.
76                      [default accept mail]
77  -h                  Print this help message and exit.
78  -V                  Print xmspamc version and exit.
79  -P spool            Spool specification. 0 = without spool, 1 = spool
80                      [default: 0]
81
82===========================================================================
83  @@FILE is XMailServerFilter parameter.
84
85  tempdir  is temporary directory.
86
87  On -s option. Large value will be looks like hung up. Therefore,
88  we will recommend the thing operated by 250k byte of an initial value.
89
90  Default size is 250k. so large mail pass through by default. -b option
91  is filter to SpamAssassin a part of mail. and reject mail when judged spam.
92
93  If you won't reject any mail, set -D score higher. (eg: -D 9999.0)
94
95== howto run spamd on windows?
96
97Visit
98http://sawin32.sourceforge.net/
99
100
101== spamassassin.tab
102  this is sample of xmspamc's filter.tab for XMailServer.
103please change "Path_to_spamc" to full path of
104xmspamc.exe. and change "Path_to_tempdir" to your temporary directory.
105
106 add xmail/MailRoot/filters.in.tab below
107
108"*"     "*"     "0.0.0.0/0"     "0.0.0.0/0"     spamassassin.tab
109
110and copy spamassassin.tab to xmail/MailRoot/filters folder.
111
Note: See TracBrowser for help on using the repository browser.