view lisp/mail/pmailout.el @ 99760:690624ab76e0

(Displaying Buffers, Vertical Scrolling) (Horizontal Scrolling): Fix indenting and rewording issues introduced with 2008-11-07 change.

;;; pmailout.el --- "PMAIL" mail reader for Emacs: output message to a file.

;; Copyright (C) 1985, 1987, 1993, 1994, 2001, 2002, 2003, 2004,
;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.

;; Maintainer: FSF
;; Keywords: mail

;; 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
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) 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.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;;; Code:

(provide 'pmailout)

(eval-when-compile
  (require 'pmail)
  (require 'pmaildesc))

;;;###autoload
(defcustom pmail-output-file-alist nil
  "*Alist matching regexps to suggested output Pmail files.
This is a list of elements of the form (REGEXP . NAME-EXP).
The suggestion is taken if REGEXP matches anywhere in the message buffer.
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."
  :type '(repeat (cons regexp
		       (choice :value ""
			       (string :tag "File Name")
			       sexp)))
  :group 'pmail-output)

;;;###autoload
(defcustom pmail-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 'pmail-output)

(defun pmail-output-read-file-name ()
  "Read the file name to use for `pmail-output'.
Set `pmail-default-file' to this name as well as returning it."
  (let* ((default-file
	   (with-current-buffer pmail-buffer
	     (expand-file-name
	      (or (catch 'answer
		    (dolist (i pmail-output-file-alist)
		      (goto-char (point-min))
		      (when (re-search-forward (car i) nil t)
			(throw 'answer (eval (cdr i))))))
		  pmail-default-file))))
	 (read-file
	  (expand-file-name
	   (read-file-name
	    (concat "Output message to Pmail (mbox) file: (default "
		    (file-name-nondirectory default-file) "): ")
	    (file-name-directory default-file)
	    (abbreviate-file-name default-file))
	   (file-name-directory default-file))))
    (setq pmail-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))))))

(declare-function pmail-update-summary "pmailsum" (&rest ignore))

;;; There are functions elsewhere in Emacs that use this function;
;;; look at them before you change the calling method.
;;;###autoload
(defun pmail-output-to-pmail-file (file-name &optional count stay)
  "Append the current message to an Pmail (mbox) 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.
If the file exists and is not an Pmail file, the message is
appended in inbox format, the same way `pmail-output' does it.

The default file name comes from `pmail-default-pmail-file',
which is updated to the name you use in this command.

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

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."
  (interactive (list (pmail-output-read-file-name)
		     (prefix-numeric-value current-prefix-arg)))
  ;; Use the 'pmail-output function to perform the output.
  (pmail-output file-name count nil nil)
  ;; Deal with the next message
  (if pmail-delete-after-output
      (unless (if (and (= count 0) stay)
		  (pmail-delete-message)
		(pmail-delete-forward))
        (setq count 0))
    (when (> count 0)
      (unless (when (not stay)
		(pmail-next-undeleted-message 1))
	(setq count 0)))))

(defun pmail-delete-unwanted-fields ()
  "Delete from the buffer header fields we don't want output."
  (when pmail-fields-not-to-output
    (save-excursion
      (let ((limit (pmail-header-get-limit))
	    (inhibit-point-motion-hooks t)
	    start)
	(goto-char (point-min))
	(while (re-search-forward pmail-fields-not-to-output limit t)
	  (forward-line 0)
	  (setq start (point))
	  (while (progn (forward-line 1) (looking-at "[ \t]+"))
	    (goto-char (line-end-position)))
	  (delete-region start (point)))))))

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

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.

The default file name comes from `pmail-default-file',
which is updated to the name you use in this command.

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

The optional fourth argument FROM-GNUS is set when called from GNUS."
  (interactive
   (list (pmail-output-read-file-name)
	 (prefix-numeric-value current-prefix-arg)))
  (or count (setq count 1))
  (setq file-name
	(expand-file-name file-name
			  (and pmail-default-file
			       (file-name-directory pmail-default-file))))
  (if (and (file-readable-p file-name) (mail-file-babyl-p file-name))
      (error "BABYL output not supported.")
    (with-current-buffer pmail-buffer
      (let ((orig-count count)
	    (pmailbuf (current-buffer))
	    (destbuf (find-buffer-visiting file-name))
	    (case-fold-search t))
	(while (> count 0)
	  (with-temp-buffer
	    (insert-buffer-substring pmailbuf)
	    ;; ensure we can write without barfing on exotic characters
	    (setq buffer-file-coding-system
		  (or pmail-file-coding-system 'raw-text))
	    ;; prune junk headers
	    (pmail-delete-unwanted-fields)
	    (if (not destbuf)
		;; The destination file is not being visited, just write
		;; out the processed message.
		(write-region (point-min) (point-max) file-name
			      t (when noattribute 'nomsg))
	      ;; The destination file is being visited.  Update it.
	      (let ((msg-string (buffer-string)))
		(with-current-buffer destbuf
		  ;; Determine if the destination file is an Pmail file.
		  (let ((buffer-read-only nil)
			(dest-current-message
			 (and (boundp 'pmail-current-message)
			      pmail-current-message)))
		    (if dest-current-message
			;; The buffer is an Pmail buffer.  Append the
			;; message.
			(progn
			  (widen)
			  (narrow-to-region (point-max) (point-max))
			  (insert msg-string)
			  (insert "\n")
			  (pmail-process-new-messages)
			  (pmail-show-message dest-current-message))
		      ;; The destination file is not an Pmail file, just
		      ;; insert at the end.
		      (goto-char (point-max))
		      (insert msg-string)))))))
	  (unless noattribute
	    (when (equal major-mode 'pmail-mode)
	      (pmail-set-attribute "filed" t)
	      (pmail-header-hide-headers)))
	  (setq count (1- count))
	  (unless from-gnus
	    (let ((next-message-p
		   (if pmail-delete-after-output
		       (pmail-delete-forward)
		     (when (> count 0)
		       (pmail-next-undeleted-message 1))))
		  (num-appended (- orig-count count)))
	      (when (and (> count 0) (not next-message-p))
		(error (format "Only %d message%s appended" num-appended
			       (if (= num-appended 1) "" "s")))
		(setq count 0)))))))))

;;;###autoload
(defun pmail-output-body-to-file (file-name)
  "Write this message body to the file FILE-NAME.
FILE-NAME defaults, interactively, from the Subject field of the message."
  (interactive
   (let ((default-file (or (mail-fetch-field "Subject")
			   pmail-default-body-file)))
     (list (setq pmail-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 pmail-default-body-file
	      (file-name-directory pmail-default-body-file))))
  (save-excursion
    (goto-char (point-min))
    (search-forward "\n\n")
    (and (file-exists-p file-name)
	 (not (y-or-n-p (message "File %s exists; overwrite? " file-name)))
	 (error "Operation aborted"))
    (write-region (point) (point-max) file-name)
    (when (equal major-mode 'pmail-mode)
      (pmail-desc-set-attribute pmail-current-message pmail-desc-stored-index t)))
  (when pmail-delete-after-output
    (pmail-delete-forward)))

;; Local Variables:
;; change-log-default-name: "ChangeLog.pmail"
;; End:

;; arch-tag: 4059abf0-f249-4be4-8e0d-602d370d01d1
;;; pmailout.el ends here