# pgpmailer > **mailbuilder** is high-level module to send pgp-encrypted messages in node and certain browser runtimes. Latest version **0.9.1** (published 2015-04-22) · 0 weekly downloads ## Install ```sh npm install pgpmailer pnpm add pgpmailer yarn add pgpmailer bun add pgpmailer ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.9.1 | | Published | 2015-04-22 | | First published | 2014-07-25 | | Weekly downloads | 0 | | TypeScript types | none | | Module format | CommonJS | | Node | >=0.10 | | Dependencies | 2 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 11 | | Author | Whiteout Networks | | Maintainers | felixhammerl, tanx, andris | | Keywords | e-mail, pgp | ## Links - npm: https://www.npmjs.com/package/pgpmailer - Repository: http://github.com/whiteout-io/pgpmailer - Homepage: https://github.com/whiteout-io/pgpmailer - Issues: https://github.com/whiteout-io/pgpmailer/issues - npm.io page: https://npm.io/package/pgpmailer ## Dependencies (2) - [pgpbuilder](https://npm.io/package/pgpbuilder.md) ~0.6.0 - [wo-smtpclient](https://npm.io/package/wo-smtpclient.md) ~0.6.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 - 0.9.1 (latest) — 2015-04-22 - 0.9.0 — 2015-02-16 - 0.8.0 — 2015-01-21 - 0.7.0 — 2014-10-29 - 0.6.0 — 2014-10-29 - 0.5.0 — 2014-10-21 - 0.4.2 — 2014-10-13 - 0.4.1 — 2014-09-05 - 0.4.0 — 2014-08-27 - 0.3.13 — 2014-08-06 - 0.3.12 — 2014-08-06 - 0.3.11 — 2014-08-05 - 0.3.10 — 2014-07-28 - 0.3.9 — 2014-07-25 - 0.3.8 — 2014-07-25 - … 1 more at https://npm.io/package/pgpmailer/versions ## README # pgpmailer **mailbuilder** is high-level module to send pgp-encrypted messages in node and certain browser runtimes. [![Build Status](https://travis-ci.org/whiteout-io/pgpmailer.png?branch=master)](https://travis-ci.org/whiteout-io/pgpmailer) ## PGP/MIME in the browser?! Yes. This module orchestrates the following libraries to send PGP-encrypted messages: * [OpenPGP.js](http://openpgpjs.org/) * [smtpclient](https://github.com/whiteout-io/smtp-client) * [pgpbuilder](https://github.com/whiteout-io/pgpbuilder) ## TCPSocket API There is a [shim](https://github.com/whiteout-io/tcp-socket) that brings [Mozilla-flavored](https://developer.mozilla.org/en-US/docs/WebAPI/TCP_Socket) version of the [Raw Socket API](http://www.w3.org/TR/raw-sockets/) to other platforms. If you are on a platform that uses forge instead of a native TLS implementation (e.g. chrome.socket), you have to set the .oncert(pemEncodedCertificate) handler that passes the TLS certificate that the server presents. It can be used on a trust-on-first-use basis for subsequent connection. If forge is used to handle TLS traffic, you may choose to handle the TLS-related load in a Web Worker. Please use tlsWorkerPath to point to `tcp-socket-tls-worker.js`! Please take a look at the [tcp-socket documentation](https://github.com/whiteout-io/tcp-socket) for more information! ## What can this library do? This library takes a plain-text message including attachments and transforms it into an [RFC 3156](http://tools.ietf.org/search/rfc3156) format. Here's a little primer about RFC 3156. An eMail consist from MIME-nodes. A MIME-node has information about what it contains, may this be other MIME-nodes, text, attachments, blabla. What goes over the wire when you send an email is mainly [some SMTP stuff](http://blog.nodeknockout.com/post/34641712180/sending-email-from-node-js) and the flattened MIME-Tree transformed to plain 7-bit ASCII. Here are some examples of how a MIME-Tree could look like. Plain-text mail envelope stuff ... yaddayadda ... text/plain A text/plain mail with attachments is a bit more interesting, it should like this envelope stuff ... multipart/mixed |___text/plain |___application/octet/stream |___application/octet/stream |___application/octet/stream An html-mail is nested even further envelope stuff ... multipart/mixed |___multipart/alternative | |___text/plain | |___text/html |___application/octet/stream |___application/octet/stream |___application/octet/stream **NB! text/html is not yet supported, but we're working hard to make it happen. Also, PRs are welcome :)** This lib takes your mail object, creates the MIME-tree, signs and encrypts it, and build a PGP/MIME message that looks like this: multipart/encrypted |___application/pgp-encrypted |___inline attachment (pgp block) ## How do I use this? Here's what you do in you own app (and/or have a look at the `test/integration.js` test) var PgpMailer = require('pgpmailer'); var pgpmailer = new PgpMailer({ host: 'HOST', port: 465, // or whatever port you want to use auth: { user: 'YOUR USERNAME', pass: 'YOUR PASSWORD', xoauth2: 'YOUR XOAUTH2 TOKEN' // (optional) If both password and xoauth2 token are set, the token is preferred. }, ignoreTLS: false, // if set to true, do not issue STARTTLS even if the server supports it requireTLS: true // if set to true, always use STARTTLS before authentication even if the host does not advertise it. If STARTTLS fails, do not try to authenticate the user secureConnection: true, // because why wouldn't you? ca: 'PIN THE CERTIFICATE OF YOUR PROVIDER OF CHOICE', // (optional) Only in conjunction with tcp-socket if you use TLS with forge. Pins a PEM-encoded certificate as a string. Please refer to the tcp-socket documentation for more information! tlsWorkerPath: 'path/to/' // (optional) Only in conjunction with tcp-socket if you use TLS with forge. . Indicates where the file for the TLS Web Worker is located. Please refer to the tcp-socket documentation for more information! }); // set your private key to sign your message pgpmailer.setPrivateKey({ privateKeyArmored: 'ASCII ARMORED PRIVATE KEY', passphrase: 'PASSPHRASE' }, function(error) { // do something useful with the error }); // execute this after pgpmailer.setPrivateKey invoked its callback and the private key is set var publicKeysArmored = ['ASCII ARMORED PUBLIC KEY OF THE SENDER', 'RECEIVER KEY', 'COPY RECEIVER KEY', 'BLINDCOPY RECEIVER KEY']; var mail = { from: [{ name: 'Foo Bar', address: 'sender@foobar.com' }], to: [{ name: 'Foo Bar', address: 'recipient@foobar.com' }], cc: [{ name: 'Foo Bar', address: 'receive.a.copy@foobar.com' }], subject: 'hello, pgp', body: 'hello, world!', attachments: [{ mimeType: 'text/plain', filename: 'a.txt', content: // a UInt8Array that contains your attachment }] }; var cleartextMessage = 'This message is prepended to your encrypted message and displayed in the clear even if your recipient does not speak PGP!'; mailer.send({ mail: mail, encrypt: true, publicKeysArmored: publicKeysArmored, cleartextMessage: cleartextMessage }, function(error) { // do something useful with the error }); If you **do not want to encrypt** your message, but instead just want to sign it, just do the following // instantiate the pgpmailer and set your public key, then mailer.send({ mail: mail, encrypt: false }, function(error) { // do something useful with the error }); ## Get your hands dirty npm install && grunt --- _Source: https://npm.io/package/pgpmailer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._