diff --git a/README.md b/README.md index 0916018..aa66fd0 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ smtpy ===== -(Pronouced: s-m-t-pee) +(Pronounced: s-m-t-pee) As of late I've has a lot of hassle with QA, regression runs and dev PCs when it comes to sending out email from testing a web app. Most of them have an SMTP server - but it's absolutely rubbish and fills up way too quickly and then dies miserably. @@ -12,6 +12,7 @@ Now I could run a regression without worrying about the server crumbling to piec Email sent from the webserver can now be directed to the localhost, and picked up by smtpy. + Usage ----- @@ -42,4 +43,18 @@ Features * Supports UTF-8 * Self cleaning so it doesn't gobble up memory - * Lightweight \ No newline at end of file + * Lightweight + + +API +--- + +All methods are accessed via the host:port that you specify in the smtpy_config.py. + + * /retrieve/email?mailLogId= + * /retrieve/emails?email=[&amount=] + + * /create/email?sender=&recipients=[&subject=&body=&ip=&port=] + + * /delete/email?mailLogId= + * /delete/emails?email= \ No newline at end of file diff --git a/smtpy_api.py b/smtpy_api.py index 0a1de9a..045b801 100644 --- a/smtpy_api.py +++ b/smtpy_api.py @@ -1,16 +1,6 @@ #! /usr/bin/env python3 """ Simple JSON REST API for the smtpy service using the bottle framework. -Ony contains two retrievals currently: - - - /email?email= - This will retrieve the first entry in the database (if any) for - the supplied email address. - - - /emails?email=[&amount=] - This will retrieve an amount of entries from the database for the - supplied email. If the amount parameter is omitted, it is defaulted - to 1. Copyright (c) 2015, Matthew Kelly (Badgerati) License: MIT (see LICENSE for details)