rmail.el 100 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 49 50 51 52 53
;(defvar rmail-spool-directory "/usr/spool/mail/"
;  "This is the name of the directory used by the system mailer for\n\
;delivering new mail.  It's name should end with a slash.")
;(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.")

Roland McGrath's avatar
Roland McGrath committed
63 64 65
;;;###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
66
A value of nil means exclude your own name only.")
Roland McGrath's avatar
Roland McGrath committed
67 68 69 70 71 72 73

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

;;;###autoload
77
(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:"
78
  "*Regexp to match Header fields that Rmail should normally hide.")
Roland McGrath's avatar
Roland McGrath committed
79

80 81 82 83 84 85
;;;###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'.")

86 87 88 89
;;;###autoload
(defvar rmail-retry-ignored-headers nil "\
*Headers that should be stripped when retrying a failed message.")

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

96 97 98 99
;;;###autoload
(defvar rmail-highlight-face nil "\
*Face used by Rmail for highlighting headers.")

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

;;;###autoload
105
(defvar rmail-primary-inbox-list nil "\
106 107 108
*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
109 110
and the value of the environment variable MAIL overrides it).")

111 112 113 114
;;;###autoload
(defvar rmail-mail-new-frame nil
  "*Non-nil means Rmail makes a new frame for composing outgoing mail.")

115 116 117 118 119 120 121
;;;###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.")

122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
;;;###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.")

140 141 142
;; 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
143 144 145 146 147 148 149

(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
Karl Heuer's avatar
Karl Heuer committed
150 151
  "If non nil, a filter function for new messages in RMAIL.
Called with region narrowed to the message, including headers.")
Roland McGrath's avatar
Roland McGrath committed
152

153 154 155
(defvar rmail-reply-prefix "Re: "
  "String to prepend to Subject line when replying to a message.")

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

161 162 163
(defvar rmail-display-summary nil
  "If non nil, the summary buffer is always displayed.")

Roland McGrath's avatar
Roland McGrath committed
164 165 166 167 168 169 170 171 172 173 174 175
(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)

176 177
(defvar rmail-overlay-list nil)

178
(defvar rmail-font-lock-keywords
179 180 181 182 183 184 185 186 187 188 189 190 191
  (eval-when-compile
    (let* ((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)
       (cons (concat "^[ \t]*"
		     "\\([" cite-prefix "]+[" cite-suffix "]*\\)?"
		     "[>|}].*")
	     'font-lock-reference-face)
       '("^\\(X-[A-Za-z0-9-]+\\|In-reply-to\\|Date\\):.*$"
	 . font-lock-string-face))))
192 193
  "Additional expressions to highlight in Rmail mode.")

Roland McGrath's avatar
Roland McGrath committed
194 195 196 197 198 199 200 201 202
;; 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)
203
;; 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
204
(defvar rmail-last-multi-labels nil)
205
(defvar rmail-last-regexp nil)
206
(defvar rmail-default-file "~/xmail"
207
  "*Default file name for \\[rmail-output].")
208
(defvar rmail-default-rmail-file "~/XMAIL"
209
  "*Default file name for \\[rmail-output-to-rmail-file].")
Jim Blandy's avatar
Jim Blandy committed
210

Jim Blandy's avatar
Jim Blandy committed
211 212 213 214
;;; 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
215
(defvar rmail-unix-mail-delimiter
Jim Blandy's avatar
Jim Blandy committed
216
  (let ((time-zone-regexp
217
	 (concat "\\([A-Z]?[A-Z]?[A-Z][A-Z]\\( DST\\)?"
Jim Blandy's avatar
Jim Blandy committed
218 219 220 221 222 223 224 225 226 227
		 "\\|[-+]?[0-9][0-9][0-9][0-9]"
		 "\\|"
		 "\\) *")))
    (concat
     "From "

     ;; Username, perhaps with a quoted section that can contain spaces.
     "\\("
     "[^ \n]*"
     "\\(\\|\".*\"[^ \n]*\\)"
228
     "\\|<[^<>\n]+>"
Jim Blandy's avatar
Jim Blandy committed
229 230 231 232
     "\\)  ?"

     ;; The time the message was sent.
     "\\([^ \n]*\\) *"			; day of the week
233
     "\\([^ \n]*\\) *"			; month
Jim Blandy's avatar
Jim Blandy committed
234 235 236 237 238 239 240 241 242 243 244 245 246
     "\\([0-9]*\\) *"			; day of month
     "\\([0-9:]*\\) *"			; time of day

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

     ;; The year.
     " [0-9][0-9]\\([0-9]*\\) *"

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

Karl Heuer's avatar
Karl Heuer committed
247 248
     ;; Old uucp cruft.
     "\\(remote from .*\\)?"
Jim Blandy's avatar
Jim Blandy committed
249 250 251 252

     "\n"))
  nil)

253 254 255
;; 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)
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
  (` (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
275 276 277 278 279 280

;;;; *** Rmail Mode ***

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

285 286 287
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
288 289 290
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
291
  (interactive (if current-prefix-arg
292
		   (list (read-file-name "Run rmail on RMAIL file: "))))
Roland McGrath's avatar
Roland McGrath committed
293 294 295 296 297 298 299 300
  (let* ((file-name (expand-file-name (or file-name-arg rmail-file-name)))
	 (existed (get-file-buffer file-name)))
    ;; 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.
301
	  (let ((enable-local-variables nil))
Roland McGrath's avatar
Roland McGrath committed
302
	    (find-file file-name))
303 304
	  (if (and (verify-visited-file-modtime existed)
		   (eq major-mode 'rmail-mode))
Roland McGrath's avatar
Roland McGrath committed
305 306
	      (progn (rmail-forget-messages)
		     (rmail-set-message-counters))))
307
      (let ((enable-local-variables nil))
Roland McGrath's avatar
Roland McGrath committed
308
	(find-file file-name)))
309 310
    (if (eq major-mode 'rmail-edit-mode)
	(error "Exit Rmail Edit mode before getting new mail."))
Roland McGrath's avatar
Roland McGrath committed
311 312 313 314 315 316 317 318 319 320 321 322
    (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)
	    (rmail-mode-2))
      (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))))
323 324 325
    (or (and (null file-name-arg)
	     (rmail-get-new-mail))
	(rmail-show-message (rmail-first-unseen-message)))
326 327
    (if rmail-display-summary (rmail-summary))
    (rmail-construct-io-menu)))
Roland McGrath's avatar
Roland McGrath committed
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 354 355 356 357 358

;; 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")))
359 360 361
	  ((equal (point-min) (point-max))
	   ;; Empty RMAIL file.  Just insert the header.
	   (rmail-insert-rmail-file-header))
Roland McGrath's avatar
Roland McGrath committed
362
	  (t
363
	   ;; Non-empty file in non-RMAIL format.  Add header and convert.
Roland McGrath's avatar
Roland McGrath committed
364 365 366 367 368 369
	   (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
370 371
	    (save-excursion
	      (goto-char (point-max))
372 373
	      (search-backward "\n\^_")
	      (forward-char 2)
374
	      (looking-at "\n*From ")))
Roland McGrath's avatar
Roland McGrath committed
375 376
	(let ((buffer-read-only nil))
	  (message "Converting to Babyl format...")
377 378 379 380 381
	  ;; 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)
382
	  (narrow-to-region (point) (point-max))
Roland McGrath's avatar
Roland McGrath committed
383 384 385
	  (rmail-convert-to-babyl-format)
	  (message "Converting to Babyl format...done")))))

386 387
;;; 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
388 389 390 391 392 393 394 395 396 397 398 399 400 401

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

(if rmail-mode-map
    nil
  (setq rmail-mode-map (make-keymap))
  (suppress-keymap rmail-mode-map)
402 403 404 405 406 407 408 409 410 411 412 413 414
  (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
415 416 417 418
  (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)
419 420 421 422 423 424 425 426 427 428 429 430 431
  (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)
432
;; I find I can't live without the default M-r command -- rms.
433 434 435 436 437 438 439 440 441 442 443 444 445
;;  (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)
446 447 448 449 450 451
  (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)
452
  (define-key rmail-mode-map "\C-c\C-s\C-k" 'rmail-sort-by-keywords)
453 454
  (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)
455
  )
456 457 458 459 460 461

(define-key rmail-mode-map [menu-bar] (make-sparse-keymap))

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

462
(define-key rmail-mode-map [menu-bar classify input-menu]
463
  nil)
464 465

(define-key rmail-mode-map [menu-bar classify output-menu]
466
  nil)
467

468
(define-key rmail-mode-map [menu-bar classify output-inbox]
469
  '("Output (inbox)..." . rmail-output))
470 471

(define-key rmail-mode-map [menu-bar classify output]
472
  '("Output (Rmail)..." . rmail-output-to-rmail-file))
473 474

(define-key rmail-mode-map [menu-bar classify kill-label]
475
  '("Kill Label..." . rmail-kill-label))
476 477

(define-key rmail-mode-map [menu-bar classify add-label]
478
  '("Add Label..." . rmail-add-label))
479 480 481 482

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

483 484 485
(define-key rmail-mode-map [menu-bar summary senders]
  '("By Senders..." . rmail-summary-by-senders))

486
(define-key rmail-mode-map [menu-bar summary labels]
487
  '("By Labels..." . rmail-summary-by-labels))
488 489

(define-key rmail-mode-map [menu-bar summary recipients]
490
  '("By Recipients..." . rmail-summary-by-recipients))
491 492

(define-key rmail-mode-map [menu-bar summary topic]
493
  '("By Topic..." . rmail-summary-by-topic))
494 495

(define-key rmail-mode-map [menu-bar summary regexp]
496
  '("By Regexp..." . rmail-summary-by-regexp))
497 498 499 500 501 502

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

504
(define-key rmail-mode-map [menu-bar mail rmail-get-new-mail]
505 506 507
  '("Get New Mail" . rmail-get-new-mail))

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

510 511 512
(define-key rmail-mode-map [menu-bar mail continue]
  '("Continue" . rmail-continue))

513
(define-key rmail-mode-map [menu-bar mail resend]
514
  '("Re-send..." . rmail-resend))
515

516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
(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
533

534 535 536 537 538 539 540 541 542 543 544 545 546
(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]
547
  '("Search Back..." . rmail-search-backwards))
548 549

(define-key rmail-mode-map [menu-bar move search]
550
  '("Search..." . rmail-search))
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569

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

573 574 575
(defun rmail-mode-kill-summary ()
  (if rmail-summary-buffer (kill-buffer rmail-summary-buffer)))

576
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
(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.
597
\\[rmail-edit-current-message]	Edit the current message.  \\[rmail-cease-edit] to return to Rmail.
Roland McGrath's avatar
Roland McGrath committed
598 599 600 601
\\[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.
602
\\[rmail-get-new-mail]	Move new mail from system spool directory into this file.
Roland McGrath's avatar
Roland McGrath committed
603 604
\\[rmail-mail]	Mail a message (same as \\[mail-other-window]).
\\[rmail-continue]	Continue composing outgoing message started before.
605 606
\\[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
607 608 609 610 611 612 613 614 615
\\[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.
616
          Any other label is present only if you add it with \\[rmail-add-label].
Roland McGrath's avatar
Roland McGrath committed
617 618
\\[rmail-previous-labeled-message]   Move to Previous message with specified label
\\[rmail-summary]	Show headers buffer, with a one line summary of each message.
619 620 621 622 623
\\[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
624 625 626
  (interactive)
  (rmail-mode-2)
  (rmail-set-message-counters)
627
  (rmail-show-message rmail-total-messages))
Roland McGrath's avatar
Roland McGrath committed
628 629 630 631 632 633 634 635 636 637 638

(defun rmail-mode-2 ()
  (kill-all-local-variables)
  (rmail-mode-1)
  (rmail-variables)
  (run-hooks 'rmail-mode-hook))

(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
639 640 641 642 643
  ;; 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
644 645 646 647 648 649 650 651 652 653 654 655
  (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)
656
  (make-local-variable 'font-lock-defaults)
657 658
  (setq font-lock-defaults
   '(rmail-font-lock-keywords t nil nil nil
659 660 661
     (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
662
  (make-local-variable 'rmail-last-label)
663
  (make-local-variable 'rmail-last-regexp)
Roland McGrath's avatar
Roland McGrath committed
664 665 666 667 668 669 670
  (make-local-variable 'rmail-deleted-vector)
  (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)
671 672
  (make-local-variable 'rmail-overlay-list)
  (setq rmail-overlay-list nil)
Roland McGrath's avatar
Roland McGrath committed
673 674
  (make-local-variable 'version-control)
  (setq version-control 'never)
675 676
  (make-local-variable 'kill-buffer-hook)
  (add-hook 'kill-buffer-hook 'rmail-mode-kill-summary)
Roland McGrath's avatar
Roland McGrath committed
677 678 679 680 681
  (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))
682 683
  ;; Provide default set of inboxes for primary mail file ~/RMAIL.
  (and (null rmail-inbox-list)
684
       (or (equal buffer-file-name (expand-file-name rmail-file-name))
685 686
	   (equal buffer-file-truename
		  (abbreviate-file-name (file-truename rmail-file-name))))
687 688 689 690
       (setq rmail-inbox-list
	     (or rmail-primary-inbox-list
		 (list (or (getenv "MAIL")
			   (concat rmail-spool-directory
691
				   (user-login-name)))))))
Roland McGrath's avatar
Roland McGrath committed
692 693
  (make-local-variable 'rmail-keywords)
  ;; this gets generated as needed
694
  (setq rmail-keywords nil))
Roland McGrath's avatar
Roland McGrath committed
695 696 697

;; Handle M-x revert-buffer done in an rmail-mode buffer.
(defun rmail-revert (arg noconfirm)
698
  (let ((revert-buffer-function (default-value 'revert-buffer-function)))
Roland McGrath's avatar
Roland McGrath committed
699 700 701 702 703 704 705
    ;; 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))
706
	  (rmail-mode)))))
Roland McGrath's avatar
Roland McGrath committed
707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729

;; 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)
730 731 732
  (save-buffer)
  (if (rmail-summary-exists)
      (rmail-select-summary (set-buffer-modified-p nil))))
Roland McGrath's avatar
Roland McGrath committed
733 734 735 736 737 738 739

(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
740 741 742
      (progn
	(replace-buffer-in-windows rmail-summary-buffer)
	(bury-buffer rmail-summary-buffer)))
Roland McGrath's avatar
Roland McGrath committed
743
  (let ((obuf (current-buffer)))
744
    (replace-buffer-in-windows obuf)
Roland McGrath's avatar
Roland McGrath committed
745 746
    (bury-buffer obuf)))

747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
(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
777 778
;;;###autoload
(defun rmail-input (filename)
779
  "Run Rmail on file FILENAME."
Roland McGrath's avatar
Roland McGrath committed
780 781 782
  (interactive "FRun rmail on RMAIL file: ")
  (rmail filename))

783 784 785 786
;; Return a list of file names for all files in or under START
;; whose names match rmail-secondary-file-regexp.
;; This includes START itself, if that name matches.
;; But normally START is a directory.
787 788
(defun rmail-find-all-files (start)
  (if (file-accessible-directory-p start)
789 790 791
      ;; Don't sort here.
      (let ((files (directory-files start t
				    rmail-secondary-file-regexp t))
792 793
	    (ret nil)
	    file)
794 795 796
	(while files
	  (setq file (car files))
	  (setq files (cdr files))
797 798 799 800
	  (or (member (file-name-nondirectory start) '("." ".."))
	      (setq ret (nconc
			 (rmail-find-all-files file)
			 ret))))
801 802 803
	;; Sort here instead of in directory-files
	;; because this list is usually much shorter.
	(sort ret 'string<))
804 805 806
    (let ((case-fold-search nil))
      (if (string-match rmail-secondary-file-regexp start)
	  (list (file-name-nondirectory start))))))
807 808 809 810 811

(defun rmail-list-to-menu (menu-name l action &optional full-name)
  (let ((menu (make-sparse-keymap menu-name)))
    (mapcar
     (function (lambda (item)
812 813 814 815 816 817 818 819 820 821 822
		 (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)))
823
		     (progn
824 825 826 827 828 829 830 831 832 833 834
		       (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)))))
835
     (reverse l))
836 837
    menu))
 
838 839 840
;; This command is always "disabled" when it appears in a menu.
(put 'rmail-disable-menu 'menu-enable ''nil)

841 842
(defun rmail-construct-io-menu ()
  (let ((files (rmail-find-all-files rmail-secondary-file-directory)))
843
    (if files
844 845 846 847
	(progn
	  (define-key rmail-mode-map [menu-bar classify input-menu]
	    (cons "Input Rmail File" 
		  (rmail-list-to-menu "Input Rmail File" 
848
				      files
849 850 851 852
				      'rmail-input)))
	  (define-key rmail-mode-map [menu-bar classify output-menu]
	    (cons "Output Rmail File" 
		  (rmail-list-to-menu "Output Rmail File" 
853 854 855 856 857 858 859
				      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)))))
860

Roland McGrath's avatar
Roland McGrath committed
861 862 863 864 865 866 867 868 869 870

;;;; *** 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
871 872
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
873 874 875 876

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
877 878
argument causes us to read a file name and use that file as the inbox.

879 880
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
881 882 883
  (interactive
   (list (if current-prefix-arg
	     (read-file-name "Get new mail from file: "))))
884 885
  ;; 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
886
  (or (verify-visited-file-modtime (current-buffer))
887
      (find-file (buffer-file-name)))
Roland McGrath's avatar
Roland McGrath committed
888 889 890 891 892 893 894 895 896 897 898 899 900 901
  (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))
  (unwind-protect
      (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.
902 903
	    (buffer-undo-list t)
	    success)
Roland McGrath's avatar
Roland McGrath committed
904 905 906 907 908 909 910 911 912 913 914 915 916 917
	(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 (list file-name) nil)
	      (setq delete-files (rmail-insert-inbox-text rmail-inbox-list t)))
	    ;; Scan the new text and convert each message to babyl format.
	    (goto-char (point-min))
918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
	    (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 ((files delete-files)
			(count 0))
		    (while files
		      (while (file-exists-p (format "RMAILOSE.%d" count))
			(setq count (1+ count)))
		      (rename-file (car files)
				   (format "RMAILOSE.%d" count))
		      (setq files (cdr files))))))
Roland McGrath's avatar
Roland McGrath committed
934 935 936
	    (or (zerop new-messages)
		(let (success)
		  (widen)
937
		  (search-backward "\n\^_" nil t)
Roland McGrath's avatar
Roland McGrath committed
938 939 940
		  (narrow-to-region (point) (point-max))
		  (goto-char (1+ (point-min)))
		  (rmail-count-new-messages)
941
		  (run-hooks 'rmail-get-new-mail-hook)
Roland McGrath's avatar
Roland McGrath committed
942 943 944 945
		  (save-buffer)))
	    ;; Delete the old files, now that babyl file is saved.
	    (while delete-files
	      (condition-case ()
Richard M. Stallman's avatar
Richard M. Stallman committed
946 947 948 949 950 951
		  ;; 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))))
Roland McGrath's avatar
Roland McGrath committed
952 953 954 955 956
		(file-error nil))
	      (setq delete-files (cdr delete-files)))))
	(if (= new-messages 0)
	    (progn (goto-char opoint)
		   (if (or file-name rmail-inbox-list)
957 958
		       (message "(No new mail has arrived)"))
		   nil)
959 960 961
	  (if (rmail-summary-exists)
	      (rmail-select-summary
		(rmail-update-summary)))
Roland McGrath's avatar
Roland McGrath committed
962 963
	  (message "%d new message%s read"
		   new-messages (if (= 1 new-messages) "" "s"))
964 965 966
	  ;; Move to the first new message
	  ;; unless we have other unseen messages before it.
	  (rmail-show-message (rmail-first-unseen-message))
967
	  (run-hooks 'rmail-after-get-new-mail-hook)
968
	  t))
Roland McGrath's avatar
Roland McGrath committed
969 970 971 972
    ;; Don't leave the buffer screwed up if we get a disk-full error.
    (rmail-show-message)))

(defun rmail-insert-inbox-text (files renamep)
973
  (let (file tofile delete-files movemail popmail)
Roland McGrath's avatar
Roland McGrath committed
974
    (while files
975 976
      (setq file (file-truename
		  (expand-file-name (substitute-in-file-name (car files))))
977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997
	    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)))
998 999
      (if popmail (setq file (file-name-nondirectory file)
			renamep t))
Roland McGrath's avatar
Roland McGrath committed
1000 1001 1002 1003 1004
      (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)
1005
		(setq file (expand-file-name (user-login-name)
Roland McGrath's avatar
Roland McGrath committed
1006
					     file)))))
1007
      (cond (popmail
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
	     (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)))))
1020 1021 1022 1023 1024 1025 1026
	     (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
1027 1028 1029 1030
      ;; 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))
1031 1032
	    ((or (file-exists-p tofile) (and (not popmail)
					     (not (file-exists-p file))))
Roland McGrath's avatar
Roland McGrath committed
1033
	     nil)
1034
	    ((and (not movemail) (not popmail))
1035 1036 1037 1038 1039
	     ;; Try copying.  If that fails (perhaps no space),
	     ;; rename instead.
	     (condition-case nil
		 (copy-file file tofile nil)
	       (error
1040 1041
		;; 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
1042 1043 1044 1045 1046 1047
	     ;; Make the real inbox file empty.
	     ;; Leaving it deleted could cause lossage
	     ;; because mailers often won't create the file.
	     (condition-case ()
		 (write-region (point) (point) file)
	       (file-error nil)))
Roland McGrath's avatar
Roland McGrath committed
1048 1049 1050 1051 1052 1053
	    (t
	     (let ((errors nil))
	       (unwind-protect
		   (save-excursion
		     (setq errors (generate-new-buffer " *rmail loss*"))
		     (buffer-disable-undo errors)
1054 1055 1056 1057 1058 1059 1060 1061 1062
		     (if rmail-pop-password
			 (call-process
			  (or rmail-movemail-program
			      (expand-file-name "movemail" exec-directory))
			  nil errors nil file tofile rmail-pop-password)
		       (call-process
			(or rmail-movemail-program
			    (expand-file-name "movemail" exec-directory))
			nil errors nil file tofile))
Roland McGrath's avatar
Roland McGrath committed
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
		     (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)
1076 1077 1078
		       (message "movemail: %s"
				(buffer-substring (point-min)
						  (point-max)))
Roland McGrath's avatar
Roland McGrath committed
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
		       (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)
	  (let (size)
	    (goto-char (point-max))
	    (setq size (nth 1 (insert-file-contents tofile)))
	    (goto-char (point-max))
	    (or (= (preceding-char) ?\n)
		(zerop size)
		(insert ?\n))
	    (setq delete-files (cons tofile delete-files))))
      (message "")
      (setq files (cdr files)))
    delete-files))

1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
(defun rmail-read-passwd (prompt &optional default)
  "Read a password, echoing `.' for each character typed.
End with RET, LFD, or ESC.  DEL or C-h rubs out.  C-u kills line.
Optional DEFAULT is password to start with."
  (let ((pass (if default default ""))
	(c 0)
	(echo-keystrokes 0)
	(cursor-in-echo-area t))
    (while (progn (message "%s%s"
			   prompt
			   (make-string (length pass) ?.))
		  (setq c (read-char))
		  (and (/= c ?\r) (/= c ?\n) (/= c ?\e)))
      (if (= c ?\C-u)
	  (setq pass "")
	(if (and (/= c ?\b) (/= c ?\177))
	    (setq pass (concat pass (char-to-string c)))
	  (if (> (length pass) 0)
	      (setq pass (substring pass 0 -1))))))
    (message "")
    (message nil)
    pass))

Roland McGrath's avatar
Roland McGrath committed
1121 1122 1123
;; the  rmail-break-forwarded-messages  feature is not implemented
(defun rmail-convert-to-babyl-format ()
  (let ((count 0) start
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
	(case-fold-search nil)
	(invalid-input-resync
	 (function (lambda ()
		     (message "Invalid Babyl format in inbox!")
		     (sit-for 1)
		     ;; Try to get back in sync with a real message.
		     (if (re-search-forward
			  (concat mmdf-delim1 "\\|^From") nil t)
			 (beginning-of-line)
		       (goto-char (point-max)))))))
Roland McGrath's avatar
Roland McGrath committed
1134 1135 1136 1137
    (goto-char (point-min))
    (save-restriction
      (while (not (eobp))
	(cond ((looking-at "BABYL OPTIONS:");Babyl header
1138 1139 1140 1141
	       (if (search-forward "\n\^_" nil t)
		   ;; If we find the proper terminator, delete through there.
		   (delete-region (point-min) (point))
		 (funcall invalid-input-resync)
1142
		 (delete-region (point-min) (point))))
Roland McGrath's avatar
Roland McGrath committed
1143 1144 1145
	      ;; Babyl format message
	      ((looking-at "\^L")
	       (or (search-forward "\n\^_" nil t)
1146
		   (funcall invalid-input-resync))
Roland McGrath's avatar
Roland McGrath committed
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177
	       (setq count (1+ count))
	       ;; Make sure there is no extra white space after the ^_
	       ;; at the end of the message.
	       ;; Narrowing will make sure that whatever follows the junk
	       ;; will be treated properly.
	       (delete-region (point)
			      (save-excursion
				(skip-chars-forward " \t\n")
				(point)))
	       (narrow-to-region (point) (point-max)))
	      ;;*** MMDF format
	      ((let ((case-fold-search t))
		 (looking-at mmdf-delim1))
	       (let ((case-fold-search t))
		 (replace-match "\^L\n0, unseen,,\n*** EOOH ***\n")
		 (setq start (point))
		 (re-search-forward mmdf-delim2 nil t)
		 (replace-match "\^_"))
	       (save-excursion
		 (save-restriction
		   (narrow-to-region start (1- (point)))
		   (goto-char (point-min))
		   (while (search-forward "\n\^_" nil t); single char "\^_"
		     (replace-match "\n^_")))); 2 chars: "^" and "_"
	       (narrow-to-region (point) (point-max))
	       (setq count (1+ count)))
	      ;;*** Mail format
	      ((looking-at "^From ")
	       (setq start (point))
	       (insert "\^L\n0, unseen,,\n*** EOOH ***\n")
	       (rmail-nuke-pinhead-header)
1178 1179 1180 1181
	       ;; If this message has a Content-Length field,
	       ;; skip to the end of the contents.
	       (let* ((header-end (save-excursion
				    (and (re-search-forward "\n\n" nil t)
1182
					 (1- (point)))))
1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
		      (case-fold-search t)
		      (size
		       ;; Get the numeric value from the Content-Length field.
		       (save-excursion
			 ;; Back up to end of prev line,
			 ;; in case the Content-Length field comes first.
			 (forward-char -1)
			 (and (search-forward "\ncontent-length: "
					      header-end t)
			      (let ((beg (point))
				    (eol (progn (end-of-line) (point))))
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
				(string-to-int (buffer-substring beg eol)))))))
		 (and size
		      (if (and (natnump size)
			       (<= (+ header-end size) (point-max))
			       ;; Make sure this would put us at a position
			       ;; that we could continue from.
			       (save-excursion
				 (goto-char (+ header-end size))
				 (skip-chars-forward "\n")
				 (or (eobp)
				     (and (looking-at "BABYL OPTIONS:")
					  (search-forward "\n\^_" nil t))
				     (and (looking-at "\^L")
					  (search-forward "\n\^_" nil t))
				     (let ((case-fold-search t))
				       (looking-at mmdf-delim1))
				     (looking-at "From "))))
			  (goto-char (+ header-end size))
			(message "Ignoring invalid Content-Length field")
			(sit-for 1 0 t))))
1214

Roland McGrath's avatar
Roland McGrath committed
1215 1216
	       (if (re-search-forward
		    (concat "^[\^_]?\\("
Jim Blandy's avatar
Jim Blandy committed
1217 1218
			    rmail-unix-mail-delimiter
			    "\\|"
Roland McGrath's avatar
Roland McGrath committed
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233
			    mmdf-delim1 "\\|"
			    "^BABYL OPTIONS:\\|"
			    "\^L\n[01],\\)") nil t)
		   (goto-char (match-beginning 1))
		 (goto-char (point-max)))
	       (setq count (1+ count))
	       (save-excursion
		 (save-restriction
		   (narrow-to-region start (point))
		   (goto-char (point-min))
		   (while (search-forward "\n\^_" nil t); single char
		     (replace-match "\n^_")))); 2 chars: "^" and "_"
	       (insert ?\^_)
	       (narrow-to-region (point) (point-max)))
	      ;;
1234 1235 1236 1237 1238
	      ;; This kludge is because some versions of sendmail.el
	      ;; insert an extra newline at the beginning that shouldn't
	      ;; be there.  sendmail.el has been fixed, but old versions
	      ;; may still be in use.  -- rms, 7 May 1993.
	      ((eolp) (delete-char 1))
1239
	      (t (error "Cannot convert to babyl format")))))
Roland McGrath's avatar
Roland McGrath committed
1240 1241 1242 1243
    count))

;; Delete the "From ..." line, creating various other headers with
;; information from it if they don't already exist.  Now puts the
1244 1245
;; original line into a mail-from: header line for debugging and for
;; use by the rmail-output function.
Roland McGrath's avatar
Roland McGrath committed
1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259