*** 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 moced 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     (while (not (eobp))
644       (goto-char (point-min))
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-literally 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             ;; `nnmail-split-methods' is a function, so we just call 
939             ;; this function here and use the result.
940             (setq group-art
941                   (mapcar
942                    (lambda (group) (cons group (funcall func group)))
943                    (condition-case nil
944                        (or (funcall nnmail-split-methods)
945                            '("bogus"))
946                      (error
947                       (message 
948                        "Error in `nnmail-split-methods'; using `bogus' mail group")
949                       (sit-for 1)
950                       '("bogus")))))
951           ;; Go through the split methods to find a match.
952           (while (and methods (or nnmail-crosspost (not group-art)))
953             (goto-char (point-max))
954             (setq method (pop methods))
955             (if (or methods
956                     (not (equal "" (nth 1 method))))
957                 (when (and
958                        (ignore-errors
959                          (if (stringp (nth 1 method))
960                              (re-search-backward (cadr method) nil t)
961                            ;; Function to say whether this is a match.
962                            (funcall (nth 1 method) (car method))))
963                        ;; Don't enter the article into the same 
964                        ;; group twice.
965                        (not (assoc (car method) group-art)))
966                   (push (cons (car method) (funcall func (car method)))
967                         group-art))
968               ;; This is the final group, which is used as a 
969               ;; catch-all.
970               (unless group-art
971                 (setq group-art 
972                       (list (cons (car method)
973                                   (funcall func (car method)))))))))
974         ;; See whether the split methods returned `junk'.
975         (if (equal group-art '(junk))
976             nil
977           (nreverse (delq 'junk group-art)))))))
978
979 (defun nnmail-insert-lines ()
980   "Insert how many lines there are in the body of the mail.
981 Return the number of characters in the body."
982   (let (lines chars)
983     (save-excursion
984       (goto-char (point-min))
985       (when (search-forward "\n\n" nil t)
986         (setq chars (- (point-max) (point)))
987         (setq lines (count-lines (point) (point-max)))
988         (forward-char -1)
989         (save-excursion
990           (when (re-search-backward "^Lines: " nil t)
991             (delete-region (point) (progn (forward-line 1) (point)))))
992         (beginning-of-line)
993         (insert (format "Lines: %d\n" (max lines 0)))
994         chars))))
995
996 (defun nnmail-insert-xref (group-alist)
997   "Insert an Xref line based on the (group . article) alist."
998   (save-excursion
999     (goto-char (point-min))
1000     (when (search-forward "\n\n" nil t)
1001       (forward-char -1)
1002       (when (re-search-backward "^Xref: " nil t)
1003         (delete-region (match-beginning 0)
1004                        (progn (forward-line 1) (point))))
1005       (insert (format "Xref: %s" (system-name)))
1006       (while group-alist
1007         (insert (format " %s:%d" (caar group-alist) (cdar group-alist)))
1008         (setq group-alist (cdr group-alist)))
1009       (insert "\n"))))
1010
1011 ;;; Message washing functions
1012
1013 (defun nnmail-remove-leading-whitespace ()
1014   "Remove excessive whitespace from all headers."
1015   (goto-char (point-min))
1016   (while (re-search-forward "^\\([^ :]+: \\) +" nil t)
1017     (replace-match "\\1" t t)))
1018
1019 (defun nnmail-remove-list-identifiers ()
1020   "Remove list identifiers from Subject headers."
1021   (let ((regexp (if (stringp nnmail-list-identifiers) nnmail-list-identifiers
1022                   (mapconcat 'identity nnmail-list-identifiers "\\|"))))
1023     (when regexp
1024       (goto-char (point-min))
1025       (when (re-search-forward
1026              (concat "Subject: +\\(Re: +\\)?\\(" regexp "\\) *")
1027              nil t)
1028         (delete-region (match-beginning 2) (match-end 0))))))
1029
1030 (defun nnmail-remove-tabs ()
1031   "Translate TAB characters into SPACE characters."
1032   (subst-char-in-region (point-min) (point-max) ?\t ?  t))
1033
1034 ;;; Utility functions
1035
1036 ;; Written by byer@mv.us.adobe.com (Scott Byer).
1037 (defun nnmail-make-complex-temp-name (prefix)
1038   (let ((newname (make-temp-name prefix))
1039         (newprefix prefix))
1040     (while (file-exists-p newname)
1041       (setq newprefix (concat newprefix "x"))
1042       (setq newname (make-temp-name newprefix)))
1043     newname))
1044
1045 ;; Written by Per Abrahamsen <amanda@iesd.auc.dk>.
1046
1047 (defun nnmail-split-fancy ()
1048   "Fancy splitting method.
1049 See the documentation for the variable `nnmail-split-fancy' for documentation."
1050   (let ((syntab (syntax-table)))
1051     (unwind-protect
1052         (progn
1053           (set-syntax-table nnmail-split-fancy-syntax-table)
1054           (nnmail-split-it nnmail-split-fancy))
1055       (set-syntax-table syntab))))
1056
1057 (defvar nnmail-split-cache nil)
1058 ;; Alist of split expressions their equivalent regexps.
1059
1060 (defun nnmail-split-it (split)
1061   ;; Return a list of groups matching SPLIT.
1062   (cond
1063    ;; nil split
1064    ((null split)
1065     nil)
1066
1067    ;; A group name.  Do the \& and \N subs into the string.
1068    ((stringp split)
1069     (list (nnmail-expand-newtext split)))
1070
1071    ;; Junk the message.
1072    ((eq split 'junk)
1073     (list 'junk))
1074
1075    ;; Builtin & operation.
1076    ((eq (car split) '&)
1077     (apply 'nconc (mapcar 'nnmail-split-it (cdr split))))
1078
1079    ;; Builtin | operation.
1080    ((eq (car split) '|)
1081     (let (done)
1082       (while (and (not done) (cdr split))
1083         (setq split (cdr split)
1084               done (nnmail-split-it (car split))))
1085       done))
1086
1087    ;; Builtin : operation.
1088    ((eq (car split) ':)
1089     (nnmail-split-it (eval (cdr split))))
1090
1091    ;; Check the cache for the regexp for this split.
1092    ;; FIX FIX FIX could avoid calling assq twice here
1093    ((assq split nnmail-split-cache)
1094     (goto-char (point-max))
1095     ;; FIX FIX FIX problem with re-search-backward is that if you have
1096     ;; a split: (from "foo-\\(bar\\|baz\\)@gnus.org "mail.foo.\\1")
1097     ;; and someone mails a message with 'To: foo-bar@gnus.org' and
1098     ;; 'CC: foo-baz@gnus.org', we'll pick 'mail.foo.baz' as the group
1099     ;; if the cc line is a later header, even though the other choice
1100     ;; is probably better.  Also, this routine won't do a crosspost
1101     ;; when there are two different matches.
1102     ;; I guess you could just make this more determined, and it could
1103     ;; look for still more matches prior to this one, and recurse
1104     ;; on each of the multiple matches hit.  Of course, then you'd
1105     ;; want to make sure that nnmail-article-group or nnmail-split-fancy
1106     ;; removed duplicates, since there might be more of those.
1107     ;; I guess we could also remove duplicates in the & split case, since
1108     ;; that's the only thing that can introduce them.
1109     (when (re-search-backward (cdr (assq split nnmail-split-cache)) nil t)
1110       ;; Someone might want to do a \N sub on this match, so get the
1111       ;; correct match positions.
1112       (goto-char (match-end 0))
1113       (let ((value (nth 1 split)))
1114         (re-search-backward (if (symbolp value)
1115                                 (cdr (assq value nnmail-split-abbrev-alist))
1116                               value)
1117                             (match-end 1)))
1118       (nnmail-split-it (nth 2 split))))
1119
1120    ;; Not in cache, compute a regexp for the field/value pair.
1121    (t
1122     (let* ((field (nth 0 split))
1123            (value (nth 1 split))
1124            (regexp (concat "^\\(\\("
1125                            (if (symbolp field)
1126                                (cdr (assq field nnmail-split-abbrev-alist))
1127                              field)
1128                            "\\):.*\\)\\<\\("
1129                            (if (symbolp value)
1130                                (cdr (assq value nnmail-split-abbrev-alist))
1131                              value)
1132                            "\\)\\>")))
1133       (push (cons split regexp) nnmail-split-cache)
1134       ;; Now that it's in the cache, just call nnmail-split-it again
1135       ;; on the same split, which will find it immediately in the cache.
1136       (nnmail-split-it split)))))
1137
1138 (defun nnmail-expand-newtext (newtext)
1139   (let ((len (length newtext))
1140         (pos 0)
1141         c expanded beg N did-expand)
1142     (while (< pos len)
1143       (setq beg pos)
1144       (while (and (< pos len)
1145                   (not (= (aref newtext pos) ?\\)))
1146         (setq pos (1+ pos)))
1147       (unless (= beg pos)
1148         (push (substring newtext beg pos) expanded))
1149       (when (< pos len)
1150         ;; we hit a \, expand it.
1151         (setq did-expand t)
1152         (setq pos (1+ pos))
1153         (setq c (aref newtext pos))
1154         (if (not (or (= c ?\&)
1155                      (and (>= c ?1)
1156                           (<= c ?9))))
1157             ;; \ followed by some character we don't expand
1158             (push (char-to-string c) expanded)
1159           ;; \& or \N
1160           (if (= c ?\&)
1161               (setq N 0)
1162             (setq N (- c ?0)))
1163           (when (match-beginning N)
1164             (push (buffer-substring (match-beginning N) (match-end N))
1165                   expanded))))
1166       (setq pos (1+ pos)))
1167     (if did-expand
1168         (apply 'concat (nreverse expanded))
1169       newtext)))
1170
1171 ;; Get a list of spool files to read.
1172 (defun nnmail-get-spool-files (&optional group)
1173   (if (null nnmail-spool-file)
1174       ;; No spool file whatsoever.
1175       nil
1176     (let* ((procmails 
1177             ;; If procmail is used to get incoming mail, the files
1178             ;; are stored in this directory.
1179             (and (file-exists-p nnmail-procmail-directory)
1180                  (or (eq nnmail-spool-file 'procmail)
1181                      nnmail-use-procmail)
1182                  (directory-files 
1183                   nnmail-procmail-directory 
1184                   t (concat (if group (concat "^" group) "")
1185                             nnmail-procmail-suffix "$"))))
1186            (p procmails)
1187            (crash (when (and (file-exists-p nnmail-crash-box)
1188                              (> (nnheader-file-size
1189                                  (file-truename nnmail-crash-box))
1190                                 0))
1191                     (list nnmail-crash-box))))
1192       ;; Remove any directories that inadvertently match the procmail
1193       ;; suffix, which might happen if the suffix is "". 
1194       (while p
1195         (when (file-directory-p (car p))
1196           (setq procmails (delete (car p) procmails)))
1197         (setq p (cdr p)))
1198       ;; Return the list of spools.
1199       (append 
1200        crash
1201        (cond ((and group
1202                    (or (eq nnmail-spool-file 'procmail)
1203                        nnmail-use-procmail)
1204                    procmails)
1205               procmails)
1206              ((and group
1207                    (eq nnmail-spool-file 'procmail))
1208               nil)
1209              ((listp nnmail-spool-file)
1210               (nconc
1211                (apply 
1212                 'nconc
1213                 (mapcar 
1214                  (lambda (file)
1215                    (if (file-directory-p file)
1216                        (nnheader-directory-regular-files file)
1217                      (list file)))
1218                  nnmail-spool-file))
1219                procmails))
1220              ((and (stringp nnmail-spool-file)
1221                    (not (file-directory-p nnmail-spool-file)))
1222               (cons nnmail-spool-file procmails))
1223              ((and (stringp nnmail-spool-file)
1224                    (file-directory-p nnmail-spool-file))
1225               (nconc
1226                (nnheader-directory-regular-files nnmail-spool-file)
1227                procmails))
1228              ((eq nnmail-spool-file 'pop)
1229               (cons (format "po:%s" (user-login-name)) procmails))
1230              (t
1231               procmails))))))
1232
1233 ;; Activate a backend only if it isn't already activated. 
1234 ;; If FORCE, re-read the active file even if the backend is 
1235 ;; already activated.
1236 (defun nnmail-activate (backend &optional force)
1237   (let (file timestamp file-time)
1238     (if (or (not (symbol-value (intern (format "%s-group-alist" backend))))
1239             force
1240             (and (setq file (ignore-errors
1241                               (symbol-value (intern (format "%s-active-file" 
1242                                                             backend)))))
1243                  (setq file-time (nth 5 (file-attributes file)))
1244                  (or (not
1245                       (setq timestamp
1246                             (condition-case ()
1247                                 (symbol-value (intern
1248                                                (format "%s-active-timestamp" 
1249                                                        backend)))
1250                               (error 'none))))
1251                      (not (consp timestamp))
1252                      (equal timestamp '(0 0))
1253                      (> (nth 0 file-time) (nth 0 timestamp))
1254                      (and (= (nth 0 file-time) (nth 0 timestamp))
1255                           (> (nth 1 file-time) (nth 1 timestamp))))))
1256         (save-excursion
1257           (or (eq timestamp 'none)
1258               (set (intern (format "%s-active-timestamp" backend)) 
1259 ;;; dmoore@ucsd.edu 25.10.96
1260 ;;; it's not always the case that current-time
1261 ;;; does correspond to changes in the file's time.  So just compare
1262 ;;; the file's new time against its own previous time.
1263 ;;;                (current-time)
1264                    file-time
1265                    ))
1266           (funcall (intern (format "%s-request-list" backend)))
1267 ;;; dmoore@ucsd.edu 25.10.96
1268 ;;; BACKEND-request-list already does this itself!
1269 ;;;       (set (intern (format "%s-group-alist" backend)) 
1270 ;;;            (nnmail-get-active))
1271           ))
1272     t))
1273
1274 (defun nnmail-message-id ()
1275   (concat "<" (message-unique-id) "@totally-fudged-out-message-id>"))
1276
1277 ;;;
1278 ;;; nnmail duplicate handling
1279 ;;;
1280
1281 (defvar nnmail-cache-buffer nil)
1282
1283 (defun nnmail-cache-open ()
1284   (if (or (not nnmail-treat-duplicates)
1285           (and nnmail-cache-buffer
1286                (buffer-name nnmail-cache-buffer)))
1287       ()                                ; The buffer is open.
1288     (save-excursion
1289       (set-buffer 
1290        (setq nnmail-cache-buffer 
1291              (get-buffer-create " *nnmail message-id cache*")))
1292       (buffer-disable-undo (current-buffer))
1293       (when (file-exists-p nnmail-message-id-cache-file)
1294         (insert-file-contents nnmail-message-id-cache-file))
1295       (set-buffer-modified-p nil)
1296       (current-buffer))))
1297
1298 (defun nnmail-cache-close ()
1299   (when (and nnmail-cache-buffer
1300              nnmail-treat-duplicates
1301              (buffer-name nnmail-cache-buffer)
1302              (buffer-modified-p nnmail-cache-buffer))
1303     (save-excursion
1304       (set-buffer nnmail-cache-buffer)
1305       ;; Weed out the excess number of Message-IDs.
1306       (goto-char (point-max))
1307       (when (search-backward "\n" nil t nnmail-message-id-cache-length)
1308         (progn
1309           (beginning-of-line)
1310           (delete-region (point-min) (point))))
1311       ;; Save the buffer.
1312       (or (file-exists-p (file-name-directory nnmail-message-id-cache-file))
1313           (make-directory (file-name-directory nnmail-message-id-cache-file)
1314                           t))
1315       (nnmail-write-region (point-min) (point-max)
1316                            nnmail-message-id-cache-file nil 'silent)
1317       (set-buffer-modified-p nil)
1318       (setq nnmail-cache-buffer nil)
1319       ;;(kill-buffer (current-buffer))
1320       )))
1321
1322 (defun nnmail-cache-insert (id)
1323   (when nnmail-treat-duplicates
1324     (save-excursion
1325       (set-buffer nnmail-cache-buffer)
1326       (goto-char (point-max))
1327       (insert id "\n"))))
1328
1329 (defun nnmail-cache-id-exists-p (id)
1330   (when nnmail-treat-duplicates
1331     (save-excursion
1332       (set-buffer nnmail-cache-buffer)
1333       (goto-char (point-max))
1334       (search-backward id nil t))))
1335
1336 (defun nnmail-check-duplication (message-id func artnum-func)
1337   (run-hooks 'nnmail-prepare-incoming-message-hook)
1338   ;; If this is a duplicate message, then we do not save it.
1339   (let* ((duplication (nnmail-cache-id-exists-p message-id))
1340          (case-fold-search t)
1341          (action (when duplication
1342                    (cond
1343                     ((memq nnmail-treat-duplicates '(warn delete))
1344                      nnmail-treat-duplicates)
1345                     ((nnheader-functionp nnmail-treat-duplicates)
1346                      (funcall nnmail-treat-duplicates message-id))
1347                     (t
1348                      nnmail-treat-duplicates))))
1349          group-art)
1350     ;; Let the backend save the article (or not).
1351     (cond
1352      ((not duplication)
1353       (nnmail-cache-insert message-id)
1354       (funcall func (setq group-art
1355                           (nreverse (nnmail-article-group artnum-func)))))
1356      ((eq action 'delete)
1357       (setq group-art nil))
1358      ((eq action 'warn)
1359       ;; We insert a warning.
1360       (let ((case-fold-search t)
1361             (newid (nnmail-message-id)))
1362         (goto-char (point-min))
1363         (when (re-search-forward "^message-id:" nil t)
1364           (beginning-of-line)
1365           (insert "Original-"))
1366         (beginning-of-line)
1367         (insert 
1368          "Message-ID: " newid "\n"
1369          "Gnus-Warning: This is a duplicate of message " message-id "\n")
1370         (nnmail-cache-insert newid)
1371         (funcall func (setq group-art
1372                             (nreverse (nnmail-article-group artnum-func))))))
1373      (t
1374       (funcall func (setq group-art
1375                           (nreverse (nnmail-article-group artnum-func))))))
1376     ;; Add the group-art list to the history list.
1377     (if group-art
1378         (push group-art nnmail-split-history)
1379       (delete-region (point-min) (point-max)))))
1380
1381 ;;; Get new mail.
1382
1383 (defun nnmail-get-value (&rest args)
1384   (let ((sym (intern (apply 'format args))))
1385     (when (boundp sym)
1386       (symbol-value sym))))
1387
1388 (defun nnmail-get-new-mail (method exit-func temp
1389                                    &optional group spool-func)
1390   "Read new incoming mail."
1391   ;; Nix out the previous split history.
1392   (unless group
1393     (setq nnmail-split-history nil))
1394   (let* ((spools (nnmail-get-spool-files group))
1395          (group-in group)
1396          incoming incomings spool)
1397     (when (and (nnmail-get-value "%s-get-new-mail" method)
1398                nnmail-spool-file)
1399       ;; We first activate all the groups.
1400       (nnmail-activate method)
1401       ;; Allow the user to hook.
1402       (run-hooks 'nnmail-pre-get-new-mail-hook)
1403       ;; Open the message-id cache.
1404       (nnmail-cache-open)
1405       ;; The we go through all the existing spool files and split the
1406       ;; mail from each.
1407       (while spools
1408         (setq spool (pop spools))
1409         ;; We read each spool file if either the spool is a POP-mail
1410         ;; spool, or the file exists.  We can't check for the
1411         ;; existence of POPped mail.
1412         (when (or (string-match "^po:" spool)
1413                   (and (file-exists-p spool)
1414                        (> (nnheader-file-size (file-truename spool)) 0)))
1415           (nnheader-message 3 "%s: Reading incoming mail..." method)
1416           (when (and (nnmail-move-inbox spool)
1417                      (file-exists-p nnmail-crash-box))
1418             ;; There is new mail.  We first find out if all this mail
1419             ;; is supposed to go to some specific group.
1420             (setq group (nnmail-get-split-group spool group-in))
1421             ;; We split the mail
1422             (nnmail-split-incoming 
1423              nnmail-crash-box (intern (format "%s-save-mail" method))
1424              spool-func group (intern (format "%s-active-number" method)))
1425             ;; Check whether the inbox is to be moved to the special tmp dir. 
1426             (setq incoming
1427                   (nnmail-make-complex-temp-name 
1428                    (expand-file-name 
1429                     (if nnmail-tmp-directory
1430                         (concat 
1431                          (file-name-as-directory nnmail-tmp-directory)
1432                          (file-name-nondirectory (concat temp "Incoming")))
1433                       (concat temp "Incoming")))))
1434             (rename-file nnmail-crash-box incoming t)
1435             (push incoming incomings))))
1436       ;; If we did indeed read any incoming spools, we save all info. 
1437       (when incomings
1438         (nnmail-save-active 
1439          (nnmail-get-value "%s-group-alist" method)
1440          (nnmail-get-value "%s-active-file" method))
1441         (when exit-func
1442           (funcall exit-func))
1443         (run-hooks 'nnmail-read-incoming-hook)
1444         (nnheader-message 3 "%s: Reading incoming mail...done" method))
1445       ;; Close the message-id cache.
1446       (nnmail-cache-close)
1447       ;; Allow the user to hook.
1448       (run-hooks 'nnmail-post-get-new-mail-hook)
1449       ;; Delete all the temporary files.
1450       (while incomings
1451         (setq incoming (pop incomings))
1452         (and nnmail-delete-incoming
1453              (file-exists-p incoming)
1454              (file-writable-p incoming)
1455              (delete-file incoming))))))
1456
1457 (defun nnmail-expired-article-p (group time force &optional inhibit)
1458   "Say whether an article that is TIME old in GROUP should be expired."
1459   (if force
1460       t
1461     (let ((days (or (and nnmail-expiry-wait-function
1462                          (funcall nnmail-expiry-wait-function group))
1463                     nnmail-expiry-wait)))
1464       (cond ((or (eq days 'never)
1465                  (and (not force)
1466                       inhibit))
1467              ;; This isn't an expirable group.
1468              nil)
1469             ((eq days 'immediate)
1470              ;; We expire all articles on sight.
1471              t)
1472             ((equal time '(0 0))
1473              ;; This is an ange-ftp group, and we don't have any dates.
1474              nil)
1475             ((numberp days)
1476              (setq days (nnmail-days-to-time days))
1477              ;; Compare the time with the current time.
1478              (nnmail-time-less days (nnmail-time-since time)))))))
1479
1480 (defvar nnmail-read-passwd nil)
1481 (defun nnmail-read-passwd (prompt &rest args)
1482   "Read a password using PROMPT.
1483 If ARGS, PROMPT is used as an argument to `format'."
1484   (let ((prompt
1485          (if args
1486              (apply 'format prompt args)
1487            prompt)))
1488     (unless nnmail-read-passwd
1489       (if (load "passwd" t)
1490           (setq nnmail-read-passwd 'read-passwd)
1491         (autoload 'ange-ftp-read-passwd "ange-ftp")
1492         (setq nnmail-read-passwd 'ange-ftp-read-passwd)))
1493     (funcall nnmail-read-passwd prompt)))
1494
1495 (defun nnmail-check-syntax ()
1496   "Check (and modify) the syntax of the message in the current buffer."
1497   (save-restriction
1498     (message-narrow-to-head)
1499     (let ((case-fold-search t))
1500       (unless (re-search-forward "^Message-ID:" nil t)
1501         (insert "Message-ID: " (nnmail-message-id) "\n")))))
1502
1503 (defun nnmail-write-region (start end filename &optional append visit lockname)
1504   "Do a `write-region', and then set the file modes."
1505   (write-region start end filename append visit lockname)
1506   (set-file-modes filename nnmail-default-file-modes))
1507
1508 ;;;
1509 ;;; Status functions
1510 ;;;
1511
1512 (defun nnmail-replace-status (name value)
1513   "Make status NAME and VALUE part of the current status line."
1514   (save-restriction
1515     (message-narrow-to-head)
1516     (let ((status (nnmail-decode-status)))
1517       (setq status (delq (member name status) status))
1518       (when value
1519         (push (cons name value) status))
1520       (message-remove-header "status")
1521       (goto-char (point-max))
1522       (insert "Status: " (nnmail-encode-status status) "\n"))))
1523
1524 (defun nnmail-decode-status ()
1525   "Return a status-value alist from STATUS."
1526   (goto-char (point-min))
1527   (when (re-search-forward "^Status: " nil t)
1528     (let (name value status)
1529       (save-restriction
1530         ;; Narrow to the status.
1531         (narrow-to-region
1532          (point)
1533          (if (re-search-forward "^[^ \t]" nil t)
1534              (1- (point))
1535            (point-max)))
1536         ;; Go through all elements and add them to the list.
1537         (goto-char (point-min))
1538         (while (re-search-forward "[^ \t=]+" nil t)
1539           (setq name (match-string 0))
1540           (if (not (= (following-char) ?=))
1541               ;; Implied "yes".
1542               (setq value "yes")
1543             (forward-char 1)
1544             (if (not (= (following-char) ?\"))
1545                 (if (not (looking-at "[^ \t]"))
1546                     ;; Implied "no".
1547                     (setq value "no")
1548                   ;; Unquoted value.
1549                   (setq value (match-string 0))
1550                   (goto-char (match-end 0)))
1551               ;; Quoted value.
1552               (setq value (read (current-buffer)))))
1553           (push (cons name value) status)))
1554       status)))
1555
1556 (defun nnmail-encode-status (status)
1557   "Return a status string from STATUS."
1558   (mapconcat
1559    (lambda (elem)
1560      (concat
1561       (car elem) "="
1562       (if (string-match "[ \t]" (cdr elem))
1563           (prin1-to-string (cdr elem))
1564         (cdr elem))))
1565    status " "))
1566
1567 (defun nnmail-split-history ()
1568   "Generate an overview of where the last mail split put articles."
1569   (interactive)
1570   (unless nnmail-split-history
1571     (error "No current split history"))
1572   (pop-to-buffer "*nnmail split history*")
1573   (buffer-disable-undo (current-buffer))
1574   (erase-buffer)
1575   (let ((history nnmail-split-history)
1576         elem)
1577     (while (setq elem (pop history))
1578       (insert (mapconcat (lambda (ga)
1579                            (concat (car ga) ":" (int-to-string (cdr ga))))
1580                          elem
1581                          ", ")
1582               "\n"))
1583     (goto-char (point-min))))
1584
1585 (defun nnmail-new-mail-p (group)
1586   "Say whether GROUP has new mail."
1587   (let ((his nnmail-split-history)
1588         found)
1589     (while his
1590       (when (assoc group (pop his))
1591         (setq found t
1592               his nil)))
1593     found))
1594         
1595 (run-hooks 'nnmail-load-hook)
1596             
1597 (provide 'nnmail)
1598
1599 ;;; nnmail.el ends here