rmailout.el 14.4 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, 1994, 2001 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
(require 'rmail)
Richard M. Stallman's avatar
Richard M. Stallman committed
28
(provide 'rmailout)
29

30
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
31
(defcustom rmail-output-file-alist nil
32
  "*Alist matching regexps to suggested output Rmail files.
33
This is a list of elements of the form (REGEXP . NAME-EXP).
34
The suggestion is taken if REGEXP matches anywhere in the message buffer.
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
Richard M. Stallman's avatar
Richard M. Stallman committed
37 38 39 40 41 42
a file name as a string."
  :type '(repeat (cons regexp
		       (choice :value ""
			       (string :tag "File Name")
			       sexp)))
  :group 'rmail-output)
43

Richard M. Stallman's avatar
Richard M. Stallman committed
44 45 46 47 48 49 50 51 52
(defun rmail-output-read-rmail-file-name ()
  "Read the file name to use for `rmail-output-to-rmail-file'.
Set `rmail-default-rmail-file' to this name as well as returning it."
  (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
53
		(set-buffer rmail-buffer)
Richard M. Stallman's avatar
Richard M. Stallman committed
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 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
		(goto-char (point-min))
		(if (re-search-forward (car (car tail)) nil t)
		    (setq answer (eval (cdr (car tail)))))
		(setq tail (cdr tail))))
	    ;; If no suggestions, use same file as last time.
	    (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)
	     (abbreviate-file-name 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)))))

(defun rmail-output-read-file-name ()
  "Read the file name to use for `rmail-output'.
Set `rmail-default-file' to this name as well as returning it."
  (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))))
	    ;; If no suggestion, use same file as last time.
	    (or answer rmail-default-file))))
    (let ((read-file
	   (expand-file-name
	    (read-file-name
	     (concat "Output message to Unix mail file: (default "
		     (file-name-nondirectory default-file)
		     ") ")
	     (file-name-directory default-file)
	     (abbreviate-file-name default-file))
	    (file-name-directory default-file))))
      (setq rmail-default-file
	    (if (file-directory-p read-file)
		(expand-file-name (file-name-nondirectory default-file)
				  read-file)
	      (expand-file-name
	       (or read-file (file-name-nondirectory default-file))
	       (file-name-directory default-file)))))))

109 110
;;; There are functions elsewhere in Emacs that use this function;
;;; look at them before you change the calling method.
111
;;;###autoload
112
(defun rmail-output-to-rmail-file (file-name &optional count stay)
root's avatar
root committed
113 114 115 116
  "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.
117 118
If the file exists and is not an Rmail file, the message is
appended in inbox format, the same way `rmail-output' does it.
119

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

root's avatar
root committed
123
A prefix argument N says to output N consecutive messages
124 125 126 127
starting with the current one.  Deleted messages are skipped and don't count.

If optional argument STAY is non-nil, then leave the last filed
mesasge up instead of moving forward to the next non-deleted message."
128
  (interactive
Richard M. Stallman's avatar
Richard M. Stallman committed
129 130
   (list (rmail-output-read-rmail-file-name)
	 (prefix-numeric-value current-prefix-arg)))
131
  (or count (setq count 1))
Jim Blandy's avatar
Jim Blandy committed
132 133
  (setq file-name
	(expand-file-name file-name
134
			  (file-name-directory rmail-default-rmail-file)))
135
  (if (and (file-readable-p file-name) (not (mail-file-babyl-p file-name)))
136 137 138
      (rmail-output file-name count)
    (rmail-maybe-set-message-counters)
    (setq file-name (abbreviate-file-name file-name))
139
    (or (find-buffer-visiting file-name)
140 141 142 143
	(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
144
	      (save-excursion
145 146
		(set-buffer file-buffer)
		(rmail-insert-rmail-file-header)
147 148 149 150
		(let ((require-final-newline nil)
		      (coding-system-for-write
		       (or rmail-file-coding-system
			   'emacs-mule-unix)))
151 152 153 154 155 156 157
		  (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
158
	      (set-buffer rmail-buffer)
159 160 161 162 163 164
	      ;; 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)))
165 166 167 168
	      (save-restriction
		(widen)
		;; Decide whether to append to a file or to an Emacs buffer.
		(save-excursion
169
		  (let ((buf (find-buffer-visiting file-name))
170 171
			(cur (current-buffer))
			(beg (1+ (rmail-msgbeg rmail-current-message)))
172 173 174 175
			(end (1+ (rmail-msgend rmail-current-message)))
			(coding-system-for-write
			 (or rmail-file-coding-system
			     'emacs-mule-unix)))
176
		    (if (not buf)
177 178 179 180 181 182 183 184 185 186 187
			;; 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))
188 189 190 191 192 193 194 195 196 197
		      (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
198 199 200 201 202
			      ;; 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))
203 204 205 206 207 208 209 210
			      (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))
211
			      (rmail-delete-unwanted-fields)
212
			      (rmail-count-new-messages t)
213 214 215
			      (if (rmail-summary-exists)
				  (rmail-select-summary
				    (rmail-update-summary)))
216
			      (rmail-show-message msg))
217 218 219 220 221
			  ;; 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)))))))
222 223 224 225
	      (rmail-set-attribute "filed" t))
	  (if redelete (rmail-set-attribute "deleted" t))))
      (setq count (1- count))
      (if rmail-delete-after-output
226 227 228 229 230
	  (unless 
	      (if (and (= count 0) stay)
		  (rmail-delete-message)
		(rmail-delete-forward))
	    (setq count 0))
231
	(if (> count 0)
232 233 234
	    (unless 
		(if (not stay) (rmail-next-undeleted-message 1))
	      (setq count 0)))))))
235

236
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
237 238 239 240 241
(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)
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259

;; 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)))))))))

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

269 270 271 272
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
273
The default file name comes from `rmail-default-file',
Richard M. Stallman's avatar
Richard M. Stallman committed
274 275
which is updated to the name you use in this command.

276
The optional third argument NOATTRIBUTE, if non-nil, says not
277 278 279
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
280
  (interactive
Richard M. Stallman's avatar
Richard M. Stallman committed
281 282
   (list (rmail-output-read-file-name)
	 (prefix-numeric-value current-prefix-arg)))
283
  (or count (setq count 1))
Jim Blandy's avatar
Jim Blandy committed
284 285
  (setq file-name
	(expand-file-name file-name
286 287
			  (and rmail-default-file
			       (file-name-directory rmail-default-file))))
288
  (if (and (file-readable-p file-name) (mail-file-babyl-p file-name))
289
      (rmail-output-to-rmail-file file-name count)
290
    (set-buffer rmail-buffer)
291 292 293 294 295
    (let ((orig-count count)
	  (rmailbuf (current-buffer))
	  (case-fold-search t)
	  (tembuf (get-buffer-create " rmail-output"))
	  (original-headers-p
296 297 298 299 300 301 302
	   (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)))))
303
	  header-beginning
304
	  mail-from mime-version)
305
      (while (> count 0)
306 307
	;; Preserve the Mail-From and MIME-Version fields
	;; even if they have been pruned.
308
	(or from-gnus
309 310 311 312 313 314 315 316 317 318 319
	    (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")))))
320 321 322 323
	(save-excursion
	  (set-buffer tembuf)
	  (erase-buffer)
	  (insert-buffer-substring rmailbuf)
324
	  (rmail-delete-unwanted-fields t)
325
	  (or (bolp) (insert "\n"))
326
	  (goto-char (point-min))
327 328 329 330 331 332 333 334
	  (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"))
335 336
	  (if mime-version
	      (insert "MIME-Version: " mime-version "\n"))
337 338 339
	  ;; ``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.)
340 341 342 343
	  (let ((case-fold-search nil))
	    (while (search-forward "\nFrom " nil t)
	      (forward-char -5)
	      (insert ?>)))
344 345
	  (write-region (point-min) (point-max) file-name t
			(if noattribute 'nomsg)))
346 347 348 349
	(or noattribute
	    (if (equal major-mode 'rmail-mode)
		(rmail-set-attribute "filed" t)))
	(setq count (1- count))
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
	(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))))))
367
      (kill-buffer tembuf))))
Eric S. Raymond's avatar
Eric S. Raymond committed
368

369
;;;###autoload
370
(defun rmail-output-body-to-file (file-name)
371 372 373 374
  "Write this message body to the file FILE-NAME.
FILE-NAME defaults, interactively, from the Subject field of the message."
  (interactive
   (let ((default-file
375 376 377 378 379 380 381 382 383 384 385 386
	   (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))))
387 388 389
  (save-excursion
    (goto-char (point-min))
    (search-forward "\n\n")
390 391 392
    (and (file-exists-p file-name)
	 (not (y-or-n-p (message "File %s exists; overwrite? " file-name)))
	 (error "Operation aborted"))
393 394 395 396 397 398
    (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
399
;;; rmailout.el ends here