DEVPROD-1877: Add ability to send emails (#158)

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.6.16 - 2023-11-14
+
+- Added support for sending emails.
+
 ## 3.6.15
 
 - Added support for binary and nonbinary artifact streams.

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "evergreen.py"
-version = "3.6.15"
+version = "3.6.16"
 description = "Python client for the Evergreen API"
 authors = [
     "Dev Prod DAG <[email protected]>",

src/evergreen/api.py

@@ -453,6 +453,43 @@ def send_slack_message(
             url, data=json.dumps(data), method="POST",
         )
 
+    def send_email(
+        self,
+        recipients: List[str],
+        sender: Optional[str] = None,
+        subject: Optional[str] = None,
+        body: Optional[str] = None,
+        is_plain_text: Optional[bool] = None,
+        headers: Optional[Dict[str, List[str]]] = None,
+    ) -> None:
+        """
+        Send an email to a user.
+
+        :param recipients: Who to send the email to.
+        :param sender: Who the email should be sent on behalf of.
+        :param subject: The subject of the email to send.
+        :param body: What should be in the body of the email.
+        :param is_plain_text: If the email is in plain text or not. If true, will be text/plain. text/html otherwise.
+        :param headers: What email headers to attach.
+        """
+        url = self._create_url("/notifications/email")
+        data: Dict[str, Any] = {
+            "recipients": recipients,
+        }
+        if sender is not None:
+            data["sender"] = sender
+        if subject is not None:
+            data["subject"] = subject
+        if body is not None:
+            data["body"] = body
+        if is_plain_text is not None:
+            data["is_plain_text"] = is_plain_text
+        if headers is not None:
+            data["headers"] = headers
+        self._call_api(
+            url, data=json.dumps(data), method="POST",
+        )
+
     def alias_for_version(
         self, version_id: str, alias: str, include_deps: bool = False
     ) -> List[VariantAlias]:

tests/evergreen/test_api.py

@@ -377,6 +377,17 @@ def test_single_test_by_task(self, mocked_api):
             method="GET",
         )
 
+    def test_email(self, mocked_api):
+        recipients = ["@fake-user"]
+        body = "I'm a fake message"
+        subject = "I'm a fake subject"
+        mocked_api.send_email(recipients=recipients, subject=subject, body=body)
+        expected_url = mocked_api._create_url("/notifications/email")
+        expected_data = json.dumps({"recipients": recipients, "subject": subject, "body": body})
+        mocked_api.session.request.assert_called_with(
+            url=expected_url, timeout=None, data=expected_data, method="POST", params=None
+        )
+
     def test_send_slack_message(self, mocked_api):
         target = "@fake-user"
         msg = "I'm a fake message"