rmailout.el 10.1 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1 2
;;; rmailout.el --- "RMAIL" mail reader for Emacs: output message to a file.

3
;; Copyright (C) 1985, 1987, 1993 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

root's avatar
root 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)
root's avatar
root committed
13 14 15 16 17 18 19 20 21 22 23
;; 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
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

Eric S. Raymond's avatar
Eric S. Raymond committed
24
;;; Code:
root's avatar
root committed
25 26 27 28 29

;; Temporary until Emacs always has this variable.
(defvar rmail-delete-after-output nil
  "*Non-nil means automatically delete a message that is copied to a file.")

30 31
(defvar rmail-output-file-alist nil
  "*Alist matching regexps to suggested output Rmail files.
32
This is a list of elements of the form (REGEXP . NAME-EXP).
33
The suggestion is taken if REGEXP matches anywhere in the message buffer.
34 35 36
NAME-EXP may be a string constant giving the file name to use,
or more generally it may be any kind of expression that returns
a file name as a string.")
37

38 39 40
;;; There are functions elsewhere in Emacs that use this function; check
;;; them out before you change the calling method.
(defun rmail-output-to-rmail-file (file-name &optional count)
root's avatar
root committed
41 42 43 44
  "Append the current message to an Rmail file named FILE-NAME.
If the file does not exist, ask if it should be created.
If file is being visited, the message is appended to the Emacs
buffer visiting that file.
45 46 47
If the file exists and is not an Rmail file, 
the message is appended in inbox format.

Richard M. Stallman's avatar
Richard M. Stallman committed
48 49 50
The default file name comes from `rmail-last-rmail-file',
which is updated to the name you use in this command.

root's avatar
root committed
51 52
A prefix argument N says to output N consecutive messages
starting with the current one.  Deleted messages are skipped and don't count."
53 54 55 56 57 58 59 60 61
  (interactive
   (let ((default-file
	   (let (answer tail)
	     (setq tail rmail-output-file-alist)
	     ;; Suggest a file based on a pattern match.
	     (while (and tail (not answer))
	       (save-excursion
		 (goto-char (point-min))
		 (if (re-search-forward (car (car tail)) nil t)
62
		     (setq answer (eval (cdr (car tail)))))
63 64
		 (setq tail (cdr tail))))
	     ;; If not suggestions, use same file as last time.
65 66
	     (or answer rmail-default-rmail-file))))
     (list (setq rmail-default-rmail-file
67 68 69 70 71 72 73 74 75 76 77 78 79
		 (let ((read-file
			(read-file-name
			 (concat "Output message to Rmail file: (default "
				 (file-name-nondirectory default-file)
				 ") ")
			 (file-name-directory default-file)
			 default-file)))
		   (if (file-directory-p read-file)
		       (expand-file-name (file-name-nondirectory default-file)
					 read-file)
		     (expand-file-name
		      (or read-file default-file)
		      (file-name-directory default-file)))))
80
	   (prefix-numeric-value current-prefix-arg))))
81
  (or count (setq count 1))
Jim Blandy's avatar
Jim Blandy committed
82 83
  (setq file-name
	(expand-file-name file-name
84
			  (file-name-directory rmail-default-rmail-file)))
85 86 87 88 89 90 91 92 93
  (if (and (file-readable-p file-name) (not (rmail-file-p file-name)))
      (rmail-output file-name count)
    (rmail-maybe-set-message-counters)
    (setq file-name (abbreviate-file-name file-name))
    (or (get-file-buffer file-name)
	(file-exists-p file-name)
	(if (yes-or-no-p
	     (concat "\"" file-name "\" does not exist, create it? "))
	    (let ((file-buffer (create-file-buffer file-name)))
root's avatar
root committed
94
	      (save-excursion
95 96 97 98 99 100 101 102 103 104
		(set-buffer file-buffer)
		(rmail-insert-rmail-file-header)
		(let ((require-final-newline nil))
		  (write-region (point-min) (point-max) file-name t 1)))
	      (kill-buffer file-buffer))
	  (error "Output file does not exist")))
    (while (> count 0)
      (let (redelete)
	(unwind-protect
	    (progn
105 106 107 108 109 110
	      ;; Temporarily turn off Deleted attribute.
	      ;; Do this outside the save-restriction, since it would
	      ;; shift the place in the buffer where the visible text starts.
	      (if (rmail-message-deleted-p rmail-current-message)
		  (progn (setq redelete t)
			 (rmail-set-attribute "deleted" nil)))
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
	      (save-restriction
		(widen)
		;; Decide whether to append to a file or to an Emacs buffer.
		(save-excursion
		  (let ((buf (get-file-buffer file-name))
			(cur (current-buffer))
			(beg (1+ (rmail-msgbeg rmail-current-message)))
			(end (1+ (rmail-msgend rmail-current-message))))
		    (if (not buf)
			(append-to-file beg end file-name)
		      (if (eq buf (current-buffer))
			  (error "Can't output message to same file it's already in"))
		      ;; File has been visited, in buffer BUF.
		      (set-buffer buf)
		      (let ((buffer-read-only nil)
			    (msg (and (boundp 'rmail-current-message)
				      rmail-current-message)))
			;; If MSG is non-nil, buffer is in RMAIL mode.
			(if msg
			    (progn
131 132 133 134 135
			      ;; Turn on auto save mode, if it's off in this
			      ;; buffer but enabled by default.
			      (and (not buffer-auto-save-file-name)
				   auto-save-default
				   (auto-save-mode t))
136 137 138 139 140 141 142 143 144
			      (rmail-maybe-set-message-counters)
			      (widen)
			      (narrow-to-region (point-max) (point-max))
			      (insert-buffer-substring cur beg end)
			      (goto-char (point-min))
			      (widen)
			      (search-backward "\n\^_")
			      (narrow-to-region (point) (point-max))
			      (rmail-count-new-messages t)
145 146 147
			      (if (rmail-summary-exists)
				  (rmail-select-summary
				    (rmail-update-summary)))
148 149 150 151 152 153 154 155 156 157 158 159 160 161
			      (rmail-show-message msg))
		;; Output file not in rmail mode => just insert at the end.
		(narrow-to-region (point-min) (1+ (buffer-size)))
		(goto-char (point-max))
		(insert-buffer-substring cur beg end)))))))
	      (rmail-set-attribute "filed" t))
	  (if redelete (rmail-set-attribute "deleted" t))))
      (setq count (1- count))
      (if rmail-delete-after-output
	  (rmail-delete-forward)
	(if (> count 0)
	    (rmail-next-undeleted-message 1))))))

;; Returns t if file FILE is an Rmail file.
162
;;;###autoload
163 164 165 166 167 168 169 170
(defun rmail-file-p (file)
  (let ((buf (generate-new-buffer " *rmail-file-p*")))
    (unwind-protect
	(save-excursion
	  (set-buffer buf)
	  (insert-file-contents file nil 0 100)
	  (looking-at "BABYL OPTIONS:"))
      (kill-buffer buf))))
root's avatar
root committed
171

172 173
;;; There are functions elsewhere in Emacs that use this function; check
;;; them out before you change the calling method.
174
(defun rmail-output (file-name &optional count noattribute from-gnus)
root's avatar
root committed
175 176
  "Append this message to Unix mail file named FILE-NAME.
A prefix argument N says to output N consecutive messages
177
starting with the current one.  Deleted messages are skipped and don't count.
178 179
When called from lisp code, N may be omitted.

180 181 182 183
If the pruned message header is shown on the current message, then
messages will be appended with pruned headers; otherwise, messages
will be appended with their original headers.

Richard M. Stallman's avatar
Richard M. Stallman committed
184 185 186
The default file name comes from `rmail-last-file',
which is updated to the name you use in this command.

187
The optional third argument NOATTRIBUTE, if non-nil, says not
188 189 190
to set the `filed' attribute, and not to display a message.

The optional fourth argument FROM-GNUS is set when called from GNUS."
root's avatar
root committed
191
  (interactive
192
   (list (setq rmail-default-file
193 194
	       (read-file-name
		(concat "Output message to Unix mail file"
195
			(if rmail-default-file
196
			    (concat " (default "
197
				    (file-name-nondirectory rmail-default-file)
198 199
				    "): " )
			  ": "))			
200 201
		(and rmail-default-file (file-name-directory rmail-default-file))
		rmail-default-file))
202 203
	 (prefix-numeric-value current-prefix-arg)))
  (or count (setq count 1))
Jim Blandy's avatar
Jim Blandy committed
204 205
  (setq file-name
	(expand-file-name file-name
206 207
			  (and rmail-default-file
			       (file-name-directory rmail-default-file))))
208
  (if (and (file-readable-p file-name) (rmail-file-p file-name))
209
      (rmail-output-to-rmail-file file-name count)
210 211 212 213 214
    (let ((orig-count count)
	  (rmailbuf (current-buffer))
	  (case-fold-search t)
	  (tembuf (get-buffer-create " rmail-output"))
	  (original-headers-p
215 216 217 218 219 220 221
	   (and (not from-gnus)
		(save-excursion 
		  (save-restriction
		    (narrow-to-region (rmail-msgbeg rmail-current-message) (point-max))
		    (goto-char (point-min))
		    (forward-line 1)
		    (= (following-char) ?0)))))
222 223 224
	  header-beginning
	  mail-from)
      (while (> count 0)
225 226 227 228 229 230 231 232 233 234
	(or from-gnus
	    (setq mail-from
		  (save-excursion
		    (save-restriction
		      (widen)
		      (goto-char (rmail-msgbeg rmail-current-message))
		      (setq header-beginning (point))
		      (search-forward "\n*** EOOH ***\n")
		      (narrow-to-region header-beginning (point))
		      (mail-fetch-field "Mail-From")))))
235 236 237 238 239 240
	(save-excursion
	  (set-buffer tembuf)
	  (erase-buffer)
	  (insert-buffer-substring rmailbuf)
	  (insert "\n")
	  (goto-char (point-min))
241 242 243 244 245 246 247 248
	  (if mail-from
	      (insert mail-from "\n")
	    (insert "From "
		    (mail-strip-quoted-names (or (mail-fetch-field "from")
						 (mail-fetch-field "really-from")
						 (mail-fetch-field "sender")
						 "unknown"))
		    " " (current-time-string) "\n"))
249 250 251 252 253 254
	  ;; ``Quote'' "\nFrom " as "\n>From "
	  ;;  (note that this isn't really quoting, as there is no requirement
	  ;;   that "\n[>]+From " be quoted in the same transparent way.)
	  (while (search-forward "\nFrom " nil t)
	    (forward-char -5)
	    (insert ?>))
255 256
	  (write-region (point-min) (point-max) file-name t
			(if noattribute 'nomsg)))
257 258 259 260
	(or noattribute
	    (if (equal major-mode 'rmail-mode)
		(rmail-set-attribute "filed" t)))
	(setq count (1- count))
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
	(or from-gnus
	    (let ((next-message-p
		   (if rmail-delete-after-output
		       (rmail-delete-forward)
		     (if (> count 0)
			 (rmail-next-undeleted-message 1))))
		  (num-appended (- orig-count count)))
	      (if (and next-message-p original-headers-p)
		  (rmail-toggle-header))
	      (if (and (> count 0) (not next-message-p))
		  (progn 
		    (error
		     (save-excursion
		       (set-buffer rmailbuf)
		       (format "Only %d message%s appended" num-appended
			       (if (= num-appended 1) "" "s"))))
		    (setq count 0))))))
278
      (kill-buffer tembuf))))
Eric S. Raymond's avatar
Eric S. Raymond committed
279 280

;;; rmailout.el ends here