Update documentation

dennisverspuij · Dec 4, 2024 · 07b65f3 · 07b65f3
1 parent 28bdf08
commit 07b65f3
Show file tree

Hide file tree

Showing 14 changed files with 292 additions and 288 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-Thunderbird Add-on "Correct Identity" (v2.4.x)
+Thunderbird Add-on "Correct Identity" (v2.5.x)
 ==============================================
 
 This add-on version works with Thunderbird versions >= 102.0
@@ -44,9 +44,13 @@ Features
     * based on the original recipients of the replied-to message
     * **NEW in 2.4.x:** based on addressbook entries
     * based on non-standard SMTP header fields of the replied-to message (**new feature**: "Advanced: Additional mail headers")
+    * **NEW in 2.5.x:** use any matched address as "from" to support "catch-all" mail server configurations
 * Automatically change the "from" identity when addressing specific recipients
 * Warn if specific recipients are included in a email send from a specific identity
 
+### **NEW in 2.5.x:** Use matching address as "from"
+In mail servers with "catch-all" configuration, all mails with any destination email address received by that server are forwarded to a single mailbox. E.g. \*@invalid.test with "\*" being any email address. Correct identity addon allow to use that address as "from" when replying such an email. E.g. use "invalid.test" as detection search pattern and choose "use the found ... as from" option.
+
 ### **NEW in 2.4.x:** Addressbook Match
 Instead of using individual match entries, also a complete addressbook can be checked for a match.
 As an example you can add the following line to the text field:
@@ -119,6 +123,17 @@ Note that you have to generate a .xpi file *with the same name* whenever you cha
 In Menu /Extras/ → /Development Tools/ you'll also find a dev console and more debugging tools.
 
 
+Flowchart
+---------
+
+The configuration options are sometimes confusing. A more formal description of the detection mechanism can be found in the flowchart below. First identify the configuration options in the config page.
+
+![Configuration window](images/flow-configs.png)
+... and the influence on the email processing:
+![Configuration window](images/flow-flow.png)
+
+
+
 Acknowledgment
 --------------
 

diff --git a/_locales/de-DE/messages.json b/_locales/de-DE/messages.json
@@ -71,10 +71,10 @@
     "message": "versuchen, die Identität zu suchen und zu benutzen, die in der Empfängerliste erscheint"
   },
   "CorrectIdentity.keepRecipientAddress": {
-    "message": "keep the sender address that appears in its recipient list, even if it does not match the identity (e.g., for catch-all adresses)"
+    "message": "verwende eine erkannte (und ggf. abweichende) Mailadresse als \"von\" zusammen mit dieser Identität (z.B. für Mailserver mit \"catch-all\" Konfiguration)"
   },
   "CorrectIdentity.removeSenderFromRecipients": {
-    "message": "remove the identity from the recipient list"
+    "message": "entferne die Identität aus der Empfängerliste (Wenn sie als Absender benutzt wird)"
   },
   "CorrectIdentity.safetyCaption": {
     "message": "Sicherheit"

diff --git a/_locales/en-US/messages.json b/_locales/en-US/messages.json
@@ -72,10 +72,10 @@
     "message": "attempt to find and use an identity that appears in its recipient list"
   },
   "CorrectIdentity.keepRecipientAddress": {
-    "message": "keep the sender address that appears in its recipient list, even if it does not match the identity (e.g., for catch-all adresses)"
+    "message": "use the found matching address from the recipient list as \"from\", even if it does not match this identity (e.g. for mail servers with catch-all addresses)"
   },
   "CorrectIdentity.removeSenderFromRecipients": {
-    "message": "remove the identity from the recipient list"
+    "message": "remove this identity from the recipient list (while used as \"from\" identity)"
   },
   "CorrectIdentity.safetyCaption": {
     "message": "Safety"

diff --git a/_locales/fr-FR/messages.json b/_locales/fr-FR/messages.json
@@ -48,10 +48,10 @@
     "message": "tenter de trouver et d’utiliser une identité qui apparaîtrait dans la liste des destinataires du message."
   },
   "CorrectIdentity.keepRecipientAddress": {
-    "message": "keep the sender address that appears in its recipient list, even if it does not match the identity (e.g., for catch-all adresses)"
+    "message": "utiliser comme adresse d'expéditeur l'adresse trouvé dans la liste de destinataires, même si elle ne correspond pas à l'identité (par exemple dans le cas d'un compte de messagerie catch-all)"
   },
   "CorrectIdentity.removeSenderFromRecipients": {
-    "message": "remove the identity from the recipient list"
+    "message": "supprimer cette identité de la liste des destinataires (alors qu'elle est utilisée comme expéditeur)"
   },
   "CorrectIdentity.safetyCaption": {
     "message": "Sécurité"

diff --git a/_locales/ja/messages.json b/_locales/ja/messages.json
@@ -48,10 +48,10 @@
     "message": "返信元のメッセージからアイデンティティの同一性を検出して適用する"
   },
   "CorrectIdentity.keepRecipientAddress": {
-    "message": "keep the sender address that appears in its recipient list, even if it does not match the identity (e.g., for catch-all adresses)"
+    "message": "受信者リストで一致したアドレスは、たとえそのアドレスがこのアイデンティティに一致しなくても（例えば、キャッチオール・アドレスを持つメールサーバーの場合）、「送信者」アドレスとして使われる"
   },
   "CorrectIdentity.removeSenderFromRecipients": {
-    "message": "remove the identity from the recipient list"
+    "message": "このアイデンティティを受信者リストから削除する（送信者として使用する"
   },
   "CorrectIdentity.safetyCaption": {
     "message": "安全"

diff --git a/_locales/nl-NL/messages.json b/_locales/nl-NL/messages.json
@@ -48,10 +48,10 @@
     "message": "detecteer en gebruik de identiteit die voorkomt in de ontvangerslijst"
   },
   "CorrectIdentity.keepRecipientAddress": {
-    "message": "keep the sender address that appears in its recipient list, even if it does not match the identity (e.g., for catch-all adresses)"
+    "message": "een erkend (en mogelijk ander) mailadres gebruiken als \"van\" samen met deze identiteit (bijv. voor mailservers met een “catch-all” configuratie)"
   },
   "CorrectIdentity.removeSenderFromRecipients": {
-    "message": "remove the identity from the recipient list"
+    "message": "identiteit verwijderen uit de ontvangerslijst (bij gebruik als afzender)"
   },
   "CorrectIdentity.safetyCaption": {
     "message": "Veiligheid"

diff --git a/flow-configs.png b/flow-configs.png
diff --git a/flow.drawio b/flow.drawio
diff --git a/icons/ci.svg b/icons/ci.svg
diff --git a/images/flow-configs.png b/images/flow-configs.png
diff --git a/flow-flow.png → images/flow-flow.png b/flow-flow.png → images/flow-flow.png
diff --git a/images/flow.drawio b/images/flow.drawio
diff --git a/images/settings.png b/images/settings.png
diff --git a/options.html b/options.html
@@ -109,6 +109,7 @@
 				id="keepRecipientAddress" name="keepRecipientAddress"
 				value="keepRecipientAddress"> <label for="keepRecipientAddress" id="keepRecipientAddressLabel">__MSG_CorrectIdentity.keepRecipientAddress__</label><br>
 		</div>
+		<br>
 		<label for="detectionAliases">__MSG_CorrectIdentity.aliasesDescription__</label>
 		<div class="tooltip">
 			<textarea id="detectionAliases" name="detectionAliases" rows="4"></textarea>