Skip to content

homingbot/homingbot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Homingbot

Overview

Homingbot is a Fake SMTP Server & Low-Maintenance Email Generator. Its content are set to automatically expire after a set duration. It is divided into 2 parts:

  1. Controller or 'API' handles all rest API calls.
  2. Nest or 'SMTP Server' receives incoming mails.

Requirements

Running

  1. Install requirements pip3.6 install -r requirements.txt

  2. Update config.py
    Cassandra
    Update cassandra_hosts. If cassandra has ssl enabled, you'll have to provide an ssl cert and key.
    Nest
    If you enable TLS, provide an ssl key and cert.

  3. Launch python3.6 __main__.py

Usage

There are 3 API endpoints:

Endpoint Method Variables Details
/generate POST count* (INT) Generates and returns count email accounts
/accounts GET NONE Returns all accounts that are yet to expire
/emails POST account* (TEXT), index (INT) Returns the email-message(s) for the specified account

* - required

License

MIT License

Releases

No releases published

Packages

No packages published

Languages