https://github.com/audriga/roundcube-jmap

JMAP API for Roundcube Webmail
https://github.com/audriga/roundcube-jmap

Last synced: 3 months ago
JSON representation

JMAP API for Roundcube Webmail

• Host: GitHub
• URL: https://github.com/audriga/roundcube-jmap
• Owner: audriga
• License: gpl-3.0
• Created: 2021-05-31T11:59:51.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-17T12:30:46.000Z (7 months ago)
• Last Synced: 2024-06-21T12:26:51.018Z (5 months ago)
• Language: PHP
• Size: 135 KB
• Stars: 7
• Watchers: 6
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - audriga/roundcube-jmap - JMAP API for Roundcube Webmail (others)

README

        
# Roundcube JMAP

⚠️  This version is still in its early stages. This API exposes user data. It is not recommended to expose this API to untrusted networks for now. Please consider contacting us before using this in production.

The JMAP plugin for Roundcube provides [JMAP](https://jmap.io/) support for Roundcube by exposing a RESTful API Endpoint which speaks the JMAP Protocol.

The following data types are currently supported by the JMAP Plugin for Roundcube:

* Signatures over the [JMAP for Mail](https://www.rfc-editor.org/rfc/rfc8621) protocol

* Contacts over the JMAP for Contacts based on JSContact protocol (see https://www.audriga.eu/jmap/jscontact/ )

* (Planned) Calendars over the [JMAP for Calendars](https://datatracker.ietf.org/doc/draft-ietf-jmap-calendars/) protocol

This plugin allows Roundcube to function as an address book sync server. It makes use of the JMAP for Contacts protocol for that. JMAP for Contacts is a successor to [CardDAV](https://www.rfc-editor.org/rfc/rfc6352).

## Installation

1. Run `make` to initialize the project for the default PHP version (8.1). Use other build targets (e.g. `make php56_mode` or `make php70_mode`) instead, in case you are using a different version.

1. (optional) there are build targets that enable logging to graylog instead of a file, e.g. run `make graylog56_mode`

1. Run `make zip` to create a zipped package under `build/`

1. Extract the resulting package into the `plugins` folder of your Roundcube (Make sure the folder is named `jmap`).

1. 🎉 Partytime! Help fix [some issues](https://github.com/audriga/jmap-roundcube/issues) and [send us some pull requests](https://github.com/audriga/jmap-roundcube/pulls) 👍

## Usage

Set up your favorite client to talk to Roundcube's JMAP API.

## Development

### Installation

1. Run step 1) from above.

1. Run `make update` to update depdendencies and make devtools available

### Tests

To run all tests run `make fulltest`. This requires [Podman](https://podman.io/)

(for Static Anaylsis) and [Ansible](https://www.ansible.com/) (for Integration

Tests).

You can also run them separately:

* **Static Analysis** via `make lint`

* **Unit Tests** via `make unit_test`

#### Tested against

PHP: 5.6, 7.0, 8.1 and 8.2

Roundcube: 1.2, 1.3, 1.4 and 1.6

### Debug

For debugging purposes it makes sense to throw some cURL calls at the API. For example, this is how you tell the JMAP API to return all Contacts:

```

curl plugins/jmap/jmap.php -u : -d '{"using":["https://www.audriga.eu/jmap/jscontact/"],"methodCalls":[["Card/get", {"accountId":""}, "0"]]}'

```