https://github.com/derhuerst/mail-prompt

A CLI prompt for email addresses.
https://github.com/derhuerst/mail-prompt

cli prompt

Last synced: 6 days ago
JSON representation

A CLI prompt for email addresses.

• Host: GitHub
• URL: https://github.com/derhuerst/mail-prompt
• Owner: derhuerst
• License: isc
• Created: 2016-10-21T23:01:35.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2021-10-26T20:03:20.000Z (about 3 years ago)
• Last Synced: 2024-10-03T23:54:12.291Z (about 1 month ago)
• Topics: cli, prompt
• Language: JavaScript
• Homepage: https://github.com/derhuerst/mail-prompt
• Size: 17.6 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

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).