This is not an official python ProtonMail API client. it allows you to read, send and delete messages in protonmail, as well as render a ready-made template with embedded images.
Installation
pip install protonmail-api-client
Using
from protonmail import ProtonMail
username = "YouAddress@proton.me"
password = "YourPassword123"
proton = ProtonMail()
proton.login(username, password)
# Get a list of all messages
messages = proton.get_messages()
# Read the latest message
message = proton.read_message(messages[0])
print(message.sender.address) # sender address
print(message.subject) # subject
print(message.body)
# <html><body><div>it's my image: <img src="cid:1234@proton.me">....
# Render the template, images downloading, converting to BASE64 and insert into html
proton.render(message)
# This is a ready-made html page, with all the pictures, you can save it right away
with open('message.html', 'w', encoding='utf-8') as f:
f.write(message.body)
print(message.body)
# <html><body><div>it's my image: <img src="data:image/png;base64, iVBORw0K..">....
# Download file from message
first_file = message.attachments[0]
proton.download_files([first_file])
with open(f'{first_file.name}', 'wb') as f:
f.write(first_file.content)
# Create attachments
with open('image.png', 'rb') as f:
img = f.read()
with open('resume.pdf', 'rb') as f:
pdf = f.read()
img_attachment = proton.create_attachment(content=img, name='image.png')
pdf_attachment = proton.create_attachment(content=pdf, name='resume.pdf')
html = f"""
<html>
<body>
<h2>Hi, I'm a python developer, here's my photo:</h2>
<img {img_attachment.get_embedded_attrs()} height="150" width="300">
<br/>
Look at my resume, it is attached to the letter.
</body>
</html>
"""
# Send message
new_message = proton.create_message(
recipients=["to1@proton.me", "to2@gmail.com", "Name of recipient <to3@outlook.com>"],
cc=["cc1@proton.me", "cc2@gmail.com", "Name of recipient <cc3@outlook.com>"],
bcc=["bcc1@proton.me", "bcc2@gmail.com", "Name of recipient <bcc3@outlook.com>"],
subject="My first message",
body=html, # html or just text
attachments=[img_attachment, pdf_attachment],
external_id="some-message-id-header-if-you-want-to-specify",
in_reply_to="message-id-of-the-mail-to-reply-to",
)
sent_message = proton.send_message(new_message)
# Wait for new message
new_message = proton.wait_for_new_message(interval=1, timeout=60, rise_timeout=False, read_message=True)
if 'spam' in new_message.body:
# Delete spam
proton.delete_messages([new_message])
# Save session, you do not have to re-enter your login, password, pgp key, passphrase
# WARNING: the file contains sensitive data, do not share it with anyone,
# otherwise someone will gain access to your mail.
proton.save_session('session.pickle')
# Load session
proton = ProtonMail()
proton.load_session('session.pickle', auto_save=True)
# Autosave is needed to save tokens if they are updated
# (the access token is only valid for 24 hours and will be updated automatically)
# Getting a list of all sessions in which you are authorized
proton.get_all_sessions()
# Revoke all sessions except the current one
proton.revoke_all_sessions()
event polling
Event polling. Polling ends in 3 cases:
- Callback returns not
None. - The callback raises the
SystemExitexception. - Timeout ends.
For example, wait indefinitely until 2 messages arrive.
def callback(response: dict, new_messages: list):
messages = response.get('Messages', [])
new_messages.extend(messages)
if len(new_messages) >= 2:
raise SystemExit
new_messages = []
proton.event_polling(callback, new_messages)
print(new_messages)
CAPTCHA
Solve CAPTCHA
Instructions to solve CAPTCHA:
- At the moment automatic CAPTCHA solving is already implemented (used by default), it uses
cv2andNumPy. SometimesCantSolveImageCaptchaexception may occur, it means you encountered a complex image, just try to log in again. - You can use manual CAPTCHA solving:
- Login with
proton.login(username, password, captcha_config=CaptchaConfig(type=CaptchaConfig.CaptchaType.MANUAL)) - You will see a url in the console, copy it.
- Open a new browser tab in incognito mode.
- Open the "DevTools" panel (press
F12) - Go to the "Network" tab.
- Enable network logging (press
CTRL + E) - Follow the copied url (from point 2.2)
- Solve the CAPTCHA.
- Find the
initrequest in the "Network" tab and open it. - In the "Preview" tab of the request, copy the token value.
- Paste the token into the python console.
- Login with
Avoid CAPTCHA
Instructions to avoid CAPTCHA:
- There maybe a DDoS attack, just wait 1-2 days.
- Stop logging into your account too often, use the
save_sessionandload_sessionmethods. - Change your IP address (for example, reboot your router, use VPN, Share mobile Internet).
- If CAPTCHA also appears in your browser:
- Open a browser tab in incognito mode.
- Log into your account.
- Solve the CAPTCHA.
- Wait for your mail to load.
- Close the tab.
- Repeat this about 10 times, then your account (only this one) can be allowlisted, and authorization (including
protonmail-api-client) will be without CAPTCHA.
- Use
cookiesfrom the browser:- Open a browser tab in incognito mode.
- Open the login page (https://account.proton.me/mail).
- Open the "DevTools" panel (press
F12). - Go to the "network" tab.
- Enable recording network log (press
CTRL + E). - Log in to your account (check "Keep me signed in").
- Find the
authrequest in the "Network" tab and open it. - In the "Headers" tab of the request, scroll down to the
Set-Cookieitems in the "Response Headers" list. - Copy the key and value from the cookies:
REFRESH-*,AUTH-*. - Paste the key and value into the following code (
x-pm-uidis the part afterAUTH-). - Close the incognito tab (Do not click the "log out" button, otherwise cookies will be invalidated).
proton = ProtonMail()
proton.session.headers['x-pm-uid'] = 'lgfbju2dxc1234567890mrf3tqmqfhv6q' # This is the part after `AUTH-`
proton.session.cookies['AUTH-lgfbju2dxc1234567890mrf3tqmqfhv6q'] = 'qr4uci1234567890anafsku8dd34vkwq'
proton.session.cookies['REFRESH-lgfbju2dxc1234567890mrf3tqmqfhv6q'] = '%7B%22ResponseType%22%3A%22token%22%2C%22ClientID%22%3A%22WebAccount%22%2C%22GrantType%22%3A%22refresh_token%22%2C%22RefreshToken%22%3A%22ceo5gp1234567890fghuinsxxtgmpvdduxg%22%2C%22UID%22%3A%22lgfbju2dxc1234567890mrf3tqmqfhv6q%22%7D'
password = 'YourPassword123'
proton._parse_info_after_login(password)
proton.save_session('session.pickle')
1 maintainer
Metadata
1 maintainer
Release files for protonmail-api-client 2.4.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| protonmail_api_client-2.4.3.tar.gz | 42.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| protonmail_api_client-2.4.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 84.1 kB
Release files / protonmail_api_client-2.4.3.tar.gz
| Download URL | protonmail_api_client-2.4.3.tar.gz |
|---|---|
| Size | 42.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b78e3ea409f39b897043e1a89fa02a19a273c9404b7cd2475d6582c08b6e4c4b
|
|
BLAKE2b-256 checksum How to use checksums |
f1aa8564a23093fc61fb5b456cf68b606900c45491534834d2c9701b19731de3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.9
|
Release files / protonmail_api_client-2.4.3-py3-none-any.whl
| Download URL | protonmail_api_client-2.4.3-py3-none-any.whl |
|---|---|
| Size | 41.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
eb5be91e43a24d6764f84fa847d71cac74d491b50fcd6ebccd565f669dd7d40a
|
|
BLAKE2b-256 checksum How to use checksums |
b177451ab3154ed0c2eccd1ac442c4e01ac5780e5b802e836800a0af98fee404
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.9
|
