Class query

Overrides: object.__init__

(inherited documentation)

Returns (result, mta-status-code, explanation) where result in ['fail', 'softfail', 'neutral' 'permerror', 'pass', 'temperror', 'none']

>>> q.check(spf='v=spf1 redirect=controlledmail.com exp=_exp.controlledmail.com')
('fail', 550, 'SPF fail - not authorized')

>>> q.check(spf='v=spf1 ip4:192.0.0.0/8 ?all moo')
('permerror', 550, 'SPF Permanent Error: Unknown mechanism found: moo')

>>> q.check(spf='v=spf1 =a ?all moo')
('permerror', 550, 'SPF Permanent Error: Unknown qualifier, RFC 4408 para 4.6.1, found in: =a')

>>> q.check(spf='v=spf1 ip4:192.0.0.0/8 ~all')
('pass', 250, 'sender SPF authorized')

>>> q.check(spf='v=spf1 ip4:192.0.0.0/8 -all moo=')
('pass', 250, 'sender SPF authorized')

>>> q.check(spf='v=spf1 ip4:192.0.0.0/8 -all match.sub-domains_9=yes')
('pass', 250, 'sender SPF authorized')

>>> q.strict = False
>>> q.check(spf='v=spf1 ip4:192.0.0.0/8 -all moo')
('permerror', 550, 'SPF Permanent Error: Unknown mechanism found: moo')
>>> q.perm_error.ext
('pass', 250, 'sender SPF authorized')

>>> q.strict = True
>>> q.check(spf='v=spf1 ip4:192.1.0.0/16 moo -all')
('permerror', 550, 'SPF Permanent Error: Unknown mechanism found: moo')

>>> q.check(spf='v=spf1 ip4:192.1.0.0/16 ~all')
('softfail', 250, 'domain owner discourages use of this host')

>>> q.check(spf='v=spf1 -ip4:192.1.0.0/6 ~all')
('fail', 550, 'SPF fail - not authorized')

>>> q.check(spf='v=spf1 ip4:1.2.3.4 -a:example.net -all')
('fail', 550, 'SPF fail - not authorized')
>>> q.libspf_local='ip4:192.0.2.3 a:example.org'
>>> q.check(spf='v=spf1 ip4:1.2.3.4 -a:example.net -all')
('pass', 250, 'sender SPF authorized')

>>> q.check(spf='v=spf1 ip4:1.2.3.4 -all exp=_exp.controlledmail.com')
('fail', 550, 'Controlledmail.com does not send mail from itself.')

>>> q.check(spf='v=spf1 ip4:1.2.3.4 ?all exp=_exp.controlledmail.com')
('neutral', 250, 'access neither permitted nor denied')

Parse and validate a mechanism. Returns mech,m,arg,cidrlength,result

>>> q = query(s='strong-bad@email.example.com',
...           h='mx.example.org', i='192.0.2.3')    
>>> q.validate_mechanism('A')
('A', 'a', 'email.example.com', 32, 'pass')

>>> q.validate_mechanism('?mx:%{d}/27')
('?mx:%{d}/27', 'mx', 'email.example.com', 27, 'neutral')

>>> try: q.validate_mechanism('ip4:1.2.3.4/247')
... except PermError,x: print x
Invalid IP4 CIDR length: ip4:1.2.3.4/247

>>> try: q.validate_mechanism('ip4:1.2.3.4/33')
... except PermError,x: print x
Invalid IP4 CIDR length: ip4:1.2.3.4/33

>>> try: q.validate_mechanism('a:example.com:8080')
... except PermError,x: print x
Invalid domain found (use FQDN): example.com:8080

>>> try: q.validate_mechanism('ip4:1.2.3.444/24')
... except PermError,x: print x
Invalid IP4 address: ip4:1.2.3.444/24

>>> try: q.validate_mechanism('ip4:1.2.03.4/24')
... except PermError,x: print x
Invalid IP4 address: ip4:1.2.03.4/24

>>> try: q.validate_mechanism('-all:3030')
... except PermError,x: print x
Invalid all mechanism format - only qualifier allowed with all: -all:3030

>>> q.validate_mechanism('-mx:%%%_/.Clara.de/27')
('-mx:%%%_/.Clara.de/27', 'mx', '% /.Clara.de', 27, 'fail')

>>> q.validate_mechanism('~exists:%{i}.%{s1}.100/86400.rate.%{d}')
('~exists:%{i}.%{s1}.100/86400.rate.%{d}', 'exists', '192.0.2.3.com.100/86400.rate.email.example.com', 32, 'softfail')

>>> q.validate_mechanism('a:mail.example.com.')
('a:mail.example.com.', 'a', 'mail.example.com', 32, 'pass')

>>> try: q.validate_mechanism('a:mail.example.com,')
... except PermError,x: print x
Do not separate mechnisms with commas: a:mail.example.com,

Test this query information against SPF text.

Do SPF RFC macro expansion.

>>> q.expand('%{d}')
'email.example.com'

>>> q.expand('%{d4}')
'email.example.com'

>>> q.expand('%{d3}')
'email.example.com'

>>> q.expand('%{d2}')
'example.com'

>>> q.expand('%{d1}')
'com'

>>> q.expand('%{p}')
'mx.example.org'

>>> q.expand('%{p2}')
'example.org'

>>> q.expand('%{dr}')
'com.example.email'

>>> q.expand('%{d2r}')
'example.email'

>>> q.expand('%{l}')
'strong-bad'

>>> q.expand('%{l-}')
'strong.bad'

>>> q.expand('%{lr}')
'strong-bad'

>>> q.expand('%{lr-}')
'bad.strong'

>>> q.expand('%{l1r-}')
'strong'

>>> q.expand('%{c}',stripdot=False)
'192.0.2.3'

>>> q.expand('%{r}',stripdot=False)
'example.net'

>>> q.expand('%{ir}.%{v}._spf.%{d2}')
'3.2.0.192.in-addr._spf.example.com'

>>> q.expand('%{lr-}.lp._spf.%{d2}')
'bad.strong.lp._spf.example.com'

>>> q.expand('%{lr-}.lp.%{ir}.%{v}._spf.%{d2}')
'bad.strong.lp.3.2.0.192.in-addr._spf.example.com'

>>> q.expand('%{ir}.%{v}.%{l1r-}.lp._spf.%{d2}')
'3.2.0.192.in-addr.strong.lp._spf.example.com'

>>> try: q.expand('%(ir).%{v}.%{l1r-}.lp._spf.%{d2}')
... except PermError,x: print x
invalid-macro-char : %(ir)

>>> q.expand('%{p2}.trusted-domains.example.net')
'example.org.trusted-domains.example.net'

>>> q.expand('%{p2}.trusted-domains.example.net.')
'example.org.trusted-domains.example.net'

>>> q = query(s='@email.example.com',
...           h='mx.example.org', i='192.0.2.3')
>>> q.p = 'mx.example.org'
>>> q.expand('%{l}')
'postmaster'

DNS query.

If the result is in cache, return that. Otherwise pull the result from DNS, and cache ALL answers, so additional info is available for further queries later.

CNAMEs are followed.

If there is no data, [] is returned.

SAFE2CACHE

Value:

{('A', 'A'): None, ('AAAA', 'AAAA'): None, ('CNAME', 'A'): None, ('CNAME', 'CNAME'): None, ('MX', 'A'): None, ('MX', 'MX'): None, ('PTR', 'PTR'): None, ('SPF', 'SPF'): None, ...