npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

node-pgp-mail

v0.0.1

Published

Library to send PGP-encrypted and signed e-mails.

Downloads

24

Readme

node-pgp-mail is a library to send PGP-encrypted e-mails. In the future, signing e-mails will also be supported.

Use the following code to initialise node-pgp-mail:

var pgpMail = require("node-pgp-mail");

var keyring; // node-pgp keyring object
var mailer = new pgpMail(keyring, "SENDMAIL", { "path": "/usr/sbin/sendmail" });

The second and third parameter define the mail transport method, see the Nodemailer docu for the syntax.

getMailRecipient()

Finds out one e-mail address to send an e-mail to the owner of the key. Prefers the one of the primary identity, but if that does not contain one, uses the one of an arbitrary other identity.

var keyId = "012345678ABCDEFAB"; // 16-digit uppercase hex long key ID
mailer.getMailRecipient(keyId, function(err, recipient) {
	if(err)
		; // An error occurred

	// recipient is a string or null if none was found
});

sendEncryptedMail()

var to = "[email protected]";
var subject = "Test e-mail";
var body = "Test e-mail";
var toKeyId = "012345678ABCDEFAB"; // 16-digit uppercase hex long key ID to encrypt to
var headers = { "Reply-To": "[email protected]" }; // Optional additional e-mail headers
mailer.sendEncryptedMail(to, subject, body, toKeyId, function(err) {
	if(err)
		; // An error occurred
}, headers);

sendMail()

Sends an unencrypted mail.

var to = "[email protected]";
var subject = "Test e-mail";
var body = "Test e-mail";
mailer.sendMail(to, subject, body, function(err) {
	if(err)
		; // An error occurred
});

In order to specify additional headers, use a Mime object instead of a string as text.

Mime

For the e-mail body, instead of a string, you can also specify a Mime object:

var contentType = "text/plain";
var content = "Test e-mail";
var headers = { "Reply-To": "[email protected]" };
var transferEncoding = "quoted-printable";
var body = new pgpMail.Mime(contentType, content, headers, transferEncoding);

This also supports multipart messages by specifying an array as content:

var body = new pgpMail.Mime("multipart/mixed", [
    new pgpMail.Mime("text/plain", "Test part 1"),
    new pgpMail.Mime("text/plain", "Test part 2")
]);