Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 1.19 KB

README.md

File metadata and controls

44 lines (29 loc) · 1.19 KB

✉️ spf-check Build Status Coverage Status

Implements RFC4408 Sender Policy Framework (SPF) check_host() validation.

Install

yarn add spf-check

Usage

The stable API returns a string with one of the possible returns.

const spf = require('spf-check');
const result = spf(ip, domain, sender);

if (result === spf.Pass) {
    // Yay!
}

API

This module also exports SPF and SPFResult classes to allow inspect the result and read the expected message.

const validator = new spf.SPF('mediamonks.com', '[email protected]');

validator.check('185.16.22.2').then(result => {
    assert(result instanceof spf.SPFResult);

    if (result.result !== spf.Pass || result.result !== spf.Neutral) {
        console.error(result.message);
    }
});

License

MIT © MediaMonks