Add support for ReplyTo addresses in emails (#6)

Author: marcoacierno

pythonit_toolkit/emails/backends/base.py

@@ -1,5 +1,5 @@
 from abc import ABC, abstractmethod
-from typing import Optional
+from typing import Dict, List, Optional
 
 from pythonit_toolkit.emails.templates import EmailTemplate
 
@@ -16,6 +16,7 @@ def send_email(
         subject: str,
         from_: str,
         to: str,
-        variables: Optional[dict[str, str]] = None
+        variables: Optional[Dict[str, str]] = None,
+        reply_to: List[str] = None
     ):
         pass

pythonit_toolkit/emails/backends/local.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import Dict, List, Optional
 
 from pythonit_toolkit.emails.templates import EmailTemplate
 
@@ -16,12 +16,16 @@ def send_email(
         subject: str,
         from_: str,
         to: str,
-        variables: Optional[dict[str, str]] = None,
+        variables: Optional[Dict[str, str]] = None,
+        reply_to: List[str] = None,
     ):
+        reply_to = reply_to or []
+
         print("=== Email sending ===")
         print(f"Template: {template}")
         print(f"From: {from_}")
         print(f"To: {to}")
         print(f"Subject: {subject}")
         print(f"Variables: {str(variables)}")
+        print(f"Reply to: {str(reply_to)}")
         print("=== End Email sending ===")

pythonit_toolkit/emails/backends/ses.py

@@ -1,5 +1,5 @@
 import json
-from typing import Optional
+from typing import Dict, List, Optional
 import html
 import boto3
 from pythonit_toolkit.emails.templates import EmailTemplate
@@ -19,14 +19,18 @@ def send_email(
         subject: str,
         from_: str,
         to: str,
-        variables: Optional[dict[str, str]] = None,
+        variables: Optional[Dict[str, str]] = None,
+        reply_to: List[str] = None,
     ):
+        reply_to = reply_to or []
+
         variables = self.encode_vars({"subject": subject, **(variables or {})})
         self.ses.send_templated_email(
             Source=from_,
             Destination={"ToAddresses": [to]},
             Template=f"pythonit-{self.environment}-{template}",
             TemplateData=json.dumps(variables),
+            ReplyToAddresses=reply_to,
         )
 
     def encode_vars(self, variables: dict[str, str]) -> dict[str, str]:

tests/emails/backends/test_local.py

@@ -14,13 +14,15 @@ async def _():
             to="hello@world.it",
             subject="Hello World!",
             variables={"a": "b", "c": "d"},
+            reply_to=["test@placeholder.com"],
         )
 
-    assert mock_logger.call_count == 7
+    assert mock_logger.call_count == 8
     mock_logger.assert_any_call("=== Email sending ===")
     mock_logger.assert_any_call(f"Template: {str(EmailTemplate.RESET_PASSWORD)}")
     mock_logger.assert_any_call("From: from@from.it")
     mock_logger.assert_any_call("To: hello@world.it")
     mock_logger.assert_any_call("Subject: Hello World!")
     mock_logger.assert_any_call("Variables: {'a': 'b', 'c': 'd'}")
+    mock_logger.assert_any_call("Reply to: ['test@placeholder.com']")
     mock_logger.assert_any_call("=== End Email sending ===")

tests/emails/backends/test_ses.py

@@ -21,6 +21,7 @@ async def _():
         Destination={"ToAddresses": ["destination@email.it"]},
         Template="pythonit-production-reset-password",
         TemplateData='{"subject": "Subject", "a": "b", "c": "d"}',
+        ReplyToAddresses=[],
     )
 
 
@@ -39,6 +40,33 @@ async def _():
         Destination={"ToAddresses": ["destination@email.it"]},
         Template="pythonit-production-reset-password",
         TemplateData='{"subject": "Subject"}',
+        ReplyToAddresses=[],
+    )
+
+
+@test("send email with reply to")
+async def _():
+    with patch("pythonit_toolkit.emails.backends.ses.boto3") as mock_boto:
+        SESEmailBackend("production").send_email(
+            template=EmailTemplate.RESET_PASSWORD,
+            subject="Subject",
+            from_="test@email.it",
+            to="destination@email.it",
+            reply_to=[
+                "test1@placeholder.com",
+                "test2@placeholder.com",
+            ]
+        )
+
+    mock_boto.client.return_value.send_templated_email.assert_called_once_with(
+        Source="test@email.it",
+        Destination={"ToAddresses": ["destination@email.it"]},
+        Template="pythonit-production-reset-password",
+        TemplateData='{"subject": "Subject"}',
+        ReplyToAddresses=[
+            "test1@placeholder.com",
+            "test2@placeholder.com",
+        ],
     )
 
 
@@ -60,4 +88,5 @@ async def _():
         Destination={"ToAddresses": ["destination@email.it"]},
         Template="pythonit-production-reset-password",
         TemplateData='{"subject": "Subject", "a": "<a href="https://google.it">link</a>"}',
+        ReplyToAddresses=[],
     )