Added support for multiple recipients

Author: Luciano Vitetti

README.md

@@ -35,3 +35,29 @@ params = MailParams(
 
 estr.mail.send(params)
 ```
+
+## Multiple Recipients Usage
+
+```python
+from envialosimple.transaccional import Transaccional
+from envialosimple.transaccional.mail import MailParams
+
+estr = Transaccional(your_api_key)
+
+params = MailParams(
+        from_email='no-reply@mycompany.com', 
+        from_name='MyCompany Notifications',
+        to_email=[
+                {"email": 'jane.doe@example.com', "name": 'Jane Doe'},
+                {"email": 'sean.smith@example.com', "name": 'Sean Smith'},
+                {"email": 'john.doe@example.com'}
+        ], 
+        reply_to='reply@here.com',
+        subject='This is a test for {{name}}', 
+        preview_text='A glimpse of what comes next...',
+        html='<h1>HTML emails are cool, {{name}}</h1>', 
+        text='Text emails are also cool, {{name}}',
+        context={'name': 'John'})
+
+estr.mail.send(params)
+```

src/envialosimple/transaccional/http.py

@@ -21,8 +21,8 @@ def post(self, url: str, data: dict) -> tuple:
 
         if http_code == 500:
             raise ValueError(f'The server responded with code {http_code}')
-
-        if type(json_response) is not dict:
+        
+        if type(json_response) is not dict and type(json_response) is not list:
             raise ValueError('The server did not respond with JSON')
 
         return (http_code, json_response)

src/envialosimple/transaccional/mail.py

@@ -1,6 +1,6 @@
 import base64
 from warnings import warn
-from typing import TypeVar, TypedDict, Union
+from typing import TypeVar, TypedDict, Union, List
 from typing_extensions import Unpack
 
 SelfMailParams = TypeVar("SelfMailParams", bound="MailParams")
@@ -13,10 +13,15 @@ class AttachmentParams(TypedDict):
     filename: Union[str, None]
 
 
+class Recipient(TypedDict):
+    email: str
+    name: Union[str, None]
+
+
 class MailParamsParams(TypedDict):
     from_email: Union[str, None]
     from_name: Union[str, None]
-    to_email: Union[str, None]
+    to_email: Union[str, None, List[Recipient]]
     to_name: Union[str, None]
     subject: Union[str, None]
     reply_to: Union[str, None]
@@ -93,7 +98,7 @@ def __init__(self, **kwargs: Unpack[MailParamsParams]):
         self.variables = kwargs.get('variables', {})
 
     def setTo(self,
-              to_email: str,
+              to_email: Union[str, List[Recipient]],
               to_name: Union[str, None]) -> SelfMailParams:
         self.to_email = to_email
         self.to_name = to_name
@@ -197,8 +202,8 @@ def to_dict(self) -> dict:
                 'name': self.from_name
             }
 
-        # Pass only email if no name was provided
-        if self.to_name is None:
+        # Pass only email if no name was provided or if email is a list with emails
+        if self.to_name is None or isinstance(self.to_email, List):
             result['to'] = self.to_email
         else:
             result['to'] = {

tests/.env.dist

@@ -1,8 +1,12 @@
 TEST_API_KEY=SomeValidAPIKey
 TEST_FROM_EMAIL=SomeValid@FromAddress
 TEST_TO_EMAIL=SomeValid@ToAddress
+TEST_SECOND_TO_EMAIL=SomeValid@ToAddress
+TEST_THIRD_TO_EMAIL=SomeValid@ToAddress
 TEST_FROM_NAME="John Smith"
 TEST_TO_NAME="John Doe"
+TEST_SECOND_TO_NAME="John Doe"
+TEST_THIRD_TO_NAME="John Doe"
 TEST_TEMPLATE_ID=SomeValidTemplateID
 TEST_INVALID_FROM_EMAIL=somename@mail.com
 TEST_SUBJECT="PyTest Session"

tests/test_mail.py

@@ -1,13 +1,18 @@
 import os
 import pytest
+from typing import List
 from envialosimple.transaccional import Transaccional
 from envialosimple.transaccional.mail import MailParams, Attachment
 
 api_key = os.environ.get('TEST_API_KEY')
 from_email = os.environ.get('TEST_FROM_EMAIL')
 from_name = os.environ.get('TEST_FROM_NAME')
 to_email = os.environ.get('TEST_TO_EMAIL')
+second_to_email = os.environ.get('TEST_SECOND_TO_EMAIL')
+third_to_email = os.environ.get('TEST_THIRD_TO_EMAIL')
 to_name = os.environ.get('TEST_TO_NAME')
+second_to_name = os.environ.get('TEST_SECOND_TO_NAME')
+third_to_name = os.environ.get('TEST_THIRD_TO_NAME')
 subject = os.environ.get('TEST_SUBJECT')
 template_id = os.environ.get('TEST_TEMPLATE_ID')
 reply_to = os.environ.get('TEST_REPLY_TO')
@@ -112,6 +117,33 @@ def test_basic_send():
     assert (outcome['queued'] is True)
 
 
+def test_multiple_to_send():
+    """
+    Send an E-Mail with Multiple recipients
+    """
+    params = MailParams()
+    params.from_email = from_email
+    params.from_name = from_name
+    params.to_email = [
+        {"email": to_email, "name": to_name},
+        {"email": second_to_email, "name": second_to_name},
+        {"email": third_to_email}
+    ]
+    params.subject = subject
+    params.reply_to = reply_to
+    params.preview_text = preview_text
+    params.html = "<body>PyTest Multiple recipients {{sub}}</body>"
+    params.text = "PyTest Multiple recipients {{sub}}"
+    params.context = {'sub': 'substitution'}
+
+    outcome = estr.mail.send(params)
+    
+    assert (type(outcome) is list)
+    assert ('id' in outcome[0])
+    assert ('queued' in outcome[0])
+    assert (outcome[0]['queued'] is True)
+
+
 def test_attachment_send():
     """
     Send E-Mail with attachment