pboyd04 / spf-parse

:email: Parse SPF (sender policy framework) records

spf-parse

Parse SPF records into their constituent parts. Note that this module does no network lookups. It only validates and parses SPF syntax.

Install

npm install --save spf-parse

Usage

const spf = require('spf-parse');

let records = spf('v=spf1 include:some.sender.org -all');

// {
//    mechanisms: [
//       {
//          prefix: 'v',
//          type: 'version',
//          description: 'The SPF record version',
//          value: 'spf1'
//       },
//       {
//          prefix: '+',
//          prefixdesc: 'Pass',
//          type: 'include',
//          description: 'The specified domain is searched for an \'allow\'',
//          value: 'some.sender.org'
//       },
//       {
//          prefix: '-',
//          prefixdesc: 'Fail',
//          type: 'all',
//          description: 'Always matches. It goes at the end of your record'
//       }
//    ]
// }

License

MIT © SoftVu