Create archive folder if it does not exist (#468)

* Fix stalwart's example config for dev.

Stalwart pops fields from the oidc response for some reason,
it'll set email as username if we don't specify username.
So let's drop that.

* Add a middleware that checks and automatically fixes missing archives folder

Changes:
* Add thunderbird_accounts.mail.middleware.FixMissingArchivesFolderMiddleware
* Add Account.verified_archive_folder (bool)
* Add functionality to query and create (if needed) an archives folder via jmap
* Add settings.STALWART_ARCHIVES_FOLDER_NAME which controls the name of the archives folder that is created.

* Move middleware to to mail and start working out the tests

* Remove duplicate migration

* Finish up the middleware tests

* Lint fix

* Fix mailbox/set response check and test

Author: MelissaAutumn

boot-docker-build.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+sudo docker compose up --build accounts vite-dev celery

boot-docker-deps.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+sudo docker compose up postgres redis kcpostgres keycloak stalwart mailpit

config.toml.example

@@ -51,7 +51,6 @@ cache.ttl.positive = "1h"
 endpoint.method = "introspect"
 endpoint.url = "http://keycloak:8999/realms/tbpro/protocol/openid-connect/token/introspect"
 fields.email = "username"
-fields.username = "username"
 timeout = "15s"
 type = "oidc"
 

src/thunderbird_accounts/authentication/middleware.py

@@ -1,4 +1,5 @@
 import logging
+from typing import Optional
 from socket import gethostbyname, gethostname
 
 from django.conf import settings
@@ -14,11 +15,17 @@
 
 
 class AccountsOIDCBackend(OIDCAuthenticationBackend):
+    """User authentication middleware for OIDC
+
+    This is our slightly customized mozilla-django-oidc middleware used to create/update/authenticate users
+    against oidc flows.
+    """
+
     def get_user(self, user_id):
         """Retrieve the user from OIDC get_user and additionally check if they're active.
         Fixes https://github.com/mozilla/mozilla-django-oidc/issues/520
         """
-        user: User = super().get_user(user_id)
+        user: Optional[User] = super().get_user(user_id)
         return user if self.user_can_authenticate(user) else None
 
     def _check_allow_list(self, claims: dict):

src/thunderbird_accounts/authentication/models.py

@@ -11,6 +11,7 @@
 
 class User(AbstractUser, BaseModel):
     """
+    :param username: The thundermail address, aligns with keycloak's usage of username.
     :param oidc_id: The ID of the connected oidc account
     :param last_used_email: The last used email associated with this account
     :param language: The user's preferred language to view the ui/system emails in

src/thunderbird_accounts/mail/middleware.py

@@ -0,0 +1,26 @@
+from django.http import HttpRequest
+from thunderbird_accounts.mail.utils import fix_archives_folder
+
+
+class FixMissingArchivesFolderMiddleware:
+    def __init__(self, get_response):
+        self.get_response = get_response
+
+    def __call__(self, request):
+        if request.user.is_authenticated and request.user.has_active_subscription:
+            # This needs to be here for after they subscribe
+            # we need their oidc access token which is only available on the request...
+            self.check_if_we_need_to_fix_archives_folder(request)
+
+        return self.get_response(request)
+
+    def check_if_we_need_to_fix_archives_folder(self, request: HttpRequest):
+        oidc_access_token = request.session['oidc_access_token']
+        user = request.user
+
+        # If the user exists, has a stalwart account reference and an oidc access token
+        # Check if we need to fix their archives folder, and do it if we need to.
+        if user and user.account_set.count() > 0 and oidc_access_token:
+            archive_folders_to_check = user.account_set.filter(verified_archive_folder=False)
+            for account in archive_folders_to_check:
+                fix_archives_folder(oidc_access_token, account)

src/thunderbird_accounts/mail/migrations/0009_account_verified_archive_folder.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.2.9 on 2025-12-03 19:13
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('mail', '0008_merge_0007_account_quota_0007_domain'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='account',
+            name='verified_archive_folder',
+            field=models.BooleanField(default=False, help_text='On login we check if they have an archive folder. If this is true that check will be skipped.'),
+        ),
+    ]

src/thunderbird_accounts/mail/models.py

@@ -63,6 +63,10 @@ class Account(BaseStalwartObject):
     quota = models.BigIntegerField(
         null=True, help_text=_('Amount of mail storage this account has access to (in bytes).')
     )
+    verified_archive_folder = models.BooleanField(
+        default=False,
+        help_text=_('On login we check if they have an archive folder. If this is true that check will be skipped.'),
+    )
     # TODO: Implement freeze_quota
 
     class Meta:
@@ -133,29 +137,17 @@ class DomainStatus(models.TextChoices):
         VERIFIED = 'verified', _('Verified')
         FAILED = 'failed', _('Verification Failed')
 
-    name = SmallTextField(
-        unique=True,
-        help_text=_('The domain name (e.g., example.com)')
-    )
+    name = SmallTextField(unique=True, help_text=_('The domain name (e.g., example.com)'))
     status = models.CharField(
         max_length=20,
         choices=DomainStatus,
         default=DomainStatus.PENDING,
-        help_text=_('Current verification status of the domain')
+        help_text=_('Current verification status of the domain'),
     )
     user = models.ForeignKey(
-        User,
-        on_delete=models.CASCADE,
-        related_name='domains',
-        help_text=_('The user who owns this domain')
-    )
-    verified_at = models.DateTimeField(
-        null=True,
-        blank=True,
-        help_text=_('Date and time when the domain was verified')
+        User, on_delete=models.CASCADE, related_name='domains', help_text=_('The user who owns this domain')
     )
+    verified_at = models.DateTimeField(null=True, blank=True, help_text=_('Date and time when the domain was verified'))
     last_verification_attempt = models.DateTimeField(
-        null=True,
-        blank=True,
-        help_text=_('Date and time of the last verification attempt')
+        null=True, blank=True, help_text=_('Date and time of the last verification attempt')
     )