rmail.el 102 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1 2
;;; rmail.el --- main code of "RMAIL" mail reader for Emacs.

Richard M. Stallman's avatar
Richard M. Stallman committed
3
;; Copyright (C) 1985,86,87,88,93,94,95,96 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

Eric S. Raymond's avatar
Eric S. Raymond committed
5
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Keywords: mail
Eric S. Raymond's avatar
Eric S. Raymond committed
7

Roland McGrath's avatar
Roland McGrath committed
8 9 10 11
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Eric S. Raymond's avatar
Eric S. Raymond committed
12
;; the Free Software Foundation; either version 2, or (at your option)
Roland McGrath's avatar
Roland McGrath committed
13 14 15 16 17 18 19 20
;; any later version.

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

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
21 22 23
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Roland McGrath's avatar
Roland McGrath committed
24

Eric S. Raymond's avatar
Eric S. Raymond committed
25
;;; Code:
Roland McGrath's avatar
Roland McGrath committed
26 27 28 29 30 31

;; Souped up by shane@mit-ajax based on ideas of rlk@athena.mit.edu
;;   New features include attribute and keyword support, message
;;   selection by dispatch table, summary by attributes and keywords,
;;   expunging by dispatch table, sticky options for file commands.

32 33 34 35 36 37 38
;; Extended by Bob Weiner of Motorola
;;   New features include: rmail and rmail-summary buffers remain
;;   synchronized and key bindings basically operate the same way in both
;;   buffers, summary by topic or by regular expression, rmail-reply-prefix
;;   variable, and a bury rmail buffer (wipe) command.
;;

Roland McGrath's avatar
Roland McGrath committed
39
(require 'mail-utils)
40 41 42 43

;; For Emacs V18 compatibility
(and (not (fboundp 'buffer-disable-undo))
     (fboundp 'buffer-flush-undo)
44
     (defalias 'buffer-disable-undo 'buffer-flush-undo))
45 46

; These variables now declared in paths.el.
Roland McGrath's avatar
Roland McGrath committed
47 48
;(defvar rmail-spool-directory "/usr/spool/mail/"
;  "This is the name of the directory used by the system mailer for\n\
49
;delivering new mail.  Its name should end with a slash.")
Roland McGrath's avatar
Roland McGrath committed
50 51 52 53
;(defvar rmail-file-name
;  (expand-file-name "~/RMAIL")
;  "")

54 55 56
(defvar rmail-movemail-program nil
  "If non-nil, name of program for fetching new mail.")

57 58 59 60 61 62
(defvar rmail-pop-password nil
  "*Password to use when reading mail from a POP server, if required.")

(defvar rmail-pop-password-required nil
  "*Non-nil if a password is required when reading mail using POP.")

63 64 65 66
(defvar rmail-preserve-inbox nil
  "*Non-nil if incoming mail should be left in the user's inbox,
rather than deleted, after it is retrieved.")

Roland McGrath's avatar
Roland McGrath committed
67 68 69
;;;###autoload
(defvar rmail-dont-reply-to-names nil "\
*A regexp specifying names to prune of reply to messages.
Richard M. Stallman's avatar
Richard M. Stallman committed
70
A value of nil means exclude your own name only.")
Roland McGrath's avatar
Roland McGrath committed
71 72 73 74 75 76 77

;;;###autoload
(defvar rmail-default-dont-reply-to-names "info-" "\
A regular expression specifying part of the value of the default value of
the variable `rmail-dont-reply-to-names', for when the user does not set
`rmail-dont-reply-to-names' explicitly.  (The other part of the default
value is the user's name.)
Richard M. Stallman's avatar
Richard M. Stallman committed
78
It is useful to set this variable in the site customization file.")
Roland McGrath's avatar
Roland McGrath committed
79 80

;;;###autoload
81
(defvar rmail-ignored-headers "^via:\\|^mail-from:\\|^origin:\\|^status:\\|^received:\\|^x400-originator:\\|^x400-recipients:\\|^x400-received:\\|^x400-mts-identifier:\\|^x400-content-type:\\|^\\(resent-\\|\\)message-id:\\|^summary-line:\\|^resent-date:\\|^nntp-posting-host:\\|^path:\\|^x-char.*:\\|^x-face:\\|^x-mailer:\\|^delivered-to:"
82
  "*Regexp to match header fields that Rmail should normally hide.")
Roland McGrath's avatar
Roland McGrath committed
83

84 85 86 87 88 89
;;;###autoload
(defvar rmail-displayed-headers nil
  "*Regexp to match Header fields that Rmail should display.
If nil, display all header fields except those matched by
`rmail-ignored-headers'.")

90 91 92 93
;;;###autoload
(defvar rmail-retry-ignored-headers nil "\
*Headers that should be stripped when retrying a failed message.")

94 95
;;;###autoload
(defvar rmail-highlighted-headers "^From:\\|^Subject:" "\
96
*Regexp to match Header fields that Rmail should normally highlight.
97 98
A value of nil means don't highlight.
See also `rmail-highlight-face'.")
99

100 101 102 103
;;;###autoload
(defvar rmail-highlight-face nil "\
*Face used by Rmail for highlighting headers.")

Roland McGrath's avatar
Roland McGrath committed
104 105 106 107 108
;;;###autoload
(defvar rmail-delete-after-output nil "\
*Non-nil means automatically delete a message that is copied to a file.")

;;;###autoload
109
(defvar rmail-primary-inbox-list nil "\
110 111 112
*List of files which are inboxes for user's primary mail file `~/RMAIL'.
`nil' means the default, which is (\"/usr/spool/mail/$USER\")
\(the name varies depending on the operating system,
Roland McGrath's avatar
Roland McGrath committed
113 114
and the value of the environment variable MAIL overrides it).")

115 116 117 118
;;;###autoload
(defvar rmail-mail-new-frame nil
  "*Non-nil means Rmail makes a new frame for composing outgoing mail.")

119 120 121 122 123 124 125
;;;###autoload
(defvar rmail-secondary-file-directory "~/"
  "*Directory for additional secondary Rmail files.")
;;;###autoload
(defvar rmail-secondary-file-regexp "\\.xmail$"
  "*Regexp for which files are secondary Rmail files.")

126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
;;;###autoload
(defvar rmail-mode-hook nil
  "List of functions to call when Rmail is invoked.")

;;;###autoload
(defvar rmail-get-new-mail-hook nil
  "List of functions to call when Rmail has retrieved new mail.")

;;;###autoload
(defvar rmail-show-message-hook nil
  "List of functions to call when Rmail displays a message.")

;;;###autoload
(defvar rmail-delete-message-hook nil
  "List of functions to call when Rmail deletes a message.
When the hooks are called, the message has been marked deleted but is
still the current message in the Rmail buffer.")

144 145 146
;; These may be altered by site-init.el to match the format of mmdf files
;;  delimiting used on a given host (delim1 and delim2 from the config
;;  files).
Roland McGrath's avatar
Roland McGrath committed
147 148 149 150 151 152 153

(defvar mmdf-delim1 "^\001\001\001\001\n"
  "Regexp marking the start of an mmdf message")
(defvar mmdf-delim2 "^\001\001\001\001\n"
  "Regexp marking the end of an mmdf message")

(defvar rmail-message-filter nil
154 155 156
  "If non-nil, a filter function for new messages in RMAIL.
Called with region narrowed to the message, including headers,
before obeying `rmail-ignored-headers'.")
Roland McGrath's avatar
Roland McGrath committed
157

158 159 160
(defvar rmail-reply-prefix "Re: "
  "String to prepend to Subject line when replying to a message.")

161
;; Some mailers use "Re(2):" or "Re^2:" or "Re: Re:" or "Re[2]:".
Karl Heuer's avatar
Karl Heuer committed
162
;; This pattern should catch all the common variants.
163
(defvar rmail-reply-regexp "\\`\\(Re\\(([0-9]+)\\|\\[[0-9]+\\]\\|\\^[0-9]+\\)?: *\\)*"
164
  "Regexp to delete from Subject line before inserting `rmail-reply-prefix'.")
Karl Heuer's avatar
Karl Heuer committed
165

166
(defvar rmail-display-summary nil
167
  "If non-nil, Rmail always displays the summary buffer.")
168

Roland McGrath's avatar
Roland McGrath committed
169 170 171 172 173 174 175 176 177 178 179 180
(defvar rmail-mode-map nil)

(defvar rmail-inbox-list nil)
(defvar rmail-keywords nil)

;; Message counters and markers.  Deleted flags.

(defvar rmail-current-message nil)
(defvar rmail-total-messages nil)
(defvar rmail-message-vector nil)
(defvar rmail-deleted-vector nil)

181 182
(defvar rmail-overlay-list nil)

183
(defvar rmail-font-lock-keywords
184
  (eval-when-compile
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
    (let* ((cite-chars "[>|}]")
	   (cite-prefix "A-Za-z")
	   (cite-suffix (concat cite-prefix "0-9_.@-`'\"")))
      (list '("^\\(From\\|Sender\\):" . font-lock-function-name-face)
	    '("^Reply-To:.*$" . font-lock-function-name-face)
	    '("^Subject:" . font-lock-comment-face)
	    '("^\\(To\\|Apparently-To\\|Cc\\):" . font-lock-keyword-face)
	    ;; Use MATCH-ANCHORED to effectively anchor the regexp left side.
	    `(,cite-chars
	      (,(concat "\\=[ \t]*"
			"\\([" cite-prefix "]+[" cite-suffix "]*\\)?"
			cite-chars ".*")
	       (beginning-of-line) (end-of-line)
	       (0 font-lock-reference-face)))       
	    '("^\\(X-[A-Za-z0-9-]+\\|In-reply-to\\|Date\\):.*$"
	      . font-lock-string-face))))
201 202
  "Additional expressions to highlight in Rmail mode.")

Roland McGrath's avatar
Roland McGrath committed
203 204 205 206 207 208 209 210 211
;; These are used by autoloaded rmail-summary.

(defvar rmail-summary-buffer nil)
(defvar rmail-summary-vector nil)

;; `Sticky' default variables.

;; Last individual label specified to a or k.
(defvar rmail-last-label nil)
212
;; Last set of values specified to C-M-n, C-M-p, C-M-s or C-M-l.
Roland McGrath's avatar
Roland McGrath committed
213
(defvar rmail-last-multi-labels nil)
214
(defvar rmail-last-regexp nil)
215
(defvar rmail-default-file "~/xmail"
216
  "*Default file name for \\[rmail-output].")
217
(defvar rmail-default-rmail-file "~/XMAIL"
218
  "*Default file name for \\[rmail-output-to-rmail-file].")
Jim Blandy's avatar
Jim Blandy committed
219

Jim Blandy's avatar
Jim Blandy committed
220 221 222 223
;;; Regexp matching the delimiter of messages in UNIX mail format
;;; (UNIX From lines), minus the initial ^.  Note that if you change
;;; this expression, you must change the code in rmail-nuke-pinhead-header
;;; that knows the exact ordering of the \\( \\) subexpressions.
Jim Blandy's avatar
Jim Blandy committed
224
(defvar rmail-unix-mail-delimiter
Jim Blandy's avatar
Jim Blandy committed
225
  (let ((time-zone-regexp
226
	 (concat "\\([A-Z]?[A-Z]?[A-Z][A-Z]\\( DST\\)?"
Jim Blandy's avatar
Jim Blandy committed
227 228 229 230 231 232
		 "\\|[-+]?[0-9][0-9][0-9][0-9]"
		 "\\|"
		 "\\) *")))
    (concat
     "From "

233 234 235 236 237 238 239 240 241 242 243
     ;; Many things can happen to an RFC 822 mailbox before it is put into
     ;; a `From' line.  The leading phrase can be stripped, e.g.
     ;; `Joe <@w.x:joe@y.z>' -> `<@w.x:joe@y.z>'.  The <> can be stripped, e.g.
     ;; `<@x.y:joe@y.z>' -> `@x.y:joe@y.z'.  Everything starting with a CRLF
     ;; can be removed, e.g.
     ;;		From: joe@y.z (Joe	K
     ;;			User)
     ;; can yield `From joe@y.z (Joe 	K Fri Mar 22 08:11:15 1996', and
     ;;		From: Joe User
     ;;			<joe@y.z>
     ;; can yield `From Joe User Fri Mar 22 08:11:15 1996'.
244 245 246 247 248
     ;; The mailbox can be removed or be replaced by white space, e.g.
     ;;		From: "Joe User"{space}{tab}
     ;;			<joe@y.z>
     ;; can yield `From {space}{tab} Fri Mar 22 08:11:15 1996',
     ;; where {space} and {tab} represent the Ascii space and tab characters.
249 250 251
     ;; We want to match the results of any of these manglings.
     ;; The following regexp rejects names whose first characters are
     ;; obviously bogus, but after that anything goes.
252
     "\\([^\0-\b\n-\r\^?].*\\)? "
Jim Blandy's avatar
Jim Blandy committed
253 254

     ;; The time the message was sent.
255 256 257 258
     "\\([^\0-\r \^?]+\\) +"				; day of the week
     "\\([^\0-\r \^?]+\\) +"				; month
     "\\([0-3]?[0-9]\\) +"				; day of month
     "\\([0-2][0-9]:[0-5][0-9]\\(:[0-6][0-9]\\)?\\) *"	; time of day
Jim Blandy's avatar
Jim Blandy committed
259 260 261 262 263 264

     ;; Perhaps a time zone, specified by an abbreviation, or by a
     ;; numeric offset.
     time-zone-regexp

     ;; The year.
265
     " \\([0-9][0-9]+\\) *"
Jim Blandy's avatar
Jim Blandy committed
266 267 268 269

     ;; On some systems the time zone can appear after the year, too.
     time-zone-regexp

Karl Heuer's avatar
Karl Heuer committed
270 271
     ;; Old uucp cruft.
     "\\(remote from .*\\)?"
Jim Blandy's avatar
Jim Blandy committed
272 273 274 275

     "\n"))
  nil)

276 277 278
;; Perform BODY in the summary buffer
;; in such a way that its cursor is properly updated in its own window.
(defmacro rmail-select-summary (&rest body)
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
  (` (let ((total rmail-total-messages))
       (if (rmail-summary-displayed)
	   (let ((window (selected-window)))
	     (save-excursion
	       (unwind-protect
		   (progn
		     (pop-to-buffer rmail-summary-buffer)
		     ;; rmail-total-messages is a buffer-local var
		     ;; in the rmail buffer.
		     ;; This way we make it available for the body
		     ;; even tho the rmail buffer is not current.
		     (let ((rmail-total-messages total))
		       (,@ body)))
		 (select-window window))))
	 (save-excursion
	   (set-buffer rmail-summary-buffer)
	   (let ((rmail-total-messages total))
	     (,@ body))))
       (rmail-maybe-display-summary))))
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326

(defvar rmail-view-buffer nil
  "Buffer which holds RMAIL message for displaying.")

;; Mule and MIME related variables.

;;;###autoload
(defvar rmail-file-coding-system nil
  "Coding system used in RMAIL file.

This is set to nil by default.")

;;;###autoload
(defvar rmail-enable-mime nil
  "*If non-nil, RMAIL uses MIME feature.
If the value is t, RMAIL automatically shows MIME decoded message.
If the value is neither t nor nil, RMAIL does not show MIME decoded message
until a user explicitly require it.")

;;;###autoload
(defvar rmail-show-mime-function nil
  "Function to show MIME decoded message of RMAIL file.")

;;;###autoload
(defvar rmail-mime-feature 'rmail-mime
  "Feature to provide for using MIME feature in RMAIL.
When starting rmail, this feature is requrired if rmail-enable-mime
is non-nil.")

Roland McGrath's avatar
Roland McGrath committed
327 328 329 330 331 332

;;;; *** Rmail Mode ***

;;;###autoload
(defun rmail (&optional file-name-arg)
  "Read and edit incoming mail.
333
Moves messages into file named by `rmail-file-name' (a babyl format file)
Roland McGrath's avatar
Roland McGrath committed
334 335 336
 and edits that file in RMAIL Mode.
Type \\[describe-mode] once editing that file, for a list of RMAIL commands.

337 338 339
May be called with file name as argument; then performs rmail editing on
that file, but does not copy any new mail into the file.
Interactively, if you supply a prefix argument, then you
340 341 342
have a chance to specify a file name with the minibuffer.

If `rmail-display-summary' is non-nil, make a summary for this RMAIL file."
Roland McGrath's avatar
Roland McGrath committed
343
  (interactive (if current-prefix-arg
344
		   (list (read-file-name "Run rmail on RMAIL file: "))))
345 346 347 348 349 350
  (if rmail-enable-mime
      (condition-case err
	  (require rmail-mime-feature)
	(error (message "Feature `%s' not provided" rmail-mime-feature)
	       (sit-for 1)
	       (setq rmail-enable-mime nil))))
Roland McGrath's avatar
Roland McGrath committed
351
  (let* ((file-name (expand-file-name (or file-name-arg rmail-file-name)))
352
	 (existed (get-file-buffer file-name))
353
	 (coding-system-for-read 'no-conversion)
354
	 run-mail-hook)
Roland McGrath's avatar
Roland McGrath committed
355 356 357 358 359 360
    ;; Like find-file, but in the case where a buffer existed
    ;; and the file was reverted, recompute the message-data.
    (if (and existed (not (verify-visited-file-modtime existed)))
	(progn
	  ;; Don't be confused by apparent local-variables spec
	  ;; in the last message in the RMAIL file.
361
	  (let ((enable-local-variables nil))
Roland McGrath's avatar
Roland McGrath committed
362
	    (find-file file-name))
363 364
	  (if (and (verify-visited-file-modtime existed)
		   (eq major-mode 'rmail-mode))
Roland McGrath's avatar
Roland McGrath committed
365 366
	      (progn (rmail-forget-messages)
		     (rmail-set-message-counters))))
367
      (let ((enable-local-variables nil))
Roland McGrath's avatar
Roland McGrath committed
368
	(find-file file-name)))
369 370
    (if (eq major-mode 'rmail-edit-mode)
	(error "Exit Rmail Edit mode before getting new mail."))
Roland McGrath's avatar
Roland McGrath committed
371 372 373
    (if (and existed (> (buffer-size) 0))
	;; Buffer not new and not empty; ensure in proper mode, but that's all.
	(or (eq major-mode 'rmail-mode)
374 375 376
	    (progn (rmail-mode-2)
		   (setq run-mail-hook t)))
      (setq run-mail-hook t)
Roland McGrath's avatar
Roland McGrath committed
377 378 379 380 381 382 383 384
      (rmail-mode-2)
      ;; Convert all or part to Babyl file if possible.
      (rmail-convert-file)
      (goto-char (point-max))
      (if (null rmail-inbox-list)
	  (progn
	    (rmail-set-message-counters)
	    (rmail-show-message))))
385 386 387
    (or (and (null file-name-arg)
	     (rmail-get-new-mail))
	(rmail-show-message (rmail-first-unseen-message)))
388
    (if rmail-display-summary (rmail-summary))
389 390 391
    (rmail-construct-io-menu)
    (if run-mail-hook
	(run-hooks 'rmail-mode-hook))))
Roland McGrath's avatar
Roland McGrath committed
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422

;; Given the value of MAILPATH, return a list of inbox file names.
;; This is turned off because it is not clear that the user wants
;; all these inboxes to feed into the primary rmail file.
; (defun rmail-convert-mailpath (string)
;   (let (idx list)
;     (while (setq idx (string-match "[%:]" string))
;       (let ((this (substring string 0 idx)))
; 	(setq string (substring string (1+ idx)))
; 	(setq list (cons (if (string-match "%" this)
; 			     (substring this 0 (string-match "%" this))
; 			   this)
; 			 list))))
;     list))

; I have checked that adding "-*- rmail -*-" to the BABYL OPTIONS line
; will not cause emacs 18.55 problems.

(defun rmail-convert-file ()
  (let (convert)
    (widen)
    (goto-char (point-min))
    ;; If file doesn't start like a Babyl file,
    ;; convert it to one, by adding a header and converting each message.
    (cond ((looking-at "BABYL OPTIONS:"))
	  ((looking-at "Version: 5\n")
	   ;; Losing babyl file made by old version of Rmail.
	   ;; Just fix the babyl file header; don't make a new one,
	   ;; so we don't lose the Labels: file attribute, etc.
	   (let ((buffer-read-only nil))
	     (insert "BABYL OPTIONS: -*- rmail -*-\n")))
423 424 425
	  ((equal (point-min) (point-max))
	   ;; Empty RMAIL file.  Just insert the header.
	   (rmail-insert-rmail-file-header))
Roland McGrath's avatar
Roland McGrath committed
426
	  (t
427
	   ;; Non-empty file in non-RMAIL format.  Add header and convert.
Roland McGrath's avatar
Roland McGrath committed
428 429
	   (setq convert t)
	   (rmail-insert-rmail-file-header)))
430 431 432 433 434 435 436
    (if (and (not convert)
	     (not rmail-enable-mime)
	     rmail-file-coding-system)
	;; Decode BABYL part at the headq only.  The remaining non
	;; BABYL parts are decode in rmail-convert-to-babyl-format if
	;; necessary..
	(rmail-decode-babyl-format))
Roland McGrath's avatar
Roland McGrath committed
437 438 439 440
    ;; If file was not a Babyl file or if there are
    ;; Unix format messages added at the end,
    ;; convert file as necessary.
    (if (or convert
441 442
	    (save-excursion
	      (goto-char (point-max))
443 444
	      (search-backward "\n\^_")
	      (forward-char 2)
445
	      (looking-at "\n*From ")))
Roland McGrath's avatar
Roland McGrath committed
446 447
	(let ((buffer-read-only nil))
	  (message "Converting to Babyl format...")
448 449 450 451 452
	  ;; If file needs conversion, convert it all,
	  ;; except for the BABYL header.
	  ;; (rmail-convert-to-babyl-format would delete the header.)
	  (goto-char (point-min))
	  (search-forward "\n\^_" nil t)
453
	  (narrow-to-region (point) (point-max))
Roland McGrath's avatar
Roland McGrath committed
454 455 456
	  (rmail-convert-to-babyl-format)
	  (message "Converting to Babyl format...done")))))

457 458
;;; I have checked that adding "-*- rmail -*-" to the BABYL OPTIONS line
;;; will not cause emacs 18.55 problems.
Roland McGrath's avatar
Roland McGrath committed
459 460 461 462 463 464 465 466 467 468

(defun rmail-insert-rmail-file-header ()
  (let ((buffer-read-only nil))
    (insert "BABYL OPTIONS: -*- rmail -*-
Version: 5
Labels:
Note:   This is the header of an rmail file.
Note:   If you are seeing it in rmail,
Note:    it means the file has no messages in it.\n\^_")))

469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
;; Decode Babyl formated part at the head of current buffer by
;; rmail-file-coding-system.

(defun rmail-decode-babyl-format ()
  (let ((modifiedp (buffer-modified-p))
	(buffer-read-only nil)
	pos)
    (goto-char (point-min))
    (search-forward "\n\^_" nil t)	; Skip BYBYL header.
    (setq pos (point))
    (message "Decoding messages...")
    (while (search-forward "\n\^_" nil t)
      (decode-coding-region pos (point) rmail-file-coding-system)
      (setq pos (point)))
    (message "Decoding messages...done")
    (set-buffer-file-coding-system rmail-file-coding-system)
    (set-buffer-modified-p modifiedp)))

Roland McGrath's avatar
Roland McGrath committed
487 488 489 490
(if rmail-mode-map
    nil
  (setq rmail-mode-map (make-keymap))
  (suppress-keymap rmail-mode-map)
491 492 493 494 495 496 497 498 499 500 501 502 503
  (define-key rmail-mode-map "a"      'rmail-add-label)
  (define-key rmail-mode-map "b"      'rmail-bury)
  (define-key rmail-mode-map "c"      'rmail-continue)
  (define-key rmail-mode-map "d"      'rmail-delete-forward)
  (define-key rmail-mode-map "\C-d"   'rmail-delete-backward)
  (define-key rmail-mode-map "e"      'rmail-edit-current-message)
  (define-key rmail-mode-map "f"      'rmail-forward)
  (define-key rmail-mode-map "g"      'rmail-get-new-mail)
  (define-key rmail-mode-map "h"      'rmail-summary)
  (define-key rmail-mode-map "i"      'rmail-input)
  (define-key rmail-mode-map "j"      'rmail-show-message)
  (define-key rmail-mode-map "k"      'rmail-kill-label)
  (define-key rmail-mode-map "l"      'rmail-summary-by-labels)
Roland McGrath's avatar
Roland McGrath committed
504 505 506 507
  (define-key rmail-mode-map "\e\C-h" 'rmail-summary)
  (define-key rmail-mode-map "\e\C-l" 'rmail-summary-by-labels)
  (define-key rmail-mode-map "\e\C-r" 'rmail-summary-by-recipients)
  (define-key rmail-mode-map "\e\C-s" 'rmail-summary-by-regexp)
508 509 510 511 512 513 514 515 516 517 518 519 520
  (define-key rmail-mode-map "\e\C-t" 'rmail-summary-by-topic)
  (define-key rmail-mode-map "m"      'rmail-mail)
  (define-key rmail-mode-map "\em"    'rmail-retry-failure)
  (define-key rmail-mode-map "n"      'rmail-next-undeleted-message)
  (define-key rmail-mode-map "\en"    'rmail-next-message)
  (define-key rmail-mode-map "\e\C-n" 'rmail-next-labeled-message)
  (define-key rmail-mode-map "o"      'rmail-output-to-rmail-file)
  (define-key rmail-mode-map "\C-o"   'rmail-output)
  (define-key rmail-mode-map "p"      'rmail-previous-undeleted-message)
  (define-key rmail-mode-map "\ep"    'rmail-previous-message)
  (define-key rmail-mode-map "\e\C-p" 'rmail-previous-labeled-message)
  (define-key rmail-mode-map "q"      'rmail-quit)
  (define-key rmail-mode-map "r"      'rmail-reply)
521
;; I find I can't live without the default M-r command -- rms.
522 523 524 525 526 527 528 529 530 531 532 533 534
;;  (define-key rmail-mode-map "\er"  'rmail-search-backwards)
  (define-key rmail-mode-map "s"      'rmail-expunge-and-save)
  (define-key rmail-mode-map "\es"    'rmail-search)
  (define-key rmail-mode-map "t"      'rmail-toggle-header)
  (define-key rmail-mode-map "u"      'rmail-undelete-previous-message)
  (define-key rmail-mode-map "w"      'rmail-edit-current-message)
  (define-key rmail-mode-map "x"      'rmail-expunge)
  (define-key rmail-mode-map "."      'rmail-beginning-of-message)
  (define-key rmail-mode-map "<"      'rmail-first-message)
  (define-key rmail-mode-map ">"      'rmail-last-message)
  (define-key rmail-mode-map " "      'scroll-up)
  (define-key rmail-mode-map "\177"   'scroll-down)
  (define-key rmail-mode-map "?"      'describe-mode)
535 536 537 538 539 540
  (define-key rmail-mode-map "\C-c\C-s\C-d" 'rmail-sort-by-date)
  (define-key rmail-mode-map "\C-c\C-s\C-s" 'rmail-sort-by-subject)
  (define-key rmail-mode-map "\C-c\C-s\C-a" 'rmail-sort-by-author)
  (define-key rmail-mode-map "\C-c\C-s\C-r" 'rmail-sort-by-recipient)
  (define-key rmail-mode-map "\C-c\C-s\C-c" 'rmail-sort-by-correspondent)
  (define-key rmail-mode-map "\C-c\C-s\C-l" 'rmail-sort-by-lines)
541
  (define-key rmail-mode-map "\C-c\C-s\C-k" 'rmail-sort-by-keywords)
542 543
  (define-key rmail-mode-map "\C-c\C-n" 'rmail-next-same-subject)
  (define-key rmail-mode-map "\C-c\C-p" 'rmail-previous-same-subject)
544
  )
545 546 547 548 549 550

(define-key rmail-mode-map [menu-bar] (make-sparse-keymap))

(define-key rmail-mode-map [menu-bar classify]
  (cons "Classify" (make-sparse-keymap "Classify")))

551
(define-key rmail-mode-map [menu-bar classify input-menu]
552
  nil)
553 554

(define-key rmail-mode-map [menu-bar classify output-menu]
555
  nil)
556

557
(define-key rmail-mode-map [menu-bar classify output-inbox]
558
  '("Output (inbox)..." . rmail-output))
559 560

(define-key rmail-mode-map [menu-bar classify output]
561
  '("Output (Rmail)..." . rmail-output-to-rmail-file))
562 563

(define-key rmail-mode-map [menu-bar classify kill-label]
564
  '("Kill Label..." . rmail-kill-label))
565 566

(define-key rmail-mode-map [menu-bar classify add-label]
567
  '("Add Label..." . rmail-add-label))
568 569 570 571

(define-key rmail-mode-map [menu-bar summary]
  (cons "Summary" (make-sparse-keymap "Summary")))

572 573 574
(define-key rmail-mode-map [menu-bar summary senders]
  '("By Senders..." . rmail-summary-by-senders))

575
(define-key rmail-mode-map [menu-bar summary labels]
576
  '("By Labels..." . rmail-summary-by-labels))
577 578

(define-key rmail-mode-map [menu-bar summary recipients]
579
  '("By Recipients..." . rmail-summary-by-recipients))
580 581

(define-key rmail-mode-map [menu-bar summary topic]
582
  '("By Topic..." . rmail-summary-by-topic))
583 584

(define-key rmail-mode-map [menu-bar summary regexp]
585
  '("By Regexp..." . rmail-summary-by-regexp))
586 587 588 589 590 591

(define-key rmail-mode-map [menu-bar summary all]
  '("All" . rmail-summary))

(define-key rmail-mode-map [menu-bar mail]
  (cons "Mail" (make-sparse-keymap "Mail")))
592

593
(define-key rmail-mode-map [menu-bar mail rmail-get-new-mail]
594 595 596
  '("Get New Mail" . rmail-get-new-mail))

(define-key rmail-mode-map [menu-bar mail lambda]
597
  '("----"))
598

599 600 601
(define-key rmail-mode-map [menu-bar mail continue]
  '("Continue" . rmail-continue))

602
(define-key rmail-mode-map [menu-bar mail resend]
603
  '("Re-send..." . rmail-resend))
604

605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621
(define-key rmail-mode-map [menu-bar mail forward]
  '("Forward" . rmail-forward))

(define-key rmail-mode-map [menu-bar mail retry]
  '("Retry" . rmail-retry-failure))

(define-key rmail-mode-map [menu-bar mail reply]
  '("Reply" . rmail-reply))

(define-key rmail-mode-map [menu-bar mail mail]
  '("Mail" . rmail-mail))

(define-key rmail-mode-map [menu-bar delete]
  (cons "Delete" (make-sparse-keymap "Delete")))

(define-key rmail-mode-map [menu-bar delete expunge/save]
  '("Expunge/Save" . rmail-expunge-and-save))
Roland McGrath's avatar
Roland McGrath committed
622

623 624 625 626 627 628 629 630 631 632 633 634 635
(define-key rmail-mode-map [menu-bar delete expunge]
  '("Expunge" . rmail-expunge))

(define-key rmail-mode-map [menu-bar delete undelete]
  '("Undelete" . rmail-undelete-previous-message))

(define-key rmail-mode-map [menu-bar delete delete]
  '("Delete" . rmail-delete-forward))

(define-key rmail-mode-map [menu-bar move]
  (cons "Move" (make-sparse-keymap "Move")))

(define-key rmail-mode-map [menu-bar move search-back]
636
  '("Search Back..." . rmail-search-backwards))
637 638

(define-key rmail-mode-map [menu-bar move search]
639
  '("Search..." . rmail-search))
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658

(define-key rmail-mode-map [menu-bar move previous]
  '("Previous Nondeleted" . rmail-previous-undeleted-message))

(define-key rmail-mode-map [menu-bar move next]
  '("Next Nondeleted" . rmail-next-undeleted-message))

(define-key rmail-mode-map [menu-bar move last]
  '("Last" . rmail-last-message))

(define-key rmail-mode-map [menu-bar move first]
  '("First" . rmail-first-message))

(define-key rmail-mode-map [menu-bar move previous]
  '("Previous" . rmail-previous-message))

(define-key rmail-mode-map [menu-bar move next]
  '("Next" . rmail-next-message))

Roland McGrath's avatar
Roland McGrath committed
659 660 661
;; Rmail mode is suitable only for specially formatted data.
(put 'rmail-mode 'mode-class 'special)

662 663 664
(defun rmail-mode-kill-summary ()
  (if rmail-summary-buffer (kill-buffer rmail-summary-buffer)))

665
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685
(defun rmail-mode ()
  "Rmail Mode is used by \\<rmail-mode-map>\\[rmail] for editing Rmail files.
All normal editing commands are turned off.
Instead, these commands are available:

\\[rmail-beginning-of-message]	Move point to front of this message (same as \\[beginning-of-buffer]).
\\[scroll-up]	Scroll to next screen of this message.
\\[scroll-down]	Scroll to previous screen of this message.
\\[rmail-next-undeleted-message]	Move to Next non-deleted message.
\\[rmail-previous-undeleted-message]	Move to Previous non-deleted message.
\\[rmail-next-message]	Move to Next message whether deleted or not.
\\[rmail-previous-message]	Move to Previous message whether deleted or not.
\\[rmail-first-message]	Move to the first message in Rmail file.
\\[rmail-last-message]	Move to the last message in Rmail file.
\\[rmail-show-message]	Jump to message specified by numeric position in file.
\\[rmail-search]	Search for string and show message it is found in.
\\[rmail-delete-forward]	Delete this message, move to next nondeleted.
\\[rmail-delete-backward]	Delete this message, move to previous nondeleted.
\\[rmail-undelete-previous-message]	Undelete message.  Tries current message, then earlier messages
	till a deleted message is found.
686
\\[rmail-edit-current-message]	Edit the current message.  \\[rmail-cease-edit] to return to Rmail.
Roland McGrath's avatar
Roland McGrath committed
687 688 689 690
\\[rmail-expunge]	Expunge deleted messages.
\\[rmail-expunge-and-save]	Expunge and save the file.
\\[rmail-quit]       Quit Rmail: expunge, save, then switch to another buffer.
\\[save-buffer] Save without expunging.
691
\\[rmail-get-new-mail]	Move new mail from system spool directory into this file.
Roland McGrath's avatar
Roland McGrath committed
692 693
\\[rmail-mail]	Mail a message (same as \\[mail-other-window]).
\\[rmail-continue]	Continue composing outgoing message started before.
694 695
\\[rmail-reply]	Reply to this message.  Like \\[rmail-mail] but initializes some fields.
\\[rmail-retry-failure]	Send this message again.  Used on a mailer failure message.
Roland McGrath's avatar
Roland McGrath committed
696 697 698 699 700 701 702 703 704
\\[rmail-forward]	Forward this message to another user.
\\[rmail-output-to-rmail-file]       Output this message to an Rmail file (append it).
\\[rmail-output]	Output this message to a Unix-format mail file (append it).
\\[rmail-input]	Input Rmail file.  Run Rmail on that file.
\\[rmail-add-label]	Add label to message.  It will be displayed in the mode line.
\\[rmail-kill-label]	Kill label.  Remove a label from current message.
\\[rmail-next-labeled-message]   Move to Next message with specified label
          (label defaults to last one specified).
          Standard labels: filed, unseen, answered, forwarded, deleted.
705
          Any other label is present only if you add it with \\[rmail-add-label].
Roland McGrath's avatar
Roland McGrath committed
706 707
\\[rmail-previous-labeled-message]   Move to Previous message with specified label
\\[rmail-summary]	Show headers buffer, with a one line summary of each message.
708 709 710 711 712
\\[rmail-summary-by-labels]	Summarize only messages with particular label(s).
\\[rmail-summary-by-recipients]   Summarize only messages with particular recipient(s).
\\[rmail-summary-by-regexp]   Summarize only messages with particular regexp(s).
\\[rmail-summary-by-topic]   Summarize only messages with subject line regexp(s).
\\[rmail-toggle-header]	Toggle display of complete header."
Roland McGrath's avatar
Roland McGrath committed
713 714 715
  (interactive)
  (rmail-mode-2)
  (rmail-set-message-counters)
716 717
  (rmail-show-message rmail-total-messages)
  (run-hooks 'rmail-mode-hook))
Roland McGrath's avatar
Roland McGrath committed
718 719 720 721

(defun rmail-mode-2 ()
  (kill-all-local-variables)
  (rmail-mode-1)
722
  (rmail-variables))
Roland McGrath's avatar
Roland McGrath committed
723 724 725 726 727

(defun rmail-mode-1 ()
  (setq major-mode 'rmail-mode)
  (setq mode-name "RMAIL")
  (setq buffer-read-only t)
Richard M. Stallman's avatar
Richard M. Stallman committed
728 729 730 731 732
  ;; No need to auto save RMAIL files in normal circumstances
  ;; because they contain no info except attribute changes
  ;; and deletion of messages.
  ;; The one exception is when messages are copied into an Rmail mode buffer.
  ;; rmail-output-to-rmail-file enables auto save when you do that.
Roland McGrath's avatar
Roland McGrath committed
733 734 735 736 737 738 739 740 741 742 743 744
  (setq buffer-auto-save-file-name nil)
  (if (boundp 'mode-line-modified)
      (setq mode-line-modified "--- ")
    (setq mode-line-format
	  (cons "--- " (cdr (default-value 'mode-line-format)))))
  (use-local-map rmail-mode-map)
  (set-syntax-table text-mode-syntax-table)
  (setq local-abbrev-table text-mode-abbrev-table))

(defun rmail-variables ()
  (make-local-variable 'revert-buffer-function)
  (setq revert-buffer-function 'rmail-revert)
745
  (make-local-variable 'font-lock-defaults)
746 747
  (setq font-lock-defaults
   '(rmail-font-lock-keywords t nil nil nil
748
     (font-lock-maximum-size . nil)
749 750 751
     (font-lock-fontify-buffer-function . rmail-fontify-buffer-function)
     (font-lock-unfontify-buffer-function . rmail-unfontify-buffer-function)
     (font-lock-inhibit-thing-lock . (lazy-lock-mode fast-lock-mode))))
Roland McGrath's avatar
Roland McGrath committed
752
  (make-local-variable 'rmail-last-label)
753
  (make-local-variable 'rmail-last-regexp)
Roland McGrath's avatar
Roland McGrath committed
754
  (make-local-variable 'rmail-deleted-vector)
755 756 757 758
  (make-local-variable 'rmail-buffer)
  (setq rmail-buffer (current-buffer))
  (make-local-variable 'rmail-view-buffer)
  (setq rmail-view-buffer rmail-buffer)
Roland McGrath's avatar
Roland McGrath committed
759 760 761 762 763 764
  (make-local-variable 'rmail-summary-buffer)
  (make-local-variable 'rmail-summary-vector)
  (make-local-variable 'rmail-current-message)
  (make-local-variable 'rmail-total-messages)
  (make-local-variable 'require-final-newline)
  (setq require-final-newline nil)
765 766
  (make-local-variable 'rmail-overlay-list)
  (setq rmail-overlay-list nil)
Roland McGrath's avatar
Roland McGrath committed
767 768
  (make-local-variable 'version-control)
  (setq version-control 'never)
769 770
  (make-local-variable 'kill-buffer-hook)
  (add-hook 'kill-buffer-hook 'rmail-mode-kill-summary)
Roland McGrath's avatar
Roland McGrath committed
771 772 773 774 775
  (make-local-variable 'file-precious-flag)
  (setq file-precious-flag t)
  (make-local-variable 'rmail-message-vector)
  (make-local-variable 'rmail-inbox-list)
  (setq rmail-inbox-list (rmail-parse-file-inboxes))
776 777
  ;; Provide default set of inboxes for primary mail file ~/RMAIL.
  (and (null rmail-inbox-list)
778
       (or (equal buffer-file-name (expand-file-name rmail-file-name))
779 780
	   (equal buffer-file-truename
		  (abbreviate-file-name (file-truename rmail-file-name))))
781 782 783 784
       (setq rmail-inbox-list
	     (or rmail-primary-inbox-list
		 (list (or (getenv "MAIL")
			   (concat rmail-spool-directory
785
				   (user-login-name)))))))
Roland McGrath's avatar
Roland McGrath committed
786 787
  (make-local-variable 'rmail-keywords)
  ;; this gets generated as needed
788
  (setq rmail-keywords nil))
Roland McGrath's avatar
Roland McGrath committed
789 790 791

;; Handle M-x revert-buffer done in an rmail-mode buffer.
(defun rmail-revert (arg noconfirm)
792
  (let ((revert-buffer-function (default-value 'revert-buffer-function)))
Roland McGrath's avatar
Roland McGrath committed
793 794 795 796 797 798 799
    ;; Call our caller again, but this time it does the default thing.
    (if (revert-buffer arg noconfirm)
	;; If the user said "yes", and we changed something,
	;; reparse the messages.
	(progn
	  (rmail-convert-file)
	  (goto-char (point-max))
800
	  (rmail-mode)))))
Roland McGrath's avatar
Roland McGrath committed
801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823

;; Return a list of files from this buffer's Mail: option.
;; Does not assume that messages have been parsed.
;; Just returns nil if buffer does not look like Babyl format.
(defun rmail-parse-file-inboxes ()
  (save-excursion
    (save-restriction
      (widen)
      (goto-char 1)
      (cond ((looking-at "BABYL OPTIONS:")
	     (search-forward "\n\^_" nil 'move)
	     (narrow-to-region 1 (point))
	     (goto-char 1)
	     (if (search-forward "\nMail:" nil t)
		 (progn
		   (narrow-to-region (point) (progn (end-of-line) (point)))
		   (goto-char (point-min))
		   (mail-parse-comma-list))))))))

(defun rmail-expunge-and-save ()
  "Expunge and save RMAIL file."
  (interactive)
  (rmail-expunge)
824 825 826
  (save-buffer)
  (if (rmail-summary-exists)
      (rmail-select-summary (set-buffer-modified-p nil))))
Roland McGrath's avatar
Roland McGrath committed
827 828 829 830 831 832 833

(defun rmail-quit ()
  "Quit out of RMAIL."
  (interactive)
  (rmail-expunge-and-save)
  ;; Don't switch to the summary buffer even if it was recently visible.
  (if rmail-summary-buffer
834 835 836
      (progn
	(replace-buffer-in-windows rmail-summary-buffer)
	(bury-buffer rmail-summary-buffer)))
Roland McGrath's avatar
Roland McGrath committed
837
  (let ((obuf (current-buffer)))
838
    (replace-buffer-in-windows obuf)
Roland McGrath's avatar
Roland McGrath committed
839 840
    (bury-buffer obuf)))

841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
(defun rmail-bury ()
  "Bury current Rmail buffer and its summary buffer."
  (interactive)
  ;; This let var was called rmail-buffer, but that interfered
  ;; with the buffer-local var used in summary buffers.
  (let ((buffer-to-bury (current-buffer)))
    (if (rmail-summary-exists)
	(let (window)
	  (while (setq window (get-buffer-window rmail-summary-buffer))
	    (set-window-buffer window (other-buffer rmail-summary-buffer)))
	  (bury-buffer rmail-summary-buffer)))
    (switch-to-buffer (other-buffer (current-buffer)))
    (bury-buffer buffer-to-bury)))

(defun rmail-duplicate-message ()
  "Create a duplicated copy of the current message.
The duplicate copy goes into the Rmail file just after the
original copy."
  (interactive)
  (widen)
  (let ((buffer-read-only nil)
	(number rmail-current-message)
	(string (buffer-substring (rmail-msgbeg rmail-current-message)
				  (rmail-msgend rmail-current-message))))
    (goto-char (rmail-msgend rmail-current-message))
    (insert string)
    (rmail-forget-messages)
    (rmail-show-message number)
    (message "Message duplicated")))

Roland McGrath's avatar
Roland McGrath committed
871 872
;;;###autoload
(defun rmail-input (filename)
873
  "Run Rmail on file FILENAME."
Roland McGrath's avatar
Roland McGrath committed
874 875 876
  (interactive "FRun rmail on RMAIL file: ")
  (rmail filename))

877 878 879 880 881

;; This used to scan subdirectories recursively, but someone pointed out
;; that if the user wants that, person can put all the files in one dir.
;; And the recursive scan was slow.  So I took it out.
;; rms, Sep 1996.
882
(defun rmail-find-all-files (start)
883
  "Return list of file in dir START that match `rmail-secondary-file-regexp'."
884
  (if (file-accessible-directory-p start)
885
      ;; Don't sort here.
886 887
      (let* ((case-fold-search t)
	     (files (directory-files start t rmail-secondary-file-regexp)))
888 889
	;; Sort here instead of in directory-files
	;; because this list is usually much shorter.
890
	(sort files 'string<))))
891 892 893 894 895

(defun rmail-list-to-menu (menu-name l action &optional full-name)
  (let ((menu (make-sparse-keymap menu-name)))
    (mapcar
     (function (lambda (item)
896 897 898 899 900 901 902 903 904 905 906
		 (let (command)
		   (if (consp item)
		       (progn
			 (setq command
			       (rmail-list-to-menu (car item) (cdr item) 
						   action 
						   (if full-name
						       (concat full-name "/"
							       (car item))
						     (car item))))
			 (setq name (car item)))
907
		     (progn
908 909 910 911 912 913 914 915 916 917 918
		       (setq name item)
		       (setq command 
			     (list 'lambda () '(interactive)
				   (list action
					 (expand-file-name 
					  (if full-name
					      (concat full-name "/" item)
					    item)
					  rmail-secondary-file-directory))))))
		   (define-key menu (vector (intern name))
		     (cons name command)))))
919
     (reverse l))
920 921
    menu))
 
922 923 924
;; This command is always "disabled" when it appears in a menu.
(put 'rmail-disable-menu 'menu-enable ''nil)

925 926
(defun rmail-construct-io-menu ()
  (let ((files (rmail-find-all-files rmail-secondary-file-directory)))
927
    (if files
928 929 930 931
	(progn
	  (define-key rmail-mode-map [menu-bar classify input-menu]
	    (cons "Input Rmail File" 
		  (rmail-list-to-menu "Input Rmail File" 
932
				      files
933 934 935 936
				      'rmail-input)))
	  (define-key rmail-mode-map [menu-bar classify output-menu]
	    (cons "Output Rmail File" 
		  (rmail-list-to-menu "Output Rmail File" 
937 938 939 940 941 942 943
				      files
				      'rmail-output-to-rmail-file))))

      (define-key rmail-mode-map [menu-bar classify input-menu]
	'("Input Rmail File" . rmail-disable-menu))
      (define-key rmail-mode-map [menu-bar classify output-menu]
	'("Output Rmail File" . rmail-disable-menu)))))
944

Roland McGrath's avatar
Roland McGrath committed
945 946 947 948 949 950 951 952 953 954

;;;; *** Rmail input ***

;; RLK feature not added in this version:
;; argument specifies inbox file or files in various ways.

(defun rmail-get-new-mail (&optional file-name)
  "Move any new mail from this RMAIL file's inbox files.
The inbox files can be specified with the file's Mail: option.  The
variable `rmail-primary-inbox-list' specifies the inboxes for your
955 956
primary RMAIL file if it has no Mail: option.  By default, this is
your /usr/spool/mail/$USER.
Roland McGrath's avatar
Roland McGrath committed
957 958 959 960

You can also specify the file to get new mail from.  In this case, the
file of new mail is not changed or deleted.  Noninteractively, you can
pass the inbox file name as an argument.  Interactively, a prefix
961 962
argument causes us to read a file name and use that file as the inbox.

963 964 965
If the variable `rmail-preserve-inbox' is non-nil, new mail will
always be left in inbox files rather than deleted.

966 967
This function runs `rmail-get-new-mail-hook' before saving the updated file.
It returns t if it got any new messages."
Roland McGrath's avatar
Roland McGrath committed
968 969 970
  (interactive
   (list (if current-prefix-arg
	     (read-file-name "Get new mail from file: "))))
971
  (run-hooks 'rmail-before-get-new-mail-hook)
972 973
  ;; If the disk file has been changed from under us,
  ;; revert to it before we get new mail.
Roland McGrath's avatar
Roland McGrath committed
974
  (or (verify-visited-file-modtime (current-buffer))
975
      (find-file (buffer-file-name)))
Roland McGrath's avatar
Roland McGrath committed
976 977 978 979 980
  (rmail-maybe-set-message-counters)
  (widen)
  ;; Get rid of all undo records for this buffer.
  (or (eq buffer-undo-list t)
      (setq buffer-undo-list nil))
981 982 983
  (let ((all-files (if file-name (list file-name)
		     rmail-inbox-list)))
    (unwind-protect
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 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
	(let (found)
	  (while all-files
	    (let ((opoint (point))
		  (new-messages 0)
		  (delete-files ())
		  ;; If buffer has not changed yet, and has not been saved yet,
		  ;; don't replace the old backup file now.
		  (make-backup-files (and make-backup-files (buffer-modified-p)))
		  (buffer-read-only nil)
		  ;; Don't make undo records for what we do in getting mail.
		  (buffer-undo-list t)
		  success
		  ;; Files to insert this time around.
		  files
		  ;; Last names of those files.
		  file-last-names)
	      ;; Pull files off all-files onto files
	      ;; as long as there is no name conflict.
	      ;; A conflict happens when two inbox file names
	      ;; have the same last component.
	      (while (and all-files
			  (not (member (file-name-nondirectory (car all-files))
				       file-last-names)))
		(setq files (cons (car all-files) files)
		      file-last-names
		      (cons (file-name-nondirectory (car all-files)) files))
		(setq all-files (cdr all-files)))
	      ;; Put them back in their original order.
	      (setq files (nreverse files))

	      (goto-char (point-max))
	      (skip-chars-backward " \t\n") ; just in case of brain damage
	      (delete-region (point) (point-max)) ; caused by require-final-newline
	      (save-excursion
		(save-restriction
		  (narrow-to-region (point) (point))
		  ;; Read in the contents of the inbox files,
		  ;; renaming them as necessary,
		  ;; and adding to the list of files to delete eventually.
		  (if file-name
		      (rmail-insert-inbox-text files nil)
		    (setq delete-files (rmail-insert-inbox-text files t)))
		  ;; Scan the new text and convert each message to babyl format.
		  (goto-char (point-min))
		  (unwind-protect
		      (save-excursion
			(setq new-messages (rmail-convert-to-babyl-format)
			      success t))
		    ;; If we could not convert the file's inboxes,
		    ;; rename the files we tried to read
		    ;; so we won't over and over again.
		    (if (and (not file-name) (not success))
			(let ((delfiles delete-files)
			      (count 0))
			  (while delfiles
			    (while (file-exists-p (format "RMAILOSE.%d" count))
			      (setq count (1+ count)))
			    (rename-file (car delfiles)
					 (format "RMAILOSE.%d" count))
			    (setq delfiles (cdr delfiles))))))
		  (or (zerop new-messages)
		      (let (success)
			(widen)
			(search-backward "\n\^_" nil t)
			(narrow-to-region (point) (point-max))
			(goto-char (1+ (point-min)))
			(rmail-count-new-messages)
			(run-hooks 'rmail-get-new-mail-hook)
			(save-buffer)))
		  ;; Delete the old files, now that babyl file is saved.
		  (while delete-files
		    (condition-case ()
			;; First, try deleting.
			(condition-case ()
			    (delete-file (car delete-files))
			  (file-error
			   ;; If we can't delete it, truncate it.
			   (write-region (point) (point) (car delete-files))))
		      (file-error nil))
		    (setq delete-files (cdr delete-files)))))
	      (if (= new-messages 0)
		  (progn (goto-char opoint)
			 (if (or file-name rmail-inbox-list)
			     (message "(No new mail has arrived)")))
		(if (rmail-summary-exists)
		    (rmail-select-summary
		     (rmail-update-summary)))
		(message "%d new message%s read"
			 new-messages (if (= 1 new-messages) "" "s"))
		;; Move to the first new message
		;; unless we have other unseen messages before it.
		(rmail-show-message (rmail-first-unseen-message))
		(run-hooks 'rmail-after-get-new-mail-hook)
		(setq found t))))
	  found)
1079 1080
      ;; Don't leave the buffer screwed up if we get a disk-full error.
      (rmail-show-message))))
Roland McGrath's avatar
Roland McGrath committed
1081 1082

(defun rmail-insert-inbox-text (files renamep)
1083 1084 1085 1086 1087
  ;; Detect a locked file now, so that we avoid moving mail
  ;; out of the real inbox file.  (That could scare people.)
  (or (memq (file-locked-p buffer-file-name) '(nil t))
      (error "RMAIL file %s is locked"
	     (file-name-nondirectory buffer-file-name)))
1088
  (let (file tofile delete-files movemail popmail)
Roland McGrath's avatar
Roland McGrath committed
1089
    (while files
1090 1091
      (setq file (file-truename
		  (expand-file-name (substitute-in-file-name (car files))))
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
	    tofile (expand-file-name
		    ;; Generate name to move to from inbox name,
		    ;; in case of multiple inboxes that need moving.
		    (concat ".newmail-" (file-name-nondirectory file))
		    ;; Use the directory of this rmail file
		    ;; because it's a nuisance to use the homedir
		    ;; if that is on a full disk and this rmail
		    ;; file isn't.
		    (file-name-directory
		     (expand-file-name buffer-file-name))))
      ;; Always use movemail to rename the file,
      ;; since there can be mailboxes in various directories.
      (setq movemail t)
;;;      ;; If getting from mail spool directory,
;;;      ;; use movemail to move rather than just renaming,
;;;      ;; so as to interlock with the mailer.
;;;      (setq movemail (string= file
;;;			      (file-truename
;;;			       (concat rmail-spool-directory
;;;				       (file-name-nondirectory file)))))
      (setq popmail (string-match "^po:" (file-name-nondirectory file)))
1113 1114
      (if popmail (setq file (file-name-nondirectory file)
			renamep t))
Roland McGrath's avatar
Roland McGrath committed
1115 1116 1117 1118 1119
      (if movemail
	  (progn
	    ;; On some systems, /usr/spool/mail/foo is a directory
	    ;; and the actual inbox is /usr/spool/mail/foo/foo.
	    (if (file-directory-p file)
1120
		(setq file (expand-file-name (user-login-name)
Roland McGrath's avatar
Roland McGrath committed
1121
					     file)))))
1122
      (cond (popmail
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134
	     (if (and rmail-pop-password-required (not rmail-pop-password))
		 (setq rmail-pop-password
		       (rmail-read-passwd
			(format "Password for %s: "
				(substring file (+ popmail 3))))))
	     (if (eq system-type 'windows-nt)
		 ;; cannot have "po:" in file name
		 (setq tofile
		       (expand-file-name
			(concat ".newmail-pop-" (substring file (+ popmail 3)))
			(file-name-directory
			 (expand-file-name buffer-file-name)))))
1135 1136 1137 1138 1139 1140 1141
	     (message "Getting mail from post office ..."))
	    ((and (file-exists-p tofile)
		  (/= 0 (nth 7 (file-attributes tofile))))
	     (message "Getting mail from %s..." tofile))
	    ((and (file-exists-p file)
		  (/= 0 (nth 7 (file-attributes file))))
	     (message "Getting mail from %s..." file)))
Roland McGrath's avatar
Roland McGrath committed
1142 1143 1144 1145
      ;; Set TOFILE if have not already done so, and
      ;; rename or copy the file FILE to TOFILE if and as appropriate.
      (cond ((not renamep)
	     (setq tofile file))
1146 1147
	    ((or (file-exists-p tofile) (and (not popmail)
					     (not (file-exists-p file))))
Roland McGrath's avatar
Roland McGrath committed
1148
	     nil)
1149
	    ((and (not movemail) (not popmail))
1150 1151 1152
	     ;; Try copying.  If that fails (perhaps no space) and
	     ;; we're allowed to blow away the inbox, rename instead.
	     (if rmail-preserve-inbox
1153
		 (copy-file file tofile nil)
1154 1155 1156 1157 1158
	       (condition-case nil
		   (copy-file file tofile nil)
		 (error
		  ;; Third arg is t so we can replace existing file TOFILE.
		  (rename-file file tofile t))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1159 1160 1161
	     ;; Make the real inbox file empty.
	     ;; Leaving it deleted could cause lossage
	     ;; because mailers often won't create the file.
1162 1163 1164 1165
	     (if (not rmail-preserve-inbox)
		 (condition-case ()
		     (write-region (point) (point) file)
		   (file-error nil))))
Roland McGrath's avatar
Roland McGrath committed
1166 1167 1168 1169 1170 1171
	    (t
	     (let ((errors nil))
	       (unwind-protect
		   (save-excursion
		     (setq errors (generate-new-buffer " *rmail loss*"))
		     (buffer-disable-undo errors)
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185
		     (let ((args 
			    (append 
			     (list (or rmail-movemail-program
				       (expand-file-name "movemail"
							 exec-directory))
				   nil errors nil)
			     (if rmail-preserve-inbox 
				 (list "-p")
			       nil)
			     (list file tofile)
			     (if rmail-pop-password 
				 (list rmail-pop-password)
			       nil))))
		       (apply 'call-process args))
Roland McGrath's avatar
Roland McGrath committed
1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198
		     (if (not (buffer-modified-p errors))
			 ;; No output => movemail won
			 nil
		       (set-buffer errors)
		       (subst-char-in-region (point-min) (point-max)
					     ?\n ?\  )
		       (goto-char (point-max))
		       (skip-chars-backward " \t")
		       (delete-region (point) (point-max))
		       (goto-char (point-min))
		       (if (looking-at "movemail: ")
			   (delete-region (point-min) (match-end 0)))
		       (beep t)
1199 1200 1201
		       (message "movemail: %s"
				(buffer-substring (point-min)
						  (point-max)))
Roland McGrath's avatar
Roland McGrath committed
1202 1203 1204 1205 1206 1207 1208
		       (sit-for 3)
		       nil))
		 (if errors (kill-buffer errors))))))
      ;; At this point, TOFILE contains the name to read:
      ;; Either the alternate name (if we renamed)
      ;; or the actual inbox (if not renaming).
      (if (file-exists-p tofile)
1209 1210
	  (let ((coding-system-for-read 'no-conversion)
		size)
Roland McGrath's avatar
Roland McGrath committed
1211
	    (goto-char (point-max))
1212
	    (setq size (nth 1 (insert-file-contents tofile)))