Fix support for Conversations add-on in Thunderbird 115 and later (#395)

CHANGELOG.md

@@ -12,6 +12,10 @@ All notable changes to this project will be documented in this file.
 - Don't save DKIM results that contain a temporary error.
 - Show proper error message if parsing of a message failed.
 
+### Fixes
+
+- Fixed support for Thunderbird Conversations add-on in Thunderbird 115 and later (#395).
+
 ### Other
 
 - Added Polish translation (by dMbski) (#392).

content/background.mjs.js

@@ -12,14 +12,14 @@
 ///<reference path="../experiments/dkimHeader.d.ts" />
 /* eslint-env webextensions */
 
+import * as Conversations from "../modules/conversation.mjs.js";
 import KeyStore, { KeyDb } from "../modules/dkim/keyStore.mjs.js";
 import SignRules, { initSignRulesProxy } from "../modules/dkim/signRules.mjs.js";
 import { migrateKeyStore, migratePrefs, migrateSignRulesUser } from "../modules/migration.mjs.js";
 import AuthVerifier from "../modules/authVerifier.mjs.js";
 import Logging from "../modules/logging.mjs.js";
 import MsgParser from "../modules/msgParser.mjs.js";
 import prefs from "../modules/preferences.mjs.js";
-import verifyMessageForConversation from "../modules/conversation.mjs.js";
 
 const log = Logging.getLogger("background");
 
@@ -156,7 +156,7 @@ browser.messageDisplay.onMessageDisplayed.addListener(async (tab, message) => {
 	}
 	try {
 		await isInitialized;
-		if (tab.url?.startsWith("chrome://conversations/")) {
+		if (await Conversations.isConversationView(tab)) {
 			// Conversation view is handled in onMessagesDisplayed
 			return;
 		}
@@ -201,9 +201,9 @@ browser.messageDisplay.onMessageDisplayed.addListener(async (tab, message) => {
 browser.messageDisplay.onMessagesDisplayed.addListener(async (tab, messages) => {
 	try {
 		await isInitialized;
-		if (tab.url?.startsWith("chrome://conversations/")) {
+		if (await Conversations.isConversationView(tab)) {
 			for (const message of messages) {
-				await verifyMessageForConversation(message);
+				await Conversations.verifyMessage(message);
 			}
 		}
 		// Normal Thunderbird view ("classic") is handled in onMessageDisplayed

manifest.json

@@ -17,6 +17,7 @@
 		"accountsRead",
 		"downloads",
 		"messagesRead",
+		"management",
 		"notifications",
 		"storage",
 		"tabs"

modules/conversation.mjs.js

@@ -1,5 +1,5 @@
 /**
- * Push the authentication result to the Conversation add-on.
+ * Push the authentication result to the Conversations add-on.
  *
  * Copyright (c) 2021-2023 Philippe Lieser
  *
@@ -35,7 +35,7 @@ const log = Logging.getLogger("Conversation");
 let port = null;
 
 /**
- * Add a pill in Conversation.
+ * Add a pill in Conversations.
  *
  * @param {number} msgId
  * @param {Severity|undefined} severity
@@ -57,7 +57,7 @@ function addPill(msgId, severity, icon, message, tooltip) {
 	if (!port) {
 		port = browser.runtime.connect("[email protected]");
 		port.onDisconnect.addListener((p) => {
-			log.debug("Port to Conversation was disconnected", p.error);
+			log.debug("Port to Conversations was disconnected", p.error);
 			port = null;
 		});
 	}
@@ -67,12 +67,38 @@ function addPill(msgId, severity, icon, message, tooltip) {
 const verifier = new AuthVerifier();
 
 /**
- * Verify a message and display the result in Conversation.
+ * Detect if a Tab shows message in Conversations message view style.
+ *
+ * @param {browser.tabs.Tab} tab
+ * @returns {Promise<boolean>}
+ */
+export async function isConversationView(tab) {
+	if (tab.url?.startsWith("chrome://conversations/")) {
+		// TB < 115
+		return true;
+	}
+	// Messages opened in Thunderbirds main 3pane tab have type "mail",
+	// and are shown in Conversations message view style (if Conversations add-on is installed).
+	// Single messages opened in a tab or windows have type "messageDisplay",
+	// and are always shown in Thunderbird's normal message view style.
+	if (tab.type === "mail") {
+		try {
+			const conversationsInfo = await browser.management.get("[email protected]");
+			return conversationsInfo.enabled;
+		} catch (error) {
+			// Conversations not installed
+		}
+	}
+	return false;
+}
+
+/**
+ * Verify a message and display the result in Conversations.
  *
  * @param {browser.messages.MessageHeader} MessageHeader
  * @returns {Promise<void>}
  */
-export default async function verifyMessage(MessageHeader) {
+export async function verifyMessage(MessageHeader) {
 	const res = await verifier.verify(MessageHeader);
 	if (!res.dkim[0]) {
 		throw new Error("Result does not contain a DKIM result.");