1 ;;; mh-comp.el --- MH-E functions for composing and sending messages
3 ;; Copyright (C) 1993, 1995, 1997,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
5 ;; Free Software Foundation, Inc.
7 ;; Author: Bill Wohler <wohler@newt.com>
8 ;; Maintainer: Bill Wohler <wohler@newt.com>
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
29 ;; This file includes the functions in the MH-Folder maps that get us
30 ;; into MH-Letter mode, as well the functions in the MH-Letter mode
31 ;; that are used to send the mail. Other that those, functions that
32 ;; are needed in mh-letter.el should be found there.
39 (require 'mh-gnus) ;needed because mh-gnus.el not compiled
44 (autoload 'easy-menu-add "easymenu")
45 (autoload 'mml-insert-tag "mml")
49 ;;; Site Customization
51 (defvar mh-send-prog "send"
52 "Name of the MH send program.
53 Some sites need to change this because of a name conflict.")
55 (defvar mh-send-uses-spost-flag nil
56 "Non-nil means \"send\" uses \"spost\" to submit messages.
58 If the value of \"postproc:\" is \"spost\", you may need to set
59 this variable to t to tell MH-E to avoid using features of
60 \"post\" that are not supported by \"spost\". You'll know that
61 you'll need to do this if sending mail fails with an error of
62 \"spost: -msgid unknown\".")
64 (defvar mh-redist-background nil
65 "If non-nil redist will be done in background like send.
66 This allows transaction log to be visible if -watch, -verbose or
73 (defvar mh-comp-formfile "components"
74 "Name of file to be used as a skeleton for composing messages.
76 Default is \"components\".
78 If not an absolute file name, the file is searched for first in the
79 user's MH directory, then in the system MH lib directory.")
81 (defvar mh-repl-formfile "replcomps"
82 "Name of file to be used as a skeleton for replying to messages.
84 Default is \"replcomps\".
86 If not an absolute file name, the file is searched for first in the
87 user's MH directory, then in the system MH lib directory.")
89 (defvar mh-repl-group-formfile "replgroupcomps"
90 "Name of file to be used as a skeleton for replying to messages.
92 Default is \"replgroupcomps\".
94 This file is used to form replies to the sender and all recipients of
95 a message. Only used if `(mh-variant-p 'nmh)' is non-nil.
96 If not an absolute file name, the file is searched for first in the
97 user's MH directory, then in the system MH lib directory.")
99 (defvar mh-rejected-letter-start
102 '("Content-Type: message/rfc822" ;MIME MDN
103 "------ This is a copy of the message, including all the headers. ------";from exim
104 "--- Below this line is a copy of the message."; from qmail
105 " ----- Unsent message follows -----" ;from sendmail V5
106 " --------Unsent Message below:" ; from sendmail at BU
107 " ----- Original message follows -----" ;from sendmail V8
108 "------- Unsent Draft" ;from MH itself
109 "---------- Original Message ----------" ;from zmailer
110 " --- The unsent message follows ---" ;from AIX mail system
111 " Your message follows:" ;from MMDF-II
112 "Content-Description: Returned Content" ;1993 KJ sendmail
115 (defvar mh-new-draft-cleaned-headers
116 "^Date:\\|^Received:\\|^Message-Id:\\|^From:\\|^Sender:\\|^Errors-To:\\|^Delivery-Date:\\|^Return-Path:"
117 "Regexp of header lines to remove before offering a message as a new draft\\<mh-folder-mode-map>.
118 Used by the \\[mh-edit-again] and \\[mh-extract-rejected-mail] commands.")
120 (defvar mh-letter-mode-syntax-table
121 (let ((syntax-table (make-syntax-table text-mode-syntax-table)))
122 (modify-syntax-entry ?% "." syntax-table)
124 "Syntax table used by MH-E while in MH-Letter mode.")
126 (defvar mh-send-args ""
127 "Extra args to pass to \"send\" command.")
129 (defvar mh-annotate-char nil
130 "Character to use to annotate `mh-sent-from-msg'.")
132 (defvar mh-annotate-field nil
133 "Field name for message annotation.")
135 (defvar mh-annotate-list nil
136 "Messages annotated, either a sequence name or a list of message numbers.
137 This variable can be used by `mh-annotate-msg-hook'.")
139 (defvar mh-insert-auto-fields-done-local nil
140 "Buffer-local variable set when `mh-insert-auto-fields' called successfully.")
141 (make-variable-buffer-local 'mh-insert-auto-fields-done-local)
145 ;;; MH-E Entry Points
149 "Compose a message with the MH mail system.
150 See `mh-send' for more details on composing mail."
153 (call-interactively 'mh-send))
156 (defun mh-smail-other-window ()
157 "Compose a message with the MH mail system in other window.
158 See `mh-send' for more details on composing mail."
161 (call-interactively 'mh-send-other-window))
163 (defun mh-send-other-window (to cc subject)
164 "Compose a message in another window.
166 See `mh-send' for more information and a description of how the
167 TO, CC, and SUBJECT arguments are used."
169 (mh-interactive-read-address "To: ")
170 (mh-interactive-read-address "Cc: ")
171 (mh-interactive-read-string "Subject: ")))
172 (let ((pop-up-windows t))
173 (mh-send-sub to cc subject (current-window-configuration))))
175 (defvar mh-error-if-no-draft nil) ;raise error over using old draft
178 (defun mh-smail-batch (&optional to subject other-headers &rest ignored)
179 "Compose a message with the MH mail system.
181 This function does not prompt the user for any header fields, and
182 thus is suitable for use by programs that want to create a mail
183 buffer. Users should use \\[mh-smail] to compose mail.
185 Optional arguments for setting certain fields include TO,
186 SUBJECT, and OTHER-HEADERS. Additional arguments are IGNORED.
188 This function remains for Emacs 21 compatibility. New
189 applications should use `mh-user-agent-compose'."
191 (let ((mh-error-if-no-draft t))
192 (mh-send (or to "") "" (or subject ""))))
195 (define-mail-user-agent 'mh-e-user-agent
196 'mh-user-agent-compose 'mh-send-letter 'mh-fully-kill-draft
197 'mh-before-send-letter-hook)
200 (defun mh-user-agent-compose (&optional to subject other-headers continue
201 switch-function yank-action
202 send-actions return-action
204 "Set up mail composition draft with the MH mail system.
205 This is the `mail-user-agent' entry point to MH-E. This function
206 conforms to the contract specified by `define-mail-user-agent'
207 which means that this function should accept the same arguments
210 The optional arguments TO and SUBJECT specify recipients and the
211 initial Subject field, respectively.
213 OTHER-HEADERS is an alist specifying additional header fields.
214 Elements look like (HEADER . VALUE) where both HEADER and VALUE
217 CONTINUE, SWITCH-FUNCTION, YANK-ACTION, SEND-ACTIONS, and
218 RETURN-ACTION are ignored."
220 (let ((mh-error-if-no-draft t))
221 (mh-send to "" subject)
223 (mh-insert-fields (concat (car (car other-headers)) ":")
224 (cdr (car other-headers)))
225 (setq other-headers (cdr other-headers)))))
228 (defvar sendmail-coding-system) ; XEmacs
231 (defun mh-send-letter (&optional arg)
232 "Save draft and send message.
234 When you are all through editing a message, you send it with this
235 command. You can give a prefix argument ARG to monitor the first stage
236 of the delivery\; this output can be found in a buffer called \"*MH-E
239 The hook `mh-before-send-letter-hook' is run at the beginning of
240 this command. For example, if you want to check your spelling in
241 your message before sending, add the function `ispell-message'.
243 Unless `mh-insert-auto-fields' had previously been called
244 manually, the function `mh-insert-auto-fields' is called to
245 insert fields based upon the recipients. If fields are added, you
246 are given a chance to see and to confirm these fields before the
247 message is actually sent. You can do away with this confirmation
248 by turning off the option `mh-auto-fields-prompt-flag'.
250 In case the MH \"send\" program is installed under a different name,
251 use `mh-send-prog' to tell MH-E the name.
253 The hook `mh-annotate-msg-hook' is run after annotating the
254 message and scan line."
256 (run-hooks 'mh-before-send-letter-hook)
257 (if (and (mh-insert-auto-fields t)
258 mh-auto-fields-prompt-flag
259 (goto-char (point-min)))
260 (if (not (y-or-n-p "Auto fields inserted, send? "))
261 (error "Send aborted")))
262 (cond ((mh-mh-directive-present-p)
264 ((or (mh-mml-tag-present-p) (not (mh-ascii-buffer-p)))
267 (message "Sending...")
268 (let ((draft-buffer (current-buffer))
269 (file-name buffer-file-name)
270 (config mh-previous-window-config)
271 (coding-system-for-write
272 (if (and (local-variable-p 'buffer-file-coding-system
273 (current-buffer)) ;XEmacs needs two args
274 ;; We're not sure why, but buffer-file-coding-system
275 ;; tends to get set to undecided-unix.
276 (not (memq buffer-file-coding-system
277 '(undecided undecided-unix undecided-dos))))
278 buffer-file-coding-system
279 (or (and (boundp 'sendmail-coding-system) sendmail-coding-system)
280 (and (default-boundp 'buffer-file-coding-system)
281 (default-value 'buffer-file-coding-system))
283 ;; Older versions of spost do not support -msgid and -mime.
284 (unless mh-send-uses-spost-flag
285 ;; Adding a Message-ID field looks good, makes it easier to search for
286 ;; message in your +outbox, and best of all doesn't break threading for
287 ;; the recipient if you reply to a message in your +outbox.
288 (setq mh-send-args (concat "-msgid " mh-send-args))
289 ;; The default BCC encapsulation will make a MIME message unreadable.
290 ;; With nmh use the -mime arg to prevent this.
291 (if (and (mh-variant-p 'nmh)
292 (mh-goto-header-field "Bcc:")
293 (mh-goto-header-field "Content-Type:"))
294 (setq mh-send-args (concat "-mime " mh-send-args))))
296 (pop-to-buffer mh-mail-delivery-buffer)
298 (mh-exec-cmd-output mh-send-prog t
299 "-nodraftfolder" "-watch" "-nopush"
300 (split-string mh-send-args) file-name)
301 (goto-char (point-max)) ; show the interesting part
303 (set-buffer draft-buffer)) ; for annotation below
305 (mh-exec-cmd-daemon mh-send-prog nil
306 "-nodraftfolder" "-noverbose"
307 (split-string mh-send-args) file-name)))
309 (mh-annotate-msg mh-sent-from-msg
312 "-component" mh-annotate-field
313 "-text" (format "\"%s %s\""
314 (mh-get-header-field "To:")
315 (mh-get-header-field "Cc:"))))
318 (y-or-n-p "Kill draft buffer? "))
319 (kill-buffer draft-buffer)
321 (set-window-configuration config))))
323 (message "Sending...done")
324 (message "Sending...backgrounded"))))
327 (defun mh-fully-kill-draft ()
328 "Quit editing and delete draft message.
330 If for some reason you are not happy with the draft, you can use
331 this command to kill the draft buffer and delete the draft
332 message. Use the command \\[kill-buffer] if you don't want to
333 delete the draft message."
335 (if (y-or-n-p "Kill draft message? ")
336 (let ((config mh-previous-window-config))
337 (if (file-exists-p buffer-file-name)
338 (delete-file buffer-file-name))
339 (set-buffer-modified-p nil)
340 (kill-buffer (buffer-name))
343 (set-window-configuration config)))
344 (error "Message not killed")))
348 ;;; MH-Folder Commands
353 (defun mh-edit-again (message)
354 "Edit a MESSAGE to send it again.
356 If you don't complete a draft for one reason or another, and if
357 the draft buffer is no longer available, you can pick your draft
358 up again with this command. If you don't use a draft folder, your
359 last \"draft\" file will be used. If you use draft folders,
360 you'll need to visit the draft folder with \"\\[mh-visit-folder]
361 drafts <RET>\", use \\[mh-next-undeleted-msg] to move to the
362 appropriate message, and then use \\[mh-edit-again] to prepare
363 the message for editing.
365 This command can also be used to take messages that were sent to
366 you and to send them to more people.
368 Don't use this command to re-edit a message from a Mailer-Daemon
369 who complained that your mail wasn't posted for some reason or
370 another (see `mh-extract-rejected-mail').
372 The default message is the current message.
375 (interactive (list (mh-get-msg-num t)))
376 (let* ((from-folder mh-current-folder)
377 (config (current-window-configuration))
379 (cond ((and mh-draft-folder (equal from-folder mh-draft-folder))
380 (pop-to-buffer (find-file-noselect (mh-msg-filename message))
382 (rename-buffer (format "draft-%d" message))
383 ;; Make buffer writable...
384 (setq buffer-read-only nil)
385 ;; If buffer was being used to display the message reinsert
387 (when (eq major-mode 'mh-show-mode)
389 (insert-file-contents buffer-file-name))
392 (mh-read-draft "clean-up" (mh-msg-filename message) nil)))))
393 (mh-clean-msg-header (point-min) mh-new-draft-cleaned-headers nil)
394 (mh-insert-header-separator)
395 (goto-char (point-min))
397 (mh-compose-and-send-mail draft "" from-folder nil nil nil nil nil nil
399 (mh-letter-mode-message)
400 (mh-letter-adjust-point)))
403 (defun mh-extract-rejected-mail (message)
404 "Edit a MESSAGE that was returned by the mail system.
406 This command prepares the message for editing by removing the
407 Mailer-Daemon envelope and unneeded header fields. Fix whatever
408 addressing problem you had, and send the message again with
411 The default message is the current message.
414 (interactive (list (mh-get-msg-num t)))
415 (let ((from-folder mh-current-folder)
416 (config (current-window-configuration))
417 (draft (mh-read-draft "extraction" (mh-msg-filename message) nil)))
418 (goto-char (point-min))
419 (cond ((re-search-forward mh-rejected-letter-start nil t)
420 (skip-chars-forward " \t\n")
421 (delete-region (point-min) (point))
422 (mh-clean-msg-header (point-min) mh-new-draft-cleaned-headers nil))
424 (message "Does not appear to be a rejected letter")))
425 (mh-insert-header-separator)
426 (goto-char (point-min))
428 (mh-compose-and-send-mail draft "" from-folder message
429 (mh-get-header-field "To:")
430 (mh-get-header-field "From:")
431 (mh-get-header-field "Cc:")
433 (mh-letter-mode-message)))
436 (defun mh-forward (to cc &optional range)
439 You are prompted for the TO and CC recipients. You are given a
440 draft to edit that looks like it would if you had run the MH
441 command \"forw\". You can then add some text.
443 You can forward several messages by using a RANGE. All of the
444 messages in the range are inserted into your draft. Check the
445 documentation of `mh-interactive-range' to see how RANGE is read
448 The hook `mh-forward-hook' is called on the draft.
450 See also `mh-compose-forward-as-mime-flag',
451 `mh-forward-subject-format', and `mh-send'."
452 (interactive (list (mh-interactive-read-address "To: ")
453 (mh-interactive-read-address "Cc: ")
454 (mh-interactive-range "Forward")))
455 (let* ((folder mh-current-folder)
456 (msgs (mh-range-to-msg-list range))
457 (config (current-window-configuration))
458 (fwd-msg-file (mh-msg-filename (car msgs) folder))
459 ;; forw always leaves file in "draft" since it doesn't have -draft
460 (draft-name (expand-file-name "draft" mh-user-path))
461 (draft (cond ((or (not (file-exists-p draft-name))
462 (y-or-n-p "The file draft exists; discard it? "))
463 (mh-exec-cmd "forw" "-build"
464 (if (and (mh-variant-p 'nmh)
465 mh-compose-forward-as-mime-flag)
468 (mh-coalesce-msg-list msgs))
470 (mh-read-draft "" draft-name t)
471 (mh-insert-fields "To:" to "Cc:" cc)
474 (mh-read-draft "" draft-name nil)))))
477 (with-current-buffer (get-buffer-create mh-temp-buffer)
479 (insert-file-contents fwd-msg-file)
480 (setq orig-from (mh-get-header-field "From:"))
481 (setq orig-subject (mh-get-header-field "Subject:")))
483 (mh-forwarded-letter-subject orig-from orig-subject)))
484 (mh-insert-fields "Subject:" forw-subject)
485 (goto-char (point-min))
486 ;; If using MML, translate MH-style directive
487 (if (equal mh-compose-insertion 'mml)
489 (goto-char (mh-mail-header-end))
492 "^#forw \\[\\([^]]+\\)\\] \\(+\\S-+\\) \\(.*\\)$"
494 (let ((description (if (equal (match-string 1)
495 "forwarded messages")
496 "forwarded message %d"
498 (msgs (split-string (match-string 3)))
501 (delete-region (point) (progn (forward-line 1) (point)))
504 (mh-mml-forward-message (format description i)
506 ;; Was inserted before us, move to end of file to preserve order
507 (goto-char (point-max)))))))
508 ;; Postition just before forwarded message
509 (if (re-search-forward "^------- Forwarded Message" nil t)
511 (goto-char (mh-mail-header-end))
513 (delete-other-windows)
514 (mh-add-msgs-to-seq msgs 'forwarded t)
515 (mh-compose-and-send-mail draft "" folder msgs
517 mh-note-forw "Forwarded:"
519 (mh-letter-mode-message)
520 (mh-letter-adjust-point)
521 (run-hooks 'mh-forward-hook)))))
523 (defun mh-forwarded-letter-subject (from subject)
524 "Return a Subject suitable for a forwarded message.
525 Original message has headers FROM and SUBJECT."
526 (let ((addr-start (string-match "<" from))
527 (comment (string-match "(" from)))
528 (cond ((and addr-start (> addr-start 0))
529 ;; Full Name <luser@host>
530 (setq from (substring from 0 (1- addr-start))))
532 ;; luser@host (Full Name)
533 (setq from (substring from (1+ comment) (1- (length from)))))))
534 (format mh-forward-subject-format from subject))
537 (defun mh-redistribute (to cc &optional message)
538 "Redistribute a message.
540 This command is similar in function to forwarding mail, but it
541 does not allow you to edit the message, nor does it add your name
542 to the \"From\" header field. It appears to the recipient as if
543 the message had come from the original sender. When you run this
544 command, you are prompted for the TO and CC recipients. The
545 default MESSAGE is the current message.
547 Also investigate the command \\[mh-edit-again] for another way to
548 redistribute messages.
550 See also `mh-redist-full-contents-flag'.
552 The hook `mh-annotate-msg-hook' is run after annotating the
553 message and scan line."
554 (interactive (list (mh-read-address "Redist-To: ")
555 (mh-read-address "Redist-Cc: ")
558 (setq message (mh-get-msg-num t)))
559 (save-window-excursion
560 (let ((folder mh-current-folder)
561 (draft (mh-read-draft "redistribution"
562 (if mh-redist-full-contents-flag
563 (mh-msg-filename message)
566 (mh-goto-header-end 0)
567 (insert "Resent-To: " to "\n")
568 (if (not (equal cc "")) (insert "Resent-cc: " cc "\n"))
571 "^Message-Id:\\|^Received:\\|^Return-Path:\\|^Sender:\\|^Date:\\|^From:"
574 (message "Redistributing...")
575 (let ((env "mhdist=1"))
576 ;; Setup environment...
577 (setq env (concat env " mhaltmsg="
578 (if mh-redist-full-contents-flag
580 (mh-msg-filename message folder))))
581 (unless mh-redist-full-contents-flag
582 (setq env (concat env " mhannotate=1")))
584 (if mh-redist-background
585 (mh-exec-cmd-env-daemon env mh-send-prog nil buffer-file-name)
586 (mh-exec-cmd-error env mh-send-prog "-push" buffer-file-name))
588 (mh-annotate-msg message folder mh-note-dist
589 "-component" "Resent:"
590 "-text" (format "\"%s %s\"" to cc)))
592 (message "Redistributing...done"))))
595 (defun mh-reply (message &optional reply-to includep)
598 When you reply to a message, you are first prompted with \"Reply
599 to whom?\" (unless the optional argument REPLY-TO is provided).
600 You have several choices here.
602 Response Reply Goes To
604 from The person who sent the message. This is the
605 default, so <RET> is sufficient.
607 to Replies to the sender, plus all recipients in the
608 \"To:\" header field.
610 all cc Forms a reply to the addresses in the
611 \"Mail-Followup-To:\" header field if one
612 exists; otherwise forms a reply to the sender,
615 Depending on your answer, \"repl\" is given a different argument
616 to form your reply. Specifically, a choice of \"from\" or none at
617 all runs \"repl -nocc all\", and a choice of \"to\" runs \"repl
618 -cc to\". Finally, either \"cc\" or \"all\" runs \"repl -cc all
621 Two windows are then created. One window contains the message to
622 which you are replying in an MH-Show buffer. Your draft, in
623 MH-Letter mode (*note `mh-letter-mode'), is in the other window.
624 If the reply draft was not one that you expected, check the
625 things that affect the behavior of \"repl\" which include the
626 \"repl:\" profile component and the \"replcomps\" and
627 \"replgroupcomps\" files.
629 If you supply a prefix argument INCLUDEP, the message you are
630 replying to is inserted in your reply after having first been run
631 through \"mhl\" with the format file \"mhl.reply\".
633 Alternatively, you can customize the option `mh-yank-behavior'
634 and choose one of its \"Automatically\" variants to do the same
635 thing. If you do so, the prefix argument has no effect.
637 Another way to include the message automatically in your draft is
638 to use \"repl: -filter repl.filter\" in your MH profile.
640 If you wish to customize the header or other parts of the reply
641 draft, please see \"repl\" and \"mh-format\".
643 See also `mh-reply-show-message-flag',
644 `mh-reply-default-reply-to', and `mh-send'."
647 (let ((minibuffer-help-form
648 "from => Sender only\nto => Sender and primary recipients\ncc or all => Sender and all recipients"))
649 (or mh-reply-default-reply-to
650 (completing-read "Reply to whom (default from): "
651 '(("from") ("to") ("cc") ("all"))
655 (let* ((folder mh-current-folder)
656 (show-buffer mh-show-buffer)
657 (config (current-window-configuration))
658 (group-reply (or (equal reply-to "cc") (equal reply-to "all")))
659 (form-file (cond ((and (mh-variant-p 'nmh 'gnu-mh) group-reply
660 (stringp mh-repl-group-formfile))
661 mh-repl-group-formfile)
662 ((stringp mh-repl-formfile) mh-repl-formfile)
664 (message "Composing a reply...")
665 (mh-exec-cmd "repl" "-build" "-noquery" "-nodraftfolder"
667 (list "-form" form-file))
668 mh-current-folder message
669 (cond ((or (equal reply-to "from") (equal reply-to ""))
671 ((equal reply-to "to")
673 (group-reply (if (mh-variant-p 'nmh 'gnu-mh)
674 '("-group" "-nocc" "me")
675 '("-cc" "all" "-nocc" "me"))))
676 (cond ((or (eq mh-yank-behavior 'autosupercite)
677 (eq mh-yank-behavior 'autoattrib))
679 (includep '("-filter" "mhl.reply"))
681 (let ((draft (mh-read-draft "reply"
682 (expand-file-name "reply" mh-user-path)
684 (delete-other-windows)
687 (let ((to (mh-get-header-field "To:"))
688 (subject (mh-get-header-field "Subject:"))
689 (cc (mh-get-header-field "Cc:")))
690 (goto-char (point-min))
691 (mh-goto-header-end 1)
693 (not mh-reply-show-message-flag)
694 (mh-in-show-buffer (show-buffer)
695 (mh-display-msg message folder)))
696 (mh-add-msgs-to-seq message 'answered t)
697 (message "Composing a reply...done")
698 (mh-compose-and-send-mail draft "" folder message to subject cc
699 mh-note-repl "Replied:" config))
700 (when (and (or (eq 'autosupercite mh-yank-behavior)
701 (eq 'autoattrib mh-yank-behavior))
702 (eq (mh-show-buffer-message-number) mh-sent-from-msg))
705 (mh-letter-mode-message))))
708 (defun mh-send (to cc subject)
711 Your letter appears in an Emacs buffer whose mode is
712 MH-Letter (see `mh-letter-mode').
714 The arguments TO, CC, and SUBJECT can be used to prefill the
715 draft fields or suppress the prompts if `mh-compose-prompt-flag'
716 is on. They are also passed to the function set in the option
717 `mh-compose-letter-function'.
719 See also `mh-insert-x-mailer-flag' and `mh-letter-mode-hook'.
721 Outside of an MH-Folder buffer (`mh-folder-mode'), you must call
722 either \\[mh-smail] or \\[mh-smail-other-window] to compose a new
725 (mh-interactive-read-address "To: ")
726 (mh-interactive-read-address "Cc: ")
727 (mh-interactive-read-string "Subject: ")))
728 (let ((config (current-window-configuration)))
729 (delete-other-windows)
730 (mh-send-sub to cc subject config)))
736 (defun mh-interactive-read-address (prompt)
738 If `mh-compose-prompt-flag' is non-nil, then read an address with
740 Otherwise return the empty string."
741 (if mh-compose-prompt-flag (mh-read-address prompt) ""))
743 (defun mh-interactive-read-string (prompt)
745 If `mh-compose-prompt-flag' is non-nil, then read a string with
747 Otherwise return the empty string."
748 (if mh-compose-prompt-flag (read-string prompt) ""))
751 (defun mh-show-buffer-message-number (&optional buffer)
752 "Message number of displayed message in corresponding show buffer.
754 Return nil if show buffer not displayed.
755 If in `mh-letter-mode', don't display the message number being replied
756 to, but rather the message number of the show buffer associated with
757 our originating folder buffer.
758 Optional argument BUFFER can be used to specify the buffer."
762 (cond ((eq major-mode 'mh-show-mode)
763 (let ((number-start (mh-search-from-end ?/ buffer-file-name)))
764 (string-to-number (substring buffer-file-name
765 (1+ number-start)))))
766 ((and (eq major-mode 'mh-folder-mode)
768 (get-buffer mh-show-buffer))
769 (mh-show-buffer-message-number mh-show-buffer))
770 ((and (eq major-mode 'mh-letter-mode)
772 (get-buffer mh-sent-from-folder))
773 (mh-show-buffer-message-number mh-sent-from-folder))
777 (defun mh-send-sub (to cc subject config)
778 "Do the real work of composing and sending a letter.
779 Expects the TO, CC, and SUBJECT fields as arguments.
780 CONFIG is the window configuration before sending mail."
781 (let ((folder mh-current-folder)
782 (msg-num (mh-get-msg-num nil)))
783 (message "Composing a message...")
784 (let ((draft (mh-read-draft
790 (expand-file-name mh-comp-formfile mh-user-path)))
794 (expand-file-name mh-comp-formfile mh-lib)))
797 (error "Can't find %s in %s or %s"
798 mh-comp-formfile mh-user-path mh-lib))))
800 (mh-insert-fields "To:" to "Subject:" subject "Cc:" cc)
801 (goto-char (point-max))
802 (mh-compose-and-send-mail draft "" folder msg-num
805 (mh-letter-mode-message)
806 (mh-letter-adjust-point))))
808 (defun mh-read-draft (use initial-contents delete-contents-file)
809 "Read draft file into a draft buffer and make that buffer the current one.
811 USE is a message used for prompting about the intended use of the
813 INITIAL-CONTENTS is filename that is read into an empty buffer, or nil
814 if buffer should not be modified. Delete the initial-contents file if
815 DELETE-CONTENTS-FILE flag is set.
816 Returns the draft folder's name.
817 If the draft folder facility is enabled in ~/.mh_profile, a new buffer
818 is used each time and saved in the draft folder. The draft file can
820 (cond (mh-draft-folder
821 (let ((orig-default-dir default-directory)
822 (draft-file-name (mh-new-draft-name)))
823 (pop-to-buffer (generate-new-buffer
825 (file-name-nondirectory draft-file-name))))
827 (insert-file-contents draft-file-name t)
829 (setq default-directory orig-default-dir)))
831 (let ((draft-name (expand-file-name "draft" mh-user-path)))
832 (pop-to-buffer "draft") ; Create if necessary
833 (if (buffer-modified-p)
834 (if (y-or-n-p "Draft has been modified; kill anyway? ")
835 (set-buffer-modified-p nil)
836 (error "Draft preserved")))
837 (setq buffer-file-name draft-name)
838 (clear-visited-file-modtime)
840 (cond ((and (file-exists-p draft-name)
841 (not (equal draft-name initial-contents)))
842 (insert-file-contents draft-name)
843 (delete-file draft-name))))))
844 (cond ((and initial-contents
845 (or (zerop (buffer-size))
847 (format "A draft exists. Use for %s? " use))
848 (if mh-error-if-no-draft
849 (error "A prior draft exists"))
852 (insert-file-contents initial-contents)
853 (if delete-contents-file (delete-file initial-contents))))
856 (save-buffer)) ; Do not reuse draft name
859 (defun mh-new-draft-name ()
860 "Return the pathname of folder for draft messages."
862 (mh-exec-cmd-quiet t "mhpath" mh-draft-folder "new")
863 (buffer-substring (point-min) (1- (point-max)))))
865 (defun mh-insert-fields (&rest name-values)
866 "Insert the NAME-VALUES pairs in the current buffer.
867 If the field exists, append the value to it.
868 Do not insert any pairs whose value is the empty string."
869 (let ((case-fold-search t))
871 (let ((field-name (car name-values))
872 (value (car (cdr name-values))))
873 (if (not (string-match "^.*:$" field-name))
874 (setq field-name (concat field-name ":")))
875 (cond ((or (null value)
878 ((mh-position-on-field field-name)
879 (insert " " (or value "")))
881 (insert field-name " " value "\n")))
882 (setq name-values (cdr (cdr name-values)))))))
884 (defun mh-compose-and-send-mail (draft send-args
885 sent-from-folder sent-from-msg
887 annotate-char annotate-field
889 "Edit and compose a draft message in buffer DRAFT and send or save it.
890 SEND-ARGS is the argument passed to the send command.
891 SENT-FROM-FOLDER is buffer containing scan listing of current folder,
892 or nil if none exists.
893 SENT-FROM-MSG is the message number or sequence name or nil.
894 The TO, SUBJECT, and CC fields are passed to the
895 `mh-compose-letter-function'.
896 If ANNOTATE-CHAR is non-null, it is used to notate the scan listing of
897 the message. In that case, the ANNOTATE-FIELD is used to build a
898 string for `mh-annotate-msg'.
899 CONFIG is the window configuration to restore after sending the
901 (pop-to-buffer draft)
905 (mh-insert-identity mh-identity-default t)
906 (mh-identity-make-menu)
907 (mh-identity-add-menu)
909 ;; Cleanup possibly RFC2047 encoded subject header
910 (mh-decode-message-subject)
912 ;; Insert extra fields.
916 (mh-letter-hide-all-skipped-fields)
918 (setq mh-sent-from-folder sent-from-folder)
919 (setq mh-sent-from-msg sent-from-msg)
920 (setq mh-send-args send-args)
921 (setq mh-annotate-char annotate-char)
922 (setq mh-annotate-field annotate-field)
923 (setq mh-previous-window-config config)
924 (setq mode-line-buffer-identification (list " {%b}"))
926 (mh-make-local-hook 'kill-buffer-hook)
927 (add-hook 'kill-buffer-hook 'mh-tidy-draft-buffer nil t)
928 (run-hook-with-args 'mh-compose-letter-function to subject cc))
930 (defun mh-insert-x-mailer ()
931 "Append an X-Mailer field to the header.
932 The versions of MH-E, Emacs, and MH are shown."
933 ;; Lazily initialize mh-x-mailer-string.
934 (when (and mh-insert-x-mailer-flag (null mh-x-mailer-string))
935 (setq mh-x-mailer-string
936 (format "MH-E %s; %s; %sEmacs %s"
937 mh-version mh-variant-in-use
938 (if (featurep 'xemacs) "X" "GNU ")
939 (cond ((not (featurep 'xemacs))
940 (string-match "[0-9]+\\.[0-9]+\\(\\.[0-9]+\\)?"
942 (match-string 0 emacs-version))
943 ((string-match "[0-9.]*\\( +\([ a-z]+[0-9]+\)\\)?"
945 (match-string 0 emacs-version))
946 (t (format "%s.%s" emacs-major-version
947 emacs-minor-version))))))
948 ;; Insert X-Mailer, but only if it doesn't already exist.
950 (when (and mh-insert-x-mailer-flag
951 (null (mh-goto-header-field "X-Mailer")))
952 (mh-insert-fields "X-Mailer:" mh-x-mailer-string))))
954 (defun mh-insert-x-face ()
955 "Append X-Face, Face or X-Image-URL field to header.
956 If the field already exists, this function does nothing."
957 (when (and (file-exists-p mh-x-face-file)
958 (file-readable-p mh-x-face-file))
960 (unless (or (mh-position-on-field "X-Face")
961 (mh-position-on-field "Face")
962 (mh-position-on-field "X-Image-URL"))
964 (goto-char (+ (point) (cadr (insert-file-contents mh-x-face-file))))
965 (if (not (looking-at "^"))
967 (unless (looking-at "\\(X-Face\\|Face\\|X-Image-URL\\): ")
968 (insert "X-Face: "))))))
970 (defun mh-tidy-draft-buffer ()
971 "Run when a draft buffer is destroyed."
972 (let ((buffer (get-buffer mh-recipients-buffer)))
974 (kill-buffer buffer))))
976 (defun mh-letter-mode-message ()
977 "Display a help message for users of `mh-letter-mode'.
978 This should be the last function called when composing the draft."
979 (message "%s" (substitute-command-keys
980 (concat "Type \\[mh-send-letter] to send message, "
981 "\\[mh-help] for help"))))
983 (defun mh-letter-adjust-point ()
984 "Move cursor to first header field if are using the no prompt mode."
985 (unless mh-compose-prompt-flag
986 (goto-char (point-max))
987 (mh-letter-next-header-field)))
989 (defun mh-annotate-msg (msg folder note &rest args)
990 "Mark MSG in FOLDER with character NOTE and annotate message with ARGS.
991 MSG can be a message number, a list of message numbers, or a sequence.
992 The hook `mh-annotate-msg-hook' is run after annotating; see its
993 documentation for variables it can use."
994 (apply 'mh-exec-cmd "anno" folder
995 (if (listp msg) (append msg args) (cons msg args)))
997 (cond ((get-buffer folder) ; Buffer may be deleted
999 (mh-iterate-on-range nil msg
1001 (+ mh-cmd-note mh-scan-field-destination-offset))))))
1002 (let ((mh-current-folder folder)
1003 ;; mh-annotate-list is a sequence name or a list of message numbers
1004 (mh-annotate-list (if (numberp msg) (list msg) msg)))
1005 (run-hooks 'mh-annotate-msg-hook)))
1007 (defun mh-insert-header-separator ()
1008 "Insert `mh-mail-header-separator', if absent."
1010 (goto-char (point-min))
1012 (if (looking-at "$")
1013 (insert mh-mail-header-separator))))
1016 (defun mh-insert-auto-fields (&optional non-interactive)
1017 "Insert custom fields if recipient is found in `mh-auto-fields-list'.
1019 Once the header contains one or more recipients, you may run this
1020 command to insert these fields manually. However, if you use this
1021 command, the automatic insertion when the message is sent is
1024 In a program, set buffer-local `mh-insert-auto-fields-done-local'
1025 if header fields were added. If NON-INTERACTIVE is non-nil,
1026 perform actions quietly and only if
1027 `mh-insert-auto-fields-done-local' is nil. Return t if fields
1028 added; otherwise return nil."
1030 (when (or (not non-interactive)
1031 (not mh-insert-auto-fields-done-local))
1033 (when (and (or (mh-goto-header-field "To:")
1034 (mh-goto-header-field "cc:")))
1035 (let ((list mh-auto-fields-list)
1036 (fields-inserted nil))
1038 (let ((regexp (nth 0 (car list)))
1039 (entries (nth 1 (car list))))
1040 (when (mh-regexp-in-field-p regexp "To:" "cc:")
1041 (setq mh-insert-auto-fields-done-local t)
1042 (setq fields-inserted t)
1043 (if (not non-interactive)
1044 (message "Fields for %s added" regexp))
1045 (let ((entry-list entries))
1047 (let ((field (caar entry-list))
1048 (value (cdar entry-list)))
1050 ((equal ":identity" field)
1052 ;;(and (not mh-identity-local)
1053 ;; Bug 1204506. But do we need to be able
1054 ;; to set an identity manually that won't be
1055 ;; overridden by mh-insert-auto-fields?
1056 (assoc value mh-identity-list)
1058 (mh-insert-identity value)))
1060 (mh-modify-header-field field value
1061 (equal field "From")))))
1062 (setq entry-list (cdr entry-list))))))
1063 (setq list (cdr list)))
1064 fields-inserted)))))
1066 (defun mh-modify-header-field (field value &optional overwrite-flag)
1067 "To header FIELD add VALUE.
1068 If OVERWRITE-FLAG is non-nil then the old value, if present, is
1070 (cond ((and overwrite-flag
1071 (mh-goto-header-field (concat field ":")))
1073 (delete-region (point) (mh-line-end-position)))
1074 ((and (not overwrite-flag)
1075 (mh-regexp-in-field-p (concat "\\b" value "\\b") field))
1076 ;; Already there, do nothing.
1078 ((and (not overwrite-flag)
1079 (mh-goto-header-field (concat field ":")))
1080 (insert " " value ","))
1082 (mh-goto-header-end 0)
1083 (insert field ": " value "\n"))))
1085 (defun mh-regexp-in-field-p (regexp &rest fields)
1086 "Non-nil means REGEXP was found in FIELDS."
1088 (let ((search-result nil)
1091 (setq field (car fields))
1092 (if (and (mh-goto-header-field field)
1094 regexp (save-excursion (mh-header-field-end)(point)) t))
1097 (setq fields (cdr fields))))
1100 (defun mh-ascii-buffer-p ()
1101 "Check if current buffer is entirely composed of ASCII.
1102 The function doesn't work for XEmacs since `find-charset-region'
1103 doesn't exist there."
1104 (loop for charset in (mh-funcall-if-exists
1105 find-charset-region (point-min) (point-max))
1106 unless (eq charset 'ascii) return nil
1112 ;; indent-tabs-mode: nil
1113 ;; sentence-end-double-space: nil
1116 ;; arch-tag: 62865511-e610-4923-b0b5-f45a8ab70a34
1117 ;;; mh-comp.el ends here