1 ;;; mh-comp --- mh-e functions for composing messages
2 ;; Time-stamp: <95/08/19 17:48:59 gildea>
4 ;; Copyright (C) 1993, 1995, 1997 Free Software Foundation, Inc.
6 ;; This file is part of mh-e, part of GNU Emacs.
8 ;; GNU Emacs is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs; see the file COPYING. If not, write to the
20 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 ;; Boston, MA 02111-1307, USA.
25 ;; Internal support for mh-e package.
29 ;; $Id: mh-comp.el,v 1.16 1999/11/10 10:46:01 gerd Exp $
36 ;;; Site customization (see also mh-utils.el):
38 (defgroup mh-compose nil
39 "Mh-e functions for composing messages"
44 (defvar mh-send-prog "send"
45 "Name of the MH send program.
46 Some sites need to change this because of a name conflict.")
48 (defvar mh-redist-full-contents nil
49 "Non-nil if the `dist' command needs whole letter for redistribution.
50 This is the case only when `send' is compiled with the BERK option.
51 If MH will not allow you to redist a previously redist'd msg, set to nil.")
54 (defvar mh-note-repl "-"
55 "String whose first character is used to notate replied to messages.")
57 (defvar mh-note-forw "F"
58 "String whose first character is used to notate forwarded messages.")
60 (defvar mh-note-dist "R"
61 "String whose first character is used to notate redistributed messages.")
63 (defvar mh-yank-hooks nil
64 "Obsolete hook for modifying a citation just inserted in the mail buffer.
65 Each hook function can find the citation between point and mark.
66 And each hook function should leave point and mark around the citation
69 This is a normal hook, misnamed for historical reasons.
70 It is semi-obsolete and is only used if `mail-citation-hook' is nil.")
72 (defvar mail-citation-hook nil
73 "*Hook for modifying a citation just inserted in the mail buffer.
74 Each hook function can find the citation between point and mark.
75 And each hook function should leave point and mark around the citation
78 If this hook is entirely empty (nil), the text of the message is inserted
79 with `mh-ins-buf-prefix' prefixed to each line.
81 See also the variable `mh-yank-from-start-of-msg', which controls how
82 much of the message passed to the hook.")
84 ;;; Copied from sendmail.el for Hyperbole
85 (defvar mail-header-separator "--------"
86 "*Line used by MH to separate headers from text in messages being composed.")
88 ;;; Personal preferences:
90 (defcustom mh-delete-yanked-msg-window nil
91 "*Controls window display when a message is yanked by \\<mh-letter-mode-map>\\[mh-yank-cur-msg].
92 If non-nil, yanking the current message into a draft letter deletes any
93 windows displaying the message."
97 (defcustom mh-yank-from-start-of-msg t
98 "*Controls which part of a message is yanked by \\<mh-letter-mode-map>\\[mh-yank-cur-msg].
99 If non-nil, include the entire message. If the symbol `body', then yank the
100 message minus the header. If nil, yank only the portion of the message
101 following the point. If the show buffer has a region, this variable is
103 :type '(choice (const :tag "Below point" nil)
104 (const :tag "Without header" body)
105 (other :tag "Entire message" t))
108 (defcustom mh-ins-buf-prefix "> "
109 "*String to put before each non-blank line of a yanked or inserted message.
110 \\<mh-letter-mode-map>Used when the message is inserted into an outgoing letter
111 by \\[mh-insert-letter] or \\[mh-yank-cur-msg]."
115 (defcustom mh-reply-default-reply-to nil
116 "*Sets the person or persons to whom a reply will be sent.
117 If nil, prompt for recipient. If non-nil, then \\<mh-folder-mode-map>`\\[mh-reply]' will use this
118 value and it should be one of \"from\", \"to\", \"cc\", or \"all\".
119 The values \"cc\" and \"all\" do the same thing."
120 :type '(choice (const :tag "Prompt" nil)
121 (const "from") (const "to")
122 (const "cc") (const "all"))
125 (defcustom mh-signature-file-name "~/.signature"
126 "*Name of file containing the user's signature.
127 Inserted into message by \\<mh-letter-mode-map>\\[mh-insert-signature]."
131 (defcustom mh-forward-subject-format "%s: %s"
132 "*Format to generate the Subject: line contents for a forwarded message.
133 The two string arguments to the format are the sender of the original
134 message and the original subject line."
138 (defvar mh-comp-formfile "components"
139 "Name of file to be used as a skeleton for composing messages.
140 Default is \"components\". If not an absolute file name, the file
141 is searched for first in the user's MH directory, then in the
142 system MH lib directory.")
144 (defvar mh-repl-formfile "replcomps"
145 "Name of file to be used as a skeleton for replying to messages.
146 Default is \"replcomps\". If not an absolute file name, the file
147 is searched for first in the user's MH directory, then in the
148 system MH lib directory.")
150 (defvar mh-repl-group-formfile "replgroupcomps"
151 "Name of file to be used as a skeleton for replying to the sender
152 and all recipients of a messages. Only used if mh-nmh-p is non-nil.
153 Default is \"replgroupcomps\". If not an absolute file name, the file
154 is searched for first in the user's MH directory, then in the system
159 (defcustom mh-letter-mode-hook nil
160 "Invoked in `mh-letter-mode' on a new letter."
164 (defcustom mh-compose-letter-function nil
165 "Invoked when setting up a letter draft.
166 It is passed three arguments: TO recipients, SUBJECT, and CC recipients."
170 (defcustom mh-before-send-letter-hook nil
171 "Invoked at the beginning of the \\<mh-letter-mode-map>\\[mh-send-letter] command."
176 (defvar mh-rejected-letter-start
177 (concat "^ ----- Unsent message follows -----$" ;from sendmail V5
178 "\\|^ ----- Original message follows -----$" ;from sendmail V8
179 "\\|^------- Unsent Draft$" ;from MH itself
180 "\\|^---------- Original Message ----------$" ;from zmailer
181 "\\|^ --- The unsent message follows ---$" ;from AIX mail system
182 "\\|^ Your message follows:$" ;from MMDF-II
183 "\\|^Content-Description: Returned Content$" ;1993 KJ sendmail
185 "Regexp specifying the beginning of the wrapper around a returned letter.
186 This wrapper is generated by the mail system when rejecting a letter.")
188 (defvar mh-new-draft-cleaned-headers
189 "^Date:\\|^Received:\\|^Message-Id:\\|^From:\\|^Sender:\\|^Errors-To:\\|^Delivery-Date:\\|^Return-Path:"
190 "Regexp of header lines to remove before offering a message as a new draft.
191 Used by the \\<mh-folder-mode-map>`\\[mh-edit-again]' and `\\[mh-extract-rejected-mail]' commands.")
193 (defvar mh-to-field-choices '(("t" . "To:") ("s" . "Subject:") ("c" . "Cc:")
194 ("b" . "Bcc:") ("f" . "Fcc:") ("r" . "From:")
196 "Alist of (final-character . field-name) choices for mh-to-field.")
198 (defvar mh-letter-mode-map (copy-keymap text-mode-map)
199 "Keymap for composing mail.")
201 (defvar mh-letter-mode-syntax-table nil
202 "Syntax table used by mh-e while in MH-Letter mode.")
204 (if mh-letter-mode-syntax-table
206 (setq mh-letter-mode-syntax-table
207 (make-syntax-table text-mode-syntax-table))
208 (modify-syntax-entry ?% "." mh-letter-mode-syntax-table))
213 "Compose and send mail with the MH mail system.
214 This function is an entry point to mh-e, the Emacs front end
215 to the MH mail system.
217 See documentation of `\\[mh-send]' for more details on composing mail."
220 (call-interactively 'mh-send))
223 (defvar mh-error-if-no-draft nil) ;raise error over using old draft
227 (defun mh-smail-batch (&optional to subject other-headers &rest ignored)
228 "Set up a mail composition draft with the MH mail system.
229 This function is an entry point to mh-e, the Emacs front end
230 to the MH mail system. This function does not prompt the user
231 for any header fields, and thus is suitable for use by programs
232 that want to create a mail buffer.
233 Users should use `\\[mh-smail]' to compose mail."
235 (let ((mh-error-if-no-draft t))
236 (mh-send (or to "") "" (or subject ""))))
239 (defun mh-edit-again (msg)
240 "Clean-up a draft or a message previously sent and make it resendable.
241 Default is the current message.
242 The variable mh-new-draft-cleaned-headers specifies the headers to remove.
243 See also documentation for `\\[mh-send]' function."
244 (interactive (list (mh-get-msg-num t)))
245 (let* ((from-folder mh-current-folder)
246 (config (current-window-configuration))
248 (cond ((and mh-draft-folder (equal from-folder mh-draft-folder))
249 (pop-to-buffer (find-file-noselect (mh-msg-filename msg)) t)
250 (rename-buffer (format "draft-%d" msg))
253 (mh-read-draft "clean-up" (mh-msg-filename msg) nil)))))
254 (mh-clean-msg-header (point-min) mh-new-draft-cleaned-headers nil)
255 (goto-char (point-min))
257 (mh-compose-and-send-mail draft "" from-folder nil nil nil nil nil nil
261 (defun mh-extract-rejected-mail (msg)
262 "Extract a letter returned by the mail system and make it resendable.
263 Default is the current message. The variable `mh-new-draft-cleaned-headers'
264 gives the headers to clean out of the original message.
265 See also documentation for `\\[mh-send]' function."
266 (interactive (list (mh-get-msg-num t)))
267 (let ((from-folder mh-current-folder)
268 (config (current-window-configuration))
269 (draft (mh-read-draft "extraction" (mh-msg-filename msg) nil)))
270 (goto-char (point-min))
271 (cond ((re-search-forward mh-rejected-letter-start nil t)
272 (skip-chars-forward " \t\n")
273 (delete-region (point-min) (point))
274 (mh-clean-msg-header (point-min) mh-new-draft-cleaned-headers nil))
276 (message "Does not appear to be a rejected letter.")))
277 (goto-char (point-min))
279 (mh-compose-and-send-mail draft "" from-folder msg
280 (mh-get-header-field "To:")
281 (mh-get-header-field "From:")
282 (mh-get-header-field "Cc:")
286 (defun mh-forward (to cc &optional msg-or-seq)
287 "Forward a message or message sequence. Defaults to displayed message.
288 If optional prefix argument provided, then prompt for the message sequence.
289 See also documentation for `\\[mh-send]' function."
290 (interactive (list (mh-read-address "To: ")
291 (mh-read-address "Cc: ")
292 (if current-prefix-arg
293 (mh-read-seq-default "Forward" t)
294 (mh-get-msg-num t))))
296 (setq msg-or-seq (mh-get-msg-num t)))
297 (let* ((folder mh-current-folder)
298 (config (current-window-configuration))
299 ;; forw always leaves file in "draft" since it doesn't have -draft
300 (draft-name (expand-file-name "draft" mh-user-path))
301 (draft (cond ((or (not (file-exists-p draft-name))
302 (y-or-n-p "The file 'draft' exists. Discard it? "))
303 (mh-exec-cmd "forw" "-build"
304 mh-current-folder msg-or-seq)
306 (mh-read-draft "" draft-name t)
307 (mh-insert-fields "To:" to "Cc:" cc)
310 (mh-read-draft "" draft-name nil))))
311 (fwd-msg-file (mh-msg-filename (if (numberp msg-or-seq)
313 (car (mh-seq-to-msgs msg-or-seq)))
318 (set-buffer (get-buffer-create mh-temp-buffer))
320 (insert-file-contents fwd-msg-file)
321 (setq orig-from (mh-get-header-field "From:"))
322 (setq orig-subject (mh-get-header-field "Subject:")))
324 (mh-forwarded-letter-subject orig-from orig-subject)))
325 (mh-insert-fields "Subject:" forw-subject)
326 (goto-char (point-min))
327 (if (re-search-forward "^------- Forwarded Message" nil t)
329 (re-search-forward "^--------")
331 (delete-other-windows)
332 (if (numberp msg-or-seq)
333 (mh-add-msgs-to-seq msg-or-seq 'forwarded t)
334 (mh-add-msgs-to-seq (mh-seq-to-msgs msg-or-seq) 'forwarded t))
335 (mh-compose-and-send-mail draft "" folder msg-or-seq
337 mh-note-forw "Forwarded:"
340 (defun mh-forwarded-letter-subject (from subject)
341 ;; Return a Subject suitable for a forwarded message.
342 ;; Original message has headers FROM and SUBJECT.
343 (let ((addr-start (string-match "<" from))
344 (comment (string-match "(" from)))
345 (cond ((and addr-start (> addr-start 0))
346 ;; Full Name <luser@host>
347 (setq from (substring from 0 (1- addr-start))))
349 ;; luser@host (Full Name)
350 (setq from (substring from (1+ comment) (1- (length from)))))))
351 (format mh-forward-subject-format from subject))
355 (defun mh-smail-other-window ()
356 "Compose and send mail in other window with the MH mail system.
357 This function is an entry point to mh-e, the Emacs front end
358 to the MH mail system.
360 See documentation of `\\[mh-send]' for more details on composing mail."
363 (call-interactively 'mh-send-other-window))
366 (defun mh-redistribute (to cc &optional msg)
367 "Redistribute a letter.
368 Depending on how your copy of MH was compiled, you may need to change the
369 setting of the variable `mh-redist-full-contents'. See its documentation."
370 (interactive (list (mh-read-address "Redist-To: ")
371 (mh-read-address "Redist-Cc: ")
374 (setq msg (mh-get-msg-num t)))
375 (save-window-excursion
376 (let ((folder mh-current-folder)
377 (draft (mh-read-draft "redistribution"
378 (if mh-redist-full-contents
379 (mh-msg-filename msg)
382 (mh-goto-header-end 0)
383 (insert "Resent-To: " to "\n")
384 (if (not (equal cc "")) (insert "Resent-cc: " cc "\n"))
385 (mh-clean-msg-header (point-min)
386 "^Message-Id:\\|^Received:\\|^Return-Path:\\|^Sender:\\|^Date:\\|^From:"
389 (message "Redistributing...")
390 (if mh-redist-full-contents
391 (call-process "/bin/sh" nil 0 nil "-c"
392 (format "mhdist=1 mhaltmsg=%s %s -push %s"
394 (expand-file-name mh-send-prog mh-progs)
396 (call-process "/bin/sh" nil 0 nil "-c"
397 (format "mhdist=1 mhaltmsg=%s mhannotate=1 %s -push %s"
398 (mh-msg-filename msg folder)
399 (expand-file-name mh-send-prog mh-progs)
401 (mh-annotate-msg msg folder mh-note-dist
402 "-component" "Resent:"
403 "-text" (format "\"%s %s\"" to cc))
405 (message "Redistributing...done"))))
408 (defun mh-reply (message &optional includep)
409 "Reply to MESSAGE (default: current message).
410 If optional prefix argument INCLUDEP provided, then include the message
411 in the reply using filter `mhl.reply' in your MH directory.
412 Prompts for type of addresses to reply to:
414 to sender and primary recipients,
415 cc/all sender and all recipients.
416 If the file named by `mh-repl-formfile' exists, it is used as a skeleton
417 for the reply. See also documentation for `\\[mh-send]' function."
418 (interactive (list (mh-get-msg-num t) current-prefix-arg))
419 (let ((minibuffer-help-form
420 "from => Sender only\nto => Sender and primary recipients\ncc or all => Sender and all recipients"))
421 (let* ((reply-to (or mh-reply-default-reply-to
422 (completing-read "Reply to whom: "
423 '(("from") ("to") ("cc") ("all"))
426 (folder mh-current-folder)
427 (show-buffer mh-show-buffer)
428 (config (current-window-configuration))
429 (group-reply (or (equal reply-to "cc") (equal reply-to "all")))
430 (form-file (cond ((and mh-nmh-p group-reply
431 (stringp mh-repl-group-formfile))
432 mh-repl-group-formfile)
433 ((stringp mh-repl-formfile) mh-repl-formfile)
435 (message "Composing a reply...")
436 (mh-exec-cmd "repl" "-build" "-noquery" "-nodraftfolder"
438 (list "-form" form-file))
439 mh-current-folder message
440 (cond ((or (equal reply-to "from") (equal reply-to ""))
442 ((equal reply-to "to")
444 (group-reply (if mh-nmh-p
445 '("-group" "-nocc" "me")
446 '("-cc" "all" "-nocc" "me"))))
448 '("-filter" "mhl.reply")))
449 (let ((draft (mh-read-draft "reply"
450 (expand-file-name "reply" mh-user-path)
452 (delete-other-windows)
455 (let ((to (mh-get-header-field "To:"))
456 (subject (mh-get-header-field "Subject:"))
457 (cc (mh-get-header-field "Cc:")))
458 (goto-char (point-min))
459 (mh-goto-header-end 1)
461 (mh-in-show-buffer (show-buffer)
462 (mh-display-msg message folder)))
463 (mh-add-msgs-to-seq message 'answered t)
464 (message "Composing a reply...done")
465 (mh-compose-and-send-mail draft "" folder message to subject cc
466 mh-note-repl "Replied:" config))))))
469 (defun mh-send (to cc subject)
470 "Compose and send a letter.
471 The file named by `mh-comp-formfile' will be used as the form.
472 Do not call this function from outside mh-e; use \\[mh-smail] instead.
474 The letter is composed in mh-letter-mode; see its documentation for more
475 details. If `mh-compose-letter-function' is defined, it is called on the
476 draft and passed three arguments: TO, SUBJECT, and CC."
478 (mh-read-address "To: ")
479 (mh-read-address "Cc: ")
480 (read-string "Subject: ")))
481 (let ((config (current-window-configuration)))
482 (delete-other-windows)
483 (mh-send-sub to cc subject config)))
486 (defun mh-send-other-window (to cc subject)
487 "Compose and send a letter in another window.
488 Do not call this function from outside mh-e;
489 use \\[mh-smail-other-window] instead.
490 See also documentation for `\\[mh-send]' function."
492 (mh-read-address "To: ")
493 (mh-read-address "Cc: ")
494 (read-string "Subject: ")))
495 (let ((pop-up-windows t))
496 (mh-send-sub to cc subject (current-window-configuration))))
499 (defun mh-send-sub (to cc subject config)
500 ;; Do the real work of composing and sending a letter.
501 ;; Expects the TO, CC, and SUBJECT fields as arguments.
502 ;; CONFIG is the window configuration before sending mail.
503 (let ((folder mh-current-folder)
504 (msg-num (mh-get-msg-num nil)))
505 (message "Composing a message...")
506 (let ((draft (mh-read-draft
512 (expand-file-name mh-comp-formfile mh-user-path)))
516 (expand-file-name mh-comp-formfile mh-lib)))
520 (expand-file-name mh-comp-formfile mh-etc)))
523 (error (format "Can't find components file \"%s\""
526 (mh-insert-fields "To:" to "Subject:" subject "Cc:" cc)
527 (goto-char (point-max))
528 (message "Composing a message...done")
529 (mh-compose-and-send-mail draft "" folder msg-num
534 (defun mh-read-draft (use initial-contents delete-contents-file)
535 ;; Read draft file into a draft buffer and make that buffer the current one.
536 ;; USE is a message used for prompting about the intended use of the message.
537 ;; INITIAL-CONTENTS is filename that is read into an empty buffer, or NIL
538 ;; if buffer should not be modified. Delete the initial-contents file if
539 ;; DELETE-CONTENTS-FILE flag is set.
540 ;; Returns the draft folder's name.
541 ;; If the draft folder facility is enabled in ~/.mh_profile, a new buffer is
542 ;; used each time and saved in the draft folder. The draft file can then be
544 (cond (mh-draft-folder
545 (let ((orig-default-dir default-directory)
546 (draft-file-name (mh-new-draft-name)))
547 (pop-to-buffer (generate-new-buffer
549 (file-name-nondirectory draft-file-name))))
551 (insert-file-contents draft-file-name t)
553 (setq default-directory orig-default-dir)))
555 (let ((draft-name (expand-file-name "draft" mh-user-path)))
556 (pop-to-buffer "draft") ; Create if necessary
557 (if (buffer-modified-p)
558 (if (y-or-n-p "Draft has been modified; kill anyway? ")
559 (set-buffer-modified-p nil)
560 (error "Draft preserved")))
561 (setq buffer-file-name draft-name)
562 (clear-visited-file-modtime)
564 (cond ((and (file-exists-p draft-name)
565 (not (equal draft-name initial-contents)))
566 (insert-file-contents draft-name)
567 (delete-file draft-name))))))
568 (cond ((and initial-contents
569 (or (zerop (buffer-size))
571 (format "A draft exists. Use for %s? " use))
572 (if mh-error-if-no-draft
573 (error "A prior draft exists."))
576 (insert-file-contents initial-contents)
577 (if delete-contents-file (delete-file initial-contents))))
580 (save-buffer)) ; Do not reuse draft name
584 (defun mh-new-draft-name ()
585 ;; Returns the pathname of folder for draft messages.
587 (mh-exec-cmd-quiet t "mhpath" mh-draft-folder "new")
588 (buffer-substring (point-min) (1- (point-max)))))
591 (defun mh-annotate-msg (msg buffer note &rest args)
592 ;; Mark the MESSAGE in BUFFER listing with the character NOTE and annotate
593 ;; the saved message with ARGS.
594 (apply 'mh-exec-cmd "anno" buffer msg args)
596 (cond ((get-buffer buffer) ; Buffer may be deleted
599 (mh-notate-seq msg note (1+ mh-cmd-note))
600 (mh-notate msg note (1+ mh-cmd-note)))))))
603 (defun mh-insert-fields (&rest name-values)
604 ;; Insert the NAME-VALUE pairs in the current buffer.
605 ;; If field NAME exists, append VALUE to it.
606 ;; Do not insert any pairs whose value is the empty string.
607 (let ((case-fold-search t))
609 (let ((field-name (car name-values))
610 (value (car (cdr name-values))))
611 (cond ((equal value "")
613 ((mh-position-on-field field-name)
616 (insert field-name " " value "\n")))
617 (setq name-values (cdr (cdr name-values)))))))
620 (defun mh-position-on-field (field &optional ignore)
621 ;; Move to the end of the FIELD in the header.
622 ;; Move to end of entire header if FIELD not found.
623 ;; Returns non-nil iff FIELD was found.
624 ;; The optional second arg is for pre-version 4 compatibility.
625 (if (mh-goto-header-field field)
627 (mh-header-field-end)
631 (defun mh-get-header-field (field)
632 ;; Find and return the body of FIELD in the mail header.
633 ;; Returns the empty string if the field is not in the header of the
635 (if (mh-goto-header-field field)
637 (skip-chars-forward " \t") ;strip leading white space in body
638 (let ((start (point)))
639 (mh-header-field-end)
640 (buffer-substring start (point))))
643 (fset 'mh-get-field 'mh-get-header-field) ;mh-e 4 compatibility
645 (defun mh-goto-header-field (field)
646 ;; Move to FIELD in the message header.
647 ;; Move to the end of the FIELD name, which should end in a colon.
648 ;; Returns T if found, NIL if not.
649 (goto-char (point-min))
650 (let ((case-fold-search t)
651 (headers-end (save-excursion
652 (mh-goto-header-end 0)
654 (re-search-forward (format "^%s" field) headers-end t)))
656 (defun mh-header-field-end ()
657 ;; Move to the end of the current header field.
658 ;; Handles RFC 822 continuation lines.
660 (while (looking-at "^[ \t]")
662 (backward-char 1)) ;to end of previous line
665 (defun mh-goto-header-end (arg)
666 ;; Find the end of the message header in the current buffer and position
667 ;; the cursor at the ARG'th newline after the header.
668 (if (re-search-forward "^-*$" nil nil)
672 (defun mh-read-address (prompt)
673 ;; Read a To: or Cc: address, prompting in the minibuffer with PROMPT.
674 ;; May someday do completion on aliases.
675 (read-string prompt))
679 ;;; Mode for composing and sending a draft message.
681 (defvar mh-sent-from-folder nil) ;Folder of msg assoc with this letter.
683 (defvar mh-sent-from-msg nil) ;Number of msg assoc with this letter.
685 (defvar mh-send-args nil) ;Extra args to pass to "send" command.
687 (defvar mh-annotate-char nil) ;Character to use to annotate mh-sent-from-msg.
689 (defvar mh-annotate-field nil) ;Field name for message annotation.
691 (put 'mh-letter-mode 'mode-class 'special)
694 (defun mh-letter-mode ()
695 "Mode for composing letters in mh-e.\\<mh-letter-mode-map>
696 When you have finished composing, type \\[mh-send-letter] to send the message
697 using the MH mail handling system.
698 See the documentation for \\[mh-edit-mhn] for information on composing MIME
701 \\{mh-letter-mode-map}
703 Variables controlling this mode (defaults in parentheses):
705 mh-delete-yanked-msg-window (nil)
706 If non-nil, \\[mh-yank-cur-msg] will delete any windows displaying
709 mh-yank-from-start-of-msg (t)
710 If non-nil, \\[mh-yank-cur-msg] will include the entire message.
711 If `body', just yank the body (no header).
712 If nil, only the portion of the message following the point will be yanked.
713 If there is a region, this variable is ignored.
715 mh-ins-buf-prefix (\"> \")
716 String to insert before each non-blank line of a message as it is
717 inserted in a draft letter.
719 mh-signature-file-name (\"~/.signature\")
720 File to be inserted into message by \\[mh-insert-signature].
722 This command runs the normal hooks `text-mode-hook' and `mh-letter-mode-hook'."
725 (or mh-user-path (mh-find-path))
726 (make-local-variable 'paragraph-start)
727 (setq paragraph-start (concat "^[ \t]*[-_][-_][-_]+$\\|" paragraph-start))
728 (make-local-variable 'paragraph-separate)
729 (setq paragraph-separate
730 (concat "^[ \t]*[-_][-_][-_]+$\\|" paragraph-separate))
731 (make-local-variable 'mh-send-args)
732 (make-local-variable 'mh-annotate-char)
733 (make-local-variable 'mh-annotate-field)
734 (make-local-variable 'mh-previous-window-config)
735 (make-local-variable 'mh-sent-from-folder)
736 (make-local-variable 'mh-sent-from-msg)
737 (make-local-variable 'mail-header-separator)
738 (setq mail-header-separator "--------") ;for Hyperbole
739 (use-local-map mh-letter-mode-map)
740 (setq major-mode 'mh-letter-mode)
741 (mh-set-mode-name "MH-Letter")
742 (set-syntax-table mh-letter-mode-syntax-table)
743 (run-hooks 'text-mode-hook)
744 ;; if text-mode-hook turned on auto-fill, tune it for messages
745 (cond ((and (boundp 'auto-fill-hook) auto-fill-hook) ;emacs 18
746 (make-local-variable 'auto-fill-hook)
747 (setq auto-fill-hook 'mh-auto-fill-for-letter)))
748 (cond ((and (boundp 'auto-fill-function) auto-fill-function) ;emacs 19
749 (make-local-variable 'auto-fill-function)
750 (setq auto-fill-function 'mh-auto-fill-for-letter)))
751 (run-hooks 'mh-letter-mode-hook))
754 (defun mh-auto-fill-for-letter ()
755 ;; Auto-fill in letters treats the header specially by inserting a tab
756 ;; before continuation line.
758 (let ((fill-prefix "\t"))
763 (defun mh-in-header-p ()
764 ;; Return non-nil if the point is in the header of a draft message.
766 (let ((cur-point (point)))
767 (goto-char (point-min))
768 (re-search-forward "^-*$" nil t)
769 (< cur-point (point)))))
772 (defun mh-to-field ()
773 "Move point to the end of a specified header field.
774 The field is indicated by the previous keystroke (the last keystroke
775 of the command) according to the list in the variable `mh-to-field-choices'.
776 Create the field if it does not exist. Set the mark to point before moving."
779 (let ((target (cdr (or (assoc (char-to-string (logior last-input-char ?`))
781 ;; also look for a char for version 4 compat
782 (assoc (logior last-input-char ?`) mh-to-field-choices))))
783 (case-fold-search t))
785 (cond ((mh-position-on-field target)
787 (skip-chars-backward " \t")
788 (delete-region (point) eol))
789 (if (and (not (eq (logior last-input-char ?`) ?s))
792 (not (looking-at "[:,]"))))
796 (if (mh-position-on-field "To:")
798 (insert (format "%s \n" target))
799 (backward-char 1)))))
802 (defun mh-to-fcc (&optional folder)
803 "Insert an Fcc: FOLDER field in the current message.
804 Prompt for the field name with a completion list of the current folders."
807 (setq folder (mh-prompt-for-folder
809 (or (and mh-default-folder-for-message-function
811 (goto-char (point-min))
812 (funcall mh-default-folder-for-message-function)))
815 (let ((last-input-char ?\C-f))
819 (insert (if (mh-folder-name-p folder)
824 (defun mh-insert-signature ()
825 "Insert the file named by `mh-signature-file-name' at point."
827 (insert-file-contents mh-signature-file-name)
828 (force-mode-line-update))
831 (defun mh-check-whom ()
832 "Verify recipients of the current letter, showing expansion of any aliases."
834 (let ((file-name buffer-file-name))
836 (message "Checking recipients...")
837 (mh-in-show-buffer ("*Recipients*")
838 (bury-buffer (current-buffer))
840 (mh-exec-cmd-output "whom" t file-name))
841 (message "Checking recipients...done")))
845 ;;; Routines to compose and send a letter.
847 (defun mh-compose-and-send-mail (draft send-args
848 sent-from-folder sent-from-msg
850 annotate-char annotate-field
852 ;; Edit and compose a draft message in buffer DRAFT and send or save it.
853 ;; SENT-FROM-FOLDER is buffer containing scan listing of current folder, or
854 ;; nil if none exists.
855 ;; SENT-FROM-MSG is the message number or sequence name or nil.
856 ;; SEND-ARGS is an optional argument passed to the send command.
857 ;; The TO, SUBJECT, and CC fields are passed to the
858 ;; mh-compose-letter-function.
859 ;; If ANNOTATE-CHAR is non-null, it is used to notate the scan listing of the
860 ;; message. In that case, the ANNOTATE-FIELD is used to build a string
861 ;; for mh-annotate-msg.
862 ;; CONFIG is the window configuration to restore after sending the letter.
863 (pop-to-buffer draft)
865 (setq mh-sent-from-folder sent-from-folder)
866 (setq mh-sent-from-msg sent-from-msg)
867 (setq mh-send-args send-args)
868 (setq mh-annotate-char annotate-char)
869 (setq mh-annotate-field annotate-field)
870 (setq mh-previous-window-config config)
871 (setq mode-line-buffer-identification (list "{%b}"))
872 (if (and (boundp 'mh-compose-letter-function)
873 mh-compose-letter-function)
874 ;; run-hooks will not pass arguments.
875 (let ((value mh-compose-letter-function))
876 (if (and (listp value) (not (eq (car value) 'lambda)))
878 (funcall (car value) to subject cc)
879 (setq value (cdr value)))
880 (funcall mh-compose-letter-function to subject cc)))))
883 (defun mh-send-letter (&optional arg)
884 "Send the draft letter in the current buffer.
885 If optional prefix argument is provided, monitor delivery.
886 Run `mh-before-send-letter-hook' before actually doing anything."
888 (run-hooks 'mh-before-send-letter-hook)
890 (message "Sending...")
891 (let ((draft-buffer (current-buffer))
892 (file-name buffer-file-name)
893 (config mh-previous-window-config)
894 (coding-system-for-write
895 (if (and (local-variable-p 'buffer-file-coding-system)
896 ;; We're not sure why, but buffer-file-coding-system
897 ;; tends to get set to undecided-unix.
898 (not (memq buffer-file-coding-system
899 '(undecided undecided-unix undecided-dos))))
900 buffer-file-coding-system
901 (or sendmail-coding-system
902 default-buffer-file-coding-system
905 (pop-to-buffer "MH mail delivery")
907 (mh-exec-cmd-output mh-send-prog t "-watch" "-nopush"
908 "-nodraftfolder" mh-send-args file-name)
909 (goto-char (point-max)) ; show the interesting part
911 (set-buffer draft-buffer)) ; for annotation below
913 (mh-exec-cmd-daemon mh-send-prog "-nodraftfolder" "-noverbose"
914 mh-send-args file-name)))
916 (mh-annotate-msg mh-sent-from-msg
919 "-component" mh-annotate-field
920 "-text" (format "\"%s %s\""
921 (mh-get-header-field "To:")
922 (mh-get-header-field "Cc:"))))
925 (y-or-n-p "Kill draft buffer? "))
926 (kill-buffer draft-buffer)
928 (set-window-configuration config))))
930 (message "Sending...done")
931 (message "Sending...backgrounded"))))
934 (defun mh-insert-letter (folder message verbatim)
935 "Insert a message into the current letter.
936 Removes the message's headers using `mh-invisible-headers'. Prefixes
937 each non-blank line with `mh-ins-buf-prefix'. Prompts for FOLDER and
938 MESSAGE. If prefix argument VERBATIM provided, do not indent and do
939 not delete headers. Leaves the mark before the letter and point after it."
941 (list (mh-prompt-for-folder "Message from" mh-sent-from-folder nil)
942 (read-input (format "Message number%s: "
944 (format " [%d]" mh-sent-from-msg)
948 (narrow-to-region (point) (point))
949 (let ((start (point-min)))
950 (if (equal message "") (setq message (int-to-string mh-sent-from-msg)))
951 (mh-exec-lib-cmd-output "mhl" "-nobell" "-noclear"
952 (expand-file-name message
953 (mh-expand-file-name folder)))
954 (cond ((not verbatim)
955 (mh-clean-msg-header start mh-invisible-headers mh-visible-headers)
956 (set-mark start) ; since mh-clean-msg-header moves it
957 (mh-insert-prefix-string mh-ins-buf-prefix))))))
960 (defun mh-yank-cur-msg ()
961 "Insert the current message into the draft buffer.
962 Prefix each non-blank line in the message with the string in
963 `mh-ins-buf-prefix'. If a region is set in the message's buffer, then
964 only the region will be inserted. Otherwise, the entire message will
965 be inserted if `mh-yank-from-start-of-msg' is non-nil. If this variable
966 is nil, the portion of the message following the point will be yanked.
967 If `mh-delete-yanked-msg-window' is non-nil, any window displaying the
968 yanked message will be deleted."
970 (if (and mh-sent-from-folder mh-sent-from-msg)
971 (let ((to-point (point))
972 (to-buffer (current-buffer)))
973 (set-buffer mh-sent-from-folder)
974 (if mh-delete-yanked-msg-window
975 (delete-windows-on mh-show-buffer))
976 (set-buffer mh-show-buffer) ; Find displayed message
977 (let ((mh-ins-str (cond ((if (boundp 'mark-active)
978 mark-active ;Emacs 19
980 (buffer-substring (region-beginning)
982 ((eq 'body mh-yank-from-start-of-msg)
985 (goto-char (point-min))
986 (mh-goto-header-end 1)
989 (mh-yank-from-start-of-msg
990 (buffer-substring (point-min) (point-max)))
992 (buffer-substring (point) (point-max))))))
993 (set-buffer to-buffer)
995 (narrow-to-region to-point to-point)
998 (mh-insert-prefix-string mh-ins-buf-prefix)
1000 (error "There is no current message")))
1003 (defun mh-insert-prefix-string (mh-ins-string)
1004 ;; Run mail-citation-hook to insert a prefix string before each line
1005 ;; in the buffer. Generality for supercite users.
1006 (set-mark (point-max))
1007 (goto-char (point-min))
1008 (cond (mail-citation-hook
1009 (run-hooks 'mail-citation-hook))
1010 (mh-yank-hooks ;old hook name
1011 (run-hooks 'mh-yank-hooks))
1013 (or (bolp) (forward-line 1))
1014 (let ((zmacs-regions nil)) ;so "(mark)" works in XEmacs
1015 (while (< (point) (mark))
1016 (insert mh-ins-string)
1017 (forward-line 1))))))
1020 (defun mh-fully-kill-draft ()
1021 "Kill the draft message file and the draft message buffer.
1022 Use \\[kill-buffer] if you don't want to delete the draft message file."
1024 (if (y-or-n-p "Kill draft message? ")
1025 (let ((config mh-previous-window-config))
1026 (if (file-exists-p buffer-file-name)
1027 (delete-file buffer-file-name))
1028 (set-buffer-modified-p nil)
1029 (kill-buffer (buffer-name))
1032 (set-window-configuration config)))
1033 (error "Message not killed")))
1036 ;;; Build the letter-mode keymap:
1038 (define-key mh-letter-mode-map "\C-c\C-f\C-b" 'mh-to-field)
1039 (define-key mh-letter-mode-map "\C-c\C-f\C-c" 'mh-to-field)
1040 (define-key mh-letter-mode-map "\C-c\C-f\C-d" 'mh-to-field)
1041 (define-key mh-letter-mode-map "\C-c\C-f\C-f" 'mh-to-fcc)
1042 (define-key mh-letter-mode-map "\C-c\C-f\C-r" 'mh-to-field)
1043 (define-key mh-letter-mode-map "\C-c\C-f\C-s" 'mh-to-field)
1044 (define-key mh-letter-mode-map "\C-c\C-f\C-t" 'mh-to-field)
1045 (define-key mh-letter-mode-map "\C-c\C-fb" 'mh-to-field)
1046 (define-key mh-letter-mode-map "\C-c\C-fc" 'mh-to-field)
1047 (define-key mh-letter-mode-map "\C-c\C-fd" 'mh-to-field)
1048 (define-key mh-letter-mode-map "\C-c\C-ff" 'mh-to-fcc)
1049 (define-key mh-letter-mode-map "\C-c\C-fr" 'mh-to-field)
1050 (define-key mh-letter-mode-map "\C-c\C-fs" 'mh-to-field)
1051 (define-key mh-letter-mode-map "\C-c\C-ft" 'mh-to-field)
1052 (define-key mh-letter-mode-map "\C-c\C-i" 'mh-insert-letter)
1053 (define-key mh-letter-mode-map "\C-c\C-q" 'mh-fully-kill-draft)
1054 (define-key mh-letter-mode-map "\C-c\C-\\" 'mh-fully-kill-draft) ;if no C-q
1055 (define-key mh-letter-mode-map "\C-c\C-s" 'mh-insert-signature)
1056 (define-key mh-letter-mode-map "\C-c\C-^" 'mh-insert-signature) ;if no C-s
1057 (define-key mh-letter-mode-map "\C-c\C-w" 'mh-check-whom)
1058 (define-key mh-letter-mode-map "\C-c\C-y" 'mh-yank-cur-msg)
1059 (define-key mh-letter-mode-map "\C-c\C-c" 'mh-send-letter)
1060 (define-key mh-letter-mode-map "\C-c\C-m\C-f" 'mh-mhn-compose-forw)
1061 (define-key mh-letter-mode-map "\C-c\C-m\C-e" 'mh-mhn-compose-anon-ftp)
1062 (define-key mh-letter-mode-map "\C-c\C-m\C-t" 'mh-mhn-compose-external-compressed-tar)
1063 (define-key mh-letter-mode-map "\C-c\C-m\C-i" 'mh-mhn-compose-insertion)
1064 (define-key mh-letter-mode-map "\C-c\C-e" 'mh-edit-mhn)
1065 (define-key mh-letter-mode-map "\C-c\C-m\C-u" 'mh-revert-mhn-edit)
1067 ;; "C-c /" prefix is used in mh-letter-mode by pgp.el
1069 ;;; autoloads from mh-mime
1071 (autoload 'mh-mhn-compose-insertion "mh-mime"
1072 "Add a directive to insert a MIME message part from a file.
1073 This is the typical way to insert non-text parts in a message.
1074 See also \\[mh-edit-mhn]." t)
1076 (autoload 'mh-mhn-compose-anon-ftp "mh-mime"
1077 "Add a directive for a MIME anonymous ftp external body part.
1078 This directive tells MH to include a reference to a
1079 message/external-body part retrievable by anonymous FTP.
1080 See also \\[mh-edit-mhn]." t)
1082 (autoload 'mh-mhn-compose-external-compressed-tar "mh-mime"
1083 "Add a directive to include a MIME reference to a compressed tar file.
1084 The file should be available via anonymous ftp. This directive
1085 tells MH to include a reference to a message/external-body part.
1086 See also \\[mh-edit-mhn]." t)
1088 (autoload 'mh-mhn-compose-forw "mh-mime"
1089 "Add a forw directive to this message, to forward a message with MIME.
1090 This directive tells MH to include another message in this one.
1091 See also \\[mh-edit-mhn]." t)
1093 (autoload 'mh-edit-mhn "mh-mime"
1094 "Format the current draft for MIME, expanding any mhn directives.
1095 Process the current draft with the mhn program, which,
1096 using directives already inserted in the draft, fills in
1097 all the MIME components and header fields.
1098 This step should be done last just before sending the message.
1099 The mhn program is part of MH version 6.8 or later.
1100 The \\[mh-revert-mhn-edit] command undoes this command.
1101 For assistance with creating mhn directives to insert
1102 various types of components in a message, see
1103 \\[mh-mhn-compose-insertion] (generic insertion from a file),
1104 \\[mh-mhn-compose-anon-ftp] (external reference to file via anonymous ftp),
1105 \\[mh-mhn-compose-external-compressed-tar] \
1106 \(reference to compressed tar file via anonymous ftp), and
1107 \\[mh-mhn-compose-forw] (forward message)." t)
1109 (autoload 'mh-revert-mhn-edit "mh-mime"
1110 "Undoes the effect of \\[mh-edit-mhn] by reverting to the backup file.
1111 Optional non-nil argument means don't ask for confirmation." t)