Merge pull request #14 from loadsmart/useReplyTo

Add support to replying messages using reply-to header

Author: luizguilhermefr

gmail_wrapper/entities.py

@@ -85,6 +85,10 @@ def subject(self):
     def from_address(self):
         return self.headers.get("From")
 
+    @property
+    def reply_to(self):
+        return self.headers.get("Reply-To")
+
     @property
     def message_id(self):
         """
@@ -130,11 +134,13 @@ def modify(self, add_labels=None, remove_labels=None):
             self.id, add_labels=add_labels, remove_labels=remove_labels
         )
 
-    def reply(self, html_content):
+    def reply(self, html_content, use_reply_to=True):
+        to = self.reply_to if (self.reply_to and use_reply_to) else self.from_address
+
         return self._client.send(
             subject=f"Re:{self.subject}",
             html_content=html_content,
-            to=self.from_address,
+            to=to,
             references=[self.message_id],
             in_reply_to=[self.message_id],
             thread_id=self.thread_id,

tests/test_client.py

@@ -291,32 +291,3 @@ def test_it_returns_the_sent_message(self, client, mocker, raw_complete_message)
         )
         assert isinstance(sent_message, Message)
         assert sent_message.id == raw_complete_message["id"]
-
-
-class TestReply:
-    def test_it_returns_the_sent_message(self, client, mocker, raw_complete_message):
-        message_to_reply = Message(client, raw_complete_message)
-        expected_message_to_be_sent = {"id": "114ADC", "internalDate": "1566398665"}
-        mocked_send_raw_message = mocker.patch(
-            "gmail_wrapper.client.GmailClient.send_raw",
-            return_value=expected_message_to_be_sent,
-        )
-        sent_message = message_to_reply.reply(
-            "The quick brown fox jumps over the lazy dog"
-        )
-        mocked_send_raw_message.assert_called_once_with(
-            "Re:Urgent errand",
-            "The quick brown fox jumps over the lazy dog",
-            "[email protected]",
-            None,
-            None,
-            [
-                "<BY5PR15MB353717D866FC27FEE4DB4EC7F77E0@BY5PR15MB3537.namprd15.prod.outlook.com>"
-            ],
-            [
-                "<BY5PR15MB353717D866FC27FEE4DB4EC7F77E0@BY5PR15MB3537.namprd15.prod.outlook.com>"
-            ],
-            "AA121212",
-        )
-        assert isinstance(sent_message, Message)
-        assert sent_message.id == expected_message_to_be_sent["id"]

tests/test_entities.py

@@ -117,6 +117,14 @@ def test_it_archives_a_message(self, mocker, client, raw_complete_message):
             raw_complete_message["id"], add_labels=None, remove_labels=["INBOX"]
         )
 
+    def test_reply_to_property(self, client, raw_complete_message):
+        message = Message(client, raw_complete_message)
+        assert message.reply_to is None
+        raw_complete_message["payload"]["headers"].append(
+            {"name": "Reply-To", "value": "[email protected]"}
+        )
+        assert message.reply_to == "[email protected]"
+
     def test_message_id_property(self, client, raw_complete_message):
         message = Message(client, raw_complete_message)
         assert (
@@ -131,6 +139,46 @@ def test_message_id_property(self, client, raw_complete_message):
         raw_complete_message["payload"]["headers"][3]["name"] = "Invalid"
         assert message.message_id is None
 
+    def test_reply(self, client, mocker, raw_complete_message):
+        message = Message(client, raw_complete_message)
+        expected_message_to_be_sent = {"id": "114ADC", "internalDate": "1566398665"}
+        mocked_send_raw_message = mocker.patch(
+            "gmail_wrapper.client.GmailClient.send_raw",
+            return_value=expected_message_to_be_sent,
+        )
+        sent_message = message.reply("The quick brown fox jumps over the lazy dog")
+        mocked_send_raw_message.assert_called_once_with(
+            "Re:Urgent errand",
+            "The quick brown fox jumps over the lazy dog",
+            "[email protected]",
+            None,
+            None,
+            [
+                "<BY5PR15MB353717D866FC27FEE4DB4EC7F77E0@BY5PR15MB3537.namprd15.prod.outlook.com>"
+            ],
+            [
+                "<BY5PR15MB353717D866FC27FEE4DB4EC7F77E0@BY5PR15MB3537.namprd15.prod.outlook.com>"
+            ],
+            "AA121212",
+        )
+        assert isinstance(sent_message, Message)
+        assert sent_message.id == expected_message_to_be_sent["id"]
+
+    def test_reply_uses_reply_to_if_set(self, client, raw_complete_message, mocker):
+        message = Message(client, raw_complete_message)
+        mocked_send_raw_message = mocker.patch(
+            "gmail_wrapper.client.GmailClient.send_raw"
+        )
+        message.reply("Any content")
+        assert mocked_send_raw_message.call_args[0][2] == "[email protected]"
+        raw_complete_message["payload"]["headers"].append(
+            {"name": "Reply-To", "value": "[email protected]"}
+        )
+        message.reply("Any content, again")
+        assert mocked_send_raw_message.call_args[0][2] == "[email protected]"
+        message.reply("Any content, again and again", use_reply_to=False)
+        assert mocked_send_raw_message.call_args[0][2] == "[email protected]"
+
 
 class TestAttachment:
     def test_it_has_basic_properties_without_additional_fetch(