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

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1995-2017 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 28
(eval-when-compile (require 'cl))

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

37 38
(autoload 'gnus-add-buffer "gnus")
(autoload 'gnus-kill-buffer "gnus")
39
(autoload 'mail-send-and-exit "sendmail" nil t)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
40 41 42 43 44 45 46 47 48 49

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

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

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

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

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
86
       \\='((\"mail.4ad\" \"From:.*4ad\")
87 88
	 (\"mail.junk\" \"From:.*Lars\\\\|Subject:.*buy\")
	 (\"mail.misc\" \"\")))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
89 90 91 92 93 94 95 96 97 98 99 100 101 102

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.

103 104 105
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
106
  :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
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
161
  "Expirable articles that are older than this will be expired.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
162 163 164 165 166
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
E.g.:
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
178 179 180

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

189
(defcustom nnmail-expiry-target 'delete
190
  "Variable that says where expired messages should end up.
191 192 193 194 195 196
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
  :group 'nnmail-expire
  :type '(choice (const delete)
Miles Bader's avatar
Miles Bader committed
200
		 function
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
		 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
Paul Eggert's avatar
Paul Eggert committed
220
      \\='((to-from \"boss\" \"nnfolder:Work\")
221 222 223 224 225
	(\"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
226
articles containing the string \"IMPORTANT\" in the Subject header will
227 228
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 244
(make-obsolete-variable 'nnmail-spool-file 'mail-sources
			"Gnus 5.9 (Emacs 22.1)")
245
;; revision 5.29 / p0-85 / Gnus 5.9
Miles Bader's avatar
Miles Bader committed
246
;; Variable removed in No Gnus v0.7
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
247

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

253
(defcustom nnmail-scan-directory-mail-source-once nil
254
  "If non-nil, scan all incoming procmail sorted mails once.
255
It scans low-level sorted spools even when not required."
Dave Love's avatar
Dave Love committed
256
  :version "21.1"
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
257 258 259 260 261 262 263 264 265
  :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
266
  (if (string-match "windows-nt" (symbol-name system-type))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
267 268
      'copy-file
    'add-name-to-file)
269
  "Function called to create a copy of a file.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
270 271 272 273 274 275 276 277 278 279 280 281
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)
282
  "Hook that will be run after the incoming mail has been transferred.
Dave Love's avatar
Dave Love committed
283
The incoming mail is moved from the specified spool file (which normally is
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
284 285 286 287 288
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.)

289
E.g.:
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
290

291
\(add-hook \\='nnmail-read-incoming-hook
292 293
	  (lambda ()
	    (call-process \"/local/bin/mailsend\" nil nil nil
294 295 296 297
			  \"read\"
			  ;; The incoming mail box file.
			  (expand-file-name (user-login-name)
					    rmail-spool-directory))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
298 299 300 301 302 303

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:

304
\(add-hook \\='nnmail-read-incoming-hook
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
305 306 307
	  (lambda ()
	    ;; Update the displayed time, since that will clear out
	    ;; the flag that says you have mail.
308
	    (when (eq (process-status \"display-time\") \\='run)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
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
	      (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)
336 337
		 (regexp :value ".*")
		 (repeat :value (".*") regexp)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356

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

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

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

371
(define-widget 'nnmail-split-fancy 'lazy
372 373 374 375 376 377 378 379 380 381 382 383
  "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 (:)"
384
                            :value (:)
385
                            (const :format "" :value :)
386
                            function
387 388 389
                            (editable-list :inline t (sexp :tag "Arg"))
                            )
                      (list :tag "Function with split arguments (!)"
390
                            :value (!)
391 392 393
                            (const :format "" !)
                            function
                            (editable-list :inline t nnmail-split-fancy))
394 395
                      (list :tag "Field match"
                            (choice :tag "Field"
396 397
                                    regexp symbol)
                            (choice :tag "Match"
398
                                    regexp
399 400 401 402 403 404 405 406
                                    (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
407 408 409 410 411

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

412
The format of this variable is SPLIT, where SPLIT can be one of
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
413 414 415 416
the following:

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

417
\(FIELD VALUE [- RESTRICT [- RESTRICT [...]]] SPLIT): If the message
418
  field FIELD (a regexp) contains VALUE (a regexp), store the messages
419
  as specified by SPLIT.  If RESTRICT (a regexp) matches some string
Pavel Janík's avatar
Pavel Janík committed
420
  after FIELD and before the end of the matched VALUE, return nil,
421 422
  otherwise process SPLIT.  Multiple RESTRICTs add up, further
  restricting the possibility of processing SPLIT.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
423 424 425 426 427 428 429 430 431 432 433

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

434 435 436 437
\(! FUNCTION SPLIT): Call FUNCTION with the result of SPLIT.  The
  return value FUNCTION should be a split, which is then recursively
  processed.

438 439 440
junk: Mail will be deleted.  Use with care!  Do not submerge in water!
  Example:
  (setq nnmail-split-fancy
Paul Eggert's avatar
Paul Eggert committed
441
	\\='(| (\"Subject\" \"MAKE MONEY FAST\" junk)
442 443
	    ...other.rules.omitted...))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
444 445 446 447
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.

448
FIELD and VALUE can also be Lisp symbols, in that case they are expanded
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
449 450 451 452 453 454 455
as specified in `nnmail-split-abbrev-alist'.

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

Example:

456
\(setq nnmail-split-methods \\='nnmail-split-fancy
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
457 458 459 460
      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.
461
      \\='(| (\"from\" mail (| (\"subject\" \"warn.*\" \"mail.warning\")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
462 463 464 465 466 467 468 469 470
			  \"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\")
471 472 473 474 475 476 477
	     ;; 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
478 479 480 481 482
	     ;; People...
	     (any \"larsi@ifi\\\\.uio\\\\.no\" \"people.Lars Magne Ingebrigtsen\"))
	  ;; Unmatched mail goes to the catch all group.
	  \"misc.misc\"))"
  :group 'nnmail-split
483
  :type 'nnmail-split-fancy)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
484 485 486 487 488

(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")
489 490 491
    (from . "from\\|sender\\|resent-from")
    (nato . "to\\|cc\\|resent-to\\|resent-cc")
    (naany . "from\\|to\\|cc\\|sender\\|resent-from\\|resent-to\\|resent-cc"))
492
  "Alist of abbreviations allowed in `nnmail-split-fancy'."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
493 494 495 496
  :group 'nnmail-split
  :type '(repeat (cons :format "%v" symbol regexp)))

(defcustom nnmail-message-id-cache-length 1000
497
  "The approximate number of Message-IDs nnmail will keep in its cache.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
498 499 500 501 502 503
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
504 505 506
(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
507 508 509 510 511
  :group 'nnmail-duplicate
  :group 'nnmail-files
  :type 'file)

(defcustom nnmail-treat-duplicates 'warn
512
  "If non-nil, nnmail keep a cache of Message-IDs to discover mail duplicates.
513
Three values are valid: nil, which means that nnmail is not to keep a
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
514 515 516 517 518 519 520 521 522 523 524 525
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)))

526
(defcustom nnmail-extra-headers '(To Newsgroups Cc)
527 528 529
  "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."
530
  :version "24.3"
531 532 533
  :group 'nnmail
  :type '(repeat symbol))

534
(defcustom nnmail-split-header-length-limit 2048
535
  "Header lines longer than this limit are excluded from the split function."
Dave Love's avatar
Dave Love committed
536
  :version "21.1"
537 538 539
  :group 'nnmail
  :type 'integer)

540 541
(defcustom nnmail-mail-splitting-charset nil
  "Default charset to be used when splitting incoming mail."
542
  :version "22.1"
543 544 545 546 547
  :group 'nnmail
  :type 'symbol)

(defcustom nnmail-mail-splitting-decodes nil
  "Whether the nnmail splitting functionality should MIME decode headers."
548
  :version "22.1"
549 550 551 552 553 554 555 556 557
  :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."
558
  :version "22.1"
559 560 561 562 563 564 565
  :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)."
566
  :version "22.1"
567 568 569
  :group 'nnmail
  :type 'boolean)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
570 571
;;; Internal variables.

572 573 574
(defvar nnmail-article-buffer " *nnmail incoming*"
  "The buffer used for splitting incoming mails.")

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

578 579 580 581 582
(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
583 584 585 586 587
  "Syntax table used by `nnmail-split-fancy'.")

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

588 589
(defvar nnmail-split-tracing nil)
(defvar nnmail-split-trace nil)
590
(defvar nnmail-inhibit-default-split-group nil)
591

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
592 593 594 595 596


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

597 598 599
(defvar nnmail-file-coding-system 'raw-text
  "Coding system used in nnmail.")

600 601 602 603
(defvar nnmail-incoming-coding-system
  mm-text-coding-system
  "Coding system used in reading inbox")

604 605 606 607
(defcustom nnmail-pathname-coding-system nil
  "Coding system for file name."
  :group 'nnmail-various
  :type 'coding-system)
608

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
609 610 611
(defun nnmail-find-file (file)
  "Insert FILE in server buffer safely."
  (set-buffer nntp-server-buffer)
612
  (delete-region (point-min) (point-max))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
613
  (let ((format-alist nil)
614
	(after-insert-file-functions nil))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
615
    (condition-case ()
616
	(let ((coding-system-for-read nnmail-file-coding-system)
617 618
	      (auto-mode-alist (mm-auto-mode-alist))
	      (file-name-coding-system nnmail-pathname-coding-system))
619 620
	  (insert-file-contents file)
	  t)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
621 622 623
      (file-error nil))))

(defun nnmail-group-pathname (group dir &optional file)
624
  "Make file name for GROUP."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
625 626
  (concat
   (let ((dir (file-name-as-directory (expand-file-name dir))))
627 628 629
     (setq group (nnheader-replace-duplicate-chars-in-string
		  (nnheader-replace-chars-in-string group ?/ ?_)
		  ?. ?_))
630
     (setq group (nnheader-translate-file-chars group))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
631
     ;; If this directory exists, we use it directly.
632 633 634 635 636 637
     (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
638
	 (nnheader-replace-chars-in-string group ?. ?/)
639
	 dir))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
640 641 642 643 644
   (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."
645
  ;; Go through all groups from the active list.
646
  (with-current-buffer nntp-server-buffer
647 648 649 650 651 652 653 654 655 656 657 658 659 660 661
    (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
662
	    (narrow-to-region (point) (point-at-eol))
663 664 665
	    (setq group (read buffer))
	    (unless (stringp group)
	      (setq group (symbol-name group)))
666 667
	    (if (and (numberp (setq max (read buffer)))
		     (numberp (setq min (read buffer))))
668
		(push (list (string-as-unibyte group) (cons min max))
669 670 671 672
		      group-assoc)))
	(error nil))
      (widen)
      (forward-line 1))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
673 674
    group-assoc))

675 676 677 678
(defcustom nnmail-active-file-coding-system 'raw-text
  "Coding system for active file."
  :group 'nnmail-various
  :type 'coding-system)
679

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
680 681
(defun nnmail-save-active (group-assoc file-name)
  "Save GROUP-ASSOC in ACTIVE-FILE."
682 683
  (let ((coding-system-for-write nnmail-active-file-coding-system))
    (when file-name
684
      (with-temp-file file-name
Miles Bader's avatar
Miles Bader committed
685
	(mm-disable-multibyte)
686
	(nnmail-generate-active group-assoc)))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
687 688 689 690 691 692

(defun nnmail-generate-active (alist)
  "Generate an active file from group-alist ALIST."
  (erase-buffer)
  (let (group)
    (while (setq group (pop alist))
693 694 695 696 697
      (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
698

699
(defun nnmail-get-split-group (file source)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
700
  "Find out whether this FILE is to be split into GROUP only.
701 702 703 704 705 706 707 708
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
709 710 711

(defun nnmail-process-babyl-mail-format (func artnum-func)
  (let ((case-fold-search t)
712
	(count 0)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
713 714
	start message-id content-length do-search end)
    (while (not (eobp))
715
      (goto-char (point-min))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
      (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)
752
		      (setq content-length (string-to-number
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
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
					    (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)
784
	  (incf count)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
785
	  (setq end (point-max))))
786 787
      (goto-char end))
    count))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
788 789 790

(defsubst nnmail-search-unix-mail-delim ()
  "Put point at the beginning of the next Unix mbox message."
Juanma Barranquero's avatar
Juanma Barranquero committed
791
  ;; Algorithm used to find the next article in the
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
  ;; 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)
808
			   (eq (char-after) ?\n)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
809 810
		     (save-excursion
		       (forward-line 1)
811
		       (while (looking-at ">From \\|From ")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
812 813 814 815 816 817 818 819
			 (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
820
  ;; Algorithm used to find the next article in the
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836
  ;; 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)
837
			   (eq (char-after) ?\n)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
838 839
		     (save-excursion
		       (forward-line 1)
840
		       (while (looking-at ">From \\|From ")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
841 842 843 844 845 846 847 848
			 (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)
849
	(count 0)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
850 851 852 853 854
	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?
855 856 857
	(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
858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
      ;; 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)
889
	  (setq content-length (string-to-number (match-string 1)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
890 891 892 893 894 895 896 897 898 899 900 901
	  ;; 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
902
	;; message body.  This should be either the end of the buffer, the
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929
	;; 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))
930
	    (incf count)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
931 932
	    (nnmail-check-duplication message-id func artnum-func)
	    (setq end (point-max))))
933 934
	(goto-char end)))
    count))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
935

936
(defun nnmail-process-mmdf-mail-format (func artnum-func &optional junk-func)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
937 938
  (let ((delim "^\^A\^A\^A\^A$")
	(case-fold-search t)
939
	(count 0)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
940 941 942 943 944
	start message-id end)
    (goto-char (point-min))
    (if (not (and (re-search-forward delim nil t)
		  (forward-line 1)))
	;; Possibly wrong format?
945
	(error "Error, unknown mail format! (Possibly corrupted.)")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982
      ;; 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))
983
	    (incf count)
984
	    (nnmail-check-duplication message-id func artnum-func junk-func)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
985 986
	    (setq end (point-max))))
	(goto-char end)
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 1018 1019 1020 1021 1022 1023
	(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
1024

1025 1026 1027
(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
1028
(defun nnmail-split-incoming (incoming func &optional exit-func
1029
				       group artnum-func junk-func)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1030
  "Go through the entire INCOMING file and pick out each individual mail.
1031 1032 1033
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."
1034
  (let ( ;; If this is a group-specific split, we bind the split
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1035 1036 1037 1038
	;; methods to just this group.
	(nnmail-split-methods (if (and group
				       (not nnmail-resplit-incoming))
				  (list (list group ""))
1039 1040
				nnmail-split-methods))
	(nnmail-group-names-not-encoded-p t))
1041 1042
    ;; Insert the incoming file.
    (with-current-buffer (get-buffer-create nnmail-article-buffer)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1043
      (erase-buffer)
1044 1045 1046 1047
      (if (bufferp incoming)
	  (insert-buffer-substring incoming)
	(let ((coding-system-for-read nnmail-incoming-coding-system))
	  (mm-insert-file-contents incoming)))
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
      (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")
1060 1061
		   (nnmail-process-mmdf-mail-format
		    func artnum-func junk-func))
1062 1063 1064 1065 1066 1067 1068
		  ((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
1069

1070
(defun nnmail-article-group (func &optional trace junk-func)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1071 1072
  "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."
1073
  (let ((methods (or nnmail-split-methods '(("bogus" ""))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1074
	(obuf (current-buffer))
1075
	group-art method grp)
1076
    (if (and (sequencep methods)
1077 1078
	     (= (length methods) 1)
	     (not nnmail-inhibit-default-split-group))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1079 1080 1081 1082 1083
	;; 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.
1084 1085
      ;; Copy the article into the work buffer.
      (with-current-buffer nntp-server-buffer
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1086
	(erase-buffer)
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
	(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
1099 1100 1101 1102
	;; Fold continuation lines.
	(goto-char (point-min))
	(while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
	  (replace-match " " t t))
1103 1104 1105 1106 1107 1108
	;; 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))
1109 1110
	  (unless (< (move-to-column nnmail-split-header-length-limit)
		     nnmail-split-header-length-limit)
1111
	    (delete-region (point) (point-at-eol)))
1112
	  (forward-line 1))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1113
	;; Allow washing.
1114
	(goto-char (point-min))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1115
	(run-hooks 'nnmail-split-hook)
1116 1117
	(when (setq nnmail-split-tracing trace)
	  (setq nnmail-split-trace nil))
1118 1119
	(if (or (and (symbolp nnmail-split-methods)
		     (fboundp nnmail-split-methods))
1120
		(not (consp (car-safe nnmail-split-methods)))
1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
		(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")))))
1146
	      (setq split (delete-dups split))
1147 1148 1149
	      ;; The article may be "cross-posted" to `junk'.  What
	      ;; to do?  Just remove the `junk' spec.  Don't really
	      ;; see anything else to do...
1150 1151 1152 1153
	      (when (and (memq 'junk split)
			 junk-func)
		(funcall junk-func 'junk))
	      (setq split (delq 'junk split))
1154
	      (when split
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1155 1156 1157 1158 1159
		(setq group-art
		      (mapcar
		       (lambda (group) (cons group (funcall func group)))
		       split))))
	  ;; Go through the split methods to find a match.
1160 1161 1162
	  (while (and methods
		      (or nnmail-crosspost
			  (not group-art)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1163
	    (goto-char (point-max))
1164
	    (setq method (pop methods)
1165
		  grp (car method))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1166 1167 1168 1169 1170
	    (if (or methods
		    (not (equal "" (nth 1 method))))
		(when (and
		       (ignore-errors
			 (if (stringp (nth 1 method))
1171 1172 1173 1174 1175 1176
			     (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
1177
			   ;; Function to say whether this is a match.
1178
			   (funcall (nth 1 method) grp)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1179 1180
		       ;; Don't enter the article into the same
		       ;; group twice.
1181 1182
		       (not (assoc grp group-art)))
		  (push (cons grp (funcall func grp))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1183 1184 1185
			group-art))
	      ;; This is the final group, which is used as a
	      ;; catch-all.
1186
	      (when (and (not group-art)
1187 1188
			 (or (equal "" (nth 1 method))
			     (not nnmail-inhibit-default-split-group)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1189 1190
		(setq group-art
		      (list (cons (car method)
1191 1192
				  (funcall func (car method))))))))
	  ;; Fall back on "bogus" if all else fails.
1193 1194
	  (when (and (not group-art)
		     (not nnmail-inhibit-default-split-group))
1195
	    (setq group-art (list (cons "bogus" (funcall func "bogus"))))))
1196 1197
	;; Produce a trace if non-empty.
	(when (and trace nnmail-split-trace)
1198
	  (let ((restore (current-buffer)))
1199 1200
	    (nnheader-set-temp-buffer "*Split Trace*")
	    (gnus-add-buffer)
1201 1202 1203
	    (dolist (trace (nreverse nnmail-split-trace))
	      (prin1 trace (current-buffer))
	      (insert "\n"))
1204 1205 1206
	    (goto-char (point-min))
	    (gnus-configure-windows 'split-trace)
	    (set-buffer restore)))
1207
	(widen)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1208 1209 1210
	;; See whether the split methods returned `junk'.
	(if (equal group-art '(junk))
	    nil
1211 1212 1213 1214 1215 1216 1217
	  ;; 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
1218 1219 1220 1221 1222 1223 1224

(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))
1225
      (unless (search-forward "\n\n" nil t)
1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
	(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