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