Metadata-Version: 2.5
Name: proxymailer
Version: 1.0.0
Summary: Official ProxyMailer Python SDK
Author: ProxyMailer
License: MIT License
        
        Copyright (c) 2026 ProxyMailer
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: email,proxymailer,sdk,smtp
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
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: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: httpx>=0.27
Provides-Extra: dev
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: respx>=0.21; extra == 'dev'
Description-Content-Type: text/markdown

# ProxyMailer Python SDK

Official Python client for the ProxyMailer application send API.

## Install

```bash
pip install proxymailer
```

Requires Python 3.10+.

## Usage

```python
import os
from proxymailer import Client

client = Client(
    api_key=os.environ["PROXYMAILER_API_KEY"],
    base_url=os.environ.get("PROXYMAILER_BASE_URL", "https://mail.example.com"),
)

result = client.send({
    "from": "Acme <noreply@acme.com>",
    "to": ["user@example.com"],
    "subject": "Welcome",
    "html": "<p>Hello</p>",
    "text": "Hello",
    "attachments": [
        Client.attachment_from_bytes("note.txt", b"hello", "text/plain"),
    ],
})

print(result.id, result.status)

# Read-only groups + visualization graph (tenant-scoped)
groups = client.list_groups()
graph = client.get_mappings()  # data["nodes"] / data["edges"]
client.close()
```

See [`docs/developers`](../../docs/developers/README.md) for the full guide, including [groups & mappings](../../docs/developers/groups.md).

## Publishing (maintainers)

To release `proxymailer` on **PyPI**:

```bash
cd sdks/python
pip install -U build twine
pytest
python -m build && twine check dist/*
twine upload --repository testpypi dist/*   # recommended first
twine upload dist/*
```

Full checklist (tokens, TestPyPI, CI): [`docs/developers/publishing.md`](../../docs/developers/publishing.md#3-python--pypi).
