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 sit on 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.
FakeEmail is installed using the buildout system 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 bootstrap.py bin/buildout
FakeEmail installs itself as a plugin into the local buildout twisted environment. This makes execution reasonably simple:
bin/twistd -n fakeemail
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:
bin/twistd -n 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.
Run the server in the background and output to a log file:
bin/twistd -l foo.log fakeemail
The dependencies will be installed through the egg/buildout, but if you require them to be system installed, they are listed below:
- python (2.4+)