dkim-signer

What is dkim-signer?

The dkim-signer npm package is used to sign email messages with DomainKeys Identified Mail (DKIM). This helps in verifying the authenticity of the email and ensuring that it has not been tampered with during transit.

What are dkim-signer's main functionalities?

Sign Email

This feature allows you to sign an email message using DKIM. The `sign` function takes the email content and options including the domain name, key selector, and private key, and returns the signed email.

const dkim = require('dkim-signer');
const email = 'From: [e-mail]\r\nTo: [e-mail]\r\nSubject: Test\r\n\r\nThis is a test email.';
const options = {
  domainName: 'example.com',
  keySelector: 'default',
  privateKey: '-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASC...\n-----END PRIVATE KEY-----'
};
const signedEmail = dkim.sign(email, options);
console.log(signedEmail);

Other packages similar to dkim-signer

nodemailer

Nodemailer is a module for Node.js applications to allow easy email sending. It supports various transport methods, including SMTP, and can be extended with plugins for additional functionality like DKIM signing. Compared to dkim-signer, Nodemailer is more comprehensive and can handle the entire email sending process, not just DKIM signing.

emailjs

EmailJS is a library for sending emails from JavaScript applications. It supports SMTP and can be configured to use DKIM for signing emails. While it provides a broader range of email functionalities, it is not as specialized in DKIM signing as dkim-signer.

mailcomposer

Mailcomposer is a Node.js module for generating email messages, including support for attachments and DKIM signing. It is more focused on email composition and can be used in conjunction with other modules for sending emails. Compared to dkim-signer, it offers more features for email creation but requires additional setup for sending emails.

README

DKIM Signer

Sign RFC822 messages with DKIM. This module is extracted from mailcomposer.

Usage

// require signer function
var DKIMSign = require("dkim-signer").DKIMSign;

// generate a RFC822 message
var rfc822message = "Subject: test\r\n\r\nHello world";

// setup DKIM options
var dkimOptions = {
    domainName: "müriaad-polüteism.info",
    keySelector: "dkim",
    privateKey: require("fs").readFileSync("./test_private.pem")
};

// generate signature header field
var signature = DKIMSign(rfc822message, dkimOptions);

// join signature header field with the message
console.log(signature + "\r\n" + rfc822message);

License

MIT