maildump

1.1.1 verified Fri May 01 auth: no python

An SMTP server that captures all received mails and exposes them via a web interface and REST API. Current version 1.1.1 (requires Python >=3.12). Released with irregular cadence.

pip install maildump

Common errors

error ModuleNotFoundError: No module named 'maildump' ↓

cause Trying to import maildump in a Python script when it's only a CLI tool.

fix

Do not import maildump; run it as a command-line tool.

error maildump: error: unrecognized arguments: --webport ↓

cause Using an old version that doesn't support the --webport flag (added in v1.1).

fix

Upgrade to maildump v1.1 or later: pip install --upgrade maildump.

error TypeError: required field 'id' missing from message ↓

cause Sending malformed emails (e.g., missing Message-ID header).

fix

Ensure your SMTP client sends valid RFC 5322 emails with a Message-ID header.

Warnings

gotcha maildump has no Python API; you cannot import it in your code. It runs as a standalone server. ↓

fix Use the CLI or the REST API to interact with maildump.

gotcha The web interface and REST API are separate from the SMTP server; ensure you start maildump with the correct ports. ↓

fix Run `maildump --help` to see all options for customizing ports and IP bindings.

deprecated Python <3.12 is no longer supported; older versions may fail to install or run. ↓

fix Upgrade to Python 3.12+.

Imports

maildump
wrong
```
from maildump import ...
```
correct
```
import maildump
```
maildump is a command-line tool; there's no public Python API to import. Use the CLI or REST API.

Quickstart

Start the SMTP server on port 1025 and the web interface on port 1080.

maildump --ip 127.0.0.1 --port 1025 --webport 1080