💌Easy-YOPMail v4

All the power of the YOPmail anonymous mail system. Without having to leave your application. Create, list and read emails. Everything from NodeJS. (Now faster, safer and lighter)

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.

📦Install

You can install the library using NPM or Yarm

npm i easy-yopmail
yarn add easy-yopmail

🌠Quick start

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

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

With the following lines of code you can get a dynamic mail

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

You can read the inbox of an email just like that

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 read an email and it is that simple

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 ...'
    //}
});

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.

🪧 Principal functions

🤝Contributor

Take a look at our document CONTRIBUTING.md to start configuring the repository. If you are looking for something to contribute. You can review our project in Trello You can also contact our channel Gitter if you have any questions about where to start contributing.

Última actualización