rmailout.el 13.5 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.

Karl Heuer's avatar
Karl Heuer committed
3
;; Copyright (C) 1985, 1987, 1993, 1994 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
;; 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.
root's avatar
root committed
24

Eric S. Raymond's avatar
Eric S. Raymond committed
25
;;; Code:
root's avatar
root committed
26

27 28
(require 'rmail)

29
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
30
(defcustom rmail-output-file-alist nil
31
  "*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
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
Richard M. Stallman's avatar
Richard M. Stallman committed
36 37 38 39 40 41
a file name as a string."
  :type '(repeat (cons regexp
		       (choice :value ""
			       (string :tag "File Name")
			       sexp)))
  :group 'rmail-output)
42

43 44
;;; There are functions elsewhere in Emacs that use this function;
;;; look at them before you change the calling method.
45
;;;###autoload
46
(defun rmail-output-to-rmail-file (file-name &optional count)
root's avatar
root committed
47 48 49 50
  "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.
51 52
If the file exists and is not an Rmail file, the message is
appended in inbox format, the same way `rmail-output' does it.
53

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

root's avatar
root committed
57 58
A prefix argument N says to output N consecutive messages
starting with the current one.  Deleted messages are skipped and don't count."
59 60 61 62 63 64 65 66 67
  (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)
68
		     (setq answer (eval (cdr (car tail)))))
69 70
		 (setq tail (cdr tail))))
	     ;; If not suggestions, use same file as last time.
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
	     (expand-file-name (or answer rmail-default-rmail-file)))))
     (let ((read-file
	    (expand-file-name
	     (read-file-name
	      (concat "Output message to Rmail file: (default "
		      (file-name-nondirectory default-file)
		      ") ")
	      (file-name-directory default-file)
	      default-file)
	     (file-name-directory default-file))))
       ;; If the user enters just a directory,
       ;; use the name within that directory chosen by the default.
       (setq rmail-default-rmail-file
	     (if (file-directory-p read-file)
		 (expand-file-name (file-name-nondirectory default-file)
				   read-file)
	       read-file)))
     (list rmail-default-rmail-file
89
	   (prefix-numeric-value current-prefix-arg))))
90
  (or count (setq count 1))
Jim Blandy's avatar
Jim Blandy committed
91 92
  (setq file-name
	(expand-file-name file-name
93
			  (file-name-directory rmail-default-rmail-file)))
94
  (if (and (file-readable-p file-name) (not (mail-file-babyl-p file-name)))
95 96 97
      (rmail-output file-name count)
    (rmail-maybe-set-message-counters)
    (setq file-name (abbreviate-file-name file-name))
98
    (or (find-buffer-visiting file-name)
99 100 101 102
	(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
103
	      (save-excursion
104 105 106 107 108 109 110 111 112 113
		(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
114 115 116 117 118 119
	      ;; 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)))
120 121 122 123
	      (save-restriction
		(widen)
		;; Decide whether to append to a file or to an Emacs buffer.
		(save-excursion
124
		  (let ((buf (find-buffer-visiting file-name))
125 126
			(cur (current-buffer))
			(beg (1+ (rmail-msgbeg rmail-current-message)))
127 128 129 130
			(end (1+ (rmail-msgend rmail-current-message)))
			(coding-system-for-write
			 (or rmail-file-coding-system
			     'emacs-mule-unix)))
131
		    (if (not buf)
132 133 134 135 136 137 138 139 140 141 142
			;; Output to a file.
			(if rmail-fields-not-to-output
			    ;; Delete some fields while we output.
			    (let ((obuf (current-buffer)))
			      (set-buffer (get-buffer-create " rmail-out-temp"))
			      (insert-buffer-substring obuf beg end)
			      (rmail-delete-unwanted-fields)
			      (append-to-file (point-min) (point-max) file-name)
			      (set-buffer obuf)
			      (kill-buffer (get-buffer " rmail-out-temp")))
			  (append-to-file beg end file-name))
143 144 145 146 147 148 149 150 151 152
		      (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
153 154 155 156 157
			      ;; 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))
158 159 160 161 162 163 164 165
			      (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))
166
			      (rmail-delete-unwanted-fields)
167
			      (rmail-count-new-messages t)
168 169 170
			      (if (rmail-summary-exists)
				  (rmail-select-summary
				    (rmail-update-summary)))
171
			      (rmail-show-message msg))
172 173 174 175 176
			  ;; 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-delete-unwanted-fields)))))))
177 178 179 180
	      (rmail-set-attribute "filed" t))
	  (if redelete (rmail-set-attribute "deleted" t))))
      (setq count (1- count))
      (if rmail-delete-after-output
181
	  (unless (rmail-delete-forward) (setq count 0))
182
	(if (> count 0)
183
	    (unless (rmail-next-undeleted-message 1) (setq count 0)))))))
184

185
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
186 187 188 189 190
(defcustom rmail-fields-not-to-output nil
  "*Regexp describing fields to exclude when outputting a message to a file."
  :type '(choice (const :tag "None" nil)
		 regexp)
  :group 'rmail-output)
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208

;; Delete from the buffer header fields we don't want output.
;; NOT-RMAIL if t means this buffer does not have the full header
;; and *** EOOH *** that a message in an Rmail file has.
(defun rmail-delete-unwanted-fields (&optional not-rmail)
  (if rmail-fields-not-to-output 
      (save-excursion
	(goto-char (point-min))
	;; Find the end of the header.
	(if (and (or not-rmail (search-forward "\n*** EOOH ***\n" nil t))
		 (search-forward "\n\n" nil t))
	    (let ((end (point-marker)))
	      (goto-char (point-min))
	      (while (re-search-forward rmail-fields-not-to-output end t)
		(beginning-of-line)
		(delete-region (point)
			       (progn (forward-line 1) (point)))))))))

209 210
;;; There are functions elsewhere in Emacs that use this function;
;;; look at them before you change the calling method.
211
;;;###autoload
212
(defun rmail-output (file-name &optional count noattribute from-gnus)
Richard M. Stallman's avatar
Richard M. Stallman committed
213
  "Append this message to system-inbox-format mail file named FILE-NAME.
root's avatar
root committed
214
A prefix argument N says to output N consecutive messages
215
starting with the current one.  Deleted messages are skipped and don't count.
216 217
When called from lisp code, N may be omitted.

218 219 220 221
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
222
The default file name comes from `rmail-default-file',
Richard M. Stallman's avatar
Richard M. Stallman committed
223 224
which is updated to the name you use in this command.

225
The optional third argument NOATTRIBUTE, if non-nil, says not
226 227 228
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
229
  (interactive
230 231 232 233 234 235 236 237 238 239
   (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)
		     (setq answer (eval (cdr (car tail)))))
		 (setq tail (cdr tail))))
240
	     ;; If no suggestion, use same file as last time.
241 242 243 244 245 246 247
	     (or answer rmail-default-file))))
     (list (setq rmail-default-file
		 (let ((read-file
			(read-file-name
			 (concat "Output message to Unix mail file: (default "
				 (file-name-nondirectory default-file)
				 ") ")
248 249
			 (file-name-directory (expand-file-name default-file))
			 (expand-file-name default-file))))
250 251 252 253
		   (if (file-directory-p read-file)
		       (expand-file-name (file-name-nondirectory default-file)
					 read-file)
		     (expand-file-name
254
		      (or read-file (file-name-nondirectory default-file))
255 256
		      (file-name-directory default-file)))))
	   (prefix-numeric-value current-prefix-arg))))
257
  (or count (setq count 1))
Jim Blandy's avatar
Jim Blandy committed
258 259
  (setq file-name
	(expand-file-name file-name
260 261
			  (and rmail-default-file
			       (file-name-directory rmail-default-file))))
262
  (if (and (file-readable-p file-name) (mail-file-babyl-p file-name))
263
      (rmail-output-to-rmail-file file-name count)
264 265 266 267 268
    (let ((orig-count count)
	  (rmailbuf (current-buffer))
	  (case-fold-search t)
	  (tembuf (get-buffer-create " rmail-output"))
	  (original-headers-p
269 270 271 272 273 274 275
	   (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)))))
276
	  header-beginning
277
	  mail-from mime-version)
278
      (while (> count 0)
279 280
	;; Preserve the Mail-From and MIME-Version fields
	;; even if they have been pruned.
281
	(or from-gnus
282 283 284 285 286 287 288 289 290 291 292
	    (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))
		(setq mail-from
		      (mail-fetch-field "Mail-From")
		      mime-version
		      (mail-fetch-field "MIME-Version")))))
293 294 295 296
	(save-excursion
	  (set-buffer tembuf)
	  (erase-buffer)
	  (insert-buffer-substring rmailbuf)
297
	  (rmail-delete-unwanted-fields t)
298
	  (or (bolp) (insert "\n"))
299
	  (goto-char (point-min))
300 301 302 303 304 305 306 307
	  (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"))
308 309
	  (if mime-version
	      (insert "MIME-Version: " mime-version "\n"))
310 311 312
	  ;; ``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.)
313 314 315 316
	  (let ((case-fold-search nil))
	    (while (search-forward "\nFrom " nil t)
	      (forward-char -5)
	      (insert ?>)))
317 318
	  (write-region (point-min) (point-max) file-name t
			(if noattribute 'nomsg)))
319 320 321 322
	(or noattribute
	    (if (equal major-mode 'rmail-mode)
		(rmail-set-attribute "filed" t)))
	(setq count (1- count))
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
	(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))))))
340
      (kill-buffer tembuf))))
Eric S. Raymond's avatar
Eric S. Raymond committed
341

342
;;;###autoload
343
(defun rmail-output-body-to-file (file-name)
344 345 346 347
  "Write this message body to the file FILE-NAME.
FILE-NAME defaults, interactively, from the Subject field of the message."
  (interactive
   (let ((default-file
348 349 350 351 352 353 354 355 356 357 358 359
	   (or (mail-fetch-field "Subject")
	       rmail-default-body-file)))
     (list (setq rmail-default-body-file
		 (read-file-name
		  "Output message body to file: "
		  (and default-file (file-name-directory default-file))
		  default-file
		  nil default-file)))))
  (setq file-name
	(expand-file-name file-name
			  (and rmail-default-body-file
			       (file-name-directory rmail-default-body-file))))
360 361 362
  (save-excursion
    (goto-char (point-min))
    (search-forward "\n\n")
363 364 365
    (and (file-exists-p file-name)
	 (not (y-or-n-p (message "File %s exists; overwrite? " file-name)))
	 (error "Operation aborted"))
366 367 368 369 370 371
    (write-region (point) (point-max) file-name)
    (if (equal major-mode 'rmail-mode)
	(rmail-set-attribute "stored" t)))
  (if rmail-delete-after-output
      (rmail-delete-forward)))

Eric S. Raymond's avatar
Eric S. Raymond committed
372
;;; rmailout.el ends here