Giter VIP home page Giter VIP logo

bipostal's Introduction

Getting Started

  1. Make your virtualenv.

  2. Install the python packages:

    pip install -r dev-reqs.txt
    
  3. Start the server:

    paster serve etc/bipostal-dev.ini
    

Run the Server

paster serve etc/bipostal-dev.ini

The API

GET /alias/
>>> 200 OK {"email": <email>, "aliases": [<alias>, <alias>, ...]}

Retrieve all the aliases for the current user.

Requires browserid auth.
POST /alias/
>>> 200 OK {"email": <email>, "alias": <alias>}

Create a new alias for the current user.

Optionally, an alias can be requested in the POST body:

    {"alias": <alias>}

Requires browserid auth.
GET /alias/<alias>
>>> 200 OK {"email": <email>}

Get the real email address for the given alias.

No auth required.
DELETE /alias/<alias>
>>> 200 OK

Forget about the given alias.

Requires browserid auth.
PUT /alias/<alias>
>>> 200 OK

Modify the given alias by passing these properties in the body::

    {"active": true|false}

Requires browserid auth.

bipostal's People

Contributors

bbangert avatar billrest avatar jrconlin avatar rfk avatar

Stargazers

 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.