1 ;;; mh-mime.el --- MH-E MIME support
3 ;; Copyright (C) 1993, 1995,
4 ;; 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Bill Wohler <wohler@newt.com>
7 ;; Maintainer: Bill Wohler <wohler@newt.com>
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 3, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
30 ;; Message composition of MIME message is done with either MH-style
31 ;; directives for mhn or mhbuild (MH 6.8 or later) or MML (MIME Meta
35 ;; Paragraph code should not fill # lines if MIME enabled.
36 ;; Implement mh-auto-mh-to-mime (if non-nil, \\[mh-send-letter]
37 ;; invokes mh-mh-to-mime automatically before sending.)
38 ;; Actually, instead of mh-auto-mh-to-mime,
39 ;; should read automhnproc from profile.
40 ;; MIME option to mh-forward command to move to content-description
48 (require 'mh-gnus
) ;needed because mh-gnus.el not compiled
57 (autoload 'article-emphasize
"gnus-art")
58 (autoload 'gnus-eval-format
"gnus-spec")
59 (autoload 'mail-content-type-get
"mail-parse")
60 (autoload 'mail-decode-encoded-word-string
"mail-parse")
61 (autoload 'mail-header-parse-content-type
"mail-parse")
62 (autoload 'mail-header-strip
"mail-parse")
63 (autoload 'mail-strip-quoted-names
"mail-utils")
64 (autoload 'message-options-get
"message")
65 (autoload 'message-options-set
"message")
66 (autoload 'message-options-set-recipient
"message")
67 (autoload 'mm-decode-body
"mm-bodies")
68 (autoload 'mm-uu-dissect
"mm-uu")
69 (autoload 'mml-unsecure-message
"mml-sec")
70 (autoload 'rfc2047-decode-region
"rfc2047")
71 (autoload 'widget-convert-button
"wid-edit")
77 ;; This has to be a macro, since we do: (setf (mh-buffer-data) ...)
79 (defmacro mh-buffer-data
()
80 "Convenience macro to get the MIME data structures of the current buffer."
81 `(gethash (current-buffer) mh-globals-hash
))
83 ;; Structure to keep track of MIME handles on a per buffer basis.
84 (mh-defstruct (mh-buffer-data (:conc-name mh-mime-
)
85 (:constructor mh-make-buffer-data
))
86 (handles ()) ; List of MIME handles
87 (handles-cache (make-hash-table)) ; Cache to avoid multiple decodes of
89 (parts-count 0) ; The button number is generated from
91 (part-index-hash (make-hash-table))) ; Avoid incrementing the part number
94 (defvar mh-mm-inline-media-tests
98 (mm-valid-and-fit-image-p 'jpeg handle
)))
102 (mm-valid-and-fit-image-p 'png handle
)))
106 (mm-valid-and-fit-image-p 'gif handle
)))
110 (mm-valid-and-fit-image-p 'tiff handle
)) )
114 (mm-valid-and-fit-image-p 'xbm handle
)))
118 (mm-valid-and-fit-image-p 'xbm handle
)))
122 (mm-valid-and-fit-image-p 'xpm handle
)))
126 (mm-valid-and-fit-image-p 'xpm handle
)))
130 (mm-valid-and-fit-image-p 'bmp handle
)))
131 ("image/x-portable-bitmap"
134 (mm-valid-and-fit-image-p 'pbm handle
)))
135 ("text/plain" mm-inline-text identity
)
136 ("text/enriched" mm-inline-text identity
)
137 ("text/richtext" mm-inline-text identity
)
138 ("text/x-patch" mm-display-patch-inline
140 (locate-library "diff-mode")))
141 ("application/emacs-lisp" mm-display-elisp-inline identity
)
142 ("application/x-emacs-lisp" mm-display-elisp-inline identity
)
144 ,(if (fboundp 'mm-inline-text-html
) 'mm-inline-text-html
'mm-inline-text
)
146 (or (and (boundp 'mm-inline-text-html-renderer
)
147 mm-inline-text-html-renderer
)
148 (and (boundp 'mm-text-html-renderer
) mm-text-html-renderer
))))
150 mh-mm-inline-text-vcard
152 (or (featurep 'vcard
)
153 (locate-library "vcard"))))
154 ("message/delivery-status" mm-inline-text identity
)
155 ("message/rfc822" mh-mm-inline-message identity
)
156 ;;("message/partial" mm-inline-partial identity)
157 ;;("message/external-body" mm-inline-external-body identity)
158 ("text/.*" mm-inline-text identity
)
159 ("audio/wav" mm-inline-audio
161 (and (or (featurep 'nas-sound
) (featurep 'native-sound
))
162 (device-sound-enabled-p))))
166 (and (or (featurep 'nas-sound
) (featurep 'native-sound
))
167 (device-sound-enabled-p))))
168 ("application/pgp-signature" ignore identity
)
169 ("application/x-pkcs7-signature" ignore identity
)
170 ("application/pkcs7-signature" ignore identity
)
171 ("application/x-pkcs7-mime" ignore identity
)
172 ("application/pkcs7-mime" ignore identity
)
173 ("multipart/alternative" ignore identity
)
174 ("multipart/mixed" ignore identity
)
175 ("multipart/related" ignore identity
)
176 ;; Disable audio and image
177 ("audio/.*" ignore ignore
)
178 ("image/.*" ignore ignore
)
179 ;; Default to displaying as text
180 (".*" mm-inline-text mh-mm-readable-p
))
181 "Alist of media types/tests saying whether types can be displayed inline.")
183 (defvar mh-mime-save-parts-directory nil
184 "Default to use for `mh-mime-save-parts-default-directory'.
187 ;; Copied from gnus-art.el (should be checked for other cool things that can
188 ;; be added to the buttons)
189 (defvar mh-mime-button-commands
190 '((mh-press-button "\r" "Toggle Display")))
191 (defvar mh-mime-button-map
192 (let ((map (make-sparse-keymap)))
193 (unless (>= (string-to-number emacs-version
) 21)
194 ;; XEmacs doesn't care.
195 (set-keymap-parent map mh-show-mode-map
))
197 (define-key map
[mouse-2
] 'mh-push-button
))
199 (define-key map
'(button2) 'mh-push-button
))
200 (dolist (c mh-mime-button-commands
)
201 (define-key map
(cadr c
) (car c
)))
203 (defvar mh-mime-button-line-format-alist
208 (defvar mh-mime-button-line-format
"%{%([%p. %d%T]%)%}%e\n")
209 (defvar mh-mime-security-button-pressed nil
)
210 (defvar mh-mime-security-button-line-format
"%{%([[%t:%i]%D]%)%}\n")
211 (defvar mh-mime-security-button-end-line-format
"%{%([[End of %t]%D]%)%}\n")
212 (defvar mh-mime-security-button-line-format-alist
216 (?D pressed-details ?s
)))
217 (defvar mh-mime-security-button-map
218 (let ((map (make-sparse-keymap)))
219 (unless (>= (string-to-number emacs-version
) 21)
220 (set-keymap-parent map mh-show-mode-map
))
221 (define-key map
"\r" 'mh-press-button
)
223 (define-key map
[mouse-2
] 'mh-push-button
))
225 (define-key map
'(button2) 'mh-push-button
))
230 ;;; MH-Folder Commands
235 (defun mh-display-with-external-viewer (part-index)
236 "View attachment externally.
238 If Emacs does not know how to view an attachment, you could save
239 it into a file and then run some program to open it. It is
240 easier, however, to launch the program directly from MH-E with
241 this command. While you'll most likely use this to view
242 spreadsheets and documents, it is also useful to use your browser
243 to view HTML attachments with higher fidelity than what Emacs can
246 This command displays the attachment associated with the button
247 under the cursor. If the cursor is not located over a button,
248 then the cursor first moves to the next button, wrapping to the
249 beginning of the message if necessary. You can provide a numeric
250 prefix argument PART-INDEX to view the attachment labeled with
253 This command tries to provide a reasonable default for the viewer
254 by calling the Emacs function `mailcap-mime-info'. This function
255 usually reads the file \"/etc/mailcap\"."
257 (when (consp part-index
) (setq part-index
(car part-index
)))
258 (mh-folder-mime-action
261 (let* ((part (get-text-property (point) 'mh-data
))
262 (type (mm-handle-media-type part
))
263 (methods (mapcar (lambda (x) (list (cdr (assoc 'viewer x
))))
264 (mailcap-mime-info type
'all
)))
266 (prompt (format "Viewer%s: " (if def
267 (format " (default %s)" def
)
269 (method (completing-read prompt methods nil nil nil nil def
))
270 (folder mh-show-folder-buffer
)
271 (buffer-read-only nil
))
272 (when (string-match "^[^% \t]+$" method
)
273 (setq method
(concat method
" %s")))
274 (flet ((mm-handle-set-external-undisplayer (handle function
)
275 (mh-handle-set-external-undisplayer folder handle function
)))
276 (unwind-protect (mm-display-external part method
)
277 (set-buffer-modified-p nil
)))))
281 (defun mh-folder-inline-mime-part (part-index)
282 "Show attachment verbatim.
284 You can view the raw contents of an attachment with this command.
285 This command displays (or hides) the contents of the attachment
286 associated with the button under the cursor verbatim. If the
287 cursor is not located over a button, then the cursor first moves
288 to the next button, wrapping to the beginning of the message if
291 You can also provide a numeric prefix argument PART-INDEX to view
292 the attachment labeled with that number."
294 (when (consp part-index
) (setq part-index
(car part-index
)))
295 (mh-folder-mime-action part-index
#'mh-mime-inline-part nil
))
297 (defun mh-mime-inline-part ()
298 "Toggle display of the raw MIME part."
300 (let* ((buffer-read-only nil
)
301 (data (get-text-property (point) 'mh-data
))
302 (inserted-flag (get-text-property (point) 'mh-mime-inserted
))
303 (displayed-flag (mm-handle-displayed-p data
))
306 (cond ((and data
(not inserted-flag
) (not displayed-flag
))
307 (let ((contents (mm-get-part data
)))
308 (add-text-properties (mh-line-beginning-position)
309 (mh-line-end-position) '(mh-mime-inserted t
))
310 (setq start
(point-marker))
312 (mm-insert-inline data contents
)
313 (setq end
(point-marker))
315 start
(progn (goto-char start
) (mh-line-end-position))
316 `(mh-region (,start .
,end
)))))
317 ((and data
(or inserted-flag displayed-flag
))
319 (message "MIME part already inserted")))
321 (set-buffer-modified-p nil
)))
324 (defun mh-folder-save-mime-part (part-index)
325 "Save (output) attachment.
327 This command saves the attachment associated with the button under the
328 cursor. If the cursor is not located over a button, then the cursor
329 first moves to the next button, wrapping to the beginning of the
330 message if necessary.
332 You can also provide a numeric prefix argument PART-INDEX to save the
333 attachment labeled with that number.
335 This command prompts you for a filename and suggests a specific name
338 (when (consp part-index
) (setq part-index
(car part-index
)))
339 (mh-folder-mime-action part-index
#'mh-mime-save-part nil
))
341 (defun mh-mime-save-part ()
342 "Save MIME part at point."
344 (let ((data (get-text-property (point) 'mh-data
)))
346 (let ((mm-default-directory
347 (file-name-as-directory (or mh-mime-save-parts-directory
348 default-directory
))))
349 (mh-mm-save-part data
)
350 (setq mh-mime-save-parts-directory mm-default-directory
)))))
353 (defun mh-folder-toggle-mime-part (part-index)
356 This command displays (or hides) the attachment associated with
357 the button under the cursor. If the cursor is not located over a
358 button, then the cursor first moves to the next button, wrapping
359 to the beginning of the message if necessary. This command has
360 the advantage over related commands of working from the MH-Folder
363 You can also provide a numeric prefix argument PART-INDEX to view
364 the attachment labeled with that number. If Emacs does not know
365 how to display the attachment, then Emacs offers to save the
366 attachment in a file."
368 (when (consp part-index
) (setq part-index
(car part-index
)))
369 (mh-folder-mime-action part-index
#'mh-press-button t
))
372 (defun mh-mime-save-parts (prompt)
375 You can save all of the attachments at once with this command.
376 The attachments are saved in the directory specified by the
377 option `mh-mime-save-parts-default-directory' unless you use a
378 prefix argument PROMPT in which case you are prompted for the
379 directory. These directories may be superseded by MH profile
380 components, since this function calls on \"mhstore\" (\"mhn\") to
383 (let ((msg (if (eq major-mode
'mh-show-mode
)
384 (mh-show-buffer-message-number)
386 (folder (if (eq major-mode
'mh-show-mode
)
387 mh-show-folder-buffer
389 (command (if (mh-variant-p 'nmh
) "mhstore" "mhn"))
393 (equal nil mh-mime-save-parts-default-directory
)
394 (equal t mh-mime-save-parts-default-directory
))
395 (not mh-mime-save-parts-directory
))
396 (read-file-name "Store in directory: " nil nil t nil
))
398 (equal t mh-mime-save-parts-default-directory
))
399 mh-mime-save-parts-directory
)
400 (read-file-name (format
401 "Store in directory (default %s): "
402 mh-mime-save-parts-directory
)
403 "" mh-mime-save-parts-directory t
""))
404 ((stringp mh-mime-save-parts-default-directory
)
405 mh-mime-save-parts-default-directory
)
407 mh-mime-save-parts-directory
))))
408 (if (and (equal directory
"") mh-mime-save-parts-directory
)
409 (setq directory mh-mime-save-parts-directory
))
410 (if (not (file-directory-p directory
))
411 (message "No directory specified")
412 (if (equal nil mh-mime-save-parts-default-directory
)
413 (setq mh-mime-save-parts-directory directory
))
415 (set-buffer (get-buffer-create mh-log-buffer
))
417 (setq mh-mime-save-parts-directory directory
)
418 (let ((initial-size (mh-truncate-log-buffer)))
420 (expand-file-name command mh-progs
) nil t nil
421 (mh-list-to-string (list folder msg
"-auto"
422 (if (not (mh-variant-p 'nmh
))
424 (if (> (buffer-size) initial-size
)
425 (save-window-excursion
426 (switch-to-buffer-other-window mh-log-buffer
)
430 (defun mh-toggle-mh-decode-mime-flag ()
431 "Toggle the value of `mh-decode-mime-flag'."
433 (setq mh-decode-mime-flag
(not mh-decode-mime-flag
))
435 (message "%s" (if mh-decode-mime-flag
436 "Processing attachments normally"
437 "Displaying raw message")))
440 (defun mh-toggle-mime-buttons ()
441 "Toggle option `mh-display-buttons-for-inline-parts-flag'."
443 (setq mh-display-buttons-for-inline-parts-flag
444 (not mh-display-buttons-for-inline-parts-flag
))
449 ;;; MIME Display Routines
451 (defun mh-mm-inline-message (handle)
452 "Display message, HANDLE.
453 The function decodes the message and displays it. It avoids
454 decoding the same message multiple times."
456 (clean-message-header mh-clean-message-header-flag
)
457 (invisible-headers mh-invisible-header-fields-compiled
)
458 (visible-headers nil
))
461 (narrow-to-region b b
)
462 (mm-insert-part handle
)
464 (or (gethash handle
(mh-mime-handles-cache (mh-buffer-data)))
465 (setf (gethash handle
(mh-mime-handles-cache (mh-buffer-data)))
466 (let ((handles (mm-dissect-buffer nil
)))
468 (mh-mm-uu-dissect-text-parts handles
)
469 (setq handles
(mm-uu-dissect)))
470 (setf (mh-mime-handles (mh-buffer-data))
472 handles
(mh-mime-handles (mh-buffer-data))))
475 (goto-char (point-min))
477 (cond (clean-message-header
478 (mh-clean-msg-header (point-min)
481 (goto-char (point-min)))
483 (mh-start-of-uncleaned-message)))
484 (mh-decode-message-header)
486 ;; The other highlighting types don't need anything special
487 (when (eq mh-highlight-citation-style
'gnus
)
488 (mh-gnus-article-highlight-citation))
489 (goto-char (point-min))
490 (insert "\n------- Forwarded Message\n\n")
492 (mh-display-emphasis)
493 (mm-handle-set-undisplayer
496 (let (buffer-read-only)
497 (if (fboundp 'remove-specifier
)
498 ;; This is only valid on XEmacs.
499 (mapcar (lambda (prop)
501 (face-property 'default prop
) (current-buffer)))
502 '(background background-pixmap foreground
)))
503 (delete-region ,(point-min-marker) ,(point-max-marker)))))))))
506 (defun mh-decode-message-header ()
507 "Decode RFC2047 encoded message header fields."
508 (when mh-decode-mime-flag
509 (let ((buffer-read-only nil
))
510 (rfc2047-decode-region (point-min) (mh-mail-header-end)))))
513 (defun mh-mime-display (&optional pre-dissected-handles
)
514 "Display (and possibly decode) MIME handles.
515 Optional argument, PRE-DISSECTED-HANDLES is a list of MIME
516 handles. If present they are displayed otherwise the buffer is
517 parsed and then displayed."
519 (folder mh-show-folder-buffer
)
520 (raw-message-data (buffer-string)))
521 (flet ((mm-handle-set-external-undisplayer
523 (mh-handle-set-external-undisplayer folder handle function
)))
524 (goto-char (point-min))
525 (unless (search-forward "\n\n" nil t
)
526 (goto-char (point-max))
531 ;; If needed dissect the current buffer
532 (if pre-dissected-handles
533 (setq handles pre-dissected-handles
)
534 (if (setq handles
(mm-dissect-buffer nil
))
535 (mh-mm-uu-dissect-text-parts handles
)
536 (setq handles
(mm-uu-dissect)))
537 (setf (mh-mime-handles (mh-buffer-data))
538 (mh-mm-merge-handles handles
539 (mh-mime-handles (mh-buffer-data))))
541 (mh-decode-message-body)))
544 (or (not (stringp (car handles
)))
546 ;; Go to start of message body
547 (goto-char (point-min))
548 (or (search-forward "\n\n" nil t
)
549 (goto-char (point-max)))
552 (delete-region (point) (point-max))
554 ;; Display the MIME handles
555 (mh-mime-display-part handles
))
557 (mh-signature-highlight))))
559 (message "Could not display body: %s" (error-message-string err
))
560 (delete-region (point-min) (point-max))
561 (insert raw-message-data
))))))
563 (defun mh-decode-message-body ()
564 "Decode message based on charset.
565 If message has been encoded for transfer take that into account."
566 (let (ct charset cte
)
567 (goto-char (point-min))
568 (re-search-forward "\n\n" nil t
)
570 (narrow-to-region (point-min) (point))
571 (setq ct
(ignore-errors (mail-header-parse-content-type
572 (message-fetch-field "Content-Type" t
)))
573 charset
(mail-content-type-get ct
'charset
)
574 cte
(message-fetch-field "Content-Transfer-Encoding")))
575 (when (stringp cte
) (setq cte
(mail-header-strip cte
)))
576 (when (or (not ct
) (equal (car ct
) "text/plain"))
578 (narrow-to-region (min (1+ (mh-mail-header-end)) (point-max))
580 (mm-decode-body charset
581 (and cte
(intern (downcase
582 (gnus-strip-whitespace cte
))))
585 (defun mh-mime-display-part (handle)
586 "Decides the viewer to call based on the type of HANDLE."
589 ((not (stringp (car handle
)))
590 (mh-mime-display-single handle
))
591 ((equal (car handle
) "multipart/alternative")
592 (mh-mime-display-alternative (cdr handle
)))
593 ((and mh-pgp-support-flag
594 (or (equal (car handle
) "multipart/signed")
595 (equal (car handle
) "multipart/encrypted")))
596 (mh-mime-display-security handle
))
598 (mh-mime-display-mixed (cdr handle
)))))
600 (defun mh-mime-display-mixed (handles)
601 "Display the list of MIME parts, HANDLES recursively."
602 (mapcar #'mh-mime-display-part handles
))
604 (defun mh-mime-display-alternative (handles)
605 "Choose among the alternatives, HANDLES the part that will be displayed.
606 If no part is preferred then all the parts are displayed."
607 (let* ((preferred (mm-preferred-alternative handles
))
608 (others (loop for x in handles unless
(eq x preferred
) collect x
)))
609 (cond ((and preferred
610 (stringp (car preferred
)))
611 (mh-mime-display-part preferred
)
612 (mh-mime-maybe-display-alternatives others
))
615 (narrow-to-region (point) (if (eobp) (point) (1+ (point))))
616 (mh-mime-display-single preferred
)
617 (mh-mime-maybe-display-alternatives others
)
618 (goto-char (point-max))))
620 (mh-mime-display-mixed handles
)))))
622 (defun mh-mime-maybe-display-alternatives (alternatives)
623 "Show buttons for ALTERNATIVES.
624 If `mh-mime-display-alternatives-flag' is non-nil then display
625 buttons for alternative parts that are usually suppressed."
626 (when (and mh-display-buttons-for-alternatives-flag alternatives
)
627 (insert "\n----------------------------------------------------\n")
628 (insert "Alternatives:\n")
629 (dolist (x alternatives
)
631 (mh-insert-mime-button x
(mh-mime-part-index x
) nil
))
632 (insert "\n----------------------------------------------------\n")))
634 (defun mh-mime-display-security (handle)
635 "Display PGP encrypted/signed message, HANDLE."
637 (narrow-to-region (point) (point))
639 (mh-insert-mime-security-button handle
)
640 (mh-mime-display-mixed (cdr handle
))
642 (let ((mh-mime-security-button-line-format
643 mh-mime-security-button-end-line-format
))
644 (mh-insert-mime-security-button handle
))
645 (mh-mm-set-handle-multipart-parameter
646 handle
'mh-region
(cons (point-min-marker) (point-max-marker)))))
648 (defun mh-mime-display-single (handle)
649 "Display a leaf node, HANDLE in the MIME tree."
650 (let* ((type (mm-handle-media-type handle
))
651 (small-image-flag (mh-small-image-p handle
))
652 (attachmentp (equal (car (mm-handle-disposition handle
))
654 (inlinep (and (equal (car (mm-handle-disposition handle
)) "inline")
655 (mm-inlinable-p handle
)
656 (mm-inlined-p handle
)))
657 (displayp (or inlinep
; show if inline OR
658 (mh-inline-vcard-p handle
); inline vcard OR
659 (and (not attachmentp
) ; if not an attachment
660 (or small-image-flag
; and small image
661 ; and user wants inline
663 (mm-handle-media-supertype handle
)
665 (mm-inlinable-p handle
)
666 (mm-inlined-p handle
)))))))
668 (narrow-to-region (point) (if (eobp) (point) (1+ (point))))
669 (cond ((and mh-pgp-support-flag
670 (equal type
"application/pgp-signature"))
671 nil
) ; skip signatures as they are already handled...
674 (mh-insert-mime-button handle
(mh-mime-part-index handle
) nil
))
676 (not mh-display-buttons-for-inline-parts-flag
))
677 (or (mm-display-part handle
)
678 (mm-display-part handle
))
679 (mh-signature-highlight handle
))
681 mh-display-buttons-for-inline-parts-flag
)
683 (mh-insert-mime-button handle
(mh-mime-part-index handle
) nil
)
685 (mh-mm-display-part handle
)))
686 (goto-char (point-max)))))
688 ;; There is a bug in Gnus inline image display due to which an extra line
689 ;; gets inserted every time it is viewed. To work around that problem we are
690 ;; using an extra property 'mh-region to remember the region that is added
691 ;; when the button is clicked. The region is then deleted to make sure that
692 ;; no extra lines get inserted.
693 (defun mh-mm-display-part (handle)
694 "Toggle display of button for MIME part, HANDLE."
696 (let ((id (get-text-property (point) 'mh-part
))
698 (window (selected-window))
699 (mail-parse-charset 'nil
)
700 (mail-parse-ignored-charsets nil
)
701 region buffer-read-only
)
704 (let ((win (get-buffer-window (current-buffer) t
)))
709 (if (mm-handle-displayed-p handle
)
710 ;; This will remove the part.
712 ;; Delete the button and displayed part (if any)
713 (let ((region (get-text-property point
'mh-region
)))
715 (mh-funcall-if-exists
716 remove-images
(car region
) (cdr region
)))
717 (mm-display-part handle
)
719 (delete-region (car region
) (cdr region
))))
720 ;; Delete button (if it still remains). This happens for
721 ;; externally displayed parts where the previous step does
724 (delete-region (point) (progn (forward-line) (point)))))
726 (delete-region (point) (progn (forward-line 1) (point)))
727 (narrow-to-region (point) (point))
728 ;; Maybe we need another unwind-protect here.
729 (when (equal (mm-handle-media-supertype handle
) "image")
731 (when (and (not (eq (ignore-errors (mm-display-part handle
))
733 (equal (mm-handle-media-supertype handle
)
735 (goto-char (point-min))
737 (when (equal (mm-handle-media-supertype handle
) "text")
738 (when (eq mh-highlight-citation-style
'gnus
)
739 (mh-gnus-article-highlight-citation))
741 (mh-display-emphasis)
742 (mh-signature-highlight handle
))
743 (setq region
(cons (progn (goto-char (point-min))
745 (progn (goto-char (point-max))
747 (when (window-live-p window
)
748 (select-window window
))
751 (mh-insert-mime-button handle id
(mm-handle-displayed-p handle
))
754 (add-text-properties (mh-line-beginning-position)
755 (mh-line-end-position)
756 `(mh-region ,region
)))))))
758 (defun mh-mime-part-index (handle)
759 "Generate the button number for MIME part, HANDLE.
760 Notice that a hash table is used to display the same number when
761 buttons need to be displayed multiple times (for instance when
762 nested messages are opened)."
763 (or (gethash handle
(mh-mime-part-index-hash (mh-buffer-data)))
764 (setf (gethash handle
(mh-mime-part-index-hash (mh-buffer-data)))
765 (incf (mh-mime-parts-count (mh-buffer-data))))))
767 (defun mh-small-image-p (handle)
768 "Decide whether HANDLE is a \"small\" image that can be displayed inline.
769 This is only useful if a Content-Disposition header is not present."
770 (let ((media-test (caddr (assoc (car (mm-handle-type handle
))
771 mh-mm-inline-media-tests
)))
772 (mm-inline-large-images t
))
774 (equal (mm-handle-media-supertype handle
) "image")
775 (funcall media-test handle
) ; Since mm-inline-large-images is T,
776 ; this only tells us if the image is
777 ; something that emacs can display
778 (let* ((image (mm-get-image handle
)))
780 (and (mh-funcall-if-exists glyphp image
)
781 (< (glyph-width image
)
782 (or mh-max-inline-image-width
(window-pixel-width)))
783 (< (glyph-height image
)
784 (or mh-max-inline-image-height
785 (window-pixel-height)))))
787 (let ((size (mh-funcall-if-exists image-size image
)))
789 (< (cdr size
) (or mh-max-inline-image-height
790 (1- (window-height))))
791 (< (car size
) (or mh-max-inline-image-width
792 (window-width)))))))))))
794 (defun mh-inline-vcard-p (handle)
795 "Decide if HANDLE is a vcard that must be displayed inline."
796 (let ((type (mm-handle-type handle
)))
797 (and (or (featurep 'vcard
) (fboundp 'vcard-pretty-print
))
799 (equal (car type
) "text/x-vcard")
803 (goto-char (point-min))
804 (not (mh-signature-separator-p)))))))
806 (defun mh-signature-highlight (&optional handle
)
807 "Highlight message signature in HANDLE.
808 The optional argument, HANDLE is a MIME handle if the function is
809 being used to highlight the signature in a MIME part."
811 (cond ((not handle
) "^-- $")
812 ((not (and (equal (mm-handle-media-supertype handle
) "text")
813 (equal (mm-handle-media-subtype handle
) "html")))
815 ((eq (mh-mm-text-html-renderer) 'lynx
) "^ --$")
818 (goto-char (point-max))
819 (when (re-search-backward regexp nil t
)
821 (let ((ov (make-overlay (point) (point-max))))
822 (overlay-put ov
'face
'mh-show-signature
)
823 (overlay-put ov
'evaporate t
)))
825 (set-extent-property (make-extent (point) (point-max))
826 'face
'mh-show-signature
))))))
833 (defvar dots
) ; XEmacs
834 (defvar type
) ; XEmacs
837 (defun mh-insert-mime-button (handle index displayed
)
838 "Insert MIME button for HANDLE.
839 INDEX is the part number that will be DISPLAYED. It is also used
840 by commands like \"K v\" which operate on individual MIME parts."
841 ;; The button could be displayed by a previous decode. In that case
842 ;; undisplay it if we need a hidden button.
843 (when (and (mm-handle-displayed-p handle
) (not displayed
))
844 (mm-display-part handle
))
845 (let ((name (or (mail-content-type-get (mm-handle-type handle
) 'name
)
846 (mail-content-type-get (mm-handle-disposition handle
)
848 (mail-content-type-get (mm-handle-type handle
) 'url
)
850 (type (mm-handle-media-type handle
))
851 (description (mail-decode-encoded-word-string
852 (or (mm-handle-description handle
) "")))
853 (dots (if (or displayed
(mm-handle-displayed-p handle
)) " " "..."))
855 (if (string-match ".*/" name
) (setq name
(substring name
(match-end 0))))
856 (setq long-type
(concat type
(and (not (equal name
""))
857 (concat "; " name
))))
858 (unless (equal description
"")
859 (setq long-type
(concat " --- " long-type
)))
860 (unless (bolp) (insert "\n"))
863 mh-mime-button-line-format mh-mime-button-line-format-alist
864 `(,@(mh-gnus-local-map-property mh-mime-button-map
)
865 mh-callback mh-mm-display-part
869 (widget-convert-button
872 :action
'mh-widget-press-button
873 :button-keymap mh-mime-button-map
875 "Mouse-2 click or press RET (in show buffer) to toggle display")
876 (dolist (ov (mh-funcall-if-exists overlays-in begin end
))
877 (mh-funcall-if-exists overlay-put ov
'evaporate t
))))
880 (defvar mm-verify-function-alist
) ; < Emacs 22
881 (defvar mm-decrypt-function-alist
) ; < Emacs 22
882 (defvar pressed-details
) ; XEmacs
884 (defun mh-insert-mime-security-button (handle)
885 "Display buttons for PGP message, HANDLE."
886 (let* ((protocol (mh-mm-handle-multipart-ctl-parameter handle
'protocol
))
887 (crypto-type (or (nth 2 (assoc protocol mm-verify-function-alist
))
888 (nth 2 (assoc protocol mm-decrypt-function-alist
))
890 (type (concat crypto-type
891 (if (equal (car handle
) "multipart/signed")
892 " Signed" " Encrypted")
894 (info (or (mh-mm-handle-multipart-ctl-parameter handle
'gnus-info
)
896 (details (mh-mm-handle-multipart-ctl-parameter handle
'gnus-details
))
897 pressed-details begin end face
)
898 (setq details
(if details
(concat "\n" details
) ""))
899 (setq pressed-details
(if mh-mime-security-button-pressed details
""))
900 (setq face
(mh-mime-security-button-face info
))
901 (unless (bolp) (insert "\n"))
904 mh-mime-security-button-line-format
905 mh-mime-security-button-line-format-alist
906 `(,@(mh-gnus-local-map-property mh-mime-security-button-map
)
907 mh-button-pressed
,mh-mime-security-button-pressed
908 mh-callback mh-mime-security-press-button
909 mh-line-format
,mh-mime-security-button-line-format
912 (widget-convert-button 'link begin end
914 :action
'mh-widget-press-button
915 :button-keymap mh-mime-security-button-map
917 :help-echo
"Mouse-2 click or press RET (in show buffer) to see security details.")
918 (dolist (ov (mh-funcall-if-exists overlays-in begin end
))
919 (mh-funcall-if-exists overlay-put ov
'evaporate t
))
920 (when (equal info
"Failed")
921 (let* ((type (if (equal (car handle
) "multipart/signed")
922 "verification" "decryption"))
923 (warning (if (equal type
"decryption")
924 "(passphrase may be incorrect)" "")))
925 (message "%s %s failed %s" crypto-type type warning
)))))
927 (defun mh-mime-security-button-face (info)
928 "Return the button face to use for encrypted/signed mail based on INFO."
929 (cond ((string-match "OK" info
) ;Decrypted mail
931 ((string-match "Failed" info
) ;Decryption failed or signature invalid
933 ((string-match "Undecided" info
);Unprocessed mail
934 'mh-show-pgg-unknown
)
935 ((string-match "Untrusted" info
);Key not trusted
936 'mh-show-pgg-unknown
)
944 (defun mh-folder-mime-action (part-index action include-security-flag
)
945 "Go to PART-INDEX and carry out ACTION.
947 If PART-INDEX is nil then go to the next part in the buffer. The
948 search for the next buffer wraps around if end of buffer is reached.
949 If argument INCLUDE-SECURITY-FLAG is non-nil then include security
950 info buttons when searching for a suitable parts."
951 (unless mh-showing-mode
953 (mh-in-show-buffer (mh-show-buffer)
957 (let ((part (get-text-property p
'mh-part
)))
958 (and (integerp part
) (= part part-index
)))))
960 (if include-security-flag
961 (get-text-property p
'mh-data
)
962 (integerp (get-text-property p
'mh-part
)))))))
964 (cond ((and (get-text-property point
'mh-part
)
965 (or (null part-index
)
966 (= (get-text-property point
'mh-part
) part-index
)))
968 ((and (get-text-property point
'mh-data
)
969 include-security-flag
973 (mh-goto-next-button nil criterion
)
974 (if (= (point) point
)
975 (message "No matching MIME part found")
976 (funcall action
)))))))
979 (defun mh-goto-next-button (backward-flag &optional criterion
)
980 "Search for next button satisfying criterion.
982 If BACKWARD-FLAG is non-nil search backward in the buffer for a mime
984 If CRITERION is a function or a symbol which has a function binding
985 then that function must return non-nil at the button we stop."
986 (unless (or (and (symbolp criterion
) (fboundp criterion
))
987 (functionp criterion
))
988 (setq criterion
(lambda (x) t
)))
989 ;; Move to the next button in the buffer satisfying criterion
990 (goto-char (or (save-excursion
992 ;; Find point before current button
993 (let ((point-before-current-button
995 (while (get-text-property (point) 'mh-data
)
996 (unless (= (forward-line
997 (if backward-flag
1 -
1))
1000 (goto-char (point-min))
1001 (goto-char (point-max)))))
1003 ;; Skip over current button
1004 (while (and (get-text-property (point) 'mh-data
)
1005 (not (if backward-flag
(bobp) (eobp))))
1006 (forward-line (if backward-flag -
1 1)))
1007 ;; Stop at next MIME button if any exists.
1010 (unless (= (forward-line
1011 (if backward-flag -
1 1))
1014 (goto-char (point-max))
1015 (goto-char (point-min)))
1016 (beginning-of-line))
1018 point-before-current-button
)
1019 (when (and (get-text-property (point) 'mh-data
)
1020 (funcall criterion
(point)))
1021 (return-from loop
(point))))
1025 (defun mh-widget-press-button (widget el
)
1026 "Callback for widget, WIDGET.
1027 Parameter EL is unused."
1028 (goto-char (widget-get widget
:from
))
1031 (defun mh-press-button ()
1032 "View contents of button.
1034 This command is a toggle so if you use it again on the same
1035 attachment, the attachment is hidden."
1037 (let ((mm-inline-media-tests mh-mm-inline-media-tests
)
1038 (data (get-text-property (point) 'mh-data
))
1039 (function (get-text-property (point) 'mh-callback
))
1040 (buffer-read-only nil
)
1041 (folder mh-show-folder-buffer
))
1042 (flet ((mm-handle-set-external-undisplayer
1044 (mh-handle-set-external-undisplayer folder handle function
)))
1045 (when (and function
(eolp))
1047 (unwind-protect (and function
(funcall function data
))
1048 (set-buffer-modified-p nil
)))))
1050 (defun mh-push-button (event)
1051 "Click MIME button for EVENT.
1053 If the MIME part is visible then it is removed. Otherwise the
1054 part is displayed. This function is called when the mouse is used
1055 to click the MIME button."
1057 (mh-do-at-event-location event
1058 (let ((folder mh-show-folder-buffer
)
1059 (mm-inline-media-tests mh-mm-inline-media-tests
)
1060 (data (get-text-property (point) 'mh-data
))
1061 (function (get-text-property (point) 'mh-callback
)))
1062 (flet ((mm-handle-set-external-undisplayer (handle func
)
1063 (mh-handle-set-external-undisplayer folder handle func
)))
1064 (and function
(funcall function data
))))))
1066 (defun mh-handle-set-external-undisplayer (folder handle function
)
1067 "Replacement for `mm-handle-set-external-undisplayer'.
1069 This is only called in recent versions of Gnus. The MIME handles
1070 are stored in data structures corresponding to MH-E folder buffer
1071 FOLDER instead of in Gnus (as in the original). The MIME part,
1072 HANDLE is associated with the undisplayer FUNCTION."
1073 (if (mh-mm-keep-viewer-alive-p handle
)
1074 (let ((new-handle (copy-sequence handle
)))
1075 (mm-handle-set-undisplayer new-handle function
)
1076 (mm-handle-set-undisplayer handle nil
)
1079 (push new-handle
(mh-mime-handles (mh-buffer-data)))))
1080 (mm-handle-set-undisplayer handle function
)))
1082 (defun mh-mime-security-press-button (handle)
1083 "Callback from security button for part HANDLE."
1084 (if (mh-mm-handle-multipart-ctl-parameter handle
'gnus-info
)
1085 (mh-mime-security-show-details handle
)
1086 (let ((region (mh-mm-handle-multipart-ctl-parameter handle
'mh-region
))
1088 (setq point
(point))
1089 (goto-char (car region
))
1090 (delete-region (car region
) (cdr region
))
1091 (with-current-buffer (mh-mm-handle-multipart-ctl-parameter handle
'buffer
)
1092 (let* ((mm-verify-option 'known
)
1093 (mm-decrypt-option 'known
)
1094 (new (mh-mm-possibly-verify-or-decrypt (cdr handle
) handle
)))
1095 (unless (eq new
(cdr handle
))
1096 (mh-mm-destroy-parts (cdr handle
))
1097 (setcdr handle new
))))
1098 (mh-mime-display-security handle
)
1099 (goto-char point
))))
1101 ;; I rewrote the security part because Gnus doesn't seem to ever minimize
1102 ;; the button. That is once the mime-security button is pressed there seems
1103 ;; to be no way of getting rid of the inserted text.
1104 (defun mh-mime-security-show-details (handle)
1105 "Toggle display of detailed security info for HANDLE."
1106 (let ((details (mh-mm-handle-multipart-ctl-parameter handle
'gnus-details
)))
1108 (let ((mh-mime-security-button-pressed
1109 (not (get-text-property (point) 'mh-button-pressed
)))
1110 (mh-mime-security-button-line-format
1111 (get-text-property (point) 'mh-line-format
)))
1113 (while (eq (get-text-property (point) 'mh-line-format
)
1114 mh-mime-security-button-line-format
)
1118 (narrow-to-region (point) (point))
1119 (mh-insert-mime-security-button handle
))
1122 (or (text-property-not-all
1124 'mh-line-format mh-mime-security-button-line-format
)
1126 (forward-line -
1)))))
1130 ;;; Miscellaneous Article Washing
1133 (defun mh-add-missing-mime-version-header ()
1134 "Some mail programs don't put a MIME-Version header.
1135 I have seen this only in spam, so maybe we shouldn't fix
1138 (goto-char (point-min))
1139 (re-search-forward "\n\n" nil t
)
1141 (narrow-to-region (point-min) (point))
1142 (when (and (message-fetch-field "content-type")
1143 (not (message-fetch-field "mime-version")))
1144 (goto-char (point-min))
1145 (insert "MIME-Version: 1.0\n")))))
1148 (defun mh-display-smileys ()
1150 (when (and mh-graphical-smileys-flag
(mh-small-show-buffer-p))
1151 (mh-funcall-if-exists smiley-region
(point-min) (point-max))))
1154 (defun mh-display-emphasis ()
1155 "Display graphical emphasis."
1156 (when (and mh-graphical-emphasis-flag
(mh-small-show-buffer-p))
1157 (flet ((article-goto-body ())) ; shadow this function to do nothing
1159 (goto-char (point-min))
1160 (article-emphasize)))))
1162 (defun mh-small-show-buffer-p ()
1163 "Check if show buffer is small.
1164 This is used to decide if smileys and graphical emphasis should be
1167 (when (and (boundp 'font-lock-maximum-size
) font-lock-maximum-size
)
1168 (cond ((numberp font-lock-maximum-size
)
1169 (setq max font-lock-maximum-size
))
1170 ((listp font-lock-maximum-size
)
1171 (setq max
(cdr (or (assoc 'mh-show-mode font-lock-maximum-size
)
1172 (assoc t font-lock-maximum-size
)))))))
1173 (or (not (numberp max
)) (>= (/ max
8) (buffer-size)))))
1177 ;;; MH-Letter Commands
1179 ;; MH-E commands are alphabetical; specific support routines follow command.
1182 (defun mh-compose-forward (&optional description folder range
)
1183 "Add tag to forward a message.
1185 You are prompted for a content DESCRIPTION, the name of the
1186 FOLDER in which the messages to forward are located, and a RANGE
1187 of messages, which defaults to the current message in that
1188 folder. Check the documentation of `mh-interactive-range' to see
1189 how RANGE is read in interactive use.
1191 The option `mh-compose-insertion' controls what type of tags are inserted."
1194 (mml-minibuffer-read-description))
1196 (mh-prompt-for-folder "Message from"
1197 mh-sent-from-folder nil
))
1199 (if (and (equal folder mh-sent-from-folder
)
1200 (numberp mh-sent-from-msg
))
1202 (nth 0 (mh-translate-range folder
"cur"))))
1204 (mh-read-range "Forward" folder
1206 (number-to-string default
))
1209 (list description folder range
)))
1210 (let ((messages (mapconcat 'identity
(mh-list-to-string range
) " ")))
1211 (dolist (message (mh-translate-range folder messages
))
1212 (if (equal mh-compose-insertion
'mml
)
1213 (mh-mml-forward-message description folder
(format "%s" message
))
1214 (mh-mh-forward-message description folder
(format "%s" message
))))))
1217 (defun mh-mml-forward-message (description folder message
)
1218 "Forward a message as attachment.
1220 The function will prompt the user for a DESCRIPTION, a FOLDER and
1222 (let ((msg (if (and (equal message
"") (numberp mh-sent-from-msg
))
1224 (string-to-number message
))))
1225 (cond ((integerp msg
)
1226 (mml-attach-file (format "%s%s/%d"
1227 mh-user-path
(substring folder
1) msg
)
1229 (if (string= "" description
) nil description
)
1231 (t (error "The message number, %s, is not a integer" msg
)))))
1233 (defun mh-mh-forward-message (&optional description folder messages
)
1234 "Add tag to forward a message.
1235 You are prompted for a content DESCRIPTION, the name of the
1236 FOLDER in which the messages to forward are located, and the
1239 See also \\[mh-mh-to-mime]."
1241 (mml-minibuffer-read-description)
1242 (mh-prompt-for-folder "Message from" mh-sent-from-folder nil
)
1243 (read-string (concat "Messages"
1244 (if (numberp mh-sent-from-msg
)
1245 (format " (default %d): "
1251 (not (string= description
""))
1252 (insert description
))
1255 (not (string= folder
""))
1256 (insert " " folder
))
1258 (not (string= messages
"")))
1259 (let ((start (point)))
1260 (insert " " messages
)
1261 (subst-char-in-region start
(point) ?
, ?
))
1262 (if (numberp mh-sent-from-msg
)
1263 (insert " " (int-to-string mh-sent-from-msg
))))
1267 (defun mh-compose-insertion (&optional inline
)
1268 "Add tag to include a file such as an image or sound.
1270 You are prompted for the filename containing the object, the
1271 media type if it cannot be determined automatically, and a
1272 content description. If you're using MH-style directives, you
1273 will also be prompted for additional attributes.
1275 The option `mh-compose-insertion' controls what type of tags are
1276 inserted. Optional argument INLINE means make it an inline
1279 (if (equal mh-compose-insertion
'mml
)
1281 (mh-mml-attach-file "inline")
1282 (mh-mml-attach-file))
1283 (call-interactively 'mh-mh-attach-file
)))
1285 (defun mh-mml-attach-file (&optional disposition
)
1286 "Add a tag to insert a MIME message part from a file.
1288 You are prompted for the filename containing the object, the
1289 media type if it cannot be determined automatically, a content
1290 description and the DISPOSITION of the attachment.
1292 This is basically `mml-attach-file' from Gnus, modified such that a prefix
1293 argument yields an \"inline\" disposition and Content-Type is determined
1295 (let* ((file (mml-minibuffer-read-file "Attach file: "))
1296 (type (mh-minibuffer-read-type file
))
1297 (description (mml-minibuffer-read-description))
1298 (dispos (or disposition
1299 (mh-mml-minibuffer-read-disposition type
))))
1300 (mml-insert-empty-tag 'part
'type type
'filename file
1301 'disposition dispos
'description description
)))
1303 (defun mh-mh-attach-file (filename type description attributes
)
1304 "Add a tag to insert a MIME message part from a file.
1305 You are prompted for the FILENAME containing the object, the
1306 media TYPE if it cannot be determined automatically, and a
1307 content DESCRIPTION. In addition, you are also prompted for
1308 additional ATTRIBUTES.
1310 See also \\[mh-mh-to-mime]."
1311 (interactive (let ((filename (mml-minibuffer-read-file "Attach file: ")))
1314 (mh-minibuffer-read-type filename
)
1315 (mml-minibuffer-read-description)
1316 (read-string "Attributes: "
1318 (file-name-nondirectory filename
)
1320 (mh-mh-compose-type filename type description attributes
))
1322 (defun mh-mh-compose-type (filename type
1323 &optional description attributes comment
)
1324 "Insert an MH-style directive to insert a file.
1325 The file specified by FILENAME is encoded as TYPE. An optional
1326 DESCRIPTION is used as the Content-Description field, optional
1327 set of ATTRIBUTES and an optional COMMENT can also be included."
1331 (insert "; " attributes
))
1333 (insert " (" comment
")"))
1336 (insert description
))
1337 (insert "] " (expand-file-name filename
))
1341 (defun mh-mh-compose-anon-ftp (host filename type description
)
1342 "Add tag to include anonymous ftp reference to a file.
1344 You can have your message initiate an \"ftp\" transfer when the
1345 recipient reads the message. You are prompted for the remote HOST
1346 and FILENAME, the media TYPE, and the content DESCRIPTION.
1348 See also \\[mh-mh-to-mime]."
1350 (read-string "Remote host: ")
1351 (read-string "Remote filename: ")
1352 (mh-minibuffer-read-type "DUMMY-FILENAME")
1353 (mml-minibuffer-read-description)))
1354 (mh-mh-compose-external-type "anon-ftp" host filename
1358 (defun mh-mh-compose-external-compressed-tar (host filename description
)
1359 "Add tag to include anonymous ftp reference to a compressed tar file.
1361 In addition to retrieving the file via anonymous \"ftp\" as per
1362 the command \\[mh-mh-compose-anon-ftp], the file will also be
1363 uncompressed and untarred. You are prompted for the remote HOST
1364 and FILENAME and the content DESCRIPTION.
1366 See also \\[mh-mh-to-mime]."
1368 (read-string "Remote host: ")
1369 (read-string "Remote filename: ")
1370 (mml-minibuffer-read-description)))
1371 (mh-mh-compose-external-type "anon-ftp" host filename
1372 "application/octet-stream"
1374 "type=tar; conversions=x-compress"
1377 ;; RFC 2045 - Multipurpose Internet Mail Extensions (MIME) Part One:
1378 ;; Format of Internet Message Bodies.
1379 ;; RFC 2046 - Multipurpose Internet Mail Extensions (MIME) Part Two:
1381 ;; RFC 2049 - Multipurpose Internet Mail Extensions (MIME) Part Five:
1382 ;; Conformance Criteria and Examples.
1383 ;; RFC 2017 - Definition of the URL MIME External-Body Access-Type
1384 ;; RFC 1738 - Uniform Resource Locators (URL)
1385 (defvar mh-access-types
1386 '(("anon-ftp") ; RFC2046 Anonymous File Transfer Protocol
1387 ("file") ; RFC1738 Host-specific file names
1388 ("ftp") ; RFC2046 File Transfer Protocol
1389 ("gopher") ; RFC1738 The Gopher Protocol
1390 ("http") ; RFC1738 Hypertext Transfer Protocol
1391 ("local-file") ; RFC2046 Local file access
1392 ("mail-server") ; RFC2046 mail-server Electronic mail address
1393 ("mailto") ; RFC1738 Electronic mail address
1394 ("news") ; RFC1738 Usenet news
1395 ("nntp") ; RFC1738 Usenet news using NNTP access
1396 ("propspero") ; RFC1738 Prospero Directory Service
1397 ("telnet") ; RFC1738 Telnet
1398 ("tftp") ; RFC2046 Trivial File Transfer Protocol
1399 ("url") ; RFC2017 URL scheme MIME access-type Protocol
1400 ("wais")) ; RFC1738 Wide Area Information Servers
1401 "Valid MIME access-type values.")
1404 (defun mh-mh-compose-external-type (access-type host filename type
1405 &optional description
1406 attributes parameters
1408 "Add tag to refer to a remote file.
1410 This command is a general utility for referencing external files.
1411 In fact, all of the other commands that insert directives to
1412 access external files call this command. You are prompted for the
1413 ACCESS-TYPE, remote HOST and FILENAME, and content TYPE. If you
1414 provide a prefix argument, you are also prompted for a content
1415 DESCRIPTION, ATTRIBUTES, PARAMETERS, and a COMMENT.
1417 See also \\[mh-mh-to-mime]."
1419 (completing-read "Access type: " mh-access-types
)
1420 (read-string "Remote host: ")
1421 (read-string "Remote filename: ")
1422 (mh-minibuffer-read-type "DUMMY-FILENAME")
1423 (if current-prefix-arg
(mml-minibuffer-read-description))
1424 (if current-prefix-arg
(read-string "Attributes: "))
1425 (if current-prefix-arg
(read-string "Parameters: "))
1426 (if current-prefix-arg
(read-string "Comment: "))))
1430 (insert "; " attributes
))
1432 (insert " (" comment
") "))
1435 (insert description
))
1437 (insert "access-type=" access-type
"; ")
1438 (insert "site=" host
)
1439 (insert "; name=" (file-name-nondirectory filename
))
1440 (let ((directory (file-name-directory filename
)))
1442 (insert "; directory=\"" directory
"\"")))
1444 (insert "; " parameters
))
1447 (defvar mh-mh-to-mime-args nil
1448 "Extra arguments for \\[mh-mh-to-mime] to pass to the \"mhbuild\" command.
1449 The arguments are passed to \"mhbuild\" if \\[mh-mh-to-mime] is
1450 given a prefix argument. Normally default arguments to
1451 \"mhbuild\" are specified in the MH profile.")
1454 (defun mh-mh-to-mime (&optional extra-args
)
1455 "Compose MIME message from MH-style directives.
1457 Typically, you send a message with attachments just like any other
1458 message. However, you may take a sneak preview of the MIME encoding if
1459 you wish by running this command.
1461 If you wish to pass additional arguments to \"mhbuild\" (\"mhn\")
1462 to affect how it builds your message, use the option
1463 `mh-mh-to-mime-args'. For example, you can build a consistency
1464 check into the message by setting `mh-mh-to-mime-args' to
1465 \"-check\". The recipient of your message can then run \"mhbuild
1466 -check\" on the message--\"mhbuild\" (\"mhn\") will complain if
1467 the message has been corrupted on the way. This command only
1468 consults this option when given a prefix argument EXTRA-ARGS.
1470 The hook `mh-mh-to-mime-hook' is called after the message has been
1473 The effects of this command can be undone by running
1474 \\[mh-mh-to-mime-undo]."
1476 (mh-mh-quote-unescaped-sharp)
1478 (message "Running %s..." (if (mh-variant-p 'nmh
) "mhbuild" "mhn"))
1480 ((mh-variant-p 'nmh
)
1481 (mh-exec-cmd-error nil
1483 (if extra-args mh-mh-to-mime-args
)
1486 (mh-exec-cmd-error (format "mhdraft=%s" buffer-file-name
)
1488 (if extra-args mh-mh-to-mime-args
)
1491 (message "Running %s...done" (if (mh-variant-p 'nmh
) "mhbuild" "mhn"))
1492 (run-hooks 'mh-mh-to-mime-hook
))
1494 (defun mh-mh-quote-unescaped-sharp ()
1495 "Quote \"#\" characters that haven't been quoted for \"mhbuild\".
1496 If the \"#\" character is present in the first column, but it isn't
1497 part of a MH-style directive then \"mhbuild\" gives an error.
1498 This function will quote all such characters."
1500 (goto-char (point-min))
1501 (while (re-search-forward "^#" nil t
)
1503 (unless (mh-mh-directive-present-p (point) (mh-line-end-position))
1505 (goto-char (mh-line-end-position)))))
1508 (defun mh-mh-to-mime-undo (noconfirm)
1509 "Undo effects of \\[mh-mh-to-mime].
1511 It does this by reverting to a backup file. You are prompted to
1512 confirm this action, but you can avoid the confirmation by adding
1513 a prefix argument NOCONFIRM."
1515 (if (null buffer-file-name
)
1516 (error "Buffer does not seem to be associated with any file"))
1517 (let ((backup-strings '("," "#"))
1519 (while (and backup-strings
1522 (concat (file-name-directory buffer-file-name
)
1523 (car backup-strings
)
1524 (file-name-nondirectory buffer-file-name
)
1526 (setq backup-strings
(cdr backup-strings
)))
1528 (error "Backup file for %s no longer exists" buffer-file-name
))
1530 (yes-or-no-p (format "Revert buffer from file %s? "
1532 (error "Revert not confirmed"))
1533 (let ((buffer-read-only nil
))
1535 (insert-file-contents backup-file
))
1536 (after-find-file nil
)))
1539 (defvar mh-identity-pgg-default-user-id
)
1542 (defun mh-mml-secure-message-encrypt (method)
1543 "Add tag to encrypt the message.
1545 A proper multipart message is created for you when you send the
1546 message. Use the command \\[mh-mml-unsecure-message] to remove
1547 this tag. Use a prefix argument METHOD to be prompted for one of
1548 the possible security methods (see `mh-mml-method-default')."
1549 (interactive (list (mh-mml-query-cryptographic-method)))
1550 (mh-secure-message method
"encrypt" mh-identity-pgg-default-user-id
))
1553 (defun mh-mml-secure-message-sign (method)
1554 "Add tag to sign the message.
1556 A proper multipart message is created for you when you send the
1557 message. Use the command \\[mh-mml-unsecure-message] to remove
1558 this tag. Use a prefix argument METHOD to be prompted for one of
1559 the possible security methods (see `mh-mml-method-default')."
1560 (interactive (list (mh-mml-query-cryptographic-method)))
1561 (mh-secure-message method
"sign" mh-identity-pgg-default-user-id
))
1564 (defun mh-mml-secure-message-signencrypt (method)
1565 "Add tag to encrypt and sign the message.
1567 A proper multipart message is created for you when you send the
1568 message. Use the command \\[mh-mml-unsecure-message] to remove
1569 this tag. Use a prefix argument METHOD to be prompted for one of
1570 the possible security methods (see `mh-mml-method-default')."
1571 (interactive (list (mh-mml-query-cryptographic-method)))
1572 (mh-secure-message method
"signencrypt" mh-identity-pgg-default-user-id
))
1574 (defvar mh-mml-cryptographic-method-history
())
1576 (defun mh-mml-query-cryptographic-method ()
1577 "Read the cryptographic method to use."
1578 (if current-prefix-arg
1579 (let ((def (or (car mh-mml-cryptographic-method-history
)
1580 mh-mml-method-default
)))
1581 (completing-read (format "Method (default %s): " def
)
1582 '(("pgp") ("pgpmime") ("smime"))
1583 nil t nil
'mh-mml-cryptographic-method-history def
))
1584 mh-mml-method-default
))
1586 (defun mh-secure-message (method mode
&optional identity
)
1587 "Add tag to encrypt or sign message.
1589 METHOD should be one of: \"pgpmime\", \"pgp\", \"smime\".
1590 MODE should be one of: \"sign\", \"encrypt\", \"signencrypt\", \"none\".
1591 IDENTITY is optionally the default-user-id to use."
1592 (if (not mh-pgp-support-flag
)
1593 (error "Your version of Gnus does not support PGP/GPG")
1594 ;; Check the arguments
1595 (let ((valid-methods (list "pgpmime" "pgp" "smime"))
1596 (valid-modes (list "sign" "encrypt" "signencrypt" "none")))
1597 (if (not (member method valid-methods
))
1598 (error "Method %s is invalid" method
))
1599 (if (not (member mode valid-modes
))
1600 (error "Mode %s is invalid" mode
))
1601 (mml-unsecure-message)
1602 (if (not (string= mode
"none"))
1604 (goto-char (point-min))
1605 (mh-goto-header-end 1)
1606 (if mh-identity-pgg-default-user-id
1607 (mml-insert-tag 'secure
'method method
'mode mode
1608 'sender mh-identity-pgg-default-user-id
)
1609 (mml-insert-tag 'secure
'method method
'mode mode
)))))))
1612 (defun mh-mml-to-mime ()
1613 "Compose MIME message from MML tags.
1615 Typically, you send a message with attachments just like any
1616 other message. However, you may take a sneak preview of the MIME
1617 encoding if you wish by running this command.
1619 This action can be undone by running \\[undo]."
1622 (when mh-pgp-support-flag
1623 ;; PGP requires actual e-mail addresses, not aliases.
1624 ;; Parse the recipients and sender from the message.
1625 (message-options-set-recipient)
1626 ;; Do an alias lookup on sender (if From field is present).
1627 (when (message-options-get 'message-sender
)
1628 (message-options-set 'message-sender
1629 (mail-strip-quoted-names
1631 (message-options-get 'message-sender
)))))
1632 ;; Do an alias lookup on recipients
1633 (message-options-set 'message-recipients
1636 (mail-strip-quoted-names (mh-alias-expand ali
)))
1637 (split-string (message-options-get 'message-recipients
) "[, ]+")
1639 (let ((saved-text (buffer-string))
1640 (buffer (current-buffer))
1641 (modified-flag (buffer-modified-p)))
1642 (condition-case err
(mml-to-mime)
1644 (with-current-buffer buffer
1645 (delete-region (point-min) (point-max))
1647 (set-buffer-modified-p modified-flag
))
1648 (error (error-message-string err
))))))
1651 (defun mh-mml-unsecure-message ()
1652 "Remove any secure message tags."
1654 (if (not mh-pgp-support-flag
)
1655 (error "Your version of Gnus does not support PGP/GPG")
1656 (mml-unsecure-message)))
1660 ;;; Support Routines for MH-Letter Commands
1663 (defun mh-mml-tag-present-p ()
1664 "Check if the current buffer has text which may be a MML tag."
1666 (goto-char (point-min))
1669 "\\(<#\\(mml\\|part\\)\\(.\\|\n\\)*>[ \n\t]*<#/\\(mml\\|part\\)>\\|"
1673 (defvar mh-media-type-regexp
1674 (concat (regexp-opt '("text" "image" "audio" "video" "application"
1675 "multipart" "message") t
)
1677 "Regexp matching valid media types used in MIME attachment compositions.")
1680 (defun mh-mh-directive-present-p (&optional begin end
)
1681 "Check if the text between BEGIN and END might be a MH-style directive.
1682 The optional argument BEGIN defaults to the beginning of the
1683 buffer, while END defaults to the end of the buffer."
1684 (unless begin
(setq begin
(point-min)))
1685 (unless end
(setq end
(point-max)))
1687 (block 'search-for-mh-directive
1689 (while (re-search-forward "^#" end t
)
1690 (let ((s (buffer-substring-no-properties
1691 (point) (mh-line-end-position))))
1692 (cond ((equal s
""))
1693 ((string-match "^forw[ \t\n]+" s
)
1694 (return-from 'search-for-mh-directive t
))
1695 (t (let ((first-token (car (split-string s
"[ \t;@]"))))
1696 (when (and first-token
1697 (string-match mh-media-type-regexp
1699 (return-from 'search-for-mh-directive t
)))))))
1702 (defun mh-minibuffer-read-type (filename &optional default
)
1703 "Return the content type associated with the given FILENAME.
1704 If the \"file\" command exists and recognizes the given file,
1705 then its value is returned\; otherwise, the user is prompted for
1706 a type (see `mailcap-mime-types').
1707 Optional argument DEFAULT is returned if a type isn't entered."
1708 (mailcap-parse-mimetypes)
1709 (let* ((default (or default
1710 (mm-default-file-encoding filename
)
1711 "application/octet-stream"))
1712 (probed-type (mh-file-mime-type filename
))
1713 (type (or (and (not (equal probed-type
"application/octet-stream"))
1716 (format "Content type (default %s): " default
)
1717 (mapcar 'list
(mailcap-mime-types))))))
1718 (if (not (equal type
""))
1723 (defun mh-file-mime-type (filename)
1724 "Return MIME type of FILENAME from file command.
1725 Returns nil if file command not on system."
1727 ((not (mh-have-file-command))
1728 nil
) ;no file command, exit now
1729 ((not (and (file-exists-p filename
)
1730 (file-readable-p filename
)))
1731 nil
) ;no file or not readable, ditto
1734 (let ((tmp-buffer (get-buffer-create mh-temp-buffer
)))
1735 (set-buffer tmp-buffer
)
1738 (call-process "file" nil
'(t nil
) nil
"-b" "-i"
1739 (expand-file-name filename
))
1740 (goto-char (point-min))
1741 (if (not (re-search-forward mh-media-type-regexp nil t
))
1743 (mh-file-mime-type-substitute (match-string 0) filename
)))
1744 (kill-buffer tmp-buffer
)))))))
1746 (defvar mh-file-mime-type-substitutions
1747 '(("application/msword" "\.xls" "application/ms-excel")
1748 ("application/msword" "\.ppt" "application/ms-powerpoint")
1749 ("text/plain" "\.vcf" "text/x-vcard")
1750 ("text/rtf" "\.rtf" "application/rtf")
1751 ("application/x-zip" "\.sxc" "application/vnd.sun.xml.calc")
1752 ("application/x-zip" "\.sxd" "application/vnd.sun.xml.draw")
1753 ("application/x-zip" "\.sxi" "application/vnd.sun.xml.impress")
1754 ("application/x-zip" "\.sxw" "application/vnd.sun.xml.writer")
1755 ("application/x-zip" "\.odg" "application/vnd.oasis.opendocument.graphics")
1756 ("application/x-zip" "\.odi" "application/vnd.oasis.opendocument.image")
1757 ("application/x-zip" "\.odp"
1758 "application/vnd.oasis.opendocument.presentation")
1759 ("application/x-zip" "\.ods"
1760 "application/vnd.oasis.opendocument.spreadsheet")
1761 ("application/x-zip" "\.odt" "application/vnd.oasis.opendocument.text"))
1762 "Substitutions to make for Content-Type returned from file command.
1763 The first element is the Content-Type returned by the file command.
1764 The second element is a regexp matching the file name, usually the
1766 The third element is the Content-Type to replace with.")
1768 (defun mh-file-mime-type-substitute (content-type filename
)
1769 "Return possibly changed CONTENT-TYPE on the FILENAME.
1770 Substitutions are made from the `mh-file-mime-type-substitutions'
1772 (let ((subst mh-file-mime-type-substitutions
)
1773 (type) (match) (answer content-type
)
1774 (case-fold-search t
))
1776 (setq type
(car (car subst
))
1777 match
(elt (car subst
) 1))
1778 (if (and (string-equal content-type type
)
1779 (string-match match filename
))
1780 (setq answer
(elt (car subst
) 2)
1782 (setq subst
(cdr subst
))))
1785 (defvar mh-have-file-command
'undefined
1786 "Cached value of function `mh-have-file-command'.
1787 Do not reference this variable directly as it might not have been
1788 initialized. Always use the command `mh-have-file-command'.")
1791 (defun mh-have-file-command ()
1792 "Return t if 'file' command is on the system.
1793 'file -i' is used to get MIME type of composition insertion."
1794 (when (eq mh-have-file-command
'undefined
)
1795 (setq mh-have-file-command
1796 (and (fboundp 'executable-find
)
1797 (executable-find "file") ; file command exists
1798 ; and accepts -i and -b args.
1799 (zerop (call-process "file" nil nil nil
"-i" "-b"
1800 (expand-file-name "inc" mh-progs
))))))
1801 mh-have-file-command
)
1808 (defun mh-mime-cleanup ()
1809 "Free the decoded MIME parts."
1810 (let ((mime-data (gethash (current-buffer) mh-globals-hash
)))
1811 ;; This is for Emacs, what about XEmacs?
1812 (mh-funcall-if-exists remove-images
(point-min) (point-max))
1814 (mh-mm-destroy-parts (mh-mime-handles mime-data
))
1815 (remhash (current-buffer) mh-globals-hash
))))
1818 (defun mh-destroy-postponed-handles ()
1819 "Free MIME data for externally displayed MIME parts."
1820 (let ((mime-data (mh-buffer-data)))
1822 (mh-mm-destroy-parts (mh-mime-handles mime-data
)))
1823 (remhash (current-buffer) mh-globals-hash
)))
1828 ;; indent-tabs-mode: nil
1829 ;; sentence-end-double-space: nil
1832 ;; arch-tag: 0dd36518-1b64-4a84-8f4e-59f422d3f002
1833 ;;; mh-mime.el ends here