1 ;;; nnmail.el --- mail support functions for the Gnus mail backends
3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Keywords: news, mail
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
30 (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
32 (eval-when-compile (require 'cl))
34 (require 'gnus) ; for macro gnus-kill-buffer, at least
38 (require 'mail-source)
42 (autoload 'gnus-add-buffer "gnus")
43 (autoload 'gnus-kill-buffer "gnus")
46 "Reading mail with Gnus."
49 (defgroup nnmail-retrieve nil
50 "Retrieving new mail."
53 (defgroup nnmail-prepare nil
54 "Preparing (or mangling) new mail after retrieval."
57 (defgroup nnmail-duplicate nil
58 "Handling of duplicate mail messages."
61 (defgroup nnmail-split nil
62 "Organizing the incoming mail in folders."
65 (defgroup nnmail-files nil
70 (defgroup nnmail-expire nil
74 (defgroup nnmail-procmail nil
75 "Interfacing with procmail and other mail agents."
78 (defgroup nnmail-various nil
79 "Various mail options."
82 (defcustom nnmail-split-methods '(("mail.misc" ""))
83 "*Incoming mail will be split according to this variable.
85 If you'd like, for instance, one mail group for mail from the
86 \"4ad-l\" mailing list, one group for junk mail and one for everything
87 else, you could do something like this:
89 (setq nnmail-split-methods
90 '((\"mail.4ad\" \"From:.*4ad\")
91 (\"mail.junk\" \"From:.*Lars\\\\|Subject:.*buy\")
92 (\"mail.misc\" \"\")))
94 As you can see, this variable is a list of lists, where the first
95 element in each \"rule\" is the name of the group (which, by the way,
96 does not have to be called anything beginning with \"mail\",
97 \"yonka.zow\" is a fine, fine name), and the second is a regexp that
98 nnmail will try to match on the header to find a fit.
100 The second element can also be a function. In that case, it will be
101 called narrowed to the headers with the first element of the rule as
102 the argument. It should return a non-nil value if it thinks that the
103 mail belongs in that group.
105 The last element should always have \"\" as the regexp.
107 This variable can also have a function as its value."
109 :type '(choice (repeat :tag "Alist" (group (string :tag "Name")
110 (choice regexp function)))
111 (function-item nnmail-split-fancy)
112 (function :tag "Other")))
114 ;; Suggested by Erik Selberg <speed@cs.washington.edu>.
115 (defcustom nnmail-crosspost t
116 "If non-nil, do crossposting if several split methods match the mail.
117 If nil, the first match found will be used."
121 (defcustom nnmail-split-fancy-with-parent-ignore-groups nil
122 "Regexp that matches group names to be ignored when applying `nnmail-split-fancy-with-parent'.
123 This can also be a list of regexps."
126 :type '(choice (const :tag "none" nil)
128 (repeat :value (".*") regexp)))
130 (defcustom nnmail-cache-ignore-groups nil
131 "Regexp that matches group names to be ignored when inserting message ids into the cache (`nnmail-cache-insert').
132 This can also be a list of regexps."
135 :type '(choice (const :tag "none" nil)
137 (repeat :value (".*") regexp)))
139 ;; Added by gord@enci.ucalgary.ca (Gordon Matzigkeit).
140 (defcustom nnmail-keep-last-article nil
141 "If non-nil, nnmail will never delete/move a group's last article.
142 It can be marked expirable, so it will be deleted when it is no longer last.
144 You may need to set this variable if other programs are putting
145 new mail into folder numbers that Gnus has marked as expired."
146 :group 'nnmail-procmail
147 :group 'nnmail-various
150 (defcustom nnmail-use-long-file-names nil
151 "If non-nil the mail backends will use long file and directory names.
152 If nil, groups like \"mail.misc\" will end up in directories like
157 (defcustom nnmail-default-file-modes 384
158 "Set the mode bits of all new mail files to this integer."
162 (defcustom nnmail-expiry-wait 7
163 "*Expirable articles that are older than this will be expired.
164 This variable can either be a number (which will be interpreted as a
165 number of days) -- this doesn't have to be an integer. This variable
166 can also be `immediate' and `never'."
167 :group 'nnmail-expire
168 :type '(choice (const immediate)
172 (defcustom nnmail-expiry-wait-function nil
173 "Variable that holds function to specify how old articles should be before they are expired.
174 The function will be called with the name of the group that the expiry
175 is to be performed in, and it should return an integer that says how
176 many days an article can be stored before it is considered \"old\".
177 It can also return the values `never' and `immediate'.
181 \(setq nnmail-expiry-wait-function
183 (cond ((string-match \"private\" newsgroup) 31)
184 ((string-match \"junk\" newsgroup) 1)
185 ((string-match \"important\" newsgroup) 'never)
187 :group 'nnmail-expire
188 :type '(choice (const :tag "nnmail-expiry-wait" nil)
189 (function :format "%v" nnmail-)))
191 (defcustom nnmail-expiry-target 'delete
192 "*Variable that says where expired messages should end up.
193 The default value is `delete' (which says to delete the messages),
194 but it can also be a string or a function. If it is a string, expired
195 messages end up in that group. If it is a function, the function is
196 called in a buffer narrowed to the message in question. The function
197 receives one argument, the name of the group the message comes from.
198 The return value should be `delete' or a group name (a string)."
200 :group 'nnmail-expire
201 :type '(choice (const delete)
205 (defcustom nnmail-fancy-expiry-targets nil
206 "Determine expiry target based on articles using fancy techniques.
208 This is a list of (\"HEADER\" \"REGEXP\" \"TARGET\") entries. If
209 `nnmail-expiry-target' is set to the function
210 `nnmail-fancy-expiry-target' and HEADER of the article matches REGEXP,
211 the message will be expired to a group determined by invoking
212 `format-time-string' with TARGET used as the format string and the
213 time extracted from the articles' Date header (if missing the current
216 In the special cases that HEADER is the symbol `to-from', the regexp
217 will try to match against both the From and the To header.
221 \(setq nnmail-fancy-expiry-targets
222 '((to-from \"boss\" \"nnfolder:Work\")
223 (\"Subject\" \"IMPORTANT\" \"nnfolder:IMPORTANT.%Y.%b\")
224 (\"from\" \".*\" \"nnfolder:Archive-%Y\")))
226 In this case, articles containing the string \"boss\" in the To or the
227 From header will be expired to the group \"nnfolder:Work\";
228 articles containing the sting \"IMPORTANT\" in the Subject header will
229 be expired to the group \"nnfolder:IMPORTANT.YYYY.MMM\"; and
230 everything else will be expired to \"nnfolder:Archive-YYYY\"."
232 :group 'nnmail-expire
233 :type '(repeat (list (choice :tag "Match against"
234 (string :tag "Header")
237 (string :tag "Target group format string"))))
239 (defcustom nnmail-cache-accepted-message-ids nil
240 "If non-nil, put Message-IDs of Gcc'd articles into the duplicate cache.
241 If non-nil, also update the cache when copy or move articles."
245 (make-obsolete-variable 'nnmail-spool-file 'mail-sources
246 "Gnus 5.9 (Emacs 22.1)")
247 ;; revision 5.29 / p0-85 / Gnus 5.9
248 ;; Variable removed in No Gnus v0.7
250 (defcustom nnmail-resplit-incoming nil
251 "*If non-nil, re-split incoming procmail sorted mail."
252 :group 'nnmail-procmail
255 (defcustom nnmail-scan-directory-mail-source-once nil
256 "*If non-nil, scan all incoming procmail sorted mails once.
257 It scans low-level sorted spools even when not required."
259 :group 'nnmail-procmail
262 (defcustom nnmail-delete-file-function 'delete-file
263 "Function called to delete files in some mail backends."
267 (defcustom nnmail-crosspost-link-function
268 (if (string-match "windows-nt" (symbol-name system-type))
271 "*Function called to create a copy of a file.
272 This is `add-name-to-file' by default, which means that crossposts
273 will use hard links. If your file system doesn't allow hard
274 links, you could set this variable to `copy-file' instead."
276 :type '(radio (function-item add-name-to-file)
277 (function-item copy-file)
278 (function :tag "Other")))
280 (defcustom nnmail-read-incoming-hook
281 (if (eq system-type 'windows-nt)
282 '(nnheader-ms-strip-cr)
284 "*Hook that will be run after the incoming mail has been transferred.
285 The incoming mail is moved from the specified spool file (which normally is
286 something like \"/usr/spool/mail/$user\") to the user's home
287 directory. This hook is called after the incoming mail box has been
288 emptied, and can be used to call any mail box programs you have
289 running (\"xwatch\", etc.)
293 \(add-hook 'nnmail-read-incoming-hook
295 (call-process \"/local/bin/mailsend\" nil nil nil
297 ;; The incoming mail box file.
298 (expand-file-name (user-login-name)
299 rmail-spool-directory))))
301 If you have xwatch running, this will alert it that mail has been
304 If you use `display-time', you could use something like this:
306 \(add-hook 'nnmail-read-incoming-hook
308 ;; Update the displayed time, since that will clear out
309 ;; the flag that says you have mail.
310 (when (eq (process-status \"display-time\") 'run)
311 (display-time-filter display-time-process \"\"))))"
312 :group 'nnmail-prepare
315 (defcustom nnmail-prepare-incoming-hook nil
316 "Hook called before treating incoming mail.
317 The hook is run in a buffer with all the new, incoming mail."
318 :group 'nnmail-prepare
321 (defcustom nnmail-prepare-incoming-header-hook nil
322 "Hook called narrowed to the headers of each message.
323 This can be used to remove excessive spaces (and stuff like
324 that) from the headers before splitting and saving the messages."
325 :group 'nnmail-prepare
328 (defcustom nnmail-prepare-incoming-message-hook nil
329 "Hook called narrowed to each message."
330 :group 'nnmail-prepare
333 (defcustom nnmail-list-identifiers nil
334 "Regexp that matches list identifiers to be removed.
335 This can also be a list of regexps."
336 :group 'nnmail-prepare
337 :type '(choice (const :tag "none" nil)
339 (repeat :value (".*") regexp)))
341 (defcustom nnmail-pre-get-new-mail-hook nil
342 "Hook called just before starting to handle new incoming mail."
343 :group 'nnmail-retrieve
346 (defcustom nnmail-post-get-new-mail-hook nil
347 "Hook called just after finishing handling new incoming mail."
348 :group 'nnmail-retrieve
351 (defcustom nnmail-split-hook nil
352 "Hook called before deciding where to split an article.
353 The functions in this hook are free to modify the buffer
354 contents in any way they choose -- the buffer contents are
355 discarded after running the split process."
359 (defcustom nnmail-spool-hook nil
360 "*A hook called when a new article is spooled."
365 (defcustom nnmail-large-newsgroup 50
366 "*The number of articles which indicates a large newsgroup or nil.
367 If the number of articles is greater than the value, verbose
368 messages will be shown to indicate the current status."
369 :group 'nnmail-various
370 :type '(choice (const :tag "infinite" nil)
371 (number :tag "count")))
373 (define-widget 'nnmail-lazy 'default
374 "Base widget for recursive datastructures.
376 This is copy of the `lazy' widget in Emacs 22.1 provided for compatibility."
378 :convert-widget 'widget-value-convert-widget
379 :value-create (lambda (widget)
380 (let ((value (widget-get widget :value))
381 (type (widget-get widget :type)))
382 (widget-put widget :children
383 (list (widget-create-child-value
384 widget (widget-convert type) value)))))
385 :value-delete 'widget-children-value-delete
386 :value-get (lambda (widget)
387 (widget-value (car (widget-get widget :children))))
388 :value-inline (lambda (widget)
389 (widget-apply (car (widget-get widget :children))
391 :default-get (lambda (widget)
393 (widget-convert (widget-get widget :type))))
394 :match (lambda (widget value)
395 (widget-apply (widget-convert (widget-get widget :type))
397 :validate (lambda (widget)
398 (widget-apply (car (widget-get widget :children)) :validate)))
400 (define-widget 'nnmail-split-fancy 'nnmail-lazy
401 "Widget for customizing splits in the variable of the same name."
403 :type '(menu-choice :value (any ".*value.*" "misc")
405 (string :tag "Destination")
406 (list :tag "Use first match (|)" :value (|)
408 (editable-list :inline t nnmail-split-fancy))
409 (list :tag "Use all matches (&)" :value (&)
411 (editable-list :inline t nnmail-split-fancy))
412 (list :tag "Function with fixed arguments (:)"
414 (const :format "" :value :)
416 (editable-list :inline t (sexp :tag "Arg"))
418 (list :tag "Function with split arguments (!)"
422 (editable-list :inline t nnmail-split-fancy))
423 (list :tag "Field match"
428 (symbol :value mail))
435 (const :tag "Junk (delete mail)" junk)))
437 (defcustom nnmail-split-fancy "mail.misc"
438 "Incoming mail can be split according to this fancy variable.
439 To enable this, set `nnmail-split-methods' to `nnmail-split-fancy'.
441 The format of this variable is SPLIT, where SPLIT can be one of
444 GROUP: Mail will be stored in GROUP (a string).
446 \(FIELD VALUE [- RESTRICT [- RESTRICT [...]]] SPLIT): If the message
447 field FIELD (a regexp) contains VALUE (a regexp), store the messages
448 as specified by SPLIT. If RESTRICT (a regexp) matches some string
449 after FIELD and before the end of the matched VALUE, return nil,
450 otherwise process SPLIT. Multiple RESTRICTs add up, further
451 restricting the possibility of processing SPLIT.
453 \(| SPLIT...): Process each SPLIT expression until one of them matches.
454 A SPLIT expression is said to match if it will cause the mail
455 message to be stored in one or more groups.
457 \(& SPLIT...): Process each SPLIT expression.
459 \(: FUNCTION optional args): Call FUNCTION with the optional args, in
460 the buffer containing the message headers. The return value FUNCTION
461 should be a split, which is then recursively processed.
463 \(! FUNCTION SPLIT): Call FUNCTION with the result of SPLIT. The
464 return value FUNCTION should be a split, which is then recursively
467 junk: Mail will be deleted. Use with care! Do not submerge in water!
469 (setq nnmail-split-fancy
470 '(| (\"Subject\" \"MAKE MONEY FAST\" junk)
471 ...other.rules.omitted...))
473 FIELD must match a complete field name. VALUE must match a complete
474 word according to the `nnmail-split-fancy-syntax-table' syntax table.
475 You can use \".*\" in the regexps to match partial field names or words.
477 FIELD and VALUE can also be Lisp symbols, in that case they are expanded
478 as specified in `nnmail-split-abbrev-alist'.
480 GROUP can contain \\& and \\N which will substitute from matching
481 \\(\\) patterns in the previous VALUE.
485 \(setq nnmail-split-methods 'nnmail-split-fancy
487 ;; Messages from the mailer daemon are not crossposted to any of
488 ;; the ordinary groups. Warnings are put in a separate group
490 '(| (\"from\" mail (| (\"subject\" \"warn.*\" \"mail.warning\")
492 ;; Non-error messages are crossposted to all relevant
493 ;; groups, but we don't crosspost between the group for the
494 ;; (ding) list and the group for other (ding) related mail.
495 (& (| (any \"ding@ifi\\\\.uio\\\\.no\" \"ding.list\")
496 (\"subject\" \"ding\" \"ding.misc\"))
497 ;; Other mailing lists...
498 (any \"procmail@informatik\\\\.rwth-aachen\\\\.de\" \"procmail.list\")
499 (any \"SmartList@informatik\\\\.rwth-aachen\\\\.de\" \"SmartList.list\")
500 ;; Both lists below have the same suffix, so prevent
501 ;; cross-posting to mkpkg.list of messages posted only to
502 ;; the bugs- list, but allow cross-posting when the
503 ;; message was really cross-posted.
504 (any \"bugs-mypackage@somewhere\" \"mypkg.bugs\")
505 (any \"mypackage@somewhere\" - \"bugs-mypackage\" \"mypkg.list\")
508 (any \"larsi@ifi\\\\.uio\\\\.no\" \"people.Lars Magne Ingebrigtsen\"))
509 ;; Unmatched mail goes to the catch all group.
512 :type 'nnmail-split-fancy)
514 (defcustom nnmail-split-abbrev-alist
515 '((any . "from\\|to\\|cc\\|sender\\|apparently-to\\|resent-from\\|resent-to\\|resent-cc")
516 (mail . "mailer-daemon\\|postmaster\\|uucp")
517 (to . "to\\|cc\\|apparently-to\\|resent-to\\|resent-cc")
518 (from . "from\\|sender\\|resent-from")
519 (nato . "to\\|cc\\|resent-to\\|resent-cc")
520 (naany . "from\\|to\\|cc\\|sender\\|resent-from\\|resent-to\\|resent-cc"))
521 "*Alist of abbreviations allowed in `nnmail-split-fancy'."
523 :type '(repeat (cons :format "%v" symbol regexp)))
525 (defcustom nnmail-message-id-cache-length 1000
526 "*The approximate number of Message-IDs nnmail will keep in its cache.
527 If this variable is nil, no checking on duplicate messages will be
529 :group 'nnmail-duplicate
530 :type '(choice (const :tag "disable" nil)
531 (integer :format "%v")))
533 (defcustom nnmail-message-id-cache-file
534 (nnheader-concat gnus-home-directory ".nnmail-cache")
535 "The file name of the nnmail Message-ID cache."
536 :group 'nnmail-duplicate
540 (defcustom nnmail-treat-duplicates 'warn
541 "*If non-nil, nnmail keep a cache of Message-IDs to discover mail duplicates.
542 Three values are valid: nil, which means that nnmail is not to keep a
543 Message-ID cache; `warn', which means that nnmail should insert extra
544 headers to warn the user about the duplication (this is the default);
545 and `delete', which means that nnmail will delete duplicated mails.
547 This variable can also be a function. It will be called from a buffer
548 narrowed to the article in question with the Message-ID as a
549 parameter. It should return nil, `warn' or `delete'."
550 :group 'nnmail-duplicate
551 :type '(choice (const :tag "off" nil)
555 (defcustom nnmail-extra-headers '(To Newsgroups)
556 "*Extra headers to parse."
559 :type '(repeat symbol))
561 (defcustom nnmail-split-header-length-limit 2048
562 "Header lines longer than this limit are excluded from the split function."
567 (defcustom nnmail-mail-splitting-charset nil
568 "Default charset to be used when splitting incoming mail."
573 (defcustom nnmail-mail-splitting-decodes nil
574 "Whether the nnmail splitting functionality should MIME decode headers."
579 (defcustom nnmail-split-fancy-match-partial-words nil
580 "Whether to match partial words when fancy splitting.
581 Normally, regexes given in `nnmail-split-fancy' are implicitly surrounded
582 by \"\\=\\<...\\>\". If this variable is true, they are not implicitly\
589 (defcustom nnmail-split-lowercase-expanded t
590 "Whether to lowercase expanded entries (i.e. \\N) when splitting mails.
591 This avoids the creation of multiple groups when users send to an address
592 using different case (i.e. mailing-list@domain vs Mailing-List@Domain)."
597 ;;; Internal variables.
599 (defvar nnmail-article-buffer " *nnmail incoming*"
600 "The buffer used for splitting incoming mails.")
602 (defvar nnmail-split-history nil
603 "List of group/article elements that say where the previous split put messages.")
605 (defvar nnmail-split-fancy-syntax-table
606 (let ((table (make-syntax-table)))
607 ;; support the %-hack
608 (modify-syntax-entry ?\% "." table)
610 "Syntax table used by `nnmail-split-fancy'.")
612 (defvar nnmail-prepare-save-mail-hook nil
613 "Hook called before saving mail.")
615 (defvar nnmail-split-tracing nil)
616 (defvar nnmail-split-trace nil)
617 (defvar nnmail-inhibit-default-split-group nil)
621 (defun nnmail-request-post (&optional server)
622 (mail-send-and-exit nil))
624 (defvar nnmail-file-coding-system 'raw-text
625 "Coding system used in nnmail.")
627 (defvar nnmail-incoming-coding-system
628 mm-text-coding-system
629 "Coding system used in reading inbox")
631 (defvar nnmail-pathname-coding-system
632 ;; This causes Emacs 22.2 and 22.3 to issue a useless warning.
633 ;;(if (and (featurep 'xemacs) (featurep 'file-coding))
634 (if (featurep 'xemacs)
635 (if (featurep 'file-coding)
636 ;; Work around a bug in many XEmacs 21.5 betas.
637 ;; Cf. http://thread.gmane.org/gmane.emacs.gnus.general/68134
638 (setq file-name-coding-system (coding-system-aliasee 'file-name))))
639 "*Coding system for file name.")
641 (defun nnmail-find-file (file)
642 "Insert FILE in server buffer safely."
643 (set-buffer nntp-server-buffer)
644 (delete-region (point-min) (point-max))
645 (let ((format-alist nil)
646 (after-insert-file-functions nil))
648 (let ((coding-system-for-read nnmail-file-coding-system)
649 (auto-mode-alist (mm-auto-mode-alist))
650 (file-name-coding-system nnmail-pathname-coding-system))
651 (insert-file-contents file)
655 (defun nnmail-group-pathname (group dir &optional file)
656 "Make file name for GROUP."
658 (let ((dir (file-name-as-directory (expand-file-name dir))))
659 (setq group (nnheader-replace-duplicate-chars-in-string
660 (nnheader-replace-chars-in-string group ?/ ?_)
662 (setq group (nnheader-translate-file-chars group))
663 ;; If this directory exists, we use it directly.
664 (file-name-as-directory
665 (if (or nnmail-use-long-file-names
666 (file-directory-p (concat dir group)))
667 (expand-file-name group dir)
668 ;; If not, we translate dots into slashes.
670 (nnheader-replace-chars-in-string group ?. ?/)
674 (defun nnmail-get-active ()
675 "Returns an assoc of group names and active ranges.
676 nn*-request-list should have been called before calling this function."
677 ;; Go through all groups from the active list.
678 (with-current-buffer nntp-server-buffer
679 (nnmail-parse-active)))
681 (defun nnmail-parse-active ()
682 "Parse the active file in the current buffer and return an alist."
683 (goto-char (point-min))
684 (unless (re-search-forward "[\\\"]" nil t)
685 (goto-char (point-max))
686 (while (re-search-backward "[][';?()#]" nil t)
688 (goto-char (point-min))
689 (let ((buffer (current-buffer))
690 group-assoc group max min)
694 (narrow-to-region (point) (point-at-eol))
695 (setq group (read buffer))
696 (unless (stringp group)
697 (setq group (symbol-name group)))
698 (if (and (numberp (setq max (read buffer)))
699 (numberp (setq min (read buffer))))
700 (push (list (mm-string-as-unibyte group) (cons min max))
707 (defvar nnmail-active-file-coding-system 'raw-text
708 "*Coding system for active file.")
710 (defun nnmail-save-active (group-assoc file-name)
711 "Save GROUP-ASSOC in ACTIVE-FILE."
712 (let ((coding-system-for-write nnmail-active-file-coding-system))
714 (with-temp-file file-name
715 (mm-disable-multibyte)
716 (nnmail-generate-active group-assoc)))))
718 (defun nnmail-generate-active (alist)
719 "Generate an active file from group-alist ALIST."
722 (while (setq group (pop alist))
723 (insert (format "%S %d %d y\n" (intern (car group)) (cdadr group)
725 (goto-char (point-max))
726 (while (search-backward "\\." nil t)
729 (defun nnmail-get-split-group (file source)
730 "Find out whether this FILE is to be split into GROUP only.
731 If SOURCE is a directory spec, try to return the group name component."
732 (if (eq (car source) 'directory)
733 (let ((file (file-name-nondirectory file)))
734 (mail-source-bind (directory source)
735 (if (string-match (concat (regexp-quote suffix) "$") file)
736 (substring file 0 (match-beginning 0))
740 (defun nnmail-process-babyl-mail-format (func artnum-func)
741 (let ((case-fold-search t)
743 start message-id content-length do-search end)
745 (goto-char (point-min))
747 "
\f\n0, *unseen,+\n\\(\\*\\*\\* EOOH \\*\\*\\*\n\\)?" nil t)
748 (goto-char (match-end 0))
749 (delete-region (match-beginning 0) (match-end 0))
753 ;; Skip all the headers in case there are more "From "s...
754 (or (search-forward "\n\n" nil t)
755 (search-forward-regexp "^[^:]*\\( .*\\|\\)$" nil t)
756 (search-forward "
\1f\f"))
758 ;; Unquote the ">From " line, if any.
759 (goto-char (point-min))
760 (when (looking-at ">From ")
761 (replace-match "X-From-Line: ") )
762 (run-hooks 'nnmail-prepare-incoming-header-hook)
763 (goto-char (point-max))
764 ;; Find the Message-ID header.
766 (if (re-search-backward
767 "^Message-ID[ \t]*:[ \n\t]*\\(<[^>]*>\\)" nil t)
768 (setq message-id (buffer-substring (match-beginning 1)
770 ;; There is no Message-ID here, so we create one.
772 (when (re-search-backward "^Message-ID[ \t]*:" nil t)
774 (insert "Original-")))
776 (insert "Message-ID: " (setq message-id (nnmail-message-id))
778 ;; Look for a Content-Length header.
779 (if (not (save-excursion
780 (and (re-search-backward
781 "^Content-Length:[ \t]*\\([0-9]+\\)" start t)
782 (setq content-length (string-to-number
786 ;; We destroy the header, since none of
787 ;; the backends ever use it, and we do not
788 ;; want to confuse other mailers by having
789 ;; a (possibly) faulty header.
790 (progn (insert "X-") t))))
793 (if (or (= (+ (point) content-length) (point-max))
795 (goto-char (+ (point) content-length))
798 (goto-char (+ (point) content-length))
799 (setq do-search nil))
802 ;; Go to the beginning of the next article - or to the end
805 (if (re-search-forward "^
\1f" nil t)
806 (goto-char (match-beginning 0))
807 (goto-char (1- (point-max)))))
808 (delete-char 1) ; delete ^_
811 (narrow-to-region start (point))
812 (goto-char (point-min))
813 (nnmail-check-duplication message-id func artnum-func)
815 (setq end (point-max))))
819 (defsubst nnmail-search-unix-mail-delim ()
820 "Put point at the beginning of the next Unix mbox message."
821 ;; Algorithm used to find the next article in the
822 ;; brain-dead Unix mbox format:
824 ;; 1) Search for "^From ".
825 ;; 2) If we find it, then see whether the previous
826 ;; line is blank and the next line looks like a header.
827 ;; Then it's possible that this is a mail delim, and we use it.
828 (let ((case-fold-search nil)
831 (if (not (re-search-forward "^From " nil t))
835 (when (and (or (bobp)
838 (eq (char-after) ?\n)))
841 (while (looking-at ">From \\|From ")
843 (looking-at "[^ \n\t:]+[ \n\t]*:")))
844 (setq found 'yes)))))
848 (defun nnmail-search-unix-mail-delim-backward ()
849 "Put point at the beginning of the current Unix mbox message."
850 ;; Algorithm used to find the next article in the
851 ;; brain-dead Unix mbox format:
853 ;; 1) Search for "^From ".
854 ;; 2) If we find it, then see whether the previous
855 ;; line is blank and the next line looks like a header.
856 ;; Then it's possible that this is a mail delim, and we use it.
857 (let ((case-fold-search nil)
860 (if (not (re-search-backward "^From " nil t))
864 (when (and (or (bobp)
867 (eq (char-after) ?\n)))
870 (while (looking-at ">From \\|From ")
872 (looking-at "[^ \n\t:]+[ \n\t]*:")))
873 (setq found 'yes)))))
877 (defun nnmail-process-unix-mail-format (func artnum-func)
878 (let ((case-fold-search t)
880 start message-id content-length end skip head-end)
881 (goto-char (point-min))
882 (if (not (and (re-search-forward "^From " nil t)
883 (goto-char (match-beginning 0))))
884 ;; Possibly wrong format?
885 (error "Error, unknown mail format! (Possibly corrupted %s `%s'.)"
886 (if (buffer-file-name) "file" "buffer")
887 (or (buffer-file-name) (buffer-name)))
888 ;; Carry on until the bitter end.
892 ;; Find the end of the head.
895 (if (search-forward "\n\n" nil t)
897 ;; This will never happen, but just to be on the safe side --
898 ;; if there is no head-body delimiter, we search a bit manually.
899 (while (and (looking-at "From \\|[^ \t]+:")
903 ;; Find the Message-ID header.
904 (goto-char (point-min))
905 (if (re-search-forward "^Message-ID[ \t]*:[ \n\t]*\\(<[^>]+>\\)" nil t)
906 (setq message-id (match-string 1))
908 (when (re-search-forward "^Message-ID[ \t]*:" nil t)
910 (insert "Original-")))
911 ;; There is no Message-ID here, so we create one.
913 (insert "Message-ID: " (setq message-id (nnmail-message-id)) "\n"))
914 ;; Look for a Content-Length header.
915 (goto-char (point-min))
916 (if (not (re-search-forward
917 "^Content-Length:[ \t]*\\([0-9]+\\)" nil t))
918 (setq content-length nil)
919 (setq content-length (string-to-number (match-string 1)))
920 ;; We destroy the header, since none of the backends ever
921 ;; use it, and we do not want to confuse other mailers by
922 ;; having a (possibly) faulty header.
925 (run-hooks 'nnmail-prepare-incoming-header-hook)
926 ;; Find the end of this article.
927 (goto-char (point-max))
929 (setq head-end (point))
930 ;; We try the Content-Length value. The idea: skip over the header
931 ;; separator, then check what happens content-length bytes into the
932 ;; message body. This should be either the end of the buffer, the
933 ;; message separator or a blank line followed by the separator.
934 ;; The blank line should probably be deleted. If neither of the
935 ;; three is met, the content-length header is probably invalid.
938 (setq skip (+ (point) content-length))
940 (cond ((or (= skip (point-max))
941 (= (1+ skip) (point-max)))
942 (setq end (point-max)))
943 ((looking-at "From ")
945 ((looking-at "[ \t]*\n\\(From \\)")
946 (setq end (match-beginning 1)))
950 ;; No Content-Length, so we find the beginning of the next
951 ;; article or the end of the buffer.
953 (or (nnmail-search-unix-mail-delim)
954 (goto-char (point-max))))
955 ;; Allow the backend to save the article.
958 (narrow-to-region start (point))
959 (goto-char (point-min))
961 (nnmail-check-duplication message-id func artnum-func)
962 (setq end (point-max))))
966 (defun nnmail-process-mmdf-mail-format (func artnum-func &optional junk-func)
967 (let ((delim "^\^A\^A\^A\^A$")
970 start message-id end)
971 (goto-char (point-min))
972 (if (not (and (re-search-forward delim nil t)
974 ;; Possibly wrong format?
975 (error "Error, unknown mail format! (Possibly corrupted.)")
976 ;; Carry on until the bitter end.
979 ;; Find the end of the head.
982 (if (search-forward "\n\n" nil t)
984 ;; This will never happen, but just to be on the safe side --
985 ;; if there is no head-body delimiter, we search a bit manually.
986 (while (and (looking-at "From \\|[^ \t]+:")
990 ;; Find the Message-ID header.
991 (goto-char (point-min))
992 (if (re-search-forward "^Message-ID[ \t]*:[ \n\t]*\\(<[^>]+>\\)" nil t)
993 (setq message-id (match-string 1))
994 ;; There is no Message-ID here, so we create one.
996 (when (re-search-backward "^Message-ID[ \t]*:" nil t)
998 (insert "Original-")))
1000 (insert "Message-ID: " (setq message-id (nnmail-message-id)) "\n"))
1001 (run-hooks 'nnmail-prepare-incoming-header-hook)
1002 ;; Find the end of this article.
1003 (goto-char (point-max))
1005 (if (re-search-forward delim nil t)
1007 (goto-char (point-max)))
1008 ;; Allow the backend to save the article.
1011 (narrow-to-region start (point))
1012 (goto-char (point-min))
1014 (nnmail-check-duplication message-id func artnum-func junk-func)
1015 (setq end (point-max))))
1020 (defun nnmail-process-maildir-mail-format (func artnum-func)
1021 ;; In a maildir, every file contains exactly one mail.
1022 (let ((case-fold-search t)
1024 (goto-char (point-min))
1025 ;; Find the end of the head.
1028 (if (search-forward "\n\n" nil t)
1030 ;; This will never happen, but just to be on the safe side --
1031 ;; if there is no head-body delimiter, we search a bit manually.
1032 (while (and (looking-at "From \\|[^ \t]+:")
1036 ;; Find the Message-ID header.
1037 (goto-char (point-min))
1038 (if (re-search-forward "^Message-ID:[ \t]*\\(<[^>]+>\\)" nil t)
1039 (setq message-id (match-string 1))
1040 ;; There is no Message-ID here, so we create one.
1042 (when (re-search-backward "^Message-ID[ \t]*:" nil t)
1044 (insert "Original-")))
1046 (insert "Message-ID: " (setq message-id (nnmail-message-id)) "\n"))
1047 (run-hooks 'nnmail-prepare-incoming-header-hook)
1048 ;; Allow the backend to save the article.
1051 (goto-char (point-min))
1052 (nnmail-check-duplication message-id func artnum-func))
1055 (defvar nnmail-group-names-not-encoded-p nil
1056 "Non-nil means group names are not encoded.")
1058 (defun nnmail-split-incoming (incoming func &optional exit-func
1059 group artnum-func junk-func)
1060 "Go through the entire INCOMING file and pick out each individual mail.
1061 FUNC will be called with the buffer narrowed to each mail.
1062 INCOMING can also be a buffer object. In that case, the mail
1063 will be copied over from that buffer."
1064 (let ( ;; If this is a group-specific split, we bind the split
1065 ;; methods to just this group.
1066 (nnmail-split-methods (if (and group
1067 (not nnmail-resplit-incoming))
1068 (list (list group ""))
1069 nnmail-split-methods))
1070 (nnmail-group-names-not-encoded-p t))
1071 ;; Insert the incoming file.
1072 (with-current-buffer (get-buffer-create nnmail-article-buffer)
1074 (if (bufferp incoming)
1075 (insert-buffer-substring incoming)
1076 (let ((coding-system-for-read nnmail-incoming-coding-system))
1077 (mm-insert-file-contents incoming)))
1079 (if (zerop (buffer-size))
1081 (goto-char (point-min))
1082 (save-excursion (run-hooks 'nnmail-prepare-incoming-hook))
1083 ;; Handle both babyl, MMDF and unix mail formats, since
1084 ;; movemail will use the former when fetching from a
1085 ;; mailbox, the latter when fetching from a file.
1086 (cond ((or (looking-at "\^L")
1087 (looking-at "BABYL OPTIONS:"))
1088 (nnmail-process-babyl-mail-format func artnum-func))
1089 ((looking-at "\^A\^A\^A\^A")
1090 (nnmail-process-mmdf-mail-format
1091 func artnum-func junk-func))
1092 ((looking-at "Return-Path:")
1093 (nnmail-process-maildir-mail-format func artnum-func))
1095 (nnmail-process-unix-mail-format func artnum-func))))
1097 (funcall exit-func))
1098 (kill-buffer (current-buffer))))))
1100 (defun nnmail-article-group (func &optional trace junk-func)
1101 "Look at the headers and return an alist of groups that match.
1102 FUNC will be called with the group name to determine the article number."
1103 (let ((methods (or nnmail-split-methods '(("bogus" ""))))
1104 (obuf (current-buffer))
1105 group-art method grp)
1106 (if (and (sequencep methods)
1107 (= (length methods) 1)
1108 (not nnmail-inhibit-default-split-group))
1109 ;; If there is only just one group to put everything in, we
1110 ;; just return a list with just this one method in.
1112 (list (cons (caar methods) (funcall func (caar methods)))))
1113 ;; We do actual comparison.
1114 ;; Copy the article into the work buffer.
1115 (with-current-buffer nntp-server-buffer
1117 (insert-buffer-substring obuf)
1118 ;; Narrow to headers.
1120 (goto-char (point-min))
1121 (if (search-forward "\n\n" nil t)
1124 (goto-char (point-min))
1125 ;; Decode MIME headers and charsets.
1126 (when nnmail-mail-splitting-decodes
1127 (let ((mail-parse-charset nnmail-mail-splitting-charset))
1128 (mail-decode-encoded-word-region (point-min) (point-max))))
1129 ;; Fold continuation lines.
1130 (goto-char (point-min))
1131 (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
1132 (replace-match " " t t))
1133 ;; Nuke pathologically long headers. Since Gnus applies
1134 ;; pathologically complex regexps to the buffer, lines
1135 ;; that are looong will take longer than the Universe's
1136 ;; existence to process.
1137 (goto-char (point-min))
1139 (unless (< (move-to-column nnmail-split-header-length-limit)
1140 nnmail-split-header-length-limit)
1141 (delete-region (point) (point-at-eol)))
1144 (goto-char (point-min))
1145 (run-hooks 'nnmail-split-hook)
1146 (when (setq nnmail-split-tracing trace)
1147 (setq nnmail-split-trace nil))
1148 (if (and (symbolp nnmail-split-methods)
1149 (fboundp nnmail-split-methods))
1151 (condition-case error-info
1152 ;; `nnmail-split-methods' is a function, so we
1153 ;; just call this function here and use the
1155 (or (funcall nnmail-split-methods)
1156 (and (not nnmail-inhibit-default-split-group)
1160 5 "Error in `nnmail-split-methods'; using `bogus' mail group: %S" error-info)
1163 (setq split (mm-delete-duplicates split))
1164 ;; The article may be "cross-posted" to `junk'. What
1165 ;; to do? Just remove the `junk' spec. Don't really
1166 ;; see anything else to do...
1167 (when (and (memq 'junk split)
1169 (funcall junk-func 'junk))
1170 (setq split (delq 'junk split))
1174 (lambda (group) (cons group (funcall func group)))
1176 ;; Go through the split methods to find a match.
1178 (or nnmail-crosspost
1180 (goto-char (point-max))
1181 (setq method (pop methods)
1184 (not (equal "" (nth 1 method))))
1187 (if (stringp (nth 1 method))
1188 (let ((expand (string-match "\\\\[0-9&]" grp))
1189 (pos (re-search-backward (cadr method)
1192 (setq grp (nnmail-expand-newtext grp)))
1194 ;; Function to say whether this is a match.
1195 (funcall (nth 1 method) grp)))
1196 ;; Don't enter the article into the same
1198 (not (assoc grp group-art)))
1199 (push (cons grp (funcall func grp))
1201 ;; This is the final group, which is used as a
1203 (when (and (not group-art)
1204 (not nnmail-inhibit-default-split-group))
1206 (list (cons (car method)
1207 (funcall func (car method))))))))
1208 ;; Fall back on "bogus" if all else fails.
1209 (when (and (not group-art)
1210 (not nnmail-inhibit-default-split-group))
1211 (setq group-art (list (cons "bogus" (funcall func "bogus"))))))
1212 ;; Produce a trace if non-empty.
1213 (when (and trace nnmail-split-trace)
1214 (let ((restore (current-buffer)))
1215 (nnheader-set-temp-buffer "*Split Trace*")
1217 (dolist (trace (nreverse nnmail-split-trace))
1218 (prin1 trace (current-buffer))
1220 (goto-char (point-min))
1221 (gnus-configure-windows 'split-trace)
1222 (set-buffer restore)))
1224 ;; See whether the split methods returned `junk'.
1225 (if (equal group-art '(junk))
1227 ;; The article may be "cross-posted" to `junk'. What
1228 ;; to do? Just remove the `junk' spec. Don't really
1229 ;; see anything else to do...
1231 (while (setq elem (car (memq 'junk group-art)))
1232 (setq group-art (delq elem group-art)))
1233 (nreverse group-art)))))))
1235 (defun nnmail-insert-lines ()
1236 "Insert how many lines there are in the body of the mail.
1237 Return the number of characters in the body."
1240 (goto-char (point-min))
1241 (unless (search-forward "\n\n" nil t)
1242 (goto-char (point-max))
1244 (setq chars (- (point-max) (point)))
1245 (setq lines (count-lines (point) (point-max)))
1248 (when (re-search-backward "^Lines: " nil t)
1249 (delete-region (point) (progn (forward-line 1) (point)))))
1251 (insert (format "Lines: %d\n" (max lines 0)))
1254 (defun nnmail-insert-xref (group-alist)
1255 "Insert an Xref line based on the (group . article) alist."
1257 (goto-char (point-min))
1258 (unless (search-forward "\n\n" nil t)
1259 (goto-char (point-max))
1262 (when (re-search-backward "^Xref: " nil t)
1263 (delete-region (match-beginning 0)
1264 (progn (forward-line 1) (point))))
1265 (insert (format "Xref: %s" (system-name)))
1267 (insert (if (mm-multibyte-p)
1268 (mm-string-as-multibyte
1269 (format " %s:%d" (caar group-alist) (cdar group-alist)))
1270 (mm-string-as-unibyte
1271 (format " %s:%d" (caar group-alist) (cdar group-alist)))))
1272 (setq group-alist (cdr group-alist)))
1275 ;;; Message washing functions
1277 (defun nnmail-remove-leading-whitespace ()
1278 "Remove excessive whitespace from all headers."
1279 (goto-char (point-min))
1280 (while (re-search-forward "^\\([^ :]+: \\) +" nil t)
1281 (replace-match "\\1" t)))
1283 (defun nnmail-remove-list-identifiers ()
1284 "Remove list identifiers from Subject headers."
1286 (if (consp nnmail-list-identifiers)
1287 (mapconcat 'identity nnmail-list-identifiers " *\\|")
1288 nnmail-list-identifiers)))
1290 (goto-char (point-min))
1291 (while (re-search-forward
1292 (concat "^Subject: +\\(R[Ee]: +\\)*\\(" regexp " *\\)")
1294 (delete-region (match-beginning 2) (match-end 0))
1295 (beginning-of-line))
1296 (when (re-search-forward "^Subject: +\\(\\(R[Ee]: +\\)+\\)R[Ee]: +"
1298 (delete-region (match-beginning 1) (match-end 1))
1299 (beginning-of-line)))))
1301 (defun nnmail-remove-tabs ()
1302 "Translate TAB characters into SPACE characters."
1303 (subst-char-in-region (point-min) (point-max) ?\t ? t))
1305 (defcustom nnmail-broken-references-mailers
1306 "^X-Mailer:.*\\(Eudora\\|Pegasus\\)"
1307 "Header line matching mailer producing bogus References lines.
1308 See `nnmail-ignore-broken-references'."
1309 :group 'nnmail-prepare
1310 :version "23.1" ;; No Gnus
1313 (defun nnmail-ignore-broken-references ()
1314 "Ignore the References line and use In-Reply-To
1316 Eudora has a broken References line, but an OK In-Reply-To."
1317 (goto-char (point-min))
1318 (when (re-search-forward nnmail-broken-references-mailers nil t)
1319 (goto-char (point-min))
1320 (when (re-search-forward "^References:" nil t)
1322 (insert "X-Gnus-Broken-Eudora-"))
1323 (goto-char (point-min))
1324 (when (re-search-forward "^\\(In-Reply-To:[^\n]+\\)\n[ \t]+" nil t)
1325 (replace-match "\\1" t))))
1327 (defalias 'nnmail-fix-eudora-headers 'nnmail-ignore-broken-references)
1328 (make-obsolete 'nnmail-fix-eudora-headers 'nnmail-ignore-broken-references "Emacs 23.1")
1330 (custom-add-option 'nnmail-prepare-incoming-header-hook
1331 'nnmail-ignore-broken-references)
1333 ;;; Utility functions
1335 (declare-function gnus-activate-group "gnus-start"
1336 (group &optional scan dont-check method))
1338 (defun nnmail-do-request-post (accept-func &optional server)
1339 "Utility function to directly post a message to an nnmail-derived group.
1340 Calls ACCEPT-FUNC (which should be `nnchoke-request-accept-article')
1341 to actually put the message in the right group."
1343 (dolist (mbx (message-unquote-tokens
1344 (message-tokenize-header
1345 (message-fetch-field "Newsgroups") ", ")) success)
1346 (let ((to-newsgroup (gnus-group-prefixed-name mbx gnus-command-method)))
1347 (or (gnus-active to-newsgroup)
1348 (gnus-activate-group to-newsgroup)
1349 (if (gnus-y-or-n-p (format "No such group: %s. Create it? "
1351 (or (and (gnus-request-create-group
1352 to-newsgroup gnus-command-method)
1353 (gnus-activate-group to-newsgroup nil nil
1354 gnus-command-method))
1355 (error "Couldn't create group %s" to-newsgroup)))
1356 (error "No such group: %s" to-newsgroup))
1357 (unless (funcall accept-func mbx (nth 1 gnus-command-method))
1358 (setq success nil))))))
1360 (defun nnmail-split-fancy ()
1361 "Fancy splitting method.
1362 See the documentation for the variable `nnmail-split-fancy' for details."
1363 (with-syntax-table nnmail-split-fancy-syntax-table
1364 (nnmail-split-it nnmail-split-fancy)))
1366 (defvar nnmail-split-cache nil)
1367 ;; Alist of split expressions their equivalent regexps.
1369 (defun nnmail-split-it (split)
1370 ;; Return a list of groups matching SPLIT.
1377 ;; A group name. Do the \& and \N subs into the string.
1379 (when nnmail-split-tracing
1380 (push split nnmail-split-trace))
1381 (list (nnmail-expand-newtext split)))
1383 ;; Junk the message.
1385 (when nnmail-split-tracing
1386 (push "junk" nnmail-split-trace))
1389 ;; Builtin & operation.
1390 ((eq (car split) '&)
1391 (apply 'nconc (mapcar 'nnmail-split-it (cdr split))))
1393 ;; Builtin | operation.
1394 ((eq (car split) '|)
1396 (while (and (not done) (cdr split))
1397 (setq split (cdr split)
1398 done (nnmail-split-it (car split))))
1401 ;; Builtin : operation.
1402 ((eq (car split) ':)
1403 (when nnmail-split-tracing
1404 (push split nnmail-split-trace))
1405 (nnmail-split-it (save-excursion (eval (cdr split)))))
1407 ;; Builtin ! operation.
1408 ((eq (car split) '!)
1409 (funcall (cadr split) (nnmail-split-it (caddr split))))
1411 ;; Check the cache for the regexp for this split.
1412 ((setq cached-pair (assq split nnmail-split-cache))
1414 (end-point (point-max))
1415 (value (nth 1 split)))
1417 (setq value (cdr (assq value nnmail-split-abbrev-alist))))
1418 (while (and (goto-char end-point)
1419 (re-search-backward (cdr cached-pair) nil t))
1420 (when nnmail-split-tracing
1421 (push split nnmail-split-trace))
1422 (let ((split-rest (cddr split))
1424 ;; The searched regexp is \(\(FIELD\).*\)\(VALUE\).
1425 ;; So, start-of-value is the point just before the
1426 ;; beginning of the value, whereas after-header-name
1427 ;; is the point just after the field name.
1428 (start-of-value (match-end 1))
1429 (after-header-name (match-end 2)))
1430 ;; Start the next search just before the beginning of the
1432 (setq end-point (1- start-of-value))
1433 ;; Handle - RESTRICTs
1434 (while (eq (car split-rest) '-)
1435 ;; RESTRICT must start after-header-name and
1436 ;; end after start-of-value, so that, for
1437 ;; (any "foo" - "x-foo" "foo.list")
1438 ;; we do not exclude foo.list just because
1439 ;; the header is: ``To: x-foo, foo''
1441 (if (and (re-search-backward (cadr split-rest)
1442 after-header-name t)
1443 (> (match-end 0) start-of-value))
1444 (setq split-rest nil)
1445 (setq split-rest (cddr split-rest))))
1448 (let ((value (nth 1 split)))
1450 (setq value (cdr (assq value nnmail-split-abbrev-alist))))
1451 ;; Someone might want to do a \N sub on this match, so get the
1452 ;; correct match positions.
1453 (re-search-backward value start-of-value))
1454 (dolist (sp (nnmail-split-it (car split-rest)))
1455 (unless (member sp split-result)
1456 (push sp split-result))))))
1459 ;; Not in cache, compute a regexp for the field/value pair.
1461 (let ((field (nth 0 split))
1462 (value (nth 1 split))
1463 (split-rest (cddr split))
1468 (setq value (cdr (assq value nnmail-split-abbrev-alist))))
1469 (if (and (>= (length value) 2)
1470 (string= ".*" (substring value 0 2)))
1471 (setq value (substring value 2)
1473 ;; Same trick for the rear of the regexp
1474 (if (and (>= (length value) 2)
1475 (string= ".*" (substring value -2)))
1476 (setq value (substring value 0 -2)
1478 ;; Invert the match-partial-words behavior if the optional
1479 ;; last element is specified.
1480 (while (eq (car split-rest) '-)
1481 (setq split-rest (cddr split-rest)))
1482 (when (if (cadr split-rest)
1483 (not nnmail-split-fancy-match-partial-words)
1484 nnmail-split-fancy-match-partial-words)
1485 (setq partial-front ""
1487 (setq regexp (concat "^\\(\\("
1489 (cdr (assq field nnmail-split-abbrev-alist))
1492 (or partial-front "\\<")
1496 (or partial-rear "\\>")))
1497 (push (cons split regexp) nnmail-split-cache)
1498 ;; Now that it's in the cache, just call nnmail-split-it again
1499 ;; on the same split, which will find it immediately in the cache.
1500 (nnmail-split-it split))))))
1502 (defun nnmail-expand-newtext (newtext)
1503 (let ((len (length newtext))
1505 c expanded beg N did-expand)
1508 (while (and (< pos len)
1509 (not (= (aref newtext pos) ?\\)))
1510 (setq pos (1+ pos)))
1512 (push (substring newtext beg pos) expanded))
1514 ;; We hit a \; expand it.
1517 c (aref newtext pos))
1518 (if (not (or (= c ?\&)
1521 ;; \ followed by some character we don't expand.
1522 (push (char-to-string c) expanded)
1527 (when (match-beginning N)
1528 (push (if nnmail-split-lowercase-expanded
1529 (downcase (buffer-substring (match-beginning N)
1531 (buffer-substring (match-beginning N) (match-end N)))
1533 (setq pos (1+ pos)))
1535 (apply 'concat (nreverse expanded))
1538 ;; Activate a backend only if it isn't already activated.
1539 ;; If FORCE, re-read the active file even if the backend is
1540 ;; already activated.
1541 (defun nnmail-activate (backend &optional force)
1542 (nnheader-init-server-buffer)
1543 (let (file timestamp file-time)
1544 (if (or (not (symbol-value (intern (format "%s-group-alist" backend))))
1546 (and (setq file (ignore-errors
1547 (symbol-value (intern (format "%s-active-file"
1549 (setq file-time (nth 5 (file-attributes file)))
1553 (symbol-value (intern
1554 (format "%s-active-timestamp"
1557 (not (consp timestamp))
1558 (equal timestamp '(0 0))
1559 (> (nth 0 file-time) (nth 0 timestamp))
1560 (and (= (nth 0 file-time) (nth 0 timestamp))
1561 (> (nth 1 file-time) (nth 1 timestamp))))))
1563 (or (eq timestamp 'none)
1564 (set (intern (format "%s-active-timestamp" backend))
1566 (funcall (intern (format "%s-request-list" backend)))))
1569 (defun nnmail-message-id ()
1570 (concat "<" (message-unique-id) "@totally-fudged-out-message-id>"))
1573 ;;; nnmail duplicate handling
1576 (defvar nnmail-cache-buffer nil)
1578 (defun nnmail-cache-open ()
1579 (if (or (not nnmail-treat-duplicates)
1580 (and nnmail-cache-buffer
1581 (buffer-name nnmail-cache-buffer)))
1582 () ; The buffer is open.
1583 (with-current-buffer
1584 (setq nnmail-cache-buffer
1585 (get-buffer-create " *nnmail message-id cache*"))
1587 (when (file-exists-p nnmail-message-id-cache-file)
1588 (nnheader-insert-file-contents nnmail-message-id-cache-file))
1589 (set-buffer-modified-p nil)
1592 (defun nnmail-cache-close ()
1593 (when (and nnmail-cache-buffer
1594 nnmail-treat-duplicates
1595 (buffer-name nnmail-cache-buffer)
1596 (buffer-modified-p nnmail-cache-buffer))
1597 (with-current-buffer nnmail-cache-buffer
1598 ;; Weed out the excess number of Message-IDs.
1599 (goto-char (point-max))
1600 (when (search-backward "\n" nil t nnmail-message-id-cache-length)
1603 (delete-region (point-min) (point))))
1605 (or (file-exists-p (file-name-directory nnmail-message-id-cache-file))
1606 (make-directory (file-name-directory nnmail-message-id-cache-file)
1608 (nnmail-write-region (point-min) (point-max)
1609 nnmail-message-id-cache-file nil 'silent)
1610 (set-buffer-modified-p nil)
1611 (setq nnmail-cache-buffer nil)
1612 (gnus-kill-buffer (current-buffer)))))
1614 ;; Compiler directives.
1616 (defvar group-art-list)
1618 (defun nnmail-cache-insert (id grp &optional subject sender)
1620 ;; this will handle cases like `B r' where the group is nil
1621 (let ((grp (or grp gnus-newsgroup-name "UNKNOWN")))
1622 (run-hook-with-args 'nnmail-spool-hook
1623 id grp subject sender))
1624 (when nnmail-treat-duplicates
1625 ;; Store some information about the group this message is written
1626 ;; to. This is passed in as the grp argument -- all locations this
1627 ;; has been called from have been checked and the group is available.
1628 ;; The only ambiguous case is nnmail-check-duplication which will only
1629 ;; pass the first (of possibly >1) group which matches. -Josh
1630 (unless (gnus-buffer-live-p nnmail-cache-buffer)
1631 (nnmail-cache-open))
1632 (with-current-buffer nnmail-cache-buffer
1633 (goto-char (point-max))
1634 (if (and grp (not (string= "" grp))
1635 (gnus-methods-equal-p gnus-command-method
1636 (nnmail-cache-primary-mail-backend)))
1637 (let ((regexp (if (consp nnmail-cache-ignore-groups)
1638 (mapconcat 'identity nnmail-cache-ignore-groups
1640 nnmail-cache-ignore-groups)))
1641 (unless (and regexp (string-match regexp grp))
1642 (insert id "\t" grp "\n")))
1643 (insert id "\n"))))))
1645 (defun nnmail-cache-primary-mail-backend ()
1646 (let ((be-list (cons gnus-select-method gnus-secondary-select-methods))
1650 (while (and (null res) be-list)
1651 (setq be (car be-list))
1652 (setq be-list (cdr be-list))
1653 (when (and (gnus-method-option-p be 'respool)
1655 (intern (format "%s-get-new-mail" (car be))))
1656 (boundp get-new-mail)
1657 (symbol-value get-new-mail))
1661 ;; Fetch the group name corresponding to the message id stored in the
1663 (defun nnmail-cache-fetch-group (id)
1664 (when (and nnmail-treat-duplicates nnmail-cache-buffer)
1665 (with-current-buffer nnmail-cache-buffer
1666 (goto-char (point-max))
1667 (when (search-backward id nil t)
1669 (skip-chars-forward "^\n\r\t")
1670 (unless (looking-at "[\r\n]")
1672 (buffer-substring (point) (point-at-eol)))))))
1674 ;; Function for nnmail-split-fancy: look up all references in the
1675 ;; cache and if a match is found, return that group.
1676 (defun nnmail-split-fancy-with-parent ()
1677 "Split this message into the same group as its parent.
1678 This function can be used as an entry in `nnmail-split-fancy', for
1679 example like this: (: nnmail-split-fancy-with-parent)
1680 For a message to be split, it looks for the parent message in the
1681 References or In-Reply-To header and then looks in the message id
1682 cache file (given by the variable `nnmail-message-id-cache-file') to
1683 see which group that message was put in. This group is returned.
1685 See the Info node `(gnus)Fancy Mail Splitting' for more details."
1686 (let* ((refstr (or (message-fetch-field "references")
1687 (message-fetch-field "in-reply-to")))
1690 (regexp (if (consp nnmail-split-fancy-with-parent-ignore-groups)
1692 (lambda (x) (format "\\(%s\\)" x))
1693 nnmail-split-fancy-with-parent-ignore-groups
1695 nnmail-split-fancy-with-parent-ignore-groups)))
1697 (setq references (nreverse (gnus-split-references refstr)))
1698 (unless (gnus-buffer-live-p nnmail-cache-buffer)
1699 (nnmail-cache-open))
1700 (dolist (x references)
1701 (setq res (or (nnmail-cache-fetch-group x) res))
1702 (when (or (member res '("delayed" "drafts" "queue"))
1703 (and regexp res (string-match regexp res)))
1707 (defun nnmail-cache-id-exists-p (id)
1708 (when nnmail-treat-duplicates
1709 (with-current-buffer nnmail-cache-buffer
1710 (goto-char (point-max))
1711 (search-backward id nil t))))
1713 (defun nnmail-fetch-field (header)
1716 (message-narrow-to-head)
1717 (message-fetch-field header))))
1719 (defun nnmail-check-duplication (message-id func artnum-func
1720 &optional junk-func)
1721 (run-hooks 'nnmail-prepare-incoming-message-hook)
1722 ;; If this is a duplicate message, then we do not save it.
1723 (let* ((duplication (nnmail-cache-id-exists-p message-id))
1724 (case-fold-search t)
1725 (action (when duplication
1727 ((memq nnmail-treat-duplicates '(warn delete))
1728 nnmail-treat-duplicates)
1729 ((functionp nnmail-treat-duplicates)
1730 (funcall nnmail-treat-duplicates message-id))
1732 nnmail-treat-duplicates))))
1734 ;; We insert a line that says what the mail source is.
1735 (let ((case-fold-search t))
1736 (goto-char (point-min))
1737 (re-search-forward "^message-id[ \t]*:" nil t)
1739 (insert (format "X-Gnus-Mail-Source: %s\n" mail-source-string)))
1741 ;; Let the backend save the article (or not).
1744 (funcall func (setq group-art
1745 (nreverse (nnmail-article-group
1746 artnum-func nil junk-func))))
1747 (nnmail-cache-insert message-id (caar group-art)))
1748 ((eq action 'delete)
1749 (setq group-art nil))
1751 ;; We insert a warning.
1752 (let ((case-fold-search t))
1753 (goto-char (point-min))
1754 (re-search-forward "^message-id[ \t]*:" nil t)
1757 "Gnus-Warning: This is a duplicate of message " message-id "\n")
1758 (funcall func (setq group-art
1759 (nreverse (nnmail-article-group artnum-func))))))
1761 (funcall func (setq group-art
1762 (nreverse (nnmail-article-group artnum-func))))))
1763 ;; Add the group-art list to the history list.
1765 (push group-art nnmail-split-history)
1766 (delete-region (point-min) (point-max)))))
1770 (defvar nnmail-fetched-sources nil)
1772 (defun nnmail-get-value (&rest args)
1773 (let ((sym (intern (apply 'format args))))
1775 (symbol-value sym))))
1777 (defun nnmail-get-new-mail (method exit-func temp
1778 &optional group spool-func)
1779 "Read new incoming mail."
1780 (nnmail-get-new-mail-1 method exit-func temp group nil spool-func))
1782 (defun nnmail-get-new-mail-1 (method exit-func temp
1783 group in-group spool-func)
1784 (let* ((sources mail-sources)
1789 incoming incomings source)
1790 (when (and (nnmail-get-value "%s-get-new-mail" method)
1792 (while (setq source (pop sources))
1793 ;; Use group's parameter
1794 (when (eq (car source) 'group)
1797 (gnus-group-find-parameter
1798 (concat (symbol-name method) ":" group)
1800 (nnmail-get-new-mail-1 method exit-func temp
1801 group group spool-func))
1803 ;; Hack to only fetch the contents of a single group's spool file.
1804 (when (and (eq (car source) 'directory)
1805 (null nnmail-scan-directory-mail-source-once)
1807 (mail-source-bind (directory source)
1808 (setq source (append source
1814 ,(concat group suffix)
1815 (file-name-nondirectory file)))))))))
1816 (when nnmail-fetched-sources
1817 (if (member source nnmail-fetched-sources)
1819 (push source nnmail-fetched-sources)
1820 (push source fetching-sources)))))
1821 (when fetching-sources
1822 ;; We first activate all the groups.
1823 (nnmail-activate method)
1824 ;; Allow the user to hook.
1825 (run-hooks 'nnmail-pre-get-new-mail-hook)
1826 ;; Open the message-id cache.
1828 ;; The we go through all the existing mail source specification
1829 ;; and fetch the mail from each.
1830 (while (setq source (pop fetching-sources))
1835 `(lambda (file orig-file)
1836 (nnmail-split-incoming
1837 file ',(intern (format "%s-save-mail" method))
1840 (if (equal file orig-file)
1842 (nnmail-get-split-group orig-file ',source)))
1843 ',(intern (format "%s-active-number" method)))))))
1846 ;; If we did indeed read any incoming spools, we save all info.
1848 (when mail-source-plugged
1849 (nnheader-message 4 "%s: Reading incoming mail (no new mail)...done"
1850 method (car source)))
1852 (nnmail-get-value "%s-group-alist" method)
1853 (nnmail-get-value "%s-active-file" method))
1855 (funcall exit-func))
1856 (run-hooks 'nnmail-read-incoming-hook)
1857 (nnheader-message 4 "%s: Reading incoming mail (%d new)...done" method
1859 ;; Close the message-id cache.
1860 (nnmail-cache-close)
1861 ;; Allow the user to hook.
1862 (run-hooks 'nnmail-post-get-new-mail-hook))))
1864 (defun nnmail-expired-article-p (group time force &optional inhibit)
1865 "Say whether an article that is TIME old in GROUP should be expired.
1866 If TIME is nil, then return the cutoff time for oldness instead."
1871 (let ((days (or (and nnmail-expiry-wait-function
1872 (funcall nnmail-expiry-wait-function group))
1873 nnmail-expiry-wait)))
1874 (cond ((or (eq days 'never)
1877 ;; This isn't an expirable group.
1879 ((eq days 'immediate)
1880 ;; We expire all articles on sight.
1884 ((equal time '(0 0))
1885 ;; This is an ange-ftp group, and we don't have any dates.
1888 (setq days (days-to-time days))
1889 ;; Compare the time with the current time.
1891 (time-subtract (current-time) days)
1892 (ignore-errors (time-less-p days (time-since time)))))))))
1894 (declare-function gnus-group-mark-article-read "gnus-group" (group article))
1896 (defun nnmail-expiry-target-group (target group)
1897 ;; Do not invoke this from nntp-server-buffer! At least nnfolder clears
1898 ;; that buffer if the nnfolder group isn't selected.
1899 (let (nnmail-cache-accepted-message-ids)
1900 ;; Don't enter Message-IDs into cache.
1901 ;; Let users hack it in TARGET function.
1902 (when (functionp target)
1903 (setq target (funcall target group)))
1904 (unless (eq target 'delete)
1905 (when (or (gnus-request-group target)
1906 (gnus-request-create-group target))
1907 (let ((group-art (gnus-request-accept-article target nil nil t)))
1908 (when (consp group-art)
1909 (gnus-group-mark-article-read target (cdr group-art))))))))
1911 (defun nnmail-fancy-expiry-target (group)
1912 "Returns a target expiry group determined by `nnmail-fancy-expiry-targets'."
1914 (case-fold-search nil)
1915 (from (or (message-fetch-field "from") ""))
1916 (to (or (message-fetch-field "to") ""))
1917 (date (message-fetch-field "date"))
1923 (message "%s" (error-message-string err))
1926 (dolist (regexp-target-pair (reverse nnmail-fancy-expiry-targets) target)
1927 (setq header (car regexp-target-pair))
1929 ;; If the header is to-from then match against the
1930 ;; To or From header
1931 ((and (equal header 'to-from)
1932 (or (string-match (cadr regexp-target-pair) from)
1933 (and (string-match (cadr regexp-target-pair) to)
1934 (let ((rmail-dont-reply-to-names
1935 (message-dont-reply-to-names)))
1936 (equal (rmail-dont-reply-to from) "")))))
1937 (setq target (format-time-string (caddr regexp-target-pair) date)))
1938 ((and (not (equal header 'to-from))
1939 (string-match (cadr regexp-target-pair)
1941 (message-fetch-field header)
1944 (format-time-string (caddr regexp-target-pair) date)))))))
1946 (defun nnmail-check-syntax ()
1947 "Check (and modify) the syntax of the message in the current buffer."
1949 (message-narrow-to-head)
1950 (let ((case-fold-search t))
1951 (unless (re-search-forward "^Message-ID[ \t]*:" nil t)
1952 (insert "Message-ID: " (nnmail-message-id) "\n")))))
1954 (defun nnmail-write-region (start end filename &optional append visit lockname)
1955 "Do a `write-region', and then set the file modes."
1956 (let ((coding-system-for-write nnmail-file-coding-system)
1957 (file-name-coding-system nnmail-pathname-coding-system))
1958 (write-region start end filename append visit lockname)
1959 (set-file-modes filename nnmail-default-file-modes)))
1962 ;;; Status functions
1965 (defun nnmail-replace-status (name value)
1966 "Make status NAME and VALUE part of the current status line."
1968 (message-narrow-to-head)
1969 (let ((status (nnmail-decode-status)))
1970 (setq status (delq (member name status) status))
1972 (push (cons name value) status))
1973 (message-remove-header "status")
1974 (goto-char (point-max))
1975 (insert "Status: " (nnmail-encode-status status) "\n"))))
1977 (defun nnmail-decode-status ()
1978 "Return a status-value alist from STATUS."
1979 (goto-char (point-min))
1980 (when (re-search-forward "^Status: " nil t)
1981 (let (name value status)
1983 ;; Narrow to the status.
1986 (if (re-search-forward "^[^ \t]" nil t)
1989 ;; Go through all elements and add them to the list.
1990 (goto-char (point-min))
1991 (while (re-search-forward "[^ \t=]+" nil t)
1992 (setq name (match-string 0))
1993 (if (not (eq (char-after) ?=))
1997 (if (not (eq (char-after) ?\"))
1998 (if (not (looking-at "[^ \t]"))
2002 (setq value (match-string 0))
2003 (goto-char (match-end 0)))
2005 (setq value (read (current-buffer)))))
2006 (push (cons name value) status)))
2009 (defun nnmail-encode-status (status)
2010 "Return a status string from STATUS."
2015 (if (string-match "[ \t]" (cdr elem))
2016 (prin1-to-string (cdr elem))
2020 (defun nnmail-split-history ()
2021 "Generate an overview of where the last mail split put articles."
2023 (unless nnmail-split-history
2024 (error "No current split history"))
2025 (with-output-to-temp-buffer "*nnmail split history*"
2026 (with-current-buffer standard-output
2027 (fundamental-mode)) ; for Emacs 20.4+
2028 (dolist (elem nnmail-split-history)
2029 (princ (mapconcat (lambda (ga)
2030 (concat (car ga) ":" (int-to-string (cdr ga))))
2035 (defun nnmail-purge-split-history (group)
2036 "Remove all instances of GROUP from `nnmail-split-history'."
2037 (let ((history nnmail-split-history))
2039 (setcar history (gnus-remove-if (lambda (e) (string= (car e) group))
2042 (setq nnmail-split-history (delq nil nnmail-split-history))))
2044 (defun nnmail-new-mail-p (group)
2045 "Say whether GROUP has new mail."
2046 (let ((his nnmail-split-history)
2049 (when (assoc group (pop his))
2054 (defun nnmail-within-headers-p ()
2055 "Check to see if point is within the headers of a unix mail message.
2056 Doesn't change point."
2057 (let ((pos (point)))
2059 (and (nnmail-search-unix-mail-delim-backward)
2060 (not (search-forward "\n\n" pos t))))))
2062 (run-hooks 'nnmail-load-hook)
2066 ;;; nnmail.el ends here