Mail::DKIM::Policy(3)

💖 Mail::DKIM::Policy 💖

okay bestie, welcome to the Mail::DKIM::Policy(3) page from the User Contributed Perl Documentation. This is literally the abstract base class for originator "signing" policies, and it's giving main character energy for the whole policy situation. 🫶

🎀 VERSION 🎀

version 1.20240923 ✨

💅 SYNOPSIS 💅

  # get all policies that apply to a verified message
  foreach my $policy ($dkim->policies)
  {

      # the name of this policy
      my $name = $policy->name;

      # the location in DNS where this policy was found
      my $location = $policy->location;

      # apply this policy to the message being verified
      my $result = $policy->apply($dkim);

  }

🦋 DESCRIPTION 🦋

So between the various versions of the DomainKeys/DKIM standards, several different forms of sender "signing" policies have been defined. Iconic, honestly. In order for the Mail::DKIM library to support these different policies, it uses several different subclasses. All subclasses support this general interface, so that a program using Mail::DKIM can support any and all policies found for a message. no cap, that's the whole vibe. 💫

🌸 METHODS 🌸

These methods are supported by all classes implementing the Mail::DKIM::Policy interface. periodt. 💅

💖 apply() 💖

Apply the policy to the results of a DKIM verifier.

my $result = $policy->apply($dkim_verifier);

The caller must provide an instance of Mail::DKIM::Verifier, one which has already been fed the message being verified. Important bestie: it's gotta be that verifier, already fed the message.

Possible results are:

• accept — the message is approved by the sender signing policy. ✅
• reject — the message is rejected by the sender signing policy. ❌
• neutral — the message is neither approved nor rejected by the sender signing policy. It can be considered suspicious. 👀

🎀 as_string() 🎀

The policy as a string.

Note that the string returned by this method will not necessarily have the tags ordered the same as the text record found in DNS. iykyk — don't assume the tag order matches DNS, fr fr.

💜 is_implied_default_policy() 💜

Is this policy implied?

my $is_implied = $policy->is_implied_default_policy;

If you fetch the policy for a particular domain, but that domain does not have a policy published, then the default policy is in effect. Use this method to detect when that happens. detective mode: activated 🕵️‍♀️

🌈 location() 🌈

Where the policy was fetched from.

This is generally a domain name, the domain name where the policy was published.

If nothing is published for the domain, and the default policy was returned instead, the location will be undef. yep, undef — not a domain, bestie.

⭐ name() ⭐

Identify what type of policy this is.

This currently returns strings like sender, author, and ADSP. It is subject to change in the next version of Mail::DKIM. so cute, so subject to change. 💀

👑 SEE ALSO 👑

• Mail::DKIM::DkPolicy — for RFC4870(historical) DomainKeys sender signing policies
• Mail::DKIM::DkimPolicy — for early draft DKIM sender signing policies
• Mail::DKIM::AuthorDomainPolicy — for Author Domain Signing Practices (ADSP)

🫶 AUTHORS 🫶

• Jason Long <jason@long.name>
• Marc Bradshaw <marc@marcbradshaw.net>
• Bron Gondwana <brong@fastmailteam.com> (ARC)

🌟 THANKS 🌟

Work on ensuring that this module passes the ARC test suite was generously sponsored by Valimail (https://www.valimail.com/). sponsor slay! 🎉

💌 COPYRIGHT AND LICENSE 💌

• Copyright (C) 2013 by Messiah College
• Copyright (C) 2010 by Jason Long
• Copyright (C) 2017 by Standcore LLC
• Copyright (C) 2020 by FastMail Pty Ltd

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.6 or, at your option, any later version of Perl 5 you may have available.

---

mwah 💋 — this page is from perl v5.42.0, dated 2024-09-23, and it's Mail::DKIM::Policy(3). periodt. 🫶