# Welcome to Mailpile! #

**IMPORTANT NOTE**

Development on this codebase has halted, until the
[Python3 rewrite](https://community.mailpile.is/t/a-very-uninformative-progress-update-mailpile-2/785)
has completed.

Apologies to those who have unanswered, out-standing pull requests and
issues. 😢 Your efforts are appreciated!

If you rely on this code and have your own branch which you actively
maintain, let us know: we would be happy to link to it.

If you need to run Mailpile v1 to access legacy data, consider using
our [legacy Docker images](https://github.com/mailpile/Mailpile-v1-Docker).


------------------------------------------------------------------------

## Introduction (Obsolete) ##

Mailpile (<https://www.mailpile.is/>) is a modern, fast web-mail client
with user-friendly encryption and privacy features. The development of
Mailpile is funded by
[a large community of backers](https://www.mailpile.is/#community)
and all code related to the project is and will be released under an OSI
approved Free Software license.

Mailpile places great emphasis on providing a clean, elegant user
interface and pleasant user experience. In particular, Mailpile aims to
make it easy and convenient to receive and send PGP encrypted or signed
e-mail.

Mailpile's primary user interface is web-based, but it also has a basic
command-line interface and an API for developers. Using web technology
for the interface allows Mailpile to function both as a local desktop
application (accessed by visiting `localhost` in the browser) or a
remote web-mail on a personal server or VPS.

The core of Mailpile is a fast search engine, custom written to deal
with large volumes of e-mail on consumer hardware. The search engine
allows e-mail to be organized using tags (similar to GMail's labels) and
the application can be configured to automatically tag incoming mail
either based on static rules or bayesian classifiers.


### Trying Mailpile

If you need to run Mailpile v1 to access legacy data, consider using
our [legacy Docker images](https://github.com/mailpile/Mailpile-v1-Docker).


## Credits and License ##

Bjarni R. Einarsson (<http://bre.klaki.net/>) created this!  If you
think it's neat, you should also check out PageKite:
<https://pagekite.net/>. [Smári](<http://www.smarimccarthy.is/>) and
[Brennan](https://brennannovak.com) joined the team in 2013 and made
this a real project (not just a toy search engine).

The original GMail team deserve a mention for their inspiring work:
wishing the Free Software world had something like GMail is what
motivated Bjarni to start working on Mailpile. We would also like to
thank Edward Snowden for inspiring us to try and make PGP usable for
journalists and everday folks!

Contributors:

- Bjarni R. Einarsson (<http://bre.klaki.net/>)
- Brennan Novak (<https://brennannovak.com/>)
- Smari McCarthy (<http://www.smarimccarthy.is/>)
- Lots more, run `git shortlog -s` for a list! (Or check
  [GitHub](https://github.com/mailpile/Mailpile/graphs/contributors).)

And of course, we couldn't do this without [our community of
backers](https://www.mailpile.is/#community).

This program is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published by
the Free Software Foundation. See the file `COPYING.md` for details.

