https://github.com/smkent/jmapc
✉️ ⚒️ A JMAP client library for Python. https://jmap.io
https://github.com/smkent/jmapc
api api-client email events examples fastmail jmap python
Last synced: about 1 month ago
JSON representation
✉️ ⚒️ A JMAP client library for Python. https://jmap.io
- Host: GitHub
- URL: https://github.com/smkent/jmapc
- Owner: smkent
- License: gpl-3.0
- Created: 2022-02-24T19:56:51.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-15T18:00:54.000Z (4 months ago)
- Last Synced: 2025-03-30T18:08:18.139Z (about 2 months ago)
- Topics: api, api-client, email, events, examples, fastmail, jmap, python
- Language: Python
- Homepage:
- Size: 647 KB
- Stars: 41
- Watchers: 3
- Forks: 6
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jmapc: A [JMAP][jmapio] client library for Python
[][pypi]
[][pypi]
[][gh-actions]
[][codecov]
[][repo]
[![jmapc][logo]](#)
Currently implemented:
* Basic models
* Request methods:
* `Core/echo`
* `Email/changes`
* `Email/copy`
* `Email/get`
* `Email/query`
* `Email/queryChanges`
* `Email/set`
* `EmailSubmission/*` (`get`, `changes`, `query`, `queryChanges`, `set`)
* `Identity/*` (`get`, `changes`, `set`)
* `Mailbox/*` (`get`, `changes`, `query`, `queryChanges`, `set`)
* `SearchSnippet/*` (`get`)
* `Thread/*` (`get`, `changes`)
* Arbitrary methods via the `CustomMethod` class
* Fastmail-specific methods:
* [`MaskedEmail/*` (`get`, `set`)][fastmail-maskedemail]
* Combined requests with support for result references
* Basic JMAP method response error handling
* EventSource event handling
* Unit tests for basic functionality and methods
## Installation
[jmapc is available on PyPI][pypi]:
```console
pip install jmapc
```
## Examples
Any of the included examples can be invoked with `poetry run`:
```console
JMAP_HOST=jmap.example.com \
JMAP_API_TOKEN=ness__pk_fire \
poetry run examples/identity_get.py
```
If successful, `examples/identity_get.py` should output something like:
```
Identity 12345 is for Ness at [email protected]
Identity 67890 is for Ness at [email protected]
```
## Development
### [Poetry][poetry] installation
Via [`pipx`][pipx]:
```console
pip install pipx
pipx install poetry
pipx inject poetry poetry-pre-commit-plugin
```
Via `pip`:
```console
pip install poetry
poetry self add poetry-pre-commit-plugin
```
### Development tasks
* Setup: `poetry install`
* Run static checks: `poetry run poe lint` or
`poetry run pre-commit run --all-files`
* Run static checks and tests: `poetry run poe test`
---
Created from [smkent/cookie-python][cookie-python] using
[cookiecutter][cookiecutter]
[codecov]: https://codecov.io/gh/smkent/jmapc
[cookie-python]: https://github.com/smkent/cookie-python
[cookiecutter]: https://github.com/cookiecutter/cookiecutter
[fastmail-maskedemail]: https://www.fastmail.com/developer/maskedemail/
[gh-actions]: https://github.com/smkent/jmapc/actions?query=branch%3Amain
[logo]: https://raw.github.com/smkent/jmapc/main/img/jmapc.png
[jmapio]: https://jmap.io
[pipx]: https://pypa.github.io/pipx/
[poetry]: https://python-poetry.org/docs/#installation
[pypi]: https://pypi.org/project/jmapc/
[repo]: https://github.com/smkent/jmapc