WIP - final use case update, kitchen sink

Author: thinkingserious

live_test.py

@@ -46,47 +46,93 @@
 # except SendGridException as e:
 #     print(e.message)
 
-# Send Multiple Emails to Multiple Recipients
+# # Send Multiple Emails to Multiple Recipients
+
+# import os
+# import json
+# from sendgrid import SendGridAPIClient
+# from sendgrid.helpers.mail import Mail, From, To, Subject, PlainTextContent, HtmlContent, SendGridException, Substitution
+# import time
+# import datetime
+
+# to_emails = [
+#     To(email='[email protected]',
+#        name='Elmer SendGrid',
+#        substitutions={
+#            Substitution('-name-', 'Elmer SendGrid'),
+#            Substitution('-github-', 'http://github.com/ethomas'),
+#        },
+#        subject=Subject('Override Global Subject')),
+#     To(email='[email protected]',
+#        name='Elmer Thomas',
+#        substitutions={
+#            Substitution('-name-', 'Elmer Thomas'),
+#            Substitution('-github-', 'http://github.com/thinkingserious'),
+#        })
+# ]
+# ts = time.time()
+# global_substitutions = Substitution('-time-', datetime.datetime.fromtimestamp(ts).strftime('%Y-%m-%d %H:%M:%S'))
+# message = Mail(from_email=From('[email protected]', 'DX'),
+#                to_emails=to_emails,
+#                subject=Subject('Hi -name-'),
+#                plain_text_content=PlainTextContent('Hello -name-, your github is -github-, email sent at -time-'),
+#                html_content=HtmlContent('<strong>Hello -name-, your github is <a href=\"-github-\">here</a></strong> email sent at -time-'),
+#                global_substitutions=global_substitutions,
+#                is_multiple=True)
+
+# try:
+#     sendgrid_client = SendGridAPIClient(apikey=os.environ.get('SENDGRID_API_KEY'))
+#     print(json.dumps(message.get(), sort_keys=True, indent=4))
+#     response = sendgrid_client.send(message=message)
+#     print(response.status_code)
+#     print(response.body)
+#     print(response.headers)
+# except SendGridException as e:
+#     print(e.message)
+
+# Kitchen Sink - an example with all settings used
 
 import os
 import json
 from sendgrid import SendGridAPIClient
-from sendgrid.helpers.mail import Mail, From, To, Subject, PlainTextContent, HtmlContent, SendGridException, Substitution
+from sendgrid.helpers.mail import Mail, From, To, Cc, Bcc, Subject, PlainTextContent, HtmlContent, SendGridException, Substitution, Header
 import time
 import datetime
 
-to_emails = [
-    To(email='[email protected]',
-       name='Elmer SendGrid',
-       substitutions={
-           Substitution('-name-', 'Elmer SendGrid'),
-           Substitution('-github-', 'http://github.com/ethomas'),
-       },
-       subject=Subject('Override Global Subject')),
-    To(email='[email protected]',
-       name='Elmer Thomas',
-       substitutions={
-           Substitution('-name-', 'Elmer Thomas'),
-           Substitution('-github-', 'http://github.com/thinkingserious'),
-       })
+message = Mail()
+
+message.to = To('[email protected]', 'Example User1')
+message.to = [ 
+    To('[email protected]', 'Example User2'),
+    To('[email protected]', 'Example User3')
 ]
-ts = time.time()
-global_substitutions = Substitution('-time-', datetime.datetime.fromtimestamp(ts).strftime('%Y-%m-%d %H:%M:%S'))
-message = Mail(from_email=From('[email protected]', 'DX'),
-               to_emails=to_emails,
-               subject=Subject('Hi -name-'),
-               plain_text_content=PlainTextContent('Hello -name-, your github is -github-, email sent at -time-'),
-               html_content=HtmlContent('<strong>Hello -name-, your github is <a href=\"-github-\">here</a></strong> email sent at -time-'),
-               global_substitutions=global_substitutions,
-               is_multiple=True)
+
+message.cc = Cc('[email protected]', 'Example User4')
+message.cc = [ 
+    Cc('[email protected]', 'Example User5'),
+    Cc('[email protected]', 'Example User6')
+]
+
+message.bcc = Bcc('[email protected]', 'Example User7')
+message.bcc = [ 
+    Bcc('[email protected]', 'Example User8'),
+    Bcc('[email protected]', 'Example User9')
+]
+
+# message.header = Header('X-Test1', 'Test1')
+# message.header = Header('X-Test2', 'Test2')
+# message.header = [
+#     Header('X-Test3', 'Test3'),
+#     Header('X-Test4', 'Test4')
+# ]
 
 try:
     sendgrid_client = SendGridAPIClient(apikey=os.environ.get('SENDGRID_API_KEY'))
     print(json.dumps(message.get(), sort_keys=True, indent=4))
-    response = sendgrid_client.send(message=message)
-    print(response.status_code)
-    print(response.body)
-    print(response.headers)
+    # response = sendgrid_client.send(message=message)
+    # print(response.status_code)
+    # print(response.body)
+    # print(response.headers)
 except SendGridException as e:
     print(e.message)
 

sendgrid/helpers/mail/__init__.py

@@ -26,4 +26,6 @@
 from .substitution import Substitution
 from .tracking_settings import TrackingSettings
 from .to_email import To
+from .cc_email import Cc
+from .bcc_email import Bcc
 from .validators import ValidateAPIKey

sendgrid/helpers/mail/bcc_email.py

@@ -0,0 +1,5 @@
+from .email import Email
+
+
+class Bcc(Email):
+    """A bcc email address with an optional name."""

sendgrid/helpers/mail/cc_email.py

@@ -0,0 +1,5 @@
+from .email import Email
+
+
+class Cc(Email):
+    """A cc email address with an optional name."""

sendgrid/helpers/mail/email.py

@@ -25,7 +25,8 @@ def __init__(self,
                  email=None,
                  name=None,
                  substitutions=None,
-                 subject=None):
+                 subject=None,
+                 p=None):
         """Create an Email with the given address and name.
 
         Either fill the separate name and email fields, or pass all information
@@ -38,6 +39,7 @@ def __init__(self,
         self._name = None
         self._email = None
         self._substitutions = None
+        self._personalization = None
 
         if email and not name:
             # allows passing emails as "dude Fella <[email protected]>"
@@ -103,6 +105,14 @@ def subject(self):
     def subject(self, value):
         self._subject = value
 
+    @property
+    def p(self):
+        return self._personalization
+
+    @p.setter
+    def p(self, value):
+        self._personalization = value
+
     def get(self):
         """
         Get a JSON-ready representation of this Email.

sendgrid/helpers/mail/mail.py

@@ -5,7 +5,6 @@
 from .content import Content
 from .subject import Subject
 
-
 class Mail(object):
     """Creates the response body for v3/mail/send"""
     def __init__(
@@ -36,7 +35,7 @@ def __init__(
         self._contents = None
         self._custom_args = None
         self._headers = None
-        self._personalizations = None
+        self._personalizations = []
         self._sections = None
         self._asm = None
         self._batch_id = None
@@ -55,38 +54,7 @@ def __init__(
         if subject is not None:
             self.subject = subject
         if to_emails is not None:
-            if is_multiple == True:
-                if isinstance(to_emails, list):
-                    for email in to_emails:
-                        personalization = Personalization()
-                        personalization.add_to(email)
-                        self.add_personalization(personalization)
-                else:
-                    personalization = Personalization()
-                    personalization.add_to(to_emails)
-                    self.add_personalization(personalization)
-                if global_substitutions is not None:
-                    if isinstance(global_substitutions, list):
-                        for substitution in global_substitutions:
-                            for p in self.personalizations:
-                                p.add_substitution(substitution)
-                    else:
-                        for p in self.personalizations:
-                            p.add_substitution(global_substitutions)
-            else:    
-                personalization = Personalization()
-                if isinstance(to_emails, list):
-                    for email in to_emails:
-                        personalization.add_to(email)
-                else:
-                    personalization.add_to(to_emails)
-                if global_substitutions is not None:
-                    if isinstance(global_substitutions, list):
-                        for substitution in global_substitutions:
-                            personalization.add_substitution(substitution)
-                    else:
-                        personalization.add_substitution(global_substitutions)
-                self.add_personalization(personalization)
+            self._set_emails(to_emails, global_substitutions, is_multiple)
         if plain_text_content is not None:
             self.add_content(plain_text_content)
         if html_content is not None:
@@ -95,9 +63,9 @@ def __init__(
     def __str__(self):
         return str(self.get())
 
-    def _ensure_append(self, new_items, append_to):
+    def _ensure_append(self, new_items, append_to, index=0):
         append_to = append_to or []
-        append_to.append(new_items)
+        append_to.insert(index, new_items)
         return append_to
 
     def _ensure_insert(self, new_items, insert_to):
@@ -112,6 +80,75 @@ def _flatten_dicts(self, dicts):
     def _get_or_none(self, from_obj):
         return from_obj.get() if from_obj is not None else None
 
+    def _set_emails(self, emails, global_substitutions=None, is_multiple=False, p=0):
+        # Send Multiple Emails to Multiple Recipients
+        if is_multiple == True:
+            if isinstance(emails, list):
+                for email in emails:
+                    if p == 0 and self._personalizations[p] == None:
+                        personalization = Personalization()
+                        self.add_personalization(personalization, index=p)
+                    else:
+                        self._personalizations[p].add_email(email)
+            else:
+                personalization = Personalization()
+                personalization.add_email(emails)
+                self.add_personalization(personalization)
+            if global_substitutions is not None:
+                if isinstance(global_substitutions, list):
+                    for substitution in global_substitutions:
+                        for p in self.personalizations:
+                            p.add_substitution(substitution)
+                else:
+                    for p in self.personalizations:
+                        p.add_substitution(global_substitutions)
+        else:  
+            try:
+                personalization = self._personalizations[p]
+                has_internal_personalization = True
+            except IndexError:
+                personalization = Personalization()
+                has_internal_personalization = False
+
+            if isinstance(emails, list):
+                for email in emails:
+                    personalization.add_email(email)
+            else:
+                personalization.add_email(emails)
+            if global_substitutions is not None:
+                if isinstance(global_substitutions, list):
+                    for substitution in global_substitutions:
+                        personalization.add_substitution(substitution)
+                else:
+                    personalization.add_substitution(global_substitutions)
+            
+            if not has_internal_personalization:
+                self.add_personalization(personalization)
+
+    @property
+    def to(self):
+        pass
+    
+    @to.setter
+    def to(self, to_emails, global_substitutions=None, is_multiple=False, p=0):
+        self._set_emails(to_emails, None, is_multiple=is_multiple, p=p)
+
+    @property
+    def cc(self):
+        pass
+    
+    @cc.setter
+    def cc(self, bcc_emails, global_substitutions=None, is_multiple=False, p=0):
+        self._set_emails(bcc_emails, None, is_multiple=is_multiple, p=p)
+
+    @property
+    def bcc(self):
+        pass
+    
+    @bcc.setter
+    def bcc(self, bcc_emails, global_substitutions=None, is_multiple=False, p=0):
+        self._set_emails(bcc_emails, None, is_multiple=is_multiple, p=p)
+
     @property
     def attachments(self):
         return self._attachments
@@ -148,6 +185,14 @@ def add_content(self, content):
     def headers(self):
         return self._headers
 
+    @property
+    def header(self):
+        pass
+
+    @header.setter
+    def header(self, header):
+        self.add_header(header)
+
     def add_header(self, header):
         if isinstance(header, dict):
             (k, v) = list(header.items())[0]
@@ -159,9 +204,9 @@ def add_header(self, header):
     def personalizations(self):
         return self._personalizations
 
-    def add_personalization(self, personalizations):
+    def add_personalization(self, personalizations, index=0):
         self._personalizations = self._ensure_append(
-            personalizations, self._personalizations)
+            personalizations, self._personalizations, index)
 
     @property
     def sections(self):

sendgrid/helpers/mail/personalization.py

@@ -14,6 +14,19 @@ def __init__(self):
         self._custom_args = []
         self._send_at = None
 
+    def add_email(self, email):
+        email_type = type(email)
+        if email_type.__name__ == 'To':
+            self.add_to(email)
+            return
+        if email_type.__name__ == 'Cc':
+            self.add_cc(email)
+            return
+        if email_type.__name__ == 'Bcc':
+            self.add_bcc(email)
+            return
+        raise ValueError('Please use a To, Cc or Bcc object.')
+
     @property
     def tos(self):
         """A list of recipients for this Personalization.