A third-party, open-source ProtonMail CardDAV, IMAP and SMTP bridge。
A third-party, open-source ProtonMail bridge. For power users only, designed to run on a server.
hydroxide supports CardDAV, IMAP and SMTP.
Rationale:
- No GUI, only a CLI (so it runs in headless environments)
- Standard-compliant (we don't care about Microsoft Outlook)
- Fully open-source
Feel free to join the IRC channel: #emersion on Libera Chat.
How does it work?
hydroxide is a server that translates standard protocols (SMTP, IMAP, CardDAV)
into ProtonMail API requests. It allows you to use your preferred e-mail clients
and git-send-email
with ProtonMail.
+-----------------+ +-------------+ ProtonMail +--------------+
| | IMAP, SMTP | | API | |
| E-mail client <-------------> hydroxide <--------------> ProtonMail |
| | | | | |
+-----------------+ +-------------+ +--------------+
Setup
Go
hydroxide is implemented in Go. Head to Go website for setup information.
Installing
Start by installing hydroxide:
git clone https://github.com/emersion/hydroxide.git
GO111MODULE=on go build ./cmd/hydroxide
Then you'll need to login to ProtonMail via hydroxide, so that hydroxide can retrieve e-mails from ProtonMail. You can do so with this command:
hydroxide auth <username>
Once you're logged in, a "bridge password" will be printed. Don't close your terminal yet, as this password is not stored anywhere by hydroxide and will be needed when configuring your e-mail client.
Your ProtonMail credentials are stored on disk encrypted with this bridge password (a 32-byte random password generated when logging in).
Usage
hydroxide can be used in multiple modes.
Don't start hydroxide multiple times, instead you can use
hydroxide serve
. This requires ports 1025 (smtp), 1143 (imap), and 8080 (carddav).
SMTP
To run hydroxide as an SMTP server:
hydroxide smtp
Once the bridge is started, you can configure your e-mail client with the following settings:
- Hostname:
localhost
- Port: 1025
- Security: none
- Username: your ProtonMail username
- Password: the bridge password (not your ProtonMail password)
CardDAV
You must setup an HTTPS reverse proxy to forward requests to hydroxide
.
hydroxide carddav
Tested on GNOME (Evolution) and Android (DAVDroid).
IMAP
Warning: IMAP support is work-in-progress. Here be dragons.
For now, it only supports unencrypted local connections.
hydroxide imap
from https://github.com/emersion/hydroxide
No comments:
Post a Comment