# mail-prompt

> A CLI prompt for email addresses.

Latest version **1.0.0** (published 2021-10-26) · ISC license · 0 weekly downloads

## Install

```sh
npm install mail-prompt
pnpm add mail-prompt
yarn add mail-prompt
bun add mail-prompt
```

## 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.0 |
| Published | 2021-10-26 |
| First published | 2016-10-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=14 |
| Dependencies | 8 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Jannis R |
| Maintainers | derhuerst |
| Keywords | mail, email, interactive, prompt, command line, cli, terminal, readline |

## Links

- npm: https://www.npmjs.com/package/mail-prompt
- Repository: https://github.com/derhuerst/mail-prompt
- Issues: https://github.com/derhuerst/mail-prompt/issues
- npm.io page: https://npm.io/package/mail-prompt

## Dependencies (8)

- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [cli-styles](https://npm.io/package/cli-styles.md) ^1.0.0
- [text-prompt](https://npm.io/package/text-prompt.md) ^0.1.3
- [ansi-escapes](https://npm.io/package/ansi-escapes.md) ^4.3.2
- [domain-regex](https://npm.io/package/domain-regex.md) ^0.0.1
- [email-addresses](https://npm.io/package/email-addresses.md) ^5.0.0
- [email-providers](https://npm.io/package/email-providers.md) ^1.0.4
- [prompt-skeleton](https://npm.io/package/prompt-skeleton.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

- 1.0.0 (latest) — 2021-10-26
- 0.1.2 — 2017-04-05
- 0.1.1 — 2016-10-22

## README

# mail-prompt 📎

**A CLI prompt for email addresses.**

[![asciicast](https://asciinema.org/a/90148.png)](https://asciinema.org/a/90148)

[![npm version](https://img.shields.io/npm/v/mail-prompt.svg)](https://www.npmjs.com/package/mail-prompt)
[![dependency status](https://img.shields.io/david/derhuerst/mail-prompt.svg)](https://david-dm.org/derhuerst/mail-prompt)
[![dev dependency status](https://img.shields.io/david/dev/derhuerst/mail-prompt.svg)](https://david-dm.org/derhuerst/mail-prompt#info=devDependencies)
![ISC-licensed](https://img.shields.io/github/license/derhuerst/mail-prompt.svg)
[![support me via GitHub Sponsors](https://img.shields.io/badge/support%20me-donate-fa7664.svg)](https://github.com/sponsors/derhuerst)
[![chat with me on Twitter](https://img.shields.io/badge/chat%20with%20me-on%20Twitter-1da1f2.svg)](https://twitter.com/derhuerst)

*mail-prompt* uses [*cli-styles*](https://github.com/derhuerst/cli-styles) and [*prompt-skeleton*](https://github.com/derhuerst/prompt-skeleton) to have a look & feel consistent with [other prompts](https://github.com/derhuerst/prompt-skeleton#prompts-using-prompt-skeleton).


## Installing

```shell
npm install mail-prompt
```


## Usage

```javascript
const mailPrompt = require('mail-prompt')
mailPrompt('Your email address?')
.on('data', (e) => console.log('Interim value', e.value))
.on('submit', (v) => console.log('Submitted with', v))
.on('abort', (v) => console.log('Aborted with', v))
```


## Related

- [`date-prompt`](https://github.com/derhuerst/date-prompt)
- [`multiselect-prompt`](https://github.com/derhuerst/multiselect-prompt)
- [`number-prompt`](https://github.com/derhuerst/number-prompt)
- [`range-prompt`](https://github.com/derhuerst/range-prompt)
- [`select-prompt`](https://github.com/derhuerst/select-prompt)
- [`text-prompt`](https://github.com/derhuerst/text-prompt)
- [`tree-select-prompt`](https://github.com/derhuerst/tree-select-prompt)
- [`cli-autocomplete`](https://github.com/derhuerst/cli-autocomplete)
- [`switch-prompt`](https://github.com/derhuerst/switch-prompt)


## Contributing

If you **have a question**, **found a bug** or want to **propose a feature**, have a look at [the issues page](https://github.com/derhuerst/mail-prompt/issues).

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