Code Monkey home page Code Monkey logo

fakeemail's Introduction

FakeEmail

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

fakeemail's People

Contributors

tomwardill avatar plumdog avatar alex2 avatar bassdread avatar lowks avatar

Watchers

James Cloos avatar Paulino R. e Silva avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.