mail-notifier
Notify your nodejs scripts of incoming imap mail.
introduction
Send mail
event for each new email in IMAP INBOX.
synopsis
Start listening new mails :
var notifier = ; var imap = username: "yourimapuser" password: "yourimappassword" host: "imap.host.com" port: 993 // imap port secure: true // use secure connection; start;
installation
$ npm install mail-notifier
API
notifier(config)
The constructor function creates a new notifier
. Parameter provide options needed for imap connection.
config
:
host
: imap server hostport
: imap server port numberusername
: imap user namepassword
: imap passwordsecure
: need secure connection to server
.start()
Start listening for incomming emails.
.stop()
Stop listening and close IMAP connection.
Events
'mail'
Sent on incoming new unread email. The parsed Mail is given as first parameter to the event listener.
'error'
Sent when an error occurs with the IMAP connection. The first parameter is the err
object.
'end'
Sent when the IMAP connection is closed. This usually happens after a stop
method call.
Dependencies
This module relies heavily on node-imap.