Skip to main content

A simple debug smtp server for development.

Project description

Introduction

mr.hermes is an extension of the smtpd.DebuggingServer from the Python standard library. It dumps all mails it receives to the standard output and optionally to files in a configurable directory.

Usage

There are several ways to use this package. Probably the most two common are the following.

Command line

Install it with your preferred Python packaging tool (setuptools, distribute, pip or whatever). Run it from the command line using python -m smtpd -n -c mr.hermes.DebuggingServer localhost:8025.

If you want to dump the output to a directory, then set the DEBUG_SMTP_OUTPUT_PATH environment variable. For example like DEBUG_SMTP_OUTPUT_PATH=mails python -m smtpd -n -c mr.hermes.DebuggingServer localhost:8025.

Buildout

Add a part to your config like this:

[debugsmtp]
# Run a simple smtp server on 8025 that echos incoming email
recipe = zc.recipe.egg
eggs = mr.hermes
entry-points = debugsmtp=runpy:run_module
scripts = debugsmtp
host = localhost
port = 8025
path = ${buildout:directory}/var/mails
initialization =
    import os
    os.environ.setdefault('DEBUG_SMTP_OUTPUT_PATH', '${:path}')
    sys.argv[1:] = ['-n', '-c', 'mr.hermes.DebuggingServer', '${:host}:${:port}']
arguments = 'smtpd', run_name='__main__', alter_sys=True

You can then add this script to something like supervisord and use mr.laforge to automatically start it when you need it.

Changelog

1.4.0 - 2017-11-08

  • Fixes for Python 3.6. [dokai (Kai Lautaportti), fschulze]

1.3.0 - 2016-12-06

  • Added *args and **kwargs in mr.hermes.DebugginServer.__init__ to accept the new (even if unused) parameters introduced in Python 3.3 and 3.4 and used when running the smtp module from cli. [duploduplo (Lorenzo Berni)]

1.2 - 2013-07-22

  • Make sure mails are sorted properly when filenames conflict. [dokai (Kai Lautaportti), fschulze]

1.1 - 2011-08-04

  • Fix packaging issue which basically made 1.0 a brownbag release. [fschulze]

1.0 - 2011-08-04

  • Initial release [fschulze (Florian Schulze)]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
mr.hermes-1.4.0.tar.gz (4.1 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page