1 ;;; gnus-mlspl.el --- a group params-based mail splitting mechanism
2 ;; Copyright (C) 1998, 1999, 2000
3 ;; Free Software Foundation, Inc.
5 ;; Author: Alexandre Oliva <oliva@lsd.ic.unicamp.br>
6 ;; Keywords: news, mail
8 ;; This program is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; This program is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with this program; see the file COPYING. If not, write to
20 ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 ;; Boston, MA 02111-1307, USA.
27 (eval-when-compile (require 'cl))
33 (defvar gnus-group-split-updated-hook nil
34 "Hook called just after nnmail-split-fancy is updated by
35 gnus-group-split-update.")
37 (defvar gnus-group-split-default-catch-all-group "mail.misc"
38 "Group name (or arbitrary fancy split) with default splitting rules.
39 Used by gnus-group-split and gnus-group-split-update as a fallback
40 split, in case none of the group-based splits matches.")
43 (defun gnus-group-split-setup (&optional auto-update catch-all)
44 "Set up the split for nnmail-split-fancy.
45 Sets things up so that nnmail-split-fancy is used for mail
46 splitting, and defines the variable nnmail-split-fancy according with
49 If AUTO-UPDATE is non-nil (prefix argument accepted, if called
50 interactively), it makes sure nnmail-split-fancy is re-computed before
51 getting new mail, by adding gnus-group-split-update to
52 nnmail-pre-get-new-mail-hook.
54 A non-nil CATCH-ALL replaces the current value of
55 gnus-group-split-default-catch-all-group. This variable is only used
56 by gnus-group-split-update, and only when its CATCH-ALL argument is
57 nil. This argument may contain any fancy split, that will be added as
58 the last split in a `|' split produced by gnus-group-split-fancy,
59 unless overridden by any group marked as a catch-all group. Typical
60 uses are as simple as the name of a default mail group, but more
61 elaborate fancy splits may also be useful to split mail that doesn't
62 match any of the group-specified splitting rules. See
63 gnus-group-split-fancy for details."
65 (setq nnmail-split-methods 'nnmail-split-fancy)
67 (setq gnus-group-split-default-catch-all-group catch-all))
68 (gnus-group-split-update)
70 (add-hook 'nnmail-pre-get-new-mail-hook 'gnus-group-split-update)))
73 (defun gnus-group-split-update (&optional catch-all)
74 "Computes nnmail-split-fancy from group params and CATCH-ALL, by
75 calling (gnus-group-split-fancy nil nil CATCH-ALL).
77 If CATCH-ALL is nil, gnus-group-split-default-catch-all-group is used
78 instead. This variable is set by gnus-group-split-setup."
80 (setq nnmail-split-fancy
81 (gnus-group-split-fancy
82 nil (null nnmail-crosspost)
83 (or catch-all gnus-group-split-default-catch-all-group)))
84 (run-hooks 'gnus-group-split-updated-hook))
87 (defun gnus-group-split ()
88 "Uses information from group parameters in order to split mail.
89 See gnus-group-split-fancy for more information.
91 gnus-group-split is a valid value for nnmail-split-methods."
92 (let (nnmail-split-fancy)
93 (gnus-group-split-update)
94 (nnmail-split-fancy)))
97 (defun gnus-group-split-fancy
98 (&optional groups no-crosspost catch-all)
99 "Uses information from group parameters in order to split mail. It
100 can be embedded into nnmail-split-fancy lists with the SPLIT
102 \(: gnus-group-split-fancy GROUPS NO-CROSSPOST CATCH-ALL\)
104 GROUPS may be a regular expression or a list of group names, that will
105 be used to select candidate groups. If it is ommited or nil, all
106 existing groups are considered.
108 if NO-CROSSPOST is ommitted or nil, a & split will be returned,
109 otherwise, a | split, that does not allow crossposting, will be
112 For each selected group, a SPLIT is composed like this: if SPLIT-SPEC
113 is specified, this split is returned as-is (unless it is nil: in this
114 case, the group is ignored). Otherwise, if TO-ADDRESS, TO-LIST and/or
115 EXTRA-ALIASES are specified, a regexp that matches any of them is
116 constructed (extra-aliases may be a list). Additionally, if
117 SPLIT-REGEXP is specified, the regexp will be extended so that it
118 matches this regexp too, and if SPLIT-EXCLUDE is specified, RESTRICT
119 clauses will be generated.
121 If CATCH-ALL is nil, no catch-all handling is performed, regardless of
122 catch-all marks in group parameters. Otherwise, if there is no
123 selected group whose SPLIT-REGEXP matches the empty string, nor is
124 there a selected group whose SPLIT-SPEC is 'catch-all, this fancy
125 split (say, a group name) will be appended to the returned SPLIT list,
126 as the last element of a '| SPLIT.
128 For example, given the following group parameters:
131 \((to-address . \"bar@femail.com\")
132 (split-regexp . \".*@femail\\\\.com\"))
134 \((to-list . \"foo@nowhere.gov\")
135 (extra-aliases \"foo@localhost\" \"foo-redist@home\")
136 (split-exclude \"bugs-foo\" \"rambling-foo\")
137 (admin-address . \"foo-request@nowhere.gov\"))