]> code.delx.au - gnu-emacs/blob - lisp/mail/mh-comp.el
(mh-send-sub): Check mh-etc is bound before using it.
[gnu-emacs] / lisp / mail / mh-comp.el
1 ;;; mh-comp --- mh-e functions for composing messages
2 ;; Time-stamp: <95/08/19 17:48:59 gildea>
3
4 ;; Copyright (C) 1993, 1995, 1997 Free Software Foundation, Inc.
5
6 ;; This file is part of mh-e, part of GNU Emacs.
7
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)
11 ;; any later version.
12
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.
17
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.
22
23 ;;; Commentary:
24
25 ;; Internal support for mh-e package.
26
27 ;;; Change Log:
28
29 ;; $Id: mh-comp.el,v 1.17 2000/04/27 18:56:42 gerd Exp $
30
31 ;;; Code:
32
33 (provide 'mh-comp)
34 (require 'mh-utils)
35
36 ;;; Site customization (see also mh-utils.el):
37
38 (defgroup mh-compose nil
39 "Mh-e functions for composing messages"
40 :prefix "mh-"
41 :group 'mh)
42
43
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.")
47
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.")
52
53
54 (defvar mh-note-repl "-"
55 "String whose first character is used to notate replied to messages.")
56
57 (defvar mh-note-forw "F"
58 "String whose first character is used to notate forwarded messages.")
59
60 (defvar mh-note-dist "R"
61 "String whose first character is used to notate redistributed messages.")
62
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
67 text as modified.
68
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.")
71
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
76 text as modified.
77
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.
80
81 See also the variable `mh-yank-from-start-of-msg', which controls how
82 much of the message passed to the hook.")
83
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.")
87
88 ;;; Personal preferences:
89
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."
94 :type 'boolean
95 :group 'mh-compose)
96
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
102 ignored."
103 :type '(choice (const :tag "Below point" nil)
104 (const :tag "Without header" body)
105 (other :tag "Entire message" t))
106 :group 'mh-compose)
107
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]."
112 :type 'string
113 :group 'mh-compose)
114
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"))
123 :group 'mh-compose)
124
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]."
128 :type 'file
129 :group 'mh-compose)
130
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."
135 :type 'string
136 :group 'mh-compose)
137
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.")
143
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.")
149
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
155 MH lib directory.")
156
157 ;;; Hooks:
158
159 (defcustom mh-letter-mode-hook nil
160 "Invoked in `mh-letter-mode' on a new letter."
161 :type 'hook
162 :group 'mh-compose)
163
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."
167 :type 'function
168 :group 'mh-compose)
169
170 (defcustom mh-before-send-letter-hook nil
171 "Invoked at the beginning of the \\<mh-letter-mode-map>\\[mh-send-letter] command."
172 :type 'hook
173 :group 'mh-compose)
174
175
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
184 )
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.")
187
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.")
192
193 (defvar mh-to-field-choices '(("t" . "To:") ("s" . "Subject:") ("c" . "Cc:")
194 ("b" . "Bcc:") ("f" . "Fcc:") ("r" . "From:")
195 ("d" . "Dcc:"))
196 "Alist of (final-character . field-name) choices for mh-to-field.")
197
198 (defvar mh-letter-mode-map (copy-keymap text-mode-map)
199 "Keymap for composing mail.")
200
201 (defvar mh-letter-mode-syntax-table nil
202 "Syntax table used by mh-e while in MH-Letter mode.")
203
204 (if mh-letter-mode-syntax-table
205 ()
206 (setq mh-letter-mode-syntax-table
207 (make-syntax-table text-mode-syntax-table))
208 (modify-syntax-entry ?% "." mh-letter-mode-syntax-table))
209
210
211 ;;;###autoload
212 (defun mh-smail ()
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.
216
217 See documentation of `\\[mh-send]' for more details on composing mail."
218 (interactive)
219 (mh-find-path)
220 (call-interactively 'mh-send))
221
222
223 (defvar mh-error-if-no-draft nil) ;raise error over using old draft
224
225
226 ;;;###autoload
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."
234 (mh-find-path)
235 (let ((mh-error-if-no-draft t))
236 (mh-send (or to "") "" (or subject ""))))
237
238
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))
247 (draft
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))
251 (buffer-name))
252 (t
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))
256 (save-buffer)
257 (mh-compose-and-send-mail draft "" from-folder nil nil nil nil nil nil
258 config)))
259
260
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))
275 (t
276 (message "Does not appear to be a rejected letter.")))
277 (goto-char (point-min))
278 (save-buffer)
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:")
283 nil nil config)))
284
285
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))))
295 (or msg-or-seq
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)
305 (prog1
306 (mh-read-draft "" draft-name t)
307 (mh-insert-fields "To:" to "Cc:" cc)
308 (save-buffer)))
309 (t
310 (mh-read-draft "" draft-name nil))))
311 (fwd-msg-file (mh-msg-filename (if (numberp msg-or-seq)
312 msg-or-seq
313 (car (mh-seq-to-msgs msg-or-seq)))
314 folder)))
315 (let (orig-from
316 orig-subject)
317 (save-excursion
318 (set-buffer (get-buffer-create mh-temp-buffer))
319 (erase-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:")))
323 (let ((forw-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)
328 (forward-line -1)
329 (re-search-forward "^--------")
330 (forward-line 1))
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
336 to forw-subject cc
337 mh-note-forw "Forwarded:"
338 config)))))
339
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))))
348 (comment
349 ;; luser@host (Full Name)
350 (setq from (substring from (1+ comment) (1- (length from)))))))
351 (format mh-forward-subject-format from subject))
352
353
354 ;;;###autoload
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.
359
360 See documentation of `\\[mh-send]' for more details on composing mail."
361 (interactive)
362 (mh-find-path)
363 (call-interactively 'mh-send-other-window))
364
365
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: ")
372 (mh-get-msg-num t)))
373 (or msg
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)
380 nil)
381 nil)))
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:"
387 nil)
388 (save-buffer)
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"
393 buffer-file-name
394 (expand-file-name mh-send-prog mh-progs)
395 buffer-file-name))
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)
400 buffer-file-name)))
401 (mh-annotate-msg msg folder mh-note-dist
402 "-component" "Resent:"
403 "-text" (format "\"%s %s\"" to cc))
404 (kill-buffer draft)
405 (message "Redistributing...done"))))
406
407
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:
413 from sender only,
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"))
424 nil
425 t)))
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)
434 (t nil))))
435 (message "Composing a reply...")
436 (mh-exec-cmd "repl" "-build" "-noquery" "-nodraftfolder"
437 (if form-file
438 (list "-form" form-file))
439 mh-current-folder message
440 (cond ((or (equal reply-to "from") (equal reply-to ""))
441 '("-nocc" "all"))
442 ((equal reply-to "to")
443 '("-cc" "to"))
444 (group-reply (if mh-nmh-p
445 '("-group" "-nocc" "me")
446 '("-cc" "all" "-nocc" "me"))))
447 (if includep
448 '("-filter" "mhl.reply")))
449 (let ((draft (mh-read-draft "reply"
450 (expand-file-name "reply" mh-user-path)
451 t)))
452 (delete-other-windows)
453 (save-buffer)
454
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)
460 (or includep
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))))))
467
468
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.
473
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."
477 (interactive (list
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)))
484
485
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."
491 (interactive (list
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))))
497
498
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
507 "message"
508 (let (components)
509 (cond
510 ((file-exists-p
511 (setq components
512 (expand-file-name mh-comp-formfile mh-user-path)))
513 components)
514 ((file-exists-p
515 (setq components
516 (expand-file-name mh-comp-formfile mh-lib)))
517 components)
518 ((file-exists-p
519 (setq components
520 (expand-file-name mh-comp-formfile
521 ;; What is this mh-etc ?? -sm
522 (and (boundp 'mh-etc) mh-etc))))
523 components)
524 (t
525 (error (format "Can't find components file \"%s\""
526 components)))))
527 nil)))
528 (mh-insert-fields "To:" to "Subject:" subject "Cc:" cc)
529 (goto-char (point-max))
530 (message "Composing a message...done")
531 (mh-compose-and-send-mail draft "" folder msg-num
532 to subject cc
533 nil nil config))))
534
535
536 (defun mh-read-draft (use initial-contents delete-contents-file)
537 ;; Read draft file into a draft buffer and make that buffer the current one.
538 ;; USE is a message used for prompting about the intended use of the message.
539 ;; INITIAL-CONTENTS is filename that is read into an empty buffer, or NIL
540 ;; if buffer should not be modified. Delete the initial-contents file if
541 ;; DELETE-CONTENTS-FILE flag is set.
542 ;; Returns the draft folder's name.
543 ;; If the draft folder facility is enabled in ~/.mh_profile, a new buffer is
544 ;; used each time and saved in the draft folder. The draft file can then be
545 ;; reused.
546 (cond (mh-draft-folder
547 (let ((orig-default-dir default-directory)
548 (draft-file-name (mh-new-draft-name)))
549 (pop-to-buffer (generate-new-buffer
550 (format "draft-%s"
551 (file-name-nondirectory draft-file-name))))
552 (condition-case ()
553 (insert-file-contents draft-file-name t)
554 (file-error))
555 (setq default-directory orig-default-dir)))
556 (t
557 (let ((draft-name (expand-file-name "draft" mh-user-path)))
558 (pop-to-buffer "draft") ; Create if necessary
559 (if (buffer-modified-p)
560 (if (y-or-n-p "Draft has been modified; kill anyway? ")
561 (set-buffer-modified-p nil)
562 (error "Draft preserved")))
563 (setq buffer-file-name draft-name)
564 (clear-visited-file-modtime)
565 (unlock-buffer)
566 (cond ((and (file-exists-p draft-name)
567 (not (equal draft-name initial-contents)))
568 (insert-file-contents draft-name)
569 (delete-file draft-name))))))
570 (cond ((and initial-contents
571 (or (zerop (buffer-size))
572 (if (y-or-n-p
573 (format "A draft exists. Use for %s? " use))
574 (if mh-error-if-no-draft
575 (error "A prior draft exists."))
576 t)))
577 (erase-buffer)
578 (insert-file-contents initial-contents)
579 (if delete-contents-file (delete-file initial-contents))))
580 (auto-save-mode 1)
581 (if mh-draft-folder
582 (save-buffer)) ; Do not reuse draft name
583 (buffer-name))
584
585
586 (defun mh-new-draft-name ()
587 ;; Returns the pathname of folder for draft messages.
588 (save-excursion
589 (mh-exec-cmd-quiet t "mhpath" mh-draft-folder "new")
590 (buffer-substring (point-min) (1- (point-max)))))
591
592
593 (defun mh-annotate-msg (msg buffer note &rest args)
594 ;; Mark the MESSAGE in BUFFER listing with the character NOTE and annotate
595 ;; the saved message with ARGS.
596 (apply 'mh-exec-cmd "anno" buffer msg args)
597 (save-excursion
598 (cond ((get-buffer buffer) ; Buffer may be deleted
599 (set-buffer buffer)
600 (if (symbolp msg)
601 (mh-notate-seq msg note (1+ mh-cmd-note))
602 (mh-notate msg note (1+ mh-cmd-note)))))))
603
604
605 (defun mh-insert-fields (&rest name-values)
606 ;; Insert the NAME-VALUE pairs in the current buffer.
607 ;; If field NAME exists, append VALUE to it.
608 ;; Do not insert any pairs whose value is the empty string.
609 (let ((case-fold-search t))
610 (while name-values
611 (let ((field-name (car name-values))
612 (value (car (cdr name-values))))
613 (cond ((equal value "")
614 nil)
615 ((mh-position-on-field field-name)
616 (insert " " value))
617 (t
618 (insert field-name " " value "\n")))
619 (setq name-values (cdr (cdr name-values)))))))
620
621
622 (defun mh-position-on-field (field &optional ignore)
623 ;; Move to the end of the FIELD in the header.
624 ;; Move to end of entire header if FIELD not found.
625 ;; Returns non-nil iff FIELD was found.
626 ;; The optional second arg is for pre-version 4 compatibility.
627 (if (mh-goto-header-field field)
628 (progn
629 (mh-header-field-end)
630 t)))
631
632
633 (defun mh-get-header-field (field)
634 ;; Find and return the body of FIELD in the mail header.
635 ;; Returns the empty string if the field is not in the header of the
636 ;; current buffer.
637 (if (mh-goto-header-field field)
638 (progn
639 (skip-chars-forward " \t") ;strip leading white space in body
640 (let ((start (point)))
641 (mh-header-field-end)
642 (buffer-substring start (point))))
643 ""))
644
645 (fset 'mh-get-field 'mh-get-header-field) ;mh-e 4 compatibility
646
647 (defun mh-goto-header-field (field)
648 ;; Move to FIELD in the message header.
649 ;; Move to the end of the FIELD name, which should end in a colon.
650 ;; Returns T if found, NIL if not.
651 (goto-char (point-min))
652 (let ((case-fold-search t)
653 (headers-end (save-excursion
654 (mh-goto-header-end 0)
655 (point))))
656 (re-search-forward (format "^%s" field) headers-end t)))
657
658 (defun mh-header-field-end ()
659 ;; Move to the end of the current header field.
660 ;; Handles RFC 822 continuation lines.
661 (forward-line 1)
662 (while (looking-at "^[ \t]")
663 (forward-line 1))
664 (backward-char 1)) ;to end of previous line
665
666
667 (defun mh-goto-header-end (arg)
668 ;; Find the end of the message header in the current buffer and position
669 ;; the cursor at the ARG'th newline after the header.
670 (if (re-search-forward "^-*$" nil nil)
671 (forward-line arg)))
672
673
674 (defun mh-read-address (prompt)
675 ;; Read a To: or Cc: address, prompting in the minibuffer with PROMPT.
676 ;; May someday do completion on aliases.
677 (read-string prompt))
678
679 \f
680
681 ;;; Mode for composing and sending a draft message.
682
683 (defvar mh-sent-from-folder nil) ;Folder of msg assoc with this letter.
684
685 (defvar mh-sent-from-msg nil) ;Number of msg assoc with this letter.
686
687 (defvar mh-send-args nil) ;Extra args to pass to "send" command.
688
689 (defvar mh-annotate-char nil) ;Character to use to annotate mh-sent-from-msg.
690
691 (defvar mh-annotate-field nil) ;Field name for message annotation.
692
693 (put 'mh-letter-mode 'mode-class 'special)
694
695 ;;;###autoload
696 (define-derived-mode mh-letter-mode text-mode "MH-Letter"
697 "Mode for composing letters in mh-e.\\<mh-letter-mode-map>
698 When you have finished composing, type \\[mh-send-letter] to send the message
699 using the MH mail handling system.
700 See the documentation for \\[mh-edit-mhn] for information on composing MIME
701 messages.
702
703 \\{mh-letter-mode-map}
704
705 Variables controlling this mode (defaults in parentheses):
706
707 mh-delete-yanked-msg-window (nil)
708 If non-nil, \\[mh-yank-cur-msg] will delete any windows displaying
709 the yanked message.
710
711 mh-yank-from-start-of-msg (t)
712 If non-nil, \\[mh-yank-cur-msg] will include the entire message.
713 If `body', just yank the body (no header).
714 If nil, only the portion of the message following the point will be yanked.
715 If there is a region, this variable is ignored.
716
717 mh-ins-buf-prefix (\"> \")
718 String to insert before each non-blank line of a message as it is
719 inserted in a draft letter.
720
721 mh-signature-file-name (\"~/.signature\")
722 File to be inserted into message by \\[mh-insert-signature].
723
724 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 ;; if text-mode-hook turned on auto-fill, tune it for messages
740 (when auto-fill-function
741 (make-local-variable 'auto-fill-function)
742 (setq auto-fill-function 'mh-auto-fill-for-letter)))
743
744
745 (defun mh-auto-fill-for-letter ()
746 ;; Auto-fill in letters treats the header specially by inserting a tab
747 ;; before continuation line.
748 (if (mh-in-header-p)
749 (let ((fill-prefix "\t"))
750 (do-auto-fill))
751 (do-auto-fill)))
752
753
754 (defun mh-in-header-p ()
755 ;; Return non-nil if the point is in the header of a draft message.
756 (save-excursion
757 (let ((cur-point (point)))
758 (goto-char (point-min))
759 (re-search-forward "^-*$" nil t)
760 (< cur-point (point)))))
761
762
763 (defun mh-to-field ()
764 "Move point to the end of a specified header field.
765 The field is indicated by the previous keystroke (the last keystroke
766 of the command) according to the list in the variable `mh-to-field-choices'.
767 Create the field if it does not exist. Set the mark to point before moving."
768 (interactive)
769 (expand-abbrev)
770 (let ((target (cdr (or (assoc (char-to-string (logior last-input-char ?`))
771 mh-to-field-choices)
772 ;; also look for a char for version 4 compat
773 (assoc (logior last-input-char ?`) mh-to-field-choices))))
774 (case-fold-search t))
775 (push-mark)
776 (cond ((mh-position-on-field target)
777 (let ((eol (point)))
778 (skip-chars-backward " \t")
779 (delete-region (point) eol))
780 (if (and (not (eq (logior last-input-char ?`) ?s))
781 (save-excursion
782 (backward-char 1)
783 (not (looking-at "[:,]"))))
784 (insert ", ")
785 (insert " ")))
786 (t
787 (if (mh-position-on-field "To:")
788 (forward-line 1))
789 (insert (format "%s \n" target))
790 (backward-char 1)))))
791
792
793 (defun mh-to-fcc (&optional folder)
794 "Insert an Fcc: FOLDER field in the current message.
795 Prompt for the field name with a completion list of the current folders."
796 (interactive)
797 (or folder
798 (setq folder (mh-prompt-for-folder
799 "Fcc"
800 (or (and mh-default-folder-for-message-function
801 (save-excursion
802 (goto-char (point-min))
803 (funcall mh-default-folder-for-message-function)))
804 "")
805 t)))
806 (let ((last-input-char ?\C-f))
807 (expand-abbrev)
808 (save-excursion
809 (mh-to-field)
810 (insert (if (mh-folder-name-p folder)
811 (substring folder 1)
812 folder)))))
813
814
815 (defun mh-insert-signature ()
816 "Insert the file named by `mh-signature-file-name' at point."
817 (interactive)
818 (insert-file-contents mh-signature-file-name)
819 (force-mode-line-update))
820
821
822 (defun mh-check-whom ()
823 "Verify recipients of the current letter, showing expansion of any aliases."
824 (interactive)
825 (let ((file-name buffer-file-name))
826 (save-buffer)
827 (message "Checking recipients...")
828 (mh-in-show-buffer ("*Recipients*")
829 (bury-buffer (current-buffer))
830 (erase-buffer)
831 (mh-exec-cmd-output "whom" t file-name))
832 (message "Checking recipients...done")))
833
834 \f
835
836 ;;; Routines to compose and send a letter.
837
838 (defun mh-compose-and-send-mail (draft send-args
839 sent-from-folder sent-from-msg
840 to subject cc
841 annotate-char annotate-field
842 config)
843 ;; Edit and compose a draft message in buffer DRAFT and send or save it.
844 ;; SENT-FROM-FOLDER is buffer containing scan listing of current folder, or
845 ;; nil if none exists.
846 ;; SENT-FROM-MSG is the message number or sequence name or nil.
847 ;; SEND-ARGS is an optional argument passed to the send command.
848 ;; The TO, SUBJECT, and CC fields are passed to the
849 ;; mh-compose-letter-function.
850 ;; If ANNOTATE-CHAR is non-null, it is used to notate the scan listing of the
851 ;; message. In that case, the ANNOTATE-FIELD is used to build a string
852 ;; for mh-annotate-msg.
853 ;; CONFIG is the window configuration to restore after sending the letter.
854 (pop-to-buffer draft)
855 (mh-letter-mode)
856 (setq mh-sent-from-folder sent-from-folder)
857 (setq mh-sent-from-msg sent-from-msg)
858 (setq mh-send-args send-args)
859 (setq mh-annotate-char annotate-char)
860 (setq mh-annotate-field annotate-field)
861 (setq mh-previous-window-config config)
862 (setq mode-line-buffer-identification (list "{%b}"))
863 (if (and (boundp 'mh-compose-letter-function)
864 mh-compose-letter-function)
865 ;; run-hooks will not pass arguments.
866 (let ((value mh-compose-letter-function))
867 (if (and (listp value) (not (eq (car value) 'lambda)))
868 (while value
869 (funcall (car value) to subject cc)
870 (setq value (cdr value)))
871 (funcall mh-compose-letter-function to subject cc)))))
872
873
874 (defun mh-send-letter (&optional arg)
875 "Send the draft letter in the current buffer.
876 If optional prefix argument is provided, monitor delivery.
877 Run `mh-before-send-letter-hook' before actually doing anything."
878 (interactive "P")
879 (run-hooks 'mh-before-send-letter-hook)
880 (save-buffer)
881 (message "Sending...")
882 (let ((draft-buffer (current-buffer))
883 (file-name buffer-file-name)
884 (config mh-previous-window-config)
885 (coding-system-for-write
886 (if (and (local-variable-p 'buffer-file-coding-system)
887 ;; We're not sure why, but buffer-file-coding-system
888 ;; tends to get set to undecided-unix.
889 (not (memq buffer-file-coding-system
890 '(undecided undecided-unix undecided-dos))))
891 buffer-file-coding-system
892 (or sendmail-coding-system
893 default-buffer-file-coding-system
894 'iso-latin-1))))
895 (cond (arg
896 (pop-to-buffer "MH mail delivery")
897 (erase-buffer)
898 (mh-exec-cmd-output mh-send-prog t "-watch" "-nopush"
899 "-nodraftfolder" mh-send-args file-name)
900 (goto-char (point-max)) ; show the interesting part
901 (recenter -1)
902 (set-buffer draft-buffer)) ; for annotation below
903 (t
904 (mh-exec-cmd-daemon mh-send-prog "-nodraftfolder" "-noverbose"
905 mh-send-args file-name)))
906 (if mh-annotate-char
907 (mh-annotate-msg mh-sent-from-msg
908 mh-sent-from-folder
909 mh-annotate-char
910 "-component" mh-annotate-field
911 "-text" (format "\"%s %s\""
912 (mh-get-header-field "To:")
913 (mh-get-header-field "Cc:"))))
914
915 (cond ((or (not arg)
916 (y-or-n-p "Kill draft buffer? "))
917 (kill-buffer draft-buffer)
918 (if config
919 (set-window-configuration config))))
920 (if arg
921 (message "Sending...done")
922 (message "Sending...backgrounded"))))
923
924
925 (defun mh-insert-letter (folder message verbatim)
926 "Insert a message into the current letter.
927 Removes the message's headers using `mh-invisible-headers'. Prefixes
928 each non-blank line with `mh-ins-buf-prefix'. Prompts for FOLDER and
929 MESSAGE. If prefix argument VERBATIM provided, do not indent and do
930 not delete headers. Leaves the mark before the letter and point after it."
931 (interactive
932 (list (mh-prompt-for-folder "Message from" mh-sent-from-folder nil)
933 (read-input (format "Message number%s: "
934 (if mh-sent-from-msg
935 (format " [%d]" mh-sent-from-msg)
936 "")))
937 current-prefix-arg))
938 (save-restriction
939 (narrow-to-region (point) (point))
940 (let ((start (point-min)))
941 (if (equal message "") (setq message (int-to-string mh-sent-from-msg)))
942 (mh-exec-lib-cmd-output "mhl" "-nobell" "-noclear"
943 (expand-file-name message
944 (mh-expand-file-name folder)))
945 (cond ((not verbatim)
946 (mh-clean-msg-header start mh-invisible-headers mh-visible-headers)
947 (set-mark start) ; since mh-clean-msg-header moves it
948 (mh-insert-prefix-string mh-ins-buf-prefix))))))
949
950
951 (defun mh-yank-cur-msg ()
952 "Insert the current message into the draft buffer.
953 Prefix each non-blank line in the message with the string in
954 `mh-ins-buf-prefix'. If a region is set in the message's buffer, then
955 only the region will be inserted. Otherwise, the entire message will
956 be inserted if `mh-yank-from-start-of-msg' is non-nil. If this variable
957 is nil, the portion of the message following the point will be yanked.
958 If `mh-delete-yanked-msg-window' is non-nil, any window displaying the
959 yanked message will be deleted."
960 (interactive)
961 (if (and mh-sent-from-folder mh-sent-from-msg)
962 (let ((to-point (point))
963 (to-buffer (current-buffer)))
964 (set-buffer mh-sent-from-folder)
965 (if mh-delete-yanked-msg-window
966 (delete-windows-on mh-show-buffer))
967 (set-buffer mh-show-buffer) ; Find displayed message
968 (let ((mh-ins-str (cond ((if (boundp 'mark-active)
969 mark-active ;Emacs 19
970 (mark)) ;Emacs 18
971 (buffer-substring (region-beginning)
972 (region-end)))
973 ((eq 'body mh-yank-from-start-of-msg)
974 (buffer-substring
975 (save-excursion
976 (goto-char (point-min))
977 (mh-goto-header-end 1)
978 (point))
979 (point-max)))
980 (mh-yank-from-start-of-msg
981 (buffer-substring (point-min) (point-max)))
982 (t
983 (buffer-substring (point) (point-max))))))
984 (set-buffer to-buffer)
985 (save-restriction
986 (narrow-to-region to-point to-point)
987 (push-mark)
988 (insert mh-ins-str)
989 (mh-insert-prefix-string mh-ins-buf-prefix)
990 (insert "\n"))))
991 (error "There is no current message")))
992
993
994 (defun mh-insert-prefix-string (mh-ins-string)
995 ;; Run mail-citation-hook to insert a prefix string before each line
996 ;; in the buffer. Generality for supercite users.
997 (set-mark (point-max))
998 (goto-char (point-min))
999 (cond (mail-citation-hook
1000 (run-hooks 'mail-citation-hook))
1001 (mh-yank-hooks ;old hook name
1002 (run-hooks 'mh-yank-hooks))
1003 (t
1004 (or (bolp) (forward-line 1))
1005 (let ((zmacs-regions nil)) ;so "(mark)" works in XEmacs
1006 (while (< (point) (mark))
1007 (insert mh-ins-string)
1008 (forward-line 1))))))
1009
1010
1011 (defun mh-fully-kill-draft ()
1012 "Kill the draft message file and the draft message buffer.
1013 Use \\[kill-buffer] if you don't want to delete the draft message file."
1014 (interactive)
1015 (if (y-or-n-p "Kill draft message? ")
1016 (let ((config mh-previous-window-config))
1017 (if (file-exists-p buffer-file-name)
1018 (delete-file buffer-file-name))
1019 (set-buffer-modified-p nil)
1020 (kill-buffer (buffer-name))
1021 (message "")
1022 (if config
1023 (set-window-configuration config)))
1024 (error "Message not killed")))
1025
1026
1027 ;;; Build the letter-mode keymap:
1028
1029 (define-key mh-letter-mode-map "\C-c\C-f\C-b" 'mh-to-field)
1030 (define-key mh-letter-mode-map "\C-c\C-f\C-c" 'mh-to-field)
1031 (define-key mh-letter-mode-map "\C-c\C-f\C-d" 'mh-to-field)
1032 (define-key mh-letter-mode-map "\C-c\C-f\C-f" 'mh-to-fcc)
1033 (define-key mh-letter-mode-map "\C-c\C-f\C-r" 'mh-to-field)
1034 (define-key mh-letter-mode-map "\C-c\C-f\C-s" 'mh-to-field)
1035 (define-key mh-letter-mode-map "\C-c\C-f\C-t" 'mh-to-field)
1036 (define-key mh-letter-mode-map "\C-c\C-fb" 'mh-to-field)
1037 (define-key mh-letter-mode-map "\C-c\C-fc" 'mh-to-field)
1038 (define-key mh-letter-mode-map "\C-c\C-fd" 'mh-to-field)
1039 (define-key mh-letter-mode-map "\C-c\C-ff" 'mh-to-fcc)
1040 (define-key mh-letter-mode-map "\C-c\C-fr" 'mh-to-field)
1041 (define-key mh-letter-mode-map "\C-c\C-fs" 'mh-to-field)
1042 (define-key mh-letter-mode-map "\C-c\C-ft" 'mh-to-field)
1043 (define-key mh-letter-mode-map "\C-c\C-i" 'mh-insert-letter)
1044 (define-key mh-letter-mode-map "\C-c\C-q" 'mh-fully-kill-draft)
1045 (define-key mh-letter-mode-map "\C-c\C-\\" 'mh-fully-kill-draft) ;if no C-q
1046 (define-key mh-letter-mode-map "\C-c\C-s" 'mh-insert-signature)
1047 (define-key mh-letter-mode-map "\C-c\C-^" 'mh-insert-signature) ;if no C-s
1048 (define-key mh-letter-mode-map "\C-c\C-w" 'mh-check-whom)
1049 (define-key mh-letter-mode-map "\C-c\C-y" 'mh-yank-cur-msg)
1050 (define-key mh-letter-mode-map "\C-c\C-c" 'mh-send-letter)
1051 (define-key mh-letter-mode-map "\C-c\C-m\C-f" 'mh-mhn-compose-forw)
1052 (define-key mh-letter-mode-map "\C-c\C-m\C-e" 'mh-mhn-compose-anon-ftp)
1053 (define-key mh-letter-mode-map "\C-c\C-m\C-t" 'mh-mhn-compose-external-compressed-tar)
1054 (define-key mh-letter-mode-map "\C-c\C-m\C-i" 'mh-mhn-compose-insertion)
1055 (define-key mh-letter-mode-map "\C-c\C-e" 'mh-edit-mhn)
1056 (define-key mh-letter-mode-map "\C-c\C-m\C-u" 'mh-revert-mhn-edit)
1057
1058 ;; "C-c /" prefix is used in mh-letter-mode by pgp.el
1059
1060 ;;; autoloads from mh-mime
1061
1062 (autoload 'mh-mhn-compose-insertion "mh-mime"
1063 "Add a directive to insert a MIME message part from a file.
1064 This is the typical way to insert non-text parts in a message.
1065 See also \\[mh-edit-mhn]." t)
1066
1067 (autoload 'mh-mhn-compose-anon-ftp "mh-mime"
1068 "Add a directive for a MIME anonymous ftp external body part.
1069 This directive tells MH to include a reference to a
1070 message/external-body part retrievable by anonymous FTP.
1071 See also \\[mh-edit-mhn]." t)
1072
1073 (autoload 'mh-mhn-compose-external-compressed-tar "mh-mime"
1074 "Add a directive to include a MIME reference to a compressed tar file.
1075 The file should be available via anonymous ftp. This directive
1076 tells MH to include a reference to a message/external-body part.
1077 See also \\[mh-edit-mhn]." t)
1078
1079 (autoload 'mh-mhn-compose-forw "mh-mime"
1080 "Add a forw directive to this message, to forward a message with MIME.
1081 This directive tells MH to include another message in this one.
1082 See also \\[mh-edit-mhn]." t)
1083
1084 (autoload 'mh-edit-mhn "mh-mime"
1085 "Format the current draft for MIME, expanding any mhn directives.
1086 Process the current draft with the mhn program, which,
1087 using directives already inserted in the draft, fills in
1088 all the MIME components and header fields.
1089 This step should be done last just before sending the message.
1090 The mhn program is part of MH version 6.8 or later.
1091 The \\[mh-revert-mhn-edit] command undoes this command.
1092 For assistance with creating mhn directives to insert
1093 various types of components in a message, see
1094 \\[mh-mhn-compose-insertion] (generic insertion from a file),
1095 \\[mh-mhn-compose-anon-ftp] (external reference to file via anonymous ftp),
1096 \\[mh-mhn-compose-external-compressed-tar] \
1097 \(reference to compressed tar file via anonymous ftp), and
1098 \\[mh-mhn-compose-forw] (forward message)." t)
1099
1100 (autoload 'mh-revert-mhn-edit "mh-mime"
1101 "Undoes the effect of \\[mh-edit-mhn] by reverting to the backup file.
1102 Optional non-nil argument means don't ask for confirmation." t)