[Rt-commit] rt branch 4.4/clarify-emailsubjecttagregex-doc created. rt-4.4.6-62-gd7628dc10b

[BPS Git Server]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "rt".

The branch, 4.4/clarify-emailsubjecttagregex-doc has been created
        at  d7628dc10bcc8c9b46fb2ef6d116199e26a103b0 (commit)

- Log -----------------------------------------------------------------
commit d7628dc10bcc8c9b46fb2ef6d116199e26a103b0
Author: Jim Brandt <jbrandt at bestpractical.com>
Date:   Thu Apr 13 10:11:59 2023 -0400

    Clarify usage of the $EmailSubjectTagRegex setting

diff --git a/etc/RT_Config.pm.in b/etc/RT_Config.pm.in
index 96cfaa6419..5626df14b3 100644
--- a/etc/RT_Config.pm.in
+++ b/etc/RT_Config.pm.in
@@ -336,20 +336,29 @@ Set(@LogToSyslogConf, ());
 
 =item C<$EmailSubjectTagRegex>
 
-This regexp controls what subject tags RT recognizes as its own.  If
-you're not dealing with historical C<$rtname> values, or historical
-queue-specific subject tags, you'll likely never have to change this
-configuration.
+This setting allows you to customize the way RT evaluates email
+subject tags. RT uses subject tags to determine if an email should
+update a ticket in this RT instance.
 
-Be B<very careful> with it. Note that it overrides C<$rtname> for
-subject token matching.
+C<$EmailSubjectTagRegex> is most useful if you change your C<$rtname> setting,
+or change a queue-specific subject tag. In those cases, you can set
+this option to still match the old values, allowing replies to old email
+to still be recognized by this RT and get correctly routed to
+existing tickets.
 
-The setting below would make RT behave exactly as it does without the
-setting enabled.
+Note that it overrides the current C<$rtname> setting for subject
+token matching, so if you need to match and old value and also the
+new value, include C<$rtname> in your regex.
 
-=cut
+As an example, the setting below would make RT behave exactly as it
+does without the setting enabled.
+
+    Set($EmailSubjectTagRegex, qr/\Q$rtname\E/i );
+
+This would match email replies for an old queue-level subject tag
+called "Old Tag" that was changed:
 
-# Set($EmailSubjectTagRegex, qr/\Q$rtname\E/i );
+    Set($EmailSubjectTagRegex, qr/\Q$rtname\E|Old Tag/i);
 
 =item C<$OwnerEmail>
 

-----------------------------------------------------------------------


hooks/post-receive
-- 
rt