feat(archive): add yearly/monthly archive folder options

core/android/account/src/main/kotlin/net/thunderbird/core/android/account/LegacyAccountDto.kt

@@ -12,6 +12,7 @@ import net.thunderbird.feature.account.AccountIdFactory
 import net.thunderbird.feature.account.storage.profile.AvatarDto
 import net.thunderbird.feature.account.storage.profile.AvatarTypeDto
 import net.thunderbird.feature.mail.account.api.BaseAccount
+import net.thunderbird.feature.mail.folder.api.ArchiveGranularity
 import net.thunderbird.feature.mail.folder.api.FolderPathDelimiter
 import net.thunderbird.feature.mail.folder.api.SpecialFolderSelection
 import net.thunderbird.feature.notification.NotificationSettings
@@ -199,6 +200,9 @@ open class LegacyAccountDto(
     @get:Synchronized
     var archiveFolderSelection = SpecialFolderSelection.AUTOMATIC
 
+    @get:Synchronized
+    var archiveGranularity = ArchiveGranularity.DEFAULT
+
     @get:Synchronized
     var spamFolderSelection = SpecialFolderSelection.AUTOMATIC
 

feature/account/storage/legacy/src/main/kotlin/net/thunderbird/feature/account/storage/legacy/LegacyAccountStorageHandler.kt

@@ -16,6 +16,7 @@ import net.thunderbird.core.preference.storage.StorageEditor
 import net.thunderbird.core.preference.storage.getEnumOrDefault
 import net.thunderbird.feature.account.AccountId
 import net.thunderbird.feature.account.storage.legacy.serializer.ServerSettingsDtoSerializer
+import net.thunderbird.feature.mail.folder.api.ArchiveGranularity
 import net.thunderbird.feature.mail.folder.api.FOLDER_DEFAULT_PATH_DELIMITER
 import net.thunderbird.feature.mail.folder.api.SpecialFolderSelection
 import net.thunderbird.feature.notification.NotificationLight
@@ -115,6 +116,12 @@ class LegacyAccountStorageHandler(
             )
             setArchiveFolderId(archiveFolderId, archiveFolderSelection)
 
+            archiveGranularity = getEnumStringPref(
+                storage,
+                keyGen.create(ARCHIVE_GRANULARITY_KEY),
+                ArchiveGranularity.DEFAULT,
+            )
+
             val spamFolderId = storage.getStringOrNull(keyGen.create("spamFolderId"))?.toLongOrNull()
             val spamFolderSelection = getEnumStringPref<SpecialFolderSelection>(
                 storage,
@@ -358,6 +365,7 @@ class LegacyAccountStorageHandler(
             editor.putString(keyGen.create("archiveFolderId"), archiveFolderId?.toString())
             editor.putString(keyGen.create("spamFolderId"), spamFolderId?.toString())
             editor.putString(keyGen.create("archiveFolderSelection"), archiveFolderSelection.name)
+            editor.putString(keyGen.create(ARCHIVE_GRANULARITY_KEY), archiveGranularity.name)
             editor.putString(keyGen.create("draftsFolderSelection"), draftsFolderSelection.name)
             editor.putString(keyGen.create("sentFolderSelection"), sentFolderSelection.name)
             editor.putString(keyGen.create("spamFolderSelection"), spamFolderSelection.name)
@@ -474,6 +482,7 @@ class LegacyAccountStorageHandler(
         editor.remove(keyGen.create("archiveFolderName"))
         editor.remove(keyGen.create("spamFolderName"))
         editor.remove(keyGen.create("archiveFolderSelection"))
+        editor.remove(keyGen.create(ARCHIVE_GRANULARITY_KEY))
         editor.remove(keyGen.create("draftsFolderSelection"))
         editor.remove(keyGen.create("sentFolderSelection"))
         editor.remove(keyGen.create("spamFolderSelection"))
@@ -613,5 +622,6 @@ class LegacyAccountStorageHandler(
         const val IDENTITY_DESCRIPTION_KEY = "description"
 
         const val FOLDER_PATH_DELIMITER_KEY = "folderPathDelimiter"
+        const val ARCHIVE_GRANULARITY_KEY = "archiveGranularity"
     }
 }

feature/mail/folder/api/src/commonMain/kotlin/net/thunderbird/feature/mail/folder/api/ArchiveGranularity.kt

@@ -0,0 +1,22 @@
+package net.thunderbird.feature.mail.folder.api
+
+enum class ArchiveGranularity {
+    SINGLE_ARCHIVE_FOLDER,
+    PER_YEAR_ARCHIVE_FOLDERS,
+    PER_MONTH_ARCHIVE_FOLDERS,
+    ;
+
+    companion object {
+        /**
+         * Default archive granularity for new accounts.
+         * Matches Thunderbird Desktop default (value 1 = yearly).
+         */
+        val DEFAULT = PER_YEAR_ARCHIVE_FOLDERS
+
+        /**
+         * Default for existing accounts during migration.
+         * Maintains backward compatibility with current single folder behavior.
+         */
+        val MIGRATION_DEFAULT = SINGLE_ARCHIVE_FOLDER
+    }
+}

legacy/core/build.gradle.kts

@@ -44,6 +44,7 @@ dependencies {
     implementation(libs.jsoup)
     implementation(libs.moshi)
     implementation(libs.timber)
+    implementation(libs.kotlinx.datetime)
     implementation(libs.mime4j.core)
     implementation(libs.mime4j.dom)
     implementation(libs.uri)

legacy/core/src/main/java/com/fsck/k9/controller/ArchiveFolderCreator.kt

@@ -0,0 +1,8 @@
+package com.fsck.k9.controller
+
+import com.fsck.k9.backend.api.FolderInfo
+import net.thunderbird.core.android.account.LegacyAccountDto
+
+internal interface ArchiveFolderCreator {
+    fun createFolder(account: LegacyAccountDto, folderInfo: FolderInfo): Long?
+}

legacy/core/src/main/java/com/fsck/k9/controller/ArchiveFolderResolver.kt

@@ -0,0 +1,80 @@
+package com.fsck.k9.controller
+
+import com.fsck.k9.backend.api.FolderInfo
+import com.fsck.k9.mailstore.LocalMessage
+import java.util.Locale
+import kotlin.time.Clock
+import kotlin.time.Instant
+import kotlinx.datetime.LocalDate
+import kotlinx.datetime.TimeZone
+import kotlinx.datetime.toLocalDateTime
+import net.thunderbird.core.android.account.LegacyAccountDto
+import net.thunderbird.feature.mail.folder.api.ArchiveGranularity
+import com.fsck.k9.mail.FolderType as LegacyFolderType
+
+internal class ArchiveFolderResolver(
+    private val folderIdResolver: FolderIdResolver,
+    private val folderCreator: ArchiveFolderCreator,
+) {
+
+    fun resolveArchiveFolder(
+        account: LegacyAccountDto,
+        message: LocalMessage,
+    ): Long? {
+        val baseFolderId = account.archiveFolderId ?: return null
+
+        return when (account.archiveGranularity) {
+            ArchiveGranularity.SINGLE_ARCHIVE_FOLDER -> {
+                baseFolderId
+            }
+
+            ArchiveGranularity.PER_YEAR_ARCHIVE_FOLDERS -> {
+                val year = message.messageDate.year
+                findOrCreateSubfolder(account, baseFolderId, year.toString()) ?: baseFolderId
+            }
+
+            ArchiveGranularity.PER_MONTH_ARCHIVE_FOLDERS -> {
+                val date = message.messageDate
+                val year = date.year
+                val month = String.format(Locale.ROOT, "%02d", date.monthNumber)
+
+                findOrCreateSubfolder(account, baseFolderId, year.toString())?.let { yearFolderId ->
+                    findOrCreateSubfolder(account, yearFolderId, month)
+                } ?: baseFolderId
+            }
+        }
+    }
+
+    private fun findOrCreateSubfolder(
+        account: LegacyAccountDto,
+        parentFolderId: Long,
+        subfolderName: String,
+    ): Long? {
+        val parentServerId = folderIdResolver.getFolderServerId(account, parentFolderId) ?: return null
+
+        val delimiter = account.folderPathDelimiter
+        val subfolderServerId = "$parentServerId$delimiter$subfolderName"
+
+        val existingId = folderIdResolver.getFolderId(account, subfolderServerId)
+        return if (existingId != null) {
+            existingId
+        } else {
+            val folderInfo = FolderInfo(
+                serverId = subfolderServerId,
+                name = subfolderServerId,
+                type = LegacyFolderType.ARCHIVE,
+                folderPathDelimiter = delimiter,
+            )
+            folderCreator.createFolder(account, folderInfo)
+        }
+    }
+
+    private val LocalMessage.messageDate: LocalDate
+        get() {
+            val epochMillis = (internalDate ?: sentDate)?.time
+            val timeZone = TimeZone.currentSystemDefault()
+            val instant = epochMillis?.let { Instant.fromEpochMilliseconds(it) }
+                ?: Clock.System.now()
+            return instant.toLocalDateTime(timeZone).date
+        }
+}

legacy/core/src/main/java/com/fsck/k9/controller/ArchiveOperations.kt

@@ -13,16 +13,17 @@ import net.thunderbird.legacy.logging.Log
 internal class ArchiveOperations(
     private val messagingController: MessagingController,
     private val featureFlagProvider: FeatureFlagProvider,
+    private val archiveFolderResolver: ArchiveFolderResolver,
 ) {
     fun archiveThreads(messages: List<MessageReference>) {
-        archiveByFolder("archiveThreads", messages) { account, folderId, messagesInFolder, archiveFolderId ->
-            archiveThreads(account, folderId, messagesInFolder, archiveFolderId)
+        archiveByFolder("archiveThreads", messages) { account, folderId, messagesInFolder ->
+            archiveThreads(account, folderId, messagesInFolder)
         }
     }
 
     fun archiveMessages(messages: List<MessageReference>) {
-        archiveByFolder("archiveMessages", messages) { account, folderId, messagesInFolder, archiveFolderId ->
-            archiveMessages(account, folderId, messagesInFolder, archiveFolderId)
+        archiveByFolder("archiveMessages", messages) { account, folderId, messagesInFolder ->
+            archiveMessages(account, folderId, messagesInFolder)
         }
     }
 
@@ -37,7 +38,6 @@ internal class ArchiveOperations(
             account: LegacyAccountDto,
             folderId: Long,
             messagesInFolder: List<LocalMessage>,
-            archiveFolderId: Long,
         ) -> Unit,
     ) {
         actOnMessagesGroupedByAccountAndFolder(messages) { account, messageFolder, messagesInFolder ->
@@ -54,7 +54,7 @@ internal class ArchiveOperations(
                 else -> {
                     messagingController.suppressMessages(account, messagesInFolder)
                     messagingController.putBackground(description, null) {
-                        action(account, sourceFolderId, messagesInFolder, archiveFolderId)
+                        action(account, sourceFolderId, messagesInFolder)
                     }
                 }
             }
@@ -65,30 +65,37 @@ internal class ArchiveOperations(
         account: LegacyAccountDto,
         sourceFolderId: Long,
         messages: List<LocalMessage>,
-        archiveFolderId: Long,
     ) {
         val messagesInThreads = messagingController.collectMessagesInThreads(account, messages)
-        archiveMessages(account, sourceFolderId, messagesInThreads, archiveFolderId)
+        archiveMessages(account, sourceFolderId, messagesInThreads)
     }
 
     private fun archiveMessages(
         account: LegacyAccountDto,
         sourceFolderId: Long,
         messages: List<LocalMessage>,
-        archiveFolderId: Long,
     ) {
+        val messagesByDestination = messages.groupBy { message ->
+            archiveFolderResolver.resolveArchiveFolder(account, message)
+        }
+
         val operation = featureFlagProvider.provide(GeneratedFeatureFlagKey.ARCHIVE_MARKS_AS_READ)
             .whenEnabledOrNot(
                 onEnabled = { MoveOrCopyFlavor.MOVE_AND_MARK_AS_READ },
                 onDisabledOrUnavailable = { MoveOrCopyFlavor.MOVE },
             )
-        messagingController.moveOrCopyMessageSynchronous(
-            account,
-            sourceFolderId,
-            messages,
-            archiveFolderId,
-            operation,
-        )
+
+        for ((destinationFolderId, messagesForFolder) in messagesByDestination) {
+            if (destinationFolderId != null) {
+                messagingController.moveOrCopyMessageSynchronous(
+                    account,
+                    sourceFolderId,
+                    messagesForFolder,
+                    destinationFolderId,
+                    operation,
+                )
+            }
+        }
     }
 
     private fun actOnMessagesGroupedByAccountAndFolder(

legacy/core/src/main/java/com/fsck/k9/controller/BackendStorageArchiveFolderCreator.kt

@@ -0,0 +1,26 @@
+package com.fsck.k9.controller
+
+import com.fsck.k9.backend.api.FolderInfo
+import com.fsck.k9.backend.api.createFolder
+import com.fsck.k9.backend.api.updateFolders
+import net.thunderbird.backend.api.BackendStorageFactory
+import net.thunderbird.core.android.account.LegacyAccountDto
+import net.thunderbird.core.logging.Logger
+
+internal class BackendStorageArchiveFolderCreator(
+    private val backendStorageFactory: BackendStorageFactory,
+    private val logger: Logger,
+) : ArchiveFolderCreator {
+    @Suppress("TooGenericExceptionCaught")
+    override fun createFolder(account: LegacyAccountDto, folderInfo: FolderInfo): Long? {
+        return try {
+            val backendStorage = backendStorageFactory.createBackendStorage(account.id)
+            backendStorage.updateFolders {
+                createFolder(folderInfo)
+            }
+        } catch (e: Exception) {
+            logger.error(throwable = e) { "Failed to create archive subfolder: ${folderInfo.serverId}" }
+            null
+        }
+    }
+}

legacy/core/src/main/java/com/fsck/k9/controller/FolderIdResolver.kt

@@ -0,0 +1,8 @@
+package com.fsck.k9.controller
+
+import net.thunderbird.core.android.account.LegacyAccountDto
+
+internal interface FolderIdResolver {
+    fun getFolderServerId(account: LegacyAccountDto, folderId: Long): String?
+    fun getFolderId(account: LegacyAccountDto, folderServerId: String): Long?
+}

legacy/core/src/main/java/com/fsck/k9/controller/KoinModule.kt

@@ -11,6 +11,7 @@ import com.fsck.k9.mailstore.SaveMessageDataCreator
 import com.fsck.k9.mailstore.SpecialLocalFoldersCreator
 import com.fsck.k9.notification.NotificationController
 import com.fsck.k9.notification.NotificationStrategy
+import net.thunderbird.backend.api.BackendStorageFactory
 import net.thunderbird.core.featureflag.FeatureFlagProvider
 import net.thunderbird.core.logging.Logger
 import net.thunderbird.feature.mail.folder.api.OutboxFolderManager
@@ -22,6 +23,7 @@ import org.koin.dsl.binds
 import org.koin.dsl.module
 
 val controllerModule = module {
+    single<FolderIdResolver> { MessageStoreFolderIdResolver(messageStoreManager = get()) }
     single {
         MessagingController(
             get<Context>(),
@@ -40,6 +42,8 @@ val controllerModule = module {
             get<Logger>(named("syncDebug")),
             get<NotificationManager>(),
             get<OutboxFolderManager>(),
+            get<BackendStorageFactory>(),
+            get<FolderIdResolver>(),
         )
     } binds arrayOf(MessagingControllerRegistry::class)
 

legacy/core/src/main/java/com/fsck/k9/controller/MessageStoreFolderIdResolver.kt

@@ -0,0 +1,16 @@
+package com.fsck.k9.controller
+
+import app.k9mail.legacy.mailstore.MessageStoreManager
+import net.thunderbird.core.android.account.LegacyAccountDto
+
+internal class MessageStoreFolderIdResolver(
+    private val messageStoreManager: MessageStoreManager,
+) : FolderIdResolver {
+    override fun getFolderServerId(account: LegacyAccountDto, folderId: Long): String? {
+        return messageStoreManager.getMessageStore(account).getFolderServerId(folderId)
+    }
+
+    override fun getFolderId(account: LegacyAccountDto, folderServerId: String): Long? {
+        return messageStoreManager.getMessageStore(account).getFolderId(folderServerId)
+    }
+}