# dkim-signer

> DKIM signing code extracted from mailcomposer

Latest version **0.2.2** (published 2016-03-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install dkim-signer
pnpm add dkim-signer
yarn add dkim-signer
bun add dkim-signer
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2016-03-02 |
| First published | 2013-12-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/dkim-signer) |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 20 |
| Author | Andris Reinman |
| Maintainers | andris |
| Keywords | DKIM, SMTP, mailcomposer |

## Links

- npm: https://www.npmjs.com/package/dkim-signer
- Repository: https://github.com/andris9/dkim-signer
- Issues: https://github.com/andris9/dkim-signer/issues
- npm.io page: https://npm.io/package/dkim-signer

## Dependencies (1)

- [libmime](https://npm.io/package/libmime.md) ^2.0.3

## 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.2.2 (latest) — 2016-03-02
- 0.2.1 — 2016-01-15
- 0.2.0 — 2014-07-03
- 0.1.2 — 2014-05-15
- 0.1.1 — 2014-05-13
- 0.1.0 — 2013-12-02

## README

# DKIM Signer

Sign RFC822 messages with DKIM. This module is extracted from [mailcomposer](https://github.com/andris9/mailcomposer).

## Usage

```javascript
// 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**

---
_Source: https://npm.io/package/dkim-signer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._