comparison man/mh-e.texi @ 37802:953a442c9130

Avoid overfull hboxes wherever possible.

37801:6c6c8f8b2d4c

\input texinfo   @c -*-texinfo-*-
@c $Id: mh-e.texi,v 1.8 2001/02/19 19:13:47 wohler Exp $
@c %**start of header
@setfilename ../info/mh-e
@settitle mh-e
@c %**end of header

-----Emacs: *scratch*         (Lisp Interaction)--All---------------------
To: wohler
cc:
Subject: Test
--------
  This is a test message to get the wheels churning...#


--**-@{draft@}      (MH-Letter)--All----------------------------------------

@end cartouche
@i{mh-e message composition window}
@end group
@end example

@key{RET} to read your message.  You should see something like:

@example
@group
@cartouche
   3  24Aug  root       received fax files on Wed Aug 24 11:00:13 PDT 1994
#  4+ 24Aug  To:wohler  Test<<This is a test message to get the wheels chu

--%%-@{+inbox@} 4 msgs (1-4)      (MH-Folder Show)--Bot---------------------
To: wohler
Subject: Test
Date: Wed, 24 Aug 1994 13:01:13 -0700
From: Bill Wohler <wohler@@newt.com>

-----@{show-+inbox@} 4      (MH-Show)--Bot----------------------------------

@end cartouche
@i{After incorporating new messages}
@end group
@end example

In-reply-to: Bill Wohler's message of Wed, 24 Aug 1994 13:01:13 -0700
             <199408242001.NAA00505@@newt.com>
--------
#

--**-@{draft@}      (MH-Letter)--All----------------------------------------
To: wohler
Subject: Test
Date: Wed, 24 Aug 1994 13:01:13 -0700
From: Bill Wohler <wohler@@newt.com>

  This is a test message to get the wheels churning...

-----@{show-+inbox@} 4      (MH-Show)--Bot----------------------------------
Composing a reply...done
@end cartouche
@i{Composition window during reply}
@end group
@end example

--**-Emacs: pick-pattern    (MH-Pick)------All----------------------------

@end cartouche
@i{Pick window}
@end group
@end example

which will display the folder name and the message number, respectively,
somewhere in the string in that order.  The default value of
@samp{"@{show-%s@} %d"} yields a mode line of

@example
-----@{show-+inbox@} 4      (MH-Show)--Bot----------------------------------
@end example

@node Customizing Moving Around,  , Customizing Viewing, Customizing Reading
@subsection Moving Around

@item mh-redist-full-contents
@code{send} requires entire message (default: @code{nil}).

@item mh-new-draft-cleaned-headers
Remove these header fields from re-edited draft (default:
@samp{"^Date:\\| ^Received:\\| ^Message-Id:\\| ^From:\\| ^Sender:\\|
^Delivery-Date:\\| ^Return-Path:"}).
@end table

@cindex @code{comp}
@cindex MH commands, @code{comp}
@vindex @code{mh-comp-formfile}

Emacs macros can be used to insert enriched text directives like
@samp{<bold>}.  The following code will make, for example, @kbd{C-c t
b} insert the @samp{<bold>} directive.

@lisp
@group
@i{Emacs macros for entering enriched text}

(defvar enriched-text-types '(("b" . "bold") ("i" . "italic") ("f" . "fixed")
                              ("s" . "smaller") ("B" . "bigger")
                              ("u" . "underline") ("c" . "center"))
  "Alist of (final-character . directive) choices for add-enriched-text.
Additional types can be found in RFC 1563.")

(defun add-enriched-text (begin end)
  "Add enriched text directives around region.

      (goto-char (point-min))      ; @r{move to beginning of text}
      (insert "<" type ">")        ; @r{insert beginning directive}
      (goto-char (point-max))      ; @r{move to end of text}
      (insert "</" type ">"))))    ; @r{insert terminating directive}
@end group
@end lisp

To use the function @code{add-enriched-text}, first create keybindings
for it (@pxref{Customizing Sending}).  Then, set the mark with
@kbd{C-@@} or @kbd{C-SPC}, type in the text to be highlighted, and type
@kbd{C-c t b}.  This adds @samp{<bold>} where you set the mark and

@end iftex

@vindex @code{mh-default-folder-for-message-function}, example
@vindex @code{mh-user-path}, example

@lisp
@group
@i{Creating useful default folder for refiling via mh-default-folder-for-message-function}

(defun my-mh-folder-from-address ()
  "Determine folder name from address.
Takes the address in the From: header field, and returns its corresponding
alias from the user's personal aliases file. Returns @code{nil} if the address
was not found."
  (require 'rfc822)                         ; @r{for the rfc822 functions}
  (search-forward-regexp "^From: \\(.*\\)") ; @r{grab header field contents}
  (save-excursion                     ; @r{save state}
    (let ((addr (car (rfc822-addresses  ; @r{get address}
                      (buffer-substring (match-beginning 1)

                                                    mh-user-path))
            (goto-char (point-min))   ; @r{grab aliases file and go to start}
            (setq folder
                  ;; @r{Search for the given address, even commented-out}
                  ;; @r{addresses are found!}
                  ;; @r{The function search-forward-regexp sets values that are}
                  ;; @r{later used by match-beginning and match-end.}
                  (if (search-forward-regexp (format "^;*\\(.*\\):.*%s"
                                                     addr) nil t)
                      ;; @r{NOTE WELL: this is what the return value looks like.}
                      ;; @r{You can modify the format string to match your own}
                      ;; @r{Mail hierarchy.}
                      (format "+%s" (buffer-substring (match-beginning 1)
                                                      (match-end 1))))))
        (kill-buffer buffer))          ; @r{get rid of our temporary buffer}
      folder)))                        ; @r{function's return value}

(setq mh-default-folder-for-message-function 'my-mh-folder-from-address)
@end group
@end lisp

@vindex @code{mh-refile-msg-hook}

The hook @code{mh-refile-msg-hook} is called after a message is marked
to be refiled.

The version of mh-e in the current version of Emacs should be up to
date. It is most likely to be more up to date than the copy that comes
with the MH distribution in @file{miscellany/mh-e}.

New mh-e releases will appear at
@uref{https://sourceforge.net/project/showfiles.php?group_id=13357,
SourceForge} before they appear in an Emacs release. You can read the
release notes on that page to determine if the given release of mh-e
is already installed in your version of Emacs.

If you go this route, I suggest that you extract the files from
@file{mh-e-@var{m.n}.tgz} in the following fashion:

@example
@group
% @kbd{cd}                                  # @r{Start in your home directory}
% @kbd{mkdir lib lib/emacs}                 # @r{Create directory for mh-e}
% @kbd{cd lib/emacs}
% @kbd{zcat @var{path/to/}mh-e-@var{m.n}.tgz | tar xvf -}    # @r{Extract files}
@end group
@end example

@cindex @file{.emacs}
@cindex files, @file{.emacs}

To use these new files, add the following to @file{~/.emacs}:

37802:953a442c9130

\input texinfo   @c -*-texinfo-*-
@c $Id: mh-e.texi,v 1.9 2001/02/23 12:31:08 gerd Exp $
@c %**start of header
@setfilename ../info/mh-e
@settitle mh-e
@c %**end of header

-----Emacs: *scratch*         (Lisp Interaction)--All-------------------
To: wohler
cc:
Subject: Test
--------
  This is a test message to get the wheels churning...#


--**-@{draft@}      (MH-Letter)--All-------------------------------------

@end cartouche
@i{mh-e message composition window}
@end group
@end example

@key{RET} to read your message.  You should see something like:

@example
@group
@cartouche
  3  24Aug root      received fax files on Wed Aug 24 11:00:13 PDT 1994
# 4+ 24Aug To:wohler Test<<This is a test message to get the wheels chu

--%%-@{+inbox@} 4 msgs (1-4)      (MH-Folder Show)--Bot------------------
To: wohler
Subject: Test
Date: Wed, 24 Aug 1994 13:01:13 -0700
From: Bill Wohler <wohler@@newt.com>

-----@{show-+inbox@} 4      (MH-Show)--Bot-------------------------------

@end cartouche
@i{After incorporating new messages}
@end group
@end example

In-reply-to: Bill Wohler's message of Wed, 24 Aug 1994 13:01:13 -0700
             <199408242001.NAA00505@@newt.com>
--------
#

--**-@{draft@}      (MH-Letter)--All-------------------------------------
To: wohler
Subject: Test
Date: Wed, 24 Aug 1994 13:01:13 -0700
From: Bill Wohler <wohler@@newt.com>

  This is a test message to get the wheels churning...

-----@{show-+inbox@} 4      (MH-Show)--Bot-------------------------------
Composing a reply...done
@end cartouche
@i{Composition window during reply}
@end group
@end example

--**-Emacs: pick-pattern    (MH-Pick)------All--------------------------

@end cartouche
@i{Pick window}
@end group
@end example

which will display the folder name and the message number, respectively,
somewhere in the string in that order.  The default value of
@samp{"@{show-%s@} %d"} yields a mode line of

@example
-----@{show-+inbox@} 4      (MH-Show)--Bot--------------------------------
@end example

@node Customizing Moving Around,  , Customizing Viewing, Customizing Reading
@subsection Moving Around

@item mh-redist-full-contents
@code{send} requires entire message (default: @code{nil}).

@item mh-new-draft-cleaned-headers
Remove these header fields from re-edited draft.  The default is:
@example
"^Date:\\| ^Received:\\| ^Message-Id:\\| ^From:\\|
^Sender:\\| ^Delivery-Date:\\| ^Return-Path:".
@end example
@end table

@cindex @code{comp}
@cindex MH commands, @code{comp}
@vindex @code{mh-comp-formfile}

Emacs macros can be used to insert enriched text directives like
@samp{<bold>}.  The following code will make, for example, @kbd{C-c t
b} insert the @samp{<bold>} directive.

@smallexample
@group
@i{Emacs macros for entering enriched text}

(defvar enriched-text-types '(("b" . "bold") ("i" . "italic")
                              ("f" . "fixed") ("s" . "smaller")
                              ("B" . "bigger") ("u" . "underline")
                              ("c" . "center"))
  "Alist of (final-character . directive) choices for add-enriched-text.
Additional types can be found in RFC 1563.")

(defun add-enriched-text (begin end)
  "Add enriched text directives around region.

      (goto-char (point-min))      ; @r{move to beginning of text}
      (insert "<" type ">")        ; @r{insert beginning directive}
      (goto-char (point-max))      ; @r{move to end of text}
      (insert "</" type ">"))))    ; @r{insert terminating directive}
@end group
@end smallexample

To use the function @code{add-enriched-text}, first create keybindings
for it (@pxref{Customizing Sending}).  Then, set the mark with
@kbd{C-@@} or @kbd{C-SPC}, type in the text to be highlighted, and type
@kbd{C-c t b}.  This adds @samp{<bold>} where you set the mark and

@end iftex

@vindex @code{mh-default-folder-for-message-function}, example
@vindex @code{mh-user-path}, example

@smallexample
@group
@i{Creating useful default folder for refiling via mh-default-folder-for-message-function}

(defun my-mh-folder-from-address ()
  "Determine folder name from address.
Takes the address in the From: header field, and returns its
corresponding alias from the user's personal aliases file. Returns
@code{nil} if the address was not found."
  (require 'rfc822)                         ; @r{for the rfc822 functions}
  (search-forward-regexp "^From: \\(.*\\)") ; @r{grab header field contents}
  (save-excursion                     ; @r{save state}
    (let ((addr (car (rfc822-addresses  ; @r{get address}
                      (buffer-substring (match-beginning 1)

                                                    mh-user-path))
            (goto-char (point-min))   ; @r{grab aliases file and go to start}
            (setq folder
                  ;; @r{Search for the given address, even commented-out}
                  ;; @r{addresses are found!}
                  ;; @r{The function search-forward-regexp sets values that}
                  ;; @r{are later used by match-beginning and match-end.}
                  (if (search-forward-regexp (format "^;*\\(.*\\):.*%s"
                                                     addr) nil t)
                      ;; @r{NOTE WELL: this is what the return value looks}
                      ;; @r{like. You can modify the format string to match}
                      ;; @r{your own Mail hierarchy.}
                      (format "+%s" (buffer-substring
                                      (match-beginning 1)
                                      (match-end 1))))))
        (kill-buffer buffer))          ; @r{get rid of our temporary buffer}
      folder)))                        ; @r{function's return value}

(setq mh-default-folder-for-message-function 'my-mh-folder-from-address)
@end group
@end smallexample

@vindex @code{mh-refile-msg-hook}

The hook @code{mh-refile-msg-hook} is called after a message is marked
to be refiled.

The version of mh-e in the current version of Emacs should be up to
date. It is most likely to be more up to date than the copy that comes
with the MH distribution in @file{miscellany/mh-e}.

@c intentionally wordy to avoid overfull hbox
New mh-e releases are almost available for downloading at
@uref{https://sourceforge.net/project/showfiles.php?group_id=13357,
SourceForge} before they appear in an Emacs release. You can read the
release notes on that page to determine if the given release of mh-e
is already installed in your version of Emacs.

If you go this route, I suggest that you extract the files from
@file{mh-e-@var{m.n}.tgz} in the following fashion:

@smallexample
@group
% @kbd{cd}                                  # @r{Start in your home directory}
% @kbd{mkdir lib lib/emacs}                 # @r{Create directory for mh-e}
% @kbd{cd lib/emacs}
% @kbd{zcat @var{path/to/}mh-e-@var{m.n}.tgz | tar xvf -}    # @r{Extract files}
@end group
@end smallexample

@cindex @file{.emacs}
@cindex files, @file{.emacs}

To use these new files, add the following to @file{~/.emacs}: