# spf-parse

> Parse SPF (Sender Polify Framework) records

Latest version **1.0.4** (published 2017-02-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install spf-parse
pnpm add spf-parse
yarn add spf-parse
bun add spf-parse
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2017-02-06 |
| First published | 2016-12-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/spf-parse) |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Brian Hann |
| Maintainers | c0bra |
| Keywords | spf, email, mail, policy, parse |

## Links

- npm: https://www.npmjs.com/package/spf-parse
- Repository: https://github.com/softvu/spf-parse
- Homepage: https://github.com/softvu/spf-parse#readme
- Issues: https://github.com/softvu/spf-parse/issues
- npm.io page: https://npm.io/package/spf-parse

## Dependencies (3)

- [tldjs](https://npm.io/package/tldjs.md) ^1.7.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.3
- [ipaddr.js](https://npm.io/package/ipaddr.js.md) ^1.2.0

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 1.0.4 (latest) — 2017-02-06
- 1.0.3 — 2017-01-04
- 1.0.1 — 2017-01-04
- 1.0.0 — 2016-12-29
- 0.0.1 — 2016-12-28

## README

# spf-parse [![Build Status](https://travis-ci.org/softvu/spf-parse.svg?branch=master)](https://travis-ci.org/softvu/spf-parse) [![Coverage Status](https://coveralls.io/repos/github/softvu/spf-parse/badge.svg?branch=master&foo=bar)](https://coveralls.io/github/softvu/spf-parse?branch=master) [![Dependency Status](https://dependencyci.com/github/softvu/spf-parse/badge)](https://dependencyci.com/github/softvu/spf-parse) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
> 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

```javascript
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](https://softvu.com)

---
_Source: https://npm.io/package/spf-parse · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._