mirror of https://github.com/moparisthebest/mail synced 2024-11-23 01:12:19 -05:00

Go to file

Tankred Hase a730cad49d Merge pull request #67 from whiteout-io/dev/WO-373 refactor sync		2014-06-03 12:32:59 +02:00
res	add channel push script	2013-11-14 10:49:38 +01:00
src	add documentation to email dao	2014-06-03 12:30:51 +02:00
test	add documentation to email dao	2014-06-03 12:30:51 +02:00
.gitignore	add build for node-webkit	2014-03-02 17:56:42 +01:00
.jshintrc	get requirejs bootstrapping working	2014-03-02 23:05:09 +01:00
.travis.yml	update readme and change deps to https github tarballs	2014-01-15 17:07:14 +01:00
Gruntfile.js	Change stable tag from alpha to beta	2014-05-12 17:52:04 +02:00
LICENSE.txt	Update LICENSE.txt	2014-04-15 18:34:33 +02:00
package.json	update dependencies	2014-06-02 15:13:02 +02:00
README.md	Update README.md	2014-05-23 11:36:12 +02:00

README.md

mail-html5

Whiteout Mail is an easy to use email client with integrated OpenPGP encryption written in pure JavaScript. Download the official version under whiteout.io.

Features

You can read about product features and our future roadmap in our FAQ.

Privacy and Security

We take the privacy of your data very seriously. Here are some of the technical details:

Messages are encrypted end-to-end using the OpenPGP standard. This means that only you and the recipient can read your mail. Your messages and private PGP key are stored encrypted on your computer and are never sent to our our servers.
Like most native email clients whiteout mail uses raw TCP sockets to communicate directly with your mail server via IMAP/SMTP.
Mail server SSL certificates are pinned under src/ca/ in order to protect against SSL certificate forgery and other man in the middle attacks.
The app is deployed as a Chrome Packaged App with auditable static versions in order to prevent problems with host-based security.
Content Security Policy (CSP) is enforced to prevent against injection attacks.

Reporting bugs and feature requests

We will launch a bug bounty program later on for independant security researchers. If you find any security vulnerabilities, don't hesitate to contact us security@whiteout.io.
You can also just create an issue on GitHub if you're missing a feature or just want to give us feedback. It would be much appreciated!

Testing

You can download a prebuilt bundle under releases or build your own from source (requires node.js, grunt and sass):

npm install && npm test

This will download all dependencies, run the tests and build the Chrome Packaged App bundle DEV.zip which can be installed under chrome://extensions in developer mode.

Development

For development you can start a connect dev server:

grunt dev

Then visit http://localhost:8580/dist/chrome.html#/desktop for front-end code or http://localhost:8580/test/new-unit/ to test JavaScript changes. You can also start a watch task so you don't have rebuild everytime you make a change:

grunt watch

Releasing

grunt release-test --release=0.0.0.x
grunt release-stable --release=0.x.0

License

Copyright © 2014, Whiteout Networks GmbH. All rights reserved.

The code is open for inspection and peer review by the security community.
The code is currently not licensed under an open source license. If you're
interested in contributing or getting a license, please get in touch with
us (info@whiteout.io).

Third party libraries

We work together with existing open source projects wherever possible and contribute any changes we make back upstream. Many of theses libraries are licensed under an open source license. Here are some of them:

OpenPGP.js (LGPL license): An implementation of OpenPGP in Javascript
email.js (MIT license): IMAP, SMTP, MIME-building and MIME-parsing engine
Forge (BSD license): An implementation of TLS in JavaScript