# jmap-draft-client

**Repository Path**: mirrors_linagora/jmap-draft-client

## Basic Information

- **Project Name**: jmap-draft-client
- **Description**: The client to comsume JMAP server with draft version
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2026-01-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# JMAP-DRAFT-CLIENT

[![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-draft-client.svg?branch=master)](https://travis-ci.org/linagora/jmap-draft-client) [![Coverage Status](https://coveralls.io/repos/linagora/jmap-draft-client/badge.svg?branch=master&service=github)](https://coveralls.io/github/linagora/jmap-draft-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-draft-client

or

    bower install jmap-draft-client

depending on your preferred package manager.

### Code

The library is very easy to use, all you need to do is create an instance of the *Client* class, then use its fluent API to send some JMAP requests:

    new jmapDraft.Client(<your Transport>, <your PromiseProvider>)
        .withAPIUrl('https://jmap.my.server.com')
        .withAuthenticationToken('YourAuthenticationToken')
        .getMailboxes()
        .then((mailboxes) => {
            // Do something with the list of mailboxes
        }, (err) => {
            // An error occured
        });

Once you're familiar with the library, head on to the [API documentation](http://linagora.github.io/jmap-draft-client/doc/api/) to find out what's possible...  
There's also some code samples included in the *samples* folder.

## How to contribute

### 1. Clone the repository

    git clone https://ci.open-paas.org/stash/scm/olibs/jmap-draft-client.git
    cd jmap-draft-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, to release a new version check this project https://ci.linagora.com/linagora/lgs/openpaas/openpaas-release-module
## Roadmap

* Implement complete error handling.
* Add support for message attachments.
* Support entities states, and then getXXXUpdates requests.
* ...

## License

[MIT](LICENSE)