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

Author: iwilson-oa

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

@@ -10,11 +10,16 @@
     "smtp_port": {
       "type": "number",
       "minimum": 1,
-      "maximum": 65535
+      "maximum": 65535,
+      "default": 25
     },
     "smtp_server": {
       "type": "string"
     },
+    "start_tls": {
+      "type": "boolean",
+      "default": true
+    },
     "sender": {
       "type": "string",
       "pattern": "^(.*?\\s+<)?[\\w.-]+@[\\w.-]+\\.[a-zA-Z]{2,6}(>?)$"
@@ -33,6 +38,6 @@
       "additionalProperties": false
     }
   },
-  "required": ["name"],
+  "required": ["name", "smtp_server", "sender"],
   "additionalProperties": false
 }

src/opentaskpy/remotehandlers/email.py

@@ -125,13 +125,15 @@ def push_files_from_worker(
                 )
                 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 self.protocol_vars["start_tls"]:
+                    smtp.starttls()
+
+                # Authenticate (if credentials specified)
+                if self.protocol_vars["credentials"]:
+                    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")