Skip to main content

HitchSMTP

Mock SMTP server that logs all incoming messages to stdout as JSON for easy parsing by HitchServe.

HitchSMTP contains a service definition for use with Hitch, but can also be used alone.

Use with Hitch

Install like so:

$ hitch install hitchsmtp
# Service definition in your test execution engine's setUp
self.services['HitchSMTP'] = hitchsmtp.HitchSMTPService(
    port=10025                                                 # Optional (default: 10025)
)

# Wait for email during test...
containing = "Registration email"

email = self.services['HitchSMTP'].logs.out.tail.until_json(
    lambda email: containing in email['payload'] or containing in email['Subject'],
    timeout=5,
    lines_back=1,
)

See this service in action at the DjangoRemindMe project.

Bad SMTP Server

You can send to specific email addresses to mock most SMTP errors.

E.g. Sending an email to 451-please-try-again-later@smtperrors.com will cause the “451 Please try again later” SMTP error.

For a full list of these errors and the email address @ smtperrors.com that will trigger them, see:

https://github.com/hitchtest/hitchsmtp/blob/master/hitchsmtp/smtperrors.py

Features

  • Logs all details about emails received by the SMTP server as easily parsed JSON.

  • Parses links in your emails automatically so that you can check just for links in emails and ‘click’ on them.

  • Can also mock SMTP errors.

Release files for hitchsmtp 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hitchsmtp 0.2.1
File Size Uploaded
hitchsmtp-0.2.1.tar.gz 5.5 kB Details

Release files / hitchsmtp-0.2.1.tar.gz

Download URL hitchsmtp-0.2.1.tar.gz
Size 5.5 kB
Tags Source
SHA-256 checksum
How to use checksums
26bfaafc642336a21d491209703f4d0ebdef432121d223400e6cd80acb09db69
BLAKE2b-256 checksum
How to use checksums
88cb0bccddb5167a0f89daaf515c34734131b3fb0d0a3e30e7721f3b30b3efdc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.2.1 This release

1 release file

0.2

1 release file

0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page