ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/cvsroot/libspf/patches/Sendmail/README
Revision: 1.1
Committed: Tue Nov 13 00:51:35 2007 UTC (18 years, 11 months ago) by root
Branch: MAIN
CVS Tags: HEAD
Log Message: 
initial import of libspf-1.0.0-p5 from freebsd ports

File Contents

# User Rev Content
1 root 1.1 File: libspf-1.0.0/patches/Sendmail/README
2     Date: 05/28/05
3     Desc: libSPF 1.0 Sendmail patching README documentation
4    
5     First time doing this? Read the Sendmail+libSPF HOWTO available within the
6     structure of the package this README should have come from, or alternatively
7     on-line @ http://libspf.org/HOWTO/sendmail-8.13.1+libspf-1.0-HOWTO.html
8    
9     Problems/Questions/Suggestions -> http://forums.6o4.ca or e-mail Teddy,
10     <teddy@codeshare.ca> or alternatively James Couzens <jcouzens@codeshare.ca>
11     In the best interest of helping you quicker, feel free to CC: me anyways,
12     I'm happy to help!
13    
14     ================================================================================
15    
16     sendmail.cf CONFIG VAR:
17    
18     SPFAction
19    
20     Inside this file place a single digit between 0 and 7.
21    
22     Below describes the behaviour of these digits:
23    
24     0: disabled
25     1: enabled (only prepends headers, and only if spfheaderstate == 1)
26     2: REJECT: fail; ACCEPT: pass, none, fail, error, netural, unknown;
27     3: REJECT: fail, softfail; ACCEPT: pass, none, error, netural, unknown;
28     4: REJECT: fail, softfail, neutral; ACCEPT: pass, none, error, unknown;
29     5: REJECT: fail, softfail, neutral, none; ACCEPT: pass, error, unknown;
30     6: REJECT: fail, softfail, neutral, none, error; ACCEPT: pass, unknown;
31     7: REJECT: fail, softfail, neutral, none, error, unknown; ACCEPT: pass;
32    
33     Chose one of the above error levels that best suits you. I recommend 1.
34    
35     ================================================================================
36    
37     sendmail.cf CONFIG VAR:
38    
39     SPFHeaderState
40    
41     value (single integer):
42    
43     1 (default) = enabled prepending Received-SPF: headers
44     0 = no not prepend headers
45    
46     When set to 1, libspf will pre-pend "Received-SPF:" headers as per the SPF RFC
47     Internet Draft. This are useful for third party applications such as
48     SpamAssassin, and even email clients capable of parsing headers to know where
49     to filter email to.
50    
51     ================================================================================
52    
53     sendmail.cf CONFIG VAR:
54    
55     SPFBestGuess
56    
57     value: (single line of text)
58    
59     default: v=spf1 a/24 mx/24 ptr
60    
61     This query is looked up in an attempt to make a guess against the user in the
62     event no record is found and the trusted forwarder lookup fails. The default
63     value exists within libspf, so creating the sendmail.cf CONFIG VAR is only
64     necessary if you wish to change this value.
65    
66     ================================================================================
67    
68     sendmail.cf CONFIG VAR:
69    
70     SPFBestGuessState
71    
72     value (single integer):
73    
74     1 (default) = perform best guess lookup when all else fails
75     0 = do not perofrm best best guess lookups.
76    
77     When an SPF query fails, and then subsequently a trusted forwarder query
78     possibly fails, libspf will attempt to perform a "best guess" query using a
79     default string which can be redefined using the 'spfguess' sendmail.cf
80     CONFIG VAR. The default value exists within libspf, so creating the
81     sendmail.cf CONFIG VAR is only necessary if you wish to change this value.
82    
83     ================================================================================
84    
85     sendmail.cf CONFIG VAR:
86    
87     SPFExplain
88    
89     value (single line of text)
90    
91     default: See http://spf.pobox.com/why.html?sender=%{S}&ip=%{I}&receiver=%{xR}
92    
93     This string (can include macros) is expanded and sent to the client for every
94     result case excluding pass. The default value exists within libspf, so
95     creating the control file is only necessary if you wish to change this value.
96    
97     ================================================================================
98    
99     sendmail.cf CONFIG VAR:
100    
101     SPFExplainState
102    
103     value (single integer):
104    
105     1 (default) = append explanation
106     0 = do not append explanation
107    
108     When set to 1, explanations will be automatically printed out after any spf
109     query excluding pass. This information is designed to be informative and
110     helpful to a user who has just likely had his or her email rejected. See the
111     above 'spfexplain' to define your own string to use instead. The default value
112     exists within libspf, so creating the sendmail.cf CONFIG VAR is only necessary
113     if you wish to change this value.
114    
115     When set to 0, explanations are not appended.
116    
117     ================================================================================
118    
119     sendmail.cf CONFIG VAR:
120    
121     SPFTrustedForwarder
122    
123     value (single line of text)
124    
125     default: v=spf1 include:spf.trusted-forwarder.org
126    
127     This string (can include macros) is expanded and is used in the event that
128     a connecting client's query results in NONE (no SPF record published). libspf
129     will then (if enabled) attempt to contact trusted-forwarder.org (default)
130     which is a global whitelisting system. You can add additional sites, or provide
131     your own. The default value exists within libspf, so creating the sendmail.cf
132     CONFIG VAR is only necessary if you wish to change this value.
133    
134     ================================================================================
135    
136     sendmail.cf CONFIG VAR:
137    
138     SPFTrustedForwarderState
139    
140     value (single integer):
141    
142     1 (default) = enabled trusted forwarder lookups
143     0 = no not perform trusted forwarder lookups
144    
145     When set to 1, libspf will attempt to contact the site contained within that
146     text, which would be ideally a whitelisting site (anything can really go there,
147     but this particular file is here specifically to handle larger whitelisting
148     services) that would be contacted in the event an SPF query returns NONE.
149     The default value exists within libspf, so creating the sendmail.cf CONFIG VAR
150     is only necessary if you wish to change this value.
151    
152     ================================================================================