nnmail.el 72 KB
Newer Older
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1
;;; nnmail.el --- mail support functions for the Gnus mail backends
2

3
;; Copyright (C) 1995-2013 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
;; Keywords: news, mail

;; This file is part of GNU Emacs.

10
;; GNU Emacs is free software: you can redistribute it and/or modify
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
11
;; it under the terms of the GNU General Public License as published by
12 13
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
14 15 16 17 18 19 20

;; 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
21
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
22 23 24 25 26

;;; Commentary:

;;; Code:

27
;; For Emacs <22.2 and XEmacs.
28 29 30
(eval-and-compile
  (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))

31 32
(eval-when-compile (require 'cl))

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

41 42
(autoload 'gnus-add-buffer "gnus")
(autoload 'gnus-kill-buffer "gnus")
43 44
(eval-when-compile
  (autoload 'mail-send-and-exit "sendmail" nil t))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
45 46 47 48 49 50 51 52 53 54

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

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

(defgroup nnmail-prepare nil
55
  "Preparing (or mangling) new mail after retrieval."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
56 57 58 59 60 61 62
  :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
63
  "Organizing the incoming mail in folders."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
  :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)

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

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\")
92 93
	 (\"mail.junk\" \"From:.*Lars\\\\|Subject:.*buy\")
	 (\"mail.misc\" \"\")))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
94 95 96 97 98 99 100 101 102 103 104 105 106 107

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.

108 109 110
This variable can also have a function as its value, and it can
also have a fancy split method as its value.  See
`nnmail-split-fancy' for an explanation of that syntax."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
111
  :group 'nnmail-split
112 113
  :type '(choice (repeat :tag "Alist" (group (string :tag "Name")
					     (choice regexp function)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
114 115 116 117 118 119 120 121 122 123
		 (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)

124 125 126
(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."
127
  :version "22.1"
128 129 130 131 132 133 134 135
  :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."
136
  :version "22.1"
137 138 139 140 141
  :group 'nnmail-split
  :type '(choice (const :tag "none" nil)
		 (regexp :value ".*")
		 (repeat :value (".*") regexp)))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
142 143
;; Added by gord@enci.ucalgary.ca (Gordon Matzigkeit).
(defcustom nnmail-keep-last-article nil
144 145 146
  "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
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
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)
172
		 (number :tag "days")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
173 174 175 176
		 (const never)))

(defcustom nnmail-expiry-wait-function nil
  "Variable that holds function to specify how old articles should be before they are expired.
177 178 179 180
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
181 182 183 184 185

Eg.:

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

194 195 196 197 198 199 200 201
(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
202
  :version "21.1"
203 204
  :group 'nnmail-expire
  :type '(choice (const delete)
Miles Bader's avatar
Miles Bader committed
205
		 function
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
		 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\";
Juanma Barranquero's avatar
Juanma Barranquero committed
231
articles containing the string \"IMPORTANT\" in the Subject header will
232 233
be expired to the group \"nnfolder:IMPORTANT.YYYY.MMM\"; and
everything else will be expired to \"nnfolder:Archive-YYYY\"."
234
  :version "22.1"
235 236 237 238 239 240
  :group 'nnmail-expire
  :type '(repeat (list (choice :tag "Match against"
			       (string :tag "Header")
			       (const to-from))
		       regexp
		       (string :tag "Target group format string"))))
241

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
242
(defcustom nnmail-cache-accepted-message-ids nil
243 244
  "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
245 246 247
  :group 'nnmail
  :type 'boolean)

248 249
(make-obsolete-variable 'nnmail-spool-file 'mail-sources
			"Gnus 5.9 (Emacs 22.1)")
250
;; revision 5.29 / p0-85 / Gnus 5.9
Miles Bader's avatar
Miles Bader committed
251
;; Variable removed in No Gnus v0.7
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
252

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

258 259 260
(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
261
  :version "21.1"
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
262 263 264 265 266 267 268 269 270
  :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
271
  (if (string-match "windows-nt" (symbol-name system-type))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
272 273
      'copy-file
    'add-name-to-file)
274
  "*Function called to create a copy of a file.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
275 276 277 278 279 280 281 282 283 284 285 286
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)
287
  "*Hook that will be run after the incoming mail has been transferred.
Dave Love's avatar
Dave Love committed
288
The incoming mail is moved from the specified spool file (which normally is
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
289 290 291 292 293 294 295 296
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
297 298
	  (lambda ()
	    (call-process \"/local/bin/mailsend\" nil nil nil
299 300 301 302
			  \"read\"
			  ;; The incoming mail box file.
			  (expand-file-name (user-login-name)
					    rmail-spool-directory))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
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 335 336 337 338 339 340

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)
341 342
		 (regexp :value ".*")
		 (repeat :value (".*") regexp)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361

(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)

362 363
(defcustom nnmail-spool-hook nil
  "*A hook called when a new article is spooled."
364
  :version "22.1"
365 366 367
  :group 'nnmail
  :type 'hook)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
368
(defcustom nnmail-large-newsgroup 50
369 370
  "*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
371 372
messages will be shown to indicate the current status."
  :group 'nnmail-various
373 374 375 376 377 378
  :type '(choice (const :tag "infinite" nil)
                 (number :tag "count")))

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

379
This is copy of the `lazy' widget in Emacs 22.1 provided for compatibility."
380 381 382 383 384
  :format "%{%t%}: %v"
  :convert-widget 'widget-value-convert-widget
  :value-create (lambda (widget)
                  (let ((value (widget-get widget :value))
                        (type (widget-get widget :type)))
385 386
                    (widget-put widget :children
                                (list (widget-create-child-value
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 412 413 414 415
                                       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 (:)"
416
                            :value (:)
417
                            (const :format "" :value :)
418
                            function
419 420 421
                            (editable-list :inline t (sexp :tag "Arg"))
                            )
                      (list :tag "Function with split arguments (!)"
422
                            :value (!)
423 424 425
                            (const :format "" !)
                            function
                            (editable-list :inline t nnmail-split-fancy))
426 427
                      (list :tag "Field match"
                            (choice :tag "Field"
428 429
                                    regexp symbol)
                            (choice :tag "Match"
430
                                    regexp
431 432 433 434 435 436 437 438
                                    (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
439 440 441 442 443

(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'.

444
The format of this variable is SPLIT, where SPLIT can be one of
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
445 446 447 448
the following:

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

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

\(| 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.

466 467 468 469
\(! FUNCTION SPLIT): Call FUNCTION with the result of SPLIT.  The
  return value FUNCTION should be a split, which is then recursively
  processed.

470 471 472 473 474 475
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
476 477 478 479
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.

480
FIELD and VALUE can also be Lisp symbols, in that case they are expanded
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
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\")
503 504 505 506 507 508 509
	     ;; 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
510 511 512 513 514
	     ;; People...
	     (any \"larsi@ifi\\\\.uio\\\\.no\" \"people.Lars Magne Ingebrigtsen\"))
	  ;; Unmatched mail goes to the catch all group.
	  \"misc.misc\"))"
  :group 'nnmail-split
515
  :type 'nnmail-split-fancy)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
516 517 518 519 520

(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")
521 522 523
    (from . "from\\|sender\\|resent-from")
    (nato . "to\\|cc\\|resent-to\\|resent-cc")
    (naany . "from\\|to\\|cc\\|sender\\|resent-from\\|resent-to\\|resent-cc"))
524
  "*Alist of abbreviations allowed in `nnmail-split-fancy'."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
525 526 527 528 529 530 531 532 533 534 535
  :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")))

Miles Bader's avatar
Miles Bader committed
536 537 538
(defcustom nnmail-message-id-cache-file
  (nnheader-concat gnus-home-directory ".nnmail-cache")
  "The file name of the nnmail Message-ID cache."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
539 540 541 542 543 544
  :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.
545
Three values are valid: nil, which means that nnmail is not to keep a
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
546 547 548 549 550 551 552 553 554 555 556 557
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)))

558
(defcustom nnmail-extra-headers '(To Newsgroups Cc)
559 560 561
  "Extra headers to parse.
In addition to the standard headers, these extra headers will be
included in NOV headers (and the like) when backends parse headers."
562
  :version "24.3"
563 564 565
  :group 'nnmail
  :type '(repeat symbol))

566
(defcustom nnmail-split-header-length-limit 2048
567
  "Header lines longer than this limit are excluded from the split function."
Dave Love's avatar
Dave Love committed
568
  :version "21.1"
569 570 571
  :group 'nnmail
  :type 'integer)

572 573
(defcustom nnmail-mail-splitting-charset nil
  "Default charset to be used when splitting incoming mail."
574
  :version "22.1"
575 576 577 578 579
  :group 'nnmail
  :type 'symbol)

(defcustom nnmail-mail-splitting-decodes nil
  "Whether the nnmail splitting functionality should MIME decode headers."
580
  :version "22.1"
581 582 583 584 585 586 587 588 589
  :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."
590
  :version "22.1"
591 592 593 594 595 596 597
  :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)."
598
  :version "22.1"
599 600 601
  :group 'nnmail
  :type 'boolean)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
602 603
;;; Internal variables.

604 605 606
(defvar nnmail-article-buffer " *nnmail incoming*"
  "The buffer used for splitting incoming mails.")

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

610 611 612 613 614
(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
615 616 617 618 619
  "Syntax table used by `nnmail-split-fancy'.")

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

620 621
(defvar nnmail-split-tracing nil)
(defvar nnmail-split-trace nil)
622
(defvar nnmail-inhibit-default-split-group nil)
623

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
624 625 626 627 628


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

629 630 631
(defvar nnmail-file-coding-system 'raw-text
  "Coding system used in nnmail.")

632 633 634 635
(defvar nnmail-incoming-coding-system
  mm-text-coding-system
  "Coding system used in reading inbox")

Miles Bader's avatar
Miles Bader committed
636 637 638 639 640 641 642 643
(defvar nnmail-pathname-coding-system
  ;; This causes Emacs 22.2 and 22.3 to issue a useless warning.
  ;;(if (and (featurep 'xemacs) (featurep 'file-coding))
  (if (featurep 'xemacs)
      (if (featurep 'file-coding)
	  ;; Work around a bug in many XEmacs 21.5 betas.
	  ;; Cf. http://thread.gmane.org/gmane.emacs.gnus.general/68134
	  (setq file-name-coding-system (coding-system-aliasee 'file-name))))
644
  "*Coding system for file name.")
645

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
646 647 648
(defun nnmail-find-file (file)
  "Insert FILE in server buffer safely."
  (set-buffer nntp-server-buffer)
649
  (delete-region (point-min) (point-max))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
650
  (let ((format-alist nil)
651
	(after-insert-file-functions nil))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
652
    (condition-case ()
653
	(let ((coding-system-for-read nnmail-file-coding-system)
654 655
	      (auto-mode-alist (mm-auto-mode-alist))
	      (file-name-coding-system nnmail-pathname-coding-system))
656 657
	  (insert-file-contents file)
	  t)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
658 659 660
      (file-error nil))))

(defun nnmail-group-pathname (group dir &optional file)
661
  "Make file name for GROUP."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
662 663
  (concat
   (let ((dir (file-name-as-directory (expand-file-name dir))))
664 665 666
     (setq group (nnheader-replace-duplicate-chars-in-string
		  (nnheader-replace-chars-in-string group ?/ ?_)
		  ?. ?_))
667
     (setq group (nnheader-translate-file-chars group))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
668
     ;; If this directory exists, we use it directly.
669 670 671 672 673 674
     (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
675
	 (nnheader-replace-chars-in-string group ?. ?/)
676
	 dir))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
677 678 679 680 681
   (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."
682
  ;; Go through all groups from the active list.
683
  (with-current-buffer nntp-server-buffer
684 685 686 687 688 689 690 691 692 693 694 695 696 697 698
    (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
699
	    (narrow-to-region (point) (point-at-eol))
700 701 702
	    (setq group (read buffer))
	    (unless (stringp group)
	      (setq group (symbol-name group)))
703 704
	    (if (and (numberp (setq max (read buffer)))
		     (numberp (setq min (read buffer))))
Miles Bader's avatar
Miles Bader committed
705
		(push (list (mm-string-as-unibyte group) (cons min max))
706 707 708 709
		      group-assoc)))
	(error nil))
      (widen)
      (forward-line 1))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
710 711
    group-assoc))

712
(defvar nnmail-active-file-coding-system 'raw-text
713 714
  "*Coding system for active file.")

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
715 716
(defun nnmail-save-active (group-assoc file-name)
  "Save GROUP-ASSOC in ACTIVE-FILE."
717 718
  (let ((coding-system-for-write nnmail-active-file-coding-system))
    (when file-name
719
      (with-temp-file file-name
Miles Bader's avatar
Miles Bader committed
720
	(mm-disable-multibyte)
721
	(nnmail-generate-active group-assoc)))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
722 723 724 725 726 727

(defun nnmail-generate-active (alist)
  "Generate an active file from group-alist ALIST."
  (erase-buffer)
  (let (group)
    (while (setq group (pop alist))
728 729 730 731 732
      (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
733

734
(defun nnmail-get-split-group (file source)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
735
  "Find out whether this FILE is to be split into GROUP only.
736 737 738 739 740 741 742 743
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
744 745 746

(defun nnmail-process-babyl-mail-format (func artnum-func)
  (let ((case-fold-search t)
747
	(count 0)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
748 749
	start message-id content-length do-search end)
    (while (not (eobp))
750
      (goto-char (point-min))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
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
      (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)
787
		      (setq content-length (string-to-number
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
					    (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)
819
	  (incf count)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
820
	  (setq end (point-max))))
821 822
      (goto-char end))
    count))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
823 824 825

(defsubst nnmail-search-unix-mail-delim ()
  "Put point at the beginning of the next Unix mbox message."
Juanma Barranquero's avatar
Juanma Barranquero committed
826
  ;; Algorithm used to find the next article in the
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
  ;; 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)
843
			   (eq (char-after) ?\n)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
844 845
		     (save-excursion
		       (forward-line 1)
846
		       (while (looking-at ">From \\|From ")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
847 848 849 850 851 852 853 854
			 (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
855
  ;; Algorithm used to find the next article in the
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
  ;; 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)
872
			   (eq (char-after) ?\n)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
873 874
		     (save-excursion
		       (forward-line 1)
875
		       (while (looking-at ">From \\|From ")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
876 877 878 879 880 881 882 883
			 (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)
884
	(count 0)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
885 886 887 888 889
	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?
890 891 892
	(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
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 922 923
      ;; 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)
924
	  (setq content-length (string-to-number (match-string 1)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
925 926 927 928 929 930 931 932 933 934 935 936
	  ;; 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
937
	;; message body.  This should be either the end of the buffer, the
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
	;; 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))
965
	    (incf count)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
966 967
	    (nnmail-check-duplication message-id func artnum-func)
	    (setq end (point-max))))
968 969
	(goto-char end)))
    count))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
970

971
(defun nnmail-process-mmdf-mail-format (func artnum-func &optional junk-func)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
972 973
  (let ((delim "^\^A\^A\^A\^A$")
	(case-fold-search t)
974
	(count 0)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
975 976 977 978 979
	start message-id end)
    (goto-char (point-min))
    (if (not (and (re-search-forward delim nil t)
		  (forward-line 1)))
	;; Possibly wrong format?
980
	(error "Error, unknown mail format! (Possibly corrupted.)")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
      ;; 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))
1018
	    (incf count)
1019
	    (nnmail-check-duplication message-id func artnum-func junk-func)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1020 1021
	    (setq end (point-max))))
	(goto-char end)
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
	(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
1059

1060 1061 1062
(defvar nnmail-group-names-not-encoded-p nil
  "Non-nil means group names are not encoded.")

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1063
(defun nnmail-split-incoming (incoming func &optional exit-func
1064
				       group artnum-func junk-func)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1065
  "Go through the entire INCOMING file and pick out each individual mail.
1066 1067 1068
FUNC will be called with the buffer narrowed to each mail.
INCOMING can also be a buffer object.  In that case, the mail
will be copied over from that buffer."
1069
  (let ( ;; If this is a group-specific split, we bind the split
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1070 1071 1072 1073
	;; methods to just this group.
	(nnmail-split-methods (if (and group
				       (not nnmail-resplit-incoming))
				  (list (list group ""))
1074 1075
				nnmail-split-methods))
	(nnmail-group-names-not-encoded-p t))
1076 1077
    ;; Insert the incoming file.
    (with-current-buffer (get-buffer-create nnmail-article-buffer)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1078
      (erase-buffer)
1079 1080 1081 1082
      (if (bufferp incoming)
	  (insert-buffer-substring incoming)
	(let ((coding-system-for-read nnmail-incoming-coding-system))
	  (mm-insert-file-contents incoming)))
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
      (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")
1095 1096
		   (nnmail-process-mmdf-mail-format
		    func artnum-func junk-func))
1097 1098 1099 1100 1101 1102 1103
		  ((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
1104

1105
(defun nnmail-article-group (func &optional trace junk-func)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1106 1107
  "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."
1108
  (let ((methods (or nnmail-split-methods '(("bogus" ""))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1109
	(obuf (current-buffer))
1110
	group-art method grp)
1111
    (if (and (sequencep methods)
1112 1113
	     (= (length methods) 1)
	     (not nnmail-inhibit-default-split-group))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1114 1115 1116 1117 1118
	;; 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.
1119 1120
      ;; Copy the article into the work buffer.
      (with-current-buffer nntp-server-buffer
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1121
	(erase-buffer)
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
	(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
1134 1135 1136 1137
	;; Fold continuation lines.
	(goto-char (point-min))
	(while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
	  (replace-match " " t t))
1138 1139 1140 1141 1142 1143
	;; 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))
1144 1145
	  (unless (< (move-to-column nnmail-split-header-length-limit)
		     nnmail-split-header-length-limit)
1146
	    (delete-region (point) (point-at-eol)))
1147
	  (forward-line 1))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1148
	;; Allow washing.
1149
	(goto-char (point-min))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1150
	(run-hooks 'nnmail-split-hook)
1151 1152
	(when (setq nnmail-split-tracing trace)
	  (setq nnmail-split-trace nil))
1153 1154
	(if (or (and (symbolp nnmail-split-methods)
		     (fboundp nnmail-split-methods))
1155
		(not (consp (car-safe nnmail-split-methods)))
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
		(and (listp nnmail-split-methods)
		     ;; Not a regular split method, so it has to be a
		     ;; fancy one.
		     (not (let ((top-element (car-safe nnmail-split-methods)))
			    (and (= 2 (length top-element))
				 (stringp (nth 0 top-element))
				 (stringp (nth 1 top-element)))))))
	    (let* ((method-function
		    (if (and (symbolp nnmail-split-methods)
			     (fboundp nnmail-split-methods))
			nnmail-split-methods
		      'nnmail-split-fancy))
		   (split
		    (condition-case error-info
			;; `nnmail-split-methods' is a function, so we
			;; just call this function here and use the
			;; result.
			(or (funcall method-function)
			    (and (not nnmail-inhibit-default-split-group)
				 '("bogus")))
		      (error
		       (nnheader-message
			5 "Error in `nnmail-split-methods'; using `bogus' mail group: %S" error-info)
		       (sit-for 1)
		       '("bogus")))))
1181
	      (setq split (mm-delete-duplicates split))
1182 1183 1184
	      ;; The article may be "cross-posted" to `junk'.  What
	      ;; to do?  Just remove the `junk' spec.  Don't really
	      ;; see anything else to do...
1185 1186 1187 1188
	      (when (and (memq 'junk split)
			 junk-func)
		(funcall junk-func 'junk))
	      (setq split (delq 'junk split))
1189
	      (when split
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1190 1191 1192 1193 1194
		(setq group-art
		      (mapcar
		       (lambda (group) (cons group (funcall func group)))
		       split))))
	  ;; Go through the split methods to find a match.
1195 1196 1197
	  (while (and methods
		      (or nnmail-crosspost
			  (not group-art)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1198
	    (goto-char (point-max))
1199
	    (setq method (pop methods)
1200
		  grp (car method))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1201 1202 1203 1204 1205
	    (if (or methods
		    (not (equal "" (nth 1 method))))
		(when (and
		       (ignore-errors
			 (if (stringp (nth 1 method))
1206 1207 1208 1209 1210 1211
			     (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
1212
			   ;; Function to say whether this is a match.
1213
			   (funcall (nth 1 method) grp)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1214 1215
		       ;; Don't enter the article into the same
		       ;; group twice.
1216 1217
		       (not (assoc grp group-art)))
		  (push (cons grp (funcall func grp))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1218 1219 1220
			group-art))
	      ;; This is the final group, which is used as a
	      ;; catch-all.
1221
	      (when (and (not group-art)
1222 1223
			 (or (equal "" (nth 1 method))
			     (not nnmail-inhibit-default-split-group)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1224 1225
		(setq group-art
		      (list (cons (car method)
1226 1227
				  (funcall func (car method))))))))
	  ;; Fall back on "bogus" if all else fails.
1228 1229
	  (when (and (not group-art)
		     (not nnmail-inhibit-default-split-group))
1230
	    (setq group-art (list (cons "bogus" (funcall func "bogus"))))))
1231 1232
	;; Produce a trace if non-empty.
	(when (and trace nnmail-split-trace)
1233
	  (let ((restore (current-buffer)))
1234 1235
	    (nnheader-set-temp-buffer "*Split Trace*")
	    (gnus-add-buffer)
1236 1237 1238
	    (dolist (trace (nreverse nnmail-split-trace))
	      (prin1 trace (current-buffer))
	      (insert "\n"))
1239 1240 1241
	    (goto-char (point-min))
	    (gnus-configure-windows 'split-trace)
	    (set-buffer restore)))
1242
	(widen)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1243 1244 1245
	;; See whether the split methods returned `junk'.
	(if (equal group-art '(junk))
	    nil
1246 1247 1248 1249 1250 1251 1252
	  ;; 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
1253 1254 1255 1256 1257 1258 1259

(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))
1260
      (unless (search-forward "\n\n" nil t)
1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271
	(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
1272 1273 1274 1275 1276

(defun nnmail-insert-xref (group-alist)
  "Insert an Xref line based on the (group . article) alist."
  (save-excursion
    (goto-char (point-min))
1277 1278 1279 1280 1281 1282 1283 1284 1285
    (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
1286 1287 1288 1289 1290
      (insert (if (mm-multibyte-p)
		  (mm-string-as-multibyte
		   (format " %s:%d" (caar group-alist) (cdar group-alist)))
		(mm-string-as-unibyte
		 (format " %s:%d" (caar group-alist) (cdar group-alist)))))
1291 1292
      (setq group-alist (cdr group-alist)))
    (insert "\n")))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303

;;; 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."
1304 1305 1306 1307
  (let ((regexp