Metadata-Version: 2.3
Name: botmailroom
Version: 0.0.1
Summary: A python client for the BotMailRoom API
Project-URL: Homepage, https://botmailroom.com
Author: BotMailRoom
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Requires-Dist: httpx
Requires-Dist: pydantic
Description-Content-Type: text/markdown

# BotMailroom Python Client

The BotMailroom Python client allows you to interact with the [BotMailroom API](https://docs.botmailroom.com/). It provides both synchronous and asynchronous methods for interacting with the API.

![Run](./images/run.gif)

## Quickstart

### 1. Get an API Key

You can get an API key by signing up for a BotMailroom account and creating an API key at https://auth.botmailroom.com/account/api_keys

### 2. Install the Client

```bash
pip install botmailroom
```

### 3. Initialize the Client

```python
from botmailroom import BotMailRoom

client = BotMailRoom(api_key="your_api_key") # or set the BOTMAILROOM_API_KEY environment variable
```

### 4. Create an Inbox

```python
inbox = client.create_inbox(name="My Inbox", email_address="CHANGE_THIS@inbox.botmailroom.com")
```

### 5. Check Emails

Send an email to the inbox's email address and then check for new emails using the `get_emails` method.

```python
emails = client.get_emails(inbox_id=inbox.id)
print(emails)
```
