;;; rmailout.el --- "RMAIL" mail reader for Emacs: output message to a file
;; Copyright (C) 1985, 1987, 1993, 1994, 2001, 2002, 2003, 2004, 2005,
-;; 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
+;; 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
;; Maintainer: FSF
;; Keywords: mail
:type 'boolean
:group 'rmail-output)
+;; FIXME risky?
(defcustom rmail-output-file-alist nil
"Alist matching regexps to suggested output Rmail files.
This is a list of elements of the form (REGEXP . NAME-EXP).
(string :tag "File Name")
sexp)))
:group 'rmail-output)
+;;;###autoload(put 'rmail-output-file-alist 'risky-local-variable t)
(defcustom rmail-fields-not-to-output nil
- "Regexp describing fields to exclude when outputting a message to a file."
+ "Regexp describing fields to exclude when outputting a message to a file.
+The function `rmail-delete-unwanted-fields' uses this, ignoring case."
:type '(choice (const :tag "None" nil)
regexp)
:group 'rmail-output)
(defun rmail-delete-unwanted-fields (preserve)
"Delete all headers matching `rmail-fields-not-to-output'.
-Retains headers matching the regexp PRESERVE. The buffer should be
-narrowed to just the header."
+Retains headers matching the regexp PRESERVE. Ignores case.
+The buffer should be narrowed to just the header."
(if rmail-fields-not-to-output
(save-excursion
(goto-char (point-min))
- (while (re-search-forward rmail-fields-not-to-output nil t)
- (beginning-of-line)
- (unless (looking-at preserve)
- (delete-region (point)
- (progn (forward-line 1) (point))))))))
+ (let ((case-fold-search t))
+ (while (re-search-forward rmail-fields-not-to-output nil t)
+ (beginning-of-line)
+ (unless (looking-at preserve)
+ (delete-region (point) (line-beginning-position 2))))))))
\f
(defun rmail-output-as-babyl (file-name nomsg)
"Convert the current buffer's text to Babyl and output to FILE-NAME.
(save-restriction
(unless (looking-at "^From ")
(error "Invalid mbox message"))
- (insert "\^L\n0, unseen,,\n*** EOOH ***\n")
+ (insert "\^L\n0,,\n*** EOOH ***\n")
(rmail-nuke-pinhead-header)
;; Decode base64 or quoted printable contents, Rmail style.
(let* ((header-end (save-excursion
"From: \\1\n"))
t)))))))
\f
+(autoload 'mail-mbox-from "mail-utils")
+
(defun rmail-output-as-mbox (file-name nomsg &optional as-seen)
"Convert the current buffer's text to mbox and output to FILE-NAME.
Alters the current buffer's text, so it should be a temporary buffer.
(rmail-delete-unwanted-fields
(if rmail-enable-mime "Mail-From"
"Mail-From\\|MIME-Version\\|Content-type"))
- ;; Generate a From line from other header fields if necessary.
- ;; FIXME this duplicates code from unrmail.el.
(goto-char (point-min))
- (unless (looking-at "From ")
- (setq from (or (mail-fetch-field "from")
- (mail-fetch-field "really-from")
- (mail-fetch-field "sender")
- "unknown")
- date (mail-fetch-field "date")
- date (or (and date
- (ignore-errors
- (current-time-string (date-to-time date))))
- (current-time-string)))
- (insert "From " (mail-strip-quoted-names from) " " date "\n"))
+ (or (looking-at "From ")
+ (insert (mail-mbox-from)))
(widen)
;; Make sure message ends with blank line.
(goto-char (point-max))
- (unless (bolp)
- (insert "\n"))
- (unless (looking-back "\n\n")
- (insert "\n"))
+ (rmail-ensure-blank-line)
(goto-char (point-min))
(let ((buf (find-buffer-visiting file-name))
(tembuf (current-buffer)))
(if (null buf)
(let ((coding-system-for-write 'raw-text-unix))
+ ;; FIXME should ensure existing file ends with a blank line.
(write-region (point-min) (point-max) file-name t nomsg))
(if (eq buf (current-buffer))
(error "Can't output message to same file it's already in"))
display message number MSG."
(save-excursion
(rmail-swap-buffers-maybe)
- ;; Turn on Auto Save mode, if it's off in this
- ;; buffer but enabled by default.
+ (rmail-modify-format)
+ ;; 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))
(rmail-maybe-set-message-counters)
+ ;; Insert the new message after the last old message.
+ (widen)
+ ;; Make sure the last old message ends with a blank line.
+ (goto-char (point-max))
+ (rmail-ensure-blank-line)
+ ;; Insert the new message at the end.
(narrow-to-region (point-max) (point-max))
(insert-buffer-substring tembuf)
(rmail-count-new-messages t)
+ ;; FIXME should re-use existing windows.
(if (rmail-summary-exists)
(rmail-select-summary (rmail-update-summary)))
(rmail-show-message-1 msg)))
;;; There are functions elsewhere in Emacs that use this function;
;;; look at them before you change the calling method.
;;;###autoload
-(defun rmail-output (file-name &optional count noattribute from-gnus)
+(defun rmail-output (file-name &optional count noattribute not-rmail)
"Append this message to mail file FILE-NAME.
-This works with both mbox format and Babyl format files,
-outputting in the appropriate format for each.
+Writes mbox format, unless FILE-NAME exists and is Babyl format, in which
+case it writes Babyl.
Interactively, the default file name comes from `rmail-default-file',
which is updated to the name you use in this command. In all uses, if
FILE-NAME is not absolute, it is expanded with the directory part of
`rmail-default-file'.
-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 a buffer is visiting FILE-NAME, adds the text to that buffer
+rather than saving the file directly. If the buffer is an Rmail
+buffer, updates it accordingly.
+
+This command always outputs the complete message header, even if
+the header display is currently pruned.
-This command always outputs the complete message header,
-even if the header display is currently pruned.
+Optional prefix argument COUNT (default 1) says to output that
+many consecutive messages, starting with the current one (ignoring
+deleted messages). If `rmail-delete-after-output' is non-nil, deletes
+messages after output.
-The optional third argument NOATTRIBUTE, if non-nil, says not
-to set the `filed' attribute, and not to display a message.
+The optional third argument NOATTRIBUTE, if non-nil, says not to
+set the `filed' attribute, and not to display a \"Wrote file\"
+message (if writing a file directly).
-The optional fourth argument FROM-GNUS is set when called from Gnus."
+Set the optional fourth argument NOT-RMAIL non-nil if you call this
+from a non-Rmail buffer. In this case, COUNT is ignored."
(interactive
(list (rmail-output-read-file-name)
(prefix-numeric-value current-prefix-arg)))
(expand-file-name file-name
(and rmail-default-file
(file-name-directory rmail-default-file))))
-
;; Warn about creating new file.
(or (find-buffer-visiting file-name)
(file-exists-p file-name)
- (yes-or-no-p
- (concat "\"" file-name "\" does not exist, create it? "))
+ (yes-or-no-p (concat "\"" file-name "\" does not exist, create it? "))
(error "Output file does not exist"))
-
- (set-buffer rmail-buffer)
-
- (let ((orig-count count)
- (case-fold-search t)
- (tembuf (get-buffer-create " rmail-output"))
- (babyl-format
- (and (file-readable-p file-name) (mail-file-babyl-p file-name))))
-
- (unwind-protect
+ (if noattribute (setq noattribute 'nomsg))
+ (let ((babyl-format (and (file-readable-p file-name)
+ (mail-file-babyl-p file-name)))
+ (cur (current-buffer))
+ (buf (find-buffer-visiting file-name)))
+
+ ;; If a babyl file is visited in a buffer, is it visited as babyl
+ ;; or as mbox?
+ (and babyl-format buf
+ (with-current-buffer buf
+ (save-restriction
+ (widen)
+ (save-excursion
+ (goto-char (point-min))
+ (setq babyl-format
+ (looking-at "BABYL OPTIONS:"))))))
+
+ (if not-rmail ; eg via message-fcc-handler-function
+ (with-temp-buffer
+ (insert-buffer-substring cur)
+ ;; Output in the appropriate format.
+ (if babyl-format
+ (progn
+ (goto-char (point-min))
+ ;; rmail-convert-to-babyl-format errors if no From line,
+ ;; whereas rmail-output-as-mbox inserts one.
+ (or (looking-at "From ")
+ (insert (mail-mbox-from)))
+ (rmail-output-as-babyl file-name noattribute))
+ (rmail-output-as-mbox file-name noattribute)))
+ ;; Called from an Rmail buffer.
+ (if rmail-buffer
+ (set-buffer rmail-buffer)
+ (error "There is no Rmail buffer"))
+ (let ((orig-count count)
+ beg end)
(while (> count 0)
- (with-current-buffer rmail-buffer
- (let (cur beg end)
- (setq beg (rmail-msgbeg rmail-current-message)
- end (rmail-msgend rmail-current-message))
- ;; All access to the buffer's local variables is now finished...
- (save-excursion
- ;; ... so it is ok to go to a different buffer.
- (if (rmail-buffers-swapped-p) (set-buffer rmail-view-buffer))
- (setq cur (current-buffer))
- (save-restriction
- (widen)
- (with-current-buffer tembuf
- (insert-buffer-substring cur beg end)
- ;; Convert the text to one format or another and output.
- (if babyl-format
- (rmail-output-as-babyl file-name (if noattribute 'nomsg))
- (rmail-output-as-mbox file-name
- (if noattribute 'nomsg))))))))
-
- ;; Mark message as "filed".
- (unless noattribute
- (rmail-set-attribute rmail-filed-attr-index t))
-
+ (setq beg (rmail-msgbeg rmail-current-message)
+ end (rmail-msgend rmail-current-message))
+ ;; All access to the buffer's local variables is now finished...
+ (save-excursion
+ ;; ... so it is ok to go to a different buffer.
+ (if (rmail-buffers-swapped-p) (set-buffer rmail-view-buffer))
+ (setq cur (current-buffer))
+ (save-restriction
+ (widen)
+ (with-temp-buffer
+ (insert-buffer-substring cur beg end)
+ (if babyl-format
+ (rmail-output-as-babyl file-name noattribute)
+ (rmail-output-as-mbox file-name noattribute)))))
+ (or noattribute ; mark message as "filed"
+ (rmail-set-attribute rmail-filed-attr-index t))
(setq count (1- count))
-
- (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 (> count 0) (not next-message-p))
- (error "Only %d message%s appended" num-appended
- (if (= num-appended 1) "" "s"))))))
- (kill-buffer tembuf))))
-
-;; FIXME gnus does not use this function.
-(defun rmail-output-as-seen (file-name &optional count noattribute 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 (> count 0) (not next-message-p))
+ (error "Only %d message%s appended" num-appended
+ (if (= num-appended 1) "" "s")))))))))
+
+;; FIXME nothing outside uses this, so NOT-RMAIL could be dropped.
+;; FIXME this duplicates code from rmail-output.
+;;;###autoload
+(defun rmail-output-as-seen (file-name &optional count noattribute not-rmail)
"Append this message to mbox 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.
-
-This outputs the message header as you see it.
-
-The default file name comes from `rmail-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."
+The details are as for `rmail-output', except that:
+ i) the header is output as currently seen
+ ii) this function cannot write to Babyl files
+iii) an Rmail buffer cannot be visiting FILE-NAME
+
+Note that if NOT-RMAIL is non-nil, there is no difference between this
+function and `rmail-output'. This argument may be removed in future,
+so you should call `rmail-output' directly in that case."
(interactive
(list (rmail-output-read-file-name)
(prefix-numeric-value current-prefix-arg)))
- (or count (setq count 1))
- (setq file-name
- (expand-file-name file-name
- (and rmail-default-file
- (file-name-directory rmail-default-file))))
- (set-buffer rmail-buffer)
-
- ;; Warn about creating new file.
- (or (find-buffer-visiting file-name)
- (file-exists-p file-name)
- (yes-or-no-p
- (concat "\"" file-name "\" does not exist, create it? "))
- (error "Output file does not exist"))
-
+ (if not-rmail
+ (rmail-output file-name count noattribute not-rmail)
+ (or count (setq count 1))
+ (setq file-name
+ (expand-file-name file-name
+ (and rmail-default-file
+ (file-name-directory rmail-default-file))))
+ ;; Warn about creating new file.
+ (or (find-buffer-visiting file-name)
+ (file-exists-p file-name)
+ (yes-or-no-p (concat "\"" file-name "\" does not exist, create it? "))
+ (error "Output file does not exist"))
+ ;; FIXME why not?
(if (and (file-readable-p file-name) (mail-file-babyl-p file-name))
(error "Cannot output `as seen' to a Babyl file"))
-
- (let ((orig-count count)
- (case-fold-search t)
- (tembuf (get-buffer-create " rmail-output")))
-
- (unwind-protect
- (while (> count 0)
- (let (cur beg end)
- ;; If operating from whole-mbox buffer, get message bounds.
- (if (not (rmail-buffers-swapped-p))
- (setq beg (rmail-msgbeg rmail-current-message)
- end (rmail-msgend rmail-current-message)))
- ;; All access to the buffer's local variables is now finished...
- (save-excursion
- (setq cur (current-buffer))
- (save-restriction
- (widen)
- ;; If operating from the view buffer, get the bounds.
- (unless beg
- (setq beg (point-min)
- end (point-max)))
-
- (with-current-buffer tembuf
- (insert-buffer-substring cur beg end)
- ;; Convert the text to one format or another and output.
- (rmail-output-as-mbox file-name
- (if noattribute 'nomsg)
- t)))))
-
- ;; Mark message as "filed".
- (unless noattribute
+ (if noattribute (setq noattribute 'nomsg))
+ (if rmail-buffer
+ (set-buffer rmail-buffer)
+ (error "There is no Rmail buffer"))
+ (let ((orig-count count)
+ (cur (current-buffer)))
+ (while (> count 0)
+ (let (beg end)
+ ;; If operating from whole-mbox buffer, get message bounds.
+ (or (rmail-buffers-swapped-p)
+ (setq beg (rmail-msgbeg rmail-current-message)
+ end (rmail-msgend rmail-current-message)))
+ (save-restriction
+ (widen)
+ ;; If operating from the view buffer, get the bounds.
+ (or beg
+ (setq beg (point-min)
+ end (point-max)))
+ (with-temp-buffer
+ (insert-buffer-substring cur beg end)
+ (rmail-output-as-mbox file-name noattribute t))))
+ (or noattribute ; mark message as "filed"
(rmail-set-attribute rmail-filed-attr-index t))
-
- (setq count (1- count))
-
- (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 (> count 0) (not next-message-p))
- (error "Only %d message%s appended" num-appended
- (if (= num-appended 1) "" "s"))))))
- (kill-buffer tembuf))))
+ (setq count (1- count))
+ (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 (> count 0) (not next-message-p))
+ (error "Only %d message%s appended" num-appended
+ (if (= num-appended 1) "" "s"))))))))
\f
;;;###autoload