a2ab5df7ce
Revise syncing work distribution. Sync time can be reduced by up to 50%. Rework the sync so that it pipelines better with bigger batch counts at each stage. We now use 3 separate stages: Download, Updates and Sync. The Download stage downloads messages in maxBatchSize intervals using 1.5x syncWorkers. Once the current batch has finished downloading it's forwarded to the Updates stage and we proceed to download the next batch. The Update stage converts everything into gluon updates and prepares a collection of noops that the sync stage can wait on for termination. Finally the sync stage waits until the updates have been applied in Gluon so that the vault information can be updated. We allow up to 4 pending wait operations to be queued currently to not block the pipeline.
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
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.
Keychain
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 freedesktop.org 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 onbbolt's "strict mode" which checks the database after everyCommit. Set to1to enable.
Dev build or run
APP_VERSION: set the bridge app version used during testing or buildingPROTONMAIL_ENV: when set todevit is not using Sentry to report crashesVERBOSITY: 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 accountsTAGS: set build tags for testsFEATURES: set feature dir, file or scenario to test
Files
Database
The database stores metadata necessary for presenting messages and mailboxes to an email client:
- Linux:
~/.cache/protonmail/bridge/<cacheVersion>/mailbox-<userID>.db(unlessXDG_CACHE_HOMEis set, in which case that is used as your~) - macOS:
~/Library/Caches/protonmail/bridge/<cacheVersion>/mailbox-<userID>.db - Windows:
%LOCALAPPDATA%\protonmail\bridge\<cacheVersion>\mailbox-<userID>.db
Preferences
User preferences are stored in json at the following location:
- Linux:
~/.config/protonmail/bridge/prefs.json - macOS:
~/Library/ApplicationSupport/protonmail/bridge/prefs.json - Windows:
%APPDATA%\protonmail\bridge\prefs.json
IMAP Cache
The currently subscribed mailboxes are held in a json file:
- Linux:
~/.cache/protonmail/bridge/<cacheVersion>/user_info.json(unlessXDG_CACHE_HOMEis set, in which case that is used as your~) - macOS:
~/Library/Caches/protonmail/bridge/<cacheVersion>/user_info.json - Windows:
%LOCALAPPDATA%\protonmail\bridge\<cacheVersion>\user_info.json
Lock file
Bridge utilises an on-disk lock to ensure only one instance is run at once. The lock file is here:
- Linux:
~/.cache/protonmail/bridge/<cacheVersion>/bridge.lock(unlessXDG_CACHE_HOMEis set, in which case that is used as your~) - macOS:
~/Library/Caches/protonmail/bridge/<cacheVersion>/bridge.lock - Windows:
%LOCALAPPDATA%\protonmail\bridge\<cacheVersion>\bridge.lock
TLS Certificate and Key
When bridge first starts, it generates a unique TLS certificate and key file at the following locations:
- Linux:
~/.config/protonmail/bridge/{cert,key}.pem(unlessXDG_CONFIG_HOMEis set, in which case that is used as your~/.config) - macOS:
~/Library/ApplicationSupport/protonmail/bridge/{cert,key}.pem - Windows:
%APPDATA%\protonmail\bridge\{cert,key}.pem