Mailvelope

Mailvelope is a browser extension for Google Chrome and Firefox that allows secure email communication based on the OpenPGP standard. It can be configured to work with arbitrary Webmail provider.

OpenPGP backends

Mailvelope uses the following OpenPGP implementation

• OpenPGP.js for the Chrome Extension and for the Firefox Addon

Installation

Mailvelope is available in the Chrome Web Store: https://chrome.google.com/webstore/detail/kajibbejlbohfaggdiogboambcijhkke

For Firefox you can get it from addons.mozilla.org: https://addons.mozilla.org/en/firefox/addon/mailvelope/

Or check the releases section for latest builds of Firefox and Chrome installation packages.

Client API

You can find the current API Documentation on GitHub pages. The version will correspond to the current master branch. A demo page with unit tests is available at: https://demo.mailvelope.com.

Build instructions

If you don’t have grunt installed, yet:

npm install -g grunt-cli

and then get and build the sources:

git clone https://github.com/mailvelope/mailvelope.git
cd mailvelope
npm ci && grunt prod

Chrome

grunt dist-cr

The Chrome extension will be in dist/mailvelope.chrome.zip.

Firefox

grunt dist-ff

The Firefox web extension will be in dist/mailvelope.firefox.zip.

Development

Update your local repository:

# inside mailvelope folder
git checkout dev
git pull origin dev && grunt
# continue with 'grunt dist-cr' or 'grunt dist-ff'

There are a few more tasks/tools available:

• watch source code for changes and recompile if needed

  grunt watch

• test the firefox plugin

npx web-ext run --source-dir=./build/firefox

It is possible to reload the plugin on changes, run the grunt watch task on another console terminal

• reset repository

  grunt clean

Website

https://www.mailvelope.com

Licence

Use of this source code is governed by the GNU AFFERO GENERAL PUBLIC LICENSE that can be found in the LICENSE file.

About

Contact: Thomas Oberndörfer thomas@mailvelope.com Twitter: @mailvelope Contributors: see list on GitHub