Provide detailed explanation for SPF result, for "Received-SPF" header

[jcea]

RFC7208 requests that the "Received-SPF" header provides details about the reason the SPF result was what it was. See https://tools.ietf.org/html/rfc7208#section-9.1 . I don't see any API call in pyspf able to provide that kind of detail.

Since I am using pyspf from a MILTER filter and I can add an appropriate "Received-SPF" header to incoming emails, it would be very nice to be able to get the SPF tests details.

Thanks.

[sdgathman]

The mechanism attribute has the mechanism producing the result (e.g. failure). You also get a text diagnostic, e.g.

Received-SPF: PermError (mail.gathman.org: permanent error in processing domain of nextgen.com: Void lookup limit of 2 exceeded) client-ip=2a01:111:f400:fe5b::713; envelope-from="HFAlerts@nextgen.com"; helo=NAM12-BN8-obe.outbound.protection.outlook.com; receiver=mail.gathman.org; x-helo-spf=pass; identity=mailfrom

[sdgathman]

Can the documentation be improved?

[karolyi]

This doesn't seem to be the case with 2.0.14.

[sdgathman]

This doesn't seem to be the case with 2.0.14.

What is not the case?

[karolyi]

Oh, hello. When testing a Permerror (as to why it happened), the original Received-SPF header only contains a (mailfrom) as an explanation, and not the Void lookup limit of 2 exceeded that seems to be a result after investigating more.

That's what I meant.

If you are active on matrix, I'd like to contact you there for some help if you're available, as I don't want to pollute this issue with offtopic stuff here.

[sdgathman]

Example API call from bmsmilter.py:
self.add_header('Received-SPF',q.get_header(q.result,self.receiver,**kv),0)