Add use case for generation of Plain Text Content from HTML

Resolves #354
sendgrid · Oct 23, 2018 · 1819e60 · 1819e60
1 parent edd02e4
commit 1819e60
Show file tree

Hide file tree

Showing 2 changed files with 59 additions and 0 deletions.
diff --git a/use_cases/README.md b/use_cases/README.md
@@ -14,6 +14,7 @@ This directory provides examples for specific use cases of this library. Please
 ### Working with Mail
 * [Asynchronous Mail Send](asynchronous_mail_send.md)
 * [Attachment](attachment.md)
+* [Sending HTML-Only Content](sending_html_content.md)
 * [Transactional Templates](transational_templates.md)
 
 ### Library Features

diff --git a/use_cases/sending_html_content.md b/use_cases/sending_html_content.md
@@ -0,0 +1,58 @@
+# Sending HTML-only Content
+
+
+Currently, we require both HTML and Plain Text content for improved deliverability. In some cases, only HTML may be available. The below example shows how to obtain the Plain Text equivalent of the HTML content.
+
+## Using `beautifulsoup4`
+
+```python
+import sendgrid
+import os
+from sendgrid.helpers.mail import Email, Content, Mail
+try:
+    # Python 3
+    import urllib.request as urllib
+except ImportError:
+    # Python 2
+    import urllib2 as urllib
+from bs4 import BeautifulSoup
+
+html_text = """
+<html>
+    <body>
+        <p>
+            Some
+            <b>
+                bad
+                <i>
+                    HTML
+                </i>
+            </b>
+        </p>
+    </body>
+</html>
+"""
+
+sg = sendgrid.SendGridAPIClient(apikey=os.environ.get('SENDGRID_API_KEY'))
+from_email = Email("test@exmaple.com")
+subject = "subject"
+to_emila = Email("to_email@example.com")
+html_content = Content("text/html", html_text)
+
+mail = Mail(from_email, subject, to_email, html_content)
+
+soup = BeautifulSoup(html_text)
+plain_text = soup.get_text()
+plain_content = Content("text/plain", plain_text)
+mail.add_content(plain_content)
+
+try:
+    response = sg.client.mail.send.post(request_body=mail.get())
+except urllib.HTTPError as e:
+    print(e.read())
+    exit()
+
+print(response.status_code)
+print(response.body)
+print(response.headers)
+```