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

JMAP server API for Nextcloud
https://github.com/audriga/nextcloud-jmap

Last synced: 3 months ago
JSON representation

JMAP server API for Nextcloud

• Host: GitHub
• URL: https://github.com/audriga/nextcloud-jmap
• Owner: audriga
• License: agpl-3.0
• Created: 2021-01-28T16:34:17.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-07-30T09:55:54.000Z (3 months ago)
• Last Synced: 2024-07-30T13:04:58.073Z (3 months ago)
• Language: PHP
• Size: 153 KB
• Stars: 27
• Watchers: 12
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.rst
  • License: COPYING

Awesome Lists containing this project

• awesome-starred - audriga/nextcloud-jmap - JMAP server API for Nextcloud (others)

README

        
# Nextcloud 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 App for Nextcloud provides [JMAP](https://jmap.io/) support for Nextcloud systems by exposing a RESTful API Endpoint which speaks the JMAP Protocol.

Please note that this version is still in its early stages.

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

* Contacts over the JMAP for Contacts protocol

* Calendars over the JMAP for Calendars protocol, built on top of the [JSCalendar](https://tools.ietf.org/html/draft-ietf-calext-jscalendar-32) format

## 🏗 Installation

1. ☁ Clone this app into the `apps` folder of your Nextcloud: `git clone https://github.com/audriga/jmap-nextcloud jmap` (Make sure the folder is named `jmap`).

2. 👩‍💻 In the folder of the app, run the command `make` to install dependencies and build the Javascript.

3. ✅ Enable the app through the app management of your Nextcloud

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

## Usage

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

## Development

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 CalendarEvents:

```

curl -u username:password /index.php/apps/jmap/jmap -d '{"using":["urn:ietf:params:jmap:calendars"],"methodCalls":[["CalendarEvent/get",{"accountId":""},"0"]]}'

```

#### Tested against

PHP: 8.1 and 8.2

Nextcloud: between 24 and 29