https://github.com/matthewhadley/gmail-notifier

OSX notification center alerts for your gmail
https://github.com/matthewhadley/gmail-notifier

Last synced: 3 months ago
JSON representation

OSX notification center alerts for your gmail

• Host: GitHub
• URL: https://github.com/matthewhadley/gmail-notifier
• Owner: matthewhadley
• License: mit
• Created: 2013-04-21T22:07:44.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2015-08-12T18:37:06.000Z (over 9 years ago)
• Last Synced: 2024-05-31T21:00:29.651Z (6 months ago)
• Language: Shell
• Size: 370 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gmail-notifier

Get OSX message center notifications for new unread emails in your gmail inbox. Ideal if you just use the web version of

gmail and so don't have a way to have notifications triggered.

![notification](https://raw.github.com/wiki/diffsky/gmail-notifier/notification.jpg)

# Installation

- clone the repo somewhere then copy the `gmail-notifier` directory into your `/Applications` directory (or create a symlink to the cloned repo).

- make sure you have a keychain entry with your gmail details, where the account value is your gmail address

- run the notifier script once to, ensure it has the right permissions (you may be prompted togive keychain access)

   - `./gmail-notifier/gmail-notifier -k gmail -o -v` # where *gmail* is the name of your keychain key with your gmail details

- by default checks for new emails happen every 10 seconds, edit the `gmail-notifier/gmail-notifier.plist` file if you wish to change that interval

- configure gmail-notifier run at login with this command `launchctl load /Applications/gmail-notifier/com.diffsky.gmail-notifier.plist`

You should now start getting notifications.

To deactivate notifications run: `launchctl unload /Applications/gmail-notifier/com.diffsky.gmail-notifier.plist`

To have gmail-notifier start automatically at login, copy the plist into your LaunchAgents directory: `cp /Applications/gmail-notifier/com.diffsky.gmail-notifier.plist ~/Library/LaunchAgents/`

# Credits

The functionality for displaying the notifications is all from [terminal-notifier](https://github.com/alloy/terminal-notifier).

A bundled version of that app is provided so that the icon can be modified to [look more like gmail](http://www.iconarchive.com/show/handycons-2-icons-by-jankoatwarpspeed/gmail-icon.html) ([from Janko](http://www.jankoatwarpspeed.com/)). This is due to a [restriction in notification center](https://github.com/alloy/terminal-notifier/issues/31#issuecomment-9169599) that means it only shows app's icon. So there is a [forked version of terminal-notifier with this changed icon](https://github.com/diffsky/terminal-notifier/tree/gmail-notifier).