jasp402 / Easy-YOPmail

๐Ÿ“ฎ YOPmail emails manager from an NPM NodeJS library
https://jasp402.github.io/Easy-YOPmail/starter-topic.html
18 stars 3 forks source link
correo jasp402 javascript mail nodejs yopmail yopmail-es

๐Ÿ“ฎ Easy-YOPMail v5.0

easy-yopmail

npm Documentation NPM Unpacked Size
SonarCloud


๐Ÿ’Œ Introducing Easy-YOPmail v5.0: Effortless Temporary Email Management for Node.js

Easy-YOPmail is a powerful Node.js library designed to simplify the way you interact with temporary email addresses from the YOPmail service. This version brings enhanced functionality, improved performance, and an even more intuitive developer experience.

Easy-YOPmail v5.0 empowers you to:

Why Choose Easy-YOPmail?

๐Ÿš€ Getting Started

  1. Install Easy-YOPmail:

    npm i easy-yopmail
  2. Import the library:

    const easyYopmail = require('easy-yopmail');
  3. Explore the examples below and the full documentation to harness the power of Easy-YOPmail!

๐Ÿ’ก Common Use Cases

โœ‰๏ธ Example: Generating a Temporary Email

easyYopmail.getMail().then(email => {
    console.log(email); 
    // Output: [randomly generated name]@yopmail.com 
});

๐Ÿ—ƒ๏ธ Example: Reading the inbox of an email

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

๐Ÿ“‘ Example: Read a message

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

๐Ÿ’– Supporting Easy-YOPMail

We deeply appreciate your interest in supporting Easy-YOPmail! Your sponsorship helps us maintain and enhance the library, bringing valuable features and improvements to the community.

Here are a few ways you can contribute:

1. Financial Support:

2. Show Your Love on GitHub:

Every contribution, big or small, helps us immensely. We are incredibly grateful for your support!