📧 EasyYopmail v5.x.x

🚀 Quick Start

Welcome to the Easy-Yopmail documentation! This page will give you an introduction to temporary emails and the full use of the tool.

💡 What is a temporary email?

Temporary emails are disposable email addresses that you can use to register on websites or services without revealing your real email address. They are useful when you need to receive a confirmation email to access a service or download a file, but you don't want to share your personal email address.

Some of the temporary email services are:

link	description
Yopmail	Yopmail is a popular temporary email service that allows you to create a temporary email address and receive emails without registration. You can use the email address for a short period and then discard it.
Temp Mail	Temp Mail is another temporary email service that provides disposable email addresses for free. You can use the email address to receive emails and then delete it when you no longer need it.
10 Minute Mail	10 Minute Mail is a temporary email service that provides email addresses that expire after 10 minutes. You can use the email address to receive emails and then discard it.
Guerrilla Mail	Guerrilla Mail is a temporary email service that offers disposable email addresses for free. You can use the email address to receive emails and then delete it when you no longer need it.
Mailinator	Mailinator is a temporary email service that provides disposable email addresses for free. You can use the email address to receive emails and then discard it.

💡 What is YoPmail?

Yopmail is a popular temporary email service that allows you to create a temporary email address and receive emails without registration. You can use the email address for a short period and then discard it.

Why use Yopmail?

No registration required, You can create a temporary email address without having to register or provide any personal information. In addition, the structure of this page allows you to implement Web Scraping in a simpler way than on competing portals. Allows extraction in an easier and more direct way.

What YOPmail looks like on the inside:

Let's take a glimpse inside YoPmail through these screenshots that showcase its most fundamental functions.

🔎 how the "index" page look on YoPmail

🔎 How the 'Generate Email' page looks on YoPmail

🔎 How the 'Inbox and body email' page looks on YoPmail

💡 What is Easy-Yopmail?

A powerful NPM library designed for NodeJS. This tool was born from the need to simplify the generation of random emails, the management of inboxes and the reading of received messages, all without the need to manually interact with any web interface.

Easy-Yopmail is based on the YOPmail 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 simplify your workflow!

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.

📦 How to use Easy-Yopmail?

We will teach you how to use Easy-Yopmail, a tool that allows you to create and manage temporary email addresses. With Easy-Yopmail, you can generate temporary email addresses, receive emails and manage your inbox simply and quickly. These are the first steps to use Easy-Yopmail:

Prerequisites

Before you begin, please ensure that you:

- Have Node.js installed on your computer.
- Have npm (Node Package Manager) installed on your computer.
- Have created your project folder.
- initialize a nodejs project with npm init -y command.
- Are in your project's directory path from the terminal.

Install the Easy-Yopmail library

You can install the library using NPM or Yarm

npm i easy-yopmail

yarn add easy-yopmail

📭 How to get temporary email?

Easy-YOPMail getMail() function allows developers to dynamically generate random email addresses. This feature is especially useful when you need a unique and temporary email address without having to interact with a web interface or perform any additional configuration.

Diagram how it works getMail() function

Writing code

To get a temporary email address using Easy-Yopmail, follow these steps:
You can copy the code and paste it into your project.
//code to example const easyYopmail = require('easy-yopmail'); easyYopmail.getMail().then(function(email){ console.log(email); });
remember to run your project to view the results in your terminal.

📬 How to read a temporary email?

To read an email, it is necessary to utilize two functions: getInbox() and readMessage(). We need to read the inbox of the email account we wish to access the message for, and once we know the ID of the email we want to consult, we can easily obtain the message using readMessage().

Diagram how it works read a temporary email

In order to read an email it is necessary to use two functions. getInbox() and readMessage(). We need to read the inbox of the email to which we want to access your message and once the email ID is known that we wish to consult. We can easily obtain the message using readMessage().

Writing code

const easyYopmail = require('easy-yopmail'); easyYopmail.getInbox('testEmail@yopmail.com').then(email=>{ console.log(email.inbox); //we obtain an object with the property "Inbox" which is an array of objects //that contain the emails found. { id: 'e_ZwDjZmZkZwV0ZGN1ZQNjAGN1ZGLlBN==', from: 'Disqus', subject: 'Re: Comment on Rehab Afterlife', timestamp: '17:41', page: 5 } });
//once we get the ID we can query it directly using readMessage() easyYopmail.readMessage('testEmail@yopmail.com', 'e_ZwDjZmZkZwV0ZGN1ZQNjAGN1ZGLlBN==').then(message =>{ console.log(message); }); //we will obtain a result similar to this: { id: 'e_ZwDjZmZkZwV0ZGN1ZQNjAGN1ZGLlBN==', submit: 'Re: Comment on Rehab Afterlife', from: 'Disqus @maas.disqus.com>', date: 'Sunday, March 31, 2024 5:41:05 PM', deliverability: 'Your account has been credited', format: 'txt', selector: null, eq: null, attribute: null, pathToSave: null, content: "You have a new reply from 𝓡𝓸𝓼𝓪 in Disqus Rehab View Reply New Channels are live: Anime, Pets, and Literature! Check them out Disqus, 1 California St., Suite 1225, San Francisco, CA 94111 You're receiving this messa ge because you've signed up for Disqus notifications. Unsubscribe Change Email Notifications id-2889cd94c1154f27b3b05244a67d7005", info: [] }

📝 How to write a temporary email?

Easy-Yopmail also facilitates sending emails from the temporary address you generated. Its writeMessage() function allows you to compose and send emails directly within your NodeJS application, streamlining your email workflow. Diagram of how the writeMessage() function operates:

Sending an Email with Easy-Yopmail To send an email using Easy-Yopmail, follow these steps: First, make sure you have installed the Easy-Yopmail library as described in the previous section.

In your NodeJS code, import the Easy-Yopmail library:

const easyYopmail = require('easy-yopmail'); Use the writeMessage() function to send an email. You will need to provide the following parameters:

mail (string): The temporary email address from which you want to send the email (e.g., "yourTempEmail@yopmail.com").
to (string): The recipient's email address.
subject (string): The subject of the email.
body (string): The body of the email.

Here's an example of how to use the writeMessage() function:

Writing code

const easyYopmail = require('easy-yopmail'); let mail = 'yourTempEmail'; //host is @yopmail.com by default let to = 'recipient'; //host is @yopmail.com by default let subject = 'Test Email'; let body = 'This is a test email sent from Easy-Yopmail.'; easyYopmail.writeMessage(mail, to, subject, body).then(function(response){ console.log(response); // Output: Your message has been sent });

🗑️ How to delete a temporary email?

With Easy-Yopmail you have two options for deleting emails:

Deleting a Specific Email: This allows you to remove a single email using its unique ID.
Deleting the Entire Inbox: This option permanently erases all emails within the inbox.

Deleting the Entire Inbox

Use the deleteInbox() Function: Call the function with the email address of the inbox you want to empty. Handle the Response: The function will return a message indicating whether the inbox was successfully emptied or not. It will also tell you how many emails were deleted.

Deleting All Emails in an Inbox code

const easyYopmail = require('easy-yopmail'); easyYopmail.deleteInbox('example@yopmail.com') .then(response => { console.log(response); // Output: "The inbox of the email [example@yopmail.com] has been deleted. X emails have been deleted." });