##Table of Contents##

• A. Description
• B. Installation
  • B.1. Prerequisites
  • B.2. Install
• C. Configuration
• D. Running notifmail
• E. notifmail 'home' directory
  • E.1. notifmail.conf
  • E.2. notifmail.log
  • E.3. notifmail.lock

notifmail is an email daemon checker which notifies system about new emails on configured IMAP servers.

Have python and other prerequisites on host:

• python
• python-notify2
• openssl
• python-daemon

Example - Fedora:

$ sudo yum install python openssl python-daemon python-pip
$ sudo pip install notify2

Example - Ubuntu:

$ sudo apt-get install python python-notify2 openssl python-daemon

$ cd <notifmail git clone directory>
$ sudo ./setup.py install

notifmail uses a configuration for connection to IMAP server and for other configurations. A sample file one is packaged in the sources as "notifmail.conf.sample". To get started copy this file in ~/.notifmail:

$ mkdir ~/.notifmail
$ cp ./notifmail.conf.sample ~/.notifmail/notifmail.conf

Edit ~/.notifmail/notifmail.conf.sample with your configuration.

To start notifmail:

$ notifmail

For more info about notifmail's command line parameters:

$ notifmail -h

notifmail's 'home' directory is located in $HOME/.notifmail and contains:

This file contains the IMAP accounts configuration to be used by notifmail. Can contain multiple accounts but each account must include:

• imap_server
• imap_user
• imap_password

There are two optional variables:

• all: Used to define mailboxes for which notifmail should trigger a notification with every new email. Multiple mailboxes must be separated by semicolon.
• summary: Used to define mailboxes for which notifmail should trigger one summary notification. Multiple mailboxes must be separated by semicolon. See C. Configuration also.

This is the logging file. By default notifmail runs as daemon so all messages go to this file. If you run daemon in foreground, log messages will be duplicated between logfile and stdout. For more info run:

$ notifmail -h

This is a lock file to avoid having multiple notifmail instances.