Installation¶
Requirements¶
Python 3.10 or higher
An email account (IMAP/SMTP access)
Install from PyPI¶
pip install simple-email-gw
Install with uv¶
uv add simple-email-gw
Run with uvx (one-off execution)¶
For running the MCP server without installation:
uvx --from simple-email-gw mcp-server
Development Installation¶
Clone the repository and install development dependencies:
git clone https://github.com/christophevg/simple-email-gw.git
cd simple-email-gw
make dev
Run tests:
make test
Run all checks:
make all
Dependencies¶
Required Dependencies¶
Package |
Purpose |
|---|---|
|
MCP server framework |
|
Async IMAP client |
|
Async SMTP client |
|
Data validation |
|
Settings management |
Optional Dependencies¶
Package |
Purpose |
|---|---|
|
Load environment from .env files |
Verifying Installation¶
Check that the package is installed correctly:
python -c "from simple_email_gw import IMAPClient; print('OK')"
Next Steps¶
Configuration - Configure email accounts
Security - Security features overview
API Reference - Complete API documentation