Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/linagora/jmap-client

This repository provides a javascript lib to make requests against a JMAP server.
https://github.com/linagora/jmap-client

api javascript jmap jmap-client mail

Last synced: 28 days ago
JSON representation

This repository provides a javascript lib to make requests against a JMAP server.

Host: GitHub
URL: https://github.com/linagora/jmap-client
Owner: linagora
License: mit
Created: 2015-07-09T14:25:43.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2021-03-01T14:43:22.000Z (almost 4 years ago)
Last Synced: 2024-12-10T03:37:52.270Z (about 2 months ago)
Topics: api, javascript, jmap, jmap-client, mail
Language: JavaScript
Size: 1.73 MB
Stars: 67
Watchers: 39
Forks: 22
Open Issues: 8
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # JMAP-CLIENT

:warning: jmap-client is based on an outdated jmap draft. If you are looking for a jmap client you can check this project [jmap-client-ts](https://github.com/OpenPaaS-Suite/jmap-client-ts)

[![Join the chat at https://gitter.im/linagora/jmap-client](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/linagora/jmap-client?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://travis-ci.org/linagora/jmap-client.svg?branch=master)](https://travis-ci.org/linagora/jmap-client) [![Coverage Status](https://coveralls.io/repos/linagora/jmap-client/badge.svg?branch=master&service=github)](https://coveralls.io/github/linagora/jmap-client?branch=master)

This repository provides a JavaScript library to make requests against a JMAP server.

It is a client-side implementation of the [JMAP](http://jmap.io/spec.html) specification.

It is developed using **ES6** and transpiled to ES5 code using [babel.js](https://babeljs.io/).

Non-exhaustive list of features:

* Entities are modeled as JavaScript classes.

* Expose a *Client* 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.js [request](https://github.com/request/request) and [jQuery](http://jquery.com/) in the browser.

## Usage

### Installation

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.

## How to contribute

### 1. Clone the repository

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

    cd jmap-client

### 2. Install dependencies

    npm install

### 3. Compile the library and run the tests

    grunt

### 4. Code, execute tests then pull request !

More detailled instructions can be found in the [contributing section](./CONTRIBUTING.md).

## Release

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

1. Checkout the _master_ branch and pull the latest changes from the remote repository

2. Run `grunt release` to do the release. A lot of things will happen but you'll eventually be back on the _master_ branch

3. Bump the version in _master_ to **NEXT_VERSION-dev** (replace _NEXT_VERSION_ by the supposed next version)

## License

[MIT](LICENSE)