Skip to main content

FakeEmail is an email server, for use in a development environment where routing email is either undesirable, or impossible to manage.

The aim of the system is to open a port, accept SMTP connections and to display a list of the emails that it has received. At no point will the emails route further on, so there is no requirement for the addresses to be valid, or to wait around waiting for the email to arrive in your inbox.

Installation

Via pip

FakeEmail is installable via pip:

pip install fakeemail

From Source

FakeEmail is installed using the setup.py and depends on Twisted for it’s server capabilites. Installation is as straight forward as possible:

git clone git://github.com/tomwardill/FakeEmail.git
cd FakeEmail
python setup.py install

Usage

Starting

If you installed fakeemail via pip, then running is simple:

fakeemail 2025 8080 0.0.0.0

This will run on SMTP port 2025, the web interface on 8080 and listen on all network interfaces. Running on port 25 is possible, but you will need to start with root privileges.

Options

There are two options for the system:

  • -s or –smtp_port : Which port to run the SMTP listener on (defaults to 2025)

  • -w or –web_port : Which port to run the Web Server on (defaults to 8000)

Use these options as shown below:

fakeemail -s 1025 -w 8001

Note that to run the SMTP listener on port 25 (the standard SMTP port), you may need to start the daemon with root privileges.

Once the server is running, direct any email at the port that you specified, and then load up http://<servername>:webport (http://localhost:8000 for example)

Dependencies

The dependencies will be installed through the egg, but if you require them to be system installed, they are listed below:

  • twisted

  • jinja2

  • python (2.4+)

Known Issues

The use of srcdoc for the iframe element of displaying HTML emails will not work in any current version of Internet Explorer.

Credits

Tom Wardill (original author) - https://github.com/tomwardill Andrew Plummer - https://github.com/plumdog John Carr - https://github.com/jc2k Tapasweni Pathak - https://github.com/tapaswenipathak Colin Watson - https://github.com/cjwatson

Release files for fakeemail 0.11.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 fakeemail 0.11.1
File Size Uploaded
fakeemail-0.11.1.tar.gz 6.7 kB Details

Release files / fakeemail-0.11.1.tar.gz

Download URL fakeemail-0.11.1.tar.gz
Size 6.7 kB
Tags Source
SHA-256 checksum
How to use checksums
184c9288512dc65ec4152f010e261a8a94984e2f7cae36aa6e0ef6fd3990cf58
BLAKE2b-256 checksum
How to use checksums
8abcbd4405a3e990b356e6022a87752bfece38f02bcb74cc3b01aee71600f3e6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.5

Release history Release notifications | RSS feed

This release

0.11.1 This release

1 release file

0.11.0

1 release file

0.10.1

1 release file

0.10.0

1 release file

0.9.0

1 release file

0.8.1

1 release file

0.8

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