Commit Graph

56 Commits

Author SHA1 Message Date
Pascal Bleser
1a50ae3d4e groupware: introduce constants for Email property names, see EmailSummaryProperties 2026-06-11 15:01:38 +02:00
Pascal Bleser
bca4874bda groupware: fix keyword patching syntax for markAsSeen=true 2026-06-11 15:01:38 +02:00
Pascal Bleser
c0fa55c03a groupware: add threadSize property in the email summary endpoint 2026-06-11 15:01:38 +02:00
Pascal Bleser
7b52f22f29 groupware: add markAsSeen=true to mark an email as $seen before it is
retrieved
2026-06-11 15:01:38 +02:00
Pascal Bleser
e2d297363b groupware: add searching emails by their Message-Id + retrieving an email by its ID as message/rfc822 2026-06-11 15:01:37 +02:00
Pascal Bleser
8b88935f9b groupware: add identity deletion 2026-06-11 15:01:37 +02:00
Pascal Bleser
1b31f0bc9c 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-06-11 15:01:37 +02:00
Pascal Bleser
6b1a6e604c groupware: jmap: don't collpase threads when searching for emails, and add dumping of JMAP request payloads when trace logging is enabled 2026-06-11 15:01:37 +02:00
Pascal Bleser
5854250280 jmap: add GetInboxNameForMultipleAccounts 2026-06-11 15:01:37 +02:00
Pascal Bleser
87542de826 jmap: fix Email/set 2026-06-11 15:01:37 +02:00
Pascal Bleser
0dff6808c1 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-06-11 15:01:37 +02:00
Pascal Bleser
4be535594e groupware: rewrite JMAP integration test to be more reusable, and upgrade Stalwart container to 0.13.4 2026-06-11 15:01:37 +02:00
Pascal Bleser
d9f08c7cfe groupware: add bootstrapping on / with quotas for all accounts 2026-06-11 15:01:37 +02:00
Pascal Bleser
45e421807d groupware: add /quota for all accounts 2026-06-11 15:01:37 +02:00
Pascal Bleser
04562cc6b3 groupware: add quota API + add support for Accept-Language and Content-Language 2026-06-11 15:01:37 +02:00
Pascal Bleser
79aaa96634 groupware: add JMAP capability checking (in part: for contacts, calendars, tasks) 2026-06-11 15:01:37 +02:00
Pascal Bleser
f34dc0ed27 groupware: add mock endpoints for tasklists and tasks 2026-06-11 15:01:37 +02:00
Pascal Bleser
657092b035 groupware: implement JMAP Task specification 2026-06-11 15:01:37 +02:00
Pascal Bleser
5a194d73d5 groupware: more mock data, added missing JMAP types 2026-06-11 15:01:36 +02:00
Pascal Bleser
70b5835bdb groupware: add mock endpoints for addressbooks and contacts 2026-06-11 15:01:36 +02:00
Pascal Bleser
f817a992b8 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-06-11 15:01:36 +02:00
Pascal Bleser
280194060c 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-06-11 15:01:36 +02:00
Pascal Bleser
18a82cd3eb feat(groupware): add WebsocketEndpoint to the JMAP Session 2026-06-11 15:01:36 +02:00
Pascal Bleser
dcaece3e17 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-06-11 15:01:36 +02:00
Pascal Bleser
d8952d3467 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-06-11 15:01:36 +02:00
Pascal Bleser
ca59d7e2a7 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-06-11 15:01:36 +02:00
Pascal Bleser
17ffe8ec56 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-06-11 15:01:36 +02:00
Pascal Bleser
64e7f46495 groupware: minor typo fixes 2026-06-11 15:01:36 +02:00
Pascal Bleser
a48a4ecd68 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-06-11 15:01:36 +02:00
Pascal Bleser
5503dc4343 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-06-11 15:01:36 +02:00
Pascal Bleser
2b080a6c38 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-06-11 15:01:36 +02:00
Pascal Bleser
979e511027 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-06-11 15:01:36 +02:00
Pascal Bleser
fa5d7f1900 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-06-11 15:01:36 +02:00
Pascal Bleser
5f94931b50 jmap: minor logging improvements 2026-06-11 15:01:36 +02:00
Pascal Bleser
f758f602cc groupware: jmap: add metrics 2026-06-11 15:01:36 +02:00
Pascal Bleser
c290330971 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-06-11 15:01:36 +02:00
Pascal Bleser
4a7a5cfa62 groupware: initial related emails implementation with SSE 2026-06-11 15:01:35 +02:00
Pascal Bleser
f3d998ac2a groupware: add /bootstrap
* add a GET /accounts/{a}/boostrap URI that delivers the same as GET /
   but also mailboxes for a given account, in case the UI remembers the
   last used account identifier, to avoid an additional roundtrip

 * streamline the use of simpleError()

 * add logging of errors at the calling site

 * add logging of evictions of Sessions from the cache

 * change default Session cache TTL to 5min instead of 30sec
2026-06-11 15:01:35 +02:00
Pascal Bleser
d0fc663e94 groupware: swagger API documentation improvements
* add more documentation for properties

 * fixes after a bit of trial-and-error with go-swagger

 * fix email filter marshalling when there are no search criteria

 * introduce an apidoc.yml that contains Swagger data and is merged when
   generating the swagger.yml from sources
2026-06-11 15:01:35 +02:00
Pascal Bleser
3c20edc0c9 Groupware improvements
* ensure that all the jmap responses contain the SessionState

 * implement missing errors that were marked as TODO

 * moved common functions from pkg/jmap and pkg/services/groupware to
   pkg/log and pkg/structs to commonalize them across both source trees

 * implement error handling for SetError occurences

 * Email: replace anonymous map[string]bool for mailbox rights with a
   MailboxRights struct, as the keys are well-defined, which allows for
   properly documenting them

 * introduce ObjectType as an "enum"

 * fix JSON marshalling and unmarshalling of EmailBodyStructure

 * move the swagger documentation structs from groupware_api.go to
   groupware_docs.go

 * fix: change verb for /groupware/accounts/*/vacation from POST to PUT
2026-06-11 15:01:35 +02:00
Pascal Bleser
d3054a68a7 groupware: minor email searching response improvements + started implementing vacation response setting API 2026-06-11 15:01:35 +02:00
Pascal Bleser
e3bb152bca groupware: add identities of all accounts to the index resource 2026-06-11 15:01:35 +02:00
Pascal Bleser
46f46e1f73 groupware: fix email search, add variant that includes the full emails 2026-06-11 15:01:35 +02:00
Pascal Bleser
3e7c4a023b Groupware: refactor jmap package, implement Email/set, EmailSubmission
* refactor the jmap package to split it into several files as the
   jmap.api.go file was becoming too unwieldy

 * refactor the Groupware handler function response to be a Response
   object, to be more future-proof and avoid adding more and more
   return parameters while handling "no content" response as well

 * more godoc for the JMAP model

 * add Email creation, updating, deleting (Email/set,
   EmailSubmission/set)

 * add endpoints
   - POST /accounts/{accountid}/messages
   - PATCH|PUT /accounts/{accountid}/messages/{messageid}
   - DELETE /accounts/{accountid}/messages/{messageid}
2026-06-11 15:01:35 +02:00
Pascal Bleser
e364f73caa groupware: implement message search with snippets 2026-06-11 15:01:35 +02:00
Pascal Bleser
8533a693b2 groupware: blob streaming (upload and download) 2026-06-11 15:01:35 +02:00
Pascal Bleser
f290fe18e8 groupware: more JMAP operations implementation 2026-06-11 15:01:35 +02:00
Pascal Bleser
7acb223e4e groupware: further implementation and improvements 2026-06-11 15:01:35 +02:00
Pascal Bleser
5074f1b99b refactored the Session object, refactored the services/groupware directory, and started Swagger documentation implementation 2026-06-11 15:01:35 +02:00
Pascal Bleser
17ba168593 groupware: refactoring the API mechanisms 2026-06-11 15:01:35 +02:00