smtpbench 1.1.0

A robust SMTP load testing and benchmarking tool with MX failover and detailed logging

SMTPBench

A robust SMTP load testing and benchmarking tool with MX failover support and detailed logging capabilities.

⚠️ Important Notice

This tool will attempt to send real emails when run against any hostname. Please be aware:

• Permission Required: Ensure you have permission on both the sending and receiving networks to use this tool. Unauthorized use may violate terms of service or laws.
• Email Tracking: All emails sent by this tool include message counts, thread IDs, and unique run identifiers (UUIDs) in the subject line and body. This enables tracking and identification if issues arise.
• ISP Blocking: If running against public hostnames, your ISP may already be blocking outbound SMTP traffic (ports 25, 587, 465). You can try alternate ports, but if these ports are open, you could still be blocked or flagged.
• Not for Residential Use: This tool is not meant to be run from residential internet connections or personal systems without proper authorization.
• Not for Malicious Use: This is NOT a tool for denial of service attacks or any malicious activity.
• Intended Purpose: This is purely an email benchmarking and load testing tool designed for authorized testing of SMTP infrastructure in controlled environments.

Use responsibly and ethically.

Features

• 🚀 Multi-threaded Load Testing - Simulate concurrent SMTP connections
• 🔄 MX Failover - Automatic MX record lookup with failover to backup servers
• 📊 Real-time Progress - Live progress bar with success rate metrics
• 📝 Detailed Logging - Structured JSON logs for success, failures, retries, and debug info
• 🔒 TLS/STARTTLS Support - Secure connection support
• ⚙️ Highly Configurable - Extensive options for timeouts, retries, and delays
• 🎨 Color-coded Output - Easy-to-read terminal output with status colors
• 📬 Journal Mode - Optional message journaling mode
• 🐛 Debug Mode - Detailed debugging for troubleshooting
• 🐳 Docker Support - Run in containers

Installation

From PyPI (Recommended)

pip install smtpbench

From Source

git clone https://github.com/SMTPBench/SMTPBench.git
cd SMTPBench
pip install -e .

Using Docker

# Build the image
docker build -t smtpbench .

# Run with log volume mount
docker run --rm -v $(pwd)/logs:/app/logs smtpbench \
    recipient=[e-mail] \
    port=587 \
    threads=5 \
    messages=10

# Or run without volume mount (logs stay in container)
docker run --rm smtpbench \
    recipient=[e-mail] \
    port=587 \
    threads=5 \
    messages=10

Quick Start

Getting Help

# Show version
smtpbench --version
smtpbench -v

# Show full help with all options
smtpbench --help

# Also works with
smtpbench -h
smtpbench help
smtpbench ?

Basic Usage

smtpbench recipient=[e-mail] port=587 threads=5 messages=10

With TLS and Custom Settings

smtpbench \
    recipient=[e-mail] \
    port=587 \
    from_address=[e-mail] \
    threads=10 \
    messages=100 \
    use_tls=true \
    retry_delay=5 \
    max_retries=3 \
    transaction_timeout=30

Using Load Balancer Instead of MX Lookup

smtpbench \
    recipient=[e-mail] \
    lb_host=smtp.local.lets.qa \
    port=587 \
    threads=5 \
    messages=20

As a Python Module

python -m smtpbench recipient=[e-mail] port=587 threads=5 messages=10

Configuration Options

For a complete, formatted list of all options with examples, run:

smtpbench --help

Required Parameters

Parameter	Description	Example
recipient	Target email address	[e-mail]
port	SMTP port number	587 or 25
threads	Number of concurrent threads	10
messages	Messages per thread (0 for infinite)	100

Note: If any required parameter is missing, SMTPBench will display a helpful error message with examples.

Optional Parameters

Parameter	Default	Description
lb_host	(auto MX lookup)	Load balancer/SMTP host (skips MX lookup)
from_address	no-reply@localhost	Sender email address
retry_delay	20	Seconds to wait between retries
use_tls	true	Enable TLS/STARTTLS
delay	0	Fixed delay between messages (seconds)
random_delay	false	Random 1-15 second delay between messages
transaction_timeout	20	SMTP transaction timeout (seconds)
max_retries	3	Maximum retry attempts per message
client_hostname	(system hostname)	Client hostname for SMTP HELO/EHLO
logfile_output	./logs	Directory for log files
journal	false	Enable journal mode
journal_address	(same as recipient)	Email address for journal copies
debug	false	Enable debug logging

Output and Logging

SMTPBench creates structured JSON logs in the specified log directory:

Log Files

• success_TIMESTAMP_UUID.log - Successfully sent messages
• fail_TIMESTAMP_UUID.log - Failed message attempts
• retry_TIMESTAMP_UUID.log - Retry attempts
• debug_TIMESTAMP_UUID.log - Debug information (when debug=true)

Log Entry Format

{
  "timestamp": "2025-11-17T21:15:00",
  "run_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "client_hostname": "loadtest-server",
  "status": "success",
  "thread_id": 1,
  "message_id": 42,
  "duration_seconds": 0.523,
  "attempt": 1,
  "retry_number": null,
  "mx_host_used": "mx1.local.lets.qa",
  "recipients": ["[e-mail]"],
  "error": null
}

Email Message Format

Each email sent by SMTPBench includes tracking headers and identifiers for correlation:

From: [e-mail]
To: [e-mail]
Subject: Quick test from thread 3 message 7 [a1b2c3d4-e5f6-7890-abcd-ef1234567890]
X-SMTPBench-Run-UUID: a1b2c3d4-e5f6-7890-abcd-ef1234567890
X-SMTPBench-Thread-ID: 3
X-SMTPBench-Message-ID: 7
Content-Type: multipart/mixed; boundary="===============1234567890=="
MIME-Version: 1.0

--===============1234567890==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit

Quick test from thread 3 message 7 [a1b2c3d4-e5f6-7890-abcd-ef1234567890]

--
SMTPBench Load Testing Tool
https://github.com/SMTPBench/SMTPBench
--===============1234567890==--

Key Fields That Change Per Message:

• Subject - Contains thread ID, message ID, and run UUID
• X-SMTPBench-Thread-ID - Identifies which thread sent the message (1 to N threads)
• X-SMTPBench-Message-ID - Message number within that thread (1 to N messages)

Key Fields That Stay Constant Per Run:

• X-SMTPBench-Run-UUID - Unique identifier for the entire test run
• From - Sender address (unless changed)
• To - Recipient address (unless changed)

Example: Messages from the Same Run

Thread 1, Message 1:

Subject: Quick test from thread 1 message 1 [a1b2c3d4-e5f6-7890-abcd-ef1234567890]
X-SMTPBench-Run-UUID: a1b2c3d4-e5f6-7890-abcd-ef1234567890
X-SMTPBench-Thread-ID: 1
X-SMTPBench-Message-ID: 1

Thread 1, Message 2:

Subject: Quick test from thread 1 message 2 [a1b2c3d4-e5f6-7890-abcd-ef1234567890]
X-SMTPBench-Run-UUID: a1b2c3d4-e5f6-7890-abcd-ef1234567890  ← Same run UUID
X-SMTPBench-Thread-ID: 1                                      ← Same thread
X-SMTPBench-Message-ID: 2                                     ← Different message

Thread 3, Message 7:

Subject: Quick test from thread 3 message 7 [a1b2c3d4-e5f6-7890-abcd-ef1234567890]
X-SMTPBench-Run-UUID: a1b2c3d4-e5f6-7890-abcd-ef1234567890  ← Same run UUID
X-SMTPBench-Thread-ID: 3                                      ← Different thread
X-SMTPBench-Message-ID: 7                                     ← Different message

Example: Messages from Different Runs

First run:

Subject: Quick test from thread 1 message 1 [a1b2c3d4-e5f6-7890-abcd-ef1234567890]
X-SMTPBench-Run-UUID: a1b2c3d4-e5f6-7890-abcd-ef1234567890

Second run (different UUID):

Subject: Quick test from thread 1 message 1 [f9e8d7c6-b5a4-3210-fedc-ba9876543210]
X-SMTPBench-Run-UUID: f9e8d7c6-b5a4-3210-fedc-ba9876543210  ← Different run

Use Cases for Headers:

• Tracking: Follow individual messages across distributed mail systems
• Correlation: Match emails with JSON log entries via run UUID
• Testing: Validate message delivery and filter test data
• Debugging: Identify which test run generated specific emails
• Analysis: Aggregate metrics by run UUID or thread ID

Terminal Output

SMTPBench displays real-time progress with color-coded success rates:

[INFO] Run UUID: a1b2c3d4-e5f6-7890-abcd-ef1234567890
[INFO] Client Hostname: loadtest-server
[INFO] MX lookup for local.lets.qa:
  - mx1.local.lets.qa (priority 10)
  - mx2.local.lets.qa (priority 20)
[INFO] SMTP banner check passed for mx1.local.lets.qa:587

100%|████████████████| 500/500 [02:15<00:00, 3.70msg/s, Success=487, Fail=13, Rate=97.4%]

=== SMTP Load Test Summary ===
Run UUID: a1b2c3d4-e5f6-7890-abcd-ef1234567890
Client Hostname: loadtest-server
SMTP Hosts Tried: mx1.local.lets.qa, mx2.local.lets.qa
Total Sent: 487
Total Failed: 13
Total Retried: 8
Elapsed Time: 135.42 seconds
Logs saved in: /path/to/logs

Use Cases (adjust samples for your needs)

Load Testing

Test SMTP server capacity and performance under concurrent load:

smtpbench recipient=[e-mail] port=587 threads=50 messages=1000

Failover Testing

Verify MX failover behavior by testing multiple mail servers:

smtpbench recipient=[e-mail] port=25 threads=10 messages=100

Connection Testing

Quick connectivity test with minimal load:

smtpbench recipient=[e-mail] port=587 threads=1 messages=1

Sustained Load Testing

Run continuous load with random delays:

smtpbench \
    recipient=[e-mail] \
    port=587 \
    threads=5 \
    messages=0 \
    random_delay=true

Examples

Test with Journal Mode

smtpbench \
    recipient=[e-mail] \
    port=587 \
    threads=5 \
    messages=10 \
    journal=true \
    journal_address=[e-mail]

Debug Mode for Troubleshooting

smtpbench \
    recipient=[e-mail] \
    port=587 \
    threads=1 \
    messages=1 \
    debug=true

High-Volume Load Test

smtpbench \
    recipient=[e-mail] \
    port=587 \
    from_address=[e-mail] \
    threads=100 \
    messages=1000 \
    use_tls=true \
    retry_delay=10 \
    max_retries=5 \
    transaction_timeout=30 \
    logfile_output=/var/log/smtpbench

Requirements

• Python 3.8 or higher
• Dependencies (automatically installed):
  • dnspython>=2.0.0
  • tqdm>=4.0.0
  • colorama>=0.4.0

Development

Setup Development Environment

git clone https://github.com/SMTPBench/SMTPBench.git
cd SMTPBench
pip install -e .
pip install pytest

Running Tests

SMTPBench includes both unit tests and integration tests.

Unit Tests

Run the unit test suite:

pytest -v -m "not integration"

Integration Tests

Integration tests use Docker Compose to spin up a real SMTP server and validate end-to-end functionality:

# Run integration tests (requires Docker)
pytest -v -m "integration"

# Or use the shell script
./tests/run_integration_test.sh

The integration tests:

• Start a local test mail server using local-test-mail-server
• Run SMTPBench to send emails
• Validate emails are received in the mbox file
• Verify log files are created correctly
• Check message format and content

Run All Tests

pytest -v

CI/CD

Tests run automatically on pull requests via GitHub Actions:

• Unit tests - Fast tests without external dependencies
• Integration tests - Full end-to-end tests with Docker Compose

See .github/workflows/pytest.yml for details.

Troubleshooting

Getting Help

If you're unsure about available options or syntax:

smtpbench --help  # Display full help with all options and examples

Invalid Arguments

If you see an error like Invalid argument format, ensure you're using the key=value format:

# ✗ Wrong
smtpbench --recipient [e-mail]

# ✓ Correct
smtpbench recipient=[e-mail] port=587 threads=5 messages=10

Missing Required Parameters

If parameters are missing, SMTPBench will show which ones are required:

$ smtpbench recipient=[e-mail]
✗ Missing required parameter(s): port, threads, messages

Connection Timeouts

If you're experiencing connection timeouts, try increasing the transaction_timeout:

smtpbench recipient=[e-mail] port=587 threads=5 messages=10 transaction_timeout=60

MX Lookup Failures

If MX lookup is failing, use lb_host to specify the SMTP server directly:

smtpbench recipient=[e-mail] lb_host=smtp.local.lets.qa port=587 threads=5 messages=10

Debug Mode

Enable debug mode for detailed SMTP protocol information:

smtpbench recipient=[e-mail] port=587 threads=1 messages=1 debug=true

Check the debug log file in your logs directory for detailed information.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Author

Randall Morse - [e-mail]

Changelog

See CHANGELOG.md for version history.

Support

For issues, questions, or contributions, please visit the GitHub repository.