fix: perform bulk message actions

Signed-off-by: SebastianKrupinski <[email protected]>

lib/Controller/MessagesController.php

@@ -30,11 +30,14 @@
 use OCA\Mail\Service\AccountService;
 use OCA\Mail\Service\AiIntegrations\AiIntegrationsService;
 use OCA\Mail\Service\ItineraryService;
+use OCA\Mail\Service\MessageOperationService;
 use OCA\Mail\Service\SmimeService;
 use OCA\Mail\Service\SnoozeService;
 use OCP\AppFramework\Controller;
 use OCP\AppFramework\Db\DoesNotExistException;
 use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Attribute\FrontpageRoute;
+use OCP\AppFramework\Http\Attribute\NoAdminRequired;
 use OCP\AppFramework\Http\Attribute\OpenAPI;
 use OCP\AppFramework\Http\ContentSecurityPolicy;
 use OCP\AppFramework\Http\JSONResponse;
@@ -94,7 +97,8 @@ public function __construct(string $appName,
 		IDkimService $dkimService,
 		IUserPreferences $preferences,
 		SnoozeService $snoozeService,
-		AiIntegrationsService $aiIntegrationService) {
+		AiIntegrationsService $aiIntegrationService,
+		private MessageOperationService $messageOperationService) {
 		parent::__construct($appName, $request);
 		$this->accountService = $accountService;
 		$this->mailManager = $mailManager;
@@ -782,6 +786,25 @@ public function setFlags(int $id, array $flags): JSONResponse {
 		return new JSONResponse();
 	}
 
+	/**
+	 * 
+	 * @NoAdminRequired
+	 *
+	 * @param array<int,int> $identifiers
+	 * @param array<int,string> $flags
+	 *
+	 * @return JSONResponse
+	 */
+	#[FrontpageRoute(verb: 'PUT', url: '/api/messages/flags')]
+	#[NoAdminRequired]
+	#[TrapError]
+	public function changeFlags(array $identifiers, array $flags): JSONResponse {
+
+		$this->messageOperationService->changeFlags($this->currentUserId, $identifiers, $flags);
+		// TODO: add proper responses
+		return new JSONResponse();
+	}
+
 	/**
 	 * @NoAdminRequired
 	 *

lib/Db/MailAccountMapper.php

@@ -66,6 +66,25 @@ public function findById(int $id): MailAccount {
 		return $this->findEntity($query);
 	}
 
+	/**
+	 * Finds all mail accounts by account ids
+	 *
+	 * @param array<int,int> $identifiers
+	 *
+	 * @return array<int,MailAccount>
+	 */
+	public function findByIds(array $identifiers): array {
+
+		$cmd = $this->db->getQueryBuilder();
+		$cmd->select('*')
+			->from($this->getTableName())
+			->where(
+				$cmd->expr()->in('id', $cmd->createNamedParameter($identifiers, IQueryBuilder::PARAM_STR_ARRAY), IQueryBuilder::PARAM_STR_ARRAY)
+			);
+
+		return $this->findEntities($cmd);
+	}
+
 	/**
 	 * Finds all Mail Accounts by user id existing for this user
 	 *

lib/Db/MessageMapper.php

@@ -178,6 +178,28 @@ public function findUidsForIds(Mailbox $mailbox, array $ids) {
 		}, array_chunk($ids, 1000));
 	}
 
+	/**
+	 * @param array<int,int> $identifiers
+	 *
+	 * @return array
+	 */
+	public function findMailboxAndUid(array $identifiers): array {
+
+		if ($identifiers === []) {
+			return [];
+		}
+
+		$cmd = $this->db->getQueryBuilder();
+		$cmd->select('mailbox_id', 'uid')
+			->from($this->getTableName())
+			->where(
+				$cmd->expr()->in('id', $cmd->createNamedParameter($identifiers, IQueryBuilder::PARAM_STR_ARRAY), IQueryBuilder::PARAM_STR_ARRAY)
+			);
+
+		return $cmd->executeQuery()->fetchAll();
+
+	}
+
 	/**
 	 * @param Account $account
 	 *

lib/IMAP/MessageMapper.php

@@ -435,6 +435,44 @@ public function removeFlag(Horde_Imap_Client_Socket $client,
 		);
 	}
 
+		/**
+	 * @throws Horde_Imap_Client_Exception
+	 */
+	public function setFlags(
+		Horde_Imap_Client_Socket $client,
+		Mailbox $mailbox,
+		array $uids,
+		array $addFlags = [],
+		array $removeFlags = [],
+		array $replaceFlags = []
+	): array {
+
+		if (count($uids) === 0) {
+			return [];
+		}
+
+		$cmd = [];
+
+		if (count($replaceFlags) > 0) {
+			$cmd['replace'] = $replaceFlags;
+		} else {
+			if (count($addFlags) > 0) {
+				$cmd['add'] = $addFlags;
+			}
+			if (count($removeFlags) > 0) {
+				$cmd['remove'] = $removeFlags;
+			}
+		}
+
+		if (count($cmd) > 0) {
+			$cmd['ids'] = new Horde_Imap_Client_Ids($uids);
+			$result = $client->store($mailbox->getName(), $cmd);
+			return $result->ids;
+		}
+
+		return [];
+	}
+
 	/**
 	 * @param Horde_Imap_Client_Socket $client
 	 * @param Mailbox $mailbox

lib/Service/MailManager.php

@@ -57,7 +57,8 @@ class MailManager implements IMailManager {
 		'deleted' => [Horde_Imap_Client::FLAG_DELETED],
 		'draft' => [Horde_Imap_Client::FLAG_DRAFT],
 		'recent' => [Horde_Imap_Client::FLAG_RECENT],
-		'junk' => [Horde_Imap_Client::FLAG_JUNK, 'junk'],
+		'junk' => [Horde_Imap_Client::FLAG_JUNK],
+		'notjunk' => [Horde_Imap_Client::FLAG_NOTJUNK],
 		'mdnsent' => [Horde_Imap_Client::FLAG_MDNSENT],
 	];
 

lib/Service/MessageOperationService.php

@@ -0,0 +1,111 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Mail\Service;
+
+use Horde_Imap_Client_Exception;
+use OCA\Mail\Account;
+use OCA\Mail\Db\MailAccountMapper;
+use OCA\Mail\Db\MailboxMapper;
+use OCA\Mail\Db\MessageMapper;
+use OCA\Mail\IMAP\IMAPClientFactory;
+use OCA\Mail\IMAP\MessageMapper as ImapMessageMapper;
+use OCA\Mail\Service\MailManager;
+
+class MessageOperationService {
+
+    public function __construct(
+        protected IMAPClientFactory $clientFactory,
+        protected MailAccountMapper $accountMapper,
+        protected MailboxMapper $mailboxMapper,
+        protected MessageMapper $messageMapper,
+        protected MailManager $mailManager,
+        protected ImapMessageMapper $imapMessageMapper
+    ) {}
+
+    // group messages by mailbox ['mailbox_id' => [message_id, message_id]]
+    protected function groupByMailbox(array $collection) {
+        return array_reduce($collection, function ($carry, $pair) {
+            if (!isset($carry[$pair['mailbox_id']])) {
+                $carry[$pair['mailbox_id']] = [];
+            }
+            $carry[$pair['mailbox_id']][] = $pair['uid'];
+            return $carry;
+        }, []);
+    }
+
+    // group mailboxes by account ['account_id' => [mailbox object]]
+    protected function groupByAccount(array $collection) {
+        return array_reduce($collection, function ($carry, $entry) {
+            if (!isset($carry[$entry->getAccountId()])) {
+                $carry[$entry->getAccountId()] = [];
+            }
+            $carry[$entry->getAccountId()][] = $entry;
+            return $carry;
+        }, []);
+    }
+
+    /**
+     * @param string $userId system user id
+     * @param array<int,int> $identifiers message ids
+	 * @param array<string,bool> $flags message flags
+     */
+    public function changeFlags(string $userId, array $identifiers, array $flags): void {
+
+        // retrieve meta data [uid, mailbox_id] for all messages
+        $messages = $this->groupByMailbox($this->messageMapper->findMailboxAndUid($identifiers));
+        // retrieve all mailboxes
+        $mailboxes = $this->groupByAccount($this->mailboxMapper->findByIds(array_keys($messages)));
+        // retrieve all accounts
+        $accounts = $this->accountMapper->findByIds(array_keys($mailboxes));
+
+        foreach ($accounts as $account) {
+            $account = new Account($account);
+            // determine if account belongs to the user and skip if not
+            if ($account->getUserId() != $userId) {
+                continue;
+            }
+
+            $client = $this->clientFactory->getClient($account);
+
+            try {
+                foreach ($mailboxes[$account->getId()] as $mailbox) {
+                    $addFlags = [];
+                    $removeFlags = [];
+                    foreach ($flags as $flag => $value) {
+                        $value = filter_var($value, FILTER_VALIDATE_BOOLEAN);
+                        // Only send system flags to the IMAP server as other flags might not be supported
+                        $imapFlags = $this->mailManager->filterFlags($client, $account, $flag, $mailbox->getName());
+                        if (empty($imapFlags)) {
+                            continue;
+                        }
+                        if ($value) {
+                            $addFlags = array_merge($addFlags, $imapFlags);
+                        } else {
+                            $removeFlags = array_merge($removeFlags, $imapFlags);
+                        }
+                    }
+                    $this->imapMessageMapper->setFlags(
+                        $client, 
+                        $mailbox, 
+                        $messages[$mailbox->getId()], 
+                        $addFlags,
+                        $removeFlags
+                    );
+                }
+            } catch (Horde_Imap_Client_Exception $e) {
+                // TODO: Add proper error handling
+            } finally {
+                $client->logout();
+            }
+        }
+
+    }
+
+}

src/components/EnvelopeList.vue

@@ -67,7 +67,7 @@
 						}}
 					</ActionButton>
 					<ActionButton :close-after-click="true"
-						@click.prevent="favoriteOrUnfavoriteAll">
+						@click.prevent="markSelectedFavoriteOrUnfavorite">
 						<template #icon>
 							<IconFavorite :size="16" />
 						</template>
@@ -414,12 +414,11 @@ export default {
 			return this.selection.includes(idx)
 		},
 		markSelectedSeenOrUnseen() {
-			const seen = !this.areAllSelectedRead
-			this.selectedEnvelopes.forEach((envelope) => {
-				this.$store.dispatch('toggleEnvelopeSeen', {
-					envelope,
-					seen,
-				})
+			const state = !this.areAllSelectedRead
+			const envelopes = this.selectedEnvelopes
+			this.$store.dispatch('markEnvelopesSeenOrUnseen', {
+				envelopes,
+				state,
 			})
 			this.unselectAll()
 		},
@@ -442,6 +441,14 @@ export default {
 			this.unselectAll()
 		},
 		async markSelectionJunk() {
+			const state = true
+			const envelopes = this.selectedEnvelopes
+			this.$store.dispatch('markEnvelopesJunkOrNotJunk', {
+				envelopes,
+				state,
+			})
+			this.unselectAll()
+			/*
 			for (const envelope of this.selectedEnvelopes) {
 				if (!envelope.flags.$junk) {
 					await this.$store.dispatch('toggleEnvelopeJunk', {
@@ -451,8 +458,17 @@ export default {
 				}
 			}
 			this.unselectAll()
+			*/
 		},
 		async markSelectionNotJunk() {
+			const state = false
+			const envelopes = this.selectedEnvelopes
+			this.$store.dispatch('markEnvelopesJunkOrNotJunk', {
+				envelopes,
+				state,
+			})
+			this.unselectAll()
+			/*
 			for (const envelope of this.selectedEnvelopes) {
 				if (envelope.flags.$junk) {
 					await this.$store.dispatch('toggleEnvelopeJunk', {
@@ -462,14 +478,14 @@ export default {
 				}
 			}
 			this.unselectAll()
-		},
-		favoriteOrUnfavoriteAll() {
-			const favFlag = !this.areAllSelectedFavorite
-			this.selectedEnvelopes.forEach((envelope) => {
-				this.$store.dispatch('markEnvelopeFavoriteOrUnfavorite', {
-					envelope,
-					favFlag,
-				})
+			*/
+		},
+		markSelectedFavoriteOrUnfavorite() {
+			const state = !this.areAllSelectedFavorite
+			const envelopes = this.selectedEnvelopes
+			this.$store.dispatch('markEnvelopesFavoriteOrUnfavorite', {
+				envelopes,
+				state,
 			})
 			this.unselectAll()
 		},

src/service/MessageService.js

@@ -115,15 +115,14 @@ export async function clearCache(accountId, id) {
 /**
  * Set flags for envelope
  *
- * @param {int} id
+ * @param {array} identifiers
  * @param {object} flags
  */
-export async function setEnvelopeFlags(id, flags) {
-	const url = generateUrl('/apps/mail/api/messages/{id}/flags', {
-		id,
-	})
+export async function setEnvelopeFlags(identifiers, flags) {
+	const url = generateUrl('/apps/mail/api/messages/flags')
 
 	return await axios.put(url, {
+		identifiers,
 		flags,
 	})
 }