Giter VIP home page Giter VIP logo

abstract-email's Introduction

abstract-email

Service to provide abstraction between multiple email service providers

Installation

  • Install required python libraries via

      `pip install -r requirements.txt`
    

Configuration

  • Copy config.py.sample to config.py and fill in appropriate values

  • *_API should be the full URI to the mail service api e.g.

      `MANDRILL_API = "https://mandrillapp.com/api/1.0/messages/send.json"`
    
  • PROVIDER can be either "mailgun" or "mandrill" (case sensitive). If not provided, mailgun will be used by default.

Running

  • Launch the dev Flask server by running

      `python ./run.py`
    

Testing

  • Launch test suite by running

      `python ./run_unittest.py`
    

Language & Framework

abstract-email uses Python and Flask, mostly because I am most familiar with this duo, but Flask is also particularly suitable because it is quite lightweight and modular, and not much is required by this app besides basic URL routing and request handling.

Trade-offs/Additional info

  • I didn't attempt the extra tasks, but if I had defined the Mail object as a database model from the start, it would have made parameter validation a little more straightforward.

  • If the service was planned to have a few more endpoints, perhaps by implementing the 'opens and clicks' functionality, I may have used a REST plugin such as Flask-RESTless to easily parse and commit the POST data to the database.

abstract-email's People

Contributors

mcardillo55 avatar

Watchers

 avatar  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.