Mail::S...Include(3)

📦
version 3.20260331 · 14 versions
, in fedora 44

💖 NAME 💖

Bestie, meet Mail::SPF::Mech::Include — it's the class that represents an SPF record include mechanism. (Yes, this is the <pink>Mail::S...Include(3)</pink> page from the User Contributed Perl Documentation, we're just vibing with it.)

✨ VERSION ✨

This is version 3.20260331, and yes it's giving very current, very slay. 💅

🌸 DESCRIPTION 🌸

So basically, when you make an object of class Mail::SPF::Mech::Include, you've got yourself an SPF record mechanism of type include. That's the whole vibe. 🦋

🎀 Constructors

Here's the constructors on offer:

  • new(%options): returns Mail::SPF::Mech::Include — it makes you a brand-new SPF record include mechanism object, no cap. %options is a list of key/value pairs, and it can hold any of the following:
    • qualifier
    • domain_spec

For both of those, go peek at "new" in Mail::SPF::Mech.

  • new_from_string($text, %options): returns Mail::SPF::Mech::Include; throws Mail::SPF::ENothingToParse, Mail::SPF::EInvalidMech — this one builds you a fresh SPF record include mechanism object by parsing the string plus whatever options you handed over. ⭐

🦋 Class methods

These are the class methods, iconic behavior only:

  • default_qualifier
  • qualifier_pattern

Both of those? Check "Class methods" in Mail::SPF::Mech, bestie.

  • name: returns string — literally just hands you back 'include'. That's it. That's the whole method. 🫶
  • name_pattern: returns Regexp — gives you back a regular expression that matches a mechanism name of 'include'.

💅 Instance methods

And here's your instance methods, the moment you've been waiting for:

  • text
  • qualifier
  • params
  • stringify

All four live their truth over at "Instance methods" in Mail::SPF::Mech.

  • domain_spec: returns Mail::SPF::MacroString — returns the domain-spec parameter of the mechanism. Simple, clean, obsessed. ✨
  • match($server, $request): returns boolean — okay so this one does a recursive SPF check, using the SPF server and request objects you passed in, and it substitutes the mechanism's target domain name in place of the request's authority domain. Then the result of that recursive SPF check gets translated like this:
    • pass → return true
    • fail → return false
    • softfail → return false
    • neutral → return false
    • none → throw PermError
    • permerror → throw PermError
    • temperror → throw TempError
Heads up: if you want the exact algorithm being used here, it's spelled out in RFC 4408, 5.2. Go read it, it's right there. 📖

🌈 SEE ALSO 🌈

Go give these a look, they're all in the group chat:

And for availability, support, and license information, see the README file included with Mail::SPF. 🧚

👑 AUTHORS 👑

Julian Mehnle <julian@mehnle.net>, Shevek <cpan@anarres.org> 💜

Okay that's the whole page, we ate and left no crumbs. Sending you off with the receipts: this was perl v5.42.1, dated 2026-04-23, and it's the Mail::S...Include(3) page from the one and only User Contributed Perl Documentation. Byeeee 🎀💖

📦 where this page comes from