Skip to content

scrive/imap-checker

Repository files navigation

mail checker

npm version

Check the IMAP server and return the first matching email.

How to use

var imapChecker = require('imap-checker');

const imapConfig = {
  user: "[email protected]",
  password: "password",
  host: "imap.gmail.com",
  port: 993,
  tls: true,
  tlsOptions: { rejectUnauthorized: false }
};

imapChecker.checkMail(imapConfig, {
  timeout: 30000,
  subject: '<subject>',
  to: '[email protected]',
  from: '[email protected]',
  interval: 2000
})
.then(email => console.log('>>>', email));

Or in ES6:

import imapChecker from 'imap-checker';

const imapConfig = {
  user: "[email protected]",
  password: "password",
  host: "imap.gmail.com",
  port: 993,
  tls: true,
  tlsOptions: { rejectUnauthorized: false }
};

const email = await imapChecker.checkMail(imapConfig, {
  timeout: 30000,
  subject: '<subject>',
  to: '[email protected]',
  from: '[email protected]',
  interval: 2000,
  since: 24 * 3600 * 1000,
  debug: true
});

console.log('>>>', email);

Different formats of email addresses are supported. For example, if you are looking for emails with sender's address as Joe Doe <[email protected]>, just search it as [email protected].