aemail 0.2.1

A simple SMTP server for receiving emails with REST API access

AEmail - Simple Email Receive Server

A simple SMTP server for receiving emails with REST API access. Perfect for testing, development, and automation scenarios where you need to receive emails programmatically.

Features

• 🚀 Simple SMTP Server: Receives emails on any address with your domain
• 🌐 REST API: Easy access to received emails via HTTP endpoints
• 💾 Flexible Storage: In-memory or SQLite database storage
• 🔧 Easy Configuration: Environment variables and config file support
• 📦 Poetry Package: Professional Python packaging with wheel support
• 🖥️ Command Line Tool: Simple CLI for starting the server
• 🎨 Web Interface: Modern web UI for browsing emails
• 🔍 Search Functionality: Find emails by sender or recipient

Use Cases

• Batch Registration: Register multiple accounts and receive verification emails
• Email Testing: Test email functionality in development environments
• Automation: Programmatically access received emails for processing
• Development: Mock email server for local development

Quick Start

Installation

# Install with pip
pip install aemail

# Or install with Poetry
poetry add aemail

Basic Usage

# Start the server with default settings
aemail-server

# Start with custom ports
aemail-server --smtp-port 2525 --rest-port 8080

# Start with persistent database
aemail-server --db-file emails.db

# Start with custom config
aemail-server --config my-config.ini

DNS Configuration

To receive emails for your domain, configure DNS records:

A Record

Point your mail subdomain to your server IP:

A    mx    YOUR.SERVER.IP.ADDRESS

MX Record

Configure MX record to route emails to your server:

MX   *    mx.yourdomain.com

The * wildcard means ALL subdomains will be routed to your server. Examples: [e-mail], [e-mail] This gives you unlimited email addresses!

API Endpoints

The server provides a REST API for accessing received emails:

GET /all

Get all stored messages (last 100)

curl http://localhost:14000/all

GET /from/{email}

Get messages from a specific sender

curl http://localhost:14000/from/[e-mail]

GET /to/{email}

Get messages to a specific recipient

curl http://localhost:14000/to/[e-mail]

GET /health

Health check endpoint

curl http://localhost:14000/health

Response Format

[
  {
    "from": "[e-mail]",
    "to": ["[e-mail]"],
    "to0": "[e-mail]",
    "subject": "Test Email",
    "content": "Email content here...",
    "time": "2024-01-01T12:00:00"
  }
]

Configuration

Config File (cfg.ini)

[smtpd]
host = ::          # Listen on all interfaces (IPv4 and IPv6)
port = 25

[rest]
port = 14000

Environment Variables

Override config file settings with environment variables:

• SMTP_HOST - SMTP server host (default: :: - all interfaces)
• SMTP_PORT - SMTP server port (default: 25)
• REST_PORT - REST API port (default: 14000)

Command Line Options

aemail-server --help

Options:
  --config, -c          Path to configuration file
  --smtp-host          SMTP server host
  --smtp-port          SMTP server port
  --rest-port          REST API port
  --db-file            SQLite database file path
  --verbose, -v        Enable verbose logging
  --version            Show version

Development

From Source

# Clone the repository
git clone https://github.com/lycying/aemail.git
cd aemail

# Install Poetry (if not already installed)
curl -sSL https://install.python-poetry.org | python3 -

# Install dependencies
poetry install

# Run the server
poetry run aemail-server

# Run tests
poetry run pytest

# Build wheel package
poetry build

Project Structure

aemail/
├── crazy_email_recv_srv/     # Main package
│   ├── __init__.py
│   ├── cli.py               # Command line interface
│   ├── config.py            # Configuration management
│   ├── data.py              # Data access layer
│   ├── email_handler.py     # SMTP email processing
│   ├── server.py            # Main server
│   ├── utils.py             # Utility functions
│   └── web_api.py           # REST API
├── tests/                   # Test suite
├── static/                  # Web interface files
├── pyproject.toml          # Poetry configuration
└── README.md

Testing

Send a test email to any address at your domain:

# Example: Send email to [e-mail]
# Then query the API:
curl http://localhost:14000/to/[e-mail]

Or use the web interface at: http://localhost:14000

License

MIT License - see LICENSE file for details.

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests
5. Submit a pull request

Support

• 🐛 Issues: GitHub Issues
• 📖 Documentation: GitHub Wiki
• 💬 Discussions: GitHub Discussions

---

Note: This tool is for testing and development purposes. Use responsibly and in compliance with applicable laws and regulations.