Commit Graph

274 Commits

Author SHA1 Message Date
Pascal Bleser
3c19e1d1db groupware: implement Mailbox modification endpoints + refactor ETag/state in the framework
* add endpoints for Mailboxes:
   - PATCH mailboxes/{id}
   - DELETE mailboxes/{id}
   - POST mailboxes

 * refactor the pkg/jmap and groupware framework to systematically
   return a jmap.State out-of-band of the per-method payloads, since
   they are almost always present in JMAP responses, which lead to the
   artificial creation of a lot of composed struct types just to also
   return the State; on the downside, it adds yet another return
   parameter
2026-04-03 15:40:09 +02:00
Pascal Bleser
ee399503ba groupware: add ical blob parsing endpoint 2026-04-03 15:40:09 +02:00
Pascal Bleser
f9f55866bb groupware: add Mailbox sorting 2026-04-03 15:40:09 +02:00
Pascal Bleser
8998cd516f groupware: jmap: fix id -> blobId attribute when uploading a blob 2026-04-03 15:40:09 +02:00
Pascal Bleser
3cdd4b56ee groupware: fix creating contacts 2026-04-03 15:40:09 +02:00
Pascal Bleser
5bb710196f groupware: actually add total and limit to the email summary endpoint 2026-04-03 15:40:09 +02:00
Pascal Bleser
733feeacce groupware: fix compilation in tests after recent changes 2026-04-03 15:40:09 +02:00
Pascal Bleser
c0ebd364ad groupware: add missing total,limit,offset attributes in the QueryEmailsSummaries response 2026-04-03 15:40:09 +02:00
Pascal Bleser
92d36ff23d groupware: add threadCount to /groupware/accounts/{accountId}/mailboxes/{mailboxId}/emails 2026-04-03 15:40:09 +02:00
Pascal Bleser
c33c7b481a groupware: add ContactCard operations 2026-04-03 15:40:09 +02:00
Pascal Bleser
584901531e groupware: add threadSize in email-by-id response 2026-04-03 15:40:09 +02:00
Pascal Bleser
086eb32f16 groupware: introduce constants for Email property names, see EmailSummaryProperties 2026-04-03 15:40:09 +02:00
Pascal Bleser
b5db2279d2 groupware: fix keyword patching syntax for markAsSeen=true 2026-04-03 15:40:09 +02:00
Pascal Bleser
7157048d64 groupware: add threadSize property in the email summary endpoint 2026-04-03 15:40:09 +02:00
Pascal Bleser
d939fe50be groupware: add markAsSeen=true to mark an email as $seen before it is
retrieved
2026-04-03 15:40:09 +02:00
Pascal Bleser
b1f89939c7 groupware: add searching emails by their Message-Id + retrieving an email by its ID as message/rfc822 2026-04-03 15:40:09 +02:00
Pascal Bleser
37bdf7afcb groupware: add identity deletion 2026-04-03 15:40:09 +02:00
Pascal Bleser
16f3adb4fb groupware:
* made several email related operations multi-account:
   QueryEmailSnippets, QueryEmails, QueryEmailsWithSnippets

 * add GetIdentitiesForAllAccounts

 * add GetEmailsForAllAccounts

 * jmap: add CreateIdentity, UpdateIdentity; groupware: add
   GetIdentityById, AddIdentity, ModifyIdentity

 * add temporary workaround until Calendars, Tasks, Contacts are
   implemented in Stalwart when determining the default account for
   those: use the mail one in the mean time
2026-04-03 15:40:09 +02:00
Pascal Bleser
ad2ceb530e groupware: jmap: don't collpase threads when searching for emails, and add dumping of JMAP request payloads when trace logging is enabled 2026-04-03 15:40:08 +02:00
Pascal Bleser
2e0550fa09 jmap: add GetInboxNameForMultipleAccounts 2026-04-03 15:40:08 +02:00
Pascal Bleser
5718eb023e jmap: fix Email/set 2026-04-03 15:40:08 +02:00
Pascal Bleser
ec7fd26377 groupware: improve jmap integration tests
* use gofakeit instead of loremipsum, as it can also fake images for
   attachments

 * random emails for testing: generate threads, add attachments
2026-04-03 15:40:08 +02:00
Pascal Bleser
bb9a4e2fbc groupware: rewrite JMAP integration test to be more reusable, and upgrade Stalwart container to 0.13.4 2026-04-03 15:40:08 +02:00
Pascal Bleser
46b35b2c54 groupware: add bootstrapping on / with quotas for all accounts 2026-04-03 15:40:08 +02:00
Pascal Bleser
dd28e4f1cf groupware: add /quota for all accounts 2026-04-03 15:40:08 +02:00
Pascal Bleser
b31792974c groupware: add quota API + add support for Accept-Language and Content-Language 2026-04-03 15:40:08 +02:00
Pascal Bleser
8ca3cf13fc groupware: add JMAP capability checking (in part: for contacts, calendars, tasks) 2026-04-03 15:40:08 +02:00
Pascal Bleser
d23918e695 groupware: add mock endpoints for tasklists and tasks 2026-04-03 15:40:08 +02:00
Pascal Bleser
dc488a936a groupware: implement JMAP Task specification 2026-04-03 15:40:08 +02:00
Pascal Bleser
55592e069f groupware: more mock data, added missing JMAP types 2026-04-03 15:40:08 +02:00
Pascal Bleser
57de1b6463 groupware: add mock endpoints for addressbooks and contacts 2026-04-03 15:40:08 +02:00
Pascal Bleser
83d5a56692 implement JSCalendar (RFC 8984) 2026-04-03 15:40:08 +02:00
Pascal Bleser
ed401b1723 JSContact: refactored after full test coverage, stronger typing for enumerations 2026-04-03 15:40:08 +02:00
Pascal Bleser
15939c0759 Implement JSContact (RFC9553) Model
* add pkg/jscontact with the implementation of the RFC9553 data model

 * add JMAP Calendar session capabilities support in pkg/jmap
2026-04-03 15:40:08 +02:00
Pascal Bleser
e32cfd0f54 start websocket implementation, add endpoint for email summaries
* feat(groupware): start implementing JMAP websocket support for push
   notifications (unfinished)

 * groupware: add GetLatestEmailsSummaryForAllAccounts

 * add new vendored dependency: github.com/gorilla/websocket

 * jmap: add QueryEmailSummaries

 * openapi: start adding examples

 * openapi: add new tooling for api-examples.yaml injection

 * apidoc-process.ts: make it more typescript-y

 * bump @redocly/cli from 2.0.8 to latest 2.2.0
2026-04-03 15:40:08 +02:00
Pascal Bleser
0b51eacc66 feat(groupware): add WebsocketEndpoint to the JMAP Session 2026-04-03 15:40:08 +02:00
Pascal Bleser
5e7266f75e jmap: modify GetBlob -> GetBlobMetadata
* fix(jmap): fix bug where CommandBlobUpload was used instead of
   CommandBlobGet in GetBlob (now GetBlobMetadata)

 * we currently don't need a variant of BlobGetCommand that also
   retrieves the content of the blob, instead we only use it for
   retrieving metadata about it
2026-04-03 15:40:07 +02:00
Pascal Bleser
27f543394b fix(groupware): fix JMAP error handling
* the JMAP error handling was not working properly, fixed it and added
   error definitions accordingly

 * add operations to retrieve mailbox roles and mailboxes by role for
   all accounts
2026-04-03 15:40:07 +02:00
Pascal Bleser
3e83d9645e refactor(groupware): use a function for multi-account method call IDs
* introduce a function 'mcid' to assemble method call IDs per account
   instead of doing that inline in each function, in case the rules for
   doing so change in the future
2026-04-03 15:40:07 +02:00
Pascal Bleser
a1db1aeb5b refactor(groupware): add max requests check
* move jmap.request() to jmap.Client.request() and pass the Session
   and a Logger to introduce checking the number of methodCalls within a
   request not exceeding the limit of the Session, as well as error
   handling and logging there instead of in each caller

 * a few bugfixes:
   - add a few missing Send() calls in logs
   - correct the response tag matching for
     GetMailboxChangesForMultipleAccounts
   - fix typo in Identity.ReplyTo json serialization rune
   - fix response tag in pkg/jmap/testdata/mailboxes1.json after
     changing them to be prefixed by the accountId
2026-04-03 15:40:07 +02:00
Pascal Bleser
cf7a8d90cf groupware: minor typo fixes 2026-04-03 15:40:07 +02:00
Pascal Bleser
5acbde1d97 feat(groupware): add fetching all mailboxes for all accounts
* add URL to retrieve all the mailboxes for all the accounts of a user,
   as a first use-case for an all-accounts operation, as
   /accounts/all/mailboxes

 * add URL to retrieve mailbox changes for all the mailboxes of all the
   accounts of a user, as a first use-case for an all-accounts
   operation, as /accounts/all/mailboxes/changes

 * change the defaultAccountId from '*' to '_', as '*' rather indicates
   "all" than "default", and we might want to use that for "all
   accounts" operations in the future

 * refactor(groupware): remove the accountId parameter from the logger()
   function, as it is not used anyways, but also confusing for
   operations that support multiple account ids
2026-04-03 15:40:07 +02:00
Pascal Bleser
75bc0065db docs(groupware): OpenAPI improvements
* refactor some pkg/jmap and groupware methods to make more sense from
   an API point-of-view

 * add path parameter documentation, but automate it by injecting their
   definition into the OpenAPI YAML tree that is extracted from the
   source code using go-swagger as it is too cumbersome, repetitive and
   error-prine to document them in the source code; wrote a TypeScript
   file apidoc-process.ts to do so

 * add generating an offline HTML file for the OpenAPI documentation
   using redocly, and injecting a favicon into the resulting HTML; wrote
   a TypeScript file apidoc-postprocess-html.ts to do so
2026-04-03 15:40:07 +02:00
Pascal Bleser
a54b75d2f9 test(groupware): add testcontainers based jmap test
* adds pkg/jmap/jmap_integration_test.go

 * uses ghcr.io/stalwartlabs/stalwart:v0.13.2-alpine

 * can be disabled by setting one of the following environment
   variables, in the same fashion as ca0493b28
   - CI=woodpecker
   - CI_SYSTEM_NAME=woodpecker
   - USE_TESTCONTAINERS=false

 * dependencies:
   - bump github.com/go-test/deep from 1.1.0 to 1.1.1
   - add github.com/cention-sany/utf7
   - add github.com/dustinkirkland/golang-petname
   - add github.com/emersion/go-imap/v2
   - add github.com/emersion/go-message
   - add github.com/emersion/go-sasl
   - add github.com/go-crypt/crypt
   - add github.com/go-crypt/x
   - add github.com/gogs/chardet
   - add github.com/inbucket/html2text
   - add github.com/jhilleryerd/enmime/v2
   - add github.com/ssor/bom
   - add gopkg.in/loremipsum.v1
2026-04-03 15:40:06 +02:00
Pascal Bleser
879ca8707b refactor(groupware): session cache and DNS autodiscovery
* move the logging of the username and session state away from pkg/jmap
   and into services/groupware

 * introduce more decoupling for the session cache, as well as moving
   the implementation into groupware_session.go
2026-04-03 15:38:19 +02:00
Pascal Bleser
31e08f087e groupware: session handling improvements
* remove the baseurl from the JMAP client configuration, and pass it to
   the session retrieval functions instead, as that is really the only
   place where it is relevant, and we gain flexibility to discover that
   session URL differently in the future without having to touch the
   JMAP client

 * move the default account identifier handling from the JMAP package to
   the Groupware one, as it really has nothing to do with JMAP itself,
   and is an opinionated feature of the Groupware REST API instead

 * add an event listener interface for JMAP events to be more flexible
   and universal, typically for metrics that are defined on the API
   level that uses the JMAP client

 * add errors for when default accounts cannot be determined

 * split groupware_framework.go into groupware_framework.go,
   groupware_request.go and groupware_response.go

 * move the accountId logging into the Groupware level instead of JMAP
   since it can also be relevant to other operations that might be
   worthy of logging before the JMAP client is even invoked
2026-04-03 15:38:18 +02:00
Pascal Bleser
05f8569687 jmap: minor logging improvements 2026-04-03 15:38:18 +02:00
Pascal Bleser
1288944f74 groupware: jmap: add metrics 2026-04-03 15:38:18 +02:00
Pascal Bleser
5fc0dc5ea2 groupware: Etag handling
* implement correct Etag and If-None-Match handling, responding with
   304 Not Modified if they match

 * introduce SessionState and State string type aliases to ensure we are
   using the correct fields for those, respectively

 * extract the SessionState from the JMAP response bodies in the
   groupware framework instead of having to do that in every single
   groupware API

 * use uint instead of int in some places to clarify that the values are
   >= 0

 * trace-log how long a Session was held in cache before being evicted

 * add Trace-Id header handling: add to response when specified in
   request, and implement a custom request logger to include it as a
   field

 * implement a more compact trace-logging of all the methods and URIs
   that are served, to put them into a single log entry instead of
   creating one log entry for every URI
2026-04-03 15:38:18 +02:00
Pascal Bleser
9ab4829a29 groupware: initial related emails implementation with SSE 2026-04-03 15:38:18 +02:00