Project

imap_notifier

0.01
No commit activity in last 3 years
No release in over 3 years
imap_notifierdacamp/imap_notifierHomepageDocumentationSource CodeBug TrackerWiki
Notification of new, unread email via IMAP
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
25,784
Stars
14
Forks
3
Watchers
2
 Releases
Current version
0.3.0
Total releases
10
First release
2013-08-21
Latest release
2020-05-04
 Pull Requests
Open Pull Requests
2
Closed Pull Requests
1
Merged Pull Requests
7
Pull Request Acceptance Rate
70%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2014-10-08
Reverse Dependencies
0

 Dependencies

Development

bundler
>= 0
rake
>= 12.3.3

Runtime

highline
>= 0
ruby-growl
>= 0
terminal-notifier
>= 0
 Project Readme

IMAP Notifier

Notification of new, unread email via IMAP using Ruby, Highline, Net/IMAP, and terminal-notifier/ruby-growl.

If you're running Max OSX > 10.8, terminal-notifier is required, otherwise ruby-growl and Growl is required.

Setup

Configure your .imap_notifier config file in your homedir or specific the flags via the command line. Your config file must have permissions of 600, thus allowing you to put in your password if you so choose. The config file is in YAML format and should be read in as a hash.

Example ~/.imap_notifier file

folders:
 - INBOX
 - Monitoring
 - Commits
 - Team+Status
user:   'han.solo'
domain: 'example.org'
server: 'imap.server.com'
password: "1H@t3BuG$!"
max: 10
pid: /tmp/imap_notifier.1.pid  # defaults to /tmp/imap_notifier.pid set this to initialize multiple imap_notifier instances
ignore_exit_code: true  #defaults to false. When true, returns 0 instead of 1 on existing pidfile exit

For Keychain Access support, specify the keychain item name and account in .imap_notifier. The item must be designated an 'Internet password' in Keychain Access.

key_name:    'keychain.name.com'
key_account: 'han.solo@keychain-account.com'

For pass support, specify the pass-name.

pass: 'han.solo'

For 1pass support, specify the item and keychain path (if not ~/Dropbox/1Password.agilekeychain).

onepass:  'han.solo'
one_path: '/Volumes/passwords/1Password.agilekeychain'

Usage

$ ./bin/imap_notifier   -h
  Usage: imap_notifier [OPTIONS]
  Options:
   -h, --help                      Display this message
   -V, --version                   Display 'IMAP Notifier 0.2.0' and exit
   -v, --debug                     Write debug output into /tmp/imap_notifier.debug
   -f, --file FILE                 Read configuration file. [DEFAULT: ~/.imap_notifier]
   -s, --server STR                Specify imap server. [Default: imap.gmail.com]
   -d, --domain STR                Specify email domain. [Default: gmail.com]
   -u, --user STR                  Specify user login. [Default: ENV['USER']]
   -m, --max INT                   Max mail mentioned before grouping them together. [Default: 5]
   -k, --kill                      Kill currently running IMAP Notifier process with SIGINT

Tips

  • User name is pulled from your environment via ruby ENV['USER']
  • If the root domain of your IMAP server is the same as your email domain (i.e. imap.gmail.com IS the same as user@gmail.com) then you only need to specify the IMAP server.