# mailto-link

> Generate a mailto protocol link

Latest version **2.0.0** (published 2021-03-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install mailto-link
pnpm add mailto-link
yarn add mailto-link
bun add mailto-link
```

## 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 | 2.0.0 |
| Published | 2021-03-30 |
| First published | 2015-09-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 12 |
| Dependencies | 4 |
| Unpacked size | 3.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Ben Drucker |
| Maintainers | bendrucker |
| Keywords | mailto, protocol, mail, link |

## Links

- npm: https://www.npmjs.com/package/mailto-link
- Repository: https://github.com/bendrucker/mailto-link
- Homepage: https://github.com/bendrucker/mailto-link#readme
- Issues: https://github.com/bendrucker/mailto-link/issues
- npm.io page: https://npm.io/package/mailto-link

## Dependencies (4)

- [assert-ok](https://npm.io/package/assert-ok.md) ~1.0.0
- [cast-array](https://npm.io/package/cast-array.md) ~1.0.1
- [query-string](https://npm.io/package/query-string.md) ~7.0.0
- [object-filter](https://npm.io/package/object-filter.md) ~1.0.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

- 2.0.0 (latest) — 2021-03-30
- 1.0.0 — 2015-09-08

## README

# mailto-link [![tests](https://github.com/bendrucker/mailto-link/actions/workflows/test.yml/badge.svg)](https://github.com/bendrucker/mailto-link/actions/workflows/test.yml)

> Generate a mailto protocol link


## Install

```
$ npm install --save mailto-link
```


## Usage

```js
var mailtoLink = require('mailto-link')

mailtoLink({to: 'bvdrucker@gmail', subject: 'Nice mailto lib'})
//=> mailto:bvdrucker@gmail.com?subject=Nice%20mailto%20lib
```

## API

#### `mailtoLink(options)` -> `string`

##### options

*Required*  
Type: `object`

###### to / cc / bcc

Type: `string` / `array[string]`

List of emails to send to.

###### subject

Type: `string`

The email subject.

###### body

Type: `string`

The email body.


## License

MIT © [Ben Drucker](http://bendrucker.me)

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