DOKK / manpages / debian 12 / mtpolicyd / Mail::MtPolicyd::Plugin::SPF.3pm.en
Mail::MtPolicyd::Plugin::SPF(3pm) User Contributed Perl Documentation Mail::MtPolicyd::Plugin::SPF(3pm)

Mail::MtPolicyd::Plugin::SPF - mtpolicyd plugin to apply SPF checks

version 2.05

This plugin applies Sender Policy Framework(SPF) checks.

Checks are implemented using the Mail::SPF perl module.

Actions based on the SPF result can be applied for:

For status 'neutral' no action or score is applied.

(uc_)enabled (default: on)
Enable/disable the plugin.
(uc_)pass_mode (default: passive)
How to behave if the SPF checks passed successfully:
Just apply score. Do not return an action.
Will return an 'dunno' action.
Score to apply when the sender has been successfully checked against SPF.
(uc_)softfail_mode (default: passive)
How to behave if the SPF checks returned a softfail status.
Just apply score. Do not return an action.
Will return an 'dunno' action.
Return an reject action.
Score to apply when the SPF check returns an softfail status.
(uc_)fail_mode (default: reject)
Return an reject action.
Just apply score and do not return an action.
Action to apply on a temperror SPF result.

Possible values: passive, dunno, defer, reject

Score to apply on a temperror SPF result.

By default no score is applied.

Action to apply on a permerror SPF result.

Possible values: passive, dunno, defer, reject

Score to apply on a permerror SPF result.

By default no score is applied.

If fail_mode is set to 'reject' this message is used in the reject.

The following pattern will be replaced in the string:

%LOCAL_EXPL%
Will be replaced with a (local) explanation of the check result.
%AUTH_EXPL%
Will be replaced with a URL to the explanation of the result.

This URL could be configured with 'default_authority_explanation'.

Score to apply if the sender failed the SPF checks.
String to return as an URL pointing to an explanation of the SPF check result.

See Mail::SPF::Server for details.

An hostname to show in the default_authority_explanation as generating server.
A comma separated list of IP addresses to skip.
Set to 'off' to disable SPF check on helo.
Maximum number of terms using DNS lookup in a SPF record to evaluate.

Exceeding this limit will cause a permanent error as specified by RFC7208.

The default of 10 is also specified in by RFC7208.

Maximum number of DNS lookups per SPF term.
Maximum number of void DNS lookups.

  <Plugin spf>
    module = "SPF"
    pass_mode = passive
    pass_score = -10
    fail_mode = reject
    #fail_score = 10
  </Plugin>

Mail::SPF, OpenSPF "" in www.openspf.org, RFC 7208 <https://tools.ietf.org/html/rfc7208>

Markus Benning <ich@markusbenning.de>

This software is Copyright (c) 2014 by Markus Benning <ich@markusbenning.de>.

This is free software, licensed under:

  The GNU General Public License, Version 2, June 1991
2022-10-15 perl v5.34.0