Code Monkey home page Code Monkey logo

jmap-demo-webmail's Introduction

JMAP Demo Webmail

This is a simple, but in many ways surprisingly sophisticated demo webmail client, making use of the JMAP JS library, and built on top of the Overture library. Hopefully this will make it easier for people to start hacking on JMAP immediately and get a feel for it. There's less than 2000 lines of non-library code - and that includes generous spacing and a few comments.

There's a hosted version at http://proxy.jmap.io, which uses the JMAP proxy to provide a JMAP interface to a Gmail or IMAP account.

The app showcases a number of features from the JMAP JS library:

  1. It's fast. Because JMAP can load pretty much any view in one round trip.

  2. You have full access to a complete mailbox, with no paging. Jump to any point and the data loads in quickly. The library is actually automatically prefetching a little bit either side of the section you currently need, so scrolling through it gives the illusion of a fully loaded mailbox.

  3. All changes update the local UI instantly, then sync to the server in the background. If the server rejects the changes, the library will automatically revert the local cache so it stays in sync.

  4. There's full, multi-level undo (and redo – Cmd-Shift-Z!) support. Again, the changes occur instantly in the client and are synced back to the server later. It can even handle undo when it's in the middle of syncing the original change to the server.

  5. There's full push support. The EventSource connection to the server receives a new state token whenever something changes, which triggers the library to make a request to the server and get back the changes. Very fast, very efficient.

Installation

Clone the git repo, open index.html – it will talk to a basic simulated JMAP server (see fixtures.js) so you can try it locally. To talk to a real server, comment out the fixtures.js file in index.html, and modify the JMAP.auth.didAuthenticate call in state.js to tell it where to connect to.

License

All code and design is made available under the liberal MIT license. Please see the LICENSE file in the repo for full details.

jmap-demo-webmail's People

Contributors

neilj avatar

Stargazers

 avatar

Watchers

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