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