nnmail.el 69.1 KB
Newer Older
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1
;;; nnmail.el --- mail support functions for the Gnus mail backends
2
;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
3
;;        Free Software Foundation, Inc.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
4

5
;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
;; Keywords: news, mail

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.

;;; Commentary:

;;; Code:

29 30
(eval-when-compile (require 'cl))

31
(require 'gnus)				; for macro gnus-kill-buffer, at least
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
32 33 34
(require 'nnheader)
(require 'message)
(require 'custom)
35
(require 'gnus-util)
36 37
(require 'mail-source)
(require 'mm-util)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
38 39

(eval-and-compile
40 41
  (autoload 'gnus-add-buffer "gnus")
  (autoload 'gnus-kill-buffer "gnus"))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59

(defgroup nnmail nil
  "Reading mail with Gnus."
  :group 'gnus)

(defgroup nnmail-retrieve nil
  "Retrieving new mail."
  :group 'nnmail)

(defgroup nnmail-prepare nil
  "Preparing (or mangling) new mail after retrival."
  :group 'nnmail)

(defgroup nnmail-duplicate nil
  "Handling of duplicate mail messages."
  :group 'nnmail)

(defgroup nnmail-split nil
ShengHuo ZHU's avatar
Typos.  
ShengHuo ZHU committed
60
  "Organizing the incoming mail in folders."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
  :group 'nnmail)

(defgroup nnmail-files nil
  "Mail files."
  :group 'gnus-files
  :group 'nnmail)

(defgroup nnmail-expire nil
  "Expiring old mail."
  :group 'nnmail)

(defgroup nnmail-procmail nil
  "Interfacing with procmail and other mail agents."
  :group 'nnmail)

(defgroup nnmail-various nil
  "Various mail options."
  :group 'nnmail)

80
(defcustom nnmail-split-methods '(("mail.misc" ""))
81
  "*Incoming mail will be split according to this variable.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
82 83 84 85 86 87 88

If you'd like, for instance, one mail group for mail from the
\"4ad-l\" mailing list, one group for junk mail and one for everything
else, you could do something like this:

 (setq nnmail-split-methods
       '((\"mail.4ad\" \"From:.*4ad\")
89 90
	 (\"mail.junk\" \"From:.*Lars\\\\|Subject:.*buy\")
	 (\"mail.misc\" \"\")))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106

As you can see, this variable is a list of lists, where the first
element in each \"rule\" is the name of the group (which, by the way,
does not have to be called anything beginning with \"mail\",
\"yonka.zow\" is a fine, fine name), and the second is a regexp that
nnmail will try to match on the header to find a fit.

The second element can also be a function.  In that case, it will be
called narrowed to the headers with the first element of the rule as
the argument.  It should return a non-nil value if it thinks that the
mail belongs in that group.

The last element should always have \"\" as the regexp.

This variable can also have a function as its value."
  :group 'nnmail-split
107 108
  :type '(choice (repeat :tag "Alist" (group (string :tag "Name")
					     (choice regexp function)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
109 110 111 112 113 114 115 116 117 118
		 (function-item nnmail-split-fancy)
		 (function :tag "Other")))

;; Suggested by Erik Selberg <speed@cs.washington.edu>.
(defcustom nnmail-crosspost t
  "If non-nil, do crossposting if several split methods match the mail.
If nil, the first match found will be used."
  :group 'nnmail-split
  :type 'boolean)

119 120 121
(defcustom nnmail-split-fancy-with-parent-ignore-groups nil
  "Regexp that matches group names to be ignored when applying `nnmail-split-fancy-with-parent'.
This can also be a list of regexps."
122
  :version "22.1"
123 124 125 126 127 128 129 130
  :group 'nnmail-split
  :type '(choice (const :tag "none" nil)
		 (regexp :value ".*")
		 (repeat :value (".*") regexp)))

(defcustom nnmail-cache-ignore-groups nil
  "Regexp that matches group names to be ignored when inserting message ids into the cache (`nnmail-cache-insert').
This can also be a list of regexps."
131
  :version "22.1"
132 133 134 135 136
  :group 'nnmail-split
  :type '(choice (const :tag "none" nil)
		 (regexp :value ".*")
		 (repeat :value (".*") regexp)))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
137 138
;; Added by gord@enci.ucalgary.ca (Gordon Matzigkeit).
(defcustom nnmail-keep-last-article nil
139 140 141
  "If non-nil, nnmail will never delete/move a group's last article.
It can be marked expirable, so it will be deleted when it is no longer last.

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
You may need to set this variable if other programs are putting
new mail into folder numbers that Gnus has marked as expired."
  :group 'nnmail-procmail
  :group 'nnmail-various
  :type 'boolean)

(defcustom nnmail-use-long-file-names nil
  "If non-nil the mail backends will use long file and directory names.
If nil, groups like \"mail.misc\" will end up in directories like
\"mail/misc/\"."
  :group 'nnmail-files
  :type 'boolean)

(defcustom nnmail-default-file-modes 384
  "Set the mode bits of all new mail files to this integer."
  :group 'nnmail-files
  :type 'integer)

(defcustom nnmail-expiry-wait 7
  "*Expirable articles that are older than this will be expired.
This variable can either be a number (which will be interpreted as a
number of days) -- this doesn't have to be an integer.  This variable
can also be `immediate' and `never'."
  :group 'nnmail-expire
  :type '(choice (const immediate)
167
		 (number :tag "days")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
168 169 170 171
		 (const never)))

(defcustom nnmail-expiry-wait-function nil
  "Variable that holds function to specify how old articles should be before they are expired.
172 173 174 175
The function will be called with the name of the group that the expiry
is to be performed in, and it should return an integer that says how
many days an article can be stored before it is considered \"old\".
It can also return the values `never' and `immediate'.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
176 177 178 179 180

Eg.:

\(setq nnmail-expiry-wait-function
      (lambda (newsgroup)
181 182
	(cond ((string-match \"private\" newsgroup) 31)
	      ((string-match \"junk\" newsgroup) 1)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
183 184 185 186 187 188
	      ((string-match \"important\" newsgroup) 'never)
	      (t 7))))"
  :group 'nnmail-expire
  :type '(choice (const :tag "nnmail-expiry-wait" nil)
		 (function :format "%v" nnmail-)))

189 190 191 192 193 194 195 196
(defcustom nnmail-expiry-target 'delete
  "*Variable that says where expired messages should end up.
The default value is `delete' (which says to delete the messages),
but it can also be a string or a function.  If it is a string, expired
messages end up in that group.  If it is a function, the function is
called in a buffer narrowed to the message in question.  The function
receives one argument, the name of the group the message comes from.
The return value should be `delete' or a group name (a string)."
Dave Love's avatar
Dave Love committed
197
  :version "21.1"
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
  :group 'nnmail-expire
  :type '(choice (const delete)
		 (function :format "%v" nnmail-)
		 string))

(defcustom nnmail-fancy-expiry-targets nil
  "Determine expiry target based on articles using fancy techniques.

This is a list of (\"HEADER\" \"REGEXP\" \"TARGET\") entries.  If
`nnmail-expiry-target' is set to the function
`nnmail-fancy-expiry-target' and HEADER of the article matches REGEXP,
the message will be expired to a group determined by invoking
`format-time-string' with TARGET used as the format string and the
time extracted from the articles' Date header (if missing the current
time is used).

In the special cases that HEADER is the symbol `to-from', the regexp
will try to match against both the From and the To header.

Example:

\(setq nnmail-fancy-expiry-targets
      '((to-from \"boss\" \"nnfolder:Work\")
	(\"Subject\" \"IMPORTANT\" \"nnfolder:IMPORTANT.%Y.%b\")
	(\"from\" \".*\" \"nnfolder:Archive-%Y\")))

In this case, articles containing the string \"boss\" in the To or the
From header will be expired to the group \"nnfolder:Work\";
articles containing the sting \"IMPORTANT\" in the Subject header will
be expired to the group \"nnfolder:IMPORTANT.YYYY.MMM\"; and
everything else will be expired to \"nnfolder:Archive-YYYY\"."
229
  :version "22.1"
230 231 232 233 234 235
  :group 'nnmail-expire
  :type '(repeat (list (choice :tag "Match against"
			       (string :tag "Header")
			       (const to-from))
		       regexp
		       (string :tag "Target group format string"))))
236

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
237
(defcustom nnmail-cache-accepted-message-ids nil
238 239
  "If non-nil, put Message-IDs of Gcc'd articles into the duplicate cache.
If non-nil, also update the cache when copy or move articles."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
240 241 242
  :group 'nnmail
  :type 'boolean)

243
(defcustom nnmail-spool-file '((file))
244
  "*Where the mail backends will look for incoming mail.
245 246
This variable is a list of mail source specifiers.
This variable is obsolete; `mail-sources' should be used instead."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
247
  :group 'nnmail-files
248
  :type 'sexp)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
249

250 251
(defcustom nnmail-resplit-incoming nil
  "*If non-nil, re-split incoming procmail sorted mail."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
252 253 254
  :group 'nnmail-procmail
  :type 'boolean)

255 256 257
(defcustom nnmail-scan-directory-mail-source-once nil
  "*If non-nil, scan all incoming procmail sorted mails once.
It scans low-level sorted spools even when not required."
Dave Love's avatar
Dave Love committed
258
  :version "21.1"
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
259 260 261 262 263 264 265 266 267
  :group 'nnmail-procmail
  :type 'boolean)

(defcustom nnmail-delete-file-function 'delete-file
  "Function called to delete files in some mail backends."
  :group 'nnmail-files
  :type 'function)

(defcustom nnmail-crosspost-link-function
268
  (if (string-match "windows-nt\\|emx" (symbol-name system-type))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
269 270
      'copy-file
    'add-name-to-file)
271
  "*Function called to create a copy of a file.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
272 273 274 275 276 277 278 279 280 281 282 283
This is `add-name-to-file' by default, which means that crossposts
will use hard links.  If your file system doesn't allow hard
links, you could set this variable to `copy-file' instead."
  :group 'nnmail-files
  :type '(radio (function-item add-name-to-file)
		(function-item copy-file)
		(function :tag "Other")))

(defcustom nnmail-read-incoming-hook
  (if (eq system-type 'windows-nt)
      '(nnheader-ms-strip-cr)
    nil)
284
  "*Hook that will be run after the incoming mail has been transferred.
Dave Love's avatar
Dave Love committed
285
The incoming mail is moved from the specified spool file (which normally is
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
286 287 288 289 290 291 292 293
something like \"/usr/spool/mail/$user\") to the user's home
directory.  This hook is called after the incoming mail box has been
emptied, and can be used to call any mail box programs you have
running (\"xwatch\", etc.)

Eg.

\(add-hook 'nnmail-read-incoming-hook
294 295 296
	  (lambda ()
	    (call-process \"/local/bin/mailsend\" nil nil nil
			  \"read\" nnmail-spool-file)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334

If you have xwatch running, this will alert it that mail has been
read.

If you use `display-time', you could use something like this:

\(add-hook 'nnmail-read-incoming-hook
	  (lambda ()
	    ;; Update the displayed time, since that will clear out
	    ;; the flag that says you have mail.
	    (when (eq (process-status \"display-time\") 'run)
	      (display-time-filter display-time-process \"\"))))"
  :group 'nnmail-prepare
  :type 'hook)

(defcustom nnmail-prepare-incoming-hook nil
  "Hook called before treating incoming mail.
The hook is run in a buffer with all the new, incoming mail."
  :group 'nnmail-prepare
  :type 'hook)

(defcustom nnmail-prepare-incoming-header-hook nil
  "Hook called narrowed to the headers of each message.
This can be used to remove excessive spaces (and stuff like
that) from the headers before splitting and saving the messages."
  :group 'nnmail-prepare
  :type 'hook)

(defcustom nnmail-prepare-incoming-message-hook nil
  "Hook called narrowed to each message."
  :group 'nnmail-prepare
  :type 'hook)

(defcustom nnmail-list-identifiers nil
  "Regexp that matches list identifiers to be removed.
This can also be a list of regexps."
  :group 'nnmail-prepare
  :type '(choice (const :tag "none" nil)
335 336
		 (regexp :value ".*")
		 (repeat :value (".*") regexp)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355

(defcustom nnmail-pre-get-new-mail-hook nil
  "Hook called just before starting to handle new incoming mail."
  :group 'nnmail-retrieve
  :type 'hook)

(defcustom nnmail-post-get-new-mail-hook nil
  "Hook called just after finishing handling new incoming mail."
  :group 'nnmail-retrieve
  :type 'hook)

(defcustom nnmail-split-hook nil
  "Hook called before deciding where to split an article.
The functions in this hook are free to modify the buffer
contents in any way they choose -- the buffer contents are
discarded after running the split process."
  :group 'nnmail-split
  :type 'hook)

356 357
(defcustom nnmail-spool-hook nil
  "*A hook called when a new article is spooled."
358
  :version "22.1"
359 360 361
  :group 'nnmail
  :type 'hook)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
362
(defcustom nnmail-large-newsgroup 50
363 364
  "*The number of articles which indicates a large newsgroup or nil.
If the number of articles is greater than the value, verbose
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
365 366
messages will be shown to indicate the current status."
  :group 'nnmail-various
367 368 369 370 371 372
  :type '(choice (const :tag "infinite" nil)
                 (number :tag "count")))

(define-widget 'nnmail-lazy 'default
  "Base widget for recursive datastructures.

373
This is copy of the `lazy' widget in Emacs 22.1 provided for compatibility."
374 375 376 377 378
  :format "%{%t%}: %v"
  :convert-widget 'widget-value-convert-widget
  :value-create (lambda (widget)
                  (let ((value (widget-get widget :value))
                        (type (widget-get widget :type)))
379 380
                    (widget-put widget :children
                                (list (widget-create-child-value
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
                                       widget (widget-convert type) value)))))
  :value-delete 'widget-children-value-delete
  :value-get (lambda (widget)
               (widget-value (car (widget-get widget :children))))
  :value-inline (lambda (widget)
                  (widget-apply (car (widget-get widget :children))
                                :value-inline))
  :default-get (lambda (widget)
                 (widget-default-get
                  (widget-convert (widget-get widget :type))))
  :match (lambda (widget value)
           (widget-apply (widget-convert (widget-get widget :type))
                         :match value))
  :validate (lambda (widget)
              (widget-apply (car (widget-get widget :children)) :validate)))

(define-widget 'nnmail-split-fancy 'nnmail-lazy
  "Widget for customizing splits in the variable of the same name."
  :tag "Split"
  :type '(menu-choice :value (any ".*value.*" "misc")
                      :tag "Type"
                      (string :tag "Destination")
                      (list :tag "Use first match (|)" :value (|)
                            (const :format "" |)
                            (editable-list :inline t nnmail-split-fancy))
                      (list :tag "Use all matches (&)" :value (&)
                            (const :format "" &)
                            (editable-list :inline t nnmail-split-fancy))
                      (list :tag "Function with fixed arguments (:)"
                            :value (: nil)
                            (const :format "" :value :)
412
                            function
413 414 415 416 417 418 419
                            (editable-list :inline t (sexp :tag "Arg"))
                            )
                      (list :tag "Function with split arguments (!)"
                            :value (! nil)
                            (const :format "" !)
                            function
                            (editable-list :inline t nnmail-split-fancy))
420 421
                      (list :tag "Field match"
                            (choice :tag "Field"
422 423
                                    regexp symbol)
                            (choice :tag "Match"
424
                                    regexp
425 426 427 428 429 430 431 432
                                    (symbol :value mail))
                            (repeat :inline t
                                    :tag "Restrictions"
                                    (group :inline t
                                           (const :format "" -)
                                           regexp))
                            nnmail-split-fancy)
                      (const :tag "Junk (delete mail)" junk)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
433 434 435 436 437

(defcustom nnmail-split-fancy "mail.misc"
  "Incoming mail can be split according to this fancy variable.
To enable this, set `nnmail-split-methods' to `nnmail-split-fancy'.

438
The format of this variable is SPLIT, where SPLIT can be one of
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
439 440 441 442
the following:

GROUP: Mail will be stored in GROUP (a string).

443
\(FIELD VALUE [- RESTRICT [- RESTRICT [...]]] SPLIT): If the message
444
  field FIELD (a regexp) contains VALUE (a regexp), store the messages
445
  as specified by SPLIT.  If RESTRICT (a regexp) matches some string
Pavel Janík's avatar
Pavel Janík committed
446
  after FIELD and before the end of the matched VALUE, return nil,
447 448
  otherwise process SPLIT.  Multiple RESTRICTs add up, further
  restricting the possibility of processing SPLIT.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
449 450 451 452 453 454 455 456 457 458 459

\(| SPLIT...): Process each SPLIT expression until one of them matches.
  A SPLIT expression is said to match if it will cause the mail
  message to be stored in one or more groups.

\(& SPLIT...): Process each SPLIT expression.

\(: FUNCTION optional args): Call FUNCTION with the optional args, in
  the buffer containing the message headers.  The return value FUNCTION
  should be a split, which is then recursively processed.

460 461 462 463
\(! FUNCTION SPLIT): Call FUNCTION with the result of SPLIT.  The
  return value FUNCTION should be a split, which is then recursively
  processed.

464 465 466 467 468 469
junk: Mail will be deleted.  Use with care!  Do not submerge in water!
  Example:
  (setq nnmail-split-fancy
	'(| (\"Subject\" \"MAKE MONEY FAST\" junk)
	    ...other.rules.omitted...))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
FIELD must match a complete field name.  VALUE must match a complete
word according to the `nnmail-split-fancy-syntax-table' syntax table.
You can use \".*\" in the regexps to match partial field names or words.

FIELD and VALUE can also be lisp symbols, in that case they are expanded
as specified in `nnmail-split-abbrev-alist'.

GROUP can contain \\& and \\N which will substitute from matching
\\(\\) patterns in the previous VALUE.

Example:

\(setq nnmail-split-methods 'nnmail-split-fancy
      nnmail-split-fancy
      ;; Messages from the mailer daemon are not crossposted to any of
      ;; the ordinary groups.  Warnings are put in a separate group
      ;; from real errors.
      '(| (\"from\" mail (| (\"subject\" \"warn.*\" \"mail.warning\")
			  \"mail.misc\"))
	  ;; Non-error messages are crossposted to all relevant
	  ;; groups, but we don't crosspost between the group for the
	  ;; (ding) list and the group for other (ding) related mail.
	  (& (| (any \"ding@ifi\\\\.uio\\\\.no\" \"ding.list\")
		(\"subject\" \"ding\" \"ding.misc\"))
	     ;; Other mailing lists...
	     (any \"procmail@informatik\\\\.rwth-aachen\\\\.de\" \"procmail.list\")
	     (any \"SmartList@informatik\\\\.rwth-aachen\\\\.de\" \"SmartList.list\")
497 498 499 500 501 502 503
	     ;; Both lists below have the same suffix, so prevent
	     ;; cross-posting to mkpkg.list of messages posted only to
	     ;; the bugs- list, but allow cross-posting when the
	     ;; message was really cross-posted.
	     (any \"bugs-mypackage@somewhere\" \"mypkg.bugs\")
	     (any \"mypackage@somewhere\" - \"bugs-mypackage\" \"mypkg.list\")
	     ;;
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
504 505 506 507 508
	     ;; People...
	     (any \"larsi@ifi\\\\.uio\\\\.no\" \"people.Lars Magne Ingebrigtsen\"))
	  ;; Unmatched mail goes to the catch all group.
	  \"misc.misc\"))"
  :group 'nnmail-split
509
  :type 'nnmail-split-fancy)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
510 511 512 513 514

(defcustom nnmail-split-abbrev-alist
  '((any . "from\\|to\\|cc\\|sender\\|apparently-to\\|resent-from\\|resent-to\\|resent-cc")
    (mail . "mailer-daemon\\|postmaster\\|uucp")
    (to . "to\\|cc\\|apparently-to\\|resent-to\\|resent-cc")
515 516 517
    (from . "from\\|sender\\|resent-from")
    (nato . "to\\|cc\\|resent-to\\|resent-cc")
    (naany . "from\\|to\\|cc\\|sender\\|resent-from\\|resent-to\\|resent-cc"))
518
  "*Alist of abbreviations allowed in `nnmail-split-fancy'."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537
  :group 'nnmail-split
  :type '(repeat (cons :format "%v" symbol regexp)))

(defcustom nnmail-message-id-cache-length 1000
  "*The approximate number of Message-IDs nnmail will keep in its cache.
If this variable is nil, no checking on duplicate messages will be
performed."
  :group 'nnmail-duplicate
  :type '(choice (const :tag "disable" nil)
		 (integer :format "%v")))

(defcustom nnmail-message-id-cache-file "~/.nnmail-cache"
  "*The file name of the nnmail Message-ID cache."
  :group 'nnmail-duplicate
  :group 'nnmail-files
  :type 'file)

(defcustom nnmail-treat-duplicates 'warn
  "*If non-nil, nnmail keep a cache of Message-IDs to discover mail duplicates.
538
Three values are valid: nil, which means that nnmail is not to keep a
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
539 540 541 542 543 544 545 546 547 548 549 550
Message-ID cache; `warn', which means that nnmail should insert extra
headers to warn the user about the duplication (this is the default);
and `delete', which means that nnmail will delete duplicated mails.

This variable can also be a function.  It will be called from a buffer
narrowed to the article in question with the Message-ID as a
parameter.  It should return nil, `warn' or `delete'."
  :group 'nnmail-duplicate
  :type '(choice (const :tag "off" nil)
		 (const warn)
		 (const delete)))

551
(defcustom nnmail-extra-headers '(To Newsgroups)
552
  "*Extra headers to parse."
Dave Love's avatar
Dave Love committed
553
  :version "21.1"
554 555 556
  :group 'nnmail
  :type '(repeat symbol))

557
(defcustom nnmail-split-header-length-limit 2048
558
  "Header lines longer than this limit are excluded from the split function."
Dave Love's avatar
Dave Love committed
559
  :version "21.1"
560 561 562
  :group 'nnmail
  :type 'integer)

563 564
(defcustom nnmail-mail-splitting-charset nil
  "Default charset to be used when splitting incoming mail."
565
  :version "22.1"
566 567 568 569 570
  :group 'nnmail
  :type 'symbol)

(defcustom nnmail-mail-splitting-decodes nil
  "Whether the nnmail splitting functionality should MIME decode headers."
571
  :version "22.1"
572 573 574 575 576 577 578 579 580
  :group 'nnmail
  :type 'boolean)

(defcustom nnmail-split-fancy-match-partial-words nil
  "Whether to match partial words when fancy splitting.
Normally, regexes given in `nnmail-split-fancy' are implicitly surrounded
by \"\\=\\<...\\>\".  If this variable is true, they are not implicitly\
 surrounded
by anything."
581
  :version "22.1"
582 583 584 585 586 587 588
  :group 'nnmail
  :type 'boolean)

(defcustom nnmail-split-lowercase-expanded t
  "Whether to lowercase expanded entries (i.e. \\N) when splitting mails.
This avoids the creation of multiple groups when users send to an address
using different case (i.e. mailing-list@domain vs Mailing-List@Domain)."
589
  :version "22.1"
590 591 592
  :group 'nnmail
  :type 'boolean)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
593 594
;;; Internal variables.

595 596 597
(defvar nnmail-article-buffer " *nnmail incoming*"
  "The buffer used for splitting incoming mails.")

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
598 599 600
(defvar nnmail-split-history nil
  "List of group/article elements that say where the previous split put messages.")

601 602 603 604 605
(defvar nnmail-split-fancy-syntax-table
  (let ((table (make-syntax-table)))
    ;; support the %-hack
    (modify-syntax-entry ?\% "." table)
    table)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
606 607 608 609 610
  "Syntax table used by `nnmail-split-fancy'.")

(defvar nnmail-prepare-save-mail-hook nil
  "Hook called before saving mail.")

611 612 613
(defvar nnmail-split-tracing nil)
(defvar nnmail-split-trace nil)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
614 615 616 617 618


(defun nnmail-request-post (&optional server)
  (mail-send-and-exit nil))

619 620 621
(defvar nnmail-file-coding-system 'raw-text
  "Coding system used in nnmail.")

622 623 624 625
(defvar nnmail-incoming-coding-system
  mm-text-coding-system
  "Coding system used in reading inbox")

626
(defvar nnmail-pathname-coding-system nil
627
  "*Coding system for file name.")
628

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
629 630 631
(defun nnmail-find-file (file)
  "Insert FILE in server buffer safely."
  (set-buffer nntp-server-buffer)
632
  (delete-region (point-min) (point-max))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
633
  (let ((format-alist nil)
634
	(after-insert-file-functions nil))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
635
    (condition-case ()
636
	(let ((coding-system-for-read nnmail-file-coding-system)
637 638
	      (auto-mode-alist (mm-auto-mode-alist))
	      (file-name-coding-system nnmail-pathname-coding-system))
639 640
	  (insert-file-contents file)
	  t)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
641 642 643
      (file-error nil))))

(defun nnmail-group-pathname (group dir &optional file)
644
  "Make file name for GROUP."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
645 646
  (concat
   (let ((dir (file-name-as-directory (expand-file-name dir))))
647 648 649
     (setq group (nnheader-replace-duplicate-chars-in-string
		  (nnheader-replace-chars-in-string group ?/ ?_)
		  ?. ?_))
650
     (setq group (nnheader-translate-file-chars group))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
651
     ;; If this directory exists, we use it directly.
652 653 654 655 656 657 658 659 660 661
     (file-name-as-directory
      (if (or nnmail-use-long-file-names
	      (file-directory-p (concat dir group)))
	  (expand-file-name group dir)
	;; If not, we translate dots into slashes.
	(expand-file-name
	 (mm-encode-coding-string
	  (nnheader-replace-chars-in-string group ?. ?/)
	  nnmail-pathname-coding-system)
	 dir))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
662 663 664 665 666
   (or file "")))

(defun nnmail-get-active ()
  "Returns an assoc of group names and active ranges.
nn*-request-list should have been called before calling this function."
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
  ;; Go through all groups from the active list.
  (save-excursion
    (set-buffer nntp-server-buffer)
    (nnmail-parse-active)))

(defun nnmail-parse-active ()
  "Parse the active file in the current buffer and return an alist."
  (goto-char (point-min))
  (unless (re-search-forward "[\\\"]" nil t)
    (goto-char (point-max))
    (while (re-search-backward "[][';?()#]" nil t)
      (insert ?\\)))
  (goto-char (point-min))
  (let ((buffer (current-buffer))
	group-assoc group max min)
    (while (not (eobp))
      (condition-case err
	  (progn
	    (narrow-to-region (point) (gnus-point-at-eol))
	    (setq group (read buffer))
	    (unless (stringp group)
	      (setq group (symbol-name group)))
689 690
	    (if (and (numberp (setq max (read buffer)))
		     (numberp (setq min (read buffer))))
691 692 693 694 695
		(push (list group (cons min max))
		      group-assoc)))
	(error nil))
      (widen)
      (forward-line 1))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
696 697
    group-assoc))

698
(defvar nnmail-active-file-coding-system 'raw-text
699 700
  "*Coding system for active file.")

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
701 702
(defun nnmail-save-active (group-assoc file-name)
  "Save GROUP-ASSOC in ACTIVE-FILE."
703 704
  (let ((coding-system-for-write nnmail-active-file-coding-system))
    (when file-name
705
      (with-temp-file file-name
706
	(nnmail-generate-active group-assoc)))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
707 708 709 710 711 712

(defun nnmail-generate-active (alist)
  "Generate an active file from group-alist ALIST."
  (erase-buffer)
  (let (group)
    (while (setq group (pop alist))
713 714 715 716 717
      (insert (format "%S %d %d y\n" (intern (car group)) (cdadr group)
		      (caadr group))))
    (goto-char (point-max))
    (while (search-backward "\\." nil t)
      (delete-char 1))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
718

719
(defun nnmail-get-split-group (file source)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
720
  "Find out whether this FILE is to be split into GROUP only.
721 722 723 724 725 726 727 728
If SOURCE is a directory spec, try to return the group name component."
  (if (eq (car source) 'directory)
      (let ((file (file-name-nondirectory file)))
	(mail-source-bind (directory source)
	  (if (string-match (concat (regexp-quote suffix) "$") file)
	      (substring file 0 (match-beginning 0))
	    nil)))
    nil))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
729 730 731

(defun nnmail-process-babyl-mail-format (func artnum-func)
  (let ((case-fold-search t)
732
	(count 0)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
733 734
	start message-id content-length do-search end)
    (while (not (eobp))
735
      (goto-char (point-min))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803
      (re-search-forward
       "\n0, *unseen,+\n\\(\\*\\*\\* EOOH \\*\\*\\*\n\\)?" nil t)
      (goto-char (match-end 0))
      (delete-region (match-beginning 0) (match-end 0))
      (narrow-to-region
       (setq start (point))
       (progn
	 ;; Skip all the headers in case there are more "From "s...
	 (or (search-forward "\n\n" nil t)
	     (search-forward-regexp "^[^:]*\\( .*\\|\\)$" nil t)
	     (search-forward ""))
	 (point)))
      ;; Unquote the ">From " line, if any.
      (goto-char (point-min))
      (when (looking-at ">From ")
	(replace-match "X-From-Line: ") )
      (run-hooks 'nnmail-prepare-incoming-header-hook)
      (goto-char (point-max))
      ;; Find the Message-ID header.
      (save-excursion
	(if (re-search-backward
	     "^Message-ID[ \t]*:[ \n\t]*\\(<[^>]*>\\)" nil t)
	    (setq message-id (buffer-substring (match-beginning 1)
					       (match-end 1)))
	  ;; There is no Message-ID here, so we create one.
	  (save-excursion
	    (when (re-search-backward "^Message-ID[ \t]*:" nil t)
	      (beginning-of-line)
	      (insert "Original-")))
	  (forward-line -1)
	  (insert "Message-ID: " (setq message-id (nnmail-message-id))
		  "\n")))
      ;; Look for a Content-Length header.
      (if (not (save-excursion
		 (and (re-search-backward
		       "^Content-Length:[ \t]*\\([0-9]+\\)" start t)
		      (setq content-length (string-to-int
					    (buffer-substring
					     (match-beginning 1)
					     (match-end 1))))
		      ;; We destroy the header, since none of
		      ;; the backends ever use it, and we do not
		      ;; want to confuse other mailers by having
		      ;; a (possibly) faulty header.
		      (progn (insert "X-") t))))
	  (setq do-search t)
	(widen)
	(if (or (= (+ (point) content-length) (point-max))
		(save-excursion
		  (goto-char (+ (point) content-length))
		  (looking-at "")))
	    (progn
	      (goto-char (+ (point) content-length))
	      (setq do-search nil))
	  (setq do-search t)))
      (widen)
      ;; Go to the beginning of the next article - or to the end
      ;; of the buffer.
      (when do-search
	(if (re-search-forward "^" nil t)
	    (goto-char (match-beginning 0))
	  (goto-char (1- (point-max)))))
      (delete-char 1)			; delete ^_
      (save-excursion
	(save-restriction
	  (narrow-to-region start (point))
	  (goto-char (point-min))
	  (nnmail-check-duplication message-id func artnum-func)
804
	  (incf count)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
805
	  (setq end (point-max))))
806 807
      (goto-char end))
    count))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
808 809 810

(defsubst nnmail-search-unix-mail-delim ()
  "Put point at the beginning of the next Unix mbox message."
Juanma Barranquero's avatar
Juanma Barranquero committed
811
  ;; Algorithm used to find the next article in the
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827
  ;; brain-dead Unix mbox format:
  ;;
  ;; 1) Search for "^From ".
  ;; 2) If we find it, then see whether the previous
  ;;    line is blank and the next line looks like a header.
  ;; Then it's possible that this is a mail delim, and we use it.
  (let ((case-fold-search nil)
	found)
    (while (not found)
      (if (not (re-search-forward "^From " nil t))
	  (setq found 'no)
	(save-excursion
	  (beginning-of-line)
	  (when (and (or (bobp)
			 (save-excursion
			   (forward-line -1)
828
			   (eq (char-after) ?\n)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
829 830
		     (save-excursion
		       (forward-line 1)
831
		       (while (looking-at ">From \\|From ")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
832 833 834 835 836 837 838 839
			 (forward-line 1))
		       (looking-at "[^ \n\t:]+[ \n\t]*:")))
	    (setq found 'yes)))))
    (beginning-of-line)
    (eq found 'yes)))

(defun nnmail-search-unix-mail-delim-backward ()
  "Put point at the beginning of the current Unix mbox message."
Juanma Barranquero's avatar
Juanma Barranquero committed
840
  ;; Algorithm used to find the next article in the
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856
  ;; brain-dead Unix mbox format:
  ;;
  ;; 1) Search for "^From ".
  ;; 2) If we find it, then see whether the previous
  ;;    line is blank and the next line looks like a header.
  ;; Then it's possible that this is a mail delim, and we use it.
  (let ((case-fold-search nil)
	found)
    (while (not found)
      (if (not (re-search-backward "^From " nil t))
	  (setq found 'no)
	(save-excursion
	  (beginning-of-line)
	  (when (and (or (bobp)
			 (save-excursion
			   (forward-line -1)
857
			   (eq (char-after) ?\n)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
858 859
		     (save-excursion
		       (forward-line 1)
860
		       (while (looking-at ">From \\|From ")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
861 862 863 864 865 866 867 868
			 (forward-line 1))
		       (looking-at "[^ \n\t:]+[ \n\t]*:")))
	    (setq found 'yes)))))
    (beginning-of-line)
    (eq found 'yes)))

(defun nnmail-process-unix-mail-format (func artnum-func)
  (let ((case-fold-search t)
869
	(count 0)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
870 871 872 873 874
	start message-id content-length end skip head-end)
    (goto-char (point-min))
    (if (not (and (re-search-forward "^From " nil t)
		  (goto-char (match-beginning 0))))
	;; Possibly wrong format?
875 876 877
	(error "Error, unknown mail format! (Possibly corrupted %s `%s'.)"
	       (if (buffer-file-name) "file" "buffer")
	       (or (buffer-file-name) (buffer-name)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921
      ;; Carry on until the bitter end.
      (while (not (eobp))
	(setq start (point)
	      end nil)
	;; Find the end of the head.
	(narrow-to-region
	 start
	 (if (search-forward "\n\n" nil t)
	     (1- (point))
	   ;; This will never happen, but just to be on the safe side --
	   ;; if there is no head-body delimiter, we search a bit manually.
	   (while (and (looking-at "From \\|[^ \t]+:")
		       (not (eobp)))
	     (forward-line 1))
	   (point)))
	;; Find the Message-ID header.
	(goto-char (point-min))
	(if (re-search-forward "^Message-ID[ \t]*:[ \n\t]*\\(<[^>]+>\\)" nil t)
	    (setq message-id (match-string 1))
	  (save-excursion
	    (when (re-search-forward "^Message-ID[ \t]*:" nil t)
	      (beginning-of-line)
	      (insert "Original-")))
	  ;; There is no Message-ID here, so we create one.
	  (forward-line 1)
	  (insert "Message-ID: " (setq message-id (nnmail-message-id)) "\n"))
	;; Look for a Content-Length header.
	(goto-char (point-min))
	(if (not (re-search-forward
		  "^Content-Length:[ \t]*\\([0-9]+\\)" nil t))
	    (setq content-length nil)
	  (setq content-length (string-to-int (match-string 1)))
	  ;; We destroy the header, since none of the backends ever
	  ;; use it, and we do not want to confuse other mailers by
	  ;; having a (possibly) faulty header.
	  (beginning-of-line)
	  (insert "X-"))
	(run-hooks 'nnmail-prepare-incoming-header-hook)
	;; Find the end of this article.
	(goto-char (point-max))
	(widen)
	(setq head-end (point))
	;; We try the Content-Length value.  The idea: skip over the header
	;; separator, then check what happens content-length bytes into the
ShengHuo ZHU's avatar
Typos.  
ShengHuo ZHU committed
922
	;; message body.  This should be either the end of the buffer, the
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949
	;; message separator or a blank line followed by the separator.
	;; The blank line should probably be deleted.  If neither of the
	;; three is met, the content-length header is probably invalid.
	(when content-length
	  (forward-line 1)
	  (setq skip (+ (point) content-length))
	  (goto-char skip)
	  (cond ((or (= skip (point-max))
		     (= (1+ skip) (point-max)))
		 (setq end (point-max)))
		((looking-at "From ")
		 (setq end skip))
		((looking-at "[ \t]*\n\\(From \\)")
		 (setq end (match-beginning 1)))
		(t (setq end nil))))
	(if end
	    (goto-char end)
	  ;; No Content-Length, so we find the beginning of the next
	  ;; article or the end of the buffer.
	  (goto-char head-end)
	  (or (nnmail-search-unix-mail-delim)
	      (goto-char (point-max))))
	;; Allow the backend to save the article.
	(save-excursion
	  (save-restriction
	    (narrow-to-region start (point))
	    (goto-char (point-min))
950
	    (incf count)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
951 952
	    (nnmail-check-duplication message-id func artnum-func)
	    (setq end (point-max))))
953 954
	(goto-char end)))
    count))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
955 956 957 958

(defun nnmail-process-mmdf-mail-format (func artnum-func)
  (let ((delim "^\^A\^A\^A\^A$")
	(case-fold-search t)
959
	(count 0)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
960 961 962 963 964
	start message-id end)
    (goto-char (point-min))
    (if (not (and (re-search-forward delim nil t)
		  (forward-line 1)))
	;; Possibly wrong format?
965
	(error "Error, unknown mail format! (Possibly corrupted.)")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
      ;; Carry on until the bitter end.
      (while (not (eobp))
	(setq start (point))
	;; Find the end of the head.
	(narrow-to-region
	 start
	 (if (search-forward "\n\n" nil t)
	     (1- (point))
	   ;; This will never happen, but just to be on the safe side --
	   ;; if there is no head-body delimiter, we search a bit manually.
	   (while (and (looking-at "From \\|[^ \t]+:")
		       (not (eobp)))
	     (forward-line 1))
	   (point)))
	;; Find the Message-ID header.
	(goto-char (point-min))
	(if (re-search-forward "^Message-ID[ \t]*:[ \n\t]*\\(<[^>]+>\\)" nil t)
	    (setq message-id (match-string 1))
	  ;; There is no Message-ID here, so we create one.
	  (save-excursion
	    (when (re-search-backward "^Message-ID[ \t]*:" nil t)
	      (beginning-of-line)
	      (insert "Original-")))
	  (forward-line 1)
	  (insert "Message-ID: " (setq message-id (nnmail-message-id)) "\n"))
	(run-hooks 'nnmail-prepare-incoming-header-hook)
	;; Find the end of this article.
	(goto-char (point-max))
	(widen)
	(if (re-search-forward delim nil t)
	    (beginning-of-line)
	  (goto-char (point-max)))
	;; Allow the backend to save the article.
	(save-excursion
	  (save-restriction
	    (narrow-to-region start (point))
	    (goto-char (point-min))
1003
	    (incf count)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1004 1005 1006
	    (nnmail-check-duplication message-id func artnum-func)
	    (setq end (point-max))))
	(goto-char end)
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
	(forward-line 2)))
    count))

(defun nnmail-process-maildir-mail-format (func artnum-func)
  ;; In a maildir, every file contains exactly one mail.
  (let ((case-fold-search t)
	message-id)
    (goto-char (point-min))
    ;; Find the end of the head.
    (narrow-to-region
     (point-min)
     (if (search-forward "\n\n" nil t)
	 (1- (point))
       ;; This will never happen, but just to be on the safe side --
       ;; if there is no head-body delimiter, we search a bit manually.
       (while (and (looking-at "From \\|[^ \t]+:")
		   (not (eobp)))
	 (forward-line 1))
       (point)))
    ;; Find the Message-ID header.
    (goto-char (point-min))
    (if (re-search-forward "^Message-ID:[ \t]*\\(<[^>]+>\\)" nil t)
	(setq message-id (match-string 1))
      ;; There is no Message-ID here, so we create one.
      (save-excursion
	(when (re-search-backward "^Message-ID[ \t]*:" nil t)
	  (beginning-of-line)
	  (insert "Original-")))
      (forward-line 1)
      (insert "Message-ID: " (setq message-id (nnmail-message-id)) "\n"))
    (run-hooks 'nnmail-prepare-incoming-header-hook)
    ;; Allow the backend to save the article.
    (widen)
    (save-excursion
      (goto-char (point-min))
      (nnmail-check-duplication message-id func artnum-func))
    1))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1044 1045 1046 1047 1048

(defun nnmail-split-incoming (incoming func &optional exit-func
				       group artnum-func)
  "Go through the entire INCOMING file and pick out each individual mail.
FUNC will be called with the buffer narrowed to each mail."
1049
  (let ( ;; If this is a group-specific split, we bind the split
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1050 1051 1052 1053 1054 1055 1056
	;; methods to just this group.
	(nnmail-split-methods (if (and group
				       (not nnmail-resplit-incoming))
				  (list (list group ""))
				nnmail-split-methods)))
    (save-excursion
      ;; Insert the incoming file.
1057
      (set-buffer (get-buffer-create nnmail-article-buffer))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1058
      (erase-buffer)
1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
      (let ((coding-system-for-read nnmail-incoming-coding-system))
	(mm-insert-file-contents incoming))
      (prog1
	  (if (zerop (buffer-size))
	      0
	    (goto-char (point-min))
	    (save-excursion (run-hooks 'nnmail-prepare-incoming-hook))
	    ;; Handle both babyl, MMDF and unix mail formats, since
	    ;; movemail will use the former when fetching from a
	    ;; mailbox, the latter when fetching from a file.
	    (cond ((or (looking-at "\^L")
		       (looking-at "BABYL OPTIONS:"))
		   (nnmail-process-babyl-mail-format func artnum-func))
		  ((looking-at "\^A\^A\^A\^A")
		   (nnmail-process-mmdf-mail-format func artnum-func))
		  ((looking-at "Return-Path:")
		   (nnmail-process-maildir-mail-format func artnum-func))
		  (t
		   (nnmail-process-unix-mail-format func artnum-func))))
	(when exit-func
	  (funcall exit-func))
	(kill-buffer (current-buffer))))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1081

1082
(defun nnmail-article-group (func &optional trace)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1083 1084
  "Look at the headers and return an alist of groups that match.
FUNC will be called with the group name to determine the article number."
1085
  (let ((methods (or nnmail-split-methods '(("bogus" ""))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1086
	(obuf (current-buffer))
1087
	group-art method grp)
1088 1089
    (if (and (sequencep methods)
	     (= (length methods) 1))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1090 1091 1092 1093 1094 1095
	;; If there is only just one group to put everything in, we
	;; just return a list with just this one method in.
	(setq group-art
	      (list (cons (caar methods) (funcall func (caar methods)))))
      ;; We do actual comparison.
      (save-excursion
1096
	;; Copy the article into the work buffer.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1097 1098
	(set-buffer nntp-server-buffer)
	(erase-buffer)
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
	(insert-buffer-substring obuf)
	;; Narrow to headers.
	(narrow-to-region
	 (goto-char (point-min))
	 (if (search-forward "\n\n" nil t)
	     (point)
	   (point-max)))
	(goto-char (point-min))
	;; Decode MIME headers and charsets.
	(when nnmail-mail-splitting-decodes
	  (let ((mail-parse-charset nnmail-mail-splitting-charset))
	    (mail-decode-encoded-word-region (point-min) (point-max))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1111 1112 1113 1114
	;; Fold continuation lines.
	(goto-char (point-min))
	(while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
	  (replace-match " " t t))
1115 1116 1117 1118 1119 1120
	;; Nuke pathologically long headers.  Since Gnus applies
	;; pathologically complex regexps to the buffer, lines
	;; that are looong will take longer than the Universe's
	;; existence to process.
	(goto-char (point-min))
	(while (not (eobp))
1121 1122
	  (unless (< (move-to-column nnmail-split-header-length-limit)
		     nnmail-split-header-length-limit)
1123
	    (delete-region (point) (gnus-point-at-eol)))
1124
	  (forward-line 1))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1125
	;; Allow washing.
1126
	(goto-char (point-min))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1127
	(run-hooks 'nnmail-split-hook)
1128 1129
	(when (setq nnmail-split-tracing trace)
	  (setq nnmail-split-trace nil))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1130 1131 1132 1133
	(if (and (symbolp nnmail-split-methods)
		 (fboundp nnmail-split-methods))
	    (let ((split
		   (condition-case nil
1134 1135 1136
		       ;; `nnmail-split-methods' is a function, so we
		       ;; just call this function here and use the
		       ;; result.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1137 1138 1139
		       (or (funcall nnmail-split-methods)
			   '("bogus"))
		     (error
1140 1141
		      (nnheader-message
		       5 "Error in `nnmail-split-methods'; using `bogus' mail group")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1142 1143
		      (sit-for 1)
		      '("bogus")))))
1144
	      (setq split (gnus-remove-duplicates split))
1145 1146 1147 1148 1149 1150 1151
	      ;; The article may be "cross-posted" to `junk'.  What
	      ;; to do?  Just remove the `junk' spec.  Don't really
	      ;; see anything else to do...
	      (let (elem)
		(while (setq elem (car (memq 'junk split)))
		  (setq split (delq elem split))))
	      (when split
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1152 1153 1154 1155 1156
		(setq group-art
		      (mapcar
		       (lambda (group) (cons group (funcall func group)))
		       split))))
	  ;; Go through the split methods to find a match.
1157 1158 1159
	  (while (and methods
		      (or nnmail-crosspost
			  (not group-art)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1160
	    (goto-char (point-max))
1161
	    (setq method (pop methods)
1162
		  grp (car method))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1163 1164 1165 1166 1167
	    (if (or methods
		    (not (equal "" (nth 1 method))))
		(when (and
		       (ignore-errors
			 (if (stringp (nth 1 method))
1168 1169 1170 1171 1172 1173
			     (let ((expand (string-match "\\\\[0-9&]" grp))
				   (pos (re-search-backward (cadr method)
							    nil t)))
			       (and expand
				    (setq grp (nnmail-expand-newtext grp)))
			       pos)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1174
			   ;; Function to say whether this is a match.
1175
			   (funcall (nth 1 method) grp)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1176 1177
		       ;; Don't enter the article into the same
		       ;; group twice.
1178 1179
		       (not (assoc grp group-art)))
		  (push (cons grp (funcall func grp))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1180 1181 1182 1183 1184 1185
			group-art))
	      ;; This is the final group, which is used as a
	      ;; catch-all.
	      (unless group-art
		(setq group-art
		      (list (cons (car method)
1186 1187 1188 1189
				  (funcall func (car method))))))))
	  ;; Fall back on "bogus" if all else fails.
	  (unless group-art
	    (setq group-art (list (cons "bogus" (funcall func "bogus"))))))
1190 1191
	;; Produce a trace if non-empty.
	(when (and trace nnmail-split-trace)
1192
	  (let ((restore (current-buffer)))
1193 1194
	    (nnheader-set-temp-buffer "*Split Trace*")
	    (gnus-add-buffer)
1195 1196 1197
	    (dolist (trace (nreverse nnmail-split-trace))
	      (prin1 trace (current-buffer))
	      (insert "\n"))
1198 1199 1200
	    (goto-char (point-min))
	    (gnus-configure-windows 'split-trace)
	    (set-buffer restore)))
1201
	(widen)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1202 1203 1204
	;; See whether the split methods returned `junk'.
	(if (equal group-art '(junk))
	    nil
1205 1206 1207 1208 1209 1210 1211
	  ;; The article may be "cross-posted" to `junk'.  What
	  ;; to do?  Just remove the `junk' spec.  Don't really
	  ;; see anything else to do...
	  (let (elem)
	    (while (setq elem (car (memq 'junk group-art)))
	      (setq group-art (delq elem group-art)))
	    (nreverse group-art)))))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1212 1213 1214 1215 1216 1217 1218

(defun nnmail-insert-lines ()
  "Insert how many lines there are in the body of the mail.
Return the number of characters in the body."
  (let (lines chars)
    (save-excursion
      (goto-char (point-min))
1219
      (unless (search-forward "\n\n" nil t)
1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230
	(goto-char (point-max))
	(insert "\n"))
      (setq chars (- (point-max) (point)))
      (setq lines (count-lines (point) (point-max)))
      (forward-char -1)
      (save-excursion
	(when (re-search-backward "^Lines: " nil t)
	  (delete-region (point) (progn (forward-line 1) (point)))))
      (beginning-of-line)
      (insert (format "Lines: %d\n" (max lines 0)))
      chars)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1231 1232 1233 1234 1235

(defun nnmail-insert-xref (group-alist)
  "Insert an Xref line based on the (group . article) alist."
  (save-excursion
    (goto-char (point-min))
1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251
    (unless (search-forward "\n\n" nil t)
      (goto-char (point-max))
      (insert "\n"))
    (forward-char -1)
    (when (re-search-backward "^Xref: " nil t)
      (delete-region (match-beginning 0)
		     (progn (forward-line 1) (point))))
    (insert (format "Xref: %s" (system-name)))
    (while group-alist
      (insert (format " %s:%d"
		      (mm-encode-coding-string
		       (caar group-alist)
		       nnmail-pathname-coding-system)
		      (cdar group-alist)))
      (setq group-alist (cdr group-alist)))
    (insert "\n")))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262

;;; Message washing functions

(defun nnmail-remove-leading-whitespace ()
  "Remove excessive whitespace from all headers."
  (goto-char (point-min))
  (while (re-search-forward "^\\([^ :]+: \\) +" nil t)
    (replace-match "\\1" t)))

(defun nnmail-remove-list-identifiers ()
  "Remove list identifiers from Subject headers."
1263 1264 1265 1266
  (let ((regexp
	 (if (consp nnmail-list-identifiers)
	     (mapconcat 'identity nnmail-list-identifiers " *\\|")
	   nnmail-list-identifiers)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1267 1268
    (when regexp
      (goto-char (point-min))
1269 1270 1271 1272 1273 1274 1275 1276 1277
      (while (re-search-forward
	      (concat "^Subject: +\\(R[Ee]: +\\)*\\(" regexp " *\\)")
	      nil t)
	(delete-region (match-beginning 2) (match-end 0))
	(beginning-of-line))
      (when (re-search-forward "^Subject: +\\(\\(R[Ee]: +\\)+\\)R[Ee]: +"
			       nil t)
	(delete-region (match-beginning 1) (match-end 1))
	(beginning-of-line)))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1278 1279 1280 1281 1282

(defun nnmail-remove-tabs ()
  "Translate TAB characters into SPACE characters."
  (subst-char-in-region (point-min) (point-max) ?\t ?  t))

1283 1284 1285 1286 1287 1288 1289 1290 1291
(defun nnmail-fix-eudora-headers ()
  "Eudora has a broken References line, but an OK In-Reply-To."
  (goto-char (point-min))
  (when (re-search-forward "^X-Mailer:.*Eudora" nil t)
    (goto-char (point-min))
    (when (re-search-forward "^References:" nil t)
      (beginning-of-line)
      (insert "X-Gnus-Broken-Eudora-"))
    (goto-char (point-min))
1292 1293
    (when (re-search-forward "^\\(In-Reply-To:[^\n]+\\)\n[ \t]+" nil t)
      (replace-match "\\1" t))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1294

1295 1296
(custom-add-option 'nnmail-prepare-incoming-header-hook
		   'nnmail-fix-eudora-headers)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1297

1298
;;; Utility functions
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1299

1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321
(defun nnmail-do-request-post (accept-func &optional server)
  "Utility function to directly post a message to an nnmail-derived group.
Calls ACCEPT-FUNC (which should be `nnchoke-request-accept-article')
to actually put the message in the right group."
  (let ((success t))
    (dolist (mbx (message-unquote-tokens
		  (message-tokenize-header
		   (message-fetch-field "Newsgroups") ", ")) success)
      (let ((to-newsgroup (gnus-group-prefixed-name mbx gnus-command-method)))
	(or (gnus-active to-newsgroup)
	    (gnus-activate-group to-newsgroup)
	    (if (gnus-y-or-n-p (format "No such group: %s.  Create it? "
				       to-newsgroup))
		(or (and (gnus-request-create-group
			  to-newsgroup gnus-command-method)
			 (gnus-activate-group to-newsgroup nil nil
					      gnus-command-method))
		    (error "Couldn't create group %s" to-newsgroup)))
	    (error "No such group: %s" to-newsgroup))
	(unless (funcall accept-func mbx (nth 1 gnus-command-method))
	  (setq success nil))))))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1322 1323
(defun nnmail-split-fancy ()
  "Fancy splitting method.
1324
See the documentation for the variable `nnmail-split-fancy' for details."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
  (let ((syntab (syntax-table)))
    (unwind-protect
	(progn
	  (set-syntax-table nnmail-split-fancy-syntax-table)
	  (nnmail-split-it nnmail-split-fancy))
      (set-syntax-table syntab))))

(defvar nnmail-split-cache nil)
;; Alist of split expressions their equivalent regexps.

(defun nnmail-split-it (split)
  ;; Return a list of groups matching SPLIT.
1337 1338 1339 1340 1341 1342 1343 1344 1345
  (let (cached-pair)
    (cond
     ;; nil split
     ((null split)
      nil)

     ;; A group name.  Do the \& and \N subs into the string.
     ((stringp split)
      (when nnmail-split-tracing
1346
	(push split nnmail-split-trace))
1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368
      (list (nnmail-expand-newtext split)))

     ;; Junk the message.
     ((eq split 'junk)
      (when nnmail-split-tracing
	(push "junk" nnmail-split-trace))
      (list 'junk))

     ;; Builtin & operation.
     ((eq (car split) '&)
      (apply 'nconc (mapcar 'nnmail-split-it (cdr split))))

     ;; Builtin | operation.
     ((eq (car split) '|)
      (let (done)
	(while (and (not done) (cdr split))
	  (setq split (cdr split)
		done (nnmail-split-it (car split))))
	done))

     ;; Builtin : operation.
     ((eq (car split) ':)
1369 1370
      (when nnmail-split-tracing
	(push split nnmail-split-trace))
1371 1372
      (nnmail-split-it (save-excursion (eval (cdr split)))))

1373 1374 1375 1376
     ;; Builtin ! operation.
     ((eq (car split) '!)
      (funcall (cadr split) (nnmail-split-it (caddr split))))

1377 1378
     ;; Check the cache for the regexp for this split.
     ((setq cached-pair (assq split nnmail-split-cache))
1379 1380 1381 1382 1383 1384 1385 1386
      (let (split-result
	    (end-point (point-max))
	    (value (nth 1 split)))
	(if (symbolp value)
	    (setq value (cdr (assq value nnmail-split-abbrev-alist))))
	(while (and (goto-char end-point)
		    (re-search-backward (cdr cached-pair) nil t))
	  (when nnmail-split-tracing
1387
	    (push split nnmail-split-trace))
1388 1389
	  (let ((split-rest (cddr split))
		(end (match-end 0))
1390 1391 1392 1393
		;; The searched regexp is \(\(FIELD\).*\)\(VALUE\).
		;; So, start-of-value is the point just before the
		;; beginning of the value, whereas after-header-name
		;; is the point just after the field name.
1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420
		(start-of-value (match-end 1))
		(after-header-name (match-end 2)))
	    ;; Start the next search just before the beginning of the
	    ;; VALUE match.
	    (setq end-point (1- start-of-value))
	    ;; Handle - RESTRICTs
	    (while (eq (car split-rest) '-)
	      ;; RESTRICT must start after-header-name and
	      ;; end after start-of-value, so that, for
	      ;; (any "foo" - "x-foo" "foo.list")
	      ;; we do not exclude foo.list just because
	      ;; the header is: ``To: x-foo, foo''
	      (goto-char end)
	      (if (and (re-search-backward (cadr split-rest)
					   after-header-name t)
		       (> (match-end 0) start-of-value))
		  (setq split-rest nil)
		(setq split-rest (cddr split-rest))))
	    (when split-rest
	      (goto-char end)
	      (let ((value (nth 1 split)))
		(if (symbolp value)
		    (setq value (cdr (assq value nnmail-split-abbrev-alist))))
		;; Someone might want to do a \N sub on this match, so get the
		;; correct match positions.
		(re-search-backward value start-of-value))
	      (dolist (sp (nnmail-split-it (car split-rest)))
1421
		(unless (member sp split-result)
1422 1423