home *** CD-ROM | disk | FTP | other *** search
/ Dream 49 / Amiga_Dream_49.iso / beos / emacs / emacs-19.34-bin / emacs-19 / info / mh-e-2 (.txt) < prev    next >
GNU Info File  |  1997-09-17  |  47KB  |  873 lines
  1. This is Info file ../info/mh-e, produced by Makeinfo-1.63 from the
  2. input file mh-e.texi.
  3.    This is Edition 1.2, last updated 22 August 1995, of `mh-e, The
  4. Emacs Interface to MH', for mh-e, Version 5.0.2.
  5.    Copyright 1995 Free Software Foundation, Inc.
  6.    Permission is granted to make and distribute verbatim copies of this
  7. manual provided the copyright notice and this permission notice are
  8. preserved on all copies.
  9.    Permission is granted to copy and distribute modified versions of
  10. this manual under the conditions for verbatim copying, provided also
  11. that the section entitled "Copying" is included exactly as in the
  12. original, and provided that the entire resulting derived work is
  13. distributed under the terms of a permission notice identical to this
  14.    Permission is granted to copy and distribute translations of this
  15. manual into another language, under the above conditions for modified
  16. versions, except that this permission notice may be stated in a
  17. translation approved by the Free Software Foundation.
  18. File: mh-e,  Node: Organizing,  Next: Printing,  Prev: Deleting,  Up: Moving Mail
  19. Organizing Your Mail with Folders
  20. ---------------------------------
  21.    mh-e has analogies for each of the MH `folder' and `refile'
  22. commands.  To refile a message in another folder, use the `o'
  23. (`mh-refile-msg') (mnemonic: "output") command.  You are prompted for
  24. the folder name.
  25.    If you are refiling several messages into the same folder, you can
  26. use the `!' (`mh-refile-or-write-again') command to repeat the last
  27. refile or write (see the description of `C-o' in *Note Files and
  28. Pipes::).  Or, place the messages into a sequence (*Note Sequences::)
  29. and specify a prefix argument to `o', in which case you'll be prompted
  30. for the name of the sequence (for example, `C-u o search RET').
  31.    If you wish to copy a message to another folder, you can use the `c'
  32. (`mh-copy-msg') command (see the `-link' argument to `refile'(1)).  You
  33. are prompted for a folder, and you can specify a prefix argument if you
  34. want to copy a sequence into another folder.  In this case, you are
  35. then prompted for the sequence.  Note that unlike the `o' command, the
  36. copy takes place immediately.  The original copy remains in the current
  37. folder.
  38.    When you want to read the messages that you have refiled into
  39. folders, use the `M-f' (`mh-visit-folder') command to visit the folder.
  40. You are prompted for the folder name.
  41.    Other commands you can perform on folders include: `M-l'
  42. (`mh-list-folders'), to list all the folders in your mail directory;
  43. `M-k' (`mh-kill-folder'), to remove a folder; `M-x mh-sort-folder', to
  44. sort the messages by date (see `sortm'(1) to see how to sort by other
  45. criteria); `M-p' (`mh-pack-folder'), to pack a folder, removing gaps
  46. from the numbering sequence; and `M-r' (`mh-rescan-folder'), to rescan
  47. the folder, which is useful to grab all messages in your `+inbox' after
  48. processing your new mail for the first time.  If you don't want to
  49. rescan the entire folder, give `M-r' or `M-p' a prefix argument and
  50. you'll be prompted for a range of messages to display (for instance,
  51. `C-u M-r last:50 RET').
  52. File: mh-e,  Node: Printing,  Next: Files and Pipes,  Prev: Organizing,  Up: Moving Mail
  53. Printing Your Mail
  54. ------------------
  55.    Printing mail is simple.  Enter `l' (`mh-print-msg') (for line
  56. printer or lpr).  The message is formatted with `mhl' and printed with
  57. the `lpr' command.  You can print all the messages in a sequence by
  58. specifying a prefix argument, in which case you are prompted for the
  59. name of the sequence (as in `C-u l frombob RET').
  60. File: mh-e,  Node: Files and Pipes,  Next: Finishing Up,  Prev: Printing,  Up: Moving Mail
  61. Files and Pipes
  62. ---------------
  63.    mh-e does offer a couple of commands that are not a part of MH.  The
  64. first one, `C-o' (`mh-write-msg-to-file'), writes a message to a file
  65. (think of the `o' as in "output").  You are prompted for the filename.
  66. If the file already exists, the message is appended to it.  You can
  67. also write the message to the file without the header by specifying a
  68. prefix argument (such as `C-u C-o /tmp/foobar RET').  Subsequent writes
  69. to the same file can be made with the `!' command.
  70.    You can also pipe the message through a Unix shell command with the
  71. `|' (`mh-pipe-msg') command.  You are prompted for the Unix command
  72. through which you wish to run your message.  If you give an argument to
  73. this command, the message header is included in the text passed to the
  74. command (the contrived example `C-u | lpr' would be done with the `l'
  75. command instead).
  76.    If the message is a shell archive `shar' or has been run through
  77. `uuencode' use `M-n' (`mh-store-msg') to extract the body of the
  78. message.  The default directory for extraction is the current
  79. directory, and you have a chance to specify a different extraction
  80. directory.  The next time you use this command, the default directory is
  81. the last directory you used.
  82. File: mh-e,  Node: Finishing Up,  Prev: Files and Pipes,  Up: Moving Mail
  83. Finishing Up
  84. ------------
  85.    If you've deleted a message or refiled it, but changed your mind, you
  86. can cancel the action before you've executed it.  Use `u' (`mh-undo')
  87. to undo a refile on or deletion of a single message.  You can also undo
  88. refiles and deletes for messages that belong to a given sequence by
  89. specifying a prefix argument.  You'll be prompted for the name of the
  90. sequence (as in `C-u u frombob RET').  Alternatively, you can use `M-u'
  91. (`mh-undo-folder') to undo all refiles or deletes in the current folder.
  92.    If you've marked messages to be deleted or refiled and you want to go
  93. ahead and delete or refile the messages, use `x'
  94. (`mh-execute-commands').  Many mh-e commands that may affect the
  95. numbering of the messages (such as `M-r' or `M-p') will ask if you want
  96. to process refiles or deletes first and then either run `x' for you or
  97. undo the pending refiles and deletes, which are lost.
  98.    When you want to quit using mh-e and go back to editing, you can use
  99. the `q' (`mh-quit') command.  This buries the buffers of the current
  100. mh-e folder and restores the buffers that were present when you first
  101. ran `M-x mh-rmail'.  You can later restore your mh-e session by
  102. selecting the `+inbox' buffer or by running `M-x mh-rmail' again.
  103. File: mh-e,  Node: Searching,  Next: Sequences,  Prev: Moving Mail,  Up: Using mh-e
  104. Searching Through Messages
  105. ==========================
  106.    You can search a folder for messages to or from a particular person
  107. or about a particular subject.  In fact, you can also search for
  108. messages containing selected strings in any arbitrary header field or
  109. any string found within the messages.  Use the `M-s'
  110. (`mh-search-folder') command.  You are first prompted for the name of
  111. the folder to search and then placed in the following buffer in MH-Pick
  112. mode:
  113.      From: #
  114.      To:
  115.      Cc:
  116.      Date:
  117.      Subject:
  118.      --------
  119.      
  120.      
  121.      
  122.      
  123.      
  124.      
  125.      
  126.      
  127.      
  128.      --**-Emacs: pick-pattern    (MH-Pick)------All----------------------------
  129.      Pick window
  130.    Edit this template by entering your search criteria in an appropriate
  131. header field that is already there, or create a new field yourself.  If
  132. the string you're looking for could be anywhere in a message, then place
  133. the string underneath the row of dashes.  The `M-s' command uses the MH
  134. command `pick' to do the real work, so read `pick'(1) to find out more
  135. about how to enter the criteria.
  136.    There are no semantics associated with the search criteria--they are
  137. simply treated as strings.  Case is ignored when all lowercase is used,
  138. and regular expressions (a la `ed') are available.  It is all right to
  139. specify several search criteria.  What happens then is that a logical
  140. *and* of the various fields is performed.  If you prefer a logical *or*
  141. operation, run `M-s' multiple times.
  142.    As an example, let's say that we want to find messages from Ginnean
  143. about horseback riding in the Kosciusko National Park (Australia) during
  144. January, 1994.  Normally we would start with a broad search and narrow
  145. it down if necessary to produce a manageable amount of data, but we'll
  146. cut to the chase and create a fairly restrictive set of criteria as
  147. follows:
  148.      From: ginnean
  149.      To:
  150.      Cc:
  151.      Date: Jan 1994
  152.      Subject: horse.*kosciusko
  153.      --------
  154.    As with MH-Letter mode, MH-Pick provides commands like `C-c C-f C-t'
  155. to help you fill in the blanks.
  156. `C-c C-f C-t'
  157.      Move to `To:' header field (`mh-to-field').
  158. `C-c C-f C-c'
  159.      Move to `cc:' header field (`mh-to-field').
  160. `C-c C-f C-s'
  161.      Move to `Subject:' header field (`mh-to-field').
  162. `C-c C-f C-f'
  163.      Move to `From:' header field (`mh-to-field').
  164. `C-c C-f C-b'
  165.      Move to `Bcc:' header field (`mh-to-field').
  166. `C-c C-f C-f'
  167.      Move to `Fcc:' header field (`mh-to-field').
  168. `C-c C-f C-d'
  169.      Move to `Dcc:' header field (`mh-to-field').
  170. `C-c C-c'
  171.      Execute the search (`mh-do-pick-search').
  172.    To perform the search, type `C-c C-c' (`mh-do-pick-search').  The
  173. selected messages are placed in the search sequence, which you can use
  174. later in forwarding (*note Forwarding::.), printing (*note
  175. Printing::.), or narrowing your field of view (*note Sequences::.).
  176. Subsequent searches are appended to the search sequence.  If, however,
  177. you wish to start with a clean slate, first delete the search sequence
  178. (how to do this is discussed in *Note Sequences::).
  179.    If you're searching in a folder that is already displayed in a
  180. MH-Folder buffer, only those messages contained in the buffer are used
  181. for the search.  Therefore, if you want to search in all messages,
  182. first kill the folder's buffer with `C-x k' or scan the entire folder
  183. with `M-r'.
  184. File: mh-e,  Node: Sequences,  Next: Miscellaneous,  Prev: Searching,  Up: Using mh-e
  185. Using Sequences
  186. ===============
  187.    For the whole scoop on MH sequences, refer to `mh-sequence'(5).  As
  188. you've read, several of the mh-e commands can operate on a sequence,
  189. which is a shorthand for a range or group of messages.  For example, you
  190. might want to forward several messages to a friend or colleague.  Here's
  191. how to manipulate sequences.
  192.      Put message in a sequence (`mh-put-msg-in-seq').
  193.      Display sequences that message belongs to (`mh-msg-is-in-seq').
  194. `M-q'
  195.      List all sequences in folder (`mh-list-sequences').
  196. `M-%'
  197.      Remove message from sequence (`mh-delete-msg-from-seq').
  198. `M-#'
  199.      Delete sequence (`mh-delete-seq').
  200. `C-x n'
  201.      Restrict display to messages in sequence (`mh-narrow-to-seq').
  202. `C-x w'
  203.      Remove restriction; display all messages (`mh-widen').
  204. `M-x mh-update-sequences'
  205.      Push mh-e's state out to MH.
  206.    To place a message in a sequence, use `%' (`mh-put-msg-in-seq') to
  207. do it manually, or use the MH command `pick' or the mh-e version of
  208. `pick' (*Note Searching::) which create a sequence automatically.  Give
  209. `%' a prefix argument and you can add all the messages in one sequence
  210. to another sequence (for example, `C-u % SourceSequence RET').
  211.    Once you've placed some messages in a sequence, you may wish to
  212. narrow the field of view to just those messages in the sequence you've
  213. created.  To do this, use `C-x n' (`mh-narrow-to-seq').  You are
  214. prompted for the name of the sequence.  What this does is show only
  215. those messages that are in the selected sequence in the MH-Folder
  216. buffer.  In addition, it limits further mh-e searches to just those
  217. messages.  When you want to widen the view to all your messages again,
  218. use `C-x w' (`mh-widen').
  219.    You can see which sequences a message is in with the `?'
  220. (`mh-msg-is-in-seq') command.  Or, you can list all sequences in a
  221. selected folder (default is current folder) with `M-q'
  222. (`mh-list-sequences').
  223.    If you want to remove a message from a sequence, use `M-%'
  224. (`mh-delete-msg-from-seq'), and if you want to delete an entire
  225. sequence, use `M-#' (`mh-delete-seq').  In the latter case you are
  226. prompted for the sequence to delete.  Note that this deletes only the
  227. sequence, not the messages in the sequence.  If you want to delete the
  228. messages, use `C-u d' (see *Note Deleting:: above).
  229.    Two sequences are maintained internally by mh-e and pushed out to MH
  230. when you type either the `x' or `q' command.  They are the sequence
  231. specified by your `Unseen-Sequence:' profile entry and cur.  However,
  232. you can also just update MH's state with the command `M-x
  233. mh-update-sequences'.  See *Note Customizing Viewing:: for an example
  234. of how this command might be used.
  235.    With the exceptions of `C-x n' and `C-x w', the underlying MH
  236. command dealing with sequences is `mark'.
  237. File: mh-e,  Node: Miscellaneous,  Prev: Sequences,  Up: Using mh-e
  238. Miscellaneous Commands
  239. ======================
  240.    One other command worth noting is `M-x mh-version'.  Since there
  241. were a few changes in command letters between Versions 3 and 4, use
  242. this command to see which version you are running.  This command didn't
  243. exist before Version 4, so the message `[No match]' indicates that it's
  244. time to upgrade (*note Getting mh-e::.).  In the meantime, use the
  245. older commands that are listed in *Note Changes to mh-e::.  The output
  246. of `M-x mh-version' should also be included with any bug report you
  247. send (*note Bug Reports::.).
  248. File: mh-e,  Node: Customizing mh-e,  Next: Odds and Ends,  Prev: Using mh-e,  Up: Top
  249. Customizing mh-e
  250. ****************
  251.    Until now, we've talked about the mh-e commands as they work "out of
  252. the box."  Of course, it is also possible to reconfigure mh-e beyond
  253. recognition.  The following sections describe all of the customization
  254. variables, show the defaults, and make recommendations for
  255. customization.  The outline of this chapter is identical to that of
  256. *Note Using mh-e::, to make it easier to find the variables you'd need
  257. to modify to affect a particular command.
  258.    However, when customizing your mail environment, first try to change
  259. what you want in MH, and only change mh-e if changing MH is not
  260. possible.  That way you will get the same behavior inside and outside
  261. GNU Emacs.  Note that mh-e does not provide hooks for customizations
  262. that can be done in MH; this omission is intentional.
  263.    Many string or integer variables are easy enough to modify using
  264. Emacs Lisp.  Any such modifications should be placed in a file called
  265. `.emacs' in your home directory (that is, `~/.emacs').  For example, to
  266. modify the variable that controls printing, you could add:
  267.      (setq mh-lpr-command-format "nenscript -G -r -2 -i'%s'")
  268.    *Note Customizing Printing:: talks more about this variable.
  269.    Variables can also hold Boolean values.  In Emacs Lisp, the Boolean
  270. values are `nil', which means false, and `t', which means true.
  271. Usually, variables are turned off by setting their value to `nil', as in
  272.      (setq mh-bury-show-buffer nil)
  273.    which keeps the MH-Show buffer at the top of the buffer stack.  To
  274. turn a variable on, you use
  275.      (setq mh-bury-show-buffer t)
  276.    which places the MH-Show buffer at the bottom of the buffer stack.
  277. However, the text says to turn on a variable by setting it to a
  278. *non-`nil'* value, because sometimes values other than `t' are
  279. meaningful (for example, see `mhl-formfile', described in *Note
  280. Customizing Viewing::).  Other variables, such as hooks, involve a
  281. little more Emacs Lisp programming expertise.
  282.    You can also "preview" the effects of changing variables before
  283. committing the changes to `~/.emacs'.  Variables can be changed in the
  284. current Emacs session by using `M-x set-variable'.
  285.    In general, "commands" in this text refer to Emacs Lisp functions.
  286. Programs outside of Emacs are specifically called MH commands, shell
  287. commands, or Unix commands.
  288.    I hope I've included enough examples here to get you well on your
  289. way.  If you want to explore Emacs Lisp further, a programming manual
  290. does exist, (1) and you can look at the code itself for examples.  Look
  291. in the Emacs Lisp directory on your system (such as
  292. `/usr/local/lib/emacs/lisp') and find all the `mh-*.el' files there.
  293. When calling mh-e and other Emacs Lisp functions directly from Emacs
  294. Lisp code, you'll need to know the correct arguments.  Use the online
  295. help for this.  For example, try `C-h f mh-execute-commands RET'.  If
  296. you write your own functions, please do not prefix your symbols
  297. (variables and functions) with `mh-'.  This prefix is reserved for the
  298. mh-e package.  To avoid conflicts with existing mh-e symbols, use a
  299. prefix like `my-' or your initials.
  300. * Menu:
  301. * Customizing Reading::
  302. * Customizing Sending::
  303. * Customizing Draft Editing::
  304. * Customizing Moving Mail::
  305. * Customizing Searching::
  306.    ---------- Footnotes ----------
  307.    (1)  Perhaps you can find the online version of *Note The GNU Emacs
  308. Lisp Reference Manual: (elisp)Top.  If not, you can order a printed
  309. manual, which has the desirable side-effect of helping to support the
  310. Free Software Foundation which made all this great software available.
  311. You can find an order form by running `C-h C-d', or you can request an
  312. order form from gnu@prep.ai.mit.edu.
  313. File: mh-e,  Node: Customizing Reading,  Next: Customizing Sending,  Prev: Customizing mh-e,  Up: Customizing mh-e
  314. Reading Your Mail
  315. =================
  316.    I'll start out by including a function that I use as a front end to
  317. mh-e.  (1) It toggles between your working window configuration, which
  318. may be quite involved--windows filled with source, compilation output,
  319. man pages, and other documentation--and your mh-e window configuration.
  320. Like the rest of the customization described in this chapter, simply
  321. add the following code to `~/.emacs'.  Don't be intimidated by the size
  322. of this example; most customizations are only one line.
  323.      Starting mh-e
  324.      
  325.      (defvar my-mh-screen-saved nil
  326.        "Set to non-`nil' when mh-e window configuration shown.")
  327.      (defvar my-normal-screen nil "Normal window configuration.")
  328.      (defvar my-mh-screen nil "mh-e window configuration.")
  329.      
  330.      (defun my-mh-rmail (&optional arg)
  331.        "Toggle between mh-e and normal screen configurations.
  332.      With non-`nil' or prefix argument, inc mailbox as well
  333.      when going into mail."
  334.        (interactive "P")                 ; user callable function, P=prefix arg
  335.        (setq my-mh-screen-saved          ; save state
  336.              (cond
  337.               ;; Bring up mh-e screen if arg or normal window configuration.
  338.               ;; If arg or +inbox buffer doesn't exist, run mh-rmail.
  339.               ((or arg (null my-mh-screen-saved))
  340.                (setq my-normal-screen (current-window-configuration))
  341.                (if (or arg (null (get-buffer "+inbox")))
  342.                    (mh-rmail)
  343.                  (set-window-configuration my-mh-screen))
  344.                t)                        ; set my-mh-screen-saved to `t'
  345.               ;; Otherwise, save mh-e screen and restore normal screen.
  346.               (t
  347.                (setq my-mh-screen (current-window-configuration))
  348.                (set-window-configuration my-normal-screen)
  349.                nil))))                   ; set my-mh-screen-saved to nil
  350.      
  351.      (global-set-key "\C-x\r" 'my-mh-rmail)  ; call with C-x RET
  352.    If you type an argument (`C-u') or if `my-mh-screen-saved' is `nil'
  353. (meaning a non-mh-e window configuration), the current window
  354. configuration is saved, either +inbox is displayed or `mh-rmail' is
  355. run, and the mh-e window configuration is shown.  Otherwise, the mh-e
  356. window configuration is saved and the original configuration is
  357. displayed.
  358.    Now to configure mh-e.  The following table lists general mh-e
  359. variables and variables that are used while reading mail.
  360. `mh-progs'
  361.      Directory containing MH programs (default: dynamic).
  362. `mh-lib'
  363.      Directory containing MH support files and programs (default:
  364.      dynamic).
  365. `mh-do-not-confirm'
  366.      Don't confirm on non-reversible commands (default: `nil').
  367. `mh-summary-height'
  368.      Number of scan lines to show (includes mode line) (default: 4).
  369. `mh-folder-mode-hook'
  370.      Functions to run in MH-Folder mode (default: `nil').
  371. `mh-clean-message-header'
  372.      Remove extraneous headers (default: `nil').
  373. `mh-invisible-headers'
  374.      Headers to hide (default: `"^Received: \\| ^Message-Id: \\|
  375.      ^Remailed-\\| ^Via: \\| ^Mail-from: \\| ^Return-Path: \\|
  376.      ^In-Reply-To: \\| ^Resent-"').
  377. `mh-visible-headers'
  378.      Headers to display (default: `nil').
  379. `mhl-formfile'
  380.      Format file for `mhl' (default: `nil').
  381. `mh-show-hook'
  382.      Functions to run when showing message (default: `nil').
  383. `mh-show-mode-hook'
  384.      Functions to run when showing message (default: `nil').
  385. `mh-bury-show-buffer'
  386.      Leave show buffer at bottom of stack (default: `t').
  387. `mh-show-buffer-mode-line-buffer-id'
  388.      Name of show buffer in mode line (default: `"{show-%s} %d"').
  389.    The two variables `mh-progs' and `mh-lib' are used to tell mh-e
  390. where the MH programs and supporting files are kept, respectively.
  391. mh-e does try to figure out where they are kept for itself by looking in
  392. common places and in the user's `PATH' environment variable, but if it
  393. cannot find the directories, or finds the wrong ones, you should set
  394. these variables.  The name of the directory should be placed in double
  395. quotes, and there should be a trailing slash (`/').  See the example in
  396. *Note Getting Started::.
  397.    If you never make mistakes, and you do not like confirmations for
  398. your actions, you can set `mh-do-not-confirm' to a non-`nil' value to
  399. disable confirmation for unrecoverable commands such as `M-k'
  400. (`mh-kill-folder') and `M-u' (`mh-undo-folder').  Here's how you set
  401. boolean values:
  402.      (setq mh-do-not-confirm t)
  403.    The variable `mh-summary-height' controls the number of scan lines
  404. displayed in the MH-Folder window, including the mode line.  The
  405. default value of 4 means that 3 scan lines are displayed.  Here's how
  406. you set numerical values:
  407.      (setq mh-summary-height 2)              ; only show the current scan line
  408.    Normally the buffer for displaying messages is buried at the bottom
  409. at the buffer stack.  You may wish to disable this feature by setting
  410. `mh-bury-show-buffer' to `nil'.  One advantage of not burying the show
  411. buffer is that one can delete the show buffer more easily in an
  412. electric buffer list because of its proximity to its associated
  413. MH-Folder buffer.  Try running `M-x electric-buffer-list' to see what I
  414. mean.
  415.    The hook `mh-folder-mode-hook' is called when a new folder is
  416. created with MH-Folder mode.  This could be used to set your own key
  417. bindings, for example:
  418.      Create additional key bindings via mh-folder-mode-hook
  419.      
  420.      (defvar my-mh-init-done nil "Non-`nil' when one-time mh-e settings made.")
  421.      
  422.      (defun my-mh-folder-mode-hook ()
  423.        "Hook to set key bindings in MH-Folder mode."
  424.        (if (not my-mh-init-done)             ; only need to bind the keys once 
  425.            (progn
  426.              (local-set-key "/" 'search-msg)
  427.              (local-set-key "b" 'mh-burst-digest)    ; better use of `b'
  428.              (setq my-mh-init-done t))))
  429.      
  430.      ;;; Emacs 19
  431.      (add-hook 'mh-folder-mode-hook 'my-mh-folder-mode-hook)
  432.      ;;; Emacs 18
  433.      ;;;   (setq mh-folder-mode-hook (cons 'my-mh-folder-mode-hook
  434.      ;;;                               mh-folder-mode-hook))
  435.      
  436.      (defun search-msg ()
  437.        "Search for a regexp in the current message."
  438.        (interactive)                         ; user function
  439.        (save-window-excursion
  440.          (other-window 1)                    ; go to next window
  441.          (isearch-forward-regexp)))          ; string search; hit return (ESC
  442.                                              ;   in Emacs 18) when done
  443. * Menu:
  444. * Customizing Viewing::
  445. * Customizing Moving Around::
  446.    ---------- Footnotes ----------
  447.    (1)  Stephen Gildea's favorite binding is `(global-set-key "\C-cr"
  448. 'mh-rmail)'.
  449. File: mh-e,  Node: Customizing Viewing,  Next: Customizing Moving Around,  Prev: Customizing Reading,  Up: Customizing Reading
  450. Viewing Your Mail
  451. -----------------
  452.    Several variables control what displayed messages look like.
  453. Normally messages are delivered with a handful of uninteresting header
  454. fields.  You can make them go away by setting `mh-clean-message-header'
  455. to a non-`nil' value.  The header can then be cleaned up in two ways.
  456. By default, the header fields in `mh-invisible-headers' are removed.
  457. On the other hand, you could set `mh-visible-headers' to the fields
  458. that you would like to see.  If this variable is set,
  459. `mh-invisible-headers' is ignored.  I suggest that you not set
  460. `mh-visible-headers' since if you use this variable, you might miss a
  461. lot of header fields that you'd rather not miss.  As an example of how
  462. to set a string variable, `mh-visible-headers' can be set to show a
  463. minimum set of header fields (see (*Note Syntax of Regular Expressions:
  464. (emacs)Regexps, for a description of the special characters in this
  465. string):
  466.      (setq mh-visible-headers "^From: \\|^Subject: \\|^Date: ")
  467.    Normally mh-e takes care of displaying messages itself (rather than
  468. calling an MH program to do the work).  If you'd rather have `mhl'
  469. display the message (within mh-e), set the variable `mhl-formfile' to a
  470. non-`nil' value.  You can set this variable either to `t' to use the
  471. default format file or to a filename if you have your own format file
  472. (`mhl'(1) tells you how to write one).  When writing your own format
  473. file, use a nonzero value for `overflowoffset' to ensure the header is
  474. RFC 822 compliant and parsable by mh-e.  `mhl' is always used for
  475. printing and forwarding; in this case, the value of `mhl-formfile' is
  476. consulted if it is a filename.
  477.    Two hooks can be used to control how messages are displayed.  The
  478. first hook, `mh-show-mode-hook', is called early on in the process of
  479. displaying of messages.  It is used to perform some actions on the
  480. contents of messages, such as highlighting the header fields.  If you're
  481. running Emacs 19 under the X Window System, the following example will
  482. highlight the `From:' and `Subject:' header fields.  This is a very
  483. nice feature indeed.
  484.      Emphasize header fields in different fonts via mh-show-mode-hook
  485.      
  486.      (defvar my-mh-keywords
  487.         '(("^From: \\(.*\\)" 1 'bold t)
  488.           ("^Subject: \\(.*\\)" 1 'highlight t))
  489.        "mh-e additions for font-lock-keywords.")
  490.      
  491.      (defun my-mh-show-mode-hook ()
  492.        "Hook to turn on and customize fonts."
  493.        (require 'font-lock)                 ; for font-lock-keywords below
  494.        (make-local-variable 'font-lock-mode-hook) ; don't affect other buffers
  495.        (add-hook 'font-lock-mode-hook       ; set a hook with inline function
  496.                  (function                  ; modifies font-lock-keywords when
  497.                   (lambda ()                ; font-lock-mode run
  498.                     (setq font-lock-keywords
  499.                           (append my-mh-keywords font-lock-keywords)))))
  500.        (font-lock-mode 1))                  ; change the typefaces
  501.      
  502.      (if window-system                      ; can't do this on ASCII terminal
  503.          (add-hook 'mh-show-mode-hook 'my-mh-show-mode-hook))
  504.    The second hook, `mh-show-hook', is the last thing called after
  505. messages are displayed.  It's used to affect the behavior of mh-e in
  506. general or when `mh-show-mode-hook' is too early.  For example, if you
  507. wanted to keep mh-e in sync with MH, you could use `mh-show-hook' as
  508. follows:
  509.      (add-hook 'mh-show-hook 'mh-update-sequences)
  510.    The function `mh-update-sequences' is documented in *Note Finishing
  511. Up::.  For those who like to modify their mode lines, use
  512. `mh-show-buffer-mode-line-buffer-id' to modify the mode line in the
  513. MH-Show buffers.  Place the two escape strings `%s' and `%d', which
  514. will display the folder name and the message number, respectively,
  515. somewhere in the string in that order.  The default value of
  516. `"{show-%s} %d"' yields a mode line of
  517.      -----{show-+inbox} 4      (MH-Show)--Bot----------------------------------
  518. File: mh-e,  Node: Customizing Moving Around,  Prev: Customizing Viewing,  Up: Customizing Reading
  519. Moving Around
  520. -------------
  521.    When you use `t' (`mh-toggle-showing') to toggle between show mode
  522. and scan mode, the MH-Show buffer is hidden and the MH-Folder buffer is
  523. left alone.  Setting `mh-recenter-summary-p' to a non-`nil' value
  524. causes the toggle to display as many scan lines as possible, with the
  525. cursor at the middle.  The effect of `mh-recenter-summary-p' is rather
  526. useful, but it can be annoying on a slow network connection.
  527. File: mh-e,  Node: Customizing Sending,  Next: Customizing Draft Editing,  Prev: Customizing Reading,  Up: Customizing mh-e
  528. Sending Mail
  529. ============
  530.    You may wish to start off by adding the following useful key
  531. bindings to your `.emacs' file:
  532.      (global-set-key "\C-xm" 'mh-smail)
  533.      (global-set-key "\C-x4m" 'mh-smail-other-window)
  534.    In addition, several variables are useful when sending mail or
  535. replying to mail.  They are summarized in the following table.
  536. `mh-comp-formfile'
  537.      Format file for drafts (default: `"components"').
  538. `mh-repl-formfile'
  539.      Format file for replies (default: `"replcomps"').
  540. `mh-letter-mode-hook'
  541.      Functions to run in MH-Letter mode (default: `nil').
  542. `mh-compose-letter-function'
  543.      Functions to run when starting a new draft (default: `nil').
  544. `mh-reply-default-reply-to'
  545.      Whom reply goes to (default: `nil').
  546. `mh-forward-subject-format'
  547.      Format string for forwarded message subject (default: `"%s: %s"').
  548. `mh-redist-full-contents'
  549.      `send' requires entire message (default: `nil').
  550. `mh-new-draft-cleaned-headers'
  551.      Remove these header fields from re-edited draft (default:
  552.      `"^Date:\\| ^Received:\\| ^Message-Id:\\| ^From:\\| ^Sender:\\|
  553.      ^Delivery-Date:\\| ^Return-Path:"').
  554.    Since mh-e does not use `comp' to create the initial draft, you need
  555. to set `mh-comp-formfile' to the name of your components file if it
  556. isn't `components'.  This is the name of the file that contains the
  557. form for composing messages.  If it does not contain an absolute
  558. pathname, mh-e searches for the file first in your MH directory and
  559. then in the system MH library directory (such as `/usr/local/lib/mh').
  560. Replies, on the other hand, are built using `repl'.  You can change the
  561. location of the field file from the default of `replcomps' by modifying
  562. `mh-repl-formfile'.
  563.    Two hooks are provided to run commands on your freshly created draft.
  564. The first hook, `mh-letter-mode-hook', allows you to do some processing
  565. before editing a letter.  For example, you may wish to modify the
  566. header after `repl' has done its work, or you may have a complicated
  567. `components' file and need to tell mh-e where the cursor should go.
  568. Here's an example of how you would use this hook--all of the other
  569. hooks are set in this fashion as well.
  570.      Prepare draft for editing via mh-letter-mode-hook
  571.      
  572.      (defvar letter-mode-init-done nil
  573.        "Non-`nil' when one-time mh-e settings have made.")
  574.      
  575.      (defun my-mh-letter-mode-hook ()
  576.        "Hook to prepare letter for editing."
  577.        (if (not letter-mode-init-done)    ; only need to bind the keys once
  578.            (progn
  579.              (local-set-key "\C-ctb" 'add-enriched-text)
  580.              (local-set-key "\C-cti" 'add-enriched-text)
  581.              (local-set-key "\C-ctf" 'add-enriched-text)
  582.              (local-set-key "\C-cts" 'add-enriched-text)
  583.              (local-set-key "\C-ctB" 'add-enriched-text)
  584.              (local-set-key "\C-ctu" 'add-enriched-text)
  585.              (local-set-key "\C-ctc" 'add-enriched-text)
  586.              (setq letter-mode-init-done t)))
  587.        (setq fill-prefix "  ")            ; I find indented text easier to read
  588.        (save-excursion
  589.          (goto-char (point-max))          ; go to end of message to
  590.          (mh-insert-signature)))          ;   insert signature
  591.      
  592.      (add-hook 'mh-letter-mode-hook 'my-mh-letter-mode-hook)
  593.    The function, `add-enriched-text' is defined in the example in *Note
  594. Customizing Editing MIME::.
  595.    The second hook, a function really, is `mh-compose-letter-function'.
  596. Like `mh-letter-mode-hook', it is called just before editing a new
  597. message; however, it is the last function called before you edit your
  598. message.  The consequence of this is that you can write a function to
  599. write and send the message for you.  This function is passed three
  600. arguments: the contents of the `To:', `Subject:', and `cc:' header
  601. fields.
  602. * Menu:
  603. * Customizing Replying::
  604. * Customizing Forwarding::
  605. * Customizing Redistributing::
  606. * Customizing Old Drafts::
  607. File: mh-e,  Node: Customizing Replying,  Next: Customizing Forwarding,  Prev: Customizing Sending,  Up: Customizing Sending
  608. Replying to Mail
  609. ----------------
  610.    If you find that most of the time that you specify `cc' when you
  611. reply to a message, set `mh-reply-default-reply-to' to `cc'.  This
  612. variable is normally set to `nil' so that you are prompted for the
  613. recipient of a reply.  It can be set to one of `from', `to', or `cc';
  614. you are then no longer prompted for the recipient(s) of your reply.
  615. File: mh-e,  Node: Customizing Forwarding,  Next: Customizing Redistributing,  Prev: Customizing Replying,  Up: Customizing Sending
  616. Forwarding Mail
  617. ---------------
  618.    When forwarding a message, the format of the `Subject:' header field
  619. can be modified by the variable `mh-forward-subject-format'.  This
  620. variable is a string which includes two escapes (`%s').  The first `%s'
  621. is replaced with the sender of the original message, and the second one
  622. is replaced with the original `Subject:'.  The default value of `"%s:
  623. %s"' takes a message with the header:
  624.      To: Bill Wohler <wohler@newt.com>
  625.      Subject: Re: 49er football
  626.      From: Greg DesBrisay <gd@cellnet.com>
  627.    and creates a subject header field of:
  628.      Subject: Greg DesBrisay: Re: 49er football
  629. File: mh-e,  Node: Customizing Redistributing,  Next: Customizing Old Drafts,  Prev: Customizing Forwarding,  Up: Customizing Sending
  630. Redistributing Your Mail
  631. ------------------------
  632.    The variable `mh-redist-full-contents' must be set to non-`nil' if
  633. `dist' requires the whole letter for redistribution, which is the case
  634. if `send' is compiled with the BERK (1)  option (which many people
  635. abhor).  If you find that MH will not allow you to redistribute a
  636. message that has been redistributed before, this variable should be set
  637. to `nil'.
  638.    ---------- Footnotes ----------
  639.    (1)  To see which options your copy of MH was compiled with, use
  640. `M-x mh-version' (*Note Miscellaneous::).
  641. File: mh-e,  Node: Customizing Old Drafts,  Prev: Customizing Redistributing,  Up: Customizing Sending
  642. Editing Old Drafts and Bounced Messages
  643. ---------------------------------------
  644.    The header fields specified by `mh-new-draft-cleaned-headers' are
  645. removed from an old draft that has been recreated with `M-e'
  646. (`mh-extract-rejected-mail') or `M-a' (`mh-edit-again').  If when you
  647. edit an old draft with these commands you find that there are header
  648. fields that you don't want included, you can append them to this
  649. variable.  For example,
  650.      (setq mh-new-draft-cleaned-headers
  651.            (concat mh-new-draft-cleaned-headers "\\|^Some-Field:"))
  652.    This appends the regular expression `\\|^Some-Field:' to the
  653. variable (*note Syntax of Regular Expressions: (emacs)Regexps.).  The
  654. `\\|' means *or*, and the `^' (caret) matches the beginning of the
  655. line.  This is done to be very specific about which fields match.  The
  656. literal `:' is appended for the same reason.
  657. File: mh-e,  Node: Customizing Draft Editing,  Next: Customizing Moving Mail,  Prev: Customizing Sending,  Up: Customizing mh-e
  658. Editing a Draft
  659. ===============
  660.    There are several variables used during the draft editing phase.
  661. Examples include changing the name of the file that holds your signature
  662. or telling mh-e about new multimedia types.  They are:
  663. `mh-yank-from-start-of-msg'
  664.      How to yank when region not set (default: `t').
  665. `mh-ins-buf-prefix'
  666.      Indent for yanked messages (default: `"> "').
  667. `mail-citation-hook'
  668.      Functions to run on yanked messages (default: `nil').
  669. `mh-delete-yanked-msg-window'
  670.      Delete message window on yank (default: `nil').
  671. `mh-mime-content-types'
  672.      List of valid content types (default: `'(("text/plain")
  673.      ("text/richtext") ("multipart/mixed") ("multipart/alternative")
  674.      ("multipart/digest") ("multipart/parallel") ("message/rfc822")
  675.      ("message/partial") ("message/external-body")
  676.      ("application/octet-stream") ("application/postscript")
  677.      ("image/jpeg") ("image/gif") ("audio/basic") ("video/mpeg"))').
  678. `mh-mhn-args'
  679.      Additional arguments for `mhn' (default: `nil').
  680. `mh-signature-file-name'
  681.      File containing signature (default: `"~/.signature"').
  682. `mh-before-send-letter-hook'
  683.      Functions to run before sending draft (default: `nil').
  684. `mh-send-prog'
  685.      MH program used to send messages (default: `"send"').
  686. * Menu:
  687. * Customizing Editing Textual::
  688. * Customizing Editing MIME::
  689. * Customizing Sending Message::
  690. File: mh-e,  Node: Customizing Editing Textual,  Next: Customizing Editing MIME,  Prev: Customizing Draft Editing,  Up: Customizing Draft Editing
  691. Editing Textual Messages
  692. ------------------------
  693.    The following two sections include variables that customize the way
  694. you edit a draft.  The discussion here applies to editing multimedia
  695. messages as well.
  696. * Menu:
  697. * Customizing Inserting Letter::
  698. * Customizing Signature::
  699. File: mh-e,  Node: Customizing Inserting Letter,  Next: Customizing Signature,  Prev: Customizing Editing Textual,  Up: Customizing Editing Textual
  700. Inserting letter to which you're replying
  701. .........................................
  702.    To control how much of the message to which you are replying is
  703. yanked by `C-c C-y' (`mh-yank-cur-msg') into your reply, modify
  704. `mh-yank-from-start-of-msg'.  The default value of `t' means that the
  705. entire message is copied.  If it is set to `'body' (don't forget the
  706. apostrophe), then only the message body is copied.  If it is set to
  707. `nil', only the part of the message following point (the current cursor
  708. position in the message's buffer) is copied.  In any case, this
  709. variable is ignored if a region is set in the message you are replying
  710. to.  The string contained in `mh-ins-buf-prefix' is inserted before
  711. each line of a message that is inserted into a draft with `C-c C-y'
  712. (`mh-yank-cur-msg').  I suggest that you not modify this variable.  The
  713. default value of `"> "' is the default string for many mailers and news
  714. readers: messages are far easier to read if several included messages
  715. have all been indented by the same string.  The variable
  716. `mail-citation-hook' is `nil' by default, which means that when a
  717. message is inserted into the letter, each line is prefixed by
  718. `mh-ins-buf-prefix'.  Otherwise, it can be set to a function that
  719. modifies an included citation.  (1) If you like to yank all the text
  720. from the message you're replying to in one go, set
  721. `mh-delete-yanked-msg-window' to non-`nil' to delete the window
  722. containing the original message after yanking it to make more room on
  723. your screen for your reply.
  724.    ---------- Footnotes ----------
  725.    (1)  *Supercite* is an example of a full-bodied, full-featured
  726. citation package.  It is in Emacs versions 19.15 and later, and can be
  727. found via anonymous `ftp' on `archive.cis.ohio-state.edu' in
  728. `/pub/gnu/emacs/elisp-archive/packages/sc3.1.tar.Z'
  729. File: mh-e,  Node: Customizing Signature,  Prev: Customizing Inserting Letter,  Up: Customizing Editing Textual
  730. Inserting your signature
  731. ........................
  732.    You can change the name of the file inserted with `C-c C-s'
  733. (`mh-insert-signature') by changing `mh-signature-file-name' (default:
  734. `"~/.signature"').
  735. File: mh-e,  Node: Customizing Editing MIME,  Next: Customizing Sending Message,  Prev: Customizing Editing Textual,  Up: Customizing Draft Editing
  736. Editing Multimedia Messages
  737. ---------------------------
  738.    The variable `mh-mime-content-types' contains a list of the
  739. currently valid content types.  They are listed in the table in *Note
  740. Customizing Draft Editing::.  If you encounter a new content type, you
  741. can add it like this:
  742.      (setq mh-mime-content-types (append mh-mime-content-types
  743.                                          '(("NEW/TYPE"))))
  744.    Emacs macros can be used to insert enriched text directives like
  745. `<bold>'.  The following code will make, for example, `C-c t b' insert
  746. the `<bold>' directive.
  747.      Emacs macros for entering enriched text
  748.      
  749.      (defvar enriched-text-types '(("b" . "bold") ("i" . "italic") ("f" . "fixed")
  750.                                    ("s" . "smaller") ("B" . "bigger")
  751.                                    ("u" . "underline") ("c" . "center"))
  752.        "Alist of (final-character . directive) choices for add-enriched-text.
  753.      Additional types can be found in RFC 1563.")
  754.      
  755.      (defun add-enriched-text (begin end)
  756.        "Add enriched text directives around region.
  757.      The directive used comes from the list enriched-text-types and is
  758.      specified by the last keystroke of the command.  When called from Lisp,
  759.      arguments are BEGIN and END."
  760.        (interactive "r")
  761.        ;; Set type to the directive indicated by the last keystroke.
  762.        (let ((type (cdr (assoc (char-to-string (logior last-input-char ?`))
  763.                                enriched-text-types))))
  764.          (save-restriction              ; restores state from narrow-to-region
  765.            (narrow-to-region begin end) ; narrow view to region
  766.            (goto-char (point-min))      ; move to beginning of text
  767.            (insert "<" type ">")        ; insert beginning directive
  768.            (goto-char (point-max))      ; move to end of text
  769.            (insert "</" type ">"))))    ; insert terminating directive
  770.    To use the function `add-enriched-text', first create keybindings
  771. for it (*note Customizing Sending::.).  Then, set the mark with `C-@'
  772. or `C-SPC', type in the text to be highlighted, and type `C-c t b'.
  773. This adds `<bold>' where you set the mark and adds `</bold>' at the
  774. location of your cursor, giving you something like: `You should be
  775. <bold>very</bold>'.  You may also be interested in investigating
  776. `sgml-mode'.
  777. * Menu:
  778. * Customizing Sending MIME::
  779. File: mh-e,  Node: Customizing Sending MIME,  Prev: Customizing Editing MIME,  Up: Customizing Editing MIME
  780. Readying multimedia messages for sending
  781. ........................................
  782.    If you wish to pass additional arguments to `mhn' to affect how it
  783. builds your message, use the variable `mh-mhn-args'.  For example, you
  784. can build a consistency check into the message by setting `mh-mhn-args'
  785. to `-check'.  The recipient of your message can then run `mhn -check'
  786. on the message--`mhn' will complain if the message has been corrupted
  787. on the way.  The `C-c C-e' (`mh-mhn-edit') command only consults this
  788. variable when given a prefix argument.
  789. File: mh-e,  Node: Customizing Sending Message,  Prev: Customizing Editing MIME,  Up: Customizing Draft Editing
  790. Sending a Message
  791. -----------------
  792.    If you want to check your spelling in your message before sending,
  793. use `mh-before-send-letter-hook' like this:
  794.    Spell-check message via mh-before-send-letter-hook
  795.      (add-hook 'mh-before-send-letter-hook 'ispell-message)
  796.    In case the MH `send' program is installed under a different name,
  797. use `mh-send-prog' to tell mh-e the name.
  798. File: mh-e,  Node: Customizing Moving Mail,  Next: Customizing Searching,  Prev: Customizing Draft Editing,  Up: Customizing mh-e
  799. Moving Your Mail Around
  800. =======================
  801.    If you change the name of some of the MH programs or have your own
  802. printing programs, the following variables can help you.  They are
  803. described in detail in the subsequent sections.
  804. `mh-inc-prog'
  805.      Program to incorporate mail (default: `"inc"').
  806. `mh-inc-folder-hook'
  807.      Functions to run when incorporating mail (default: `nil').
  808. `mh-delete-msg-hook'
  809.      Functions to run when deleting messages (default: `nil').
  810. `mh-print-background'
  811.      Print in foreground or background (default: `nil').
  812. `mh-lpr-command-format'
  813.      Command used to print (default: `"lpr -J '%s'"').
  814. `mh-default-folder-for-message-function'
  815.      Function to generate a default folder (default: `nil').
  816. `mh-auto-folder-collect'
  817.      Collect folder names in background at startup (default: `t').
  818. `mh-recursive-folders'
  819.      Collect nested folders (default: `nil').
  820. `mh-refile-msg-hook'
  821.      Functions to run when refiling message (default: `nil').
  822. `mh-store-default-directory'
  823.      Default directory for storing files created by `uuencode' or `shar'
  824.      (default: `nil').
  825. `mh-sortm-args'
  826.      Additional arguments for `sortm' (default: `nil').
  827. `mh-scan-prog'
  828.      Program to scan messages (default: `"scan"').
  829. `mh-before-quit-hook'
  830.      Functions to run before quitting (default: `nil').  See also
  831.      `mh-quit-hook'.
  832. `mh-quit-hook'
  833.      Functions to run after quitting (default: `nil'). See also
  834.      `mh-before-quit-hook'.
  835. * Menu:
  836. * Customizing Incorporating::
  837. * Customizing Deleting::
  838. * Customizing Organizing::
  839. * Customizing Printing::
  840. * Customizing Files and Pipes::
  841. * Customizing Finishing Up::
  842. File: mh-e,  Node: Customizing Incorporating,  Next: Customizing Deleting,  Prev: Customizing Moving Mail,  Up: Customizing Moving Mail
  843. Incorporating Your Mail
  844. -----------------------
  845.    The name of the program that incorporates new mail is stored in
  846. `mh-inc-prog'; it is `"inc"' by default.  This program generates a
  847. one-line summary for each of the new messages.  Unless it is an
  848. absolute pathname, the file is assumed to be in the `mh-progs'
  849. directory.  You may also link a file to `inc' that uses a different
  850. format (see `mh-profile'(5)).  You'll then need to modify several
  851. variables appropriately; see `mh-scan-prog' below.  You can set the
  852. hook `mh-inc-folder-hook', which is called after new mail is
  853. incorporated by the `i' (`mh-inc-folder') command.  A good use of this
  854. hook is to rescan the whole folder either after running `M-x mh-rmail'
  855. the first time or when you've changed the message numbers from outside
  856. of mh-e.
  857.      Rescan folder after incorporating new mail via mh-inc-folder-hook
  858.      
  859.      (defun my-mh-inc-folder-hook ()
  860.        "Hook to rescan folder after incorporating mail."
  861.        (if (buffer-modified-p)            ; if outstanding refiles and deletes,
  862.            (mh-execute-commands))         ;   carry them out
  863.        (mh-rescan-folder)                 ; synchronize with +inbox
  864.        (mh-show))                         ; show the current message
  865.      
  866.      (add-hook 'mh-inc-folder-hook 'my-mh-inc-folder-hook)
  867. File: mh-e,  Node: Customizing Deleting,  Next: Customizing Organizing,  Prev: Customizing Incorporating,  Up: Customizing Moving Mail
  868. Deleting Your Mail
  869. ------------------
  870.    The hook `mh-delete-msg-hook' is called after you mark a message for
  871. deletion.  For example, the current maintainer of mh-e used this once
  872. when he kept statistics on his mail usage.
  873.