COMPAT.md

Kopano GRAPI API compatibility with Microsoft Graph

This document summarizes the Kopano GRAPI implementation differences and scope in relation to Microsoft Graph API. Thus the upstream documentation applies to GRAPI. For a list of endpoints implemented by GRAPI see the Resources section below.

What's noteworthy

• Endpoints such as "/me/messages" or "/me/events" do not expose the entire store, but just the inbox or calendar, respectively.
• Relative paths, such as "mailFolder/id/childFolder/id/childFolder/id/.." are not supported.

Query Parameters

Genereally the Graph documentation applies considering the following changes:

• We do not support $filter or $format.
• Support for $expand and $count is preliminary.

Extensions

• We support handling attachments in binary using $value. For example: GET /me/messages/id/attachment/id/$value
• We support the query parameter $search for /users.

Batch API

We support the JSON batching API for combining multiple requests in one HTTP call.

Resources

This API supports groupware related endpoints. GRAPI follows a experimental/non-experimental approach. Experimental endpoints are disabled by default (enable with --enable-experimental-endpoints commandline switch).

attachment Resource

(Resource)

Get attachment

(Extension: use attachment/id/$value to get attachment in binary.)

Delete attachment

calendar Resource

(Resource)

Get calendar

List calendarView

List events

Create event

getSchedule

contact Resource

(Resource)

Get contact

Delete contact

delta

contactFolder Resource

(Resource)

Get contactFolder

List contacts

Create contact

delta

event Resource

(Resource)

Get event

Update event

Delete event

accept event

tentativelyAccept event

decline event

List instances

List attachments

Add attachment

group Resource

(Resource)

Get group

List members

mailFolder Resource

(Resource)

Get mailFolder

Create childFolder

List childFolders

Create message

List messages

Delete mailFolder

copy

move

delta

message Resource

(Resource)

Get message

Update message

Delete message

createReply

createReplyAll

send

List attachments

Add attachment

copy

move

delta

profilePhoto Resource

(Resource)

Get profilePhoto

Update profilePhoto

subscription Resource

(Resource)

Create subscription

Get subscription

Delete subscription

user Resource

(Resource)

List users

Get user

List messages

Create message

List mailFolders

Create mailFolder

sendMail

List events

Create event

List contactFolders

List calendars

List calendarView

reminderView

List contacts

Create contact

List memberOf

delta

calendar

calendars

events