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

3
;; Copyright (C) 1985,86,87,88,93,94,95,96,97 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

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

49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
(defgroup rmail nil
  "Mail reader for Emacs."
  :group 'mail)

(defgroup rmail-retrieve nil
  "Rmail retrieval options."
  :prefix "rmail-"
  :group 'rmail)

(defgroup rmail-files nil
  "Rmail files."
  :prefix "rmail-"
  :group 'rmail)

(defgroup rmail-headers nil
  "Rmail header options."
  :prefix "rmail-"
  :group 'rmail)

(defgroup rmail-reply nil
  "Rmail reply options."
  :prefix "rmail-"
  :group 'rmail)

(defgroup rmail-summary nil
  "Rmail summary options."
  :prefix "rmail-"
  :prefix "rmail-summary-"
  :group 'rmail)

(defgroup rmail-output nil
  "Output message to a file."
  :prefix "rmail-output-"
  :prefix "rmail-"
  :group 'rmail)


86 87 88 89
(defcustom rmail-movemail-program nil
  "If non-nil, name of program for fetching new mail."
  :group 'rmail-retrieve
  :type 'string)
90

91 92 93 94 95
(defcustom rmail-pop-password nil
  "*Password to use when reading mail from a POP server, if required."
  :type '(choice (string :tag "Password")
		 (const :tag "Not Required" nil))
  :group 'rmail-retrieve)
96

97 98 99 100
(defcustom rmail-pop-password-required nil
  "*Non-nil if a password is required when reading mail using POP."
  :type 'boolean
  :group 'rmail-retrieve)
101

102
(defcustom rmail-movemail-flags nil
Karl Heuer's avatar
Karl Heuer committed
103 104 105
  "*List of flags to pass to movemail.
Most commonly used to specify `-g' to enable GSS-API authentication
or `-k' to enable Kerberos authentication."
106
  :type '(repeat string)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
107 108
  :group 'rmail-retrieve
  :version "20.3")
109

110 111 112 113 114
(defvar rmail-pop-password-error "invalid usercode or password"
  "Regular expression matching incorrect-password POP server error messages.
If you get an incorrect-password error that this expression does not match,
please report it with \\[report-emacs-bug].")

115
(defcustom rmail-preserve-inbox nil
116
  "*Non-nil if incoming mail should be left in the user's inbox,
117 118 119
rather than deleted, after it is retrieved."
  :type 'boolean
  :group 'rmail-retrieve)
120

Roland McGrath's avatar
Roland McGrath committed
121
;;;###autoload
122
(defcustom rmail-dont-reply-to-names nil "\
Roland McGrath's avatar
Roland McGrath committed
123
*A regexp specifying names to prune of reply to messages.
124 125 126
A value of nil means exclude your own name only."
  :type '(choice regexp (const :tag "Your Name" nil))
  :group 'rmail-reply)
Roland McGrath's avatar
Roland McGrath committed
127 128 129 130 131 132 133

;;;###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
134
It is useful to set this variable in the site customization file.")
Roland McGrath's avatar
Roland McGrath committed
135 136

;;;###autoload
137
(defcustom rmail-ignored-headers "^via:\\|^mail-from:\\|^origin:\\|^references:\\|^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:\\|^lines:\\|^mime-version:\\|^content-transfer-encoding:"
138 139 140
  "*Regexp to match header fields that Rmail should normally hide."
  :type 'regexp
  :group 'rmail-headers)
Roland McGrath's avatar
Roland McGrath committed
141

142
;;;###autoload
143
(defcustom rmail-displayed-headers nil
144 145
  "*Regexp to match Header fields that Rmail should display.
If nil, display all header fields except those matched by
146 147 148
`rmail-ignored-headers'."
  :type '(choice regexp (const :tag "All"))
  :group 'rmail-headers)
149

150
;;;###autoload
151 152 153 154
(defcustom rmail-retry-ignored-headers nil "\
*Headers that should be stripped when retrying a failed message."
  :type '(choice regexp (const nil :tag "None"))
  :group 'rmail-headers)
155

156
;;;###autoload
157
(defcustom rmail-highlighted-headers "^From:\\|^Subject:" "\
158
*Regexp to match Header fields that Rmail should normally highlight.
159
A value of nil means don't highlight.
160 161 162
See also `rmail-highlight-face'."
  :type 'regexp
  :group 'rmail-headers)
163

164
;;;###autoload
165 166 167 168 169
(defcustom rmail-highlight-face nil "\
*Face used by Rmail for highlighting headers."
  :type '(choice (const :tag "Default" nil)
		 face)
  :group 'rmail-headers)
170

Roland McGrath's avatar
Roland McGrath committed
171
;;;###autoload
172 173 174 175
(defcustom rmail-delete-after-output nil "\
*Non-nil means automatically delete a message that is copied to a file."
  :type 'boolean
  :group 'rmail-files)
Roland McGrath's avatar
Roland McGrath committed
176 177

;;;###autoload
178
(defcustom rmail-primary-inbox-list nil "\
179 180 181
*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,
182
and the value of the environment variable MAIL overrides it)."
183 184 185
  ;; Don't use backquote here, because we don't want to need it
  ;; at load time.
  :type (list 'choice '(const :tag "Default" nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
186 187 188
	      (list 'repeat ':value (or (getenv "MAIL")
					(concat "/var/spool/mail/"
						(getenv "USER")))
189
		    'file))
190 191
  :group 'rmail-retrieve
  :group 'rmail-files)
Roland McGrath's avatar
Roland McGrath committed
192

193
;;;###autoload
194 195 196 197
(defcustom rmail-mail-new-frame nil
  "*Non-nil means Rmail makes a new frame for composing outgoing mail."
  :type 'boolean
  :group 'rmail-reply)
198

199
;;;###autoload
200 201 202 203
(defcustom rmail-secondary-file-directory "~/"
  "*Directory for additional secondary Rmail files."
  :type 'directory
  :group 'rmail-files)
204
;;;###autoload
205 206 207 208
(defcustom rmail-secondary-file-regexp "\\.xmail$"
  "*Regexp for which files are secondary Rmail files."
  :type 'regexp
  :group 'rmail-files)
209

210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
;;;###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.")

228 229 230
;; 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
231

232
(defvar rmail-mmdf-delim1 "^\001\001\001\001\n"
Roland McGrath's avatar
Roland McGrath committed
233
  "Regexp marking the start of an mmdf message")
234
(defvar rmail-mmdf-delim2 "^\001\001\001\001\n"
Roland McGrath's avatar
Roland McGrath committed
235 236
  "Regexp marking the end of an mmdf message")

237
(defcustom rmail-message-filter nil
238 239
  "If non-nil, a filter function for new messages in RMAIL.
Called with region narrowed to the message, including headers,
240 241 242
before obeying `rmail-ignored-headers'."
  :group 'rmail-headers
  :type 'function)
Roland McGrath's avatar
Roland McGrath committed
243

244 245 246
(defvar rmail-reply-prefix "Re: "
  "String to prepend to Subject line when replying to a message.")

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

252 253 254 255 256
(defcustom rmail-display-summary nil
  "*If non-nil, Rmail always displays the summary buffer."
  :group 'rmail-summary
  :type 'boolean)

Roland McGrath's avatar
Roland McGrath committed
257
(defvar rmail-inbox-list nil)
258 259
(put 'rmail-inbox-list 'permanent-local t)

Roland McGrath's avatar
Roland McGrath committed
260
(defvar rmail-keywords nil)
261
(put 'rmail-keywords 'permanent-local t)
Roland McGrath's avatar
Roland McGrath committed
262

263 264 265 266 267 268
(defvar rmail-buffer nil
  "The RMAIL buffer related to the current buffer.
In an RMAIL buffer, this holds the RMAIL buffer itself.
In a summary buffer, this holds the RMAIL buffer it is a summary for.")
(put 'rmail-buffer 'permanent-local t)

Roland McGrath's avatar
Roland McGrath committed
269 270 271
;; Message counters and markers.  Deleted flags.

(defvar rmail-current-message nil)
272 273
(put 'rmail-current-message 'permanent-local t)

Roland McGrath's avatar
Roland McGrath committed
274
(defvar rmail-total-messages nil)
275 276
(put 'rmail-total-messages 'permanent-local t)

Roland McGrath's avatar
Roland McGrath committed
277
(defvar rmail-message-vector nil)
278 279
(put 'rmail-message-vector 'permanent-local t)

Roland McGrath's avatar
Roland McGrath committed
280
(defvar rmail-deleted-vector nil)
281 282
(put 'rmail-deleted-vector 'permanent-local t)

283 284 285 286
(defvar rmail-msgref-vector nil
  "In an Rmail buffer, a vector whose Nth element is a list (N).
When expunging renumbers messages, these lists are modified
by substituting the new message number into the existing list.")
287
(put 'rmail-msgref-vector 'permanent-local t)
Roland McGrath's avatar
Roland McGrath committed
288

289
(defvar rmail-overlay-list nil)
290
(put 'rmail-overlay-list 'permanent-local t)
291

Roland McGrath's avatar
Roland McGrath committed
292 293 294
;; These are used by autoloaded rmail-summary.

(defvar rmail-summary-buffer nil)
295
(put 'rmail-summary-buffer 'permanent-local t)
Roland McGrath's avatar
Roland McGrath committed
296
(defvar rmail-summary-vector nil)
297
(put 'rmail-summary-vector 'permanent-local t)
Roland McGrath's avatar
Roland McGrath committed
298

299 300 301 302
(defvar rmail-view-buffer nil
  "Buffer which holds RMAIL message for MIME displaying.")
(put 'rmail-view-buffer 'permanent-local t)

Roland McGrath's avatar
Roland McGrath committed
303 304 305 306
;; `Sticky' default variables.

;; Last individual label specified to a or k.
(defvar rmail-last-label nil)
307 308
(put 'rmail-last-label 'permanent-local t)

309
;; 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
310
(defvar rmail-last-multi-labels nil)
311

312
(defvar rmail-last-regexp nil)
313 314
(put 'rmail-last-regexp 'permanent-local t)

315 316 317 318 319 320 321 322
(defcustom rmail-default-file "~/xmail"
  "*Default file name for \\[rmail-output]."
  :type 'file
  :group 'rmail-files)
(defcustom rmail-default-rmail-file "~/XMAIL"
  "*Default file name for \\[rmail-output-to-rmail-file]."
  :type 'file
  :group 'rmail-files)
Jim Blandy's avatar
Jim Blandy committed
323

324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
;; 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
(defcustom 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 requires it."
  :type '(choice (const :tag "on" t)
		 (const :tag "off" nil)
		 (sexp :tag "when asked" :format "%t\n" ask))
  :group 'rmail)

;;;###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.")


Jim Blandy's avatar
Jim Blandy committed
354 355 356 357
;;; 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
358
(defvar rmail-unix-mail-delimiter
Jim Blandy's avatar
Jim Blandy committed
359
  (let ((time-zone-regexp
360
	 (concat "\\([A-Z]?[A-Z]?[A-Z][A-Z]\\( DST\\)?"
Jim Blandy's avatar
Jim Blandy committed
361 362 363 364 365 366
		 "\\|[-+]?[0-9][0-9][0-9][0-9]"
		 "\\|"
		 "\\) *")))
    (concat
     "From "

367 368 369 370 371 372 373 374 375 376 377
     ;; 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'.
378 379 380 381 382
     ;; 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.
383 384 385
     ;; 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.
386
     "\\([^\0-\b\n-\r\^?].*\\)? "
Jim Blandy's avatar
Jim Blandy committed
387 388

     ;; The time the message was sent.
389 390 391 392
     "\\([^\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
393 394 395 396 397 398

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

     ;; The year.
399
     " \\([0-9][0-9]+\\) *"
Jim Blandy's avatar
Jim Blandy committed
400 401 402 403

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

Karl Heuer's avatar
Karl Heuer committed
404 405
     ;; Old uucp cruft.
     "\\(remote from .*\\)?"
Jim Blandy's avatar
Jim Blandy committed
406 407 408 409

     "\n"))
  nil)

410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
(defvar rmail-font-lock-keywords
  (eval-when-compile
    (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\\|Newsgroups\\):"
	      . font-lock-keyword-face)
	    ;; Use MATCH-ANCHORED to effectively anchor the regexp left side.
	    `(,cite-chars
	      (,(concat "\\=[ \t]*"
			"\\(\\([" cite-prefix "]+[" cite-suffix "]*\\)?"
			"\\(" cite-chars "[ \t]*\\)\\)+"
			"\\(.*\\)")
	       (beginning-of-line) (end-of-line)
	       (2 font-lock-constant-face nil t)
	       (4 font-lock-comment-face nil t)))
	    '("^\\(X-[A-Za-z0-9-]+\\|In-reply-to\\|Date\\):.*$"
	      . font-lock-string-face))))
  "Additional expressions to highlight in Rmail mode.")

433 434 435
;; 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)
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
  (` (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))))
Roland McGrath's avatar
Roland McGrath committed
455 456 457

;;;; *** Rmail Mode ***

458 459
(defvar rmail-enable-multibyte nil)

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

467 468 469
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
470 471 472
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
473
  (interactive (if current-prefix-arg
474
		   (list (read-file-name "Run rmail on RMAIL file: "))))
475 476 477 478 479 480
  (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
481
  (let* ((file-name (expand-file-name (or file-name-arg rmail-file-name)))
482
	 (existed (get-file-buffer file-name))
483 484 485
	 ;; This binding is necessary because we much decide if we
	 ;; need code conversion while the buffer is unibyte
	 ;; (i.e. enable-multibyte-characters is nil).
486 487 488 489 490 491 492 493
	 (rmail-enable-multibyte (default-value 'enable-multibyte-characters))
	 ;; Since the file may contain messages of different encodings
	 ;; at the tail (non-BYBYL part), we can't decode them at once
	 ;; on reading.  So, at first, we read the file without text
	 ;; code conversion, then decode the messages one by one by
	 ;; rmail-decode-babyl-format or
	 ;; rmail-convert-to-babyl-format.
	 (coding-system-for-read (and rmail-enable-multibyte 'raw-text))
494
	 run-mail-hook msg-shown)
Roland McGrath's avatar
Roland McGrath committed
495 496
    ;; Like find-file, but in the case where a buffer existed
    ;; and the file was reverted, recompute the message-data.
497 498 499 500 501
    ;; We used to bind enable-local-variables to nil here,
    ;; but that should not be needed now that rmail-mode
    ;; sets it locally to nil.
    ;; (Binding a variable locally with let is not safe if it has
    ;; buffer-local bindings.)
Roland McGrath's avatar
Roland McGrath committed
502 503
    (if (and existed (not (verify-visited-file-modtime existed)))
	(progn
504
	  (find-file file-name)
505 506
	  (if (and (verify-visited-file-modtime existed)
		   (eq major-mode 'rmail-mode))
Roland McGrath's avatar
Roland McGrath committed
507 508
	      (progn (rmail-forget-messages)
		     (rmail-set-message-counters))))
509
      (find-file file-name))
510
    (if (eq major-mode 'rmail-edit-mode)
511
	(error "Exit Rmail Edit mode before getting new mail"))
Roland McGrath's avatar
Roland McGrath committed
512 513 514
    (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)
515 516 517
	    (progn (rmail-mode-2)
		   (setq run-mail-hook t)))
      (setq run-mail-hook t)
Roland McGrath's avatar
Roland McGrath committed
518 519 520
      (rmail-mode-2)
      ;; Convert all or part to Babyl file if possible.
      (rmail-convert-file)
521 522 523 524 525
      ;; As we have read a file by raw-text, the buffer is set to
      ;; unibyte.  We must make it multibyte if necessary.
      (if (and rmail-enable-multibyte
	       (not enable-multibyte-characters))
	  (set-buffer-multibyte t))
Roland McGrath's avatar
Roland McGrath committed
526 527 528 529
      (goto-char (point-max))
      (if (null rmail-inbox-list)
	  (progn
	    (rmail-set-message-counters)
530 531
	    (rmail-show-message)
	    (setq msg-shown t))))
532 533 534 535 536 537 538 539 540
    (unwind-protect
	(or (and (null file-name-arg)
		 (rmail-get-new-mail))
	    (or msg-shown (rmail-show-message (rmail-first-unseen-message))))
      (progn
	(if rmail-display-summary (rmail-summary))
	(rmail-construct-io-menu)
	(if run-mail-hook
	    (run-hooks 'rmail-mode-hook))))))
Roland McGrath's avatar
Roland McGrath committed
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571

;; 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")))
572 573 574
	  ((equal (point-min) (point-max))
	   ;; Empty RMAIL file.  Just insert the header.
	   (rmail-insert-rmail-file-header))
Roland McGrath's avatar
Roland McGrath committed
575
	  (t
576
	   ;; Non-empty file in non-RMAIL format.  Add header and convert.
Roland McGrath's avatar
Roland McGrath committed
577 578 579 580 581 582
	   (setq convert t)
	   (rmail-insert-rmail-file-header)))
    ;; 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
583 584
	    (save-excursion
	      (goto-char (point-max))
585 586
	      (search-backward "\n\^_")
	      (forward-char 2)
587
	      (looking-at "\n*From ")))
Roland McGrath's avatar
Roland McGrath committed
588 589
	(let ((buffer-read-only nil))
	  (message "Converting to Babyl format...")
590 591 592 593 594
	  ;; 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)
595
	  (narrow-to-region (point) (point-max))
Roland McGrath's avatar
Roland McGrath committed
596
	  (rmail-convert-to-babyl-format)
597 598 599 600 601
	  (message "Converting to Babyl format...done"))
      (if (and (not rmail-enable-mime)
	       rmail-enable-multibyte)
	  ;; We still have to decode BABYL part.
	  (rmail-decode-babyl-format)))))
Roland McGrath's avatar
Roland McGrath committed
602

603 604
;;; 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
605 606 607 608 609 610 611 612 613 614

(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\^_")))

615
;; Decode Babyl formated part at the head of current buffer by
616
;; rmail-file-coding-system, or if it is nil, do auto conversion.
617 618 619 620

(defun rmail-decode-babyl-format ()
  (let ((modifiedp (buffer-modified-p))
	(buffer-read-only nil)
621
	from to)
622 623
    (goto-char (point-min))
    (search-forward "\n\^_" nil t)	; Skip BYBYL header.
624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
    (setq from (point))
    (goto-char (point-max))
    (search-backward "\n\^_" from 'mv)
    (setq to (point))
    (if (not (and rmail-file-coding-system
		  (coding-system-p rmail-file-coding-system)))
	(setq rmail-file-coding-system (detect-coding-region from to t)))
    (if (not (eq rmail-file-coding-system 'undecided))
	(let ((count 1))
	  (goto-char from)
	  (while (search-forward "\n\^_" nil t)
	    (decode-coding-region from (1- (point)) rmail-file-coding-system)
	    (goto-char (point))
	    (setq from (point))
	    (if (= (% count 10) 0)
639
		(message "Decoding messages...%d" count))
640
	    (setq count (1+ count)))
641
	  (message "Decoding messages...done")
642 643
	  (set-buffer-file-coding-system rmail-file-coding-system)
	  (set-buffer-modified-p modifiedp)))))
644

645
(defvar rmail-mode-map nil)
Roland McGrath's avatar
Roland McGrath committed
646 647 648 649
(if rmail-mode-map
    nil
  (setq rmail-mode-map (make-keymap))
  (suppress-keymap rmail-mode-map)
650 651 652 653 654 655 656 657 658 659 660 661 662
  (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
663 664 665 666
  (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)
667 668 669 670 671 672 673 674 675 676 677 678 679
  (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)
680
;; I find I can't live without the default M-r command -- rms.
681 682 683 684 685
;;  (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)
686
  (define-key rmail-mode-map "w"      'rmail-output-body-to-file)
687 688 689 690 691 692 693
  (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)
694 695 696 697 698 699
  (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)
700
  (define-key rmail-mode-map "\C-c\C-s\C-k" 'rmail-sort-by-keywords)
701 702
  (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)
703
  )
704 705 706 707 708 709

(define-key rmail-mode-map [menu-bar] (make-sparse-keymap))

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

710
(define-key rmail-mode-map [menu-bar classify input-menu]
711
  nil)
712 713

(define-key rmail-mode-map [menu-bar classify output-menu]
714
  nil)
715

716 717 718
(define-key rmail-mode-map [menu-bar classify output-body]
  '("Output body to file..." . rmail-output-body-to-file))

719
(define-key rmail-mode-map [menu-bar classify output-inbox]
720
  '("Output (inbox)..." . rmail-output))
721 722

(define-key rmail-mode-map [menu-bar classify output]
723
  '("Output (Rmail)..." . rmail-output-to-rmail-file))
724 725

(define-key rmail-mode-map [menu-bar classify kill-label]
726
  '("Kill Label..." . rmail-kill-label))
727 728

(define-key rmail-mode-map [menu-bar classify add-label]
729
  '("Add Label..." . rmail-add-label))
730 731 732 733

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

734 735 736
(define-key rmail-mode-map [menu-bar summary senders]
  '("By Senders..." . rmail-summary-by-senders))

737
(define-key rmail-mode-map [menu-bar summary labels]
738
  '("By Labels..." . rmail-summary-by-labels))
739 740

(define-key rmail-mode-map [menu-bar summary recipients]
741
  '("By Recipients..." . rmail-summary-by-recipients))
742 743

(define-key rmail-mode-map [menu-bar summary topic]
744
  '("By Topic..." . rmail-summary-by-topic))
745 746

(define-key rmail-mode-map [menu-bar summary regexp]
747
  '("By Regexp..." . rmail-summary-by-regexp))
748 749 750 751 752 753

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

755
(define-key rmail-mode-map [menu-bar mail rmail-get-new-mail]
756 757 758
  '("Get New Mail" . rmail-get-new-mail))

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

761 762 763
(define-key rmail-mode-map [menu-bar mail continue]
  '("Continue" . rmail-continue))

764
(define-key rmail-mode-map [menu-bar mail resend]
765
  '("Re-send..." . rmail-resend))
766

767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
(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
784

785 786 787 788 789 790 791 792 793 794 795 796 797
(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]
798
  '("Search Back..." . rmail-search-backwards))
799 800

(define-key rmail-mode-map [menu-bar move search]
801
  '("Search..." . rmail-search))
802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820

(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
821 822 823
;; Rmail mode is suitable only for specially formatted data.
(put 'rmail-mode 'mode-class 'special)

824 825 826
(defun rmail-mode-kill-summary ()
  (if rmail-summary-buffer (kill-buffer rmail-summary-buffer)))

827
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
(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.
848
\\[rmail-edit-current-message]	Edit the current message.  \\[rmail-cease-edit] to return to Rmail.
Roland McGrath's avatar
Roland McGrath committed
849 850 851 852
\\[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.
853
\\[rmail-get-new-mail]	Move new mail from system spool directory into this file.
Roland McGrath's avatar
Roland McGrath committed
854 855
\\[rmail-mail]	Mail a message (same as \\[mail-other-window]).
\\[rmail-continue]	Continue composing outgoing message started before.
856 857
\\[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
858 859 860
\\[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).
Stephen Eglen's avatar
Stephen Eglen committed
861
\\[rmail-output-body-to-file]	Save message body to a file.  Default filename comes from Subject line.
Roland McGrath's avatar
Roland McGrath committed
862 863 864 865 866 867
\\[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.
868
          Any other label is present only if you add it with \\[rmail-add-label].
Roland McGrath's avatar
Roland McGrath committed
869 870
\\[rmail-previous-labeled-message]   Move to Previous message with specified label
\\[rmail-summary]	Show headers buffer, with a one line summary of each message.
871 872 873 874 875
\\[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
876 877 878
  (interactive)
  (rmail-mode-2)
  (rmail-set-message-counters)
879 880
  (rmail-show-message rmail-total-messages)
  (run-hooks 'rmail-mode-hook))
Roland McGrath's avatar
Roland McGrath committed
881 882 883 884

(defun rmail-mode-2 ()
  (kill-all-local-variables)
  (rmail-mode-1)
885
  (rmail-perm-variables)
886
  (rmail-variables))
Roland McGrath's avatar
Roland McGrath committed
887 888 889 890 891

(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
892 893 894 895 896
  ;; 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
897
  (setq buffer-auto-save-file-name nil)
898
  (setq mode-line-modified "--")
Roland McGrath's avatar
Roland McGrath committed
899 900 901 902
  (use-local-map rmail-mode-map)
  (set-syntax-table text-mode-syntax-table)
  (setq local-abbrev-table text-mode-abbrev-table))

903 904
;; Set up the permanent locals associated with an Rmail file.
(defun rmail-perm-variables ()
Roland McGrath's avatar
Roland McGrath committed
905
  (make-local-variable 'rmail-last-label)
906
  (make-local-variable 'rmail-last-regexp)
Roland McGrath's avatar
Roland McGrath committed
907
  (make-local-variable 'rmail-deleted-vector)
908 909 910 911
  (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
912 913 914 915
  (make-local-variable 'rmail-summary-buffer)
  (make-local-variable 'rmail-summary-vector)
  (make-local-variable 'rmail-current-message)
  (make-local-variable 'rmail-total-messages)
916 917
  (make-local-variable 'rmail-overlay-list)
  (setq rmail-overlay-list nil)
Roland McGrath's avatar
Roland McGrath committed
918
  (make-local-variable 'rmail-message-vector)
919
  (make-local-variable 'rmail-msgref-vector)
Roland McGrath's avatar
Roland McGrath committed
920 921
  (make-local-variable 'rmail-inbox-list)
  (setq rmail-inbox-list (rmail-parse-file-inboxes))
922 923
  ;; Provide default set of inboxes for primary mail file ~/RMAIL.
  (and (null rmail-inbox-list)
924
       (or (equal buffer-file-name (expand-file-name rmail-file-name))
925 926
	   (equal buffer-file-truename
		  (abbreviate-file-name (file-truename rmail-file-name))))
927 928 929 930
       (setq rmail-inbox-list
	     (or rmail-primary-inbox-list
		 (list (or (getenv "MAIL")
			   (concat rmail-spool-directory
931
				   (user-login-name)))))))
Roland McGrath's avatar
Roland McGrath committed
932 933
  (make-local-variable 'rmail-keywords)
  ;; this gets generated as needed
934
  (setq rmail-keywords nil))
Roland McGrath's avatar
Roland McGrath committed
935

936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958
;; Set up the non-permanent locals associated with Rmail mode.
(defun rmail-variables ()
  ;; Don't let a local variables list in a message cause confusion.
  (make-local-variable 'enable-local-variables)
  (setq enable-local-variables nil)
  (make-local-variable 'revert-buffer-function)
  (setq revert-buffer-function 'rmail-revert)
  (make-local-variable 'font-lock-defaults)
  (setq font-lock-defaults
   '(rmail-font-lock-keywords t nil nil nil
     (font-lock-maximum-size . nil)
     (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))))
  (make-local-variable 'require-final-newline)
  (setq require-final-newline nil)
  (make-local-variable 'version-control)
  (setq version-control 'never)
  (make-local-variable 'kill-buffer-hook)
  (add-hook 'kill-buffer-hook 'rmail-mode-kill-summary)
  (make-local-variable 'file-precious-flag)
  (setq file-precious-flag t))

Roland McGrath's avatar
Roland McGrath committed
959 960
;; Handle M-x revert-buffer done in an rmail-mode buffer.
(defun rmail-revert (arg noconfirm)
961
  (let ((revert-buffer-function (default-value 'revert-buffer-function)))
Roland McGrath's avatar
Roland McGrath committed
962 963 964 965
    ;; 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.
966
	(progn
Roland McGrath's avatar
Roland McGrath committed
967 968
	  (rmail-convert-file)
	  (goto-char (point-max))
969
	  (rmail-mode)))))
Roland McGrath's avatar
Roland McGrath committed
970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992

;; 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)
993 994 995
  (save-buffer)
  (if (rmail-summary-exists)
      (rmail-select-summary (set-buffer-modified-p nil))))
Roland McGrath's avatar
Roland McGrath committed
996 997 998 999 1000 1001

(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.
1002 1003 1004
  (when rmail-summary-buffer
    (replace-buffer-in-windows rmail-summary-buffer)
    (bury-buffer rmail-summary-buffer))
Roland McGrath's avatar
Roland McGrath committed
1005
  (let ((obuf (current-buffer)))
1006 1007
    (quit-window)
    (replace-buffer-in-windows obuf)))
Roland McGrath's avatar
Roland McGrath committed
1008

1009 1010 1011 1012 1013 1014 1015 1016 1017
(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))
1018
	    (quit-window nil window))
1019
	  (bury-buffer rmail-summary-buffer)))
1020
    (quit-window)))
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037

(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
1038 1039
;;;###autoload
(defun rmail-input (filename)
1040
  "Run Rmail on file FILENAME."
Roland McGrath's avatar
Roland McGrath committed
1041 1042 1043
  (interactive "FRun rmail on RMAIL file: ")
  (rmail filename))

1044 1045 1046 1047 1048

;; 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.
1049
(defun rmail-find-all-files (start)
1050
  "Return list of file in dir START that match `rmail-secondary-file-regexp'."
1051
  (if (file-accessible-directory-p start)
1052
      ;; Don't sort here.
1053 1054
      (let* ((case-fold-search t)
	     (files (directory-files start t rmail-secondary-file-regexp)))
1055 1056
	;; Sort here instead of in directory-files
	;; because this list is usually much shorter.
1057
	(sort files 'string<))))
1058 1059 1060 1061 1062

(defun rmail-list-to-menu (menu-name l action &optional full-name)
  (let ((menu (make-sparse-keymap menu-name)))
    (mapcar
     (function (lambda (item)
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
		 (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)))
1074
		     (progn
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085
		       (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)))))
1086
     (reverse l))
1087 1088
    menu))
 
1089 1090 1091
;; This command is always "disabled" when it appears in a menu.
(put 'rmail-disable-menu 'menu-enable ''nil)

1092 1093
(defun rmail-construct-io-menu ()
  (let ((files (rmail-find-all-files rmail-secondary-file-directory)))
1094
    (if files
1095 1096 1097 1098
	(progn
	  (define-key rmail-mode-map [menu-bar classify input-menu]
	    (cons "Input Rmail File" 
		  (rmail-list-to-menu "Input Rmail File" 
1099
				      files
1100 1101 1102 1103
				      'rmail-input)))
	  (define-key rmail-mode-map [menu-bar classify output-menu]
	    (cons "Output Rmail File" 
		  (rmail-list-to-menu "Output Rmail File" 
1104 1105 1106 1107 1108 1109 1110
				      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)))))