Merge pull request #120 from QHivert/notify_feat

Add Notify Extension

Author: tonioo

README.rst

@@ -43,6 +43,7 @@ The following extensions are also supported:
 * Relational (`RFC 5231 <https://tools.ietf.org/html/rfc5231>`_)
 * Imap4flags (`RFC 5232 <https://tools.ietf.org/html/rfc5232>`_)
 * Regular expression (`Draft <https://datatracker.ietf.org/doc/html/draft-murchison-sieve-regex-08/>`_)
+* Notifications (`RFC 5435 <https://datatracker.ietf.org/doc/html/rfc5435>`_)
 
 The following extensions are partially supported:
 

sievelib/commands.py

@@ -463,6 +463,7 @@ def check_next_arg(
             return False
         if self.iscomplete(atype, avalue):
             return False
+        
 
         if self.curarg is not None and "extra_arg" in self.curarg:
             condition = atype in self.curarg["extra_arg"]["type"] and (
@@ -726,6 +727,44 @@ class RemoveflagCommand(ActionCommand):
     ]
     extension = "imap4flags"
 
+class NotifyCommand(ActionCommand):
+    """
+    Notify extension
+
+    https://datatracker.ietf.org/doc/html/rfc5435
+    """
+    extension = "enotify"
+    args_definition = [
+        {
+            "name": "from",
+            "type": ["tag"],
+            "values": [":from"],
+            "required": False,
+            "extra_arg": {"type": "string", "required": True}
+        },
+                {
+            "name": "importance",
+            "type": ["tag"],
+            "values": [":importance"],
+            "required": False,
+            "extra_arg": {"type": "string", "required": True}
+        },
+                {
+            "name": "options",
+            "type": ["tag"],
+            "values": [":options"],
+            "required": False,
+            "extra_arg": {"type": "stringlist", "required": True}
+        },
+        {
+            "name": "message",
+            "type": ["tag"],
+            "values": [":message"],
+            "required": False,
+            "extra_arg": {"type": "string", "required": True}
+        },
+        {"name": "method", "type": ["string"], "required": True},
+    ]
 
 class TestCommand(Command):
     """Indermediate class to represent "test" commands"""

sievelib/tests/test_factory.py

@@ -703,6 +703,31 @@ def test_address_list_args(self):
 """,
         )
 
+    def test_notify_action(self):
+        self.fs.addfilter(
+            "test",
+            [
+                (
+                    "from",
+                    ":contains",
+                    "[email protected]",
+                )
+            ],
+            [("notify", ":importance", "1", ":message", "This is probably very important", "mailto:[email protected]")],
+        )
+
+        output = io.StringIO()
+        self.fs.tosieve(output)
+        self.assertEqual(
+            output.getvalue(),
+            """require ["enotify"];
+
+# Filter: test
+if anyof (header :contains "from" "[email protected]") {
+    notify :importance "1" :message "This is probably very important" "mailto:[email protected]";
+}
+"""
+        )
 
 if __name__ == "__main__":
     unittest.main()

sievelib/tests/test_parser.py

@@ -663,6 +663,19 @@ def test_body_extension(self):
 """
         )
 
+    def test_notify_extension(self):
+        self.compilation_ok(
+            b"""require ["enotify", "fileinto", "variables"];
+
+if header :contains "from" "[email protected]" {
+    notify :importance "1"
+        :message "This is probably very important"
+                    "mailto:[email protected]";
+    # Don't send any further notifications
+    stop;
+}
+"""
+        )
 
 class InvalidSyntaxes(SieveTest):
     def test_nested_comments(self):
@@ -850,6 +863,19 @@ def test_vacation_seconds_no_arg(self):
 """
         )
 
+    def test_notify_extension_importance_no_args(self):
+        self.compilation_ko(
+            b"""require ["enotify", "fileinto", "variables"];
+
+if header :contains "from" "[email protected]" {
+    notify :importance
+        :message "This is probably very important";
+            "mailto:[email protected]"
+    # Don't send any further notifications
+    stop;
+}
+"""
+        )
 
 class LanguageRestrictions(SieveTest):
     def test_unknown_control(self):