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

3
;; Copyright (C) 1985, 1987, 1993, 1994, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
7
;; Keywords: mail
Eric S. Raymond's avatar
Eric S. Raymond committed
8

root's avatar
root committed
9 10 11 12
;; 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
13
;; the Free Software Foundation; either version 3, or (at your option)
root's avatar
root committed
14 15 16 17 18 19 20 21
;; 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
22
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
23 24
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
root's avatar
root committed
25

26 27
;;; Commentary:

Eric S. Raymond's avatar
Eric S. Raymond committed
28
;;; Code:
root's avatar
root committed
29

30
(require 'rmail)
Richard M. Stallman's avatar
Richard M. Stallman committed
31
(provide 'rmailout)
32

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

Richard M. Stallman's avatar
Richard M. Stallman committed
47 48 49 50 51 52 53 54 55
(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
56
		(set-buffer rmail-buffer)
Richard M. Stallman's avatar
Richard M. Stallman committed
57 58 59 60 61 62 63 64 65
		(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
66
	     (concat "Output message to Rmail file (default "
Richard M. Stallman's avatar
Richard M. Stallman committed
67
		     (file-name-nondirectory default-file)
68
		     "): ")
Richard M. Stallman's avatar
Richard M. Stallman committed
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
	     (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
98
	     (concat "Output message to Unix mail file (default "
Richard M. Stallman's avatar
Richard M. Stallman committed
99
		     (file-name-nondirectory default-file)
100
		     "): ")
Richard M. Stallman's avatar
Richard M. Stallman committed
101 102 103 104 105 106 107 108 109 110 111
	     (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)))))))

112 113
(declare-function rmail-update-summary "rmailsum" (&rest ignore))

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

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

128
A prefix argument COUNT says to output that many consecutive messages,
129 130
starting with the current one.  Deleted messages are skipped and don't count.

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

241
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
242 243 244 245 246
(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)
247 248 249 250 251

;; 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)
252
  (if rmail-fields-not-to-output
253 254 255 256 257 258 259 260 261 262 263 264
      (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)))))))))

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

274 275 276 277
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
278
The default file name comes from `rmail-default-file',
Richard M. Stallman's avatar
Richard M. Stallman committed
279 280
which is updated to the name you use in this command.

281
The optional third argument NOATTRIBUTE, if non-nil, says not
282 283 284
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
285
  (interactive
Richard M. Stallman's avatar
Richard M. Stallman committed
286 287
   (list (rmail-output-read-file-name)
	 (prefix-numeric-value current-prefix-arg)))
288
  (or count (setq count 1))
Jim Blandy's avatar
Jim Blandy committed
289 290
  (setq file-name
	(expand-file-name file-name
291 292
			  (and rmail-default-file
			       (file-name-directory rmail-default-file))))
293
  (if (and (file-readable-p file-name) (mail-file-babyl-p file-name))
294
      (rmail-output-to-rmail-file file-name count)
295
    (set-buffer rmail-buffer)
296 297 298 299 300
    (let ((orig-count count)
	  (rmailbuf (current-buffer))
	  (case-fold-search t)
	  (tembuf (get-buffer-create " rmail-output"))
	  (original-headers-p
301
	   (and (not from-gnus)
302
		(save-excursion
303 304 305 306 307
		  (save-restriction
		    (narrow-to-region (rmail-msgbeg rmail-current-message) (point-max))
		    (goto-char (point-min))
		    (forward-line 1)
		    (= (following-char) ?0)))))
308
	  header-beginning
309
	  mail-from mime-version content-type)
310
      (while (> count 0)
311 312
	;; Preserve the Mail-From and MIME-Version fields
	;; even if they have been pruned.
313
	(or from-gnus
314 315 316 317 318 319 320
	    (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))
321 322 323 324
		(setq mail-from (mail-fetch-field "Mail-From"))
		(unless rmail-enable-mime
		  (setq mime-version (mail-fetch-field "MIME-Version")
			content-type (mail-fetch-field "Content-type"))))))
325 326 327 328
	(save-excursion
	  (set-buffer tembuf)
	  (erase-buffer)
	  (insert-buffer-substring rmailbuf)
329 330 331 332 333 334 335 336 337 338 339 340 341 342
	  (when rmail-enable-mime
	    (if original-headers-p
		(delete-region (goto-char (point-min))
			       (if (search-forward "\n*** EOOH ***\n")
				   (match-end 0)))
	      (goto-char (point-min))
	      (forward-line 2)
	      (delete-region (point-min)(point))
	      (search-forward "\n*** EOOH ***\n")
	      (delete-region (match-beginning 0)
			     (if (search-forward "\n\n")
				 (1- (match-end 0)))))
	    (setq buffer-file-coding-system (or rmail-file-coding-system
						'raw-text)))
343
	  (rmail-delete-unwanted-fields t)
344
	  (or (bolp) (insert "\n"))
345
	  (goto-char (point-min))
346 347 348 349 350 351 352 353
	  (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"))
354 355 356 357 358
	  (when mime-version
	    (insert "MIME-Version: " mime-version)
	    ;; Some malformed MIME messages set content-type to nil.
	    (when content-type
	      (insert "\nContent-type: " content-type "\n")))
359 360 361
	  ;; ``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.)
362 363 364 365
	  (let ((case-fold-search nil))
	    (while (search-forward "\nFrom " nil t)
	      (forward-char -5)
	      (insert ?>)))
366 367
	  (write-region (point-min) (point-max) file-name t
			(if noattribute 'nomsg)))
368 369 370 371
	(or noattribute
	    (if (equal major-mode 'rmail-mode)
		(rmail-set-attribute "filed" t)))
	(setq count (1- count))
372 373 374 375 376 377 378 379 380 381
	(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))
382
		  (progn
Deepak Goel's avatar
Deepak Goel committed
383
		    (error "%s"
384 385 386 387 388
		     (save-excursion
		       (set-buffer rmailbuf)
		       (format "Only %d message%s appended" num-appended
			       (if (= num-appended 1) "" "s"))))
		    (setq count 0))))))
389
      (kill-buffer tembuf))))
Eric S. Raymond's avatar
Eric S. Raymond committed
390

391
;;;###autoload
392
(defun rmail-output-body-to-file (file-name)
393 394 395 396
  "Write this message body to the file FILE-NAME.
FILE-NAME defaults, interactively, from the Subject field of the message."
  (interactive
   (let ((default-file
397 398 399 400 401 402 403 404 405 406 407 408
	   (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))))
409 410 411
  (save-excursion
    (goto-char (point-min))
    (search-forward "\n\n")
412
    (and (file-exists-p file-name)
413
	 (not (y-or-n-p (format "File %s exists; overwrite? " file-name)))
414
	 (error "Operation aborted"))
415 416 417 418 419 420
    (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)))

421
;; arch-tag: 447117c6-1a9a-4b88-aa43-3101b043e3a4
Eric S. Raymond's avatar
Eric S. Raymond committed
422
;;; rmailout.el ends here