https://github.com/justinkalland/protonmail-api
✉ Node.js API for ProtonMail
https://github.com/justinkalland/protonmail-api
api-client nodejs protonmail puppeteer
Last synced: 3 months ago
JSON representation
✉ Node.js API for ProtonMail
- Host: GitHub
- URL: https://github.com/justinkalland/protonmail-api
- Owner: justinkalland
- License: mit
- Archived: true
- Created: 2019-01-22T19:54:14.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T15:57:05.000Z (about 2 years ago)
- Last Synced: 2025-01-14T12:43:47.972Z (3 months ago)
- Topics: api-client, nodejs, protonmail, puppeteer
- Language: JavaScript
- Homepage:
- Size: 1.11 MB
- Stars: 147
- Watchers: 5
- Forks: 27
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# protonmail-api
Unofficial API for interacting with ProtonMail.
Allows interaction with ProtonMail through a simple Node.js API. Leverages the official [WebClient](https://github.com/ProtonMail/WebClient), keeping with the spirit of security and privacy. Currently supports sending email, managing email/conversations, and managing labels and folders. See the [documentation](https://justinkalland.github.io/protonmail-api/) for full functionality.
_This project is not endorsed or supported by Proton Technologies AG._
# Quick Start
## Setup
```
npm install protonmail-api
```
## Send an Email
```js
const ProtonMail = require('protonmail-api');
(async () => {
const pm = await ProtonMail.connect({
username: '[email protected]',
password: 'somethingsecure'
})
await pm.sendEmail({
to: '[email protected]',
subject: 'Send email tutorial',
body: 'Hello world'
})
pm.close()
})()
```
## More Examples
Numerous examples can be found in the [tutorials section of the documentation](https://justinkalland.github.io/protonmail-api/).
# Documentation
[Full documentation found here](https://justinkalland.github.io/protonmail-api/)
# How?
This library uses [Puppeteer](https://github.com/GoogleChrome/puppeteer) (headless Chromium) to load and control the official [ProtonMail WebClient](https://github.com/ProtonMail/WebClient).
The first attempt at building this was by trying to reverse engineer the API from the WebClient. This proved to be difficult and fragile. By utilizing the AngularJS modules (through the headless browser) this library is able to leverage all the work that goes into the official WebClient. This also means complex and sensitive things (like cryptography) are not handled by this library. The main drawback to this approach is the added weight of Puppeteer.
# Contributing
This project is looking for maintainers and contributors. Please contact [email protected] if you are interested.
To run integration tests you need to provide a ProtonMail account. It is best to use a dedicated testing account without any filters. The credentials are set as environment variables `PM_USERNAME` and `PM_PASSWORD`.
Example:
```
[email protected] PM_PASSWORD=kgjSOE223qWer npm run test
```
Or create a `.env` file (in this directory next to `package.json`:
```
[email protected]
PM_PASSWORD=kgjSOE223qWer
```