Initial working version of Send a Single Email to a Single Recipient

thinkingserious · thinkingserious · commit e07db8d02269 · 2018-06-26T11:36:44.000-07:00
diff --git a/live_test.py b/live_test.py
@@ -0,0 +1,19 @@
+# Send a Single Email to a Single Recipient
+import os
+from sendgrid import SendGridAPIClient # import sendgrid
+from sendgrid.helpers.mail import Mail, From, To, Subject, PlainTextContent, HtmlContent, SendGridException # from sendgrid.helpers.mail
+
+msg = Mail(from_email=From('dx@sendgrid.com', 'DX'),
+           to_emails=To('elmer.thomas@sendgrid.com', 'Elmer Thomas'),
+           subject=Subject('Sending with SendGrid is Fun'),
+           plain_text_content=PlainTextContent('and easy to do anywhere, even with Python'),
+           html_content=HtmlContent('<strong>and easy to do anywhere, even with Python</strong>'))
+
+try:
+    sg_client = SendGridAPIClient(apikey=os.environ.get('SENDGRID_API_KEY'))
+    response = sg_client.send(request_body=msg)
+    print(response.status_code)
+    print(response.body)
+    print(response.headers)
+except SendGridException as e:
+    print(e.message)
diff --git a/proposals/mail-helper-refactor.md b/proposals/mail-helper-refactor.md
@@ -16,7 +16,8 @@ msg = Mail(from_email=From('from@example.com', 'From Name'),
            html_content=HtmlContent('<strong>and easy to do anywhere, even with Python</strong>'))
 
 try:
-    response = sendgrid.send(msg, apikey=os.environ.get('SENDGRID_apikey'))
+    sg_client = SendGridAPIClient()
+    response = sg_client.send(msg, apikey=os.environ.get('SENDGRID_apikey'))
     print(response.status_code)
     print(response.body)
     print(response.headers)
diff --git a/sendgrid/helpers/mail/__init__.py b/sendgrid/helpers/mail/__init__.py
@@ -9,16 +9,21 @@
 from .email import Email
 from .exceptions import SendGridException, APIKeyIncludedException
 from .footer_settings import FooterSettings
+from .from_email import From
 from .ganalytics import Ganalytics
 from .header import Header
+from .html_content import HtmlContent
 from .mail_settings import MailSettings
 from .mail import Mail
 from .open_tracking import OpenTracking
 from .personalization import Personalization
+from .plain_text_content import PlainTextContent
 from .sandbox_mode import SandBoxMode
 from .section import Section
 from .spam_check import SpamCheck
+from .subject import Subject
 from .subscription_tracking import SubscriptionTracking
 from .substitution import Substitution
 from .tracking_settings import TrackingSettings
+from .to_email import To
 from .validators import ValidateAPIKey
diff --git a/sendgrid/helpers/mail/from_email.py b/sendgrid/helpers/mail/from_email.py
@@ -0,0 +1,4 @@
+from .email import Email
+
+class From(Email):
+    """A from email address with an optional name."""
diff --git a/sendgrid/helpers/mail/html_content.py b/sendgrid/helpers/mail/html_content.py
@@ -0,0 +1,41 @@
+from .content import Content
+from .validators import ValidateAPIKey
+
+class HtmlContent(Content):
+    """HTML content to be included in your email.
+    """
+
+    def __init__(self, value):
+        """Create a HtmlContent with the specified MIME type and value.
+
+        :param value: The actual HTML content.
+        :type value: string, optional
+        """
+        self._type = "text/html"
+        self._value = value
+        self._validator = ValidateAPIKey()
+
+    @property
+    def value(self):
+        """The actual HTML content.
+
+        :rtype: string
+        """
+        return self._value
+
+    @value.setter
+    def value(self, value):
+        self._validator.validate_message_dict(value)
+        self._value = value
+
+    def get(self):
+        """
+        Get a JSON-ready representation of this HtmlContent.
+
+        :returns: This HtmlContent, ready for use in a request body.
+        :rtype: dict
+        """
+        content = {}
+        content["type"] = "text/html"
+        content["value"] = self._value
+        return content
diff --git a/sendgrid/helpers/mail/mail.py b/sendgrid/helpers/mail/mail.py
@@ -2,17 +2,17 @@
 from .personalization import Personalization
 from .header import Header
 
-
 class Mail(object):
     """A request to be sent with the SendGrid v3 Mail Send API (v3/mail/send).
 
     Use get() to get the request body.
     """
     def __init__(self, 
                  from_email=None, 
+                 to_emails=None,
                  subject=None, 
-                 to_email=None, 
-                 content=None):
+                 plain_text_content=None,
+                 html_content=None):
         """Create a Mail object.
 
         If any parameters are not supplied, they must be set after initialization.
@@ -47,15 +47,18 @@ def __init__(self,
             self.from_email = from_email
 
         if subject:
-            self.subject = subject
+            self.subject = subject.get()
 
-        if to_email:
+        if to_emails:
             personalization = Personalization()
-            personalization.add_to(to_email)
+            personalization.add_to(to_emails)
             self.add_personalization(personalization)
 
-        if content:
-            self.add_content(content)
+        if plain_text_content:
+            self.add_content(plain_text_content)
+        
+        if html_content:
+            self.add_content(html_content)
 
     def __str__(self):
         """Get a JSON representation of this Mail request.
@@ -395,3 +398,4 @@ def add_custom_arg(self, custom_arg):
         if self._custom_args is None:
             self._custom_args = []
         self._custom_args.append(custom_arg)
+
diff --git a/sendgrid/helpers/mail/plain_text_content.py b/sendgrid/helpers/mail/plain_text_content.py
@@ -0,0 +1,41 @@
+from .content import Content
+from .validators import ValidateAPIKey
+
+class PlainTextContent(Content):
+    """Plain text content to be included in your email.
+    """
+
+    def __init__(self, value):
+        """Create a PlainTextContent with the specified MIME type and value.
+
+        :param value: The actual text content.
+        :type value: string, optional
+        """
+        self._type = "text/plain"
+        self._value = value
+        self._validator = ValidateAPIKey()
+
+    @property
+    def value(self):
+        """The actual text content.
+
+        :rtype: string
+        """
+        return self._value
+
+    @value.setter
+    def value(self, value):
+        self._validator.validate_message_dict(value)
+        self._value = value
+
+    def get(self):
+        """
+        Get a JSON-ready representation of this PlainTextContent.
+
+        :returns: This PlainTextContent, ready for use in a request body.
+        :rtype: dict
+        """
+        content = {}
+        content["type"] = "text/plain"
+        content["value"] = self._value
+        return content
diff --git a/sendgrid/helpers/mail/subject.py b/sendgrid/helpers/mail/subject.py
@@ -0,0 +1,38 @@
+class Subject(object):
+    """A subject for an email message."""
+
+    def __init__(self, subject):
+        """Create a Subjuct.
+
+        :param subject: The subject for an email
+        :type subject: string
+        """
+        self._subject = subject
+
+    @property
+    def subject(self):
+        """The subject of an email.
+
+        :rtype: string
+        """
+        return self._subject
+
+    @subject.setter
+    def subject(self, value):
+        self._subject = value
+
+    def __str__(self):
+        """Get a JSON representation of this Mail request.
+
+        :rtype: string
+        """
+        return str(self.get())
+
+    def get(self):
+        """
+        Get a JSON-ready representation of this Subject.
+
+        :returns: This Subject, ready for use in a request body.
+        :rtype: string
+        """
+        return self._subject
diff --git a/sendgrid/helpers/mail/to_email.py b/sendgrid/helpers/mail/to_email.py
@@ -0,0 +1,4 @@
+from .email import Email
+
+class To(Email):
+    """A to email address with an optional name."""
diff --git a/sendgrid/sendgrid.py b/sendgrid/sendgrid.py
@@ -103,3 +103,7 @@ def api_key(self):
     @api_key.setter
     def api_key(self, value):
         self.apikey = value
+
+    def send(self, request_body):
+        response = self.client.mail.send.post(request_body=request_body.get())
+        return response
