Merge pull request #667 from padamscrestonecapital/master

Add ability to pass b64 formatted string when adding attachments

Author: vgrem

examples/outlook/messages/create_draft_message_with_attachments.py

@@ -0,0 +1,16 @@
+import base64
+
+from examples import acquire_token_by_username_password
+from office365.graph_client import GraphClient
+
+
+# Multple "add_file_attachment" calls can be chained before "execute_query" to add multiple attachments
+
+with open(r"path\to\file\test.pdf", "rb") as f:
+    content = base64.b64encode(f.read()).decode()
+client = GraphClient(acquire_token_by_username_password)
+client.me.messages.add(
+    subject="Meet for lunch?",
+    body="The new cafeteria is open.",
+    to_recipients=["fannyd@contoso.onmicrosoft.com"]
+).add_file_attachment("attachment.txt", content_type="application/pdf", base64_content=content).execute_query()

office365/outlook/mail/attachments/collection.py

@@ -12,19 +12,27 @@ class AttachmentCollection(EntityCollection):
     def __init__(self, context, resource_path=None):
         super(AttachmentCollection, self).__init__(context, Attachment, resource_path)
 
-    def add_file(self, name, content, content_type=None):
+    def add_file(self, name, content=None, content_type=None, base64_content=None):
         """
         Attach a file to message
 
         :param str name: The name representing the text that is displayed below the icon representing the
              embedded attachment
-        :param str content: The contents of the file
+        :param str or None content: The contents of the file
         :param str or None content_type: The content type of the attachment.
+        :param str or None base64_content: The contents of the file in the form of a base64 string.
         """
+        if not content and not base64_content:
+            raise TypeError("Either content or base64_content is required")
         from office365.outlook.mail.attachments.file import FileAttachment
+
         return_type = FileAttachment(self.context)
         return_type.name = name
-        return_type.content_bytes = base64.b64encode(content.encode("utf-8")).decode("utf-8")
+        if base64_content:
+            content = base64_content
+        else:
+            content = base64.b64encode(content.encode("utf-8")).decode("utf-8")
+        return_type.content_bytes = content
         return_type.content_type = content_type
         self.add_child(return_type)
         return self

office365/outlook/mail/messages/message.py

@@ -60,16 +60,21 @@ def get_content(self):
         self.context.add_query(qry)
         return return_type
 
-    def add_file_attachment(self, name, content, content_type=None):
+    def add_file_attachment(
+        self, name, content=None, content_type=None, base64_content=None
+    ):
         """
         Attach a file to message
 
         :param str name: The name representing the text that is displayed below the icon representing the
              embedded attachment
-        :param str content: The contents of the file
+        :param str or None content: The contents of the file
         :param str or None content_type: The content type of the attachment.
+        :param str or None base64_content: The contents of the file in the form of a base64 string.
         """
-        self.attachments.add_file(name, content, content_type)
+        if not content and not base64_content:
+            raise TypeError("Either content or base64_content is required")
+        self.attachments.add_file(name, content, content_type, base64_content)
         return self
 
     def upload_attachment(self, file_path, chunk_uploaded=None):

tests/outlook/test_messages.py

@@ -1,3 +1,6 @@
+import base64
+import io
+
 from office365.outlook.mail.messages.message import Message
 from office365.outlook.mail.recipient import Recipient
 from tests import test_user_principal_name, test_user_principal_name_alt
@@ -44,3 +47,27 @@ def test_7_delete_message(self):
         messages = self.client.me.messages.top(1).get().execute_query()
         message_to_delete = messages[0]
         message_to_delete.delete_object().execute_query()
+
+    def test_8_create_draft_message_with_attachments(self):
+        content = base64.b64encode(
+            io.BytesIO(b"This is some file content").read()
+        ).decode()
+        draft = (
+            self.client.me
+            .messages.add(
+                subject="Check out this attachment", body="The new cafeteria is open."
+            )
+            .add_file_attachment("test.txt", "Hello World!")
+            .add_file_attachment("test2.txt", base64_content=content)
+            .execute_query()
+        )
+        assert (
+            len(
+                self.client.me
+                .messages[draft.id]
+                .attachments.get()
+                .execute_query()
+            )
+            == 2
+        )
+        draft.delete_object().execute_query()