mirror of
https://github.com/mailscope/kumomta.git
synced 2026-08-24 13:18:18 +00:00
Wez Furlong
6fc0d782ff
Add a convenience function that is intended to be used around the time that you might be building up the overall set of Authentication-Results. Populate missing smtp.mailfrom in SPF authentication result.
1.1 KiB
1.1 KiB
kumo.spf.check_msg
kumo.spf.check_msg(MESSAGE)
{{since('dev')}}
This function will check SPF records from DNS for the provided message. It will extract the appropriate domain and sender information from the metadata and message.
It will return an object containing the SPF disposition string and a result
of type authenticationresult for use with msg:add_authentication_results().
Example: checking the SPF policy
kumo.on('smtp_server_message_received', function(msg, conn_meta)
-- Check the SPF policy for the domain and return the results.
local result = kumo.spf.check_msg(msg)
print('spf', kumo.json_encode_pretty(result))
if result.disposition ~= 'pass' then
kumo.reject(420, 'go away')
end
end)
might print something like this to the diagnostic log:
spf [
"disposition": "pass",
{
"result": "pass",
"method": "spf",
"reason": "matched 'all' directive",
"method_version": null,
"props": {
"smtp.mailfrom": "sender@example.com"
}
}
]