Contents

= geekmail

Small ruby script that checks the count of emails in your IMAP inbox.

To install, please run
  gem install geekmail

followed by adding a geek shell script like:
  echo "`geekmail` unhandled emails"

The script needs a configuration for your email server. Please add a ~/.geekmail.conf file (with correct permissions) that looks something like this:

	config:
	  host: imap.gmail.com
	  port: 993
	  username: YOUR_EMAIL
	  password: YOUR_PASSWORD

Troubleshooting tip:
As geektools does not have the same value for $PATH as your shell, you might need to add some extra paths to your geektool shell command. In my case I also had to export the GEM_PATH. I ended up with the following command:
  export GEM_PATH=/usr/local/Cellar/gems/1.8;
  export PATH=$PATH:/usr/local/bin:/Users/seb/.gem/ruby/1.8/bin;
  echo "`geekmail` unhandled emails"


== Contributing to geekmail
 
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
* Fork the project
* Start a feature/bugfix branch
* Commit and push until you are happy with your contribution
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

== Copyright

Copyright (c) 2010 Sebastian. See LICENSE.txt for
further details.

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
geekmail-0.1.2	README.rdoc