mika56/spfcheck

Checks an IP address against a domain's SPF record

PHP-SPF-Check

, _(*1)

Simple library to check an IP address against a domain's SPF record, _(*2)

Requirements

This library requires a supported version of PHP, that is PHP >= 8.1., _(*3)

Older versions of this library support older versions of PHP. Please note that no bugfixes, no new features, and no support will be provided for older versions., _(*4)

Installation

This library is available through Composer. Run composer require "mika56/spfcheck:^3.0" or add this to your composer.json:, _(*5)

{
  "require": {
    "mika56/spfcheck": "^3.0"
  }
}

Usage

Create a new instance of SPFCheck. The constructor requires a DNSRecordGetterInterface to be passed. Included in this library is DNSRecordGetter, which uses PHP's DNS function dns_get_record to get data. Please take a look at mika56/spfcheck-dns-direct if you want to use custom DNS servers., _(*6)

<?php
use Mika56\SPFCheck\DNS\DNSRecordGetter;
use Mika56\SPFCheck\SPFCheck;

require('vendor/autoload.php');

$checker = new SPFCheck(new DNSRecordGetter());
var_dump($checker->getIPStringResult('127.0.0.1', 'test.com'));

Return value is one of Result::SHORT_PASS, Result::SHORT_FAIL, Result::SHORT_SOFTFAIL, Result::SHORT_NEUTRAL, Result::SHORT_NONE, Result::SHORT_PERMERROR, Result::SHORT_TEMPERROR, _(*7)

If you want to get more details about the check, you can use SPFCheck::getResult(Query $query): Result which will return a Result object with more details about the check., _(*8)