Repository files navigation

⚠️ jmap-client is based on an outdated jmap draft. If you are looking for a jmap client you can check this projectjmap-client-ts

This repository provides a JavaScript library to make requests against a JMAP server.It is a client-side implementation of theJMAP specification.It is developed usingES6 and transpiled to ES5 code usingbabel.js.

Non-exhaustive list of features:

• Entities are modeled as JavaScript classes.
• Expose aClient class that you can use to send JMAP requests, using a fluent API.
• Uses Promises exclusively, and allows for pluggable Promise implementation.
• Allows for pluggable transports, with default support for node.jsrequest andjQuery in the browser.

The library is provided as a NPM or Bower packages, thus to install either use:

npm install jmap-client

or

bower install jmap-client

depending on your preferred package manager.

git clone https://ci.open-paas.org/stash/scm/olibs/jmap-client.gitcd jmap-client

npm install

grunt

More detailled instructions can be found in thecontributing section.

If you are a maintainer of this project, here's how you can release a new version:

1. Checkout themaster branch and pull the latest changes from the remote repository
2. Rungrunt release to do the release. A lot of things will happen but you'll eventually be back on themaster branch
3. Bump the version inmaster toNEXT_VERSION-dev (replaceNEXT_VERSION by the supposed next version)

MIT