Jakub 874882b554 Logic change to follow old code.		5 years ago
.github/ISSUE_TEMPLATE	chore: add version info to github issue template	5 years ago
cmd	Cookies for Import-Export	6 years ago
doc	Import-Export app everywhere	6 years ago
icon.iconset	We build too many walls and not enough bridges	6 years ago
internal	Custom types for flags and encrypted outside test	5 years ago
pkg	Logic change to follow old code.	5 years ago
release-notes	Import-Export Elbe 1.2.1	5 years ago
test	Remove unnecessary semicolon	5 years ago
utils	Keep Import-Export credits up to date	6 years ago
.gitattributes	use unreleased for changes	5 years ago
.gitignore	fix: gitignore should also ignore ie build files	6 years ago
.gitlab-ci.yml	CI artifacts only for a day	6 years ago
.gitmodules	We build too many walls and not enough bridges	6 years ago
.golangci.yml	Import-Export Elbe 1.2.1	5 years ago
BUILDS.md	Apply 1 suggestion(s) to 1 file(s)	5 years ago
CONTRIBUTING.md	We build too many walls and not enough bridges	6 years ago
COPYING.md	fix 404 errors by using absolute urls	6 years ago
Changelog.md	use unreleased for changes	5 years ago
LICENSE	We build too many walls and not enough bridges	6 years ago
Makefile	Build creates proper binary names	5 years ago
README.md	README and BUILD info about Import-Export and tags	5 years ago
go.mod	feat: switch to public go-rfc5322 parser	5 years ago
go.sum	feat: switch to public go-rfc5322 parser	5 years ago
unreleased.md	Fixing lint and integration tests, changelog, GODT-880, and typos	5 years ago

README.md

ProtonMail Bridge and Import Export app

This repository holds the ProtonMail Bridge and the ProtonMail Import-Export applications. For a detailed build information see BUILDS. For licensing information see COPYING. For contribution policy see CONTRIBUTING.

Description Bridge

ProtonMail 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 ProtonMail 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 ProtonMail 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.

Description Import-Export app

ProtonMail Import-Export app for importing and exporting messages.

To transfer messages, firstly log in using your ProtonMail credentials. For import, expand your account, and pick the address to which to import messages from IMAP server or local EML or MBOX files. For export, pick the whole account or only a specific address. Then, in both cases, configure transfer rules (match source and target mailboxes, set time range limits and so on) and hit start. Once the transfer is complete, check the results.

More details on the public website.

Keychain

You need to have a keychain in order to run the ProtonMail Bridge. On Mac or Windows, Bridge uses native credential managers. On Linux, use Gnome keyring or pass.

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_APP: set which app to test (bridge or ie)
TEST_ACCOUNTS: set JSON file with configured accounts
TAGS: set build tags for tests
FEATURES: 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 (unless XDG_CACHE_HOME is 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: ~/.cache/protonmail/bridge/<cacheVersion>/prefs.json (unless XDG_CACHE_HOME is set, in which case that is used as your ~)
macOS: ~/Library/Caches/protonmail/bridge/<cacheVersion>/prefs.json
Windows: %LOCALAPPDATA%\protonmail\bridge\<cacheVersion>\prefs.json

IMAP Cache

The currently subscribed mailboxes are held in a json file:

Linux: ~/.cache/protonmail/bridge/<cacheVersion>/user_info.json (unless XDG_CACHE_HOME is 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 (unless XDG_CACHE_HOME is 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 (unless XDG_CONFIG_HOME is 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