Metadata-Version: 2.4
Name: mailinator_python_client_2
Version: 1.0.9
Summary: Official SDK for Mailinator
Home-page: https://github.com/manybrain/mailinator-python-client
Author: Manybrain, LLC
Author-email: support@manybrain.com
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Mailinator Python SDK

The official Mailinator Python SDK. This REST API client is implemented as a thin wrapper around the [Mailinator API](https://www.mailinator.com/documentation/docs/api/index.html). The OpenAPI specification is the source of truth.

## API Reference

See [Mailinator's API Reference](https://www.mailinator.com/documentation/docs/api/index.html) for all of the currently available API endpoints.

## Documentation

- OpenAPI spec: <https://github.com/manybrain/mailinatordocs/blob/main/openapi/mailinator-api.yaml>
- SDK examples: [`EXAMPLE.md`](EXAMPLE.md)
- SDK architecture and OpenAPI alignment workflow: [`OPENAPI_ALIGNMENT.md`](OPENAPI_ALIGNMENT.md)
- Current modernization and alignment work: [`ROADMAP.md`](ROADMAP.md)

## Installation

```bash
pip install mailinator-python-client-2
```

## Quick Start

```python
from mailinator import Mailinator

client = Mailinator("YOUR_API_TOKEN")
```

For request examples (inbox, messages, domains, rules, webhooks, and stats), see [`EXAMPLE.md`](EXAMPLE.md).

## Tests

Run the mocked tests with:

```bash
python -m pytest tests/test_mailinator_mocked.py
```

These tests do not make network requests and do not require Mailinator credentials.

Run the integration tests with:

```bash
python -m pytest tests/test_mailinator.py -s
```

Integration tests require valid environment values and will skip when required settings are missing.

Use either:

- `.env` (recommended): copy `.env.example` to `.env` and fill in values.
- `tests/localsettings.py`: copy `tests/localsettings.py.template` to `tests/localsettings.py` (it also loads `.env` if present).

Run the full suite with:

```bash
python -m pytest
```
