# nodemailer-markdown

> Markdown content for Nodemailer

Latest version **1.0.3** (published 2019-04-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install nodemailer-markdown
pnpm add nodemailer-markdown
yarn add nodemailer-markdown
bun add nodemailer-markdown
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2019-04-12 |
| First published | 2014-07-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6.4 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 37 |
| Author | Andris Reinman |
| Maintainers | andris |
| Keywords | Nodemailer, markdown |

## Links

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

## Dependencies (1)

- [marked](https://npm.io/package/marked.md) ^0.6.2

## 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

- 1.0.3 (latest) — 2019-04-12
- 1.0.2 — 2018-01-05
- 1.0.1 — 2016-09-13
- 1.0.0 — 2014-08-18
- 0.1.2 — 2014-07-10
- 0.1.1 — 2014-07-05
- 0.1.0 — 2014-07-04

## README

# Markdown plugin for Nodemailer

This applies to Nodemailer v1.0+. This plugin adds an option `markdown` for the Nodemailer e-mail options. This value will be used to populate `text` and `html` so you don't have to.

## Install

Install from npm

    npm install nodemailer-markdown --save

## Usage

#### 1. Load the `markdown` function

```javascript
var markdown = require('nodemailer-markdown').markdown;
```

#### 2. Attach it as a 'compile' handler for a nodemailer transport object

```javascript
nodemailerTransport.use('compile', markdown(options))
```

Where

  * **options** - includes options for the [marked](https://www.npmjs.org/package/marked) parser with the following additions:
      * **useEmbeddedImages** - if true, load or download referenced images and include these as attachments

#### 3. Set a `markdown` value

Any nodemailer content value can be used: String, Buffer, Stream or an object in the form of {path: filepath/url}

```javascript
var mailOptions1 = {
    markdown: '# Hello world!\n\nThis is a **markdown** message'
};
var mailOptions2 = {
    markdown: {path: __dirname + '/message.md'}
};
```

## Example

```javascript
var nodemailer = require('nodemailer');
var transporter = nodemailer.createTransport();
transporter.use('compile', markdown());
transporter.sendMail({
    from: 'me@example.com',
    to: 'receiver@example.com',
    markdown: '# Hello world!\n\nThis is a **markdown** message'
});
```

## License

**MIT**

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