Merge pull request #11889 from nextcloud/fix/noid/create-drafts-folder-on-demand

fix: ensure drafts folder exists

Author: kesselb

lib/Contracts/IMailManager.php

@@ -46,12 +46,13 @@ public function getMailboxes(Account $account, bool $forceSync = false): array;
 	/**
 	 * @param Account $account
 	 * @param string $name
+	 * @param string[] $specialUse
 	 *
 	 * @return Mailbox
 	 *
 	 * @throws ServiceException
 	 */
-	public function createMailbox(Account $account, string $name): Mailbox;
+	public function createMailbox(Account $account, string $name, array $specialUse = []): Mailbox;
 
 	/**
 	 * @param Mailbox $mailbox

lib/IMAP/FolderMapper.php

@@ -71,9 +71,10 @@ public function getFolders(Account $account, Horde_Imap_Client_Socket $client,
 		), $toPersist);
 	}
 
-	public function createFolder(Horde_Imap_Client_Socket $client,
-		string $name): Folder {
-		$client->createMailbox($name);
+	public function createFolder(Horde_Imap_Client_Socket $client, string $name, array $specialUse = []): Folder {
+		$client->createMailbox($name, [
+			'special_use' => $specialUse,
+		]);
 
 		$list = $client->listMailboxes($name, Horde_Imap_Client::MBOX_ALL_SUBSCRIBED, [
 			'delimiter' => true,

lib/Service/MailManager.php

@@ -142,18 +142,11 @@ public function getMailboxes(Account $account, bool $forceSync = false): array {
 		return $this->mailboxMapper->findAll($account);
 	}
 
-	/**
-	 * @param Account $account
-	 * @param string $name
-	 *
-	 * @return Mailbox
-	 * @throws ServiceException
-	 */
 	#[\Override]
-	public function createMailbox(Account $account, string $name): Mailbox {
+	public function createMailbox(Account $account, string $name, array $specialUse = []): Mailbox {
 		$client = $this->imapClientFactory->getClient($account);
 		try {
-			$folder = $this->folderMapper->createFolder($client, $name);
+			$folder = $this->folderMapper->createFolder($client, $name, $specialUse);
 			$this->folderMapper->fetchFolderAcls([$folder], $client);
 		} catch (Horde_Imap_Client_Exception $e) {
 			throw new ServiceException(

lib/Service/MailTransmission.php

@@ -28,6 +28,7 @@
 use OCA\Mail\Account;
 use OCA\Mail\Address;
 use OCA\Mail\AddressList;
+use OCA\Mail\Contracts\IMailManager;
 use OCA\Mail\Contracts\IMailTransmission;
 use OCA\Mail\Db\LocalMessage;
 use OCA\Mail\Db\Mailbox;
@@ -67,6 +68,7 @@ public function __construct(
 		private PerformanceLogger $performanceLogger,
 		private AliasesService $aliasesService,
 		private TransmissionService $transmissionService,
+		private IMailManager $mailManager,
 	) {
 	}
 
@@ -231,12 +233,7 @@ public function saveLocalDraft(Account $account, LocalMessage $message): void {
 			$transport = new Horde_Mail_Transport_Null();
 			$mail->send($transport, false, false);
 			$perfLogger->step('create IMAP draft message');
-			// save the message in the drafts folder
-			$draftsMailboxId = $account->getMailAccount()->getDraftsMailboxId();
-			if ($draftsMailboxId === null) {
-				throw new ClientException('No drafts mailbox configured');
-			}
-			$draftsMailbox = $this->mailboxMapper->findById($draftsMailboxId);
+			$draftsMailbox = $this->findOrCreateDraftsMailbox($account);
 			$this->messageMapper->save(
 				$client,
 				$draftsMailbox,
@@ -258,6 +255,20 @@ public function saveLocalDraft(Account $account, LocalMessage $message): void {
 		$perfLogger->end();
 	}
 
+	private function findOrCreateDraftsMailbox(Account $account): Mailbox {
+		$draftsMailboxId = $account->getMailAccount()->getDraftsMailboxId();
+
+		if ($draftsMailboxId === null) {
+			return $this->mailManager->createMailbox(
+				$account,
+				'Drafts',
+				[Horde_Imap_Client::SPECIALUSE_DRAFTS]
+			);
+		}
+
+		return $this->mailboxMapper->findById($draftsMailboxId);
+	}
+
 	/**
 	 * @param NewMessageData $message
 	 * @param Message|null $previousDraft

tests/Integration/Service/MailTransmissionIntegrationTest.php

@@ -13,6 +13,7 @@
 use OC;
 use OCA\Mail\Account;
 use OCA\Mail\Contracts\IAttachmentService;
+use OCA\Mail\Contracts\IMailManager;
 use OCA\Mail\Contracts\IMailTransmission;
 use OCA\Mail\Db\LocalMessage;
 use OCA\Mail\Db\LocalMessageMapper;
@@ -140,6 +141,7 @@ protected function setUp(): void {
 			Server::get(PerformanceLogger::class),
 			Server::get(AliasesService::class),
 			Server::get(TransmissionService::class),
+			Server::get(IMailManager::class)
 		);
 	}
 

tests/Unit/Service/MailTransmissionTest.php

@@ -62,6 +62,7 @@ protected function setUp(): void {
 		$this->performanceLogger = $this->createMock(PerformanceLogger::class);
 		$this->aliasService = $this->createMock(AliasesService::class);
 		$this->transmissionService = $this->createMock(TransmissionService::class);
+		$this->mailManager = $this->createMock(IMailManager::class);
 
 		$this->transmission = new MailTransmission(
 			$this->imapClientFactory,
@@ -73,6 +74,7 @@ protected function setUp(): void {
 			$this->performanceLogger,
 			$this->aliasService,
 			$this->transmissionService,
+			$this->mailManager,
 		);
 	}
 
@@ -402,4 +404,33 @@ public function testSendLocalDraft(): void {
 
 		$this->transmission->saveLocalDraft(new Account($mailAccount), $localMessage);
 	}
+
+	public function testCreateDraftsMailboxAndSave(): void {
+		$mailAccount = new MailAccount();
+		$mailAccount->setId(10);
+		$mailAccount->setUserId('alice');
+		$mailAccount->setName('Alice');
+		$mailAccount->setEmail('[email protected]');
+		$mailAccount->setDraftsMailboxId(null);
+		$localMessage = new LocalMessage();
+		$localMessage->setType(LocalMessage::TYPE_DRAFT);
+		$localMessage->setAccountId($mailAccount->getId());
+		$localMessage->setAliasId(1);
+		$localMessage->setSendAt(1000);
+		$localMessage->setSubject('Subject');
+		$localMessage->setBodyHtml('<p>Body</p>');
+		$localMessage->setHtml(true);
+		$to = new Recipient();
+		$to->setLabel('Bob');
+		$to->setEmail('[email protected]');
+		$to->setType(Recipient::TYPE_TO);
+		$localMessage->setRecipients([$to]);
+
+		$this->mailManager->expects(self::once())
+			->method('createMailbox');
+		$this->messageMapper->expects(self::once())
+			->method('save');
+
+		$this->transmission->saveLocalDraft(new Account($mailAccount), $localMessage);
+	}
 }