You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
Jakub babb4412ae
chore: Bridge Perth Narrows 3.0.21
1 week ago
cmd fix(GODT-2458): Wait for both bridge and bridge-gui to be ended before restarting on crash. 3 weeks ago
dist GODT-2134: fix dock icon on macOS when launched with '--no-window'. 4 months ago
extern Other: added vcpkg as a submodule + build scripts 7 months ago
internal feat(GODT-2509): Migrate TLS cert from v1/v2 location during upgrade to v3 1 week ago
pkg fix(GODT-2481): Fix DBUS Secert Service 1 week ago
release-notes Other: Update release notes. 4 months ago
tests fix(GODT-2323): Fix Expunge not issued for move 2 months ago
utils Other: added C/C++ header template file (* type to script. 3 months ago
.gitignore GODT-1779: Remove go-imap 5 months ago
.gitlab-ci.yml Other(CI): Make race checks manual 2 months ago
.gitmodules Other: added vcpkg as a submodule + build scripts 7 months ago
.golangci.yml GODT-2034: Basic vault migration ability (proof of concept) 5 months ago feat(GODT-2357): Hide DSN_SENTRY and use single setting point for DSN_SENTRY. 4 weeks ago GODT-1817: Restore move related feature tests 3 months ago chore: Bridge Perth Narrows 3.0.21 1 week ago
Makefile chore: Bridge Perth Narrows 3.0.21 1 week ago GODT-2291: Change gluon store default location from Cache to Data. 2 months ago
go.mod fix(GODT-2513): Crash in scanner 1 week ago
go.sum fix(GODT-2513): Crash in scanner 1 week ago

Proton Mail Bridge and Import Export app

Copyright (c) 2022 Proton AG

This repository holds the Proton Mail Bridge and the Proton Mail Import-Export applications. For a detailed build information see BUILDS. The license can be found in LICENSE file, for more licensing information see COPYING_NOTES. For contribution policy see CONTRIBUTING.

Description Bridge

Proton Mail Bridge for e-mail clients.

When launched, Bridge will initialize local IMAP/SMTP servers and render its GUI.

To configure an e-mail client, firstly log in using your Proton Mail credentials. Open your e-mail client and add a new account using the settings which are located in the Bridge GUI. The client will only be able to sync with your Proton Mail account when the Bridge is running, thus the option to start Bridge on startup is enabled by default.

When the main window is closed, Bridge will continue to run in the background.

More details on the public website.


Launchers are binaries used to run the Proton Mail Bridge or Import-Export apps.

Official distributions of the Proton Mail Bridge and Import-Export apps contain both a launcher and the app itself. The launcher is installed in a protected area of the system (i.e. an area accessible only with admin privileges) and is used to run the app. The launcher ensures that nobody tampered with the app's files by verifying their signature using a hardcoded public key. App files are placed in regular userspace and are signed by Proton's private key. This feature enables the app to securely update itself automatically without asking the user for a password.


You need to have a keychain in order to run the Proton Mail Bridge. On Mac or Windows, Bridge uses native credential managers. On Linux, use secret-service API (e.g. Gnome keyring) or pass. We are working on allowing other secret services (e.g. KeepassXC), but for now only gnome-keyring is usable without major problems.

Environment Variables

Bridge application

  • BRIDGESTRICTMODE: tells bridge to turn on bbolt's "strict mode" which checks the database after every Commit. Set to 1 to enable.

Dev build or run

  • APP_VERSION: set the bridge app version used during testing or building
  • PROTONMAIL_ENV: when set to dev it is not using Sentry to report crashes
  • VERBOSITY: set log level used during test time and by the makefile

Integration testing

  • TEST_ENV: set which env to use (fake or live)
  • TEST_ACCOUNTS: set JSON file with configured accounts
  • TAGS: set build tags for tests
  • FEATURES: set feature dir, file or scenario to test


There are now three types of system folders which Bridge recognises:

Windows Mac Linux Linux (XDG)
config %APPDATA%\protonmail\bridge-v3 ~/Library/Application Support/protonmail/bridge-v3 ~/.config/protonmail/bridge-v3 $XDG_CONFIG_HOME/protonmail/bridge-v3
cache %LOCALAPPDATA%\protonmail\bridge-v3 ~/Library/Caches/protonmail/bridge-v3 ~/.cache/protonmail/bridge-v3 $XDG_CACHE_HOME/protonmail/bridge-v3
data %APPDATA%\protonmail\bridge-v3 ~/Library/Application Support/protonmail/bridge-v3 ~/.local/share/protonmail/bridge-v3 $XDG_DATA_HOME/protonmail/bridge-v3
temp %LOCALAPPDATA%\Temp $TMPDIR if non-empty, else /tmp $TMPDIR if non-empty, else /tmp $TMPDIR if non-empty, else /tmp


Base Dir Path
bridge lock file cache bridge.lock
bridge-gui lock file cache bridge-gui.lock
vault config vault.enc
gRPC server json config grpcServerConfig.json
gRPC client json config grpcClientConfig_.json
Logs data logs
gluon DB data gluon/backend/db
gluon messages sata gluon/backend/store
Update files data updates
sentry cache data sentry_cache
Mac/Linux File Socket temp bridge_{RANDOM_UUID}.sock