(inhibit-frame-set-background-mode): New var.
[bpt/emacs.git] / lisp / gnus / nnmail.el
CommitLineData
eec82323 1;;; nnmail.el --- mail support functions for the Gnus mail backends
e84b4b86
TTN
2
3;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
e3fe4da0 4;; 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
eec82323 5
6748645f 6;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
eec82323
LMI
7;; Keywords: news, mail
8
9;; This file is part of GNU Emacs.
10
5e809f55 11;; GNU Emacs is free software: you can redistribute it and/or modify
eec82323 12;; it under the terms of the GNU General Public License as published by
5e809f55
GM
13;; the Free Software Foundation, either version 3 of the License, or
14;; (at your option) any later version.
eec82323
LMI
15
16;; GNU Emacs is distributed in the hope that it will be useful,
17;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19;; GNU General Public License for more details.
20
21;; You should have received a copy of the GNU General Public License
5e809f55 22;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
eec82323
LMI
23
24;;; Commentary:
25
26;;; Code:
27
163a3c6a
GM
28;; For Emacs < 22.2.
29(eval-and-compile
30 (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
31
0df953b6
RS
32(eval-when-compile (require 'cl))
33
23f87bed 34(require 'gnus) ; for macro gnus-kill-buffer, at least
eec82323 35(require 'nnheader)
eec82323 36(require 'message)
6748645f 37(require 'gnus-util)
16409b0b
GM
38(require 'mail-source)
39(require 'mm-util)
163a3c6a 40(require 'gnus-int)
eec82323 41
8abf1b22
GM
42(autoload 'gnus-add-buffer "gnus")
43(autoload 'gnus-kill-buffer "gnus")
eec82323
LMI
44
45(defgroup nnmail nil
46 "Reading mail with Gnus."
47 :group 'gnus)
48
49(defgroup nnmail-retrieve nil
50 "Retrieving new mail."
51 :group 'nnmail)
52
53(defgroup nnmail-prepare nil
e72c9bcc 54 "Preparing (or mangling) new mail after retrieval."
eec82323
LMI
55 :group 'nnmail)
56
57(defgroup nnmail-duplicate nil
58 "Handling of duplicate mail messages."
59 :group 'nnmail)
60
61(defgroup nnmail-split nil
8f688cb0 62 "Organizing the incoming mail in folders."
eec82323
LMI
63 :group 'nnmail)
64
65(defgroup nnmail-files nil
66 "Mail files."
67 :group 'gnus-files
68 :group 'nnmail)
69
70(defgroup nnmail-expire nil
71 "Expiring old mail."
72 :group 'nnmail)
73
74(defgroup nnmail-procmail nil
75 "Interfacing with procmail and other mail agents."
76 :group 'nnmail)
77
78(defgroup nnmail-various nil
79 "Various mail options."
80 :group 'nnmail)
81
23f87bed 82(defcustom nnmail-split-methods '(("mail.misc" ""))
6748645f 83 "*Incoming mail will be split according to this variable.
eec82323
LMI
84
85If you'd like, for instance, one mail group for mail from the
86\"4ad-l\" mailing list, one group for junk mail and one for everything
87else, you could do something like this:
88
89 (setq nnmail-split-methods
90 '((\"mail.4ad\" \"From:.*4ad\")
23f87bed
MB
91 (\"mail.junk\" \"From:.*Lars\\\\|Subject:.*buy\")
92 (\"mail.misc\" \"\")))
eec82323
LMI
93
94As you can see, this variable is a list of lists, where the first
95element in each \"rule\" is the name of the group (which, by the way,
96does not have to be called anything beginning with \"mail\",
97\"yonka.zow\" is a fine, fine name), and the second is a regexp that
98nnmail will try to match on the header to find a fit.
99
100The second element can also be a function. In that case, it will be
101called narrowed to the headers with the first element of the rule as
102the argument. It should return a non-nil value if it thinks that the
103mail belongs in that group.
104
105The last element should always have \"\" as the regexp.
106
107This variable can also have a function as its value."
108 :group 'nnmail-split
23f87bed
MB
109 :type '(choice (repeat :tag "Alist" (group (string :tag "Name")
110 (choice regexp function)))
eec82323
LMI
111 (function-item nnmail-split-fancy)
112 (function :tag "Other")))
113
114;; Suggested by Erik Selberg <speed@cs.washington.edu>.
115(defcustom nnmail-crosspost t
116 "If non-nil, do crossposting if several split methods match the mail.
117If nil, the first match found will be used."
118 :group 'nnmail-split
119 :type 'boolean)
120
23f87bed
MB
121(defcustom nnmail-split-fancy-with-parent-ignore-groups nil
122 "Regexp that matches group names to be ignored when applying `nnmail-split-fancy-with-parent'.
123This can also be a list of regexps."
bf247b6e 124 :version "22.1"
23f87bed
MB
125 :group 'nnmail-split
126 :type '(choice (const :tag "none" nil)
127 (regexp :value ".*")
128 (repeat :value (".*") regexp)))
129
130(defcustom nnmail-cache-ignore-groups nil
131 "Regexp that matches group names to be ignored when inserting message ids into the cache (`nnmail-cache-insert').
132This can also be a list of regexps."
bf247b6e 133 :version "22.1"
23f87bed
MB
134 :group 'nnmail-split
135 :type '(choice (const :tag "none" nil)
136 (regexp :value ".*")
137 (repeat :value (".*") regexp)))
138
eec82323
LMI
139;; Added by gord@enci.ucalgary.ca (Gordon Matzigkeit).
140(defcustom nnmail-keep-last-article nil
a8151ef7
LMI
141 "If non-nil, nnmail will never delete/move a group's last article.
142It can be marked expirable, so it will be deleted when it is no longer last.
143
eec82323
LMI
144You may need to set this variable if other programs are putting
145new mail into folder numbers that Gnus has marked as expired."
146 :group 'nnmail-procmail
147 :group 'nnmail-various
148 :type 'boolean)
149
150(defcustom nnmail-use-long-file-names nil
151 "If non-nil the mail backends will use long file and directory names.
152If nil, groups like \"mail.misc\" will end up in directories like
153\"mail/misc/\"."
154 :group 'nnmail-files
155 :type 'boolean)
156
157(defcustom nnmail-default-file-modes 384
158 "Set the mode bits of all new mail files to this integer."
159 :group 'nnmail-files
160 :type 'integer)
161
162(defcustom nnmail-expiry-wait 7
163 "*Expirable articles that are older than this will be expired.
164This variable can either be a number (which will be interpreted as a
165number of days) -- this doesn't have to be an integer. This variable
166can also be `immediate' and `never'."
167 :group 'nnmail-expire
168 :type '(choice (const immediate)
23f87bed 169 (number :tag "days")
eec82323
LMI
170 (const never)))
171
172(defcustom nnmail-expiry-wait-function nil
173 "Variable that holds function to specify how old articles should be before they are expired.
23f87bed
MB
174The function will be called with the name of the group that the expiry
175is to be performed in, and it should return an integer that says how
176many days an article can be stored before it is considered \"old\".
177It can also return the values `never' and `immediate'.
eec82323
LMI
178
179Eg.:
180
181\(setq nnmail-expiry-wait-function
182 (lambda (newsgroup)
23f87bed
MB
183 (cond ((string-match \"private\" newsgroup) 31)
184 ((string-match \"junk\" newsgroup) 1)
eec82323
LMI
185 ((string-match \"important\" newsgroup) 'never)
186 (t 7))))"
187 :group 'nnmail-expire
188 :type '(choice (const :tag "nnmail-expiry-wait" nil)
189 (function :format "%v" nnmail-)))
190
16409b0b
GM
191(defcustom nnmail-expiry-target 'delete
192 "*Variable that says where expired messages should end up.
193The default value is `delete' (which says to delete the messages),
194but it can also be a string or a function. If it is a string, expired
195messages end up in that group. If it is a function, the function is
196called in a buffer narrowed to the message in question. The function
197receives one argument, the name of the group the message comes from.
198The return value should be `delete' or a group name (a string)."
4693ed4e 199 :version "21.1"
23f87bed
MB
200 :group 'nnmail-expire
201 :type '(choice (const delete)
202 (function :format "%v" nnmail-)
203 string))
204
205(defcustom nnmail-fancy-expiry-targets nil
206 "Determine expiry target based on articles using fancy techniques.
207
208This is a list of (\"HEADER\" \"REGEXP\" \"TARGET\") entries. If
209`nnmail-expiry-target' is set to the function
210`nnmail-fancy-expiry-target' and HEADER of the article matches REGEXP,
211the message will be expired to a group determined by invoking
212`format-time-string' with TARGET used as the format string and the
213time extracted from the articles' Date header (if missing the current
214time is used).
215
216In the special cases that HEADER is the symbol `to-from', the regexp
217will try to match against both the From and the To header.
218
219Example:
220
221\(setq nnmail-fancy-expiry-targets
222 '((to-from \"boss\" \"nnfolder:Work\")
223 (\"Subject\" \"IMPORTANT\" \"nnfolder:IMPORTANT.%Y.%b\")
224 (\"from\" \".*\" \"nnfolder:Archive-%Y\")))
225
226In this case, articles containing the string \"boss\" in the To or the
227From header will be expired to the group \"nnfolder:Work\";
228articles containing the sting \"IMPORTANT\" in the Subject header will
229be expired to the group \"nnfolder:IMPORTANT.YYYY.MMM\"; and
230everything else will be expired to \"nnfolder:Archive-YYYY\"."
bf247b6e 231 :version "22.1"
23f87bed
MB
232 :group 'nnmail-expire
233 :type '(repeat (list (choice :tag "Match against"
234 (string :tag "Header")
235 (const to-from))
236 regexp
237 (string :tag "Target group format string"))))
16409b0b 238
eec82323 239(defcustom nnmail-cache-accepted-message-ids nil
23f87bed
MB
240 "If non-nil, put Message-IDs of Gcc'd articles into the duplicate cache.
241If non-nil, also update the cache when copy or move articles."
eec82323
LMI
242 :group 'nnmail
243 :type 'boolean)
244
8aed9ac5
RS
245(make-obsolete-variable 'nnmail-spool-file
246 "This option is obsolete in Gnus 5.9. \
247Use `mail-sources' instead.")
248;; revision 5.29 / p0-85 / Gnus 5.9
b890d447 249;; Variable removed in No Gnus v0.7
eec82323 250
16409b0b
GM
251(defcustom nnmail-resplit-incoming nil
252 "*If non-nil, re-split incoming procmail sorted mail."
eec82323
LMI
253 :group 'nnmail-procmail
254 :type 'boolean)
255
16409b0b
GM
256(defcustom nnmail-scan-directory-mail-source-once nil
257 "*If non-nil, scan all incoming procmail sorted mails once.
258It scans low-level sorted spools even when not required."
4693ed4e 259 :version "21.1"
eec82323
LMI
260 :group 'nnmail-procmail
261 :type 'boolean)
262
263(defcustom nnmail-delete-file-function 'delete-file
264 "Function called to delete files in some mail backends."
265 :group 'nnmail-files
266 :type 'function)
267
268(defcustom nnmail-crosspost-link-function
6748645f 269 (if (string-match "windows-nt\\|emx" (symbol-name system-type))
eec82323
LMI
270 'copy-file
271 'add-name-to-file)
6748645f 272 "*Function called to create a copy of a file.
eec82323
LMI
273This is `add-name-to-file' by default, which means that crossposts
274will use hard links. If your file system doesn't allow hard
275links, you could set this variable to `copy-file' instead."
276 :group 'nnmail-files
277 :type '(radio (function-item add-name-to-file)
278 (function-item copy-file)
279 (function :tag "Other")))
280
eec82323
LMI
281(defcustom nnmail-read-incoming-hook
282 (if (eq system-type 'windows-nt)
283 '(nnheader-ms-strip-cr)
284 nil)
6748645f 285 "*Hook that will be run after the incoming mail has been transferred.
8b93df01 286The incoming mail is moved from the specified spool file (which normally is
eec82323
LMI
287something like \"/usr/spool/mail/$user\") to the user's home
288directory. This hook is called after the incoming mail box has been
289emptied, and can be used to call any mail box programs you have
290running (\"xwatch\", etc.)
291
292Eg.
293
294\(add-hook 'nnmail-read-incoming-hook
23f87bed
MB
295 (lambda ()
296 (call-process \"/local/bin/mailsend\" nil nil nil
01c52d31
MB
297 \"read\"
298 ;; The incoming mail box file.
299 (expand-file-name (user-login-name)
300 rmail-spool-directory))))
eec82323
LMI
301
302If you have xwatch running, this will alert it that mail has been
303read.
304
305If you use `display-time', you could use something like this:
306
307\(add-hook 'nnmail-read-incoming-hook
308 (lambda ()
309 ;; Update the displayed time, since that will clear out
310 ;; the flag that says you have mail.
311 (when (eq (process-status \"display-time\") 'run)
312 (display-time-filter display-time-process \"\"))))"
313 :group 'nnmail-prepare
314 :type 'hook)
315
eec82323
LMI
316(defcustom nnmail-prepare-incoming-hook nil
317 "Hook called before treating incoming mail.
318The hook is run in a buffer with all the new, incoming mail."
319 :group 'nnmail-prepare
320 :type 'hook)
321
322(defcustom nnmail-prepare-incoming-header-hook nil
323 "Hook called narrowed to the headers of each message.
324This can be used to remove excessive spaces (and stuff like
325that) from the headers before splitting and saving the messages."
326 :group 'nnmail-prepare
327 :type 'hook)
328
329(defcustom nnmail-prepare-incoming-message-hook nil
330 "Hook called narrowed to each message."
331 :group 'nnmail-prepare
332 :type 'hook)
333
334(defcustom nnmail-list-identifiers nil
335 "Regexp that matches list identifiers to be removed.
336This can also be a list of regexps."
337 :group 'nnmail-prepare
338 :type '(choice (const :tag "none" nil)
6748645f
LMI
339 (regexp :value ".*")
340 (repeat :value (".*") regexp)))
eec82323
LMI
341
342(defcustom nnmail-pre-get-new-mail-hook nil
343 "Hook called just before starting to handle new incoming mail."
344 :group 'nnmail-retrieve
345 :type 'hook)
346
347(defcustom nnmail-post-get-new-mail-hook nil
348 "Hook called just after finishing handling new incoming mail."
349 :group 'nnmail-retrieve
350 :type 'hook)
351
352(defcustom nnmail-split-hook nil
353 "Hook called before deciding where to split an article.
354The functions in this hook are free to modify the buffer
355contents in any way they choose -- the buffer contents are
356discarded after running the split process."
357 :group 'nnmail-split
358 :type 'hook)
359
23f87bed
MB
360(defcustom nnmail-spool-hook nil
361 "*A hook called when a new article is spooled."
bf247b6e 362 :version "22.1"
23f87bed
MB
363 :group 'nnmail
364 :type 'hook)
365
eec82323 366(defcustom nnmail-large-newsgroup 50
23f87bed
MB
367 "*The number of articles which indicates a large newsgroup or nil.
368If the number of articles is greater than the value, verbose
eec82323
LMI
369messages will be shown to indicate the current status."
370 :group 'nnmail-various
23f87bed
MB
371 :type '(choice (const :tag "infinite" nil)
372 (number :tag "count")))
373
374(define-widget 'nnmail-lazy 'default
375 "Base widget for recursive datastructures.
376
bf247b6e 377This is copy of the `lazy' widget in Emacs 22.1 provided for compatibility."
23f87bed
MB
378 :format "%{%t%}: %v"
379 :convert-widget 'widget-value-convert-widget
380 :value-create (lambda (widget)
381 (let ((value (widget-get widget :value))
382 (type (widget-get widget :type)))
bf247b6e
KS
383 (widget-put widget :children
384 (list (widget-create-child-value
23f87bed
MB
385 widget (widget-convert type) value)))))
386 :value-delete 'widget-children-value-delete
387 :value-get (lambda (widget)
388 (widget-value (car (widget-get widget :children))))
389 :value-inline (lambda (widget)
390 (widget-apply (car (widget-get widget :children))
391 :value-inline))
392 :default-get (lambda (widget)
393 (widget-default-get
394 (widget-convert (widget-get widget :type))))
395 :match (lambda (widget value)
396 (widget-apply (widget-convert (widget-get widget :type))
397 :match value))
398 :validate (lambda (widget)
399 (widget-apply (car (widget-get widget :children)) :validate)))
400
401(define-widget 'nnmail-split-fancy 'nnmail-lazy
402 "Widget for customizing splits in the variable of the same name."
403 :tag "Split"
404 :type '(menu-choice :value (any ".*value.*" "misc")
405 :tag "Type"
406 (string :tag "Destination")
407 (list :tag "Use first match (|)" :value (|)
408 (const :format "" |)
409 (editable-list :inline t nnmail-split-fancy))
410 (list :tag "Use all matches (&)" :value (&)
411 (const :format "" &)
412 (editable-list :inline t nnmail-split-fancy))
413 (list :tag "Function with fixed arguments (:)"
01c52d31 414 :value (:)
23f87bed 415 (const :format "" :value :)
bf247b6e 416 function
23f87bed
MB
417 (editable-list :inline t (sexp :tag "Arg"))
418 )
419 (list :tag "Function with split arguments (!)"
01c52d31 420 :value (!)
23f87bed
MB
421 (const :format "" !)
422 function
423 (editable-list :inline t nnmail-split-fancy))
bf247b6e
KS
424 (list :tag "Field match"
425 (choice :tag "Field"
23f87bed
MB
426 regexp symbol)
427 (choice :tag "Match"
bf247b6e 428 regexp
23f87bed
MB
429 (symbol :value mail))
430 (repeat :inline t
431 :tag "Restrictions"
432 (group :inline t
433 (const :format "" -)
434 regexp))
435 nnmail-split-fancy)
436 (const :tag "Junk (delete mail)" junk)))
eec82323
LMI
437
438(defcustom nnmail-split-fancy "mail.misc"
439 "Incoming mail can be split according to this fancy variable.
440To enable this, set `nnmail-split-methods' to `nnmail-split-fancy'.
441
6748645f 442The format of this variable is SPLIT, where SPLIT can be one of
eec82323
LMI
443the following:
444
445GROUP: Mail will be stored in GROUP (a string).
446
16409b0b 447\(FIELD VALUE [- RESTRICT [- RESTRICT [...]]] SPLIT): If the message
a1506d29 448 field FIELD (a regexp) contains VALUE (a regexp), store the messages
16409b0b 449 as specified by SPLIT. If RESTRICT (a regexp) matches some string
f0529b5b 450 after FIELD and before the end of the matched VALUE, return nil,
16409b0b
GM
451 otherwise process SPLIT. Multiple RESTRICTs add up, further
452 restricting the possibility of processing SPLIT.
eec82323
LMI
453
454\(| SPLIT...): Process each SPLIT expression until one of them matches.
455 A SPLIT expression is said to match if it will cause the mail
456 message to be stored in one or more groups.
457
458\(& SPLIT...): Process each SPLIT expression.
459
460\(: FUNCTION optional args): Call FUNCTION with the optional args, in
461 the buffer containing the message headers. The return value FUNCTION
462 should be a split, which is then recursively processed.
463
16409b0b
GM
464\(! FUNCTION SPLIT): Call FUNCTION with the result of SPLIT. The
465 return value FUNCTION should be a split, which is then recursively
466 processed.
467
23f87bed
MB
468junk: Mail will be deleted. Use with care! Do not submerge in water!
469 Example:
470 (setq nnmail-split-fancy
471 '(| (\"Subject\" \"MAKE MONEY FAST\" junk)
472 ...other.rules.omitted...))
473
eec82323
LMI
474FIELD must match a complete field name. VALUE must match a complete
475word according to the `nnmail-split-fancy-syntax-table' syntax table.
476You can use \".*\" in the regexps to match partial field names or words.
477
01c52d31 478FIELD and VALUE can also be Lisp symbols, in that case they are expanded
eec82323
LMI
479as specified in `nnmail-split-abbrev-alist'.
480
481GROUP can contain \\& and \\N which will substitute from matching
482\\(\\) patterns in the previous VALUE.
483
484Example:
485
486\(setq nnmail-split-methods 'nnmail-split-fancy
487 nnmail-split-fancy
488 ;; Messages from the mailer daemon are not crossposted to any of
489 ;; the ordinary groups. Warnings are put in a separate group
490 ;; from real errors.
491 '(| (\"from\" mail (| (\"subject\" \"warn.*\" \"mail.warning\")
492 \"mail.misc\"))
493 ;; Non-error messages are crossposted to all relevant
494 ;; groups, but we don't crosspost between the group for the
495 ;; (ding) list and the group for other (ding) related mail.
496 (& (| (any \"ding@ifi\\\\.uio\\\\.no\" \"ding.list\")
497 (\"subject\" \"ding\" \"ding.misc\"))
498 ;; Other mailing lists...
499 (any \"procmail@informatik\\\\.rwth-aachen\\\\.de\" \"procmail.list\")
500 (any \"SmartList@informatik\\\\.rwth-aachen\\\\.de\" \"SmartList.list\")
23f87bed
MB
501 ;; Both lists below have the same suffix, so prevent
502 ;; cross-posting to mkpkg.list of messages posted only to
503 ;; the bugs- list, but allow cross-posting when the
504 ;; message was really cross-posted.
505 (any \"bugs-mypackage@somewhere\" \"mypkg.bugs\")
506 (any \"mypackage@somewhere\" - \"bugs-mypackage\" \"mypkg.list\")
507 ;;
eec82323
LMI
508 ;; People...
509 (any \"larsi@ifi\\\\.uio\\\\.no\" \"people.Lars Magne Ingebrigtsen\"))
510 ;; Unmatched mail goes to the catch all group.
511 \"misc.misc\"))"
512 :group 'nnmail-split
23f87bed 513 :type 'nnmail-split-fancy)
eec82323
LMI
514
515(defcustom nnmail-split-abbrev-alist
516 '((any . "from\\|to\\|cc\\|sender\\|apparently-to\\|resent-from\\|resent-to\\|resent-cc")
517 (mail . "mailer-daemon\\|postmaster\\|uucp")
518 (to . "to\\|cc\\|apparently-to\\|resent-to\\|resent-cc")
a8151ef7
LMI
519 (from . "from\\|sender\\|resent-from")
520 (nato . "to\\|cc\\|resent-to\\|resent-cc")
521 (naany . "from\\|to\\|cc\\|sender\\|resent-from\\|resent-to\\|resent-cc"))
6748645f 522 "*Alist of abbreviations allowed in `nnmail-split-fancy'."
eec82323
LMI
523 :group 'nnmail-split
524 :type '(repeat (cons :format "%v" symbol regexp)))
525
eec82323
LMI
526(defcustom nnmail-message-id-cache-length 1000
527 "*The approximate number of Message-IDs nnmail will keep in its cache.
528If this variable is nil, no checking on duplicate messages will be
529performed."
530 :group 'nnmail-duplicate
531 :type '(choice (const :tag "disable" nil)
532 (integer :format "%v")))
533
52bec650
MB
534(defcustom nnmail-message-id-cache-file
535 (nnheader-concat gnus-home-directory ".nnmail-cache")
536 "The file name of the nnmail Message-ID cache."
eec82323
LMI
537 :group 'nnmail-duplicate
538 :group 'nnmail-files
539 :type 'file)
540
541(defcustom nnmail-treat-duplicates 'warn
542 "*If non-nil, nnmail keep a cache of Message-IDs to discover mail duplicates.
16409b0b 543Three values are valid: nil, which means that nnmail is not to keep a
eec82323
LMI
544Message-ID cache; `warn', which means that nnmail should insert extra
545headers to warn the user about the duplication (this is the default);
546and `delete', which means that nnmail will delete duplicated mails.
547
548This variable can also be a function. It will be called from a buffer
549narrowed to the article in question with the Message-ID as a
550parameter. It should return nil, `warn' or `delete'."
551 :group 'nnmail-duplicate
552 :type '(choice (const :tag "off" nil)
553 (const warn)
554 (const delete)))
555
23f87bed 556(defcustom nnmail-extra-headers '(To Newsgroups)
16409b0b 557 "*Extra headers to parse."
4693ed4e 558 :version "21.1"
16409b0b
GM
559 :group 'nnmail
560 :type '(repeat symbol))
561
ad136a7c 562(defcustom nnmail-split-header-length-limit 2048
16409b0b 563 "Header lines longer than this limit are excluded from the split function."
4693ed4e 564 :version "21.1"
16409b0b
GM
565 :group 'nnmail
566 :type 'integer)
567
23f87bed
MB
568(defcustom nnmail-mail-splitting-charset nil
569 "Default charset to be used when splitting incoming mail."
bf247b6e 570 :version "22.1"
23f87bed
MB
571 :group 'nnmail
572 :type 'symbol)
573
574(defcustom nnmail-mail-splitting-decodes nil
575 "Whether the nnmail splitting functionality should MIME decode headers."
bf247b6e 576 :version "22.1"
23f87bed
MB
577 :group 'nnmail
578 :type 'boolean)
579
580(defcustom nnmail-split-fancy-match-partial-words nil
581 "Whether to match partial words when fancy splitting.
582Normally, regexes given in `nnmail-split-fancy' are implicitly surrounded
583by \"\\=\\<...\\>\". If this variable is true, they are not implicitly\
584 surrounded
585by anything."
bf247b6e 586 :version "22.1"
23f87bed
MB
587 :group 'nnmail
588 :type 'boolean)
589
590(defcustom nnmail-split-lowercase-expanded t
591 "Whether to lowercase expanded entries (i.e. \\N) when splitting mails.
592This avoids the creation of multiple groups when users send to an address
593using different case (i.e. mailing-list@domain vs Mailing-List@Domain)."
bf247b6e 594 :version "22.1"
23f87bed
MB
595 :group 'nnmail
596 :type 'boolean)
597
eec82323
LMI
598;;; Internal variables.
599
23f87bed
MB
600(defvar nnmail-article-buffer " *nnmail incoming*"
601 "The buffer used for splitting incoming mails.")
602
eec82323
LMI
603(defvar nnmail-split-history nil
604 "List of group/article elements that say where the previous split put messages.")
605
23f87bed
MB
606(defvar nnmail-split-fancy-syntax-table
607 (let ((table (make-syntax-table)))
608 ;; support the %-hack
609 (modify-syntax-entry ?\% "." table)
610 table)
eec82323 611 "Syntax table used by `nnmail-split-fancy'.")
eec82323
LMI
612
613(defvar nnmail-prepare-save-mail-hook nil
614 "Hook called before saving mail.")
615
6748645f
LMI
616(defvar nnmail-split-tracing nil)
617(defvar nnmail-split-trace nil)
618
eec82323
LMI
619\f
620
eec82323
LMI
621(defun nnmail-request-post (&optional server)
622 (mail-send-and-exit nil))
623
6748645f
LMI
624(defvar nnmail-file-coding-system 'raw-text
625 "Coding system used in nnmail.")
626
16409b0b
GM
627(defvar nnmail-incoming-coding-system
628 mm-text-coding-system
629 "Coding system used in reading inbox")
630
47e77e9f 631(defvar nnmail-pathname-coding-system nil
35ef97a5 632 "*Coding system for file name.")
1613b43a 633
eec82323
LMI
634(defun nnmail-find-file (file)
635 "Insert FILE in server buffer safely."
636 (set-buffer nntp-server-buffer)
16409b0b 637 (delete-region (point-min) (point-max))
eec82323 638 (let ((format-alist nil)
23f87bed 639 (after-insert-file-functions nil))
eec82323 640 (condition-case ()
1613b43a 641 (let ((coding-system-for-read nnmail-file-coding-system)
16409b0b
GM
642 (auto-mode-alist (mm-auto-mode-alist))
643 (file-name-coding-system nnmail-pathname-coding-system))
1613b43a
KH
644 (insert-file-contents file)
645 t)
eec82323
LMI
646 (file-error nil))))
647
648(defun nnmail-group-pathname (group dir &optional file)
35ef97a5 649 "Make file name for GROUP."
eec82323
LMI
650 (concat
651 (let ((dir (file-name-as-directory (expand-file-name dir))))
16409b0b
GM
652 (setq group (nnheader-replace-duplicate-chars-in-string
653 (nnheader-replace-chars-in-string group ?/ ?_)
654 ?. ?_))
6748645f 655 (setq group (nnheader-translate-file-chars group))
eec82323 656 ;; If this directory exists, we use it directly.
16409b0b
GM
657 (file-name-as-directory
658 (if (or nnmail-use-long-file-names
659 (file-directory-p (concat dir group)))
660 (expand-file-name group dir)
661 ;; If not, we translate dots into slashes.
662 (expand-file-name
01c52d31 663 (nnheader-replace-chars-in-string group ?. ?/)
16409b0b 664 dir))))
eec82323
LMI
665 (or file "")))
666
eec82323
LMI
667(defun nnmail-get-active ()
668 "Returns an assoc of group names and active ranges.
669nn*-request-list should have been called before calling this function."
16409b0b
GM
670 ;; Go through all groups from the active list.
671 (save-excursion
672 (set-buffer nntp-server-buffer)
673 (nnmail-parse-active)))
674
675(defun nnmail-parse-active ()
676 "Parse the active file in the current buffer and return an alist."
677 (goto-char (point-min))
678 (unless (re-search-forward "[\\\"]" nil t)
679 (goto-char (point-max))
680 (while (re-search-backward "[][';?()#]" nil t)
681 (insert ?\\)))
682 (goto-char (point-min))
683 (let ((buffer (current-buffer))
684 group-assoc group max min)
685 (while (not (eobp))
686 (condition-case err
687 (progn
01c52d31 688 (narrow-to-region (point) (point-at-eol))
16409b0b
GM
689 (setq group (read buffer))
690 (unless (stringp group)
691 (setq group (symbol-name group)))
23f87bed
MB
692 (if (and (numberp (setq max (read buffer)))
693 (numberp (setq min (read buffer))))
1428d46b 694 (push (list (mm-string-as-unibyte group) (cons min max))
16409b0b
GM
695 group-assoc)))
696 (error nil))
697 (widen)
698 (forward-line 1))
eec82323
LMI
699 group-assoc))
700
16409b0b 701(defvar nnmail-active-file-coding-system 'raw-text
1613b43a
KH
702 "*Coding system for active file.")
703
eec82323
LMI
704(defun nnmail-save-active (group-assoc file-name)
705 "Save GROUP-ASSOC in ACTIVE-FILE."
1613b43a
KH
706 (let ((coding-system-for-write nnmail-active-file-coding-system))
707 (when file-name
16409b0b 708 (with-temp-file file-name
1428d46b 709 (mm-disable-multibyte)
1613b43a 710 (nnmail-generate-active group-assoc)))))
eec82323
LMI
711
712(defun nnmail-generate-active (alist)
713 "Generate an active file from group-alist ALIST."
714 (erase-buffer)
715 (let (group)
716 (while (setq group (pop alist))
16409b0b
GM
717 (insert (format "%S %d %d y\n" (intern (car group)) (cdadr group)
718 (caadr group))))
719 (goto-char (point-max))
720 (while (search-backward "\\." nil t)
721 (delete-char 1))))
eec82323 722
16409b0b 723(defun nnmail-get-split-group (file source)
eec82323 724 "Find out whether this FILE is to be split into GROUP only.
16409b0b
GM
725If SOURCE is a directory spec, try to return the group name component."
726 (if (eq (car source) 'directory)
727 (let ((file (file-name-nondirectory file)))
728 (mail-source-bind (directory source)
729 (if (string-match (concat (regexp-quote suffix) "$") file)
730 (substring file 0 (match-beginning 0))
731 nil)))
732 nil))
eec82323
LMI
733
734(defun nnmail-process-babyl-mail-format (func artnum-func)
735 (let ((case-fold-search t)
16409b0b 736 (count 0)
eec82323 737 start message-id content-length do-search end)
eec82323 738 (while (not (eobp))
6748645f 739 (goto-char (point-min))
eec82323
LMI
740 (re-search-forward
741 "\f\n0, *unseen,+\n\\(\\*\\*\\* EOOH \\*\\*\\*\n\\)?" nil t)
742 (goto-char (match-end 0))
743 (delete-region (match-beginning 0) (match-end 0))
744 (narrow-to-region
745 (setq start (point))
746 (progn
747 ;; Skip all the headers in case there are more "From "s...
748 (or (search-forward "\n\n" nil t)
749 (search-forward-regexp "^[^:]*\\( .*\\|\\)$" nil t)
750 (search-forward "\1f\f"))
751 (point)))
752 ;; Unquote the ">From " line, if any.
753 (goto-char (point-min))
754 (when (looking-at ">From ")
755 (replace-match "X-From-Line: ") )
756 (run-hooks 'nnmail-prepare-incoming-header-hook)
757 (goto-char (point-max))
758 ;; Find the Message-ID header.
759 (save-excursion
760 (if (re-search-backward
761 "^Message-ID[ \t]*:[ \n\t]*\\(<[^>]*>\\)" nil t)
762 (setq message-id (buffer-substring (match-beginning 1)
763 (match-end 1)))
764 ;; There is no Message-ID here, so we create one.
765 (save-excursion
766 (when (re-search-backward "^Message-ID[ \t]*:" nil t)
767 (beginning-of-line)
768 (insert "Original-")))
769 (forward-line -1)
770 (insert "Message-ID: " (setq message-id (nnmail-message-id))
771 "\n")))
772 ;; Look for a Content-Length header.
773 (if (not (save-excursion
774 (and (re-search-backward
775 "^Content-Length:[ \t]*\\([0-9]+\\)" start t)
e9bd5782 776 (setq content-length (string-to-number
eec82323
LMI
777 (buffer-substring
778 (match-beginning 1)
779 (match-end 1))))
780 ;; We destroy the header, since none of
781 ;; the backends ever use it, and we do not
782 ;; want to confuse other mailers by having
783 ;; a (possibly) faulty header.
784 (progn (insert "X-") t))))
785 (setq do-search t)
786 (widen)
787 (if (or (= (+ (point) content-length) (point-max))
788 (save-excursion
789 (goto-char (+ (point) content-length))
790 (looking-at "\1f")))
791 (progn
792 (goto-char (+ (point) content-length))
793 (setq do-search nil))
794 (setq do-search t)))
795 (widen)
796 ;; Go to the beginning of the next article - or to the end
797 ;; of the buffer.
798 (when do-search
799 (if (re-search-forward "^\1f" nil t)
800 (goto-char (match-beginning 0))
801 (goto-char (1- (point-max)))))
802 (delete-char 1) ; delete ^_
803 (save-excursion
804 (save-restriction
805 (narrow-to-region start (point))
806 (goto-char (point-min))
807 (nnmail-check-duplication message-id func artnum-func)
16409b0b 808 (incf count)
eec82323 809 (setq end (point-max))))
16409b0b
GM
810 (goto-char end))
811 count))
eec82323
LMI
812
813(defsubst nnmail-search-unix-mail-delim ()
814 "Put point at the beginning of the next Unix mbox message."
b96fb65c 815 ;; Algorithm used to find the next article in the
eec82323
LMI
816 ;; brain-dead Unix mbox format:
817 ;;
818 ;; 1) Search for "^From ".
819 ;; 2) If we find it, then see whether the previous
820 ;; line is blank and the next line looks like a header.
821 ;; Then it's possible that this is a mail delim, and we use it.
822 (let ((case-fold-search nil)
823 found)
824 (while (not found)
825 (if (not (re-search-forward "^From " nil t))
826 (setq found 'no)
827 (save-excursion
828 (beginning-of-line)
829 (when (and (or (bobp)
830 (save-excursion
831 (forward-line -1)
16409b0b 832 (eq (char-after) ?\n)))
eec82323
LMI
833 (save-excursion
834 (forward-line 1)
a8151ef7 835 (while (looking-at ">From \\|From ")
eec82323
LMI
836 (forward-line 1))
837 (looking-at "[^ \n\t:]+[ \n\t]*:")))
838 (setq found 'yes)))))
839 (beginning-of-line)
840 (eq found 'yes)))
841
842(defun nnmail-search-unix-mail-delim-backward ()
843 "Put point at the beginning of the current Unix mbox message."
b96fb65c 844 ;; Algorithm used to find the next article in the
eec82323
LMI
845 ;; brain-dead Unix mbox format:
846 ;;
847 ;; 1) Search for "^From ".
848 ;; 2) If we find it, then see whether the previous
849 ;; line is blank and the next line looks like a header.
850 ;; Then it's possible that this is a mail delim, and we use it.
851 (let ((case-fold-search nil)
852 found)
853 (while (not found)
854 (if (not (re-search-backward "^From " nil t))
855 (setq found 'no)
856 (save-excursion
857 (beginning-of-line)
858 (when (and (or (bobp)
859 (save-excursion
860 (forward-line -1)
16409b0b 861 (eq (char-after) ?\n)))
eec82323
LMI
862 (save-excursion
863 (forward-line 1)
a8151ef7 864 (while (looking-at ">From \\|From ")
eec82323
LMI
865 (forward-line 1))
866 (looking-at "[^ \n\t:]+[ \n\t]*:")))
867 (setq found 'yes)))))
868 (beginning-of-line)
869 (eq found 'yes)))
870
871(defun nnmail-process-unix-mail-format (func artnum-func)
872 (let ((case-fold-search t)
16409b0b 873 (count 0)
eec82323
LMI
874 start message-id content-length end skip head-end)
875 (goto-char (point-min))
876 (if (not (and (re-search-forward "^From " nil t)
877 (goto-char (match-beginning 0))))
878 ;; Possibly wrong format?
23f87bed
MB
879 (error "Error, unknown mail format! (Possibly corrupted %s `%s'.)"
880 (if (buffer-file-name) "file" "buffer")
881 (or (buffer-file-name) (buffer-name)))
eec82323
LMI
882 ;; Carry on until the bitter end.
883 (while (not (eobp))
884 (setq start (point)
885 end nil)
886 ;; Find the end of the head.
887 (narrow-to-region
888 start
889 (if (search-forward "\n\n" nil t)
890 (1- (point))
891 ;; This will never happen, but just to be on the safe side --
892 ;; if there is no head-body delimiter, we search a bit manually.
893 (while (and (looking-at "From \\|[^ \t]+:")
894 (not (eobp)))
895 (forward-line 1))
896 (point)))
897 ;; Find the Message-ID header.
898 (goto-char (point-min))
899 (if (re-search-forward "^Message-ID[ \t]*:[ \n\t]*\\(<[^>]+>\\)" nil t)
900 (setq message-id (match-string 1))
901 (save-excursion
902 (when (re-search-forward "^Message-ID[ \t]*:" nil t)
903 (beginning-of-line)
904 (insert "Original-")))
905 ;; There is no Message-ID here, so we create one.
906 (forward-line 1)
907 (insert "Message-ID: " (setq message-id (nnmail-message-id)) "\n"))
908 ;; Look for a Content-Length header.
909 (goto-char (point-min))
910 (if (not (re-search-forward
911 "^Content-Length:[ \t]*\\([0-9]+\\)" nil t))
912 (setq content-length nil)
e9bd5782 913 (setq content-length (string-to-number (match-string 1)))
eec82323
LMI
914 ;; We destroy the header, since none of the backends ever
915 ;; use it, and we do not want to confuse other mailers by
916 ;; having a (possibly) faulty header.
917 (beginning-of-line)
918 (insert "X-"))
919 (run-hooks 'nnmail-prepare-incoming-header-hook)
920 ;; Find the end of this article.
921 (goto-char (point-max))
922 (widen)
923 (setq head-end (point))
924 ;; We try the Content-Length value. The idea: skip over the header
925 ;; separator, then check what happens content-length bytes into the
8f688cb0 926 ;; message body. This should be either the end of the buffer, the
eec82323
LMI
927 ;; message separator or a blank line followed by the separator.
928 ;; The blank line should probably be deleted. If neither of the
929 ;; three is met, the content-length header is probably invalid.
930 (when content-length
931 (forward-line 1)
932 (setq skip (+ (point) content-length))
933 (goto-char skip)
934 (cond ((or (= skip (point-max))
935 (= (1+ skip) (point-max)))
936 (setq end (point-max)))
937 ((looking-at "From ")
938 (setq end skip))
939 ((looking-at "[ \t]*\n\\(From \\)")
940 (setq end (match-beginning 1)))
941 (t (setq end nil))))
942 (if end
943 (goto-char end)
944 ;; No Content-Length, so we find the beginning of the next
945 ;; article or the end of the buffer.
946 (goto-char head-end)
947 (or (nnmail-search-unix-mail-delim)
948 (goto-char (point-max))))
949 ;; Allow the backend to save the article.
950 (save-excursion
951 (save-restriction
952 (narrow-to-region start (point))
953 (goto-char (point-min))
16409b0b 954 (incf count)
eec82323
LMI
955 (nnmail-check-duplication message-id func artnum-func)
956 (setq end (point-max))))
16409b0b
GM
957 (goto-char end)))
958 count))
eec82323
LMI
959
960(defun nnmail-process-mmdf-mail-format (func artnum-func)
961 (let ((delim "^\^A\^A\^A\^A$")
962 (case-fold-search t)
16409b0b 963 (count 0)
eec82323
LMI
964 start message-id end)
965 (goto-char (point-min))
966 (if (not (and (re-search-forward delim nil t)
967 (forward-line 1)))
968 ;; Possibly wrong format?
16409b0b 969 (error "Error, unknown mail format! (Possibly corrupted.)")
eec82323
LMI
970 ;; Carry on until the bitter end.
971 (while (not (eobp))
972 (setq start (point))
973 ;; Find the end of the head.
974 (narrow-to-region
975 start
976 (if (search-forward "\n\n" nil t)
977 (1- (point))
978 ;; This will never happen, but just to be on the safe side --
979 ;; if there is no head-body delimiter, we search a bit manually.
980 (while (and (looking-at "From \\|[^ \t]+:")
981 (not (eobp)))
982 (forward-line 1))
983 (point)))
984 ;; Find the Message-ID header.
985 (goto-char (point-min))
986 (if (re-search-forward "^Message-ID[ \t]*:[ \n\t]*\\(<[^>]+>\\)" nil t)
987 (setq message-id (match-string 1))
988 ;; There is no Message-ID here, so we create one.
989 (save-excursion
990 (when (re-search-backward "^Message-ID[ \t]*:" nil t)
991 (beginning-of-line)
992 (insert "Original-")))
993 (forward-line 1)
994 (insert "Message-ID: " (setq message-id (nnmail-message-id)) "\n"))
995 (run-hooks 'nnmail-prepare-incoming-header-hook)
996 ;; Find the end of this article.
997 (goto-char (point-max))
998 (widen)
999 (if (re-search-forward delim nil t)
1000 (beginning-of-line)
1001 (goto-char (point-max)))
1002 ;; Allow the backend to save the article.
1003 (save-excursion
1004 (save-restriction
1005 (narrow-to-region start (point))
1006 (goto-char (point-min))
16409b0b 1007 (incf count)
eec82323
LMI
1008 (nnmail-check-duplication message-id func artnum-func)
1009 (setq end (point-max))))
1010 (goto-char end)
16409b0b
GM
1011 (forward-line 2)))
1012 count))
1013
1014(defun nnmail-process-maildir-mail-format (func artnum-func)
1015 ;; In a maildir, every file contains exactly one mail.
1016 (let ((case-fold-search t)
1017 message-id)
1018 (goto-char (point-min))
1019 ;; Find the end of the head.
1020 (narrow-to-region
1021 (point-min)
1022 (if (search-forward "\n\n" nil t)
1023 (1- (point))
1024 ;; This will never happen, but just to be on the safe side --
1025 ;; if there is no head-body delimiter, we search a bit manually.
1026 (while (and (looking-at "From \\|[^ \t]+:")
1027 (not (eobp)))
1028 (forward-line 1))
1029 (point)))
1030 ;; Find the Message-ID header.
1031 (goto-char (point-min))
1032 (if (re-search-forward "^Message-ID:[ \t]*\\(<[^>]+>\\)" nil t)
1033 (setq message-id (match-string 1))
1034 ;; There is no Message-ID here, so we create one.
1035 (save-excursion
1036 (when (re-search-backward "^Message-ID[ \t]*:" nil t)
1037 (beginning-of-line)
1038 (insert "Original-")))
1039 (forward-line 1)
1040 (insert "Message-ID: " (setq message-id (nnmail-message-id)) "\n"))
1041 (run-hooks 'nnmail-prepare-incoming-header-hook)
1042 ;; Allow the backend to save the article.
1043 (widen)
1044 (save-excursion
1045 (goto-char (point-min))
1046 (nnmail-check-duplication message-id func artnum-func))
1047 1))
eec82323 1048
01c52d31
MB
1049(defvar nnmail-group-names-not-encoded-p nil
1050 "Non-nil means group names are not encoded.")
1051
eec82323
LMI
1052(defun nnmail-split-incoming (incoming func &optional exit-func
1053 group artnum-func)
1054 "Go through the entire INCOMING file and pick out each individual mail.
1055FUNC will be called with the buffer narrowed to each mail."
23f87bed 1056 (let ( ;; If this is a group-specific split, we bind the split
eec82323
LMI
1057 ;; methods to just this group.
1058 (nnmail-split-methods (if (and group
eec82323
LMI
1059 (not nnmail-resplit-incoming))
1060 (list (list group ""))
01c52d31
MB
1061 nnmail-split-methods))
1062 (nnmail-group-names-not-encoded-p t))
eec82323
LMI
1063 (save-excursion
1064 ;; Insert the incoming file.
23f87bed 1065 (set-buffer (get-buffer-create nnmail-article-buffer))
eec82323 1066 (erase-buffer)
16409b0b
GM
1067 (let ((coding-system-for-read nnmail-incoming-coding-system))
1068 (mm-insert-file-contents incoming))
1069 (prog1
1070 (if (zerop (buffer-size))
1071 0
1072 (goto-char (point-min))
1073 (save-excursion (run-hooks 'nnmail-prepare-incoming-hook))
1074 ;; Handle both babyl, MMDF and unix mail formats, since
1075 ;; movemail will use the former when fetching from a
1076 ;; mailbox, the latter when fetching from a file.
1077 (cond ((or (looking-at "\^L")
1078 (looking-at "BABYL OPTIONS:"))
1079 (nnmail-process-babyl-mail-format func artnum-func))
1080 ((looking-at "\^A\^A\^A\^A")
1081 (nnmail-process-mmdf-mail-format func artnum-func))
1082 ((looking-at "Return-Path:")
1083 (nnmail-process-maildir-mail-format func artnum-func))
1084 (t
1085 (nnmail-process-unix-mail-format func artnum-func))))
1086 (when exit-func
1087 (funcall exit-func))
1088 (kill-buffer (current-buffer))))))
eec82323 1089
6748645f 1090(defun nnmail-article-group (func &optional trace)
eec82323
LMI
1091 "Look at the headers and return an alist of groups that match.
1092FUNC will be called with the group name to determine the article number."
23f87bed 1093 (let ((methods (or nnmail-split-methods '(("bogus" ""))))
eec82323 1094 (obuf (current-buffer))
23f87bed 1095 group-art method grp)
6748645f
LMI
1096 (if (and (sequencep methods)
1097 (= (length methods) 1))
eec82323
LMI
1098 ;; If there is only just one group to put everything in, we
1099 ;; just return a list with just this one method in.
1100 (setq group-art
1101 (list (cons (caar methods) (funcall func (caar methods)))))
1102 ;; We do actual comparison.
1103 (save-excursion
23f87bed 1104 ;; Copy the article into the work buffer.
eec82323
LMI
1105 (set-buffer nntp-server-buffer)
1106 (erase-buffer)
23f87bed
MB
1107 (insert-buffer-substring obuf)
1108 ;; Narrow to headers.
1109 (narrow-to-region
1110 (goto-char (point-min))
1111 (if (search-forward "\n\n" nil t)
1112 (point)
1113 (point-max)))
1114 (goto-char (point-min))
1115 ;; Decode MIME headers and charsets.
1116 (when nnmail-mail-splitting-decodes
1117 (let ((mail-parse-charset nnmail-mail-splitting-charset))
1118 (mail-decode-encoded-word-region (point-min) (point-max))))
eec82323
LMI
1119 ;; Fold continuation lines.
1120 (goto-char (point-min))
1121 (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
1122 (replace-match " " t t))
6748645f
LMI
1123 ;; Nuke pathologically long headers. Since Gnus applies
1124 ;; pathologically complex regexps to the buffer, lines
1125 ;; that are looong will take longer than the Universe's
1126 ;; existence to process.
1127 (goto-char (point-min))
1128 (while (not (eobp))
16409b0b
GM
1129 (unless (< (move-to-column nnmail-split-header-length-limit)
1130 nnmail-split-header-length-limit)
01c52d31 1131 (delete-region (point) (point-at-eol)))
16409b0b 1132 (forward-line 1))
eec82323 1133 ;; Allow washing.
6748645f 1134 (goto-char (point-min))
eec82323 1135 (run-hooks 'nnmail-split-hook)
6748645f
LMI
1136 (when (setq nnmail-split-tracing trace)
1137 (setq nnmail-split-trace nil))
eec82323
LMI
1138 (if (and (symbolp nnmail-split-methods)
1139 (fboundp nnmail-split-methods))
1140 (let ((split
06dc8321 1141 (condition-case error-info
a8151ef7
LMI
1142 ;; `nnmail-split-methods' is a function, so we
1143 ;; just call this function here and use the
1144 ;; result.
eec82323
LMI
1145 (or (funcall nnmail-split-methods)
1146 '("bogus"))
1147 (error
23f87bed 1148 (nnheader-message
06dc8321 1149 5 "Error in `nnmail-split-methods'; using `bogus' mail group: %S" error-info)
eec82323
LMI
1150 (sit-for 1)
1151 '("bogus")))))
8753ddee 1152 (setq split (mm-delete-duplicates split))
a8151ef7
LMI
1153 ;; The article may be "cross-posted" to `junk'. What
1154 ;; to do? Just remove the `junk' spec. Don't really
1155 ;; see anything else to do...
1156 (let (elem)
1157 (while (setq elem (car (memq 'junk split)))
1158 (setq split (delq elem split))))
1159 (when split
eec82323
LMI
1160 (setq group-art
1161 (mapcar
1162 (lambda (group) (cons group (funcall func group)))
1163 split))))
1164 ;; Go through the split methods to find a match.
6748645f
LMI
1165 (while (and methods
1166 (or nnmail-crosspost
1167 (not group-art)))
eec82323 1168 (goto-char (point-max))
6748645f 1169 (setq method (pop methods)
16409b0b 1170 grp (car method))
eec82323
LMI
1171 (if (or methods
1172 (not (equal "" (nth 1 method))))
1173 (when (and
1174 (ignore-errors
1175 (if (stringp (nth 1 method))
16409b0b
GM
1176 (let ((expand (string-match "\\\\[0-9&]" grp))
1177 (pos (re-search-backward (cadr method)
1178 nil t)))
1179 (and expand
1180 (setq grp (nnmail-expand-newtext grp)))
1181 pos)
eec82323 1182 ;; Function to say whether this is a match.
16409b0b 1183 (funcall (nth 1 method) grp)))
eec82323
LMI
1184 ;; Don't enter the article into the same
1185 ;; group twice.
16409b0b
GM
1186 (not (assoc grp group-art)))
1187 (push (cons grp (funcall func grp))
eec82323
LMI
1188 group-art))
1189 ;; This is the final group, which is used as a
1190 ;; catch-all.
1191 (unless group-art
1192 (setq group-art
1193 (list (cons (car method)
23f87bed
MB
1194 (funcall func (car method))))))))
1195 ;; Fall back on "bogus" if all else fails.
1196 (unless group-art
1197 (setq group-art (list (cons "bogus" (funcall func "bogus"))))))
6748645f
LMI
1198 ;; Produce a trace if non-empty.
1199 (when (and trace nnmail-split-trace)
23f87bed 1200 (let ((restore (current-buffer)))
6748645f
LMI
1201 (nnheader-set-temp-buffer "*Split Trace*")
1202 (gnus-add-buffer)
23f87bed
MB
1203 (dolist (trace (nreverse nnmail-split-trace))
1204 (prin1 trace (current-buffer))
1205 (insert "\n"))
6748645f
LMI
1206 (goto-char (point-min))
1207 (gnus-configure-windows 'split-trace)
1208 (set-buffer restore)))
23f87bed 1209 (widen)
eec82323
LMI
1210 ;; See whether the split methods returned `junk'.
1211 (if (equal group-art '(junk))
1212 nil
a8151ef7
LMI
1213 ;; The article may be "cross-posted" to `junk'. What
1214 ;; to do? Just remove the `junk' spec. Don't really
1215 ;; see anything else to do...
1216 (let (elem)
1217 (while (setq elem (car (memq 'junk group-art)))
1218 (setq group-art (delq elem group-art)))
1219 (nreverse group-art)))))))
eec82323
LMI
1220
1221(defun nnmail-insert-lines ()
1222 "Insert how many lines there are in the body of the mail.
1223Return the number of characters in the body."
1224 (let (lines chars)
1225 (save-excursion
1226 (goto-char (point-min))
a1506d29 1227 (unless (search-forward "\n\n" nil t)
16409b0b
GM
1228 (goto-char (point-max))
1229 (insert "\n"))
1230 (setq chars (- (point-max) (point)))
1231 (setq lines (count-lines (point) (point-max)))
1232 (forward-char -1)
1233 (save-excursion
1234 (when (re-search-backward "^Lines: " nil t)
1235 (delete-region (point) (progn (forward-line 1) (point)))))
1236 (beginning-of-line)
1237 (insert (format "Lines: %d\n" (max lines 0)))
1238 chars)))
eec82323
LMI
1239
1240(defun nnmail-insert-xref (group-alist)
1241 "Insert an Xref line based on the (group . article) alist."
1242 (save-excursion
1243 (goto-char (point-min))
16409b0b
GM
1244 (unless (search-forward "\n\n" nil t)
1245 (goto-char (point-max))
1246 (insert "\n"))
1247 (forward-char -1)
1248 (when (re-search-backward "^Xref: " nil t)
1249 (delete-region (match-beginning 0)
1250 (progn (forward-line 1) (point))))
1251 (insert (format "Xref: %s" (system-name)))
1252 (while group-alist
01c52d31
MB
1253 (insert (if (mm-multibyte-p)
1254 (mm-string-as-multibyte
1255 (format " %s:%d" (caar group-alist) (cdar group-alist)))
1256 (mm-string-as-unibyte
1257 (format " %s:%d" (caar group-alist) (cdar group-alist)))))
16409b0b
GM
1258 (setq group-alist (cdr group-alist)))
1259 (insert "\n")))
eec82323
LMI
1260
1261;;; Message washing functions
1262
1263(defun nnmail-remove-leading-whitespace ()
1264 "Remove excessive whitespace from all headers."
1265 (goto-char (point-min))
1266 (while (re-search-forward "^\\([^ :]+: \\) +" nil t)
1267 (replace-match "\\1" t)))
1268
1269(defun nnmail-remove-list-identifiers ()
1270 "Remove list identifiers from Subject headers."
23f87bed
MB
1271 (let ((regexp
1272 (if (consp nnmail-list-identifiers)
1273 (mapconcat 'identity nnmail-list-identifiers " *\\|")
1274 nnmail-list-identifiers)))
eec82323
LMI
1275 (when regexp
1276 (goto-char (point-min))
23f87bed
MB
1277 (while (re-search-forward
1278 (concat "^Subject: +\\(R[Ee]: +\\)*\\(" regexp " *\\)")
1279 nil t)
1280 (delete-region (match-beginning 2) (match-end 0))
1281 (beginning-of-line))
1282 (when (re-search-forward "^Subject: +\\(\\(R[Ee]: +\\)+\\)R[Ee]: +"
1283 nil t)
1284 (delete-region (match-beginning 1) (match-end 1))
1285 (beginning-of-line)))))
eec82323
LMI
1286
1287(defun nnmail-remove-tabs ()
1288 "Translate TAB characters into SPACE characters."
1289 (subst-char-in-region (point-min) (point-max) ?\t ? t))
1290
01c52d31
MB
1291(defcustom nnmail-broken-references-mailers
1292 "^X-Mailer:.*\\(Eudora\\|Pegasus\\)"
1293 "Header line matching mailer producing bogus References lines.
1294See `nnmail-ignore-broken-references'."
1295 :group 'nnmail-prepare
330f707b 1296 :version "23.1" ;; No Gnus
01c52d31
MB
1297 :type 'regexp)
1298
1299(defun nnmail-ignore-broken-references ()
1300 "Ignore the References line and use In-Reply-To
1301
1302Eudora has a broken References line, but an OK In-Reply-To."
16409b0b 1303 (goto-char (point-min))
01c52d31 1304 (when (re-search-forward nnmail-broken-references-mailers nil t)
16409b0b
GM
1305 (goto-char (point-min))
1306 (when (re-search-forward "^References:" nil t)
1307 (beginning-of-line)
1308 (insert "X-Gnus-Broken-Eudora-"))
1309 (goto-char (point-min))
23f87bed
MB
1310 (when (re-search-forward "^\\(In-Reply-To:[^\n]+\\)\n[ \t]+" nil t)
1311 (replace-match "\\1" t))))
eec82323 1312
01c52d31
MB
1313(defalias 'nnmail-fix-eudora-headers 'nnmail-ignore-broken-references)
1314(make-obsolete 'nnmail-fix-eudora-headers 'nnmail-ignore-broken-references)
1315
16409b0b 1316(custom-add-option 'nnmail-prepare-incoming-header-hook
01c52d31 1317 'nnmail-ignore-broken-references)
eec82323 1318
16409b0b 1319;;; Utility functions
eec82323 1320
163a3c6a
GM
1321(declare-function gnus-activate-group "gnus-start"
1322 (group &optional scan dont-check method))
1323
23f87bed
MB
1324(defun nnmail-do-request-post (accept-func &optional server)
1325 "Utility function to directly post a message to an nnmail-derived group.
1326Calls ACCEPT-FUNC (which should be `nnchoke-request-accept-article')
1327to actually put the message in the right group."
1328 (let ((success t))
1329 (dolist (mbx (message-unquote-tokens
1330 (message-tokenize-header
1331 (message-fetch-field "Newsgroups") ", ")) success)
1332 (let ((to-newsgroup (gnus-group-prefixed-name mbx gnus-command-method)))
1333 (or (gnus-active to-newsgroup)
1334 (gnus-activate-group to-newsgroup)
1335 (if (gnus-y-or-n-p (format "No such group: %s. Create it? "
1336 to-newsgroup))
1337 (or (and (gnus-request-create-group
1338 to-newsgroup gnus-command-method)
1339 (gnus-activate-group to-newsgroup nil nil
1340 gnus-command-method))
1341 (error "Couldn't create group %s" to-newsgroup)))
1342 (error "No such group: %s" to-newsgroup))
1343 (unless (funcall accept-func mbx (nth 1 gnus-command-method))
1344 (setq success nil))))))
1345
eec82323
LMI
1346(defun nnmail-split-fancy ()
1347 "Fancy splitting method.
23f87bed 1348See the documentation for the variable `nnmail-split-fancy' for details."
01c52d31
MB
1349 (with-syntax-table nnmail-split-fancy-syntax-table
1350 (nnmail-split-it nnmail-split-fancy)))
eec82323
LMI
1351
1352(defvar nnmail-split-cache nil)
1353;; Alist of split expressions their equivalent regexps.
1354
1355(defun nnmail-split-it (split)
1356 ;; Return a list of groups matching SPLIT.
6748645f
LMI
1357 (let (cached-pair)
1358 (cond
1359 ;; nil split
1360 ((null split)
1361 nil)
1362
1363 ;; A group name. Do the \& and \N subs into the string.
1364 ((stringp split)
1365 (when nnmail-split-tracing
23f87bed 1366 (push split nnmail-split-trace))
6748645f
LMI
1367 (list (nnmail-expand-newtext split)))
1368
1369 ;; Junk the message.
1370 ((eq split 'junk)
1371 (when nnmail-split-tracing
1372 (push "junk" nnmail-split-trace))
1373 (list 'junk))
1374
1375 ;; Builtin & operation.
1376 ((eq (car split) '&)
1377 (apply 'nconc (mapcar 'nnmail-split-it (cdr split))))
1378
1379 ;; Builtin | operation.
1380 ((eq (car split) '|)
1381 (let (done)
1382 (while (and (not done) (cdr split))
1383 (setq split (cdr split)
1384 done (nnmail-split-it (car split))))
1385 done))
1386
1387 ;; Builtin : operation.
1388 ((eq (car split) ':)
23f87bed
MB
1389 (when nnmail-split-tracing
1390 (push split nnmail-split-trace))
6748645f
LMI
1391 (nnmail-split-it (save-excursion (eval (cdr split)))))
1392
16409b0b
GM
1393 ;; Builtin ! operation.
1394 ((eq (car split) '!)
1395 (funcall (cadr split) (nnmail-split-it (caddr split))))
1396
6748645f
LMI
1397 ;; Check the cache for the regexp for this split.
1398 ((setq cached-pair (assq split nnmail-split-cache))
16409b0b
GM
1399 (let (split-result
1400 (end-point (point-max))
1401 (value (nth 1 split)))
1402 (if (symbolp value)
1403 (setq value (cdr (assq value nnmail-split-abbrev-alist))))
1404 (while (and (goto-char end-point)
1405 (re-search-backward (cdr cached-pair) nil t))
1406 (when nnmail-split-tracing
23f87bed 1407 (push split nnmail-split-trace))
16409b0b
GM
1408 (let ((split-rest (cddr split))
1409 (end (match-end 0))
23f87bed
MB
1410 ;; The searched regexp is \(\(FIELD\).*\)\(VALUE\).
1411 ;; So, start-of-value is the point just before the
1412 ;; beginning of the value, whereas after-header-name
1413 ;; is the point just after the field name.
16409b0b
GM
1414 (start-of-value (match-end 1))
1415 (after-header-name (match-end 2)))
1416 ;; Start the next search just before the beginning of the
1417 ;; VALUE match.
1418 (setq end-point (1- start-of-value))
1419 ;; Handle - RESTRICTs
1420 (while (eq (car split-rest) '-)
1421 ;; RESTRICT must start after-header-name and
1422 ;; end after start-of-value, so that, for
1423 ;; (any "foo" - "x-foo" "foo.list")
1424 ;; we do not exclude foo.list just because
1425 ;; the header is: ``To: x-foo, foo''
1426 (goto-char end)
1427 (if (and (re-search-backward (cadr split-rest)
1428 after-header-name t)
1429 (> (match-end 0) start-of-value))
1430 (setq split-rest nil)
1431 (setq split-rest (cddr split-rest))))
1432 (when split-rest
1433 (goto-char end)
1434 (let ((value (nth 1 split)))
1435 (if (symbolp value)
1436 (setq value (cdr (assq value nnmail-split-abbrev-alist))))
1437 ;; Someone might want to do a \N sub on this match, so get the
1438 ;; correct match positions.
1439 (re-search-backward value start-of-value))
1440 (dolist (sp (nnmail-split-it (car split-rest)))
23f87bed 1441 (unless (member sp split-result)
16409b0b
GM
1442 (push sp split-result))))))
1443 split-result))
6748645f
LMI
1444
1445 ;; Not in cache, compute a regexp for the field/value pair.
1446 (t
61e66a15
MB
1447 (let ((field (nth 0 split))
1448 (value (nth 1 split))
1449 (split-rest (cddr split))
1450 partial-front
1451 partial-rear
1452 regexp)
16409b0b
GM
1453 (if (symbolp value)
1454 (setq value (cdr (assq value nnmail-split-abbrev-alist))))
1455 (if (and (>= (length value) 2)
1456 (string= ".*" (substring value 0 2)))
1457 (setq value (substring value 2)
23f87bed
MB
1458 partial-front ""))
1459 ;; Same trick for the rear of the regexp
1460 (if (and (>= (length value) 2)
1461 (string= ".*" (substring value -2)))
1462 (setq value (substring value 0 -2)
1463 partial-rear ""))
61e66a15
MB
1464 ;; Invert the match-partial-words behavior if the optional
1465 ;; last element is specified.
1466 (while (eq (car split-rest) '-)
1467 (setq split-rest (cddr split-rest)))
1468 (when (if (cadr split-rest)
1469 (not nnmail-split-fancy-match-partial-words)
1470 nnmail-split-fancy-match-partial-words)
23f87bed
MB
1471 (setq partial-front ""
1472 partial-rear ""))
16409b0b 1473 (setq regexp (concat "^\\(\\("
6748645f
LMI
1474 (if (symbolp field)
1475 (cdr (assq field nnmail-split-abbrev-alist))
1476 field)
16409b0b 1477 "\\):.*\\)"
23f87bed 1478 (or partial-front "\\<")
16409b0b
GM
1479 "\\("
1480 value
23f87bed
MB
1481 "\\)"
1482 (or partial-rear "\\>")))
6748645f
LMI
1483 (push (cons split regexp) nnmail-split-cache)
1484 ;; Now that it's in the cache, just call nnmail-split-it again
61e66a15 1485 ;; on the same split, which will find it immediately in the cache.
6748645f 1486 (nnmail-split-it split))))))
eec82323
LMI
1487
1488(defun nnmail-expand-newtext (newtext)
1489 (let ((len (length newtext))
1490 (pos 0)
1491 c expanded beg N did-expand)
1492 (while (< pos len)
1493 (setq beg pos)
1494 (while (and (< pos len)
1495 (not (= (aref newtext pos) ?\\)))
1496 (setq pos (1+ pos)))
1497 (unless (= beg pos)
1498 (push (substring newtext beg pos) expanded))
1499 (when (< pos len)
6748645f
LMI
1500 ;; We hit a \; expand it.
1501 (setq did-expand t
1502 pos (1+ pos)
1503 c (aref newtext pos))
eec82323
LMI
1504 (if (not (or (= c ?\&)
1505 (and (>= c ?1)
1506 (<= c ?9))))
6748645f 1507 ;; \ followed by some character we don't expand.
eec82323
LMI
1508 (push (char-to-string c) expanded)
1509 ;; \& or \N
1510 (if (= c ?\&)
1511 (setq N 0)
1512 (setq N (- c ?0)))
1513 (when (match-beginning N)
23f87bed
MB
1514 (push (if nnmail-split-lowercase-expanded
1515 (downcase (buffer-substring (match-beginning N)
1516 (match-end N)))
1517 (buffer-substring (match-beginning N) (match-end N)))
eec82323
LMI
1518 expanded))))
1519 (setq pos (1+ pos)))
1520 (if did-expand
1521 (apply 'concat (nreverse expanded))
1522 newtext)))
1523
eec82323
LMI
1524;; Activate a backend only if it isn't already activated.
1525;; If FORCE, re-read the active file even if the backend is
1526;; already activated.
1527(defun nnmail-activate (backend &optional force)
6748645f 1528 (nnheader-init-server-buffer)
eec82323
LMI
1529 (let (file timestamp file-time)
1530 (if (or (not (symbol-value (intern (format "%s-group-alist" backend))))
1531 force
1532 (and (setq file (ignore-errors
1533 (symbol-value (intern (format "%s-active-file"
1534 backend)))))
1535 (setq file-time (nth 5 (file-attributes file)))
1536 (or (not
1537 (setq timestamp
1538 (condition-case ()
1539 (symbol-value (intern
1540 (format "%s-active-timestamp"
1541 backend)))
1542 (error 'none))))
1543 (not (consp timestamp))
1544 (equal timestamp '(0 0))
1545 (> (nth 0 file-time) (nth 0 timestamp))
1546 (and (= (nth 0 file-time) (nth 0 timestamp))
1547 (> (nth 1 file-time) (nth 1 timestamp))))))
1548 (save-excursion
1549 (or (eq timestamp 'none)
1550 (set (intern (format "%s-active-timestamp" backend))
1551 file-time))
1552 (funcall (intern (format "%s-request-list" backend)))))
1553 t))
1554
1555(defun nnmail-message-id ()
1556 (concat "<" (message-unique-id) "@totally-fudged-out-message-id>"))
1557
1558;;;
1559;;; nnmail duplicate handling
1560;;;
1561
1562(defvar nnmail-cache-buffer nil)
1563
1564(defun nnmail-cache-open ()
1565 (if (or (not nnmail-treat-duplicates)
1566 (and nnmail-cache-buffer
1567 (buffer-name nnmail-cache-buffer)))
1568 () ; The buffer is open.
1569 (save-excursion
1570 (set-buffer
1571 (setq nnmail-cache-buffer
1572 (get-buffer-create " *nnmail message-id cache*")))
23f87bed 1573 (gnus-add-buffer)
eec82323
LMI
1574 (when (file-exists-p nnmail-message-id-cache-file)
1575 (nnheader-insert-file-contents nnmail-message-id-cache-file))
1576 (set-buffer-modified-p nil)
1577 (current-buffer))))
1578
1579(defun nnmail-cache-close ()
1580 (when (and nnmail-cache-buffer
1581 nnmail-treat-duplicates
1582 (buffer-name nnmail-cache-buffer)
1583 (buffer-modified-p nnmail-cache-buffer))
1584 (save-excursion
1585 (set-buffer nnmail-cache-buffer)
1586 ;; Weed out the excess number of Message-IDs.
1587 (goto-char (point-max))
1588 (when (search-backward "\n" nil t nnmail-message-id-cache-length)
1589 (progn
1590 (beginning-of-line)
1591 (delete-region (point-min) (point))))
1592 ;; Save the buffer.
1593 (or (file-exists-p (file-name-directory nnmail-message-id-cache-file))
1594 (make-directory (file-name-directory nnmail-message-id-cache-file)
1595 t))
1596 (nnmail-write-region (point-min) (point-max)
1597 nnmail-message-id-cache-file nil 'silent)
1598 (set-buffer-modified-p nil)
1599 (setq nnmail-cache-buffer nil)
23f87bed 1600 (gnus-kill-buffer (current-buffer)))))
eec82323 1601
16409b0b
GM
1602;; Compiler directives.
1603(defvar group)
1604(defvar group-art-list)
1605(defvar group-art)
23f87bed
MB
1606(defun nnmail-cache-insert (id grp &optional subject sender)
1607 (when (stringp id)
1608 ;; this will handle cases like `B r' where the group is nil
1609 (let ((grp (or grp gnus-newsgroup-name "UNKNOWN")))
bf247b6e 1610 (run-hook-with-args 'nnmail-spool-hook
23f87bed
MB
1611 id grp subject sender))
1612 (when nnmail-treat-duplicates
1613 ;; Store some information about the group this message is written
1614 ;; to. This is passed in as the grp argument -- all locations this
1615 ;; has been called from have been checked and the group is available.
1616 ;; The only ambiguous case is nnmail-check-duplication which will only
1617 ;; pass the first (of possibly >1) group which matches. -Josh
16409b0b 1618 (unless (gnus-buffer-live-p nnmail-cache-buffer)
23f87bed 1619 (nnmail-cache-open))
16409b0b 1620 (save-excursion
23f87bed
MB
1621 (set-buffer nnmail-cache-buffer)
1622 (goto-char (point-max))
1623 (if (and grp (not (string= "" grp))
1624 (gnus-methods-equal-p gnus-command-method
1625 (nnmail-cache-primary-mail-backend)))
1626 (let ((regexp (if (consp nnmail-cache-ignore-groups)
1627 (mapconcat 'identity nnmail-cache-ignore-groups
1628 "\\|")
1629 nnmail-cache-ignore-groups)))
1630 (unless (and regexp (string-match regexp grp))
1631 (insert id "\t" grp "\n")))
1632 (insert id "\n"))))))
bf247b6e 1633
16409b0b
GM
1634(defun nnmail-cache-primary-mail-backend ()
1635 (let ((be-list (cons gnus-select-method gnus-secondary-select-methods))
23f87bed
MB
1636 (be nil)
1637 (res nil)
1638 (get-new-mail nil))
16409b0b
GM
1639 (while (and (null res) be-list)
1640 (setq be (car be-list))
1641 (setq be-list (cdr be-list))
1642 (when (and (gnus-method-option-p be 'respool)
23f87bed
MB
1643 (setq get-new-mail
1644 (intern (format "%s-get-new-mail" (car be))))
1645 (boundp get-new-mail)
1646 (symbol-value get-new-mail))
1647 (setq res be)))
16409b0b
GM
1648 res))
1649
1650;; Fetch the group name corresponding to the message id stored in the
1651;; cache.
1652(defun nnmail-cache-fetch-group (id)
1653 (when (and nnmail-treat-duplicates nnmail-cache-buffer)
eec82323
LMI
1654 (save-excursion
1655 (set-buffer nnmail-cache-buffer)
1656 (goto-char (point-max))
16409b0b 1657 (when (search-backward id nil t)
23f87bed
MB
1658 (beginning-of-line)
1659 (skip-chars-forward "^\n\r\t")
1660 (unless (looking-at "[\r\n]")
1661 (forward-char 1)
01c52d31 1662 (buffer-substring (point) (point-at-eol)))))))
16409b0b
GM
1663
1664;; Function for nnmail-split-fancy: look up all references in the
1665;; cache and if a match is found, return that group.
1666(defun nnmail-split-fancy-with-parent ()
23f87bed
MB
1667 "Split this message into the same group as its parent.
1668This function can be used as an entry in `nnmail-split-fancy', for
1669example like this: (: nnmail-split-fancy-with-parent)
1670For a message to be split, it looks for the parent message in the
1671References or In-Reply-To header and then looks in the message id
1672cache file (given by the variable `nnmail-message-id-cache-file') to
1673see which group that message was put in. This group is returned.
1674
1675See the Info node `(gnus)Fancy Mail Splitting' for more details."
16409b0b 1676 (let* ((refstr (or (message-fetch-field "references")
23f87bed
MB
1677 (message-fetch-field "in-reply-to")))
1678 (references nil)
1679 (res nil)
1680 (regexp (if (consp nnmail-split-fancy-with-parent-ignore-groups)
1681 (mapconcat
1682 (lambda (x) (format "\\(%s\\)" x))
1683 nnmail-split-fancy-with-parent-ignore-groups
1684 "\\|")
1685 nnmail-split-fancy-with-parent-ignore-groups)))
16409b0b
GM
1686 (when refstr
1687 (setq references (nreverse (gnus-split-references refstr)))
1688 (unless (gnus-buffer-live-p nnmail-cache-buffer)
23f87bed 1689 (nnmail-cache-open))
01c52d31
MB
1690 (dolist (x references)
1691 (setq res (or (nnmail-cache-fetch-group x) res))
1692 (when (or (member res '("delayed" "drafts" "queue"))
1693 (and regexp res (string-match regexp res)))
1694 (setq res nil)))
16409b0b 1695 res)))
eec82323
LMI
1696
1697(defun nnmail-cache-id-exists-p (id)
1698 (when nnmail-treat-duplicates
1699 (save-excursion
1700 (set-buffer nnmail-cache-buffer)
1701 (goto-char (point-max))
1702 (search-backward id nil t))))
1703
1704(defun nnmail-fetch-field (header)
1705 (save-excursion
1706 (save-restriction
1707 (message-narrow-to-head)
1708 (message-fetch-field header))))
1709
1710(defun nnmail-check-duplication (message-id func artnum-func)
1711 (run-hooks 'nnmail-prepare-incoming-message-hook)
1712 ;; If this is a duplicate message, then we do not save it.
1713 (let* ((duplication (nnmail-cache-id-exists-p message-id))
1714 (case-fold-search t)
1715 (action (when duplication
1716 (cond
1717 ((memq nnmail-treat-duplicates '(warn delete))
1718 nnmail-treat-duplicates)
23f87bed 1719 ((functionp nnmail-treat-duplicates)
eec82323
LMI
1720 (funcall nnmail-treat-duplicates message-id))
1721 (t
1722 nnmail-treat-duplicates))))
1723 group-art)
16409b0b
GM
1724 ;; We insert a line that says what the mail source is.
1725 (let ((case-fold-search t))
1726 (goto-char (point-min))
1727 (re-search-forward "^message-id[ \t]*:" nil t)
1728 (beginning-of-line)
1729 (insert (format "X-Gnus-Mail-Source: %s\n" mail-source-string)))
1730
eec82323
LMI
1731 ;; Let the backend save the article (or not).
1732 (cond
1733 ((not duplication)
eec82323 1734 (funcall func (setq group-art
16409b0b 1735 (nreverse (nnmail-article-group artnum-func))))
23f87bed 1736 (nnmail-cache-insert message-id (caar group-art)))
eec82323
LMI
1737 ((eq action 'delete)
1738 (setq group-art nil))
1739 ((eq action 'warn)
1740 ;; We insert a warning.
1741 (let ((case-fold-search t))
1742 (goto-char (point-min))
1743 (re-search-forward "^message-id[ \t]*:" nil t)
1744 (beginning-of-line)
1745 (insert
1746 "Gnus-Warning: This is a duplicate of message " message-id "\n")
1747 (funcall func (setq group-art
1748 (nreverse (nnmail-article-group artnum-func))))))
1749 (t
1750 (funcall func (setq group-art
1751 (nreverse (nnmail-article-group artnum-func))))))
1752 ;; Add the group-art list to the history list.
1753 (if group-art
1754 (push group-art nnmail-split-history)
1755 (delete-region (point-min) (point-max)))))
1756
1757;;; Get new mail.
1758
16409b0b
GM
1759(defvar nnmail-fetched-sources nil)
1760
eec82323
LMI
1761(defun nnmail-get-value (&rest args)
1762 (let ((sym (intern (apply 'format args))))
1763 (when (boundp sym)
1764 (symbol-value sym))))
1765
1766(defun nnmail-get-new-mail (method exit-func temp
a1da1e37 1767 &optional group spool-func)
eec82323 1768 "Read new incoming mail."
a1da1e37
MB
1769 (nnmail-get-new-mail-1 method exit-func temp group nil spool-func))
1770
1771(defun nnmail-get-new-mail-1 (method exit-func temp
1772 group in-group spool-func)
b890d447 1773 (let* ((sources mail-sources)
16409b0b 1774 fetching-sources
16409b0b
GM
1775 (i 0)
1776 (new 0)
1777 (total 0)
1778 incoming incomings source)
8b93df01
DL
1779 (when (and (nnmail-get-value "%s-get-new-mail" method)
1780 sources)
16409b0b 1781 (while (setq source (pop sources))
a1da1e37
MB
1782 ;; Use group's parameter
1783 (when (eq (car source) 'group)
1784 (let ((mail-sources
1785 (list
1786 (gnus-group-find-parameter
1787 (concat (symbol-name method) ":" group)
1788 'mail-source t))))
1789 (nnmail-get-new-mail-1 method exit-func temp
1790 group group spool-func))
1791 (setq source nil))
16409b0b
GM
1792 ;; Hack to only fetch the contents of a single group's spool file.
1793 (when (and (eq (car source) 'directory)
1794 (null nnmail-scan-directory-mail-source-once)
1795 group)
1796 (mail-source-bind (directory source)
1797 (setq source (append source
1798 (list
1799 :predicate
23f87bed
MB
1800 (gnus-byte-compile
1801 `(lambda (file)
1802 (string-equal
1803 ,(concat group suffix)
1804 (file-name-nondirectory file)))))))))
16409b0b
GM
1805 (when nnmail-fetched-sources
1806 (if (member source nnmail-fetched-sources)
1807 (setq source nil)
1808 (push source nnmail-fetched-sources)
1809 (push source fetching-sources)))))
1810 (when fetching-sources
eec82323
LMI
1811 ;; We first activate all the groups.
1812 (nnmail-activate method)
1813 ;; Allow the user to hook.
1814 (run-hooks 'nnmail-pre-get-new-mail-hook)
1815 ;; Open the message-id cache.
1816 (nnmail-cache-open)
16409b0b
GM
1817 ;; The we go through all the existing mail source specification
1818 ;; and fetch the mail from each.
1819 (while (setq source (pop fetching-sources))
1820 (nnheader-message 4 "%s: Reading incoming mail from %s..."
1821 method (car source))
1822 (when (setq new
1823 (mail-source-fetch
1824 source
23f87bed
MB
1825 (gnus-byte-compile
1826 `(lambda (file orig-file)
1827 (nnmail-split-incoming
1828 file ',(intern (format "%s-save-mail" method))
1829 ',spool-func
a1da1e37
MB
1830 (or in-group
1831 (if (equal file orig-file)
1832 nil
1833 (nnmail-get-split-group orig-file ',source)))
23f87bed 1834 ',(intern (format "%s-active-number" method)))))))
16409b0b
GM
1835 (incf total new)
1836 (incf i)))
eec82323 1837 ;; If we did indeed read any incoming spools, we save all info.
16409b0b
GM
1838 (if (zerop total)
1839 (nnheader-message 4 "%s: Reading incoming mail (no new mail)...done"
1840 method (car source))
eec82323
LMI
1841 (nnmail-save-active
1842 (nnmail-get-value "%s-group-alist" method)
1843 (nnmail-get-value "%s-active-file" method))
1844 (when exit-func
1845 (funcall exit-func))
1846 (run-hooks 'nnmail-read-incoming-hook)
16409b0b
GM
1847 (nnheader-message 4 "%s: Reading incoming mail (%d new)...done" method
1848 total))
eec82323
LMI
1849 ;; Close the message-id cache.
1850 (nnmail-cache-close)
1851 ;; Allow the user to hook.
16409b0b 1852 (run-hooks 'nnmail-post-get-new-mail-hook))))
eec82323
LMI
1853
1854(defun nnmail-expired-article-p (group time force &optional inhibit)
1855 "Say whether an article that is TIME old in GROUP should be expired."
1856 (if force
1857 t
1858 (let ((days (or (and nnmail-expiry-wait-function
1859 (funcall nnmail-expiry-wait-function group))
1860 nnmail-expiry-wait)))
1861 (cond ((or (eq days 'never)
1862 (and (not force)
1863 inhibit))
1864 ;; This isn't an expirable group.
1865 nil)
1866 ((eq days 'immediate)
1867 ;; We expire all articles on sight.
1868 t)
1869 ((equal time '(0 0))
23f87bed 1870 ;; This is an ange-ftp group, and we don't have any dates.
eec82323
LMI
1871 nil)
1872 ((numberp days)
16409b0b 1873 (setq days (days-to-time days))
eec82323 1874 ;; Compare the time with the current time.
16409b0b
GM
1875 (ignore-errors (time-less-p days (time-since time))))))))
1876
163a3c6a
GM
1877(declare-function gnus-group-mark-article-read "gnus-group" (group article))
1878
16409b0b 1879(defun nnmail-expiry-target-group (target group)
23f87bed
MB
1880 ;; Do not invoke this from nntp-server-buffer! At least nnfolder clears
1881 ;; that buffer if the nnfolder group isn't selected.
1882 (let (nnmail-cache-accepted-message-ids)
1883 ;; Don't enter Message-IDs into cache.
1884 ;; Let users hack it in TARGET function.
1885 (when (functionp target)
1886 (setq target (funcall target group)))
1887 (unless (eq target 'delete)
1888 (when (or (gnus-request-group target)
1889 (gnus-request-create-group target))
1890 (let ((group-art (gnus-request-accept-article target nil nil t)))
1891 (when (consp group-art)
1892 (gnus-group-mark-article-read target (cdr group-art))))))))
1893
1894(defun nnmail-fancy-expiry-target (group)
1895 "Returns a target expiry group determined by `nnmail-fancy-expiry-targets'."
1896 (let* (header
1897 (case-fold-search nil)
1898 (from (or (message-fetch-field "from") ""))
1899 (to (or (message-fetch-field "to") ""))
58090a8d 1900 (date (message-fetch-field "date"))
23f87bed 1901 (target 'delete))
58090a8d
MB
1902 (setq date (if date
1903 (condition-case err
1904 (date-to-time date)
1905 (error
1906 (message "%s" (error-message-string err))
1907 (current-time)))
1908 (current-time)))
23f87bed
MB
1909 (dolist (regexp-target-pair (reverse nnmail-fancy-expiry-targets) target)
1910 (setq header (car regexp-target-pair))
1911 (cond
1912 ;; If the header is to-from then match against the
1913 ;; To or From header
1914 ((and (equal header 'to-from)
1915 (or (string-match (cadr regexp-target-pair) from)
5255e3ff
MB
1916 (and (string-match (cadr regexp-target-pair) to)
1917 (let ((rmail-dont-reply-to-names
01c52d31 1918 (message-dont-reply-to-names)))
5255e3ff 1919 (equal (rmail-dont-reply-to from) "")))))
23f87bed
MB
1920 (setq target (format-time-string (caddr regexp-target-pair) date)))
1921 ((and (not (equal header 'to-from))
1922 (string-match (cadr regexp-target-pair)
1923 (or
1924 (message-fetch-field header)
1925 "")))
1926 (setq target
1927 (format-time-string (caddr regexp-target-pair) date)))))))
eec82323
LMI
1928
1929(defun nnmail-check-syntax ()
1930 "Check (and modify) the syntax of the message in the current buffer."
1931 (save-restriction
1932 (message-narrow-to-head)
1933 (let ((case-fold-search t))
1934 (unless (re-search-forward "^Message-ID[ \t]*:" nil t)
1935 (insert "Message-ID: " (nnmail-message-id) "\n")))))
1936
1937(defun nnmail-write-region (start end filename &optional append visit lockname)
1938 "Do a `write-region', and then set the file modes."
1613b43a 1939 (let ((coding-system-for-write nnmail-file-coding-system)
16409b0b 1940 (file-name-coding-system nnmail-pathname-coding-system))
1613b43a
KH
1941 (write-region start end filename append visit lockname)
1942 (set-file-modes filename nnmail-default-file-modes)))
eec82323
LMI
1943
1944;;;
1945;;; Status functions
1946;;;
1947
1948(defun nnmail-replace-status (name value)
1949 "Make status NAME and VALUE part of the current status line."
1950 (save-restriction
1951 (message-narrow-to-head)
1952 (let ((status (nnmail-decode-status)))
1953 (setq status (delq (member name status) status))
1954 (when value
1955 (push (cons name value) status))
1956 (message-remove-header "status")
1957 (goto-char (point-max))
1958 (insert "Status: " (nnmail-encode-status status) "\n"))))
1959
1960(defun nnmail-decode-status ()
1961 "Return a status-value alist from STATUS."
1962 (goto-char (point-min))
1963 (when (re-search-forward "^Status: " nil t)
1964 (let (name value status)
1965 (save-restriction
1966 ;; Narrow to the status.
1967 (narrow-to-region
1968 (point)
1969 (if (re-search-forward "^[^ \t]" nil t)
1970 (1- (point))
1971 (point-max)))
1972 ;; Go through all elements and add them to the list.
1973 (goto-char (point-min))
1974 (while (re-search-forward "[^ \t=]+" nil t)
1975 (setq name (match-string 0))
16409b0b 1976 (if (not (eq (char-after) ?=))
eec82323
LMI
1977 ;; Implied "yes".
1978 (setq value "yes")
1979 (forward-char 1)
16409b0b 1980 (if (not (eq (char-after) ?\"))
eec82323
LMI
1981 (if (not (looking-at "[^ \t]"))
1982 ;; Implied "no".
1983 (setq value "no")
1984 ;; Unquoted value.
1985 (setq value (match-string 0))
1986 (goto-char (match-end 0)))
1987 ;; Quoted value.
1988 (setq value (read (current-buffer)))))
1989 (push (cons name value) status)))
1990 status)))
1991
1992(defun nnmail-encode-status (status)
1993 "Return a status string from STATUS."
1994 (mapconcat
1995 (lambda (elem)
1996 (concat
1997 (car elem) "="
1998 (if (string-match "[ \t]" (cdr elem))
1999 (prin1-to-string (cdr elem))
2000 (cdr elem))))
2001 status " "))
2002
2003(defun nnmail-split-history ()
2004 "Generate an overview of where the last mail split put articles."
2005 (interactive)
2006 (unless nnmail-split-history
2007 (error "No current split history"))
2008 (with-output-to-temp-buffer "*nnmail split history*"
16409b0b
GM
2009 (with-current-buffer standard-output
2010 (fundamental-mode)) ; for Emacs 20.4+
01c52d31 2011 (dolist (elem nnmail-split-history)
eec82323
LMI
2012 (princ (mapconcat (lambda (ga)
2013 (concat (car ga) ":" (int-to-string (cdr ga))))
2014 elem
2015 ", "))
01c52d31 2016 (princ "\n"))))
eec82323 2017
6748645f
LMI
2018(defun nnmail-purge-split-history (group)
2019 "Remove all instances of GROUP from `nnmail-split-history'."
2020 (let ((history nnmail-split-history))
2021 (while history
23f87bed 2022 (setcar history (gnus-remove-if (lambda (e) (string= (car e) group))
6748645f
LMI
2023 (car history)))
2024 (pop history))
2025 (setq nnmail-split-history (delq nil nnmail-split-history))))
2026
eec82323
LMI
2027(defun nnmail-new-mail-p (group)
2028 "Say whether GROUP has new mail."
2029 (let ((his nnmail-split-history)
2030 found)
2031 (while his
2032 (when (assoc group (pop his))
2033 (setq found t
2034 his nil)))
2035 found))
2036
6748645f
LMI
2037(defun nnmail-within-headers-p ()
2038 "Check to see if point is within the headers of a unix mail message.
2039Doesn't change point."
2040 (let ((pos (point)))
2041 (save-excursion
2042 (and (nnmail-search-unix-mail-delim-backward)
2043 (not (search-forward "\n\n" pos t))))))
2044
eec82323
LMI
2045(run-hooks 'nnmail-load-hook)
2046
2047(provide 'nnmail)
2048
cbee283d 2049;; arch-tag: fe8f671a-50db-428a-bb5d-f00462f72ed7
eec82323 2050;;; nnmail.el ends here