issue2550803: Replying to NOSY mail goes to the tracker through

rouilj · rouilj · commit 7b1a8549e12f · 2016-06-26T00:36:23.000-04:00
reply-to, not original message author.

Created new [tracker] replyto_address config.ini option to allow:
  1) setting reply-to header to the tracker
  2) setting reply-to header to the address of the author
     of the change
  3) setting it to a fixed address (like noreply@some.place)

Proposal by Peter Funk (pefu) in discussion with Tom Ekberg
(tekberg).

I chose to re-retrieve the email address for the author from the
database rather than adding a new variable.  Also managed to make
a test case for each of the three settings.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -78,6 +78,15 @@ Features:
   indexer. See ``doc/upgrading.txt`` for details. Initial patch
   done by David Wolever. Patch modified, docs added and committed
   by John Rouillard.
+- issue2550803: Replying to NOSY mail goes to the tracker through
+  reply-to, not original message author.
+  Created new [tracker] replyto_address config.ini option to allow:
+    1) setting reply-to header to the tracker
+    2) setting reply-to header to the address of the author
+       of the change
+    3) setting it to a fixed address (like noreply@some.place)
+  Done by John Rouillard from proposal by Peter Funk (pefu)
+  in discussion with Tom Ekberg (tekberg). See doc/upgrading.txt.
 
 Fixed:
 
diff --git a/doc/upgrading.txt b/doc/upgrading.txt
@@ -65,6 +65,34 @@ setting this value in the [main] section of the tracker's
   # Possible values: xapian, whoosh, native (internal).
   indexer =
 
+New config file option 'replyto_address' added
+----------------------------------------------
+
+A new config file option has been added to let you control the
+Reply-To header on nosy messages.
+
+Edit your tracker's ``config.ini`` and place the following after
+the email entry in the tracker section::
+
+  [tracker]
+  ...
+
+  # Controls the reply-to header address used when sending
+  # nosy messages.
+  # If the value is unset (default) the roundup tracker's
+  # email address (above) is used.
+  # If set to "AUTHOR" then the primary email address of the
+  # author of the change will be used as the reply-to
+  # address. This allows email exchanges to occur outside of
+  # the view of roundup and exposes the address of the person
+  # who updated the issue, but it could be useful in some
+  # unusual circumstances.
+  # If set to some other value, the value is used as the reply-to
+  # address. It must be a valid RFC2822 address or people will not be
+  # able to reply.
+  # Default: 
+  replyto_address = 
+
 html/_generic.404.html in trackers use page template
 ----------------------------------------------------
 
diff --git a/roundup/configuration.py b/roundup/configuration.py
@@ -588,6 +588,20 @@ def str2value(self, value):
         (MailAddressOption, "email", "issue_tracker",
             "Email address that mail to roundup should go to.\n"
             "If no domain is specified then mail_domain is added."),
+        (Option, "replyto_address", "",
+            "Controls the reply-to header address used when sending\n"
+            "nosy messages.\n"
+            "If the value is unset (default) the roundup tracker's\n"
+            "email address (above) is used.\n"
+            "If set to \"AUTHOR\" then the primary email address of the\n"
+            "author of the change will be used as the reply-to\n"
+            "address. This allows email exchanges to occur outside of\n"
+            "the view of roundup and exposes the address of the person\n"
+            "who updated the issue, but it could be useful in some\n"
+            "unusual circumstances.\n"
+            "If set to some other value, the value is used as the reply-to\n"
+            "address. It must be a valid RFC2822 address or people will not be\n"
+            "able to reply."),
         (NullableOption, "language", "",
             "Default locale name for this tracker.\n"
             "If this option is not set, the language is determined\n"
diff --git a/roundup/roundupdb.py b/roundup/roundupdb.py
@@ -532,8 +532,18 @@ def send_message(self, issueid, msgid, note, sendto, from_address=None,
 
             message = mailer.get_standard_message(multipart=message_files)
 
-            # set reply-to to the tracker
-            message['Reply-To'] = tracker_name
+            # set reply-to as requested by config option TRACKER_REPLYTO_ADDRESS
+            replyto_config = self.db.config.TRACKER_REPLYTO_ADDRESS
+            if replyto_config:
+                if replyto_config == "AUTHOR":
+                    # note that authaddr at this point is already surrounded by < >, so
+                    # get the original address from the db as nice_send_header adds < >
+                    replyto_addr = nice_sender_header(authname, users.get(authid, 'address', ''), charset)
+                else:
+                    replyto_addr = replyto_config
+            else:
+                replyto_addr = tracker_name
+            message['Reply-To'] = replyto_addr
 
             # message ids
             if messageid:
diff --git a/test/test_mailgw.py b/test/test_mailgw.py
@@ -1963,6 +1963,142 @@ def testNosyRemove(self):
         # NO NOSY MESSAGE SHOULD BE SENT!
         assert not os.path.exists(SENDMAILDEBUG)
 
+    def testNosyReplytoTracker(self):
+        self.db.config.TRACKER_REPLYTO_ADDRESS = ''
+        self._handle_mail('''Content-Type: text/plain;
+  charset="iso-8859-1"
+From: Chef <chef@bork.bork.bork>
+To: issue_tracker@your.tracker.email.domain.example
+Message-Id: <dummy_test_message_id>
+Subject: [issue] Testing... [nosy=mary; assignedto=richard]
+
+This is a test submission of a new issue.
+''')
+        self.compareMessages(self._get_mail(),
+'''FROM: roundup-admin@your.tracker.email.domain.example
+TO: mary@test.test, richard@test.test
+Content-Type: text/plain; charset="utf-8"
+Subject: [issue1] Testing...
+To: mary@test.test, richard@test.test
+From: "Bork, Chef" <issue_tracker@your.tracker.email.domain.example>
+Reply-To: Roundup issue tracker
+ <issue_tracker@your.tracker.email.domain.example>
+MIME-Version: 1.0
+Message-Id: <dummy_test_message_id>
+X-Roundup-Name: Roundup issue tracker
+X-Roundup-Loop: hello
+X-Roundup-Issue-Status: unread
+Content-Transfer-Encoding: quoted-printable
+
+
+New submission from Bork, Chef <chef@bork.bork.bork>:
+
+This is a test submission of a new issue.
+
+----------
+assignedto: richard
+messages: 1
+nosy: Chef, mary, richard
+status: unread
+title: Testing...
+tx_Source: email
+
+_______________________________________________________________________
+Roundup issue tracker <issue_tracker@your.tracker.email.domain.example>
+<http://tracker.example/cgi-bin/roundup.cgi/bugs/issue1>
+_______________________________________________________________________
+''')
+
+    def testNosyReplytoSomeaddress(self):
+        self.db.config.TRACKER_REPLYTO_ADDRESS = 'replyto@me.example.com'
+        self._handle_mail('''Content-Type: text/plain;
+  charset="iso-8859-1"
+From: Chef <chef@bork.bork.bork>
+To: issue_tracker@your.tracker.email.domain.example
+Message-Id: <dummy_test_message_id>
+Subject: [issue] Testing... [nosy=mary; assignedto=richard]
+
+This is a test submission of a new issue.
+''')
+        self.compareMessages(self._get_mail(),
+'''FROM: roundup-admin@your.tracker.email.domain.example
+TO: mary@test.test, richard@test.test
+Content-Type: text/plain; charset="utf-8"
+Subject: [issue1] Testing...
+To: mary@test.test, richard@test.test
+From: "Bork, Chef" <issue_tracker@your.tracker.email.domain.example>
+Reply-To: replyto@me.example.com
+MIME-Version: 1.0
+Message-Id: <dummy_test_message_id>
+X-Roundup-Name: Roundup issue tracker
+X-Roundup-Loop: hello
+X-Roundup-Issue-Status: unread
+Content-Transfer-Encoding: quoted-printable
+
+
+New submission from Bork, Chef <chef@bork.bork.bork>:
+
+This is a test submission of a new issue.
+
+----------
+assignedto: richard
+messages: 1
+nosy: Chef, mary, richard
+status: unread
+title: Testing...
+tx_Source: email
+
+_______________________________________________________________________
+Roundup issue tracker <issue_tracker@your.tracker.email.domain.example>
+<http://tracker.example/cgi-bin/roundup.cgi/bugs/issue1>
+_______________________________________________________________________
+''')
+
+    def testNosyReplytoAuthor(self):
+        self.db.config.TRACKER_REPLYTO_ADDRESS = 'AUTHOR'
+        self._handle_mail('''Content-Type: text/plain;
+  charset="iso-8859-1"
+From: Chef <chef@bork.bork.bork>
+To: issue_tracker@your.tracker.email.domain.example
+Message-Id: <dummy_test_message_id>
+Subject: [issue] Testing... [nosy=mary; assignedto=richard]
+
+This is a test submission of a new issue.
+''')
+        self.compareMessages(self._get_mail(),
+'''FROM: roundup-admin@your.tracker.email.domain.example
+TO: mary@test.test, richard@test.test
+Content-Type: text/plain; charset="utf-8"
+Subject: [issue1] Testing...
+To: mary@test.test, richard@test.test
+From: "Bork, Chef" <issue_tracker@your.tracker.email.domain.example>
+Reply-To: "Bork, Chef" <chef@bork.bork.bork>
+MIME-Version: 1.0
+Message-Id: <dummy_test_message_id>
+X-Roundup-Name: Roundup issue tracker
+X-Roundup-Loop: hello
+X-Roundup-Issue-Status: unread
+Content-Transfer-Encoding: quoted-printable
+
+
+New submission from Bork, Chef <chef@bork.bork.bork>:
+
+This is a test submission of a new issue.
+
+----------
+assignedto: richard
+messages: 1
+nosy: Chef, mary, richard
+status: unread
+title: Testing...
+tx_Source: email
+
+_______________________________________________________________________
+Roundup issue tracker <issue_tracker@your.tracker.email.domain.example>
+<http://tracker.example/cgi-bin/roundup.cgi/bugs/issue1>
+_______________________________________________________________________
+''')
+
     def testNewUserAuthor(self):
         self.db.commit()
         l = self.db.user.list()
