Welcome to the Ultimate Guide to mail-listener2

In this comprehensive guide, we will introduce you to mail-listener2, a powerful Node.js library used for listening to emails. We’ll explore its functionalities, show you how to set it up, and provide you with useful API examples to get the most out of this tool. Let’s dive in!

What is mail-listener2?

mail-listener2 is a Node.js library that provides simple but effective IMAP mailbox listening capabilities. It supports IDLE extensions which allow it to quickly respond to new email notifications.

Installation

To start using mail-listener2, you first need to install it via npm:

npm install mail-listener2

Basic Example

Here’s a basic example to get you started:

 const MailListener = require('mail-listener2');
const mailListener = new MailListener({
    username: 'your-email@gmail.com',
    password: 'your-email-password',
    host: 'imap.gmail.com',
    port: 993,
    secure: true, // use secure connection
    mailbox: 'INBOX',
    markSeen: true, // mark messages as read
    fetchUnreadOnStart: true,
    attachments: true, // download attachments as they are added to the message
    attachmentOptions: { directory: 'attachments/' } // specify a location for saving attachments
});
mailListener.start();
mailListener.on('server:connected', () => {
    console.log('imap connected');
});
mailListener.on('mail', (mail, seqno, attributes) => {
    console.log('received email:', mail);
});
mailListener.on('error', (err) => {
    console.log(err);
}); 

Advanced API Usage

In addition to basic functionality, mail-listener2 offers several advanced options. Let’s explore them:

Listening to Specific Mailboxes

 const mailListener = new MailListener({
    ...
    mailbox: 'INBOX.Sent', // specify mailbox to listen to
    ...
}); 

Filtering Emails

You can filter emails by modifying the searchFilter property:

 const mailListener = new MailListener({
    ...
    searchFilter: ['UNSEEN', ['SINCE', 'May 20, 2020']], // filters unseen mails since a specific date
    ...
}); 

Building a Simple Email Application

Here’s how you can build a simple email application using mail-listener2:

Step 1: Setting Up the Server

 const express = require('express'); const app = express();
const MailListener = require('mail-listener2');
const mailListener = new MailListener({
    username: 'your-email@gmail.com',
    password: 'your-email-password',
    host: 'imap.gmail.com',
    port: 993,
    secure: true, // use secure connection
    mailbox: 'INBOX',
    markSeen: true,
    fetchUnreadOnStart: true,
    attachments: true,
    attachmentOptions: { directory: 'attachments/' }
});
mailListener.start();
mailListener.on('server:connected', () => {
    console.log('imap connected');
});
mailListener.on('mail', (mail, seqno, attributes) => {
    console.log('received email:', mail);
});
mailListener.on('error', (err) => {
    console.log(err);
});
app.get('/', (req, res) => {
    res.send('Email Listener is running');
});
app.listen(3000, () => {
    console.log('Server is running on port 3000');
}); 

This example sets up an Express server that runs the mail-listener2 and provides a simple status route.

Conclusion

We hope this guide has given you a good understanding of mail-listener2 and its capabilities. It’s a robust library that can greatly simplify email handling in your Node.js applications. Happy coding!

Hash: 866ad2f03fa899b076ec25a8e77538a21c4f202f85701bb75f90b6e7a4f2541b