Skip to content

Latest commit

 

History

History
49 lines (39 loc) · 1.3 KB

README.md

File metadata and controls

49 lines (39 loc) · 1.3 KB
Raw

yama

yet another mail app

yama syncs couchdb instance with an email inbox (imap) i.e., enables a local RESTful interface to your email with a powerful database to use for fun things later.

installation

$ virtualenv --no-site-packages --distribute -pPython2.7 venv
$ source venv/bin/activate
$ pip install git+https://github.com/balsagoth/imbox
$ pip install -r requirements.txt

usage

$ couchdb
$ source venv/bin/activate
$ python yama.py -imap "imap.gmail.com" -u "[email protected]" -p "YOUR_GMAIL_PW" -db "http://127.0.0.1:5984/"

Running yama.py should spin thru your imap endpoint (gmail account in this case) and pull down all messages and sync each one with the local couchdb instance running at the db endpoint. This means you can visit your mail locally now by opening your browser to: http://localhost:5984/

Useful local urls:

  • /all_dbs: lists databases (look for messages, the yama-generated db name for this imap endpoint account)
  • /messages_/_all_docs: lists all docs (emails) saved in this database
  • /messages_/: GETs the doc (email) with the given id

author

Thomas Willey

license

Open sourced under the MIT license.