---
name: "Mail::SPF::Mech::Include"
section: "3pm"
platform: "linux"
package: "perl-mail-spf"
version: "3.20260331-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/Mail::SPF::Mech::Include"
---

# Mail::SPF::Mech::Include(3pm)

SPF record "include" mechanism class

## NAME

Mail::SPF::Mech::Include - SPF record "include" mechanism class

## VERSION

version 3.20260331

## DESCRIPTION

An object of class **Mail::SPF::Mech::Include** represents an SPF record mechanism of type `"include"`.

### Constructors

The following constructors are provided:

- **new(%options)**: returns *Mail::SPF::Mech::Include*

  Creates a new SPF record `"include"` mechanism object.

  `%options` is a list of key/value pairs representing any of the following options:

  - **qualifier**

    - **domain\_spec**

    See "new" in Mail::SPF::Mech.

- **new\_from\_string($text, %options)**: returns *Mail::SPF::Mech::Include*; throws *Mail::SPF::ENothingToParse*, *Mail::SPF::EInvalidMech*

  Creates a new SPF record `"include"` mechanism object by parsing the string and any options given.

### Class methods

The following class methods are provided:

- **default\_qualifier**

  - **qualifier\_pattern**

  See "Class methods" in Mail::SPF::Mech.

- **name**: returns *string*

  Returns **'include'**.

- **name\_pattern**: returns *Regexp*

  Returns a regular expression that matches a mechanism name of **'include'**.

### Instance methods

The following instance methods are provided:

- **text**

  - **qualifier**

  - **params**

  - **stringify**

  See "Instance methods" in Mail::SPF::Mech.

- **domain\_spec**: returns *Mail::SPF::MacroString*

  Returns the `"domain-spec"` parameter of the mechanism.

- **match($server, $request)**: returns *boolean*

  Performs a recursive SPF check using the given SPF server and request objects and substituting the mechanism's target domain name for the request's authority domain.  The result of the recursive SPF check is translated as follows:

  ```
       Recursive result | Effect
      ------------------+-----------------
       pass             | return true
       fail             | return false
       softfail         | return false
       neutral          | return false
       none             | throw PermError
       permerror        | throw PermError
       temperror        | throw TempError
  ```

  See RFC 4408, 5.2, for the exact algorithm used.

## SEE ALSO

Mail::SPF, Mail::SPF::Record, Mail::SPF::Term, Mail::SPF::Mech

\<http://tools.ietf.org/html/rfc4408\>

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

## AUTHORS

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