*** empty log message ***
[gnus] / lisp / nnmail.el
1 ;;; nnmail.el --- mail support functions for the Gnus mail backends
2 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
3
4 ;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
5 ;; Keywords: news, mail
6
7 ;; This file is part of GNU Emacs.
8
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
12 ;; any later version.
13
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 ;; GNU General Public License for more details.
18
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
23
24 ;;; Commentary:
25
26 ;;; Code:
27
28 (require 'nnheader)
29 (require 'timezone)
30 (require 'message)
31 (eval-when-compile (require 'cl))
32 (require 'custom)
33
34 (defgroup gnus-mail nil
35   "Mailreading.."
36   :group 'gnus)
37
38 (defcustom nnmail-split-methods
39   '(("mail.misc" ""))
40   "Incoming mail will be split according to this variable.
41
42 If you'd like, for instance, one mail group for mail from the
43 \"4ad-l\" mailing list, one group for junk mail and one for everything
44 else, you could do something like this:
45
46  (setq nnmail-split-methods
47        '((\"mail.4ad\" \"From:.*4ad\")
48          (\"mail.junk\" \"From:.*Lars\\\\|Subject:.*buy\")
49          (\"mail.misc\" \"\")))
50
51 As you can see, this variable is a list of lists, where the first
52 element in each \"rule\" is the name of the group (which, by the way,
53 does not have to be called anything beginning with \"mail\",
54 \"yonka.zow\" is a fine, fine name), and the second is a regexp that
55 nnmail will try to match on the header to find a fit.
56
57 The second element can also be a function.  In that case, it will be
58 called narrowed to the headers with the first element of the rule as
59 the argument.  It should return a non-nil value if it thinks that the
60 mail belongs in that group.
61
62 The last element should always have \"\" as the regexp.
63
64 This variable can also have a function as its value."
65   :group 'gnus-mail
66   :type '(choice (repeat :tag "Alist" (group (string :tag "Name") regexp))
67                  (function-item nnmail-split-fancy)
68                  (function :tag "Other")))
69
70 ;; Suggested by Erik Selberg <speed@cs.washington.edu>.
71 (defcustom nnmail-crosspost t
72   "If non-nil, do crossposting if several split methods match the mail.
73 If nil, the first match found will be used."
74   :group 'gnus-mail
75   :type 'boolean)
76
77 ;; Added by gord@enci.ucalgary.ca (Gordon Matzigkeit).
78 (defcustom nnmail-keep-last-article nil
79   "If non-nil, nnmail will never delete the last expired article in a directory.  
80 You may need to set this variable if other programs are putting
81 new mail into folder numbers that Gnus has marked as expired."
82   :group 'gnus-mail
83   :type 'boolean)
84
85 (defcustom nnmail-use-long-file-names nil
86   "If non-nil the mail backends will use long file and directory names.
87 If nil, groups like \"mail.misc\" will end up in directories like
88 \"mail/misc/\"."
89   :group 'gnus-mail
90   :type 'boolean)
91
92 (defcustom nnmail-default-file-modes 384
93   "Set the mode bits of all new mail files to this integer."
94   :group 'gnus-mail
95   :type 'integer)
96
97 (defcustom nnmail-expiry-wait 7
98   "*Expirable articles that are older than this will be expired.
99 This variable can either be a number (which will be interpreted as a
100 number of days) -- this doesn't have to be an integer.  This variable
101 can also be `immediate' and `never'."
102   :group 'gnus-mail
103   :type '(choice (const immediate)
104                  (integer :tag "days")
105                  (const never)))
106
107 (defcustom nnmail-expiry-wait-function nil
108   "Variable that holds function to specify how old articles should be before they are expired.
109   The function will be called with the name of the group that the
110 expiry is to be performed in, and it should return an integer that
111 says how many days an article can be stored before it is considered
112 \"old\".  It can also return the values `never' and `immediate'.
113
114 Eg.:
115
116 \(setq nnmail-expiry-wait-function
117       (lambda (newsgroup)
118         (cond ((string-match \"private\" newsgroup) 31)
119               ((string-match \"junk\" newsgroup) 1)
120               ((string-match \"important\" newsgroup) 'never)
121               (t 7))))"
122   :group 'gnus-mail
123   :type '(choice (const :tag "nnmail-expiry-wait" nil)
124                  (function :format "%v" nnmail-)))
125
126 (defcustom nnmail-spool-file 
127   (or (getenv "MAIL")
128       (concat "/usr/spool/mail/" (user-login-name)))
129   "Where the mail backends will look for incoming mail.
130 This variable is \"/usr/spool/mail/$user\" by default.
131 If this variable is nil, no mail backends will read incoming mail.
132 If this variable is a list, all files mentioned in this list will be
133 used as incoming mailboxes.
134 If this variable is a directory (i. e., it's name ends with a \"/\"),
135 treat all files in that directory as incoming spool files."
136   :group 'gnus-mail
137   :type 'file)
138
139 (defcustom nnmail-crash-box "~/.gnus-crash-box"
140   "File where Gnus will store mail while processing it."
141   :group 'gnus-mail
142   :type 'file)
143
144 (defcustom nnmail-use-procmail nil
145   "*If non-nil, the mail backends will look in `nnmail-procmail-directory' for spool files.
146 The file(s) in `nnmail-spool-file' will also be read."
147   :group 'gnus-mail
148   :type 'boolean)
149
150 (defcustom nnmail-procmail-directory "~/incoming/"
151   "*When using procmail (and the like), incoming mail is put in this directory.
152 The Gnus mail backends will read the mail from this directory."
153   :group 'gnus-mail
154   :type 'directory)
155
156 (defcustom nnmail-procmail-suffix "\\.spool"
157   "*Suffix of files created by procmail (and the like).
158 This variable might be a suffix-regexp to match the suffixes of
159 several files - eg. \".spool[0-9]*\"."
160   :group 'gnus-mail
161   :type 'regexp)
162
163 (defcustom nnmail-resplit-incoming nil
164   "*If non-nil, re-split incoming procmail sorted mail."
165   :group 'gnus-mail
166   :type 'boolean)
167
168 (defcustom nnmail-delete-file-function 'delete-file
169   "Function called to delete files in some mail backends."
170   :group 'gnus-mail
171   :type 'function)
172
173 (defcustom nnmail-crosspost-link-function 'add-name-to-file
174   "Function called to create a copy of a file.
175 This is `add-name-to-file' by default, which means that crossposts
176 will use hard links.  If your file system doesn't allow hard
177 links, you could set this variable to `copy-file' instead."
178   :group 'gnus-mail
179   :type '(radio (function-item add-name-to-file)
180                 (function-item copy-file)
181                 (function :tag "Other")))
182
183 (defcustom nnmail-movemail-program "movemail"
184   "*A command to be executed to move mail from the inbox.
185 The default is \"movemail\".
186
187 This can also be a function.  In that case, the function will be
188 called with two parameters -- the name of the INBOX file, and the file
189 to be moved to."
190   :group 'gnus-mail
191   :type 'string)
192
193 (defcustom nnmail-pop-password-required nil
194   "*Non-nil if a password is required when reading mail using POP."
195   :group 'gnus-mail
196   :type 'boolean)
197
198 (defcustom nnmail-read-incoming-hook 
199   (if (eq system-type 'windows-nt)
200       '(nnheader-ms-strip-cr)
201     nil)
202   "Hook that will be run after the incoming mail has been transferred.
203 The incoming mail is moved from `nnmail-spool-file' (which normally is
204 something like \"/usr/spool/mail/$user\") to the user's home
205 directory.  This hook is called after the incoming mail box has been
206 emptied, and can be used to call any mail box programs you have
207 running (\"xwatch\", etc.)
208
209 Eg.
210
211 \(add-hook 'nnmail-read-incoming-hook 
212            (lambda ()
213              (start-process \"mailsend\" nil 
214                             \"/local/bin/mailsend\" \"read\" \"mbox\")))
215
216 If you have xwatch running, this will alert it that mail has been
217 read.  
218
219 If you use `display-time', you could use something like this:
220
221 \(add-hook 'nnmail-read-incoming-hook
222           (lambda ()
223             ;; Update the displayed time, since that will clear out
224             ;; the flag that says you have mail.
225             (when (eq (process-status \"display-time\") 'run)
226               (display-time-filter display-time-process \"\"))))"
227   :group 'gnus-mail
228   :type 'hook)
229
230 ;; Suggested by Erik Selberg <speed@cs.washington.edu>.
231 (defcustom nnmail-prepare-incoming-hook nil
232   "Hook called before treating incoming mail.
233 The hook is run in a buffer with all the new, incoming mail."
234   :group 'gnus-mail
235   :type 'hook)
236
237 (defcustom nnmail-prepare-incoming-header-hook nil
238   "Hook called narrowed to the headers of each message.
239 This can be used to remove excessive spaces (and stuff like
240 that) from the headers before splitting and saving the messages."
241   :group 'gnus-mail
242   :type 'hook)
243
244 (defcustom nnmail-prepare-incoming-message-hook nil
245   "Hook called narrowed to each message."
246   :group 'gnus-mail
247   :type 'hook)
248
249 (defcustom nnmail-list-identifiers nil
250   "Regexp that match list identifiers to be removed.
251 This can also be a list of regexps."
252   :group 'gnus-mail
253   :type '(choice regexp
254                  (repeat regexp)))
255
256 (defcustom nnmail-pre-get-new-mail-hook nil
257   "Hook called just before starting to handle new incoming mail."
258   :group 'gnus-mail
259   :type 'hook)
260
261 (defcustom nnmail-post-get-new-mail-hook nil
262   "Hook called just after finishing handling new incoming mail."
263   :group 'gnus-mail
264   :type 'hook)
265
266 (defcustom nnmail-split-hook nil
267   "Hook called before deciding where to split an article.
268 The functions in this hook are free to modify the buffer
269 contents in any way they choose -- the buffer contents are
270 discarded after running the split process."
271   :group 'gnus-mail
272   :type 'hook)
273
274 ;; Suggested by Mejia Pablo J <pjm9806@usl.edu>.
275 (defcustom nnmail-tmp-directory nil
276   "*If non-nil, use this directory for temporary storage when reading incoming mail."
277   :group 'gnus-mail
278   :type '(choice (const :tag "default" nil)
279                  (directory :format "%v")))
280
281 (defcustom nnmail-large-newsgroup 50
282   "*The number of the articles which indicates a large newsgroup.
283 If the number of the articles is greater than the value, verbose
284 messages will be shown to indicate the current status."
285   :group 'gnus-mail
286   :type 'integer)
287
288 (defcustom nnmail-split-fancy "mail.misc"
289   "Incoming mail can be split according to this fancy variable.
290 To enable this, set `nnmail-split-methods' to `nnmail-split-fancy'.
291
292 The format is this variable is SPLIT, where SPLIT can be one of
293 the following:
294
295 GROUP: Mail will be stored in GROUP (a string).  
296
297 \(FIELD VALUE SPLIT): If the message field FIELD (a regexp) contains
298   VALUE (a regexp), store the messages as specified by SPLIT.
299
300 \(| SPLIT...): Process each SPLIT expression until one of them matches.
301   A SPLIT expression is said to match if it will cause the mail
302   message to be stored in one or more groups.  
303
304 \(& SPLIT...): Process each SPLIT expression.
305
306 \(: FUNCTION optional args): Call FUNCTION with the optional args, in
307   the buffer containing the message headers.  The return value FUNCTION
308   should be a split, which is then recursively processed.
309
310 FIELD must match a complete field name.  VALUE must match a complete
311 word according to the `nnmail-split-fancy-syntax-table' syntax table.
312 You can use .* in the regexps to match partial field names or words.
313
314 FIELD and VALUE can also be lisp symbols, in that case they are expanded
315 as specified in `nnmail-split-abbrev-alist'.
316
317 GROUP can contain \\& and \\N which will substitute from matching
318 \\(\\) patterns in the previous VALUE.
319
320 Example:
321
322 \(setq nnmail-split-methods 'nnmail-split-fancy
323       nnmail-split-fancy
324       ;; Messages from the mailer daemon are not crossposted to any of
325       ;; the ordinary groups.  Warnings are put in a separate group
326       ;; from real errors.
327       '(| (\"from\" mail (| (\"subject\" \"warn.*\" \"mail.warning\")
328                           \"mail.misc\"))
329           ;; Non-error messages are crossposted to all relevant
330           ;; groups, but we don't crosspost between the group for the
331           ;; (ding) list and the group for other (ding) related mail.
332           (& (| (any \"ding@ifi\\\\.uio\\\\.no\" \"ding.list\")
333                 (\"subject\" \"ding\" \"ding.misc\"))
334              ;; Other mailing lists...
335              (any \"procmail@informatik\\\\.rwth-aachen\\\\.de\" \"procmail.list\")
336              (any \"SmartList@informatik\\\\.rwth-aachen\\\\.de\" \"SmartList.list\")
337              ;; People...
338              (any \"larsi@ifi\\\\.uio\\\\.no\" \"people.Lars Magne Ingebrigtsen\"))
339           ;; Unmatched mail goes to the catch all group.
340           \"misc.misc\"))"
341   :group 'gnus-mail
342   ;; Sigh!
343   :type 'sexp)
344
345 (defcustom nnmail-split-abbrev-alist
346   '((any . "from\\|to\\|cc\\|sender\\|apparently-to\\|resent-from\\|resent-to\\|resent-cc")
347     (mail . "mailer-daemon\\|postmaster\\|uucp"))
348   "Alist of abbreviations allowed in `nnmail-split-fancy'."
349   :group 'gnus-mail
350   :type '(repeat (cons :format "%v" symbol regexp)))
351
352 (defcustom nnmail-delete-incoming nil
353   "*If non-nil, the mail backends will delete incoming files after
354 splitting."
355   :group 'gnus-mail
356   :type 'boolean)
357
358 (defcustom nnmail-message-id-cache-length 1000
359   "*The approximate number of Message-IDs nnmail will keep in its cache.
360 If this variable is nil, no checking on duplicate messages will be
361 performed."
362   :group 'gnus-mail
363   :type '(choice (const :tag "disable" nil)
364                  (integer :format "%v")))
365
366 (defcustom nnmail-message-id-cache-file "~/.nnmail-cache"
367   "*The file name of the nnmail Message-ID cache."
368   :group 'gnus-mail
369   :type 'file)
370
371 (defcustom nnmail-treat-duplicates 'warn
372   "*If non-nil, nnmail keep a cache of Message-IDs to discover mail duplicates.
373 Three values are legal: nil, which means that nnmail is not to keep a
374 Message-ID cache; `warn', which means that nnmail should insert extra
375 headers to warn the user about the duplication (this is the default);
376 and `delete', which means that nnmail will delete duplicated mails.
377
378 This variable can also be a function.  It will be called from a buffer
379 narrowed to the article in question with the Message-ID as a
380 parameter.  It should return nil, `warn' or `delete'."
381   :group 'gnus-mail
382   :type '(choice (const :tag "off" nil)
383                  (const warn)
384                  (const delete)))
385
386 ;;; Internal variables.
387
388 (defvar nnmail-split-history nil
389   "List of group/article elements that say where the previous split put messages.")
390
391 (defvar nnmail-pop-password nil
392   "*Password to use when reading mail from a POP server, if required.")
393
394 (defvar nnmail-split-fancy-syntax-table nil
395   "Syntax table used by `nnmail-split-fancy'.")
396 (unless (syntax-table-p nnmail-split-fancy-syntax-table)
397   (setq nnmail-split-fancy-syntax-table
398         (copy-syntax-table (standard-syntax-table)))
399   ;; support the %-hack
400   (modify-syntax-entry ?\% "." nnmail-split-fancy-syntax-table))
401
402 (defvar nnmail-prepare-save-mail-hook nil
403   "Hook called before saving mail.")
404
405 (defvar nnmail-moved-inboxes nil
406   "List of inboxes that have been moved.")
407
408 (defvar nnmail-internal-password nil)
409
410 \f
411
412 (defconst nnmail-version "nnmail 1.0"
413   "nnmail version.")
414
415 \f
416
417 (defun nnmail-request-post (&optional server)
418   (mail-send-and-exit nil))
419
420 (defun nnmail-find-file (file)
421   "Insert FILE in server buffer safely."
422   (set-buffer nntp-server-buffer)
423   (erase-buffer)
424   (let ((format-alist nil)
425         (after-insert-file-functions nil))
426     (condition-case ()
427         (progn (insert-file-contents file) t)
428       (file-error nil))))
429
430 (defun nnmail-group-pathname (group dir &optional file)
431   "Make pathname for GROUP."
432   (concat
433    (let ((dir (file-name-as-directory (expand-file-name dir))))
434      ;; If this directory exists, we use it directly.
435      (if (or nnmail-use-long-file-names 
436              (file-directory-p (concat dir group)))
437          (concat dir group "/")
438        ;; If not, we translate dots into slashes.
439        (concat dir (nnheader-replace-chars-in-string group ?. ?/) "/")))
440    (or file "")))
441   
442 (defun nnmail-date-to-time (date)
443   "Convert DATE into time."
444   (condition-case ()
445       (let* ((d1 (timezone-parse-date date))
446              (t1 (timezone-parse-time (aref d1 3))))
447         (apply 'encode-time
448                (mapcar (lambda (el)
449                          (and el (string-to-number el)))
450                        (list
451                         (aref t1 2) (aref t1 1) (aref t1 0)
452                         (aref d1 2) (aref d1 1) (aref d1 0)
453                         (aref d1 4)))))
454     ;; If we get an error, then we just return a 0 time.
455     (error (list 0 0))))
456
457 (defun nnmail-time-less (t1 t2)
458   "Say whether time T1 is less than time T2."
459   (or (< (car t1) (car t2))
460       (and (= (car t1) (car t2))
461            (< (nth 1 t1) (nth 1 t2)))))
462
463 (defun nnmail-days-to-time (days)
464   "Convert DAYS into time."
465   (let* ((seconds (* 1.0 days 60 60 24))
466          (rest (expt 2 16))
467          (ms (condition-case nil (round (/ seconds rest))
468                (range-error (expt 2 16)))))
469     (list ms (condition-case nil (round (- seconds (* ms rest)))
470                (range-error (expt 2 16))))))
471
472 (defun nnmail-time-since (time)
473   "Return the time since TIME, which is either an internal time or a date."
474   (when (stringp time)
475     ;; Convert date strings to internal time.
476     (setq time (nnmail-date-to-time time)))
477   (let* ((current (current-time))
478          (rest (when (< (nth 1 current) (nth 1 time))
479                  (expt 2 16))))
480     (list (- (+ (car current) (if rest -1 0)) (car time))
481           (- (+ (or rest 0) (nth 1 current)) (nth 1 time)))))
482
483 ;; Function rewritten from rmail.el.
484 (defun nnmail-move-inbox (inbox)
485   "Move INBOX to `nnmail-crash-box'."
486   (if (not (file-writable-p nnmail-crash-box))
487       (gnus-error 1 "Can't write to crash box %s.  Not moving mail."
488                   nnmail-crash-box)
489     ;; If the crash box exists and is empty, we delete it.
490     (when (and (file-exists-p nnmail-crash-box)
491                (zerop (nnheader-file-size (file-truename nnmail-crash-box))))
492       (delete-file nnmail-crash-box))
493     (let ((inbox (file-truename (expand-file-name inbox)))
494           (tofile (file-truename (expand-file-name nnmail-crash-box)))
495           movemail popmail errors)
496       (if (setq popmail (string-match
497                          "^po:" (file-name-nondirectory inbox)))
498           (setq inbox (file-name-nondirectory inbox))
499         (setq movemail t)
500         ;; On some systems, /usr/spool/mail/foo is a directory
501         ;; and the actual inbox is /usr/spool/mail/foo/foo.
502         (when (file-directory-p inbox)
503           (setq inbox (expand-file-name (user-login-name) inbox))))
504       (if (member inbox nnmail-moved-inboxes)
505           ;; We don't try to move an already moved inbox.
506           nil
507         (if popmail
508             (progn
509               (setq nnmail-internal-password nnmail-pop-password)
510               (when (and nnmail-pop-password-required
511                          (not nnmail-pop-password))
512                 (setq nnmail-internal-password
513                       (nnmail-read-passwd
514                        (format "Password for %s: "
515                                (substring inbox (+ popmail 3))))))
516               (message "Getting mail from post office ..."))
517           (when (or (and (file-exists-p tofile)
518                          (/= 0 (nnheader-file-size tofile)))
519                     (and (file-exists-p inbox)
520                          (/= 0 (nnheader-file-size inbox))))
521             (message "Getting mail from %s..." inbox)))
522         ;; Set TOFILE if have not already done so, and
523         ;; rename or copy the file INBOX to TOFILE if and as appropriate.
524         (cond 
525          ((file-exists-p tofile)
526           ;; The crash box exists already.
527           t)
528          ((and (not popmail)
529                (not (file-exists-p inbox)))
530           ;; There is no inbox.
531           (setq tofile nil))
532          (t
533           ;; If getting from mail spool directory, use movemail to move
534           ;; rather than just renaming, so as to interlock with the
535           ;; mailer.
536           (unwind-protect
537               (save-excursion
538                 (setq errors (generate-new-buffer " *nnmail loss*"))
539                 (buffer-disable-undo errors)
540                 (let ((default-directory "/"))
541                   (if (nnheader-functionp nnmail-movemail-program)
542                       (funcall nnmail-movemail-program inbox tofile)
543                     (apply 
544                      'call-process
545                      (append
546                       (list
547                        (expand-file-name nnmail-movemail-program
548                                          exec-directory)
549                        nil errors nil inbox tofile)
550                       (when nnmail-internal-password
551                         (list nnmail-internal-password))))))
552                 (if (not (buffer-modified-p errors))
553                     ;; No output => movemail won
554                     (progn
555                       (unless popmail
556                         (set-file-modes tofile nnmail-default-file-modes))
557                       (push inbox nnmail-moved-inboxes))
558                   (set-buffer errors)
559                   ;; There may be a warning about older revisions.  We
560                   ;; ignore those.
561                   (goto-char (point-min))
562                   (if (search-forward "older revision" nil t)
563                       (progn
564                         (unless popmail
565                           (set-file-modes tofile nnmail-default-file-modes))
566                         (push inbox nnmail-moved-inboxes))
567                     ;; Probably a real error.
568                     (subst-char-in-region (point-min) (point-max) ?\n ?\  )
569                     (goto-char (point-max))
570                     (skip-chars-backward " \t")
571                     (delete-region (point) (point-max))
572                     (goto-char (point-min))
573                     (when (looking-at "movemail: ")
574                       (delete-region (point-min) (match-end 0)))
575                     (unless (yes-or-no-p
576                              (format "movemail: %s.  Continue? "
577                                      (buffer-string)))
578                       (error "%s" (buffer-string)))
579                     (setq tofile nil)))))))
580         (and errors
581              (buffer-name errors)
582              (kill-buffer errors))
583         tofile))))
584
585 (defun nnmail-get-active ()
586   "Returns an assoc of group names and active ranges.
587 nn*-request-list should have been called before calling this function."
588   (let (group-assoc)
589     ;; Go through all groups from the active list.
590     (save-excursion
591       (set-buffer nntp-server-buffer)
592       (goto-char (point-min))
593       (while (re-search-forward 
594               "^\\([^ \t]+\\)[ \t]+\\([0-9]+\\)[ \t]+\\([0-9]+\\)" nil t)
595         ;; We create an alist with `(GROUP (LOW . HIGH))' elements.
596         (push (list (match-string 1)
597                     (cons (string-to-int (match-string 3))
598                           (string-to-int (match-string 2))))
599               group-assoc)))
600     group-assoc))
601
602 (defun nnmail-save-active (group-assoc file-name)
603   "Save GROUP-ASSOC in ACTIVE-FILE."
604   (when file-name
605     (nnheader-temp-write file-name
606       (nnmail-generate-active group-assoc))))
607
608 (defun nnmail-generate-active (alist)
609   "Generate an active file from group-alist ALIST."
610   (erase-buffer)
611   (let (group)
612     (while (setq group (pop alist))
613       (insert (format "%s %d %d y\n" (car group) (cdadr group)
614                       (caadr group))))))
615
616 (defun nnmail-get-split-group (file group)
617   "Find out whether this FILE is to be split into GROUP only.
618 If GROUP is non-nil and we are using procmail, return the group name
619 only when the file is the correct procmail file.  When GROUP is nil,
620 return nil if FILE is a spool file or the procmail group for which it
621 is a spool.  If not using procmail, return GROUP."
622   (if (or (eq nnmail-spool-file 'procmail)
623           nnmail-use-procmail)
624       (if (string-match (concat "^" (expand-file-name
625                                      (file-name-as-directory
626                                       nnmail-procmail-directory))
627                                 "\\([^/]*\\)" nnmail-procmail-suffix "$")
628                         (expand-file-name file))
629           (let ((procmail-group (substring (expand-file-name file)
630                                            (match-beginning 1)
631                                            (match-end 1))))
632             (if group 
633                 (if (string-equal group procmail-group)
634                     group
635                   nil)
636               procmail-group))
637         nil)
638     group))
639
640 (defun nnmail-process-babyl-mail-format (func artnum-func)
641   (let ((case-fold-search t)
642         start message-id content-length do-search end)
643     (goto-char (point-min))
644     (while (not (eobp))
645       (re-search-forward
646        "\f\n0, *unseen,+\n\\(\\*\\*\\* EOOH \\*\\*\\*\n\\)?" nil t)
647       (goto-char (match-end 0))
648       (delete-region (match-beginning 0) (match-end 0))
649       (narrow-to-region
650        (setq start (point))
651        (progn
652          ;; Skip all the headers in case there are more "From "s...
653          (or (search-forward "\n\n" nil t)
654              (search-forward-regexp "^[^:]*\\( .*\\|\\)$" nil t)
655              (search-forward "\1f\f"))
656          (point)))
657       (run-hooks 'nnmail-prepare-incoming-header-hook)
658       (widen)
659       ;; Find the Message-ID header.
660       (save-excursion
661         (if (re-search-backward "^Message-ID:[ \t]*\\(<[^>]*>\\)" nil t)
662             (setq message-id (buffer-substring (match-beginning 1)
663                                                (match-end 1)))
664           ;; There is no Message-ID here, so we create one.
665           (save-excursion
666             (when (re-search-backward "^Message-ID:" nil t)
667               (beginning-of-line)
668               (insert "Original-")))
669           (forward-line -1)
670           (insert "Message-ID: " (setq message-id (nnmail-message-id))
671                   "\n")))
672       ;; Look for a Content-Length header.
673       (if (not (save-excursion
674                  (and (re-search-backward 
675                        "^Content-Length:[ \t]*\\([0-9]+\\)" start t)
676                       (setq content-length (string-to-int
677                                             (buffer-substring 
678                                              (match-beginning 1)
679                                              (match-end 1))))
680                       ;; We destroy the header, since none of
681                       ;; the backends ever use it, and we do not
682                       ;; want to confuse other mailers by having
683                       ;; a (possibly) faulty header.
684                       (progn (insert "X-") t))))
685           (setq do-search t)
686         (if (or (= (+ (point) content-length) (point-max))
687                 (save-excursion
688                   (goto-char (+ (point) content-length))
689                   (looking-at "\1f")))
690             (progn
691               (goto-char (+ (point) content-length))
692               (setq do-search nil))
693           (setq do-search t)))
694       ;; Go to the beginning of the next article - or to the end
695       ;; of the buffer.  
696       (when do-search
697         (if (re-search-forward "^\1f" nil t)
698             (goto-char (match-beginning 0))
699           (goto-char (1- (point-max)))))
700       (delete-char 1)                   ; delete ^_
701       (save-excursion
702         (save-restriction
703           (narrow-to-region start (point))
704           (goto-char (point-min))
705           (nnmail-check-duplication message-id func artnum-func)
706           (setq end (point-max))))
707       (goto-char end))))
708
709 (defun nnmail-search-unix-mail-delim ()
710   "Put point at the beginning of the next Unix mbox message."
711   ;; Algorithm used to find the the next article in the
712   ;; brain-dead Unix mbox format:
713   ;;
714   ;; 1) Search for "^From ".
715   ;; 2) If we find it, then see whether the previous
716   ;;    line is blank and the next line looks like a header.
717   ;; Then it's possible that this is a mail delim, and we use it.
718   (let ((case-fold-search nil)
719         found)
720     (while (not found)
721       (if (not (re-search-forward "^From " nil t))
722           (setq found 'no)
723         (save-excursion
724           (beginning-of-line)
725           (when (and (or (bobp)
726                          (save-excursion
727                            (forward-line -1)
728                            (= (following-char) ?\n)))
729                      (save-excursion
730                        (forward-line 1)
731                        (while (looking-at ">From ")
732                          (forward-line 1))
733                        (looking-at "[^ \t:]+[ \t]*:")))
734             (setq found 'yes)))))
735     (beginning-of-line)
736     (eq found 'yes)))
737
738 (defun nnmail-process-unix-mail-format (func artnum-func)
739   (let ((case-fold-search t)
740         start message-id content-length end skip head-end)
741     (goto-char (point-min))
742     (if (not (and (re-search-forward "^From " nil t)
743                   (goto-char (match-beginning 0))))
744         ;; Possibly wrong format?
745         (error "Error, unknown mail format! (Possibly corrupted.)")
746       ;; Carry on until the bitter end.
747       (while (not (eobp))
748         (setq start (point)
749               end nil)
750         ;; Find the end of the head.
751         (narrow-to-region
752          start 
753          (if (search-forward "\n\n" nil t)
754              (1- (point))
755            ;; This will never happen, but just to be on the safe side --
756            ;; if there is no head-body delimiter, we search a bit manually.
757            (while (and (looking-at "From \\|[^ \t]+:")
758                        (not (eobp)))
759              (forward-line 1)
760              (point))))
761         ;; Find the Message-ID header.
762         (goto-char (point-min))
763         (if (re-search-forward "^Message-ID:[ \t]*\\(<[^>]+>\\)" nil t)
764             (setq message-id (match-string 1))
765           (save-excursion
766             (when (re-search-forward "^Message-ID:" nil t)
767               (beginning-of-line)
768               (insert "Original-")))
769           ;; There is no Message-ID here, so we create one.
770           (forward-line 1)
771           (insert "Message-ID: " (setq message-id (nnmail-message-id)) "\n"))
772         ;; Look for a Content-Length header.
773         (goto-char (point-min))
774         (if (not (re-search-forward
775                   "^Content-Length:[ \t]*\\([0-9]+\\)" nil t))
776             (setq content-length nil)
777           (setq content-length (string-to-int (match-string 1)))
778           ;; We destroy the header, since none of the backends ever 
779           ;; use it, and we do not want to confuse other mailers by
780           ;; having a (possibly) faulty header.
781           (beginning-of-line)
782           (insert "X-"))
783         (run-hooks 'nnmail-prepare-incoming-header-hook)
784         ;; Find the end of this article.
785         (goto-char (point-max))
786         (widen)
787         (setq head-end (point))
788         ;; We try the Content-Length value.  The idea: skip over the header
789         ;; separator, then check what happens content-length bytes into the
790         ;; message body.  This should be either the end ot the buffer, the
791         ;; message separator or a blank line followed by the separator.
792         ;; The blank line should probably be deleted.  If neither of the
793         ;; three is met, the content-length header is probably invalid.
794         (when content-length
795           (forward-line 1)
796           (setq skip (+ (point) content-length))
797           (goto-char skip)
798           (cond ((or (= skip (point-max))
799                      (= (1+ skip) (point-max)))
800                  (setq end (point-max)))
801                 ((looking-at "From ")
802                  (setq end skip))
803                 ((looking-at "[ \t]*\n\\(From \\)")
804                  (setq end (match-beginning 1)))
805                 (t (setq end nil))))
806         (if end
807             (goto-char end)
808           ;; No Content-Length, so we find the beginning of the next 
809           ;; article or the end of the buffer.
810           (goto-char head-end)
811           (or (nnmail-search-unix-mail-delim)
812               (goto-char (point-max))))
813         ;; Allow the backend to save the article.
814         (save-excursion
815           (save-restriction
816             (narrow-to-region start (point))
817             (goto-char (point-min))
818             (nnmail-check-duplication message-id func artnum-func)
819             (setq end (point-max))))
820         (goto-char end)))))
821
822 (defun nnmail-process-mmdf-mail-format (func artnum-func)
823   (let ((delim "^\^A\^A\^A\^A$")
824         (case-fold-search t)
825         start message-id end)
826     (goto-char (point-min))
827     (if (not (and (re-search-forward delim nil t)
828                   (forward-line 1)))
829         ;; Possibly wrong format?
830         (error "Error, unknown mail format! (Possibly corrupted.)")
831       ;; Carry on until the bitter end.
832       (while (not (eobp))
833         (setq start (point))
834         ;; Find the end of the head.
835         (narrow-to-region
836          start 
837          (if (search-forward "\n\n" nil t)
838              (1- (point))
839            ;; This will never happen, but just to be on the safe side --
840            ;; if there is no head-body delimiter, we search a bit manually.
841            (while (and (looking-at "From \\|[^ \t]+:")
842                        (not (eobp)))
843              (forward-line 1)
844              (point))))
845         ;; Find the Message-ID header.
846         (goto-char (point-min))
847         (if (re-search-forward "^Message-ID:[ \t]*\\(<[^>]+>\\)" nil t)
848             (setq message-id (match-string 1))
849           ;; There is no Message-ID here, so we create one.
850           (save-excursion
851             (when (re-search-backward "^Message-ID:" nil t)
852               (beginning-of-line)
853               (insert "Original-")))
854           (forward-line 1)
855           (insert "Message-ID: " (setq message-id (nnmail-message-id)) "\n"))
856         (run-hooks 'nnmail-prepare-incoming-header-hook)
857         ;; Find the end of this article.
858         (goto-char (point-max))
859         (widen)
860         (if (re-search-forward delim nil t)
861             (beginning-of-line)
862           (goto-char (point-max)))
863         ;; Allow the backend to save the article.
864         (save-excursion
865           (save-restriction
866             (narrow-to-region start (point))
867             (goto-char (point-min))
868             (nnmail-check-duplication message-id func artnum-func)
869             (setq end (point-max))))
870         (goto-char end)
871         (forward-line 2)))))
872
873 (defun nnmail-split-incoming (incoming func &optional exit-func
874                                        group artnum-func)
875   "Go through the entire INCOMING file and pick out each individual mail.
876 FUNC will be called with the buffer narrowed to each mail."
877   (let (;; If this is a group-specific split, we bind the split
878         ;; methods to just this group.
879         (nnmail-split-methods (if (and group
880                                        (or (eq nnmail-spool-file 'procmail)
881                                            nnmail-use-procmail)
882                                        (not nnmail-resplit-incoming))
883                                   (list (list group ""))
884                                 nnmail-split-methods)))
885     (save-excursion
886       ;; Insert the incoming file.
887       (set-buffer (get-buffer-create " *nnmail incoming*"))
888       (buffer-disable-undo (current-buffer))
889       (erase-buffer)
890       (nnheader-insert-file-contents incoming)
891       (unless (zerop (buffer-size))
892         (goto-char (point-min))
893         (save-excursion (run-hooks 'nnmail-prepare-incoming-hook))
894         ;; Handle both babyl, MMDF and unix mail formats, since movemail will
895         ;; use the former when fetching from a mailbox, the latter when
896         ;; fetches from a file.
897         (cond ((or (looking-at "\^L")
898                    (looking-at "BABYL OPTIONS:"))
899                (nnmail-process-babyl-mail-format func artnum-func))
900               ((looking-at "\^A\^A\^A\^A")
901                (nnmail-process-mmdf-mail-format func artnum-func))
902               (t
903                (nnmail-process-unix-mail-format func artnum-func))))
904       (when exit-func
905         (funcall exit-func))
906       (kill-buffer (current-buffer)))))
907
908 ;; Mail crossposts suggested by Brian Edmonds <edmonds@cs.ubc.ca>. 
909 (defun nnmail-article-group (func)
910   "Look at the headers and return an alist of groups that match.
911 FUNC will be called with the group name to determine the article number."
912   (let ((methods nnmail-split-methods)
913         (obuf (current-buffer))
914         (beg (point-min))
915         end group-art method)
916     (if (and (sequencep methods) (= (length methods) 1))
917         ;; If there is only just one group to put everything in, we
918         ;; just return a list with just this one method in.
919         (setq group-art
920               (list (cons (caar methods) (funcall func (caar methods)))))
921       ;; We do actual comparison.
922       (save-excursion
923         ;; Find headers.
924         (goto-char beg)
925         (setq end (if (search-forward "\n\n" nil t) (point) (point-max)))
926         (set-buffer nntp-server-buffer)
927         (erase-buffer)
928         ;; Copy the headers into the work buffer.
929         (insert-buffer-substring obuf beg end)
930         ;; Fold continuation lines.
931         (goto-char (point-min))
932         (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
933           (replace-match " " t t))
934         ;; Allow washing.
935         (run-hooks 'nnmail-split-hook)
936         (if (and (symbolp nnmail-split-methods)
937                  (fboundp nnmail-split-methods))
938             (let ((split
939                    (condition-case nil
940                        (or (funcall nnmail-split-methods)
941                            '("bogus"))
942                      (error
943                       (message 
944                        "Error in `nnmail-split-methods'; using `bogus' mail group")
945                       (sit-for 1)
946                       '("bogus")))))
947               (unless (equal split '(junk))
948                 ;; `nnmail-split-methods' is a function, so we just call 
949                 ;; this function here and use the result.
950                 (setq group-art
951                       (mapcar
952                        (lambda (group) (cons group (funcall func group)))
953                        split))))
954           ;; Go through the split methods to find a match.
955           (while (and methods (or nnmail-crosspost (not group-art)))
956             (goto-char (point-max))
957             (setq method (pop methods))
958             (if (or methods
959                     (not (equal "" (nth 1 method))))
960                 (when (and
961                        (ignore-errors
962                          (if (stringp (nth 1 method))
963                              (re-search-backward (cadr method) nil t)
964                            ;; Function to say whether this is a match.
965                            (funcall (nth 1 method) (car method))))
966                        ;; Don't enter the article into the same 
967                        ;; group twice.
968                        (not (assoc (car method) group-art)))
969                   (push (cons (car method) (funcall func (car method)))
970                         group-art))
971               ;; This is the final group, which is used as a 
972               ;; catch-all.
973               (unless group-art
974                 (setq group-art 
975                       (list (cons (car method)
976                                   (funcall func (car method)))))))))
977         ;; See whether the split methods returned `junk'.
978         (if (equal group-art '(junk))
979             nil
980           (nreverse (delq 'junk group-art)))))))
981
982 (defun nnmail-insert-lines ()
983   "Insert how many lines there are in the body of the mail.
984 Return the number of characters in the body."
985   (let (lines chars)
986     (save-excursion
987       (goto-char (point-min))
988       (when (search-forward "\n\n" nil t)
989         (setq chars (- (point-max) (point)))
990         (setq lines (count-lines (point) (point-max)))
991         (forward-char -1)
992         (save-excursion
993           (when (re-search-backward "^Lines: " nil t)
994             (delete-region (point) (progn (forward-line 1) (point)))))
995         (beginning-of-line)
996         (insert (format "Lines: %d\n" (max lines 0)))
997         chars))))
998
999 (defun nnmail-insert-xref (group-alist)
1000   "Insert an Xref line based on the (group . article) alist."
1001   (save-excursion
1002     (goto-char (point-min))
1003     (when (search-forward "\n\n" nil t)
1004       (forward-char -1)
1005       (when (re-search-backward "^Xref: " nil t)
1006         (delete-region (match-beginning 0)
1007                        (progn (forward-line 1) (point))))
1008       (insert (format "Xref: %s" (system-name)))
1009       (while group-alist
1010         (insert (format " %s:%d" (caar group-alist) (cdar group-alist)))
1011         (setq group-alist (cdr group-alist)))
1012       (insert "\n"))))
1013
1014 ;;; Message washing functions
1015
1016 (defun nnmail-remove-leading-whitespace ()
1017   "Remove excessive whitespace from all headers."
1018   (goto-char (point-min))
1019   (while (re-search-forward "^\\([^ :]+: \\) +" nil t)
1020     (replace-match "\\1" t t)))
1021
1022 (defun nnmail-remove-list-identifiers ()
1023   "Remove list identifiers from Subject headers."
1024   (let ((regexp (if (stringp nnmail-list-identifiers) nnmail-list-identifiers
1025                   (mapconcat 'identity nnmail-list-identifiers "\\|"))))
1026     (when regexp
1027       (goto-char (point-min))
1028       (when (re-search-forward
1029              (concat "Subject: +\\(Re: +\\)?\\(" regexp "\\) *")
1030              nil t)
1031         (delete-region (match-beginning 2) (match-end 0))))))
1032
1033 (defun nnmail-remove-tabs ()
1034   "Translate TAB characters into SPACE characters."
1035   (subst-char-in-region (point-min) (point-max) ?\t ?  t))
1036
1037 ;;; Utility functions
1038
1039 ;; Written by byer@mv.us.adobe.com (Scott Byer).
1040 (defun nnmail-make-complex-temp-name (prefix)
1041   (let ((newname (make-temp-name prefix))
1042         (newprefix prefix))
1043     (while (file-exists-p newname)
1044       (setq newprefix (concat newprefix "x"))
1045       (setq newname (make-temp-name newprefix)))
1046     newname))
1047
1048 ;; Written by Per Abrahamsen <amanda@iesd.auc.dk>.
1049
1050 (defun nnmail-split-fancy ()
1051   "Fancy splitting method.
1052 See the documentation for the variable `nnmail-split-fancy' for documentation."
1053   (let ((syntab (syntax-table)))
1054     (unwind-protect
1055         (progn
1056           (set-syntax-table nnmail-split-fancy-syntax-table)
1057           (nnmail-split-it nnmail-split-fancy))
1058       (set-syntax-table syntab))))
1059
1060 (defvar nnmail-split-cache nil)
1061 ;; Alist of split expressions their equivalent regexps.
1062
1063 (defun nnmail-split-it (split)
1064   ;; Return a list of groups matching SPLIT.
1065   (cond
1066    ;; nil split
1067    ((null split)
1068     nil)
1069
1070    ;; A group name.  Do the \& and \N subs into the string.
1071    ((stringp split)
1072     (list (nnmail-expand-newtext split)))
1073
1074    ;; Junk the message.
1075    ((eq split 'junk)
1076     (list 'junk))
1077
1078    ;; Builtin & operation.
1079    ((eq (car split) '&)
1080     (apply 'nconc (mapcar 'nnmail-split-it (cdr split))))
1081
1082    ;; Builtin | operation.
1083    ((eq (car split) '|)
1084     (let (done)
1085       (while (and (not done) (cdr split))
1086         (setq split (cdr split)
1087               done (nnmail-split-it (car split))))
1088       done))
1089
1090    ;; Builtin : operation.
1091    ((eq (car split) ':)
1092     (nnmail-split-it (eval (cdr split))))
1093
1094    ;; Check the cache for the regexp for this split.
1095    ;; FIX FIX FIX could avoid calling assq twice here
1096    ((assq split nnmail-split-cache)
1097     (goto-char (point-max))
1098     ;; FIX FIX FIX problem with re-search-backward is that if you have
1099     ;; a split: (from "foo-\\(bar\\|baz\\)@gnus.org "mail.foo.\\1")
1100     ;; and someone mails a message with 'To: foo-bar@gnus.org' and
1101     ;; 'CC: foo-baz@gnus.org', we'll pick 'mail.foo.baz' as the group
1102     ;; if the cc line is a later header, even though the other choice
1103     ;; is probably better.  Also, this routine won't do a crosspost
1104     ;; when there are two different matches.
1105     ;; I guess you could just make this more determined, and it could
1106     ;; look for still more matches prior to this one, and recurse
1107     ;; on each of the multiple matches hit.  Of course, then you'd
1108     ;; want to make sure that nnmail-article-group or nnmail-split-fancy
1109     ;; removed duplicates, since there might be more of those.
1110     ;; I guess we could also remove duplicates in the & split case, since
1111     ;; that's the only thing that can introduce them.
1112     (when (re-search-backward (cdr (assq split nnmail-split-cache)) nil t)
1113       ;; Someone might want to do a \N sub on this match, so get the
1114       ;; correct match positions.
1115       (goto-char (match-end 0))
1116       (let ((value (nth 1 split)))
1117         (re-search-backward (if (symbolp value)
1118                                 (cdr (assq value nnmail-split-abbrev-alist))
1119                               value)
1120                             (match-end 1)))
1121       (nnmail-split-it (nth 2 split))))
1122
1123    ;; Not in cache, compute a regexp for the field/value pair.
1124    (t
1125     (let* ((field (nth 0 split))
1126            (value (nth 1 split))
1127            (regexp (concat "^\\(\\("
1128                            (if (symbolp field)
1129                                (cdr (assq field nnmail-split-abbrev-alist))
1130                              field)
1131                            "\\):.*\\)\\<\\("
1132                            (if (symbolp value)
1133                                (cdr (assq value nnmail-split-abbrev-alist))
1134                              value)
1135                            "\\)\\>")))
1136       (push (cons split regexp) nnmail-split-cache)
1137       ;; Now that it's in the cache, just call nnmail-split-it again
1138       ;; on the same split, which will find it immediately in the cache.
1139       (nnmail-split-it split)))))
1140
1141 (defun nnmail-expand-newtext (newtext)
1142   (let ((len (length newtext))
1143         (pos 0)
1144         c expanded beg N did-expand)
1145     (while (< pos len)
1146       (setq beg pos)
1147       (while (and (< pos len)
1148                   (not (= (aref newtext pos) ?\\)))
1149         (setq pos (1+ pos)))
1150       (unless (= beg pos)
1151         (push (substring newtext beg pos) expanded))
1152       (when (< pos len)
1153         ;; we hit a \, expand it.
1154         (setq did-expand t)
1155         (setq pos (1+ pos))
1156         (setq c (aref newtext pos))
1157         (if (not (or (= c ?\&)
1158                      (and (>= c ?1)
1159                           (<= c ?9))))
1160             ;; \ followed by some character we don't expand
1161             (push (char-to-string c) expanded)
1162           ;; \& or \N
1163           (if (= c ?\&)
1164               (setq N 0)
1165             (setq N (- c ?0)))
1166           (when (match-beginning N)
1167             (push (buffer-substring (match-beginning N) (match-end N))
1168                   expanded))))
1169       (setq pos (1+ pos)))
1170     (if did-expand
1171         (apply 'concat (nreverse expanded))
1172       newtext)))
1173
1174 ;; Get a list of spool files to read.
1175 (defun nnmail-get-spool-files (&optional group)
1176   (if (null nnmail-spool-file)
1177       ;; No spool file whatsoever.
1178       nil
1179     (let* ((procmails 
1180             ;; If procmail is used to get incoming mail, the files
1181             ;; are stored in this directory.
1182             (and (file-exists-p nnmail-procmail-directory)
1183                  (or (eq nnmail-spool-file 'procmail)
1184                      nnmail-use-procmail)
1185                  (directory-files 
1186                   nnmail-procmail-directory 
1187                   t (concat (if group (concat "^" group) "")
1188                             nnmail-procmail-suffix "$"))))
1189            (p procmails)
1190            (crash (when (and (file-exists-p nnmail-crash-box)
1191                              (> (nnheader-file-size
1192                                  (file-truename nnmail-crash-box))
1193                                 0))
1194                     (list nnmail-crash-box))))
1195       ;; Remove any directories that inadvertently match the procmail
1196       ;; suffix, which might happen if the suffix is "". 
1197       (while p
1198         (when (file-directory-p (car p))
1199           (setq procmails (delete (car p) procmails)))
1200         (setq p (cdr p)))
1201       ;; Return the list of spools.
1202       (append 
1203        crash
1204        (cond ((and group
1205                    (or (eq nnmail-spool-file 'procmail)
1206                        nnmail-use-procmail)
1207                    procmails)
1208               procmails)
1209              ((and group
1210                    (eq nnmail-spool-file 'procmail))
1211               nil)
1212              ((listp nnmail-spool-file)
1213               (nconc
1214                (apply 
1215                 'nconc
1216                 (mapcar 
1217                  (lambda (file)
1218                    (if (file-directory-p file)
1219                        (nnheader-directory-regular-files file)
1220                      (list file)))
1221                  nnmail-spool-file))
1222                procmails))
1223              ((and (stringp nnmail-spool-file)
1224                    (not (file-directory-p nnmail-spool-file)))
1225               (cons nnmail-spool-file procmails))
1226              ((and (stringp nnmail-spool-file)
1227                    (file-directory-p nnmail-spool-file))
1228               (nconc
1229                (nnheader-directory-regular-files nnmail-spool-file)
1230                procmails))
1231              ((eq nnmail-spool-file 'pop)
1232               (cons (format "po:%s" (user-login-name)) procmails))
1233              (t
1234               procmails))))))
1235
1236 ;; Activate a backend only if it isn't already activated. 
1237 ;; If FORCE, re-read the active file even if the backend is 
1238 ;; already activated.
1239 (defun nnmail-activate (backend &optional force)
1240   (let (file timestamp file-time)
1241     (if (or (not (symbol-value (intern (format "%s-group-alist" backend))))
1242             force
1243             (and (setq file (ignore-errors
1244                               (symbol-value (intern (format "%s-active-file" 
1245                                                             backend)))))
1246                  (setq file-time (nth 5 (file-attributes file)))
1247                  (or (not
1248                       (setq timestamp
1249                             (condition-case ()
1250                                 (symbol-value (intern
1251                                                (format "%s-active-timestamp" 
1252                                                        backend)))
1253                               (error 'none))))
1254                      (not (consp timestamp))
1255                      (equal timestamp '(0 0))
1256                      (> (nth 0 file-time) (nth 0 timestamp))
1257                      (and (= (nth 0 file-time) (nth 0 timestamp))
1258                           (> (nth 1 file-time) (nth 1 timestamp))))))
1259         (save-excursion
1260           (or (eq timestamp 'none)
1261               (set (intern (format "%s-active-timestamp" backend)) 
1262 ;;; dmoore@ucsd.edu 25.10.96
1263 ;;; it's not always the case that current-time
1264 ;;; does correspond to changes in the file's time.  So just compare
1265 ;;; the file's new time against its own previous time.
1266 ;;;                (current-time)
1267                    file-time
1268                    ))
1269           (funcall (intern (format "%s-request-list" backend)))
1270 ;;; dmoore@ucsd.edu 25.10.96
1271 ;;; BACKEND-request-list already does this itself!
1272 ;;;       (set (intern (format "%s-group-alist" backend)) 
1273 ;;;            (nnmail-get-active))
1274           ))
1275     t))
1276
1277 (defun nnmail-message-id ()
1278   (concat "<" (message-unique-id) "@totally-fudged-out-message-id>"))
1279
1280 ;;;
1281 ;;; nnmail duplicate handling
1282 ;;;
1283
1284 (defvar nnmail-cache-buffer nil)
1285
1286 (defun nnmail-cache-open ()
1287   (if (or (not nnmail-treat-duplicates)
1288           (and nnmail-cache-buffer
1289                (buffer-name nnmail-cache-buffer)))
1290       ()                                ; The buffer is open.
1291     (save-excursion
1292       (set-buffer 
1293        (setq nnmail-cache-buffer 
1294              (get-buffer-create " *nnmail message-id cache*")))
1295       (buffer-disable-undo (current-buffer))
1296       (when (file-exists-p nnmail-message-id-cache-file)
1297         (nnheader-insert-file-contents nnmail-message-id-cache-file))
1298       (set-buffer-modified-p nil)
1299       (current-buffer))))
1300
1301 (defun nnmail-cache-close ()
1302   (when (and nnmail-cache-buffer
1303              nnmail-treat-duplicates
1304              (buffer-name nnmail-cache-buffer)
1305              (buffer-modified-p nnmail-cache-buffer))
1306     (save-excursion
1307       (set-buffer nnmail-cache-buffer)
1308       ;; Weed out the excess number of Message-IDs.
1309       (goto-char (point-max))
1310       (when (search-backward "\n" nil t nnmail-message-id-cache-length)
1311         (progn
1312           (beginning-of-line)
1313           (delete-region (point-min) (point))))
1314       ;; Save the buffer.
1315       (or (file-exists-p (file-name-directory nnmail-message-id-cache-file))
1316           (make-directory (file-name-directory nnmail-message-id-cache-file)
1317                           t))
1318       (nnmail-write-region (point-min) (point-max)
1319                            nnmail-message-id-cache-file nil 'silent)
1320       (set-buffer-modified-p nil)
1321       (setq nnmail-cache-buffer nil)
1322       ;;(kill-buffer (current-buffer))
1323       )))
1324
1325 (defun nnmail-cache-insert (id)
1326   (when nnmail-treat-duplicates
1327     (save-excursion
1328       (set-buffer nnmail-cache-buffer)
1329       (goto-char (point-max))
1330       (insert id "\n"))))
1331
1332 (defun nnmail-cache-id-exists-p (id)
1333   (when nnmail-treat-duplicates
1334     (save-excursion
1335       (set-buffer nnmail-cache-buffer)
1336       (goto-char (point-max))
1337       (search-backward id nil t))))
1338
1339 (defun nnmail-check-duplication (message-id func artnum-func)
1340   (run-hooks 'nnmail-prepare-incoming-message-hook)
1341   ;; If this is a duplicate message, then we do not save it.
1342   (let* ((duplication (nnmail-cache-id-exists-p message-id))
1343          (case-fold-search t)
1344          (action (when duplication
1345                    (cond
1346                     ((memq nnmail-treat-duplicates '(warn delete))
1347                      nnmail-treat-duplicates)
1348                     ((nnheader-functionp nnmail-treat-duplicates)
1349                      (funcall nnmail-treat-duplicates message-id))
1350                     (t
1351                      nnmail-treat-duplicates))))
1352          group-art)
1353     ;; Let the backend save the article (or not).
1354     (cond
1355      ((not duplication)
1356       (nnmail-cache-insert message-id)
1357       (funcall func (setq group-art
1358                           (nreverse (nnmail-article-group artnum-func)))))
1359      ((eq action 'delete)
1360       (setq group-art nil))
1361      ((eq action 'warn)
1362       ;; We insert a warning.
1363       (let ((case-fold-search t)
1364             (newid (nnmail-message-id)))
1365         (goto-char (point-min))
1366         (when (re-search-forward "^message-id:" nil t)
1367           (beginning-of-line)
1368           (insert "Original-"))
1369         (beginning-of-line)
1370         (insert 
1371          "Message-ID: " newid "\n"
1372          "Gnus-Warning: This is a duplicate of message " message-id "\n")
1373         (nnmail-cache-insert newid)
1374         (funcall func (setq group-art
1375                             (nreverse (nnmail-article-group artnum-func))))))
1376      (t
1377       (funcall func (setq group-art
1378                           (nreverse (nnmail-article-group artnum-func))))))
1379     ;; Add the group-art list to the history list.
1380     (if group-art
1381         (push group-art nnmail-split-history)
1382       (delete-region (point-min) (point-max)))))
1383
1384 ;;; Get new mail.
1385
1386 (defun nnmail-get-value (&rest args)
1387   (let ((sym (intern (apply 'format args))))
1388     (when (boundp sym)
1389       (symbol-value sym))))
1390
1391 (defun nnmail-get-new-mail (method exit-func temp
1392                                    &optional group spool-func)
1393   "Read new incoming mail."
1394   ;; Nix out the previous split history.
1395   (unless group
1396     (setq nnmail-split-history nil))
1397   (let* ((spools (nnmail-get-spool-files group))
1398          (group-in group)
1399          incoming incomings spool)
1400     (when (and (nnmail-get-value "%s-get-new-mail" method)
1401                nnmail-spool-file)
1402       ;; We first activate all the groups.
1403       (nnmail-activate method)
1404       ;; Allow the user to hook.
1405       (run-hooks 'nnmail-pre-get-new-mail-hook)
1406       ;; Open the message-id cache.
1407       (nnmail-cache-open)
1408       ;; The we go through all the existing spool files and split the
1409       ;; mail from each.
1410       (while spools
1411         (setq spool (pop spools))
1412         ;; We read each spool file if either the spool is a POP-mail
1413         ;; spool, or the file exists.  We can't check for the
1414         ;; existence of POPped mail.
1415         (when (or (string-match "^po:" spool)
1416                   (and (file-exists-p spool)
1417                        (> (nnheader-file-size (file-truename spool)) 0)))
1418           (nnheader-message 3 "%s: Reading incoming mail..." method)
1419           (when (and (nnmail-move-inbox spool)
1420                      (file-exists-p nnmail-crash-box))
1421             ;; There is new mail.  We first find out if all this mail
1422             ;; is supposed to go to some specific group.
1423             (setq group (nnmail-get-split-group spool group-in))
1424             ;; We split the mail
1425             (nnmail-split-incoming 
1426              nnmail-crash-box (intern (format "%s-save-mail" method))
1427              spool-func group (intern (format "%s-active-number" method)))
1428             ;; Check whether the inbox is to be moved to the special tmp dir. 
1429             (setq incoming
1430                   (nnmail-make-complex-temp-name 
1431                    (expand-file-name 
1432                     (if nnmail-tmp-directory
1433                         (concat 
1434                          (file-name-as-directory nnmail-tmp-directory)
1435                          (file-name-nondirectory (concat temp "Incoming")))
1436                       (concat temp "Incoming")))))
1437             (rename-file nnmail-crash-box incoming t)
1438             (push incoming incomings))))
1439       ;; If we did indeed read any incoming spools, we save all info. 
1440       (when incomings
1441         (nnmail-save-active 
1442          (nnmail-get-value "%s-group-alist" method)
1443          (nnmail-get-value "%s-active-file" method))
1444         (when exit-func
1445           (funcall exit-func))
1446         (run-hooks 'nnmail-read-incoming-hook)
1447         (nnheader-message 3 "%s: Reading incoming mail...done" method))
1448       ;; Close the message-id cache.
1449       (nnmail-cache-close)
1450       ;; Allow the user to hook.
1451       (run-hooks 'nnmail-post-get-new-mail-hook)
1452       ;; Delete all the temporary files.
1453       (while incomings
1454         (setq incoming (pop incomings))
1455         (and nnmail-delete-incoming
1456              (file-exists-p incoming)
1457              (file-writable-p incoming)
1458              (delete-file incoming))))))
1459
1460 (defun nnmail-expired-article-p (group time force &optional inhibit)
1461   "Say whether an article that is TIME old in GROUP should be expired."
1462   (if force
1463       t
1464     (let ((days (or (and nnmail-expiry-wait-function
1465                          (funcall nnmail-expiry-wait-function group))
1466                     nnmail-expiry-wait)))
1467       (cond ((or (eq days 'never)
1468                  (and (not force)
1469                       inhibit))
1470              ;; This isn't an expirable group.
1471              nil)
1472             ((eq days 'immediate)
1473              ;; We expire all articles on sight.
1474              t)
1475             ((equal time '(0 0))
1476              ;; This is an ange-ftp group, and we don't have any dates.
1477              nil)
1478             ((numberp days)
1479              (setq days (nnmail-days-to-time days))
1480              ;; Compare the time with the current time.
1481              (nnmail-time-less days (nnmail-time-since time)))))))
1482
1483 (defvar nnmail-read-passwd nil)
1484 (defun nnmail-read-passwd (prompt &rest args)
1485   "Read a password using PROMPT.
1486 If ARGS, PROMPT is used as an argument to `format'."
1487   (let ((prompt
1488          (if args
1489              (apply 'format prompt args)
1490            prompt)))
1491     (unless nnmail-read-passwd
1492       (if (load "passwd" t)
1493           (setq nnmail-read-passwd 'read-passwd)
1494         (autoload 'ange-ftp-read-passwd "ange-ftp")
1495         (setq nnmail-read-passwd 'ange-ftp-read-passwd)))
1496     (funcall nnmail-read-passwd prompt)))
1497
1498 (defun nnmail-check-syntax ()
1499   "Check (and modify) the syntax of the message in the current buffer."
1500   (save-restriction
1501     (message-narrow-to-head)
1502     (let ((case-fold-search t))
1503       (unless (re-search-forward "^Message-ID:" nil t)
1504         (insert "Message-ID: " (nnmail-message-id) "\n")))))
1505
1506 (defun nnmail-write-region (start end filename &optional append visit lockname)
1507   "Do a `write-region', and then set the file modes."
1508   (write-region start end filename append visit lockname)
1509   (set-file-modes filename nnmail-default-file-modes))
1510
1511 ;;;
1512 ;;; Status functions
1513 ;;;
1514
1515 (defun nnmail-replace-status (name value)
1516   "Make status NAME and VALUE part of the current status line."
1517   (save-restriction
1518     (message-narrow-to-head)
1519     (let ((status (nnmail-decode-status)))
1520       (setq status (delq (member name status) status))
1521       (when value
1522         (push (cons name value) status))
1523       (message-remove-header "status")
1524       (goto-char (point-max))
1525       (insert "Status: " (nnmail-encode-status status) "\n"))))
1526
1527 (defun nnmail-decode-status ()
1528   "Return a status-value alist from STATUS."
1529   (goto-char (point-min))
1530   (when (re-search-forward "^Status: " nil t)
1531     (let (name value status)
1532       (save-restriction
1533         ;; Narrow to the status.
1534         (narrow-to-region
1535          (point)
1536          (if (re-search-forward "^[^ \t]" nil t)
1537              (1- (point))
1538            (point-max)))
1539         ;; Go through all elements and add them to the list.
1540         (goto-char (point-min))
1541         (while (re-search-forward "[^ \t=]+" nil t)
1542           (setq name (match-string 0))
1543           (if (not (= (following-char) ?=))
1544               ;; Implied "yes".
1545               (setq value "yes")
1546             (forward-char 1)
1547             (if (not (= (following-char) ?\"))
1548                 (if (not (looking-at "[^ \t]"))
1549                     ;; Implied "no".
1550                     (setq value "no")
1551                   ;; Unquoted value.
1552                   (setq value (match-string 0))
1553                   (goto-char (match-end 0)))
1554               ;; Quoted value.
1555               (setq value (read (current-buffer)))))
1556           (push (cons name value) status)))
1557       status)))
1558
1559 (defun nnmail-encode-status (status)
1560   "Return a status string from STATUS."
1561   (mapconcat
1562    (lambda (elem)
1563      (concat
1564       (car elem) "="
1565       (if (string-match "[ \t]" (cdr elem))
1566           (prin1-to-string (cdr elem))
1567         (cdr elem))))
1568    status " "))
1569
1570 (defun nnmail-split-history ()
1571   "Generate an overview of where the last mail split put articles."
1572   (interactive)
1573   (unless nnmail-split-history
1574     (error "No current split history"))
1575   (pop-to-buffer "*nnmail split history*")
1576   (buffer-disable-undo (current-buffer))
1577   (erase-buffer)
1578   (let ((history nnmail-split-history)
1579         elem)
1580     (while (setq elem (pop history))
1581       (insert (mapconcat (lambda (ga)
1582                            (concat (car ga) ":" (int-to-string (cdr ga))))
1583                          elem
1584                          ", ")
1585               "\n"))
1586     (goto-char (point-min))))
1587
1588 (defun nnmail-new-mail-p (group)
1589   "Say whether GROUP has new mail."
1590   (let ((his nnmail-split-history)
1591         found)
1592     (while his
1593       (when (assoc group (pop his))
1594         (setq found t
1595               his nil)))
1596     found))
1597         
1598 (run-hooks 'nnmail-load-hook)
1599             
1600 (provide 'nnmail)
1601
1602 ;;; nnmail.el ends here