# mail-notifier2

> Nodejs library to get notified on new incoming email.

Latest version **0.1.0-2** (published 2013-04-25) · 0 weekly downloads

## Install

```sh
npm install mail-notifier2
pnpm add mail-notifier2
yarn add mail-notifier2
bun add mail-notifier2
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0-2 |
| Published | 2013-04-25 |
| First published | 2013-04-23 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | ~0.8.x |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Jerome Creignou, Sander Pick |
| Maintainers | sanderpick |
| Keywords | imap, mail, notifier |

## Links

- npm: https://www.npmjs.com/package/mail-notifier2
- Repository: https://github.com/sanderpick/nodejs-mail-notifier
- npm.io page: https://npm.io/package/mail-notifier2

## Dependencies (3)

- [seq](https://npm.io/package/seq.md) ~0.3.5
- [imap](https://npm.io/package/imap.md) ~0.7.9
- [mailparser](https://npm.io/package/mailparser.md) ~0.3.4

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.1.0-2 (latest) — 2013-04-25
- 0.1.0-1 — 2013-04-24
- 0.1.0 — 2013-04-23

## README

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 :

```javascript
var notifier = require('mail-notifier');

var imap = {
  username: "yourimapuser",
  password: "yourimappassword",
  host: "imap.host.com",
  port: 993, // imap port
  secure: true // use secure connection
};

notifier(imap).on('mail',function(mail){console.log(mail);}).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 host
 * `port` :  imap server port number
 * `username` :  imap user name
 * `password` :  imap password
 * `secure` :  need secure connection to server

.start()
------------------------------------
Start listening for incomming emails.

Events
======

'mail'
-----
Sent on incoming new unread email. The parsed Mail is given as first parameter to the event listener.

---
_Source: https://npm.io/package/mail-notifier2 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._