A Mailpit API Client
Project description
API-client for https://github.com/axllent/mailpit written in Python
- Authors:
Lars Liedtke <corvan@gmx.de>
- Version:
0.10.2
Motivation
For work, I thought about introducing integration testing. We are working with Odoo and I wanted to test if e-mails created by Odoo really were sent. I remembered mailhog, which I discovered to be abandoned. Searching for an alternative, I found Mailpit - for which I decided to write an API-client in my free time.
Usage
this library - as is Mailpit - is mostly meant for testing. Giving the url of Mailpit to a tool to send e-mail messages to and then use this client to check on the API if the mail was sent.
Client
The client itself consists of the class API in mailpit/client/api.py, that offers methods, which query the API-Endpoints and are named respectively. To use this class, simply try something like this. You have to have Mailpit running on localhost for this [1] .
import mailpit.client.api
api = mailpit.client.api.API("localhost:8025")
messages = api.get_messages()
Additionally, there are some model-classes that wrap the API’s responses. For example with
messages = api.get_messages()
messages will be an instance of mailpit.client.models.Messages , which you can find in link:mailpit/client/models/messages.py[mailpit/client/models.py]. + The model-classes’ attributes are named the same as Mailpit’s responses, as documented in the API’s README.md, but as is convention in Python in Snakecase.
For examples have a look at the link:tests[tests]
== Testing
To make testing easier I plan to provide testhelpers like TestCase-classes of unittest and pytest-fixtures.
=== unittest tbd
=== pytest tbd
Project details
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
Hashes for mailpit-api-client-0.10.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6dc3ad183edeca9c943fd89238283e468ec4db2fb20b9a9acf1d423bf3430e71 |
|
MD5 | 6712748ccc6a268c6ccf03a1db3bcc74 |
|
BLAKE2b-256 | 233883924e57a8ede6d2e478b889f27260fba87e509ca9dbe77aafd265e2576b |
Hashes for mailpit_api_client-0.10.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0ea3d4e57b986328434d7814293e1e95a2396481c41f5504d8d54c3777fe0ac2 |
|
MD5 | 0ad6f9d8deb8a52f645679117be61eb3 |
|
BLAKE2b-256 | cfbca3f1f2881aaa10adf235f614f027636490794f63b2ec8f3fd80ed8b8fae8 |