feat: customizable message-id prefix

appinfo/routes.php

@@ -350,6 +350,11 @@
 			'url' => '/api/settings/llm',
 			'verb' => 'PUT'
 		],
+		[
+			'name' => 'settings#setMessageIdPrefix',
+			'url' => '/api/settings/messageidprefix',
+			'verb' => 'POST'
+		],
 		[
 			'name' => 'settings#setImportanceClassificationEnabledByDefault',
 			'url' => '/api/settings/importance-classification-default',

lib/ConfigLexicon.php

@@ -36,6 +36,7 @@ class ConfigLexicon implements ILexicon {
 	public const MICROSOFT_OAUTH_TENANT_ID = 'microsoft_oauth_tenant_id';
 	public const ANTISPAM_REPORTING_SPAM = 'antispam_reporting_spam';
 	public const ANTISPAM_REPORTING_HAM = 'antispam_reporting_ham';
+	public const MESSAGE_ID_PREFIX = 'message_id_prefix';
 
 	#[\Override]
 	public function getStrictness(): Strictness {
@@ -113,6 +114,12 @@ public function getAppConfigs(): array {
 				ValueType::STRING,
 				definition: 'Email address ham (not spam) reports are forwarded to',
 			),
+			new Entry(
+				self::MESSAGE_ID_PREFIX,
+				ValueType::STRING,
+				defaultRaw: 'nextcloud-mail',
+				definition: 'Default message ID prefix to use for outgoing mail',
+			),
 		];
 	}
 

lib/Controller/SettingsController.php

@@ -109,6 +109,12 @@ public function setEnabledLlmProcessing(bool $enabled): JSONResponse {
 		$this->appConfig->setValueBool(Application::APP_ID, ConfigLexicon::LLM_PROCESSING, $enabled);
 		return new JSONResponse([]);
 	}
+
+	public function setMessageIdPrefix(string $prefix): JSONResponse {
+		$this->appConfig->setValueString(Application::APP_ID, ConfigLexicon::MESSAGE_ID_PREFIX, $prefix);
+		return new JSONResponse([]);
+	}
+
 	public function setLayoutMessageView(string $value): JSONResponse {
 		$this->appConfig->setValueString(Application::APP_ID, ConfigLexicon::LAYOUT_MESSAGE_VIEW, $value);
 		return new JSONResponse([]);

lib/Service/MailTransmission.php

@@ -30,6 +30,8 @@
 use OCA\Mail\Account;
 use OCA\Mail\Address;
 use OCA\Mail\AddressList;
+use OCA\Mail\AppInfo\Application;
+use OCA\Mail\ConfigLexicon;
 use OCA\Mail\Contracts\IMailManager;
 use OCA\Mail\Contracts\IMailTransmission;
 use OCA\Mail\Db\LocalMessage;
@@ -50,6 +52,7 @@
 use OCA\Mail\Support\PerformanceLogger;
 use OCP\AppFramework\Db\DoesNotExistException;
 use OCP\EventDispatcher\IEventDispatcher;
+use OCP\IAppConfig;
 use Psr\Log\LoggerInterface;
 use Throwable;
 
@@ -71,6 +74,7 @@ public function __construct(
 		private AliasesService $aliasesService,
 		private TransmissionService $transmissionService,
 		private IMailManager $mailManager,
+		private IAppConfig $appConfig,
 	) {
 	}
 
@@ -114,7 +118,12 @@ public function sendMessage(Account $account, LocalMessage $localMessage): void
 		// approach used by Horde IMP and other clients (Evolution, Thunderbird).
 		$fccHeaders = new Horde_Mime_Headers();
 		$fccHeaders->addHeaderOb(Horde_Mime_Headers_Date::create());
-		$fccHeaders->addHeaderOb(Horde_Mime_Headers_MessageId::create());
+		$prefix = $this->appConfig->getValueString(
+			Application::APP_ID,
+			ConfigLexicon::MESSAGE_ID_PREFIX,
+			'nextcloud-mail',
+		);
+		$fccHeaders->addHeaderOb(Horde_Mime_Headers_MessageId::create($prefix));
 		$fccHeaders->addHeaderOb(new Horde_Mime_Headers_Addresses('From', $from->toHorde()));
 		$fccHeaders->addHeaderOb(new Horde_Mime_Headers_Addresses('To', $to->toHorde()));
 		if (count($cc) > 0) {
@@ -376,7 +385,12 @@ public function saveDraft(NewMessageData $message, ?Message $previousDraft = nul
 	private function buildMimeHeaders(Address $from, AddressList $to, AddressList $cc, AddressList $bcc, ?string $subject): Horde_Mime_Headers {
 		$headers = new Horde_Mime_Headers();
 		$headers->addHeaderOb(Horde_Mime_Headers_Date::create());
-		$headers->addHeaderOb(Horde_Mime_Headers_MessageId::create());
+		$prefix = $this->appConfig->getValueString(
+			Application::APP_ID,
+			ConfigLexicon::MESSAGE_ID_PREFIX,
+			'nextcloud-mail',
+		);
+		$headers->addHeaderOb(Horde_Mime_Headers_MessageId::create($prefix));
 		$headers->addHeaderOb(new Horde_Mime_Headers_Addresses('From', $from->toHorde()));
 		$headers->addHeaderOb(new Horde_Mime_Headers_Addresses('To', $to->toHorde()));
 		if (count($cc) > 0) {

lib/Settings/AdminSettings.php

@@ -108,6 +108,11 @@ public function getForm() {
 			$this->themingDefaults->buildDocLinkToKey('admin-groupware-oauth-microsoft'),
 		);
 
+		$this->initialStateService->provideInitialState(
+			'message_id_prefix',
+			$this->appConfig->getValueString(Application::APP_ID, ConfigLexicon::MESSAGE_ID_PREFIX, 'nextcloud-mail')
+		);
+
 		return new TemplateResponse(Application::APP_ID, 'settings-admin');
 	}
 

src/components/settings/AdminSettings.vue

@@ -277,6 +277,28 @@
 				</p>
 			</article>
 		</div>
+		<div class="app-description">
+			<h3>{{ t('mail', 'Message-ID prefix') }}</h3>
+			<article>
+				<p>
+					{{ t('mail', 'This setting is used to customize the prefix in the RFC 5322 compliant Message-ID header for outgoing mail.') }}
+				</p>
+			</article>
+			<br>
+			<article>
+				<form @submit.prevent="updateMessageIdPrefix">
+					<label for="mail-message-id-prefix"> {{ t('mail', 'Message-ID prefix') }} </label>
+					<input
+						id="mail-message-id-prefix"
+						v-model="messageIdPrefixVal"
+						:disabled="loading"
+						type="text">
+					<button type="submit" :disabled="loading" class="primary">
+						{{ t('mail', 'Update') }}
+					</button>
+				</form>
+			</article>
+		</div>
 	</NcSettingsSection>
 </template>
 
@@ -302,6 +324,7 @@ import {
 	updateAllowNewMailAccounts,
 	updateEnabledSmartReply,
 	updateLlmEnabled,
+	updateMessageIdPrefix,
 	updateProvisioningSettings,
 } from '../../service/SettingsService.js'
 
@@ -330,12 +353,19 @@ export default {
 			type: Array,
 			required: true,
 		},
+
+		messageIdPrefix: {
+			type: String,
+			required: true,
+		},
 	},
 
 	data() {
 		return {
 			addNew: false,
+			loading: false,
 			formKey: Math.random(),
+			messageIdPrefixVal: this.messageIdPrefix,
 			configs: this.provisioningSettings,
 			googleOauthClientId,
 			googleOauthRedirectUrl,
@@ -436,6 +466,10 @@ export default {
 			await updateLlmEnabled(checked)
 		},
 
+		async updateMessageIdPrefix() {
+			await updateMessageIdPrefix(this.messageIdPrefixVal)
+		},
+
 		async updateEnabledSmartReply(checked) {
 			await updateEnabledSmartReply(checked)
 		},

src/main-settings.js

@@ -22,5 +22,6 @@ const View = Vue.extend(AdminSettings)
 new View({
 	propsData: {
 		provisioningSettings: loadState('mail', 'provisioning_settings') || [],
+		messageIdPrefix: loadState('mail', 'message_id_prefix') || 'nextcloud-mail',
 	},
 }).$mount('#mail-admin-settings')

src/service/SettingsService.js

@@ -70,6 +70,15 @@ export async function updateLlmEnabled(enabled) {
 	return resp.data
 }
 
+export async function updateMessageIdPrefix(prefix) {
+	const url = generateUrl('/apps/mail/api/settings/messageidprefix')
+	const data = {
+		prefix,
+	}
+	const resp = await axios.post(url, data)
+	return resp.data
+}
+
 export async function updateEnabledSmartReply(enabled) {
 	const url = generateUrl('/apps/mail/api/settings/smartreply')
 	const data = {

tests/Unit/ConfigLexiconTest.php

@@ -51,6 +51,7 @@ public function appConfigProvider(): array {
 			ConfigLexicon::MICROSOFT_OAUTH_TENANT_ID => [ValueType::STRING, 'common'],
 			ConfigLexicon::ANTISPAM_REPORTING_SPAM => [ValueType::STRING, null],
 			ConfigLexicon::ANTISPAM_REPORTING_HAM => [ValueType::STRING, null],
+			ConfigLexicon::MESSAGE_ID_PREFIX => [ValueType::STRING, 'nextcloud-mail'],
 		];
 	}
 

tests/Unit/Service/MailTransmissionTest.php

@@ -36,6 +36,7 @@
 use OCA\Mail\Support\PerformanceLogger;
 use OCP\AppFramework\Db\DoesNotExistException;
 use OCP\EventDispatcher\IEventDispatcher;
+use OCP\IAppConfig;
 use PHPUnit\Framework\MockObject\MockObject;
 use Psr\Log\LoggerInterface;
 
@@ -51,6 +52,7 @@ class MailTransmissionTest extends TestCase {
 	private MailTransmission $transmission;
 	private AliasesService|MockObject $aliasService;
 	private TransmissionService $transmissionService;
+	private IAppConfig $appConfig;
 
 	protected function setUp(): void {
 		parent::setUp();
@@ -65,6 +67,7 @@ protected function setUp(): void {
 		$this->aliasService = $this->createMock(AliasesService::class);
 		$this->transmissionService = $this->createMock(TransmissionService::class);
 		$this->mailManager = $this->createMock(IMailManager::class);
+		$this->appConfig = $this->createMock(IAppConfig::class);
 
 		$this->transmission = new MailTransmission(
 			$this->imapClientFactory,
@@ -77,6 +80,7 @@ protected function setUp(): void {
 			$this->aliasService,
 			$this->transmissionService,
 			$this->mailManager,
+			$this->appConfig,
 		);
 	}
 

tests/Unit/Settings/AdminSettingsTest.php

@@ -37,7 +37,7 @@ public function testGetSection() {
 	}
 
 	public function testGetForm() {
-		$this->serviceMock->getParameter('initialStateService')->expects($this->exactly(14))
+		$this->serviceMock->getParameter('initialStateService')->expects($this->exactly(15))
 			->method('provideInitialState')
 			->withConsecutive(
 				[
@@ -96,6 +96,10 @@ public function testGetForm() {
 					'microsoft_oauth_docs',
 					$this->anything()
 				],
+				[
+					'message_id_prefix',
+					$this->anything()
+				],
 			);
 		$expected = new TemplateResponse(Application::APP_ID, 'settings-admin');