# disposable-mail-api

> Generate multiple disposable mails

Latest version **0.1.0** (published 2023-03-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install disposable-mail-api
pnpm add disposable-mail-api
yarn add disposable-mail-api
bun add disposable-mail-api
```

Provides the command `disposable-mail-api`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2023-03-13 |
| First published | 2022-11-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 25.1 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Esteve 'GiR' Segura |
| Maintainers | estevesegura |
| Keywords | mail, disposable, temporal, mail, testing, mails, email, testing, emails |

## Links

- npm: https://www.npmjs.com/package/disposable-mail-api
- Repository: https://github.com/EsteveSegura/disposable-mail-api
- Homepage: https://github.com/EsteveSegura/disposable-mail-api#readme
- Issues: https://github.com/EsteveSegura/disposable-mail-api/issues
- npm.io page: https://npm.io/package/disposable-mail-api

## Dependencies (4)

- [axios](https://npm.io/package/axios.md) ^0.27.2
- [yargs](https://npm.io/package/yargs.md) ^17.6.2
- [figlet](https://npm.io/package/figlet.md) ^1.5.2
- [string-strip-html](https://npm.io/package/string-strip-html.md) ^8.4.0

## 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.1.0 (latest) — 2023-03-13
- 0.0.10 — 2023-02-04
- 0.0.9 — 2023-01-22
- 0.0.8 — 2023-01-15
- 0.0.7 — 2023-01-07
- 0.0.6 — 2023-01-07
- 0.0.5 — 2022-11-15
- 0.0.4 — 2022-11-15
- 0.0.3 — 2022-11-15
- 0.0.2 — 2022-11-11
- 0.0.1 — 2022-11-10

## README

<div align="center">
 <h1>Disposable Mail Api</h1>
    <span><strong>Disposable Mail Api</strong> It is a library to generate disposable mails completly functional and usable on internet.</span><br />
    <img src="https://img.shields.io/badge/NodeJS-14.13.0-green"> 
    <img src="https://img.shields.io/badge/License-MIT-blue">
    <img src="https://img.shields.io/badge/Version-0.0.1-blue">
</div>

## Installation
```bash
npm i disposable-mail-api
```

## Examples
### Basic Usage
The library is very easy to use, we can create a fully functional mail on the internet with the code shown below and we will be able to receive and consult the entire inbox.
```js
const {DisposableMail} = require('disposable-mail-api');
const mail = new DisposableMail();

(async () => {
  const createMail = await mail.generate({mail: 'MySuperFakeEmail'}); // => {addres: 'mysuperfakeemail@kerenkey.com'}
  const getInboxMail = await mail.inbox({withHtml: true}); // => mailInbox: [{from: [{address: 'SomeEmail@SomeDomain.com', name: 'John Doe'}], intro: 'Mail content!', subject: 'important mail'}]
})();
```

### CLI Usage
Install disposable-mail-api in global context
```bash
npm i -g disposable-mail-api
```

And then you can run:

```bash
disposable-mail-api -u myrandomusername --html
```

This will show an interface in which you can receive mails without this need of code, something like this:

```plaintext
Mail created => myrandomusername@karenkey.com
Listening for mails...

---------------------------- NEW MAIL ----------------------------
>> From: John Doe <JohnDoe@example.net>
>> Subject: Testing mail server.
>> Intro: Awesome mail system.
>> Body: Awesome mail system.
---------------------------- NEW MAIL ----------------------------
>> From: Not Jonh Doe <NotJohnDoe@voicemod.net>
>> Subject: Not John Doe speaking!
>> Intro: You know.... im not John Doe, im J...
>> Body: You know.... im not John Doe, im Jonh Doe!
```

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