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.
Project description
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.
Unfortunately, I could not find an analogue of DecryptSessionKeys from OpenPG.js, so this uses Playwright to execute js. if you have any ideas write to me
Installation
Install requirements:
pip install protonmail-api-client
Install Playwright:
playwright install webkit
Getting Started
Get PGP private key and passphrase
Go to the Email encryption keys section, click on "Export private key" (NOT the Account keys), create the passphrase.
from protonmail import ProtonMail
username = "YouAddress@proton.me"
password = "YourPassword123"
proton = ProtonMail()
proton.login(username, password)
private_key = 'privatekey.YourAddress@proton.me-123...89.asc'
passphrase = 'YourPassphrase'
proton.pgp_import(private_key, passphrase=passphrase)
# 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)
# Send message
recipients = ["to@gmail.com", "to2@gmail.com"] # You can’t send to @proton.me/@protonmail.com yet
subject = "My first message"
body = "<html><body>hello, i sent my first mail!</body></html>" # html or just text
new_message = proton.create_message(
recipients=recipients,
subject=subject,
body=body
)
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)
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for protonmail-api-client-1.3.4.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 81fa538376f8fa08d0498a5a5af4119ea7695e7b5e9bd990f8472ac16e3b5bc4 |
|
| MD5 | f0e1418f5e40aa3d40cadf93747e40cc |
|
| BLAKE2b-256 | d13a344590ef096d94bcb96967c174b39aa5a4aa1837c3aab9c3596e5458b84f |
Close
Hashes for protonmail_api_client-1.3.4-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 31cd27bd2f4e782dc46bcc3ffe766aae64e487ce119fafddaec476c882009b86 |
|
| MD5 | 43979eab22dd8a30b594954f02480197 |
|
| BLAKE2b-256 | f5fcb2568ce27e46b5b977c26405e7f6c85e2ca21edba7c507eb2c391ad2a0ca |
