This package is deprecated in favor of dkimpy instead, see https://github.com/forwardemail/dkimpy/ for more information.

python-dkim-verify

Node.js wrapper around Python's dkim.verify function which conforms to RFC spec

Table of Contents

• Requirements
• Install
• Usage
• Contributors
• License

Requirements

1. Ensure that you have a Python version of >= 3.5 installed per dkimpy requirements (note that Python v3 is required because of a bug with DNS recursive CNAME lookups on v2.7):

   python3 --version

2. Install the packages dkimpy:

   pip3 install dkimpy

Install

npm:

npm install python-dkim-verify

yarn:

yarn add python-dkim-verify

Usage

const dkimVerify = require('python-dkim-verify');
 
// then/catch usage
dkimVerify(rawEmail)
  .then(result)
  .catch(console.error);
 
// async/await usage
(async () => {
  try {
    const result = await dkimVerify(rawEmail);
    console.log(result);
  } catch (err) {
    console.error(err);
  }
})();

Note that result is either true or false depending on whether or not DKIM verification was successful for the first DKIM-Signature header found on the email.

Contributors

License

MIT © Nick Baugh