Feat/email destination changes (#121)

* Adjust schema for email destinations to make startTLS and credentials optional, and require smtp server and sender to be set

* Remove defaults from email destination schema and set in TaskHandler

* Adjust test email protocol schema

* Fix dictionary key check for smtp credentials

* bump version v25.3.0 -> v25.3.1

Author: iwilson-oa

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+#v25.3.1
+
+- Adjust email_destination TaskHandler to allow use of TLS/credentials to be optional, and set default port to 587
+- Adjust email_destination protocol schema to ensure that smtp_server and sender are set
+
 # v25.3.0
 
 - Add ignore_errors=True to problematic .gnupg removal

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "opentaskpy"
-version = "v25.3.0"
+version = "v25.3.1"
 authors = [{ name = "Adam McDonagh", email = "adam@elitemonkey.net" }]
 license = { text = "GPLv3" }
 classifiers = [
@@ -71,7 +71,7 @@ otf-batch-validator = "opentaskpy.cli.batch_validator:main"
 profile = 'black'
 
 [tool.bumpver]
-current_version = "v25.3.0"
+current_version = "v25.3.1"
 version_pattern = "vYY.WW.PATCH[-TAG]"
 commit_message = "bump version {old_version} -> {new_version}"
 commit = true

src/opentaskpy/config/schemas/transfer/email/protocol.json

@@ -15,6 +15,9 @@
     "smtp_server": {
       "type": "string"
     },
+    "use_tls": {
+      "type": "boolean"
+    },
     "sender": {
       "type": "string",
       "pattern": "^(.*?\\s+<)?[\\w.-]+@[\\w.-]+\\.[a-zA-Z]{2,6}(>?)$"
@@ -33,6 +36,6 @@
       "additionalProperties": false
     }
   },
-  "required": ["name"],
+  "required": ["name", "smtp_server", "sender"],
   "additionalProperties": false
 }

src/opentaskpy/remotehandlers/email.py

@@ -116,22 +116,34 @@ def push_files_from_worker(
 
             msg["From"] = self.protocol_vars["sender"]
 
+            # Set connection port, default to 587
+            smtp_port = 587
+            if "smtp_port" in self.protocol_vars:
+                smtp_port = self.protocol_vars["smtp_port"]
+
+            # Determine whether to use startTLS on connection
+            use_tls = True
+            if "use_tls" in self.protocol_vars and not self.protocol_vars["use_tls"]:
+                use_tls = False
+
             # Send the email using a provided SMTP server
             try:
                 self.logger.debug(f"Sending email to {email_address}")
                 smtp = smtplib.SMTP(
                     self.protocol_vars["smtp_server"],
-                    port=self.protocol_vars["smtp_port"],
+                    port=smtp_port,
                 )
                 if self.logger.getEffectiveLevel() <= DEBUG:
                     smtp.set_debuglevel(1)
-                smtp.starttls()
-
-                # Authenticate
-                smtp.login(
-                    self.protocol_vars["credentials"]["username"],
-                    self.protocol_vars["credentials"]["password"],
-                )
+                if use_tls:
+                    smtp.starttls()
+
+                # Authenticate (if credentials specified)
+                if "credentials" in self.protocol_vars:
+                    smtp.login(
+                        self.protocol_vars["credentials"]["username"],
+                        self.protocol_vars["credentials"]["password"],
+                    )
 
                 smtp.sendmail(
                     self.protocol_vars["sender"], email_address, msg.as_string()

tests/test_email_transfer_schema_validate.py

@@ -6,7 +6,11 @@
 
 @pytest.fixture(scope="function")
 def valid_protocol_definition():
-    return {"name": "email"}
+    return {
+        "name": "email",
+        "smtp_server": "smtp.gmail.com",
+        "sender": "Test Sender <test@example.com>",
+    }
 
 
 @pytest.fixture(scope="function")

tests/test_schema_validate.py

@@ -16,7 +16,11 @@ def valid_protocol_definition():
 
 @pytest.fixture(scope="function")
 def valid_protocol_definition_2():
-    return {"name": "email"}
+    return {
+        "name": "email",
+        "smtp_server": "smtp.gmail.com",
+        "sender": "Test Sender <test@example.com>",
+    }
 
 
 @pytest.fixture(scope="function")