Re: Fancy Mail Splitting documentation needs improved?

[Kan-Ru Chen <kanru@kanru.info>]

[-- Attachment #1: Type: text/plain, Size: 1763 bytes --]

Tommy Kelly <tommy.kelly@verilab.com> writes:

> OK, I'm stopping here for comments from y'all. Note that I'm thinking
> aloud in the above. For example, the idea that there are four 
> forms of split could probably be simplified into a single syntax
> covering all forms. But I haven't figure out what that looks like yet.

Great idea and rewrite!  I was confused at first when reading the
fancy split method, as I thought the | and & operations was logical
operations, but instead they are group operations. Each SPLIT will be
processed (&) or until one matched (|).

I am implementing the logical operators, so the split rule will look
like sieve rule:

--8<---------------cut here---------------start------------->8---
(setq nnmail-split-fancy
      `(| (or (("x-bogosity" "spam" t)
               ("x-spam-status" "yes" t)
               ("list-id" ".*yahoogroups.com" t)
               (to "undisclosed.*recipients" t))
              "mail.spam")
          (or (("list-id" "awesome" t)
               ("list-id" "notmuch" t)
               ("list-id" "madbutterfly" t))
              "mail.list")
          ,(format-time-string "mail.misc-%Y")))
--8<---------------cut here---------------end--------------->8---

The logical operator syntax is:

--8<---------------cut here---------------start------------->8---
(<OP> (<CLAUSE 1> <CLAUSE 2> ...)
      SPLIT)
--8<---------------cut here---------------end--------------->8---

Each clause is a field split that returns non-nil SPLIT, if the OP of
the clauses was true, then split to SPLIT.

The syntax is not finalized yet, but already fulfilled my needs.  I'd
like to drop the third argument of field split, so that the clauses
looks more clear.  I need your comments!

- Kanru

P.S. Draft patch attached.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: fancysplit.patch --]
[-- Type: text/x-diff, Size: 1443 bytes --]

diff --git a/lisp/nnmail.el b/lisp/nnmail.el
index c86e96b..00de781 100644
--- a/lisp/nnmail.el
+++ b/lisp/nnmail.el
@@ -1389,6 +1389,10 @@ See the documentation for the variable `nnmail-split-fancy' for details."
      ((null split)
       nil)
 
+     ;; t split
+     ((eq split t)
+      (list t))
+
      ;; A group name.  Do the \& and \N subs into the string.
      ((stringp split)
       (when nnmail-split-tracing
@@ -1401,6 +1405,28 @@ See the documentation for the variable `nnmail-split-fancy' for details."
 	(push "junk" nnmail-split-trace))
       (list 'junk))
 
+     ;; Logical OR operation.
+     ((eq (car split) 'or)
+      (let (done
+            (clauses (cadr split))
+            (split (cddr split)))
+        (while (and (not done) (car clauses))
+          (setq done (car (nnmail-split-it (car clauses)))
+                clauses (cdr clauses)))
+        (when done
+          (nnmail-split-it (car split)))))
+
+     ;; Logical AND operation.
+     ((eq (car split) 'and)
+      (let ((done t)
+            (clauses (cadr split))
+            (split (cddr split)))
+        (while (and done (car clauses))
+          (setq done (car (nnmail-split-it (car clauses)))
+                clauses (cdr clauses)))
+        (when (and done (null clauses))
+          (nnmail-split-it (car split)))))
+
      ;; Builtin & operation.
      ((eq (car split) '&)
       (apply 'nconc (mapcar 'nnmail-split-it (cdr split))))