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