@valimail/dmarc-subject-parser

DMARC Report Subject Parser

Usage no npm install needed!

<script type="module">
  import valimailDmarcSubjectParser from 'https://cdn.skypack.dev/@valimail/dmarc-subject-parser';
</script>

README

DMARC SUBJECT PARSER

Email subject line parsing for both Aggregate and Failure DMARC reports.

Installation

yarn add @valimail/dmarc-subject-parser

API

parser.aggregate(subject, from)

Parse the given email subject line. To enable fallback processing, include the optional 'from' argument.

Returns an Object with the following properties:

  • reportDomain: Full reporting domain.
  • reportOrgDomain: Top level domain (from public suffix).
  • submitter: Submitter from subject or host.
  • reportId: Report ID specified in subject.

parser.failure(subject, from)

Parse the given email subject line.

  • subject
  • from (for submitter)

Returns an Object with the following properties:

  • reportDomain: Full reporting domain.
  • reportOrgDomain: Top level domain (from public suffix).
  • submitter: Submitter from host.

parser.parse(type, subject, from)

Provides a generic interface to both the aggregate and failure parsers.

Testing

yarn test
yarn lint

Development

Gulp based auto-test setup with linting.

gulp

Publishing

Must have an active NPMJS.com account within the Valimail account.

npm publish