Inbox is a set of tools to make it simple to develop apps and services on top of email. This includes a modern RESTful API that return JSON and Unicode objects. See the full API documentation for more details.

1. Install VirtualBox

2. Install Vagrant

3. git clone git@github.com:inboxapp/inbox.git

4. cd inbox

5. vagrant up

   Feel free to check out the Vagrantfile while this starts up. It creates a host-only network for the VM at 192.168.10.200.

6. vagrant ssh

   At this point you should be SSH'd into a shiny new Ubuntu 12.04 VM. The inbox directory you started with should be synced to /vagrant.

   If not, run vagrant reload and vagrant ssh again. You should see the shared folder now.

7. cd /vagrant

8. bin/inbox-start

And voilà! Auth an account via the commandline to start syncing:

bin/inbox-auth ben.bitdiddle1861@gmail.com

Please create an issue if you use a mail provider not listed here.

We'd love your help making Inbox better! Join the Google Group for project updates and feature discussion. We also hang out in ##inbox on irc.freenode.net, or you can email help@inboxapp.com.

Please sign the Contributor License Agreement before submitting patches. (It's similar to other projects, like NodeJS or Meteor.)

We maintain strict code style, following pep8, the Google Python style guide, and numpy docstring conventions.

We standardize on single-quotes for strings literals e.g. 'my-identifier', but use double-quotes for strings that are likely to contain single-quote characters as part of the string itself (such as error messages, or any strings containing natural language), e.g. "You've got an error!".

This code is free software, licensed under the The GNU Affero General Public License (AGPL). See the LICENSE file for more details.

You should do git config branch.master.rebase true in the repo to keep your history nice and clean. You can set this globally using git config --global branch.autosetuprebase remote.