Commit Graph

67 Commits

Author SHA1 Message Date
Pascal Bleser 46e5d82148 groupware: add threadSize in email-by-id response 2026-02-04 09:40:22 +01:00
Pascal Bleser b9999076e5 groupware: fix keyword patching syntax for adding and removing email keywords endpoints 2026-02-04 09:40:22 +01:00
Pascal Bleser 8cce5286f0 groupware: fix keyword patching syntax for markAsSeen=true 2026-02-04 09:40:22 +01:00
Pascal Bleser c61bded13f groupware: add threadSize property in the email summary endpoint 2026-02-04 09:40:22 +01:00
Pascal Bleser 5a3b66c312 groupware: improve email sanitization by using the mime package to parse the part type, in order to recognize HTML ones that need sanitization 2026-02-04 09:40:22 +01:00
Pascal Bleser 32a2cf5100 groupware: add headers Unmatched-Path and Unsupported-Method to make
development of the web UI easier
2026-02-04 09:40:22 +01:00
Pascal Bleser fa6b695f24 groupware: add markAsSeen=true to mark an email as $seen before it is
retrieved
2026-02-04 09:40:22 +01:00
Pascal Bleser f4ed735441 groupware: add the Retry-After header in responses when the session cannot be retrieved 2026-02-04 09:40:22 +01:00
Pascal Bleser 8999caf5a1 groupware: add searching emails by their Message-Id + retrieving an email by its ID as message/rfc822 2026-02-04 09:40:22 +01:00
Pascal Bleser df4253102d groupware: add email HTML sanitization
* sanitize email text/html body parts using bluemonday

 * deps(groupware):
   - new dependency: github.com/microcosm-cc/bluemonday
   - transitive dependencies:
     - github.com/aymerick/douceur
     - github.com/gorilla/css
2026-02-04 09:40:22 +01:00
Pascal Bleser 9ee798f42e groupware: add identity deletion 2026-02-04 09:40:22 +01:00
Pascal Bleser 9ef74191c0 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-02-04 09:40:22 +01:00
Pascal Bleser dce74c9e21 groupware: fix NPE when one of the accounts is a group account 2026-02-04 09:40:22 +01:00
Pascal Bleser 773edd9e2a groupware: accept both '_' and '*' as the 'default account' placeholder 2026-02-04 09:40:22 +01:00
Pascal Bleser 4620aa4727 groupware: implement email updating and email keyword updating endpoints 2026-02-04 09:40:21 +01:00
Pascal Bleser 5871d814d3 groupware: for /accounts/all/emails/latest/summary, rename the ?unread query parameter into ?seen as that is more intuitive 2026-02-04 09:40:21 +01:00
Pascal Bleser b5c454cd2c docs(groupware): fix basepath in OpenAPI, /groupware instead of /groupware/groupware 2026-02-04 09:40:21 +01:00
Pascal Bleser acd2532ba2 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-02-04 09:40:21 +01:00
Pascal Bleser d01bdc9d0c groupware: add bootstrapping on / with quotas for all accounts 2026-02-04 09:40:21 +01:00
Pascal Bleser 2eaae9f979 groupware: add /quota for all accounts 2026-02-04 09:40:21 +01:00
Pascal Bleser 9bfa73869f groupware: add quota API + add support for Accept-Language and Content-Language 2026-02-04 09:40:21 +01:00
Pascal Bleser 7a0ebbee70 groupware: add flag to currently ignore session capability checks for calendars, contacts and tasks, as those are not implemented in Stalwart yet; will need to remove it in the future 2026-02-04 09:40:21 +01:00
Pascal Bleser 86815a61a4 groupware: add JMAP capability checking (in part: for contacts, calendars, tasks) 2026-02-04 09:40:21 +01:00
Pascal Bleser 15d45f5ded groupware: add mock endpoints for tasklists and tasks 2026-02-04 09:40:21 +01:00
Pascal Bleser bbf9d1bd9c groupware: implement JMAP Task specification 2026-02-04 09:40:21 +01:00
Pascal Bleser ae1f5af2d4 groupware: more mock data, added missing JMAP types 2026-02-04 09:40:21 +01:00
Pascal Bleser 0ef3af4e19 groupware: add mock endpoints for addressbooks and contacts 2026-02-04 09:40:21 +01:00
Pascal Bleser ed11980784 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-02-04 09:40:21 +01:00
Pascal Bleser 4e08b26c7c refactor(groupware): just use a function for the attachment picker
Minor: be more Go idiomatic: just use a function to pick the attachment
from an Email's attachment list instead of using an interface with
multiple iplementation structs.
2026-02-04 09:40:21 +01:00
Pascal Bleser 3c4f34a2f3 groupware: improved attachment APIs
* feat(groupware): add /accounts/{}/emails/{}/attachments

 * feat(groupware): add
   /accounts/{}/emails/{}/attachments?partId=&name=&blobId=
2026-02-04 09:40:21 +01:00
Pascal Bleser 66d75c98de 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-02-04 09:40:20 +01:00
Pascal Bleser cfd4897a5d refactor(groupware): rename "Messages" to "Email" everywhere
There was really no reason to go with "Messages" as far as the
vocabulary of the Groupware API goes, since the objects those APIs serve
are "Emails", to stick with the wording of the JMAP specification.
2026-02-04 09:40:20 +01:00
Pascal Bleser 19b478197b groupware: minor typo fixes 2026-02-04 09:40:20 +01:00
Pascal Bleser ecd7c0946a 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-02-04 09:40:20 +01:00
Pascal Bleser 3968eedcc5 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-02-04 09:40:20 +01:00
Pascal Bleser 3813d14cae 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-02-04 09:40:20 +01:00
Pascal Bleser e63a7c4bc5 groupware: add DNS auto-discovery (currently disabled, needs testing) 2026-02-04 09:40:20 +01:00
Pascal Bleser f52a645c8a 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-02-04 09:40:20 +01:00
Pascal Bleser b76bec1279 groupware: fix debug server, was missing a lot of configuration options and was binding to :80 2026-02-04 09:40:20 +01:00
Pascal Bleser 3d85aa69b7 refactor(groupware): logging and metrics improvements
* some minor code refactorings to improve logging and metrics

 * more code documentation
2026-02-04 09:40:20 +01:00
Pascal Bleser 7adb66dd16 groupware: improve metrics
* implement more metrics, in a more streamlined fashion

 * use concurrent-map to store SSE streams instead of a regular map with
   one big lock that will not scale when it grows, causing too much
   contention on that one lock

 * while testing error metrics, noticed a few bugs with error handling
   when Stalwart is down: fixed
2026-02-04 09:40:20 +01:00
Pascal Bleser ad9387119b groupware: implement metrics
* implement a framework for metrics, with a few exemplary ones
2026-02-04 09:40:20 +01:00
Pascal Bleser 780e125621 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-02-04 09:40:20 +01:00
Pascal Bleser c7bb866595 groupware: initial related emails implementation with SSE 2026-02-04 09:40:20 +01:00
Pascal Bleser 675e3e5fdb 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-02-04 09:40:20 +01:00
Pascal Bleser 42a4c5c156 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-02-04 09:40:20 +01:00
Pascal Bleser 4d338ff6b8 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-02-04 09:40:20 +01:00
Pascal Bleser 17718abec5 groupware: minor email searching response improvements + started implementing vacation response setting API 2026-02-04 09:40:20 +01:00
Pascal Bleser 1309db5e43 groupware: add identities of all accounts to the index resource 2026-02-04 09:40:20 +01:00
Pascal Bleser a9e22fc2b8 groupware: fix email search, add variant that includes the full emails 2026-02-04 09:40:20 +01:00