hhy5277 / application

:envelope: Unofficial Electron wrapper for ProtonMail

ProtonMail Desktop

ProtonMail Desktop is an unofficial app that emulates a native client for the ProtonMail e-mail service. Check out more about Protonmail in their website.

We are not affiliated with ProtonMail team. All copyrights belong to their respective owners.

Features

Background behaviour

When closing the window, the app will continue running in the background. On OSX, app will be available in the dock and on WIN & Linux (depends on distro) in the tray. Right-click the dock/tray icon and choose Quit to completely quit the app. On OS X, click the dock icon to show the window. On Linux, right-click the tray icon and choose Toggle to toggle the window. On Windows, click the tray icon to toggle the window.

Native Notifications

Native notifications are working for all OS, you will get a notification when you receive a new email and window is not focused (i.e. app minimized).

Dev and contributing

Built with Electron and React. Write unit tests for new functionality and add e2e test when appropriate.

Dev and compile works on OS X, Linux, and Windows. You will need Yarn to run this app.

Any contribution or suggestion is accepted. Feel free to create any report for issues or app crashes. You can also use the report link provided in the application menu to create a crash report. Pull requests are accepted.

Developing

1. yarn
2. yarn start

Running the App

Executables

You can build your own executables from the latest source by running one of the commands below. More stable, older executables can be found here.

Compiling from source

The installer is provided by electon-builder and processed through webpack.

1. $ yarn
2. $ yarn build:prod
3. $ yarn run dist to package in a distributable format.
4. $ yarn run pack to generate package directory without distributable.

The building settings is in ./package.json and additional configuration instructions can be found here. The building process will only create version for the current OS. For creating MacOS, Windows and Linux distributable you need to run the command from each OS.

License

MIT See License.md
Free Software, Hell Yeah!