-
Notifications
You must be signed in to change notification settings - Fork 1k
Getting started
Mailpile is currently only released in source form, from our Github repository.
The quickest way to get up and running, is to follow one of the following guides:
When that is done, the following guides will help you configure the software and get started using it:
If you are using some other operating system or are a developer who prefers Docker, Virtualenv or PIP to the above recipes, please read on...
======================================================================================================
If you are using some other operating system you are on your own, but the following general guidelines may be of use.
- Python 2.7
- python-imaging 1.1.7
- python-lxml 2.3.2
- python-jinja2 2.6
- spambayes 1.1a6
You will also need a tool which can download your e-mail and store in one of the following formats:
- Unix mbox
- Unix Maildir
- Windows Maildir
- Mac Mail.app format
- GMVault
If you're the kind of Python dev who prefers to stay in the Python universe, the PIP tool can be used to install the required packages:
$ pip install -r requirements.txt
Note that this requires having a functioning C development environment and sometimes lxml can be a bit tricky to install. For Debian-based distributions, the required development libraries can be installed like so:
$ sudo apt-get install libxml2-dev libxslt1-dev
as per this Stack Overflow answer.
The Makefile includes a recipe for setting up a virtualenv for use with Mailpile:
$ make virtualenv
$ source mp-virtualenv/bin/activate
$ mailpile
This allows easy, sandboxed usage.
You can build a docker image:
$ docker build -t mailpile scripts/docker/
and run it:
$ docker run -i -t -p 33411:33411 mailpile
or enter the container's bash prompt directly:
$ docker run -i -t mailpile bash