https://github.com/asyncee/smtpdev
Asynchronous SMTP server for local development and email testing
https://github.com/asyncee/smtpdev
development python smtp
Last synced: 5 months ago
JSON representation
Asynchronous SMTP server for local development and email testing
- Host: GitHub
- URL: https://github.com/asyncee/smtpdev
- Owner: asyncee
- License: mit
- Created: 2019-06-01T11:52:42.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-03-20T03:45:31.000Z (over 5 years ago)
- Last Synced: 2025-11-27T20:24:28.070Z (7 months ago)
- Topics: development, python, smtp
- Language: Python
- Size: 227 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# smtpdev
Asynchronous SMTP server for developers.
## Installation
Just use pip:
```bash
pip install smtpdev
```
## Launching
You can launch smtpdev by issuing `smtpdev` command. All parameters have pre-set defaults.
Also it is possible to use docker image:
```
docker pull asyncee/smtpdev
```
## Usage
Launch server and navigate to `localhost:8080` using your favourite browser.
Then send any email to `localhost:2500` to see it's html / text parts and headers.
## Command line options description
```
$ smtpdev --help
Usage: smtpdev [OPTIONS]
Options:
--smtp-host TEXT Smtp server host (default localhost).
--smtp-port INTEGER Smtp server port (default 2500).
--web-host TEXT Web server host (default localhost).
--web-port INTEGER Web server port (default 8080).
--develop Run in developer mode.
--debug Whether to use debug loglevel.
--maildir TEXT Full path to emails directory, temporary directory if not set.
--help Show this message and exit.
```
## Development
### Installation
Clone repository and use following command to bootstrap
python environment and install package in editable mode.
```bash
make bootstrap
```
### Launching smtpdev
```bash
make run
```
### Running mypy
```bash
make check
```