Merge pull request #9 from loadsmart/reply

Reply a message

Author: luizguilhermefr

README.md

@@ -104,6 +104,20 @@ message = client.send(
 print(message) # Gmail message: ABC123
 ```
 
+- Reply message
+
+```python
+message_id = "..."
+message = client.get_message(message_id)
+
+reply = '''
+I am out for vacation, will return <strong>Jan 14</strong>.
+
+If it is really important, you can call me, but think twice.
+'''
+response = message.reply(reply)
+```
+
 - Handle exceptions
 
 Exceptions are part of every developer day-to-day. You may want to handle exceptions as follows:

gmail_wrapper/client.py

@@ -131,29 +131,71 @@ def get_attachment_body(self, id, message_id):
 
         return AttachmentBody(raw_attachment_body)
 
-    def _make_sendable_message(self, subject, html_content, to, cc, bcc):
+    def _make_sendable_message(
+        self,
+        subject,
+        html_content,
+        to,
+        cc,
+        bcc,
+        references,
+        in_reply_to,
+        thread_id=None,
+    ):
         message = MIMEText(html_content, "html")
         message["subject"] = subject
         message["from"] = self.email
         message["to"] = to
         message["cc"] = ",".join(cc)
         message["bcc"] = ",".join(bcc)
+        message["references"] = " ".join(references)
+        message["in-reply-to"] = " ".join(in_reply_to)
         return {
             "raw": base64.urlsafe_b64encode(bytes(message.as_string(), "utf-8")).decode(
                 "utf-8"
-            )
+            ),
+            "threadId": thread_id,
         }
 
-    def send_raw(self, subject, html_content, to, cc=None, bcc=None):
+    def send_raw(
+        self,
+        subject,
+        html_content,
+        to,
+        cc=None,
+        bcc=None,
+        references=None,
+        in_reply_to=None,
+        thread_id=None,
+    ):
         sendable = self._make_sendable_message(
-            subject, html_content, to, cc if cc else [], bcc if bcc else []
+            subject,
+            html_content,
+            to,
+            cc if cc else [],
+            bcc if bcc else [],
+            references if references else [],
+            in_reply_to if in_reply_to else [],
+            thread_id,
         )
 
         return self._execute(
             self._messages_resource().send(userId=self.email, body=sendable)
         )
 
-    def send(self, subject, html_content, to, cc=None, bcc=None):
-        raw_sent_message = self.send_raw(subject, html_content, to, cc, bcc)
+    def send(
+        self,
+        subject,
+        html_content,
+        to,
+        cc=None,
+        bcc=None,
+        references=None,
+        in_reply_to=None,
+        thread_id=None,
+    ):
+        raw_sent_message = self.send_raw(
+            subject, html_content, to, cc, bcc, references, in_reply_to, thread_id
+        )
 
         return Message(self, raw_sent_message)

gmail_wrapper/entities.py

@@ -81,6 +81,25 @@ def id(self):
     def subject(self):
         return self.headers.get("Subject")
 
+    @property
+    def from_address(self):
+        return self.headers.get("From")
+
+    @property
+    def message_id(self):
+        """
+        While self.id is the user-bound id of the message, self.message_id
+        is the global id of the message, valid for every user on the thread.
+        """
+        return self.headers.get("Message-ID")
+
+    @property
+    def thread_id(self):
+        if "threadId" not in self._raw:
+            self._raw = self._client.get_raw_message(self.id)
+
+        return self._raw.get("threadId")
+
     @property
     def date(self):
         ms_in_seconds = 1000
@@ -101,5 +120,15 @@ def modify(self, add_labels=None, remove_labels=None):
             self.id, add_labels=add_labels, remove_labels=remove_labels
         )
 
+    def reply(self, html_content):
+        return self._client.send(
+            subject=f"Re:{self.subject}",
+            html_content=html_content,
+            to=self.from_address,
+            references=[self.message_id],
+            in_reply_to=[self.message_id],
+            thread_id=self.thread_id,
+        )
+
     def __str__(self):
         return "Gmail message: {}".format(self.id)

tests/conftest.py

@@ -47,6 +47,7 @@ def raw_complete_message():
                 {"name": "To", "value": "[email protected]"},
                 {"name": "From", "value": "[email protected]"},
                 {"name": "Subject", "value": "Urgent errand"},
+                {"name": "Message-ID", "value": "<BY5PR15MB353717D866FC27FEE4DB4EC7F77E0@BY5PR15MB3537.namprd15.prod.outlook.com>"},
             ],
             "parts": [
                 {

tests/test_client.py

@@ -234,7 +234,11 @@ def test_it_creates_a_proper_sendable_message(self, client):
         to = "[email protected]"
         cc = ["[email protected]", "[email protected]"]
         bcc = []
-        sendable = client._make_sendable_message(subject, content, to, cc, bcc)
+        references = []
+        in_reply_to = []
+        sendable = client._make_sendable_message(
+            subject, content, to, cc, bcc, references, in_reply_to
+        )
         decoded = base64.urlsafe_b64decode(sendable["raw"]).decode("utf-8")
         assert decoded.startswith("Content-Type: text/html;")
         assert f"subject: {subject}\n" in decoded
@@ -257,8 +261,9 @@ def test_it_send_and_return_a_raw_message(self, mocker, raw_complete_message):
             userId="[email protected]",
             body={
                 "raw": base64.urlsafe_b64encode(
-                    b'Content-Type: text/html; charset="us-ascii"\nMIME-Version: 1.0\nContent-Transfer-Encoding: 7bit\nsubject: Hi there!\nfrom: [email protected]\nto: [email protected]\ncc: \nbcc: \n\n<html><p>Hey</p></html>'
-                ).decode("utf-8")
+                    b'Content-Type: text/html; charset="us-ascii"\nMIME-Version: 1.0\nContent-Transfer-Encoding: 7bit\nsubject: Hi there!\nfrom: [email protected]\nto: [email protected]\ncc: \nbcc: \nreferences: \nin-reply-to: \n\n<html><p>Hey</p></html>'
+                ).decode("utf-8"),
+                "threadId": None,
             },
         )
 
@@ -275,7 +280,43 @@ def test_it_returns_the_sent_message(self, client, mocker, raw_complete_message)
             to="[email protected]",
         )
         mocked_send_raw_message.assert_called_once_with(
-            "Hi there!", "<html><p>Hey</p></html>", "[email protected]", None, None
+            "Hi there!",
+            "<html><p>Hey</p></html>",
+            "[email protected]",
+            None,
+            None,
+            None,
+            None,
+            None,
         )
         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

@@ -25,6 +25,7 @@ def test_it_fetch_additional_information_when_needed(
             return_value=raw_complete_message,
         )
         incomplete_message = Message(client, raw_incomplete_message)
+        assert incomplete_message.thread_id == raw_complete_message["threadId"]
         assert (
             incomplete_message.subject
             == raw_complete_message["payload"]["headers"][2]["value"]