> For the complete documentation index, see [llms.txt](https://jasp402.gitbook.io/easy-yopmail-v4/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://jasp402.gitbook.io/easy-yopmail-v4/easy-yopmail-v4.md).

# Easy-YOPMail v4

<div data-full-width="true"><figure><img src="https://culqi-images-storage.s3.us-east-2.amazonaws.com/images/v4_EN_us.png" alt=""><figcaption><p>Easy-yopmail v4</p></figcaption></figure></div>

A powerful [NPM ](https://npmjs.com/)library designed for [NodeJS](http://nodejs.org/). This tool was born from the need to simplify the <mark style="background-color:green;">generation of random emails</mark>, <mark style="background-color:green;">the management of inboxes</mark> and the <mark style="background-color:orange;">reading of received messages</mark>, all without the need to manually interact with any web interface.

**Easy-Yopmail** is based on the [YOPmail ](https://yopmail.com/)platform and operates completely asynchronously. Its intuitive design and efficiency make it an indispensable tool for scraping, automated testing, and any process that requires efficient email management. With Easy-Yopmail, you can focus on what really matters: developing your application. Let our bookstore take care of the email for you.

Join the community of developers who are already taking advantage of Easy-Yopmail. Install it today from NPM and see how it can <mark style="background-color:green;">simplify your workflow</mark>!

[💡](https://emojipedia.org/es/bombilla/)**The main features of Easy-Yopmail include:**

* **Random Email Generation:** *Create unique and random email addresses with a single command.*
* **Inbox Management:** *Access and list the inbox of any Yopmail email address.*
* **Reading Emails:** *Read received emails without having to interact with any web interface.*
* **Asynchronous Operation:** *All Easy-Yopmail functions run asynchronously, allowing for a seamless workflow.*
* **Easy Integration with NodeJS:** *As an NPM library, Easy-Yopmail integrates seamlessly with any NodeJS project.*
* **Based on YOPmail**: *Easy-Yopmail uses the YOPmail platform, which guarantees the reliability and efficiency of its functions.*

## 📦Install

You can install the library using [NPM](https://www.npmjs.com/) or [Yarm](https://yarnpkg.com/)

```sh
npm i easy-yopmail
```

```sh
yarn add easy-yopmail
```

## [🌠](https://emojipedia.org/es/estrella-fugaz/)Quick start

We start with declaring the dependency like in any other application.

{% code fullWidth="false" %}

```javascript
//Declare module
const easyYOPmail = require('easy-yopmail');
```

{% endcode %}

With the following lines of code you can <mark style="background-color:green;">get a dynamic mail</mark>

```javascript
easyYOPmail.getMail().then(mail => {
    console.log(mail); 
    //Output:
    //jemuzivutro-3233@yopmail.com
});
```

You can <mark style="background-color:green;">read the inbox</mark> of an email just like that

```javascript
easyYOPmail.getInbox('testing_01').then(inbox => {
    console.log(inbox);
    //Output:
    //{
    //  settings: {},
    //  search: {},
    //  totalInbox: 271,
    //  totalPages: 19,
    //  mailFromPage: { page_1: 15 },
    //  totalGetMails: 15,
    //  inbox: [
    //       {
    //         id: 'e_ZwZjAGVlZGHlZQR1ZQNjAwZ5AQp4ZD==',
    //         from: 'Ola no-reply',
    //         subject: 'this is example message...',
    //         timestamp: '10:20'
    //       }
    //  ]
    //}
});
```

The most desired thing is to be able to <mark style="background-color:green;">read an email</mark> and it is that simple

```javascript
easyYOPmail.readMessage('testing_01', 'e_ZwZjAGVlZGHlZQR1ZQNjAwZ5AQp4ZD==', 'TXT').then(message => {
    console.log(message);
    //Output:
    //{
    //  id: 'e_ZwZjAGVlZGHlZQR1ZQNjAwZ5AQp4ZD==',
    //  submit: 'ITechnoLabs Notification - Event from Hanwha  XNV-6012',
    //  from: 'ITechnoLabs Notification Service <notifications@mycamcloud.com>',
    //  date: 'Monday, May 22, 2023 10:23:26 PM',
    //  selector: '#mail',
    //  format: 'txt',
    //  data: 'Hanwha  XNV-6012\n ...'
    //}
});
```

{% hint style="info" %}
In the examples above, you will find lines of code that are commented out. This is just to show you an example of the result.
{% endhint %}

## [🪧](https://emojipedia.org/es/letrero/) Principal functions

<table data-view="cards" data-full-width="true"><thead><tr><th></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><a href="/pages/p9Y8ecnbCmf2wabOe8yV">Create Mail Dynamically</a></td><td><a href="/files/4EBgHmOJe7NojxPh7ajB">/files/4EBgHmOJe7NojxPh7ajB</a></td></tr><tr><td><a href="/pages/jeYF5aRhrGgUIp8b4342">Read Mail Inbox</a></td><td><a href="/files/DG0YAv9bQUDAHrGwKm9B">/files/DG0YAv9bQUDAHrGwKm9B</a></td></tr><tr><td><a href="/pages/I6d60FeRxjU2oZ28gSTO">Read Mail Message</a></td><td><a href="/files/r9UgdF3mcctH43rZrIcv">/files/r9UgdF3mcctH43rZrIcv</a></td></tr></tbody></table>

## [🤝](https://emojipedia.org/es/apret%C3%B3n-de-manos/)Contributor

Take a look at our document [CONTRIBUTING.md](https://jasp402.github.io/js-packtools/#/es/contribute) to start configuring the repository. If you are looking for something to contribute. You can review our project in [Trello](https://trello.com/b/FMUpri2i/js-packtools) You can also contact our channel [Gitter](https://gitter.im/js-packtools/community) if you have any questions about where to start contributing.

{% embed url="<https://github.com/jasp402/Easy-YOPmail>" %}

{% embed url="<https://www.npmjs.com/package/easy-yopmail>" %}