]> code.delx.au - gnu-emacs/blob - doc/misc/mh-e.texi
(VERSION, EDITION, UPDATED, UPDATE-MONTH): Update for release 8.2.
[gnu-emacs] / doc / misc / mh-e.texi
1 \input texinfo @c -*-texinfo-*-
2 @c
3 @c Note: This document requires makeinfo version 4.6 or greater to build.
4 @c
5 @c %**start of header
6 @setfilename ../../info/mh-e
7 @settitle The MH-E Manual
8 @c %**end of header
9
10 @c Version of the software and manual.
11 @set VERSION 8.2
12 @c Edition of the manual. It is either empty for the first edition or
13 @c has the form ", nth Edition" (without the quotes).
14 @set EDITION
15 @set UPDATED 2009-06-13
16 @set UPDATE-MONTH June, 2009
17
18 @c Other variables.
19 @set MH-BOOK-HOME http://rand-mh.sourceforge.net/book/mh
20 @set MH-E-HOME http://mh-e.sourceforge.net/
21
22 @c Copyright
23 @copying
24 This is version @value{VERSION}@value{EDITION} of @cite{The MH-E
25 Manual}, last updated @value{UPDATED}.
26
27 Copyright @copyright{} 1995, 2001, 2002, 2003, 2005, 2006, 2007, 2008, 2009
28 Free Software Foundation, Inc.
29
30 @c This dual license has been agreed upon by the FSF.
31
32 @quotation
33 Permission is granted to copy, distribute and/or modify this document
34 under the terms of either:
35
36 @enumerate a
37 @item
38 the GNU Free Documentation License, Version 1.3 or any later version
39 published by the Free Software Foundation; with no Invariant Sections,
40 with the Front-Cover texts being ``A GNU Manual,'' and with the
41 Back-Cover Texts as in (a) below. A copy of the license is included in
42 the section entitled ``GNU Free Documentation License.''
43
44 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
45 modify this GNU manual. Buying copies from the FSF supports it in
46 developing GNU and promoting software freedom.''
47
48 @item
49 the GNU General Public License as published by the Free Software
50 Foundation; either version 3, or (at your option) any later version. A
51 copy of the license is included in the section entitled ``GNU General
52 Public License.''
53 @end enumerate
54
55 @end quotation
56 @end copying
57
58 @c Info Directory Entry
59 @dircategory Emacs
60 @direntry
61 * MH-E: (mh-e). Emacs interface to the MH mail system.
62 @end direntry
63
64 @c Title Page
65 @titlepage
66 @title The MH-E Manual
67 @subtitle Version @value{VERSION}@value{EDITION}
68 @subtitle @value{UPDATE-MONTH}
69 @author Bill Wohler
70
71 @c Copyright Page
72 @page
73 @vskip 0pt plus 1filll
74 @insertcopying
75 @end titlepage
76
77 @ifnottex
78 @html
79 <!--
80 @end html
81 @node Top, Preface, (dir), (dir)
82 @top The MH-E Manual
83 @html
84 -->
85 @end html
86 @insertcopying
87 @end ifnottex
88
89 @c Table of Contents
90 @contents
91
92 @html
93 <!--
94 @end html
95
96 @menu
97 * Preface:: Preface
98 * Conventions:: GNU Emacs Terms and Conventions
99 * Getting Started:: Getting Started
100 * Tour Through MH-E:: Tour Through MH-E
101 * Using This Manual:: Using This Manual
102 * Incorporating Mail:: Incorporating Mail
103 * Reading Mail:: Reading Mail
104 * Folders:: Organizing Your Mail with Folders
105 * Sending Mail:: Sending Mail
106 * Editing Drafts:: Editing a Draft
107 * Aliases:: Aliases
108 * Identities:: Identities
109 * Speedbar:: The Speedbar
110 * Menu Bar:: The Menu Bar
111 * Tool Bar:: The Tool Bar
112 * Searching:: Searching Through Messages
113 * Threading:: Viewing Message Threads
114 * Limits:: Limiting Display
115 * Sequences:: Using Sequences
116 * Junk:: Dealing With Junk Mail
117 * Miscellaneous:: Miscellaneous Commands, Variables, and Buffers
118 * Scan Line Formats:: Scan Line Formats
119 * Procmail:: Reading Mailing Lists Effectively
120 * Odds and Ends:: Odds and Ends
121 * History:: History of MH-E
122 * GFDL:: GNU Free Documentation License
123 * GPL:: GNU General Public License
124 * Key Index:: Key (Character) Index
125 * Command Index:: Command Index
126 * Option Index:: Option (Variable) Index
127 * Concept Index:: Concept Index
128
129 @detailmenu
130 --- The Detailed Node Listing ---
131
132 Tour Through MH-E
133
134 * Sending Mail Tour::
135 * Reading Mail Tour::
136 * Processing Mail Tour::
137 * Leaving MH-E::
138 * More About MH-E::
139
140 Using This Manual
141
142 * Options::
143 * Ranges::
144 * Folder Selection::
145
146 Reading Your Mail
147
148 * Viewing::
149 * Viewing Attachments::
150 * HTML::
151 * Digests::
152 * Reading PGP::
153 * Printing::
154 * Files and Pipes::
155 * Navigating::
156 * Miscellaneous Commands and Options::
157
158 Sending Mail
159
160 * Composing::
161 * Replying::
162 * Forwarding::
163 * Redistributing::
164 * Editing Again::
165
166 Editing a Draft
167
168 * Editing Message::
169 * Inserting Letter::
170 * Inserting Messages::
171 * Signature::
172 * Picture::
173 * Adding Attachments::
174 * Sending PGP::
175 * Checking Recipients::
176 * Sending Message::
177 * Killing Draft::
178
179 Odds and Ends
180
181 * Bug Reports::
182 * Mailing Lists::
183 * MH FAQ and Support::
184 * Getting MH-E::
185
186 History of MH-E
187
188 * From Brian Reid::
189 * From Jim Larus::
190 * From Stephen Gildea::
191 * From Bill Wohler::
192
193 @end detailmenu
194 @end menu
195
196 @html
197 -->
198 @end html
199
200 @node Preface, Conventions, Top, Top
201 @unnumbered Preface
202
203 @cindex Emacs
204 @cindex Unix commands, Emacs
205 @cindex preface
206
207 This manual introduces another interface to the MH mail system that is
208 accessible through the GNU Emacs editor, namely, @emph{MH-E}. MH-E is
209 easy to use. I don't assume that you know GNU Emacs or even MH at this
210 point, since I didn't know either of them when I discovered MH-E.
211 However, MH-E was the tip of the iceberg, and I discovered more and
212 more niceties about GNU Emacs and MH@. Now I'm fully hooked on both of
213 them.
214
215 The MH-E package is distributed with GNU Emacs@footnote{Version
216 @value{VERSION} of MH-E will appear in GNU Emacs 23.1. It is supported
217 in GNU Emacs 21 and 22, as well as XEmacs 21 (except for versions
218 21.5.9-21.5.16). It is compatible with MH versions 6.8.4 and higher,
219 all versions of nmh, and GNU mailutils 1.0 and higher.}, so you
220 shouldn't have to do anything special to use it. Gnus is also
221 required; version 5.10 or higher is recommended. This manual covers
222 MH-E version @value{VERSION}. To help you decide which version you
223 have, see @ref{Getting Started}.
224
225 @findex help-with-tutorial
226 @kindex C-h t
227
228 If you don't already use GNU Emacs but want to learn more, you can
229 read an online tutorial by starting GNU Emacs and typing @kbd{C-h t}
230 (@code{help-with-tutorial}). (To learn about this notation, see
231 @ref{Conventions}.) If you want to take the plunge, consult the
232 @iftex
233 @cite{GNU Emacs Manual},
234 @end iftex
235 @ifinfo
236 @ref{top, , GNU Emacs Manual, emacs, GNU Emacs Manual},
237 @end ifinfo
238 @ifhtml
239 @uref{http://www.gnu.org/software/emacs/manual/html_node/,
240 @cite{GNU Emacs Manual}},
241 @end ifhtml
242 from the Free Software Foundation.
243
244 If more information is needed, you can go to the Unix manual pages of
245 the individual MH commands. When the name is not obvious, I'll guide
246 you to a relevant MH manual page that describes the action more fully.
247
248 @cindex @cite{MH & nmh: Email for Users & Programmers}
249 @cindex MH book
250 @cindex info
251 @kindex C-h i
252
253 This manual is available in both Info and online formats. The Info
254 version is distributed with Emacs and can be accessed with the
255 @command{info} command (@samp{info mh-e}) or within Emacs (@kbd{C-h i
256 m mh-e @key{RET}}). The online version is available at
257 @uref{http://mh-e.sourceforge.net/manual/, SourceForge}. Another great
258 online resource is the book @uref{http://www.ics.uci.edu/~mh/book/,
259 @cite{MH & nmh: Email for Users & Programmers}} (also known as
260 @dfn{the MH book}).
261
262 I hope you enjoy this manual! If you have any comments, or suggestions
263 for this document, please let me know.
264
265 @cindex Bill Wohler
266 @cindex Wohler, Bill
267
268 @noindent
269 Bill Wohler <@i{wohler at newt.com}>@*
270 8 February 1995@*
271 24 February 2006
272
273 @node Conventions, Getting Started, Preface, Top
274 @chapter GNU Emacs Terms and Conventions
275
276 @cindex Emacs
277 @cindex Emacs, conventions
278 @cindex Emacs, terms
279 @cindex Unix commands, Emacs
280 @cindex conventions, Emacs
281 @cindex terms, Emacs
282
283 If you're an experienced Emacs user, you can skip the following
284 conventions and definition of terms and go directly to the next
285 section (@pxref{Getting Started}).
286
287 @cindex Emacs commands
288 @cindex MH commands
289 @cindex Unix commands
290 @cindex commands
291 @cindex commands, MH
292 @cindex commands, Unix
293 @cindex commands, shell
294 @cindex functions
295 @cindex shell commands
296
297 In general, @dfn{functions} in this text refer to Emacs Lisp functions
298 that one would call from within Emacs Lisp programs (for example,
299 @code{(mh-inc-folder)}). On the other hand, @dfn{commands} are those
300 things that are run by the user, such as @kbd{i} or @kbd{M-x
301 mh-inc-folder}. Programs outside of Emacs are specifically called MH
302 commands, shell commands, or Unix commands.
303
304 @cindex conventions, key names
305 @cindex key names
306
307 The conventions for key names are as follows:
308
309 @table @kbd
310 @item C-x
311 Hold down the @key{CTRL} (Control) key and press the @kbd{x} key.
312 @c -------------------------
313 @item M-x
314 Hold down the @key{META} or @key{ALT} key and press the @kbd{x} key.
315
316 Since some keyboards don't have a @key{META} key, you can generate
317 @kbd{M-x}, for example, by pressing @key{ESC} (Escape),
318 @emph{releasing it}, and then pressing the @kbd{x} key.
319 @c -------------------------
320 @item @key{RET}
321 Press the @key{RETURN} or @key{ENTER} key. This is normally used to
322 complete a command.
323 @c -------------------------
324 @item @key{SPC}
325 Press the space bar.
326 @c -------------------------
327 @item @key{TAB}
328 Press the @key{TAB} key.
329 @c -------------------------
330 @item @key{DEL}
331 Press the @key{DELETE} key.
332 @c -------------------------
333 @item @key{BS}
334 Press the @key{BACKSPACE} key@footnote{If you are using Version 20 or
335 earlier of Emacs, you will need to use the @key{DEL} key.}.
336 @end table
337
338 @cindex Emacs, prefix argument
339 @cindex prefix argument
340 @kindex C-u
341
342 A @dfn{prefix argument} allows you to pass an argument to any Emacs
343 function. To pass an argument, type @kbd{C-u} before the Emacs command
344 or keystroke. Numeric arguments can be passed as well. For example, to
345 insert five f's, use @kbd{C-u 5 f}. There is a default of four when
346 using @kbd{C-u}, and you can use multiple prefix arguments to provide
347 arguments of powers of four. To continue our example, you could insert
348 four f's with @kbd{C-u f}, 16 f's with @kbd{C-u C-u f}, 64 f's with
349 @kbd{C-u C-u C-u f}, and so on. Numeric and valueless negative
350 arguments can also be inserted with the @key{META} key. Examples
351 include @kbd{M-5} to specify an argument of 5, or @kbd{M--} which
352 specifies a negative argument with no particular value.
353
354 @sp 1
355 @center @strong{NOTE}
356
357 @quotation
358 The prefix @kbd{C-u} or @kbd{M-} is not necessary in MH-E's MH-Folder
359 mode (@pxref{Reading Mail Tour}). In this mode, simply enter the
360 numerical argument before entering the command.
361 @end quotation
362 @sp 1
363
364 @cindex @file{.emacs}
365 @cindex Emacs, variables
366 @cindex files, @file{.emacs}
367 @cindex variables
368 @findex setq
369
370 Emacs uses @dfn{variables} to hold values. These can be changed via
371 calls to the function @code{setq} in @file{~/.emacs}.
372
373 @cindex Emacs, options
374 @cindex options
375 @findex customize-group
376 @findex customize-option
377
378 Variables in MH-E that are normally modified by the user are called
379 @dfn{options} and are modified through the customize functions (such
380 as @kbd{M-x customize-option} or @kbd{M-x customize-group}).
381 @ifnothtml
382 @xref{Easy Customization,,,emacs,The GNU Emacs Manual}, in @cite{The
383 GNU Emacs Manual}.
384 @end ifnothtml
385 @ifhtml
386 See section
387 @uref{http://www.gnu.org/software/emacs/manual/html_node/Easy-Customization.html,
388 Easy Customization} in @cite{The GNU Emacs Manual}.
389 @end ifhtml
390 @xref{Options}.
391
392 @cindex Emacs, faces
393 @cindex faces
394 @cindex highlighting
395 @findex customize-face
396
397 You can specify various styles for displaying text using @dfn{faces}.
398 MH-E provides a set of faces that you can use to personalize the look
399 of your MH-E buffers. Use the command @kbd{M-x customize-face} to do
400 this.
401 @ifnothtml
402 @xref{Face Customization,,,emacs,The GNU Emacs Manual}, in @cite{The
403 GNU Emacs Manual}.
404 @end ifnothtml
405 @ifhtml
406 See section
407 @uref{http://www.gnu.org/software/emacs/manual/html_node/Face-Customization.html,
408 Face Customization} in @cite{The GNU Emacs Manual}.
409 @end ifhtml
410
411 @cindex abnormal hooks
412 @cindex hooks
413 @cindex normal hooks
414 @findex add-hook
415 @findex customize-option
416
417 Commands often offer @dfn{hooks} which enable you to extend or modify
418 the way a command works.
419 @ifnothtml
420 @ref{Hooks, , Hooks, emacs, The GNU Emacs Manual}, in @cite{The GNU
421 Emacs Manual}
422 @end ifnothtml
423 @ifhtml
424 See section
425 @uref{http://www.gnu.org/software/emacs/manual/html_node/Hooks.html,
426 Hooks} in @cite{The GNU Emacs Manual}
427 @end ifhtml
428 for a description about @dfn{normal hooks} and @dfn{abnormal hooks}.
429 MH-E uses normal hooks in nearly all cases, so you can assume that we
430 are talking about normal hooks unless we explicitly mention that a
431 hook is abnormal. We also follow the conventions described in that
432 section: the name of the abnormal hooks end in @code{-hooks} and all
433 the rest of the MH-E hooks end in @code{-hook}. You can add hooks with
434 either @code{customize-option} or @code{add-hook}.
435
436 @cindex Emacs, mark
437 @cindex Emacs, point
438 @cindex Emacs, region
439 @cindex mark
440 @cindex point
441 @cindex region
442 @kindex C-@@
443 @kindex C-@key{SPC}
444
445 There are several other terms that are used in Emacs that you should
446 know. The @dfn{point} is where the cursor currently is. You can save
447 your current place in the file by setting a @dfn{mark}. This operation
448 is useful in several ways. The mark can be later used when defining a
449 @dfn{region}, which is the text between the point and mark. Many
450 commands operate on regions, such as those for deleting text or
451 filling paragraphs. A mark can be set with @kbd{C-@@} (or
452 @kbd{C-@key{SPC}}).
453
454 @cindex completion
455 @cindex Emacs, completion
456 @cindex Emacs, file completion
457 @cindex Emacs, folder completion
458 @cindex Emacs, minibuffer
459 @cindex file completion
460 @cindex folder completion
461 @cindex minibuffer
462 @kindex SPC
463 @kindex TAB
464
465 The @dfn{minibuffer} is the bottom line of the Emacs window, where all
466 prompting and multiple-character input is directed. You can use
467 @dfn{completion} to enter values such as folders. Completion means
468 that Emacs fills in text for you when you type @key{SPC} or @key{TAB}.
469 A second @key{SPC} or @key{TAB} will list all possibilities at that
470 point.
471 @ifnothtml
472 @xref{Completion, , Completion, emacs, The GNU Emacs Manual}.
473 @end ifnothtml
474 @ifhtml
475 See the section
476 @uref{http://www.gnu.org/software/emacs/manual/html_node/Completion.html,
477 Completion} in @cite{The GNU Emacs Manual}.
478 @end ifhtml
479 Note that @key{SPC} cannot be used for completing filenames and
480 folders.
481
482 @findex help-with-tutorial
483 @kindex C-h t
484 @kindex M-x
485
486 The minibuffer is also where you enter Emacs function names after
487 typing @kbd{M-x}. For example, in the preface, I mentioned that you
488 could obtain help with @kbd{C-h t} (@code{help-with-tutorial}). What
489 this means is that you can get a tutorial by typing either @kbd{C-h t}
490 or @kbd{M-x help-with-tutorial}. In the latter case, you are prompted
491 for @samp{help-with-tutorial} in the minibuffer after typing
492 @kbd{M-x}.
493
494 @cindex ~
495
496 The @samp{~} notation in filenames represents your home directory.
497 This notation is used by many shells including @command{bash},
498 @code{tcsh}, and @command{csh}. It is analogous to the environment
499 variable @samp{$HOME}. For example, @file{~/.emacs} can be written
500 @file{$HOME/.emacs} or using the absolute path as in
501 @file{/home/wohler/.emacs} instead.
502
503 @cindex Emacs, interrupting
504 @cindex Emacs, quitting
505 @cindex interrupting
506 @cindex quitting
507
508 @i{In case of trouble:} Emacs can be interrupted at any time with
509 @kbd{C-g}. For example, if you've started a command that requests that
510 you enter something in the minibuffer, but then you change your mind,
511 type @kbd{C-g} and you'll be back where you started. If you want to
512 exit Emacs entirely, use @kbd{C-x C-c}.
513
514 @node Getting Started, Tour Through MH-E, Conventions, Top
515 @chapter Getting Started
516
517 @cindex MH-E, versions
518 @cindex history
519 @cindex versions of MH-E
520
521 Because there are many old versions of MH-E out there, it is important
522 to know which version you have. I'll be talking about @w{Version 8}
523 which is pretty close to @w{Version 6} and @w{Version 7}. It differs
524 from @w{Version 4} and @w{Version 5} and is vastly different from
525 @w{Version 3}. @xref{History}.
526
527 @findex mh-version
528
529 To determine which version of MH-E that you have, enter @kbd{M-x
530 mh-version @key{RET}}. Hopefully it says that you're running
531 @w{Version @value{VERSION}} which is the latest version as of this
532 printing.
533
534 If your version is much older than this, please consider upgrading.
535 You can have your system administrator upgrade the system-wide
536 version, or you can install your own personal version. It's really
537 quite easy. @xref{Getting MH-E}, for instructions for getting and
538 installing MH-E.
539
540 If the @code{mh-version} command displays @samp{No MH variant
541 detected}@footnote{In very old versions of MH-E, you may get the error
542 message, @samp{Cannot find the commands `inc' and `mhl' and the file
543 `components'} if MH-E can't find MH. In this case, you need to update
544 MH-E, and you may need to install MH too. However, newer versions of
545 MH-E are better at finding MH if it is on your system.}, then you need
546 to install MH or tell MH-E where to find MH.
547
548 @cindex Debian
549 @cindex nmh
550 @cindex GNU mailutils MH
551
552 If you don't have MH on your system already, you must install a
553 variant of MH. The Debian mh-e package does this for you automatically
554 (@pxref{Getting MH-E}). Most people use
555 @uref{http://www.nongnu.org/nmh/, nmh}, but you may be interested in
556 trying out @uref{http://www.gnu.org/software/mailutils/, GNU mailutils
557 MH}, which supports IMAP. Your GNU/Linux distribution probably has
558 packages for both of these.
559
560 @cindex @command{install-mh}
561 @cindex MH commands, @command{install-mh}
562 @cindex MH book
563
564 If you've never run MH before, you need to run @command{install-mh}
565 from the shell before you continue. This sets up your personal MH
566 environment@footnote{See the section
567 @uref{@value{MH-BOOK-HOME}/../overall/setup.html, Setting Up MH} in the
568 MH book.}. If you don't, you'll be greeted with the error message:
569 @samp{Install MH and run install-mh before running MH-E}. This is all
570 you need to know about MH to use MH-E, but the more you know about MH,
571 the more you can leverage its power. See the
572 @uref{@value{MH-BOOK-HOME}/../, MH book} to learn more about MH.
573
574 @cindex @samp{Path:} MH profile component
575 @cindex MH profile
576 @cindex MH profile component
577 @cindex MH profile component, @samp{Path:}
578
579 Your MH environment includes your @dfn{MH profile} which is found in
580 the file @file{~/.mh_profile}, or the file named in the environment
581 variable @samp{$MH}. This file contains a number of @dfn{MH
582 profile components}. For example, the @samp{Path:} MH profile
583 component contains the path to your mail directory, which is
584 @file{~/Mail} by default.
585
586 @cindex @command{mhparam}
587 @cindex MH commands, @command{mhparam}
588 @vindex exec-path
589 @vindex mh-path
590 @vindex mh-sys-path
591 @vindex mh-variant
592 @vindex mh-variant-in-use
593
594 There are several options MH-E uses to interact with your MH
595 installation. The option @code{mh-variant} specifies the variant used
596 by MH-E (@pxref{Options}). The default setting of this option is
597 @samp{Auto-detect} which means that MH-E will automatically choose the
598 first of nmh, MH, or GNU mailutils MH that it finds in the directories
599 listed in @code{mh-path} (which you can customize),
600 @code{mh-sys-path}, and @code{exec-path}. If MH-E can't find MH at
601 all, you may have to customize @code{mh-path} and add the directory in
602 which the command @command{mhparam} is located. If, on the other hand,
603 you have both nmh and GNU mailutils MH installed (for example) and
604 @code{mh-variant-in-use} was initialized to nmh but you want to use
605 GNU mailutils MH, then you can set @code{mh-variant} to
606 @samp{gnu-mh}.
607
608 @vindex mh-flists-present-flag
609 @vindex mh-lib
610 @vindex mh-lib-progs
611 @vindex mh-progs
612
613 When @code{mh-variant} is changed, MH-E resets @code{mh-progs},
614 @code{mh-lib}, @code{mh-lib-progs}, @code{mh-flists-present-flag}, and
615 @code{mh-variant-in-use} accordingly.
616
617 @cindex @file{.emacs}
618 @cindex files, @file{.emacs}
619
620 @sp 1
621 @center @strong{NOTE}
622
623 @quotation
624 Prior to version 8, it was often necessary to set some of these
625 variables in @file{~/.emacs}; now it is no longer necessary and can
626 actually cause problems.
627 @end quotation
628 @sp 1
629
630 @cindex MH profile component, @samp{Draft-Folder:}
631 @cindex MH profile component, @samp{Path:}
632 @cindex MH profile component, @samp{Previous-Sequence:}
633 @cindex MH profile component, @samp{Unseen-Sequence:}
634 @cindex @samp{Draft-Folder:} MH profile component
635 @cindex @samp{Path:} MH profile component
636 @cindex @samp{Previous-Sequence:} MH profile component
637 @cindex @samp{Unseen-Sequence:} MH profile component
638 @findex mh-find-path
639 @vindex mh-draft-folder
640 @vindex mh-find-path-hook
641 @vindex mh-inbox
642 @vindex mh-previous-seq
643 @vindex mh-unseen-seq
644 @vindex mh-user-path
645
646 In addition to setting variables that point to MH itself, MH-E also
647 sets a handful of variables that point to where you keep your mail.
648 During initialization, the function @code{mh-find-path} sets
649 @code{mh-user-path} from your @samp{Path:} MH profile component (but
650 defaults to @samp{Mail} if one isn't present), @code{mh-draft-folder}
651 from @samp{Draft-Folder:}, @code{mh-unseen-seq} from
652 @samp{Unseen-Sequence:}, @code{mh-previous-seq} from
653 @samp{Previous-Sequence:}, and @code{mh-inbox} from @samp{Inbox:}
654 (defaults to @samp{+inbox}). The hook @code{mh-find-path-hook} is run
655 after these variables have been set. This hook can be used the change
656 the value of these variables if you need to run with different values
657 between MH and MH-E.
658
659 @node Tour Through MH-E, Using This Manual, Getting Started, Top
660 @chapter Tour Through MH-E
661
662 @cindex introduction
663 @cindex tour
664 @cindex tutorial
665
666 This chapter introduces some of the terms you'll need to know and then
667 takes you on a tour of MH-E@footnote{The keys mentioned in these
668 chapters refer to the default key bindings. If you've changed the
669 bindings, refer to the command summaries at the beginning of each
670 chapter for a mapping between default key bindings and function
671 names.}. When you're done, you'll be able to send, read, and file
672 mail, which is all that a lot of people ever do. But if you're the
673 curious or adventurous type, read the rest of the manual to be able to
674 use all the features of MH-E. I suggest you read this chapter first to
675 get the big picture, and then you can read the manual as you wish.
676
677 @menu
678 * Sending Mail Tour::
679 * Reading Mail Tour::
680 * Processing Mail Tour::
681 * Leaving MH-E::
682 * More About MH-E::
683 @end menu
684
685 @node Sending Mail Tour, Reading Mail Tour, Tour Through MH-E, Tour Through MH-E
686 @section Sending Mail
687
688 @cindex MH-Letter mode
689 @cindex mode
690 @cindex modes, MH-Letter
691 @cindex sending mail
692 @findex mh-smail
693 @kindex M-x mh-smail
694
695 Let's start our tour by sending ourselves a message which we can later
696 read and process. Enter @kbd{M-x mh-smail} to invoke the MH-E program
697 to send messages. Your message appears in an Emacs buffer whose
698 mode@footnote{A @dfn{mode} changes Emacs to make it easier to edit a
699 particular type of text.} is MH-Letter.
700
701 Enter your login name in the @samp{To:} header field. Press the
702 @key{TAB} twice to move the cursor past the @samp{Cc:} field, since no
703 carbon copies are to be sent, and on to the @samp{Subject:} field.
704 Enter @kbd{Test} or anything else that comes to mind.
705
706 Press @key{TAB} again to move the cursor to the body of the message.
707 Enter some text, using normal Emacs commands. You should now have
708 something like this@footnote{If you're running Emacs under the X
709 Window System, then you would also see a menu bar and a tool bar. I've
710 left out the menu bar and tool bar in all of the example screens.}:
711
712 @cartouche
713 @smallexample
714
715
716
717
718
719
720 --:-- *scratch* All L1 (Lisp Interaction)-------------------------
721 To: wohler
722 cc:
723 Subject: Test
724 X-Mailer: MH-E 8.1; nmh 1.1; GNU Emacs 23.1
725 --------
726 This is a test message to get the wheels churning...#
727
728
729 --:** @{draft@} All L5 (MH-Letter)----------------------------------
730 Type C-c C-c to send message, C-C ? for help
731 @end smallexample
732 @end cartouche
733 @i{MH-E message composition window}
734
735 Note the line of dashes that separates the header and the body of the
736 message. It is essential that these dashes (or a blank line) are
737 present or the body of your message will be considered to be part of
738 the header.
739
740 @cindex help
741 @findex describe-mode
742 @kindex C-c ?
743 @kindex C-c C-c
744 @kindex C-h m
745
746 There are several commands specific to MH-Letter mode@footnote{You can
747 get quick help for the commands used most often with @kbd{C-c ?} or
748 more complete help with the @kbd{C-h m} (@code{describe-mode})
749 command.}, but at this time we'll only use @kbd{C-c C-c} to send your
750 message. Type @kbd{C-c C-c} now. That's all there is to it!
751
752 @node Reading Mail Tour, Processing Mail Tour, Sending Mail Tour, Tour Through MH-E
753 @section Receiving Mail
754
755 @cindex @command{inc}
756 @cindex @command{scan}
757 @cindex MH commands, @command{inc}
758 @cindex MH commands, @command{scan}
759 @cindex MH-Folder mode
760 @cindex modes, MH-Folder
761 @cindex reading mail
762 @findex mh-rmail
763 @kindex M-x mh-rmail
764
765 To read the mail you've just sent yourself, enter @kbd{M-x mh-rmail}.
766 This incorporates the new mail and puts the output from
767 @command{inc}@footnote{See the section
768 @uref{@value{MH-BOOK-HOME}/reapre.html, Reading Mail: inc show next
769 prev} in the MH book.} (called @dfn{scan lines} after the MH program
770 @command{scan}@footnote{See the section
771 @uref{@value{MH-BOOK-HOME}/faswsprs.html, Find and Specify with scan
772 pick Ranges Sequences} in the MH book.} which prints a one-line
773 summary of each message) into a buffer called @samp{+inbox} whose
774 major mode is MH-Folder.
775
776 @findex mh-rmail
777 @kindex F r
778 @kindex M-x mh-rmail
779
780 @sp 1
781 @center @strong{NOTE}
782
783 @quotation
784
785 The @kbd{M-x mh-rmail} command will show you only new mail, not mail
786 you have already read. If you were to run this tour again, you would
787 use @kbd{F r} to pull all your messages into MH-E.
788 @end quotation
789 @sp 1
790
791 @kindex @key{RET}
792 @kindex n
793 @kindex p
794
795 You should see the scan line for your message, and perhaps others. Use
796 @kbd{n} or @kbd{p} to move the cursor to your test message and type
797 @key{RET} to read your message. You should see something like:
798
799 @cartouche
800 @smallexample
801 3 t08/24 root received fax files on Wed Aug 24 11:00:13 PDT 1
802 # 4+t08/24 To:wohler Test<<This is a test message to get the wheels
803
804 -:%% @{+inbox/select@} 4 msgs (1-4) Bot L4 (MH-Folder Show)---------
805 To: wohler
806 Subject: Test
807 X-Mailer: MH-E 8.1; nmh 1.1; GNU Emacs 23.1
808 Date: Fri, 17 Mar 2006 10:49:11 -0800
809 From: Bill Wohler <wohler@@stop.mail-abuse.org>
810
811 This is a test message to get the wheels churning...
812
813
814
815 --:-- @{show-+inbox@} 4 All L1 (MH-Show)----------------------------
816
817 @end smallexample
818 @end cartouche
819 @i{After incorporating new messages}
820
821 @kindex @key{DEL}
822 @kindex @key{SPC}
823
824 If you typed a long message, you can view subsequent pages with
825 @key{SPC} and previous pages with @key{DEL}.
826
827 @node Processing Mail Tour, Leaving MH-E, Reading Mail Tour, Tour Through MH-E
828 @section Processing Mail
829
830 @cindex processing mail
831 @kindex @key{RET}
832 @kindex r
833
834 The first thing we want to do is reply to the message that we sent
835 ourselves. Ensure that the cursor is still on the same line as your
836 test message and type @kbd{r}. You are prompted in the minibuffer with
837 @samp{Reply to whom:}. Here MH-E is asking whether you'd like to reply
838 to the original sender only, to the sender and primary recipients, or
839 to the sender and all recipients. You can press @key{TAB} to see these
840 choices. If you simply press @key{RET}, you'll reply only to the
841 sender. Press @key{RET} now.
842
843 You'll find yourself in an Emacs buffer similar to that when you were
844 sending the original message, like this:
845
846 @cartouche
847 @smallexample
848 To:
849 cc:
850 Subject: Re: Test
851 In-reply-to: <31054.1142621351@@stop.mail-abuse.org>
852 References: <31054.1142621351@@stop.mail-abuse.org>
853 Comments: In-reply-to Bill Wohler <wohler@@stop.mail-abuse.org>
854 message dated "Fri, 17 Mar 2006 10:49:11 -0800."
855 X-Mailer: MH-E 8.1; nmh 1.1; GNU Emacs 23.1
856 --------
857 #
858
859 --:-- @{draft@} All L10 (MH-Letter)----------------------------------
860 To: wohler
861 Subject: Test
862 X-Mailer: MH-E 8.1; nmh 1.1; GNU Emacs 23.1
863 Date: Fri, 17 Mar 2006 10:49:11 -0800
864 From: Bill Wohler <wohler@@stop.mail-abuse.org>
865
866 This is a test message to get the wheels churning...
867
868 --:-- @{show-+inbox@} 4 All L1 (MH-Show)----------------------------
869 Type C-c C-c to send message, C-c ? for help
870 @end smallexample
871 @end cartouche
872 @i{Composition window during reply}
873
874 @findex backward-char
875 @findex forward-char
876 @findex next-line
877 @findex previous-line
878 @kindex C-b
879 @kindex C-c C-c
880 @kindex C-c C-f C-t
881 @kindex C-f
882 @kindex C-n
883 @kindex C-p
884 @kindex @key{BS}
885
886 By default, MH will not add you to the address list of your replies,
887 so if you find that the @samp{To:} header field is missing, don't
888 worry. In this case, type @kbd{C-c C-f C-t} to create and go to the
889 @samp{To:} field, where you can type your login name again. You can
890 move around with the arrow keys or with @kbd{C-p}
891 (@code{previous-line}), @kbd{C-n} (@code{next-line}), @kbd{C-b}
892 (@code{backward-char}), and @kbd{C-f} (@code{forward-char}) and can
893 delete the previous character with @key{BS}. When you're finished
894 editing your message, send it with @kbd{C-c C-c} as before.
895
896 @cindex @command{refile}
897 @cindex MH commands, @command{refile}
898 @cindex folders
899 @kindex @key{SPC}
900 @kindex o
901
902 You'll often want to save messages that were sent to you in an
903 organized fashion. This is done with @dfn{folders}. You can use
904 folders to keep messages from your friends, or messages related to a
905 particular topic. With your cursor in the MH-Folder buffer and
906 positioned on the message you sent to yourself, type @kbd{o} to output
907 (@command{refile} in MH parlance) that message to a folder. Enter
908 @kbd{test} at the @samp{Destination folder:} prompt and type @kbd{y}
909 (or @key{SPC}) when MH-E asks to create the folder @samp{+test}. Note
910 that a @samp{^} (caret) appears next to the message number, which
911 means that the message has been marked for refiling but has not yet
912 been refiled. We'll talk about how the refile is actually carried out
913 in a moment.
914
915 @cindex MH-Folder mode
916 @cindex modes, MH-Folder
917 @kindex d
918 @kindex i
919 @kindex @key{RET}
920 @kindex n
921 @kindex p
922 @kindex x
923
924 Your previous reply is now waiting in the system mailbox. You
925 incorporate this mail into your MH-Folder buffer named @samp{+inbox}
926 with the @kbd{i} command. Do this now. After the mail is incorporated,
927 use @kbd{n} or @kbd{p} to move the cursor to the new message, and read
928 it with @key{RET}. Let's delete this message by typing @kbd{d}. Note
929 that a @samp{D} appears next to the message number. This means that
930 the message is marked for deletion but is not yet deleted. To perform
931 the deletion (and the refile we did previously), use the @kbd{x}
932 command.
933
934 @findex mh-smail
935 @kindex m
936 @kindex M-x mh-smail
937
938 If you want to send another message you can use @kbd{m} instead of
939 @kbd{M-x mh-smail}. So go ahead, send some mail to your friends!
940
941 @cindex help
942 @cindex prefix characters
943 @findex describe-mode
944 @kindex ?
945 @kindex C-h m
946 @kindex F ?
947
948 You can get a quick reminder about these commands by typing @kbd{?}.
949 This lists several @dfn{prefix characters}. To list the commands
950 available via the prefix characters, type the prefix character
951 followed by a @kbd{?}, for example, @kbd{F ?}. More complete help is
952 available with the @kbd{C-h m} (@code{describe-mode}) command.
953
954 @node Leaving MH-E, More About MH-E, Processing Mail Tour, Tour Through MH-E
955 @section Leaving MH-E
956
957 @cindex Emacs, quitting
958 @cindex quitting
959 @kindex C-x C-c
960 @kindex x
961
962 You may now wish to exit @command{emacs} entirely. Use @kbd{C-x C-c}
963 to exit @command{emacs}. If you exited without running @kbd{x} in the
964 @samp{+inbox} buffer, Emacs will offer to save it for you. Type
965 @kbd{y} or @key{SPC} to save @samp{+inbox} changes, which means to
966 perform any refiles and deletes that you did there.
967
968 @findex mh-rmail
969 @kindex C-x b
970 @kindex C-x k
971 @kindex M-x mh-rmail
972 @kindex q
973
974 If you don't want to leave Emacs, you can type @kbd{q} to bury (hide)
975 the MH-E folder or delete it entirely with @kbd{C-x k}. You can then
976 later recall it with @kbd{C-x b} or @kbd{M-x mh-rmail}.
977
978 @cindex @command{packf}
979 @cindex MH commands, @command{packf}
980 @cindex exporting folders
981 @cindex folders, exporting
982 @cindex mbox-style folder
983
984 On the other hand, if you no longer want to use MH and MH-E, you can
985 take your mail with you. You can copy all of your mail into a single
986 file, mbox-style, by using the MH command @command{packf}. For
987 example, to create a file called @file{msgbox} with the messages in
988 your @samp{+inbox} folder, use @samp{packf +inbox}. The
989 @command{packf} command will append the messages to the file if it
990 already exists, so you can use @samp{folders -recurse -fast} in a
991 script to copy all of your messages into a single file, or using the
992 @samp{-file} argument, a file for each folder.
993
994 @node More About MH-E, , Leaving MH-E, Tour Through MH-E
995 @section More About MH-E
996
997 These are the basic commands to get you going, but there are plenty
998 more. If you think that MH-E is for you, read the rest of the manual
999 to find out how you can:
1000
1001 @itemize @bullet
1002 @item
1003 Print your messages (@pxref{Printing}).
1004 @c -------------------------
1005 @item
1006 Edit messages and include your signature (@pxref{Editing Drafts}).
1007 @c -------------------------
1008 @item
1009 Forward messages (@pxref{Forwarding}).
1010 @c -------------------------
1011 @item
1012 Read digests (@pxref{Digests}).
1013 @c -------------------------
1014 @item
1015 Edit bounced messages (@pxref{Editing Again}).
1016 @c -------------------------
1017 @item
1018 Send multimedia messages (@pxref{Adding Attachments}).
1019 @c -------------------------
1020 @item
1021 Read HTML messages (@pxref{HTML}).
1022 @c -------------------------
1023 @item
1024 Use aliases and identities (see @ref{Aliases}, @pxref{Identities}).
1025 @c -------------------------
1026 @item
1027 Create different views of your mail (see @ref{Threading}, @pxref{Limits}).
1028 @c -------------------------
1029 @item
1030 Deal with junk mail (@pxref{Junk}).
1031 @c -------------------------
1032 @item
1033 Handle signed and encrypted messages (see @ref{Reading PGP},
1034 @pxref{Sending PGP}).
1035 @c -------------------------
1036 @item
1037 Process mail that was sent with @command{shar} or @command{uuencode}
1038 (@pxref{Files and Pipes}).
1039 @c -------------------------
1040 @item
1041 Use sequences conveniently (@pxref{Sequences}).
1042 @c -------------------------
1043 @item
1044 Use the speedbar, tool bar, and menu bar (see @ref{Speedbar}, see @ref{Tool
1045 Bar}, @pxref{Menu Bar}).
1046 @c -------------------------
1047 @item
1048 Show header fields in different fonts (@pxref{Reading Mail}).
1049 @c -------------------------
1050 @item
1051 Find previously refiled messages (@pxref{Searching}).
1052 @c -------------------------
1053 @item
1054 Place messages in a file (@pxref{Files and Pipes}).
1055 @end itemize
1056
1057 Remember that you can also use MH commands when you're not running
1058 MH-E (and when you are!).
1059
1060 @node Using This Manual, Incorporating Mail, Tour Through MH-E, Top
1061 @chapter Using This Manual
1062
1063 This chapter begins the meat of the manual which goes into more detail
1064 about every MH-E command and option.
1065
1066 @cindex Emacs, info
1067 @cindex Emacs, online help
1068 @cindex info
1069 @cindex online help
1070 @findex describe-mode
1071 @findex mh-help
1072 @kindex ?
1073 @kindex C-c ?
1074 @kindex C-h C-h
1075 @kindex C-h C-k i
1076 @kindex C-h i
1077 @kindex C-h m
1078
1079 There are many commands, but don't get intimidated. There are command
1080 summaries at the beginning of each chapter. In case you have or would
1081 like to rebind the keys, the command summaries also list the
1082 associated Emacs Lisp function. Furthermore, even if you're stranded
1083 on a desert island with a laptop and are without your manuals, you can
1084 get a summary of all these commands with GNU Emacs online help: use
1085 @kbd{C-h m} (@code{describe-mode}) for a brief summary of commands,
1086 @kbd{?} (@code{mh-help}) for an even briefer summary@footnote{This
1087 help appears in a buffer called @samp{*MH-E Help*}
1088 (@pxref{Miscellaneous}).} (@kbd{C-c ?} in MH-Letter mode), or @kbd{C-h
1089 i} to read this manual via Info. The online help is quite good; try
1090 running @kbd{C-h C-h}. This brings up a list of available help topics,
1091 one of which displays the documentation for a given key (like @kbd{C-h
1092 k C-n}). Another useful help feature is to view the manual section
1093 that describes a given key (such as @kbd{C-h K i}). In addition,
1094 review @ref{Conventions}, if any of the GNU Emacs conventions are
1095 strange to you.
1096
1097 In addition to all of the commands, it is also possible to reconfigure
1098 MH-E to fit the needs of even the most demanding user. The following
1099 chapters also describe all of the options, show the defaults, and make
1100 recommendations for customization.
1101
1102 However, when customizing your mail environment, first try to change
1103 what you want in MH, and only change MH-E if changing MH is not
1104 possible. That way you will get the same behavior inside and outside
1105 GNU Emacs. Note that MH-E does not provide hooks for customizations
1106 that can be done in MH; this omission is intentional.
1107
1108 @cindex Emacs Lisp Manual
1109 @cindex Emacs, Emacs Lisp Manual
1110 @cindex Emacs, info
1111 @cindex Emacs, online help
1112 @cindex info
1113 @cindex online help
1114
1115 I hope I've included enough examples here to get you well on your way.
1116 If you want to explore Emacs Lisp further, a programming manual does
1117 exist,
1118 @c Yes, some of the stuff in the following sections is redundant, but
1119 @c TeX barfs if the @ifs are inside the @footnote.
1120 @iftex
1121 @footnote{The @cite{GNU Emacs Lisp Reference Manual} may be available
1122 online in the Info system by typing @kbd{C-h i m Emacs Lisp
1123 @key{RET}}. It is also available online at @*
1124 @uref{http://www.gnu.org/software/emacs/elisp-manual/html_node/}. You
1125 can also order a printed manual, which has the desirable side-effect
1126 of helping to support the Free Software Foundation which made all this
1127 great software available. You can find an order form by running
1128 @kbd{C-h C-d}, or you can request an order form from @i{gnu at
1129 gnu.org}.}
1130 @end iftex
1131 @ifinfo
1132 @footnote{@xref{Top, The GNU Emacs Lisp Reference Manual, , elisp, GNU
1133 Emacs Lisp Reference Manual}, which may be available online in the
1134 Info system. It is also available online at
1135 @uref{http://www.gnu.org/software/emacs/elisp-manual/html_node/}. You
1136 can also order a printed manual, which has the desirable side-effect
1137 of helping to support the Free Software Foundation which made all this
1138 great software available. You can find an order form by running
1139 @kbd{C-h C-d}, or you can request an order form from @i{gnu at
1140 gnu.org}.}
1141 @end ifinfo
1142 @ifhtml
1143 @footnote{The
1144 @uref{http://www.gnu.org/software/emacs/elisp-manual/html_node/,
1145 The GNU Emacs Lisp Reference Manual} may also be available online in
1146 the Info system by typing @kbd{C-h i m Emacs Lisp @key{RET}}. You can
1147 also order a printed manual, which has the desirable side-effect of
1148 helping to support the Free Software Foundation which made all this
1149 great software available. You can find an order form by running
1150 @kbd{C-h C-d}, or you can request an order form from @i{gnu at
1151 gnu.org}.}
1152 @end ifhtml
1153 and you can look at the code itself for examples. Look in the Emacs
1154 Lisp directory on your system (such as
1155 @file{/usr/local/lib/emacs/lisp/mh-e}) and find all the @file{mh-*.el}
1156 files there. When calling MH-E and other Emacs Lisp functions directly
1157 from Emacs Lisp code, you'll need to know the correct arguments. Use
1158 the online help for this. For example, try @kbd{C-h f
1159 mh-execute-commands @key{RET}}. If you write your own functions,
1160 please do not prefix your symbols (variables and functions) with
1161 @samp{mh-}. This prefix is reserved for the MH-E package. To avoid
1162 conflicts with existing MH-E symbols, use a prefix like @samp{my-} or
1163 your initials. (Unless, of course, your initials happen to be @emph{mh}!)
1164
1165 @menu
1166 * Options::
1167 * Ranges::
1168 * Folder Selection::
1169 @end menu
1170
1171 @node Options, Ranges, Using This Manual, Using This Manual
1172 @section Options
1173
1174 @cindex Emacs, customizing
1175 @cindex Emacs, setting options
1176 @cindex customizing MH-E
1177 @cindex setting options
1178 @findex customize-option
1179 @vindex mh-lpr-command-format, example
1180
1181 Many string or integer options are easy to modify using @kbd{M-x
1182 customize-option}. For example, to modify the option that controls
1183 printing, you would run @kbd{M-x customize-option @key{RET}
1184 mh-lpr-command-format @key{RET}}. In the buffer that appears, modify
1185 the string to the right of the variable. For example, you may change
1186 the @command{lpr} command with @samp{nenscript -G -r -2 -i'%s'}. Then
1187 use the @samp{State} combo box and select @samp{Save for Future
1188 Sessions}. To read more about @code{mh-lpr-command-format}, see
1189 @ref{Printing}.
1190
1191 @cindex nil
1192 @cindex off, option
1193 @cindex on, option
1194 @cindex option, turning on and off
1195 @cindex t
1196 @findex customize-option
1197 @vindex mh-bury-show-buffer-flag, example
1198
1199 Options can also hold boolean values. In Emacs Lisp, the boolean
1200 values are @code{nil}, which means false, and @code{t}, which means
1201 true. The @code{customize-option} function makes it easy to change
1202 boolean values; simply click on the toggle button in the customize
1203 buffer to switch between @samp{on} (@code{t}) and @samp{off}
1204 (@code{nil}). For example, try setting @code{mh-bury-show-buffer-flag}
1205 to @samp{off} to keep the MH-Show buffer at the top of the buffer
1206 stack. Use the @samp{State} combo box and choose @samp{Set for Current
1207 Session} to see how the option affects the show buffer. Then choose
1208 the @samp{Erase Customization} menu item to reset the option to the
1209 default, which places the MH-Show buffer at the bottom of the buffer
1210 stack.
1211
1212 @vindex mh-mhl-format-file, example
1213
1214 The text usually says to turn on an option by setting it to a
1215 @emph{non-@code{nil}} value, because sometimes values other than
1216 @samp{on} are meaningful. An example of this is the variable
1217 @code{mh-mhl-format-file} (@pxref{Viewing}). Other options, such as
1218 hooks, involve a little more Emacs Lisp programming expertise.
1219
1220 @cindex customization group, @samp{mh}
1221 @cindex @samp{mh} customization group
1222 @findex customize-group
1223 @findex mh-customize
1224
1225 You can browse all of the MH-E options with the @code{customize-group}
1226 function. Try entering @kbd{M-x customize-group @key{RET} mh
1227 @key{RET}} to view the top-level options as well as buttons for all of
1228 the MH-E customization groups. Another way to view the MH-E
1229 customization group is to use @kbd{M-x mh-customize @key{RET}}.
1230
1231 @node Ranges, Folder Selection, Options, Using This Manual
1232 @section Ranges
1233
1234 @c Sync with mh-folder-mode docstring.
1235
1236 @cindex message abbreviations
1237 @cindex message ranges
1238 @cindex ranges
1239
1240 Many commands that operate on individual messages, such as
1241 @code{mh-forward} or @code{mh-refile-msg} take a @code{RANGE}
1242 argument. This argument can be used in several ways.
1243
1244 @kindex C-u, with ranges
1245
1246 If you provide the prefix argument @kbd{C-u} to these commands, then
1247 you will be prompted for the message range. This can be any valid MH
1248 range which can include messages, sequences (@pxref{Sequences}), and
1249 the abbreviations (described in the @command{mh}(1) man page):
1250
1251 @table @samp
1252 @item <num1>-<num2>
1253 Indicates all messages in the range <num1> to <num2>, inclusive. The
1254 range must be nonempty.
1255 @c -------------------------
1256 @item <num>:N
1257 @itemx <num>:+N
1258 @itemx <num>:-N
1259 Up to N messages beginning with (or ending with) message num. Num may
1260 be any of the predefined symbols: first, prev, cur, next or last.
1261 @c -------------------------
1262 @item first:N
1263 @itemx prev:N
1264 @itemx next:N
1265 @itemx last:N
1266 The first, previous, next or last messages, if they exist.
1267 @c -------------------------
1268 @item all
1269 All of the messages.
1270 @end table
1271
1272 For example, a range that shows all of these things is @samp{1 2 3
1273 5-10 last:5 unseen}.
1274
1275 @vindex transient-mark-mode
1276
1277 If the option @code{transient-mark-mode} is turned on and you set a
1278 region in the MH-Folder buffer, then the MH-E command will perform the
1279 operation on all messages in that region.
1280
1281 @cindex @samp{mh-range} customization group
1282 @cindex customization group, @samp{mh-range}
1283
1284 The @samp{mh-range} customization group contains a single option which
1285 affects how ranges are interpreted.
1286
1287 @vtable @code
1288 @item mh-interpret-number-as-range-flag
1289 On means interpret a number as a range (default: @samp{on}).
1290 @end vtable
1291
1292 @vindex mh-interpret-number-as-range-flag
1293
1294 Since one of the most frequent ranges used is @samp{last:N}, MH-E will
1295 interpret input such as @samp{200} as @samp{last:200} if the
1296 @code{mh-interpret-number-as-range-flag} option is on (which is the
1297 default). If you need to scan just the message 200, then use the range
1298 @samp{200:1} or @samp{200-200}.
1299
1300 @node Folder Selection, , Ranges, Using This Manual
1301 @section Folder Selection
1302
1303 @cindex completion, folders
1304 @cindex folders, completion
1305 @cindex folders, selecting
1306
1307 When you choose a folder in MH-E via a command such as @kbd{o}
1308 (@code{mh-refile-msg}), completion is used to enter the folder
1309 @ifnothtml
1310 (@pxref{Completion, , , emacs, The GNU Emacs Manual}).
1311 @end ifnothtml
1312 @ifhtml
1313 (see the section
1314 @uref{http://www.gnu.org/software/emacs/manual/html_node/Completion.html,
1315 Completion} in @cite{The GNU Emacs Manual}).
1316 @end ifhtml
1317 In addition, MH-E has several ways of choosing a suitable default so
1318 that the folder can often be selected with a single @key{RET} key.
1319
1320 @cindex customization group, @samp{mh-folder-selection}
1321 @cindex @samp{mh-folder-selection} customization group
1322
1323 The @samp{mh-folder-selection} customization group contains some
1324 options which are used to help with this.
1325
1326 @vtable @code
1327 @item mh-default-folder-for-message-function
1328 Function to select a default folder for refiling or @samp{Fcc:}
1329 (default: @code{nil}).
1330 @c -------------------------
1331 @item mh-default-folder-list
1332 List of addresses and folders (default: @code{nil}).
1333 @c -------------------------
1334 @item mh-default-folder-must-exist-flag
1335 On means guessed folder name must exist to be used (default:
1336 @samp{on}).
1337 @c -------------------------
1338 @item mh-default-folder-prefix
1339 Prefix used for folder names generated from aliases (default: @code{""}).
1340 @end vtable
1341
1342 @vindex mh-default-folder-for-message-function
1343
1344 You can set the option @code{mh-default-folder-for-message-function}
1345 to a function that provides a default folder for the message to be
1346 refiled. When this function is called, the current buffer contains the
1347 message being refiled and point is at the start of the message. This
1348 function should return the default folder as a string with a leading
1349 @samp{+} sign. It can also return @code{nil} so that the last folder
1350 name is used as the default, or an empty string to suppress the
1351 default entirely.
1352
1353 Otherwise, the name of the destination folder is derived from the
1354 sender as follows:
1355
1356 @enumerate
1357 @vindex mh-default-folder-list
1358 @item
1359 The folder name associated with the first address found in the list
1360 @code{mh-default-folder-list} is used. Each element in this list
1361 contains a @samp{Check Recipient} item. If this item is turned on,
1362 then the address is checked against the recipient instead of the
1363 sender. This is useful for mailing lists.
1364 @c -------------------------
1365 @vindex mh-default-folder-prefix
1366 @item
1367 An alias prefixed by @code{mh-default-folder-prefix} corresponding to
1368 the address is used. The prefix is used to prevent clutter in your
1369 mail directory. @xref{Aliases}.
1370 @end enumerate
1371
1372 @vindex mh-default-folder-must-exist-flag
1373
1374 If the derived folder does not exist, and
1375 @code{mh-default-folder-must-exist-flag} is @code{t}, then the last
1376 folder name used is suggested. This is useful if you get mail from
1377 various people for whom you have an alias, but file them all in the
1378 same project folder.
1379
1380 @node Incorporating Mail, Reading Mail, Using This Manual, Top
1381 @chapter Incorporating Your Mail
1382
1383 @cindex @samp{Folder} menu
1384 @cindex incorporating
1385 @cindex menu, @samp{Folder}
1386
1387 This chapter talks about getting mail from your system mailbox into
1388 your MH @samp{+inbox} folder. The following command accomplishes that
1389 and is found in the @samp{Folder} menu.
1390
1391 @table @kbd
1392 @cindex @samp{Folder > Incorporate New Mail} menu item
1393 @cindex menu item, @samp{Folder > Incorporate New Mail}
1394 @findex mh-inc-folder
1395 @kindex i
1396 @item i
1397 Incorporate new mail into a folder (@code{mh-inc-folder}).
1398 @end table
1399
1400 @cindex @samp{mh-inc} customization group
1401 @cindex customization group, @samp{mh-inc}
1402
1403 The following options in the @samp{mh-inc} customization group are
1404 used.
1405
1406 @vtable @code
1407 @item mh-inc-prog
1408 Program to incorporate mail (default: @code{"inc"}).
1409 @c -------------------------
1410 @item mh-inc-spool-list
1411 Alternate spool files (default: @code{nil}).
1412 @end vtable
1413
1414 The following hook is available.
1415
1416 @vtable @code
1417 @findex mh-inc-folder
1418 @item mh-inc-folder-hook
1419 Hook run by @code{mh-inc-folder} after incorporating mail into a
1420 folder (default: @code{nil}).
1421 @end vtable
1422
1423 @cindex @samp{+inbox}
1424 @findex mh-inc-folder
1425 @kindex i
1426
1427 If at any time you receive new mail, incorporate the new mail into
1428 your @samp{+inbox} buffer with @kbd{i} (@code{mh-inc-folder}). Note
1429 that @kbd{i} will display the @samp{+inbox} buffer, even if there
1430 isn't any new mail. You can incorporate mail from any file into the
1431 current folder by specifying a prefix argument; you'll be prompted for
1432 the name of the file to use as well as the destination folder (for
1433 example, @kbd{C-u i ~/mbox @key{RET} +tmp @key{RET}}).
1434
1435 @cindex @file{.emacs}
1436 @cindex Emacs, notification of new mail
1437 @cindex files, @file{.emacs}
1438 @cindex new mail
1439 @cindex notification of new mail
1440
1441 Emacs can notify you when you have new mail by displaying @samp{Mail}
1442 in the mode line. To enable this behavior, and to have a clock in the
1443 mode line as well, add the following to @file{~/.emacs}:
1444
1445 @findex display-time
1446
1447 @smalllisp
1448 (display-time)
1449 @end smalllisp
1450
1451 @cindex @command{inc}
1452 @cindex incorporating
1453 @cindex MH commands, @command{inc}
1454 @vindex mh-inc-prog
1455 @vindex mh-progs
1456
1457 The name of the program that incorporates new mail is stored in
1458 @code{mh-inc-prog}; it is @code{"inc"} by default. This program
1459 generates a one-line summary for each of the new messages. Unless it
1460 is an absolute pathname, the file is assumed to be in the
1461 @code{mh-progs} directory (@pxref{Getting Started}). You may also link
1462 a file to @command{inc} that uses a different format (see
1463 @samp{mh-profile}(5), and sections
1464 @uref{@value{MH-BOOK-HOME}/reapre.html, Reading Mail: inc show next
1465 prev} and @uref{@value{MH-BOOK-HOME}/mhstr.html, MH Format Strings} in
1466 the MH book). You'll then need to modify several variables
1467 appropriately (@pxref{Scan Line Formats}).
1468
1469 @vindex mh-inc-spool-list
1470
1471 You can use the @code{mh-inc-spool-list} variable to direct MH-E to
1472 retrieve mail from arbitrary spool files other than your system
1473 mailbox, file it in folders other than your @samp{+inbox}, and assign
1474 key bindings to incorporate this mail.
1475
1476 @cindex @command{procmail}
1477 @cindex @file{.procmailrc}
1478 @cindex Unix commands, @command{procmail}
1479 @cindex files, @file{.procmailrc}
1480
1481 Suppose you are subscribed to the @i{mh-e-devel} mailing list and you
1482 use @command{procmail} to filter this mail into @file{~/mail/mh-e}
1483 with the following recipe in @file{.procmailrc}:
1484
1485 @smallexample
1486 PATH=$PATH:/usr/bin/mh
1487 MAILDIR=$HOME/`mhparam Path`
1488 :0:
1489 * ^From mh-e-devel-admin@@stop.mail-abuse.org
1490 mh-e
1491 @end smallexample
1492
1493 @findex mh-inc-spool-*
1494 @kindex I *
1495
1496 In order to incorporate @file{~/mail/mh-e} into @samp{+mh-e} with an
1497 @kbd{I m} (@code{mh-inc-spool-mh-e}) command, customize this option,
1498 and click on the @samp{INS} button. Enter a @samp{Spool File} of
1499 @samp{~/mail/mh-e}, a @samp{Folder} of @samp{mh-e}, and a @samp{Key
1500 Binding} of @samp{m}.
1501
1502 @cindex @command{emacsclient}
1503 @cindex @command{gnuclient}
1504 @cindex @command{xbuffy}
1505 @cindex @samp{gnuserv}
1506 @cindex Unix commands, @command{emacsclient}
1507 @cindex Unix commands, @command{gnuclient}
1508 @cindex Unix commands, @command{xbuffy}
1509
1510 You can use @command{xbuffy} to automate the incorporation of this
1511 mail using the Emacs 23 command @command{emacsclient} as follows:
1512
1513 @smallexample
1514 box ~/mail/mh-e
1515 title mh-e
1516 origMode
1517 polltime 10
1518 headertime 0
1519 command emacsclient --eval '(mh-inc-spool-mh-e)'
1520 @end smallexample
1521
1522 In XEmacs, the command @command{gnuclient} is used in a similar
1523 fashion.
1524
1525 @findex mh-inc-folder
1526 @kindex i
1527 @vindex mh-inc-folder-hook
1528
1529 You can set the hook @code{mh-inc-folder-hook}, which is called after
1530 new mail is incorporated by the @kbd{i} (@code{mh-inc-folder})
1531 command. A good use of this hook is to rescan the whole folder either
1532 after running @kbd{M-x mh-rmail} the first time or when you've changed
1533 the message numbers from outside of MH-E.
1534
1535 @findex mh-execute-commands
1536 @findex mh-rescan-folder, example
1537 @findex mh-show, example
1538 @vindex mh-inc-folder-hook, example
1539
1540 @smalllisp
1541 @group
1542 (defun my-mh-inc-folder-hook ()
1543 "Hook to rescan folder after incorporating mail."
1544 (if (buffer-modified-p) ; @r{if outstanding refiles and deletes,}
1545 (mh-execute-commands)) ; @r{carry them out}
1546 (mh-rescan-folder) ; @r{synchronize with +inbox}
1547 (mh-show)) ; @r{show the current message}
1548
1549 (add-hook 'mh-inc-folder-hook 'my-mh-inc-folder-hook)
1550
1551 @i{Rescan folder after incorporating new mail via mh-inc-folder-hook}
1552
1553 @end group
1554 @end smalllisp
1555
1556 @node Reading Mail, Folders, Incorporating Mail, Top
1557 @chapter Reading Your Mail
1558
1559 @cindex @samp{+inbox}
1560 @cindex MH-Folder mode
1561 @cindex MH-Show mode
1562 @cindex modes, MH-Folder
1563 @cindex modes, MH-Show
1564 @cindex reading mail
1565 @findex mh-rmail
1566 @kindex F r
1567 @kindex F v
1568 @kindex M-x mh-rmail
1569
1570 The MH-E entry point for reading mail is @kbd{M-x mh-rmail}. This
1571 command incorporates your mail and creates a buffer called
1572 @samp{+inbox} in MH-Folder mode. The command @kbd{M-x mh-rmail} shows
1573 you only new mail, not mail you have already read@footnote{If you want
1574 to see your old mail as well, use @kbd{F r} to pull all your messages
1575 into MH-E. Or, give a prefix argument to @code{mh-rmail} so it will
1576 prompt you for folder to visit like @kbd{F v} (for example, @kbd{C-u
1577 M-x mh-rmail @key{RET} bob @key{RET}}). @xref{Folders}.}.
1578
1579 @findex display-time
1580 @vindex read-mail-command
1581
1582 There are some commands that need to read mail, such as @kbd{Mouse-2}
1583 over the @samp{Mail} button that @code{display-time} adds to the mode
1584 line. You can configure Emacs to have these commands use MH-E by
1585 setting the option @code{read-mail-command} to @samp{mh-rmail}.
1586
1587 @cindex @command{scan}
1588 @cindex @samp{Message} menu
1589 @cindex MH commands, @command{scan}
1590 @cindex menu, @samp{Message}
1591 @cindex scan lines
1592
1593 The @samp{+inbox} buffer contains @dfn{scan lines}, which are one-line
1594 summaries of each incorporated message. You can perform most MH
1595 commands on these messages via one- or two-letter commands in either
1596 the MH-Folder or MH-Show buffers or by using the @samp{Message} menu.
1597 See @command{scan}(1) for a description of the contents of the scan
1598 lines, and see the Figure in @ref{Reading Mail Tour}, for an example.
1599
1600 @table @kbd
1601 @kindex ?
1602 @findex mh-help
1603 @item ?
1604 Display cheat sheet for the MH-E commands (@code{mh-help}).
1605 @c -------------------------
1606 @cindex @samp{Message > Show Message} menu item
1607 @cindex menu item, @samp{Message > Show Message}
1608 @kindex @key{RET}
1609 @findex mh-show
1610 @item @key{RET}
1611 Display message (@code{mh-show}).
1612 @c -------------------------
1613 @cindex @samp{Message > Show Message with Header} menu item
1614 @cindex menu item, @samp{Message > Show Message with Header}
1615 @kindex , (comma)
1616 @findex mh-header-display
1617 @item , (comma)
1618 Display message with all header fields (@code{mh-header-display}).
1619 @c -------------------------
1620 @cindex @samp{Message > Show Message with Preferred Alternative} menu item
1621 @cindex menu item, @samp{Message > Show Message with Preferred Alternative}
1622 @kindex : (colon)
1623 @findex mh-show-preferred-alternative
1624 @item : (colon)
1625 Display message with the default preferred alternative
1626 (@code{mh-show-preferred-alternative}).
1627 @c -------------------------
1628 @kindex ; (semicolon)
1629 @findex mh-toggle-mh-decode-mime-flag
1630 @item ; (semicolon)
1631 Toggle the value of @code{mh-decode-mime-flag}
1632 (@code{mh-toggle-mh-decode-mime-flag}).
1633 @c -------------------------
1634 @kindex @key{SPC}
1635 @findex mh-page-msg
1636 @item @key{SPC}
1637 Display next page in message (@code{mh-page-msg}).
1638 @c -------------------------
1639 @kindex @key{BS}
1640 @findex mh-previous-page
1641 @item @key{BS}
1642 Display previous page in message (@code{mh-previous-page}).
1643 @c -------------------------
1644 @cindex @samp{Message > Write Message to File...} menu item
1645 @cindex menu item, @samp{Message > Write Message to File...}
1646 @kindex >
1647 @findex mh-write-msg-to-file
1648 @item >
1649 Append message to end of file (@code{mh-write-msg-to-file}).
1650 @c -------------------------
1651 @cindex @samp{Message > Pipe Message to Command...} menu item
1652 @cindex menu item, @samp{Message > Pipe Message to Command...}
1653 @kindex |
1654 @findex mh-pipe-msg
1655 @item |
1656 Pipe message through shell command (@code{mh-pipe-msg}).
1657 @c -------------------------
1658 @kindex C-d
1659 @findex mh-delete-msg-no-motion
1660 @item C-d
1661 Delete range, don't move to next message
1662 (@code{mh-delete-msg-no-motion}).
1663 @c -------------------------
1664 @cindex @samp{Message > Delete Message} menu item
1665 @cindex menu item, @samp{Message > Delete Message}
1666 @kindex d
1667 @findex mh-delete-msg
1668 @item d
1669 Delete range (@code{mh-delete-msg}).
1670 @c -------------------------
1671 @kindex D ?
1672 @findex mh-prefix-help
1673 @item D ?
1674 Display cheat sheet for the commands of the current prefix in
1675 minibuffer (@code{mh-prefix-help}).
1676 @c -------------------------
1677 @kindex D @key{SPC}
1678 @findex mh-page-digest
1679 @item D @key{SPC}
1680 Display next message in digest (@code{mh-page-digest}).
1681 @c -------------------------
1682 @kindex D @key{BS}
1683 @findex mh-page-digest-backwards
1684 @item D @key{BS}
1685 Display previous message in digest (@code{mh-page-digest-backwards}).
1686 @c -------------------------
1687 @cindex @samp{Message > Burst Digest Message} menu item
1688 @cindex menu item, @samp{Message > Burst Digest Message}
1689 @kindex D b
1690 @findex mh-burst-digest
1691 @item D b
1692 Break up digest into separate messages (@code{mh-burst-digest}).
1693 @c -------------------------
1694 @cindex @samp{Message > Go to Message by Number...} menu item
1695 @cindex menu item, @samp{Message > Go to Message by Number...}
1696 @kindex g
1697 @findex mh-goto-msg
1698 @item g
1699 Go to a message (@code{mh-goto-msg}).
1700 @c -------------------------
1701 @kindex k
1702 @findex mh-delete-subject-or-thread
1703 @item k
1704 Delete messages with same subject or thread
1705 (@code{mh-delete-subject-or-thread}).
1706 @c -------------------------
1707 @kindex K ?
1708 @findex mh-prefix-help
1709 @item K ?
1710 Display cheat sheet for the commands of the current prefix in
1711 minibuffer (@code{mh-prefix-help}).
1712 @c -------------------------
1713 @kindex K @key{TAB}
1714 @findex mh-next-button
1715 @item K @key{TAB}
1716 Go to the next button (@code{mh-next-button}).
1717 @c -------------------------
1718 @kindex K S-@key{TAB}
1719 @findex mh-prev-button
1720 @item K S-@key{TAB}
1721 Go to the previous button (@code{mh-prev-button}).
1722 @c -------------------------
1723 @kindex K a
1724 @findex mh-mime-save-parts
1725 @item K a
1726 Save attachments (@code{mh-mime-save-parts}).
1727 @c -------------------------
1728 @kindex K e
1729 @findex mh-display-with-external-viewer
1730 @item K e
1731 View attachment externally (@code{mh-display-with-external-viewer}).
1732 @c -------------------------
1733 @kindex K i
1734 @findex mh-folder-inline-mime-part
1735 @item K i
1736 Show attachment verbatim (@code{mh-folder-inline-mime-part}).
1737 @c -------------------------
1738 @kindex K o
1739 @findex mh-folder-save-mime-part
1740 @item K o
1741 Save (output) attachment (@code{mh-folder-save-mime-part}).
1742 @c -------------------------
1743 @kindex K t
1744 @findex mh-toggle-mime-buttons
1745 @item K t
1746 Toggle option @code{mh-display-buttons-for-inline-parts-flag}
1747 (@code{mh-toggle-mime-buttons}).
1748 @c -------------------------
1749 @kindex K v
1750 @findex mh-folder-toggle-mime-part
1751 @item K v
1752 View attachment (@code{mh-folder-toggle-mime-part}).
1753 @c -------------------------
1754 @cindex @samp{Message > Modify Message} menu item
1755 @cindex menu item, @samp{Message > Modify Message}
1756 @kindex M
1757 @findex mh-modify
1758 @item M
1759 Edit message (@code{mh-modify}).
1760 @c -------------------------
1761 @cindex @samp{Message > Go to First Message} menu item
1762 @cindex menu item, @samp{Message > Go to First Message}
1763 @kindex M-<
1764 @findex mh-first-msg
1765 @item M-<
1766 Display first message (@code{mh-first-msg}).
1767 @c -------------------------
1768 @cindex @samp{Message > Go to Last Message} menu item
1769 @cindex menu item, @samp{Message > Go to Last Message}
1770 @kindex M->
1771 @findex mh-last-msg
1772 @item M->
1773 Display last message (@code{mh-last-msg}).
1774 @c -------------------------
1775 @kindex M-n
1776 @findex mh-next-unread-msg
1777 @item M-n
1778 Display next unread message (@code{mh-next-unread-msg}).
1779 @c -------------------------
1780 @kindex M-p
1781 @findex mh-previous-unread-msg
1782 @item M-p
1783 Display previous unread message (@code{mh-previous-unread-msg}).
1784 @c -------------------------
1785 @cindex @samp{Message > Next Message} menu item
1786 @cindex menu item, @samp{Message > Next Message}
1787 @kindex n
1788 @findex mh-next-undeleted-msg
1789 @item n
1790 Display next message (@code{mh-next-undeleted-msg}).
1791 @c -------------------------
1792 @cindex @samp{Message > Previous Message} menu item
1793 @cindex menu item, @samp{Message > Previous Message}
1794 @kindex p
1795 @findex mh-previous-undeleted-msg
1796 @item p
1797 Display previous message (@code{mh-previous-undeleted-msg}).
1798 @c -------------------------
1799 @kindex P ?
1800 @findex mh-prefix-help
1801 @item P ?
1802 Display cheat sheet for the commands of the current prefix in
1803 minibuffer (@code{mh-prefix-help}).
1804 @c -------------------------
1805 @kindex P C
1806 @findex mh-ps-print-toggle-color
1807 @item P C
1808 Toggle whether color is used in printing messages
1809 (@code{mh-ps-print-toggle-color}).
1810 @c -------------------------
1811 @kindex P F
1812 @findex mh-ps-print-toggle-faces
1813 @item P F
1814 Toggle whether printing is done with faces or not
1815 (@code{mh-ps-print-toggle-faces}).
1816 @c -------------------------
1817 @kindex P f
1818 @findex mh-ps-print-msg-file
1819 @item P f
1820 Print range to file (@code{mh-ps-print-msg-file}).
1821 @c -------------------------
1822 @cindex @samp{Message > Print Message} menu item
1823 @cindex menu item, @samp{Message > Print Message}
1824 @kindex P l
1825 @findex mh-print-msg
1826 @item P l
1827 Print range the old fashioned way
1828 (@code{mh-print-msg}).
1829 @c -------------------------
1830 @kindex P p
1831 @findex mh-ps-print-msg
1832 @item P p
1833 Print range (@code{mh-ps-print-msg}).
1834 @c -------------------------
1835 @kindex X ?
1836 @findex mh-prefix-help
1837 @item X ?
1838 Display cheat sheet for the commands of the current prefix in
1839 minibuffer (@code{mh-prefix-help}).
1840 @c -------------------------
1841 @cindex @samp{Message > Unpack Uuencoded Message...} menu item
1842 @cindex menu item, @samp{Message > Unpack Uuencoded Message...}
1843 @kindex X s
1844 @kindex X u
1845 @findex mh-store-msg
1846 @item X s
1847 @itemx X u
1848 Unpack message created with @command{uudecode} or @command{shar}
1849 (@code{mh-store-msg}).
1850 @c -------------------------
1851 @kindex Mouse-2
1852 @findex mh-show-mouse
1853 @item Mouse-2
1854 Move point to mouse event and show message (@code{mh-show-mouse}).
1855 @end table
1856
1857 Within the MH-Show buffer, the following command is defined.
1858
1859 @table @kbd
1860 @kindex @key{RET}
1861 @kindex Mouse-1
1862 @kindex Mouse-2
1863 @findex mh-press-button
1864 @item @key{RET}
1865 @itemx Mouse-1
1866 @itemx Mouse-2
1867 View contents of button (@code{mh-press-button}).
1868 @end table
1869
1870 @cindex @samp{mh-show} customization group
1871 @cindex customization group, @samp{mh-show}
1872
1873 The following table lists options in the @samp{mh-show} customization
1874 group that are used while reading mail.
1875
1876 @vtable @code
1877 @item mh-bury-show-buffer-flag
1878 On means show buffer is buried (default: @samp{on}).
1879 @c -------------------------
1880 @item mh-clean-message-header-flag
1881 On means remove extraneous header fields (default: @samp{on}).
1882 @c -------------------------
1883 @item mh-decode-mime-flag
1884 On means attachments are handled (default: @samp{on} if the Gnus
1885 @samp{mm-decode} package is present).
1886 @c -------------------------
1887 @item mh-display-buttons-for-alternatives-flag
1888 On means display buttons for all alternative attachments (default:
1889 @samp{off}).
1890 @c -------------------------
1891 @item mh-display-buttons-for-inline-parts-flag
1892 On means display buttons for all inline attachments (default:
1893 @samp{off}).
1894 @c -------------------------
1895 @item mh-do-not-confirm-flag
1896 On means non-reversible commands do not prompt for confirmation
1897 (default: @samp{off}).
1898 @c -------------------------
1899 @item mh-fetch-x-image-url
1900 Control fetching of @samp{X-Image-URL:} header field image (default:
1901 @samp{Never Fetch}).
1902 @c -------------------------
1903 @item mh-graphical-smileys-flag
1904 On means graphical smileys are displayed (default: @samp{on}).
1905 @c -------------------------
1906 @item mh-graphical-emphasis-flag
1907 On means graphical emphasis is displayed (default: @samp{on}).
1908 @c -------------------------
1909 @item mh-highlight-citation-style
1910 Style for highlighting citations (default: @samp{Multicolor}).
1911 @c -------------------------
1912 @item mh-invisible-header-fields-default
1913 List of hidden header fields (default: a checklist too long to list
1914 here).
1915 @c -------------------------
1916 @item mh-invisible-header-fields
1917 Additional header fields to hide (default: @code{nil}).
1918 @c -------------------------
1919 @item mh-lpr-command-format
1920 Command used to print (default: @code{"lpr -J '%s'"}).
1921 @c -------------------------
1922 @item mh-max-inline-image-height
1923 Maximum inline image height if @samp{Content-Disposition:} is not
1924 present (default: 0).
1925 @c -------------------------
1926 @item mh-max-inline-image-width
1927 Maximum inline image width if @samp{Content-Disposition:} is not
1928 present(default: 0).
1929 @c -------------------------
1930 @item mh-mhl-format-file
1931 Specifies the format file to pass to the @command{mhl} program
1932 (default: @samp{Use Default mhl Format (Printing Only)}).
1933 @c -------------------------
1934 @item mh-mime-save-parts-default-directory
1935 Default directory to use for @kbd{K a}.
1936 @c -------------------------
1937 @item mh-print-background-flag
1938 On means messages should be printed in the background (default:
1939 @samp{off}).
1940 @c -------------------------
1941 @item mh-show-buffer-mode-line-buffer-id
1942 Format string to produce @code{mode-line-buffer-identification} for
1943 show buffers (default: @code{" @{show-%s@} %d"}).
1944 @c -------------------------
1945 @item mh-show-maximum-size
1946 Maximum size of message (in bytes) to display automatically (default:
1947 0).
1948 @c -------------------------
1949 @item mh-show-use-xface-flag
1950 On means display face images in MH-Show buffers (default: @samp{on}).
1951 @c -------------------------
1952 @item mh-store-default-directory
1953 Default directory for @kbd{X s} (default: @samp{Current}).
1954 @c -------------------------
1955 @item mh-summary-height
1956 Number of lines in MH-Folder buffer (including the mode line)
1957 (default: depends on size of frame).
1958 @end vtable
1959
1960 The following hooks are available.
1961
1962 @vtable @code
1963 @item mh-delete-msg-hook
1964 Hook run after marking each message for deletion (default: @code{nil}).
1965 @c -------------------------
1966 @item mh-show-hook
1967 Hook run after @key{RET} shows a message (default: @code{nil}).
1968 @c -------------------------
1969 @item mh-show-mode-hook
1970 Hook run upon entry to @code{mh-show-mode} (default: @code{nil}).
1971 @end vtable
1972
1973 The following faces are available.
1974
1975 @vtable @code
1976 @item mh-show-cc
1977 Face used to highlight @samp{cc:} header fields.
1978 @c -------------------------
1979 @item mh-show-date
1980 Face used to highlight @samp{Date:} header fields.
1981 @c -------------------------
1982 @item mh-show-from
1983 Face used to highlight @samp{From:} header fields.
1984 @c -------------------------
1985 @item mh-show-header
1986 Face used to deemphasize less interesting header fields.
1987 @c -------------------------
1988 @item mh-show-pgg-bad
1989 Bad PGG signature face.
1990 @c -------------------------
1991 @item mh-show-pgg-good
1992 Good PGG signature face.
1993 @c -------------------------
1994 @item mh-show-pgg-unknown
1995 Unknown or untrusted PGG signature face.
1996 @c -------------------------
1997 @item mh-show-signature
1998 Signature face.
1999 @c -------------------------
2000 @item mh-show-subject
2001 Face used to highlight @samp{Subject:} header fields.
2002 @c -------------------------
2003 @item mh-show-to
2004 Face used to highlight @samp{To:} header fields.
2005 @c -------------------------
2006 @item mh-show-xface
2007 X-Face image face.
2008 @end vtable
2009
2010 The functions and variables introduced here are explained in more
2011 detail in the following sections.
2012
2013 @menu
2014 * Viewing::
2015 * Viewing Attachments::
2016 * HTML::
2017 * Digests::
2018 * Reading PGP::
2019 * Printing::
2020 * Files and Pipes::
2021 * Navigating::
2022 * Miscellaneous Commands and Options::
2023 @end menu
2024
2025 @node Viewing, Viewing Attachments, Reading Mail, Reading Mail
2026 @section Viewing Your Mail
2027
2028 @findex mh-header-display
2029 @findex mh-page-msg
2030 @findex mh-previous-page
2031 @findex mh-show
2032 @findex mh-show-mouse
2033 @kindex , (comma)
2034 @kindex . (period)
2035 @kindex @key{BS}
2036 @kindex @key{RET}
2037 @kindex @key{SPC}
2038 @kindex Mouse-2
2039
2040 The command @key{RET} (@code{mh-show}) displays the message that the
2041 cursor is on while @kbd{Mouse-2} (@code{mh-show-mouse}) displays the
2042 message that the mouse cursor is on. If the message is already
2043 displayed, it scrolls to the beginning of the message. Use @key{SPC}
2044 (@code{mh-page-msg}) and @key{BS} (@code{mh-previous-page}) to move
2045 forwards and backwards one page at a time through the message. You can
2046 give either of these commands a prefix argument that specifies the
2047 number of lines to scroll (such as @kbd{10 @key{SPC}}). The @key{SPC}
2048 command will also show the next undeleted message if it is used at the
2049 bottom of a message. MH-E normally hides a lot of the superfluous
2050 header fields that mailers add to a message, but if you wish to see
2051 all of them, use the command @kbd{,} (comma;
2052 @code{mh-header-display}).
2053
2054 @vindex mh-show-maximum-size
2055
2056 The option @code{mh-show-maximum-size} provides an opportunity to skip
2057 over large messages which may be slow to load. The default value of 0
2058 means that all message are shown regardless of size.
2059
2060 A litany of options control what displayed messages look like.
2061
2062 @vindex mh-show-cc
2063 @vindex mh-show-date
2064 @vindex mh-show-from
2065 @vindex mh-show-header
2066 @vindex mh-show-subject
2067 @vindex mh-show-to
2068
2069 First, the appearance of the header fields can be modified by
2070 customizing the associated face: @code{mh-show-to}, @code{mh-show-cc},
2071 @code{mh-show-from}, @code{mh-show-date}, and @code{mh-show-subject}.
2072 The face @code{mh-show-header} is used to deemphasize the other, less
2073 interesting, header fields.
2074
2075 @cindex regular expressions, @code{mh-invisible-header-fields}
2076 @vindex mh-clean-message-header-flag
2077 @vindex mh-invisible-header-fields
2078 @vindex mh-invisible-header-fields-default
2079
2080 Normally messages are delivered with a handful of uninteresting header
2081 fields. These are hidden by turning on the option
2082 @code{mh-clean-message-header-flag} (which it is by default). The
2083 header fields listed in the option
2084 @code{mh-invisible-header-fields-default} are hidden, although you can
2085 check off any field that you would like to see. Header fields that you
2086 would like to hide that aren't listed can be added to the option
2087 @code{mh-invisible-header-fields} with a couple of caveats. Regular
2088 expressions are not allowed. Unique fields should have a @samp{:}
2089 suffix; otherwise, the element can be used to render invisible an
2090 entire class of fields that start with the same prefix. If you think a
2091 header field should be generally ignored, please update
2092 @uref{https://sourceforge.net/tracker/index.php?func=detail&aid=1916032&group_id=13357&atid=113357,
2093 SF #1916032}.
2094
2095 @cindex header field, @samp{Face:}
2096 @cindex header field, @samp{X-Face:}
2097 @cindex header field, @samp{X-Image-URL:}
2098 @cindex @samp{Face:} header field
2099 @cindex @samp{X-Face:} header field
2100 @cindex @samp{X-Image-URL:} header field
2101 @vindex mh-show-use-xface-flag
2102
2103 MH-E can display the content of @samp{Face:}, @samp{X-Face:}, and
2104 @samp{X-Image-URL:} header fields. If any of these fields occur in the
2105 header of your message, the sender's face will appear in the
2106 @samp{From:} header field. If more than one of these fields appear,
2107 then the first field found in the order @samp{Face:}, @samp{X-Face:},
2108 and @samp{X-Image-URL:} will be used. The option
2109 @code{mh-show-use-xface-flag} is used to turn this feature on and off.
2110 This feature will be turned on by default if your system supports it.
2111
2112 The first header field used, if present, is the Gnus-specific
2113 @samp{Face:} field@footnote{The @samp{Face:} field appeared in GNU
2114 Emacs 21 and XEmacs. For more information, see
2115 @uref{http://quimby.gnus.org/circus/face/}.}.
2116
2117 @cindex @command{uncompface}
2118 @cindex Emacs, packages, x-face
2119 @cindex Unix commands, @command{uncompface}
2120 @cindex x-face package
2121 @vindex mh-show-xface
2122
2123 Next is the traditional @samp{X-Face:} header field@footnote{The
2124 display of this field requires the
2125 @uref{ftp://ftp.cs.indiana.edu/pub/faces/compface/compface.tar.Z,
2126 @command{uncompface} program}. Recent versions of XEmacs have internal
2127 support for @samp{X-Face:} images. If your version of XEmacs does not,
2128 then you'll need both @command{uncompface} and the
2129 @uref{ftp://ftp.jpl.org/pub/elisp/, @samp{x-face} package}.}. MH-E
2130 renders the foreground and background of the image using the
2131 associated attributes of the face @code{mh-show-xface}.
2132
2133 @cindex @command{convert}
2134 @cindex @command{wget}
2135 @cindex ImageMagick
2136 @cindex Unix commands, @command{convert}
2137 @cindex Unix commands, @command{wget}
2138 @vindex mh-fetch-x-image-url
2139
2140 Finally, MH-E will display images referenced by the
2141 @samp{X-Image-URL:} header field if neither the @samp{Face:} nor the
2142 @samp{X-Face:} fields are present@footnote{The display of the images
2143 requires the @uref{http://www.gnu.org/software/wget/wget.html,
2144 @command{wget} program} to fetch the image and the @command{convert}
2145 program from the @uref{http://www.imagemagick.org/, ImageMagick
2146 suite}.}. Of the three header fields this is the most efficient in
2147 terms of network usage since the image doesn't need to be transmitted
2148 with every single mail. The option @code{mh-fetch-x-image-url}
2149 controls the fetching of the @samp{X-Image-URL:} header field image
2150 with the following values:
2151
2152 @table @samp
2153 @item Ask Before Fetching
2154 You are prompted before the image is fetched. MH-E will remember your
2155 reply and will either use the already fetched image the next time the
2156 same URL is encountered or silently skip it if you didn't fetch it the
2157 first time. This is a good setting.
2158 @c -------------------------
2159 @item Never Fetch
2160 Images are never fetched and only displayed if they are already
2161 present in the cache. This is the default.
2162 @end table
2163
2164 There isn't a value of @samp{Always Fetch} for privacy and DOS (denial
2165 of service) reasons. For example, fetching a URL can tip off a spammer
2166 that you've read his email (which is why you shouldn't blindly answer
2167 yes if you've set this option to @samp{Ask Before Fetching}). Someone
2168 may also flood your network and fill your disk drive by sending a
2169 torrent of messages, each specifying a unique URL to a very large
2170 file.
2171
2172 @cindex @file{.mhe-x-image-cache}
2173 @cindex files, @file{.mhe-x-image-cache}
2174
2175 The cache of images is found in the directory
2176 @file{.mhe-x-image-cache} within your MH directory. You can add your
2177 own face to the @samp{From:} field too. @xref{Picture}.
2178
2179 @cindex @command{mhl}
2180 @cindex MH commands, @command{mhl}
2181 @vindex mh-mhl-format-file
2182
2183 Normally MH-E takes care of displaying messages itself (rather than
2184 calling an MH program to do the work). If you'd rather have
2185 @command{mhl} display the message (within MH-E), change the option
2186 @code{mh-mhl-format-file} from its default value of @samp{Use Default
2187 mhl Format (Printing Only)}. You can set this option to @samp{Use
2188 Default mhl Format} to get the same output as you would get if you ran
2189 @command{mhl} from the shell. If you have a format file that you want
2190 MH-E to use, you can set this option to @samp{Specify an mhl Format
2191 File} and enter the name of your format file (@command{mhl}(1) or
2192 section @uref{@value{MH-BOOK-HOME}/shomes.html#Usisho, Using mhl} in
2193 the MH book tells you how to write one). Your format file should
2194 specify a non-zero value for @samp{overflowoffset} to allow MH-E to
2195 parse the header. Note that @command{mhl} is always used for printing
2196 and forwarding; in this case, the value of @code{mh-mhl-format-file}
2197 is consulted if you have specified a format file.
2198
2199 @cindex citations, highlighting
2200 @cindex highlighting citations
2201 @vindex mh-highlight-citation-style
2202
2203 If the sender of the message has cited other messages in his message,
2204 then MH-E will highlight these citations to emphasize the sender's
2205 actual response. The option @code{mh-highlight-citation-style} can be
2206 customized to change the highlighting style. The @samp{Multicolor}
2207 method uses a different color for each indentation while the
2208 @samp{Monotone} method highlights all citations in red. To disable
2209 highlighting of citations entirely, choose @samp{None}.
2210
2211 @cindex URLs, highlighting
2212 @cindex email addresses, highlighting
2213 @cindex highlighting URLs
2214 @cindex highlighting email addresses
2215 @cindex links, following
2216 @findex goto-address-at-point
2217 @kindex C-c @key{RET}
2218 @kindex Mouse-2
2219 @vindex goto-address-highlight-p
2220
2221 Email addresses and URLs in the message are highlighted if the option
2222 @code{goto-address-highlight-p} is on, which it is by default. To view
2223 the web page for a highlighted URL or to send a message using a
2224 highlighted email address, use @kbd{Mouse-2} or @kbd{C-c @key{RET}}
2225 (@code{goto-address-at-point}). @xref{Sending Mail}, to see how to
2226 configure Emacs to send the message using MH-E.
2227
2228 @cindex boldface, showing
2229 @cindex emphasis
2230 @cindex italics, showing
2231 @cindex smileys
2232 @cindex typesetting
2233 @cindex underline, showing
2234 @vindex gnus-emphasis-alist
2235 @vindex mh-decode-mime-flag
2236 @vindex mh-graphical-emphasis-flag
2237 @vindex mh-graphical-smileys-flag
2238
2239 It is a long standing custom to inject body language using a
2240 cornucopia of punctuation, also known as the @dfn{smileys}. MH-E can
2241 render these as graphical widgets if the option
2242 @code{mh-graphical-smileys-flag} is turned on, which it is by default.
2243 Smileys include patterns such as :-) and ;-). Similarly, a few
2244 typesetting features are indicated in ASCII text with certain
2245 characters. If your terminal supports it, MH-E can render these
2246 typesetting directives naturally if the option
2247 @code{mh-graphical-emphasis-flag} is turned on, which it is by
2248 default. For example, _underline_ will be
2249 @ifhtml
2250 @html
2251 <u>underlined</u>,
2252 @end html
2253 @end ifhtml
2254 @ifnothtml
2255 underlined,
2256 @end ifnothtml
2257 *bold* will appear in @b{bold}, /italics/ will appear in @i{italics},
2258 and so on. See the option @code{gnus-emphasis-alist} for the whole
2259 list. Both of these options are disabled if the option
2260 @code{mh-decode-mime-flag} is turned off. @xref{Viewing Attachments}.
2261
2262 @cindex signature separator
2263 @cindex vCard
2264 @vindex mh-show-signature
2265
2266 MH-E normally renders signatures and vCards in italics so that the
2267 body of the message stands out more. MH-E depends on the presence of
2268 the @dfn{signature separator} (@code{"-- "}) to do this. You can also
2269 customize the face @code{mh-show-signature} so the appearance of the
2270 signature block is more to your liking.
2271
2272 @vindex mh-show-hook
2273 @vindex mh-show-mode-hook
2274
2275 Two hooks can be used to control how messages are displayed. The first
2276 hook, @code{mh-show-mode-hook}, is called early on in the process of
2277 the message display. It is usually used to perform some action on the
2278 message's content. The second hook, @code{mh-show-hook}, is the last
2279 thing called after messages are displayed. It's used to affect the
2280 behavior of MH-E in general or when @code{mh-show-mode-hook} is too
2281 early.
2282
2283 @cindex MH-Show mode
2284 @cindex modes, MH-Show
2285 @vindex mh-show-buffer-mode-line-buffer-id
2286
2287 For those who like to modify their mode lines, use
2288 @code{mh-show-buffer-mode-line-buffer-id} to modify the mode line in
2289 the MH-Show buffers. Place the two escape strings @samp{%s} and
2290 @samp{%d}, which will display the folder name and the message number,
2291 respectively, somewhere in the string in that order. The default value
2292 of @code{"@{show-%s@} %d"} yields a mode line of
2293
2294 @smallexample
2295 -----@{show-+inbox@} 4 (MH-Show)--Bot--------------------------------
2296 @end smallexample
2297
2298 @node Viewing Attachments, HTML, Viewing, Reading Mail
2299 @section Viewing Attachments
2300
2301 @cindex attachments
2302 @cindex body parts
2303 @cindex @command{mhshow}
2304 @cindex @command{show}
2305 @cindex MH commands, @command{mhshow}
2306 @cindex MH commands, @command{show}
2307 @cindex MIME
2308 @cindex multimedia mail
2309
2310 MH has the ability to display @dfn{@sc{mime}} (Multipurpose Internet
2311 Mail Extensions) messages which are simply messages with additional
2312 @dfn{body parts} or @dfn{attachments}. You can use the MH commands
2313 @command{show}@footnote{See the section
2314 @uref{@value{MH-BOOK-HOME}/reapre.html, Reading Mail: inc show next
2315 prev} in the MH book.} or @command{mhshow}@footnote{See the section
2316 @uref{@value{MH-BOOK-HOME}/usimim.html#ReMIMa, Reading MIME Mail} in
2317 the MH book.} from the shell to read @sc{mime} messages@footnote{You
2318 can call them directly from Emacs if you're running the X Window
2319 System: type @kbd{M-! xterm -e mhshow @var{message-number}}. You can
2320 leave out the @samp{xterm -e} if you use @command{mhlist} or
2321 @command{mhstore}.}.
2322
2323 @cindex Emacs, packages, mm-decode
2324 @cindex mm-decode package
2325 @findex mh-toggle-mh-decode-mime-flag
2326 @kindex ; (semicolon)
2327 @vindex mh-decode-mime-flag
2328
2329 MH-E can handle attachments as well if the Gnus @samp{mm-decode}
2330 package is present. If so, the option @code{mh-decode-mime-flag} will
2331 be on. Otherwise, you'll see the @sc{mime} body parts rather than text
2332 or attachments. There isn't much point in turning off the option
2333 @code{mh-decode-mime-flag}; however, you can inspect it if it appears
2334 that the body parts are not being interpreted correctly or toggle it
2335 with the command @kbd{;} (semicolon;
2336 @code{mh-toggle-mh-decode-mime-flag}) to view the raw message. This
2337 option also controls the display of quoted-printable messages and
2338 other graphical widgets. @xref{Viewing}.
2339
2340 @cindex buttons
2341
2342 Attachments in MH-E are indicated by @dfn{buttons} like this:
2343
2344 @smallexample
2345 [1. image/jpeg; foo.jpg]...
2346 @end smallexample
2347
2348 @findex mh-next-button
2349 @findex mh-press-button
2350 @findex mh-prev-button
2351 @kindex @key{RET}
2352 @kindex K @key{TAB}
2353 @kindex K S-@key{TAB}
2354 @kindex Mouse-1
2355 @kindex Mouse-2
2356
2357 To view the contents of the button, use either @kbd{Mouse-1} or
2358 @kbd{Mouse-2} on the button or @key{RET} (@code{mh-press-button}) when
2359 the cursor is over the button. This command is a toggle so if you use
2360 it again on the same attachment, it is hidden. If Emacs does not know
2361 how to display the attachment, then Emacs offers to save the
2362 attachment in a file. To move the cursor to the next button, use the
2363 command @kbd{K @key{TAB}} (@code{mh-next-button}). If the end of the
2364 buffer is reached then the search wraps over to the start of the
2365 buffer. To move the cursor to the previous button, use the command
2366 @kbd{K S-@key{TAB}} (@code{mh-prev-button}). If the beginning of the
2367 buffer is reached then the search wraps over to the end of the buffer.
2368
2369 @cindex attachments, viewing
2370 @cindex viewing attachments
2371 @findex mh-folder-toggle-mime-part
2372 @kindex K v
2373
2374 Another way to view the contents of a button is to use the command
2375 @kbd{K v} (@code{mh-folder-toggle-mime-part}). This command displays
2376 (or hides) the attachment associated with the button under the cursor.
2377 If the cursor is not located over a button, then the cursor first
2378 moves to the next button, wrapping to the beginning of the message if
2379 necessary. This command has the advantage over the previous commands
2380 of working from the MH-Folder buffer. You can also provide a numeric
2381 prefix argument (as in @kbd{4 K v}) to view the attachment labeled
2382 with that number. If Emacs does not know how to display the
2383 attachment, then Emacs offers to save the attachment in a file.
2384
2385 @cindex @file{/etc/mailcap}
2386 @cindex files, @file{/etc/mailcap}
2387 @findex mailcap-mime-info
2388 @findex mh-display-with-external-viewer
2389 @kindex K e
2390
2391 If Emacs does not know how to view an attachment, you could save it
2392 into a file and then run some program to open it. It is easier,
2393 however, to launch the program directly from MH-E with the command
2394 @kbd{K e} (@code{mh-display-with-external-viewer}). While you'll most
2395 likely use this to view spreadsheets and documents, it is also useful
2396 to use your browser to view HTML attachments with higher fidelity than
2397 what Emacs can provide. This command displays the attachment
2398 associated with the button under the cursor. If the cursor is not
2399 located over a button, then the cursor first moves to the next button,
2400 wrapping to the beginning of the message if necessary. You can provide
2401 a numeric prefix argument (as in @kbd{4 K e}) to view the attachment
2402 labeled with that number. This command tries to provide a reasonable
2403 default for the viewer by calling the Emacs function
2404 @code{mailcap-mime-info}. This function usually reads the file
2405 @file{/etc/mailcap}.
2406
2407 @cindex attachments, saving
2408 @cindex saving attachments
2409 @findex mh-folder-save-mime-part
2410 @kindex K o
2411
2412 Use the command @kbd{K o} (@code{mh-folder-save-mime-part}) to save
2413 attachments (the mnemonic is ``output''). This command saves the
2414 attachment associated with the button under the cursor. If the cursor
2415 is not located over a button, then the cursor first moves to the next
2416 button, wrapping to the beginning of the message if necessary. You can
2417 also provide a numeric prefix argument (as in @kbd{3 K o}) to save the
2418 attachment labeled with that number. This command prompts you for a
2419 filename and suggests a specific name if it is available.
2420
2421 @cindex @command{mhn}
2422 @cindex @command{mhstore}
2423 @cindex MH commands, @command{mhn}
2424 @cindex MH commands, @command{mhstore}
2425 @findex mh-mime-save-parts
2426 @kindex K a
2427 @vindex mh-mime-save-parts-default-directory
2428
2429 You can save all of the attachments at once with the command @kbd{K a}
2430 (@code{mh-mime-save-parts}). The attachments are saved in the
2431 directory specified by the option
2432 @code{mh-mime-save-parts-default-directory} unless you use a prefix
2433 argument (as in @kbd{C-u K a}) in which case you are prompted for the
2434 directory. These directories may be superseded by MH profile
2435 components, since this function calls on @command{mhstore}
2436 (@command{mhn}) to do the work.
2437
2438 @vindex mh-mime-save-parts-default-directory
2439
2440 The default value for the option
2441 @code{mh-mime-save-parts-default-directory} is @samp{Prompt Always} so
2442 that you are always prompted for the directory in which to save the
2443 attachments. However, if you usually use the same directory within a
2444 session, then you can set this option to @samp{Prompt the First Time}
2445 to avoid the prompt each time. you can make this directory permanent
2446 by choosing @samp{Directory} and entering the directory's name.
2447
2448 @cindex attachments, inline
2449 @cindex inline attachments
2450 @findex mh-toggle-mime-buttons
2451 @kindex K t
2452 @vindex mh-display-buttons-for-inline-parts-flag
2453
2454 The sender can request that attachments should be viewed inline so
2455 that they do not really appear like an attachment at all to the
2456 reader. Most of the time, this is desirable, so by default MH-E
2457 suppresses the buttons for inline attachments. On the other hand, you
2458 may receive code or HTML which the sender has added to his message as
2459 inline attachments so that you can read them in MH-E. In this case, it
2460 is useful to see the buttons so that you know you don't have to cut
2461 and paste the code into a file; you can simply save the attachment. If
2462 you want to make the buttons visible for inline attachments, you can
2463 use the command @kbd{K t} (@code{mh-toggle-mime-buttons}) to toggle
2464 the visibility of these buttons. You can turn on these buttons
2465 permanently by turning on the option
2466 @code{mh-display-buttons-for-inline-parts-flag}.
2467
2468 MH-E cannot display all attachments inline however. It can display
2469 text (including @sc{html}) and images.
2470
2471 @cindex header field, @samp{Content-Disposition:}
2472 @cindex inline images
2473 @cindex @samp{Content-Disposition:} header field
2474 @vindex mh-max-inline-image-height
2475 @vindex mh-max-inline-image-width
2476
2477 Some older mail programs do not insert the needed
2478 plumbing@footnote{This plumbing is the @samp{Content-Disposition:}
2479 header field.} to tell MH-E whether to display the attachments inline
2480 or not. If this is the case, MH-E will display these images inline if
2481 they are smaller than the window. However, you might want to allow
2482 larger images to be displayed inline. To do this, you can change the
2483 options @code{mh-max-inline-image-width} and
2484 @code{mh-max-inline-image-height} from their default value of zero to
2485 a large number. The size of your screen is a good choice for these
2486 numbers.
2487
2488 @cindex alternatives
2489 @cindex attachments, alternatives
2490 @vindex mh-display-buttons-for-alternatives-flag
2491
2492 Sometimes, a mail program will produce multiple alternatives of an
2493 attachment in increasing degree of faithfulness to the original
2494 content. By default, only the preferred alternative is displayed. If
2495 the option @code{mh-display-buttons-for-alternatives-flag} is on, then
2496 the preferred part is shown inline and buttons are shown for each of
2497 the other alternatives.
2498
2499 @vindex mm-discouraged-alternatives
2500
2501 Many people prefer to see the @samp{text/plain} alternative rather
2502 than the @samp{text/html} alternative. To do this in MH-E, customize
2503 the option @code{mm-discouraged-alternatives}, and add
2504 @samp{text/html}. The next best alternative, if any, will be shown.
2505
2506 @findex mh-show-preferred-alternative
2507 @kindex : (colon)
2508
2509 Occasionally, though, you might want to see the preferred alternative.
2510 The command @kbd{:} (@code{mh-show-preferred-alternative}) displays
2511 the message with the default preferred alternative. This is as if
2512 @code{mm-discouraged-alternatives} is set to @samp{nil}. Use the
2513 command @key{RET} (@code{mh-show}) to show the message normally again.
2514
2515 @kindex K i
2516 @findex mh-folder-inline-mime-part
2517
2518 You can view the raw contents of an attachment with the command @kbd{K
2519 i} (@code{mh-folder-inline-mime-part}). This command displays (or
2520 hides) the contents of the attachment associated with the button under
2521 the cursor verbatim. If the cursor is not located over a button, then
2522 the cursor first moves to the next button, wrapping to the beginning
2523 of the message if necessary. You can also provide a numeric prefix
2524 argument (as in @kbd{4 K i}) to view the attachment labeled with that
2525 number.
2526
2527 For additional information on buttons, see
2528 @ifinfo
2529 @ref{Article Buttons,,,gnus}, and @ref{MIME Commands,,,gnus}.
2530 @end ifinfo
2531 @ifnotinfo
2532 the chapters @uref{http://www.gnus.org/manual/gnus_101.html#SEC101,
2533 Article Buttons} and
2534 @uref{http://www.gnus.org/manual/gnus_108.html#SEC108, MIME Commands}
2535 in the @cite{The Gnus Manual}.
2536 @end ifnotinfo
2537
2538 @node HTML, Digests, Viewing Attachments, Reading Mail
2539 @section HTML
2540
2541 @cindex HTML
2542 @cindex Gnus
2543
2544 MH-E can display messages that have been sent in HTML@footnote{This
2545 feature depends on a version of Gnus that is at least 5.10.}. The
2546 content of the message will appear in the MH-Show buffer as you would
2547 expect if the entire message is HTML, or there is an inline HTML body
2548 part. However, if there is an HTML body part that is an attachment,
2549 then you'll see a button like this:
2550
2551 @smallexample
2552 [1. text/html; foo.html]...
2553 @end smallexample
2554
2555 To see how to read the contents of this body part, see @ref{Viewing
2556 Attachments}.
2557
2558 @vindex mm-text-html-renderer
2559
2560 The browser that MH-E uses is determined by the option
2561 @code{mm-text-html-renderer}. The default setting is set automatically
2562 based upon the presence of a known browser on your system. If you wish
2563 to use a different browser, then set this option accordingly. See the
2564 documentation for the browser you use for additional information on
2565 how to use it. In particular, find and disable the option to render
2566 images as this can tip off spammers that the email address they have
2567 used is valid.
2568
2569 @vindex mm-text-html-renderer
2570
2571 If you're confused about which @code{mm-text-html-renderer} to use,
2572 here's a brief description of each, sorted by popularity, that
2573 includes the results of a quick poll of MH-E users from 2005-12-23.
2574
2575 @table @asis
2576 @cindex browser, @samp{w3m}
2577 @cindex @samp{w3m}
2578 @kindex Mouse-2
2579 @item @samp{w3m} 7
2580 The @samp{w3m} browser requires an external program. It's quick,
2581 produces pretty nice output, and best of all, it's the only browser
2582 that highlights links. These can be clicked with @kbd{Mouse-2} to view
2583 the content of the link in @samp{w3m}. The @samp{w3m} browser handles
2584 tables well and actually respects the table's width parameter (which
2585 can cause text to wrap if the author didn't anticipate that the page
2586 would be viewed in Emacs).
2587 @c -------------------------
2588 @cindex browser, @samp{w3m-standalone}
2589 @cindex @samp{w3m-standalone}
2590 @item @samp{w3m-standalone} 3
2591 This browser, along with @samp{nil} for the external browser, are the
2592 only choices that work without having to download a separate lisp
2593 package or external program. This browser is quick, but does not show
2594 links. It handles simple tables but some tables get rendered much
2595 wider than the Emacs frame. This browser was the only one not to
2596 handle the escape @samp{&ndash;} (it printed a @samp{?}), but it did
2597 render @samp{&reg;}.
2598 @c -------------------------
2599 @cindex browser, @samp{links}
2600 @cindex @samp{links}
2601 @item @samp{links} 1
2602 The @samp{links} browser requires an external program. It's quick, and
2603 produces nicer output than @samp{lynx} on single column mails in
2604 tables. However, it doesn't show links and it doesn't do as nice a job
2605 on multi-column tables as some lines wrap. At least it fits in 80
2606 columns and thus seems better than @samp{w3} and
2607 @samp{w3m-standalone}. Converts escapes such as @samp{&reg;} to (R).
2608 @c -------------------------
2609 @cindex browser, @samp{lynx}
2610 @cindex @samp{lynx}
2611 @item @samp{lynx} 1
2612 The @samp{lynx} browser requires an external program. It's quick and
2613 produces pretty decent output but it doesn't show links. It doesn't
2614 seem to do multi-column tables which makes output much cleaner. It
2615 centers the output and wraps long lines more than most. Handles
2616 @samp{&reg;}.
2617 @c -------------------------
2618 @item @samp{nil} 1
2619 This choice obviously requires an external browser. Like
2620 @samp{w3m-standalone}, it works out of the box. With this setting,
2621 HTML messages have a button for the body part which you can view with
2622 @kbd{K v} (@code{mh-folder-toggle-mime-part}).
2623 @c -------------------------
2624 @cindex browser, @samp{w3}
2625 @cindex @samp{w3}
2626 @item @samp{w3} 0
2627 This choice does not require an external program as all of the
2628 rendering is done in lisp. You do need to get the package separately.
2629 This browser is @strong{slow}, and doesn't appear to have been updated
2630 since 2001 and the author hasn't responded to my emails. It displays
2631 unknown tags instead of hiding them, so you get to see all the
2632 Microsoft crap in certain messages. Tends to make multi-column tables
2633 wider than even a full-screen Emacs can handle. Like @samp{w3m}, you
2634 can follow links, but you have to find them first as they are not
2635 highlighted. Performs well on single-column tables and handles escapes
2636 such as @samp{&reg;}.
2637 @c -------------------------
2638 @cindex browser, @samp{html2text}
2639 @cindex @samp{html2text}
2640 @item @samp{html2text} 0
2641 The @samp{html2text} browser requires an external program. I noticed
2642 that it can do some nasty things with simple HTML mails (like filling
2643 the entire message as if it were one paragraph, including signature).
2644 On another message, it displayed half of the HTML tags for some
2645 reason.
2646 @end table
2647
2648 @vindex mm-text-html-renderer
2649
2650 For a couple more sources of information about
2651 @code{mm-text-html-renderer},
2652 @ifinfo
2653 @xref{Display Customization,,,emacs-mime}, and the documentation for
2654 the Gnus command @kbd{W h} (@pxref{Article Washing,,,gnus},).
2655 @end ifinfo
2656 @ifnotinfo
2657 see section @uref{http://www.gnus.org/manual/emacs-mime_6.html,
2658 Display Customization} in the @cite{The Emacs MIME Manual} and the
2659 documentation for the Gnus command @kbd{W h} (see section
2660 @uref{http://www.gnus.org/manual/gnus_99.html, Article Washing} in the
2661 @cite{The Gnus Manual}).
2662 @end ifnotinfo
2663
2664 @cindex @file{.emacs}
2665 @cindex files, @file{.emacs}
2666 @findex browse-url-at-mouse
2667 @kindex S-Mouse-2
2668
2669 A useful key binding that you can add to @file{~/.emacs} is the
2670 following which displays an HTML link or textual URL in an external
2671 browser when clicked with @kbd{S-mouse-2}. This binding works in any
2672 buffer, including HTML buffers.
2673
2674 @smalllisp
2675 (global-set-key [S-mouse-2] 'browse-url-at-mouse)
2676 @end smalllisp
2677
2678 @node Digests, Reading PGP, HTML, Reading Mail
2679 @section Digests
2680
2681 @cindex digests
2682 @findex mh-page-digest
2683 @findex mh-page-digest-backwards
2684 @kindex D @key{BS}
2685 @kindex D @key{SPC}
2686 @kindex @key{BS}
2687 @kindex @key{SPC}
2688
2689 A digest is a message that contains other messages. Special MH-E
2690 commands let you read digests conveniently. You can use @key{SPC} and
2691 @key{BS} to page through the digest as if it were a normal message,
2692 but if you wish to skip to the next message in the digest, use
2693 @kbd{D @key{SPC}} (@code{mh-page-digest}). To return to a previous message,
2694 use @kbd{D @key{BS}} (@code{mh-page-digest-backwards}).
2695
2696 @cindex @command{burst}
2697 @cindex MH commands, @command{burst}
2698 @cindex MH-Folder Show mode
2699 @cindex modes, MH-Folder Show
2700 @findex mh-burst-digest
2701 @kindex d
2702 @kindex D b
2703 @kindex t
2704
2705 Another handy command is @kbd{D b} (@code{mh-burst-digest}). This
2706 command uses the MH command @command{burst}@footnote{See the section
2707 @uref{@value{MH-BOOK-HOME}/burdig.html, Bursting Messages} in the MH
2708 book.} to break out each message in the digest into its own message.
2709 Using this command, you can quickly delete unwanted messages, like
2710 this: Once the digest is split up, toggle out of MH-Folder Show mode
2711 with @kbd{t} (@pxref{Folders}) so that the scan lines fill the screen
2712 and messages aren't displayed. Then use @kbd{d} (@pxref{Reading Mail})
2713 to quickly delete messages that you don't want to read (based on the
2714 @samp{Subject:} header field). You can also burst the digest to reply
2715 directly to the people who posted the messages in the digest. One
2716 problem you may encounter is that the @samp{From:} header fields are
2717 preceded with a @samp{>} so that your reply can't create the
2718 @samp{To:} field correctly. In this case, you must correct the
2719 @samp{To:} field yourself. This is described later (@pxref{Editing
2720 Drafts}).
2721
2722 @node Reading PGP, Printing, Digests, Reading Mail
2723 @section Signed and Encrypted Messages
2724
2725 @cindex GPG
2726 @cindex GnuPG
2727 @cindex Gnus
2728 @cindex OpenPGP
2729 @cindex PGP
2730 @cindex RFC 3156
2731 @cindex encrypted messages
2732 @cindex security
2733 @cindex signed messages
2734
2735 You can read encrypted or signed PGP or GPG messages with
2736 MH-E@footnote{This feature depends on post-5.10 versions of Gnus.
2737 @cite{MIME Security with OpenPGP} is documented in
2738 @uref{http://www.rfc-editor.org/rfc/rfc3156.txt, RFC 3156}. However,
2739 MH-E can also decrypt old-style PGP messages that are not in MIME
2740 format.}. This section assumes that you already have a good
2741 understanding of GPG and have set up your keys appropriately.
2742
2743 If someone sends you a signed message, here is what you'll see:
2744
2745 @smallexample
2746 @group
2747 [[PGP Signed Part:Bill Wohler <wohler@@stop.mail-abuse.org>]]
2748 This is a signed message.
2749
2750 [[End of PGP Signed Part]]
2751 @end group
2752 @end smallexample
2753
2754 @cindex keychain
2755 @cindex key server
2756 @cindex signed messages
2757
2758 If the key for the given signature is not in your keychain, you'll be
2759 given the opportunity to fetch the key from a key server and verify
2760 the key. If the message is really large, the verification process can
2761 take a long time. You can press @kbd{C-g} at any time to
2762 cancel@footnote{Unfortunately in the current version, the validation
2763 process doesn't display a message so it appears that MH-E has hung. We
2764 hope that this will be fixed in the future.}.
2765
2766 If the signature doesn't check out, you might see something like this:
2767
2768 @smallexample
2769 @group
2770 [[PGP Signed Part:Failed]]
2771 This is a signed message.
2772 This is garbage added after the signature was made.
2773
2774 [[End of PGP Signed Part]]
2775 @end group
2776 @end smallexample
2777
2778 @cindex decrypting messages
2779
2780 If someone sends you an encrypted message, MH-E will ask for your
2781 passphrase to decrypt the message. You should see something like this:
2782
2783 @smallexample
2784 @group
2785 [[PGP Encrypted Part:OK]]
2786
2787 [[PGP Signed Part:Bill Wohler <wohler@@stop.mail-abuse.org>]]
2788 This is the secret message.
2789
2790 [[End of PGP Signed Part]]
2791
2792 [[End of PGP Encrypted Part]]
2793 @end group
2794 @end smallexample
2795
2796 If there is a problem decrypting the message, the button will say:
2797
2798 @smallexample
2799 [[PGP Encrypted Part:Failed]]
2800 @end smallexample
2801
2802 You can read the contents of this button using the methods described in
2803 @ref{Viewing Attachments}. If the message were corrupted, you'd see
2804 this:
2805
2806 @smallexample
2807 [[PGP Encrypted Part:Failed]
2808 Invalid base64 data]
2809 @end smallexample
2810
2811 If your passphrase were incorrect, you'd see something like this:
2812
2813 @smallexample
2814 [GNUPG:] ENC_TO CD9C88BB610BD9AD 1 0
2815 [GNUPG:] USERID_HINT CD9C88BB610BD9AD Bill Wohler <wohler@@stop.mail-abuse.org>
2816 [GNUPG:] NEED_PASSPHRASE CD9C88BB610BD9AD CD9C88BB610BD9AD 1 0
2817 [GNUPG:] BAD_PASSPHRASE CD9C88BB610BD9AD
2818 gpg: encrypted with 1024-bit RSA key, ID 610BD9AD, created 1997-09-09
2819 "Bill Wohler <wohler@@stop.mail-abuse.org>"
2820 gpg: public key decryption failed: bad passphrase
2821 [GNUPG:] BEGIN_DECRYPTION
2822 [GNUPG:] DECRYPTION_FAILED
2823 gpg: decryption failed: secret key not available
2824 [GNUPG:] END_DECRYPTION
2825
2826 gpg exited abnormally: '2'
2827 @end smallexample
2828
2829 @vindex mh-show-pgg-bad
2830 @vindex mh-show-pgg-good
2831 @vindex mh-show-pgg-unknown
2832
2833 The appearance of the buttons is controlled by the faces
2834 @code{mh-show-pgg-good}, @code{mh-show-pgg-bad}, and
2835 @code{mh-show-pgg-unknown} depending on the validity of the signature.
2836 The latter is used whether the signature is unknown or untrusted.
2837
2838 @cindex @samp{pgg} customization group
2839 @cindex PGG
2840 @cindex customization group, @samp{pgg}
2841
2842 The @samp{pgg} customization group may have some settings which may
2843 interest you.
2844 @iftex
2845 See @cite{The PGG Manual}.
2846 @end iftex
2847 @ifinfo
2848 @xref{Top, , The PGG Manual, pgg, The PGG Manual}.
2849 @end ifinfo
2850 @ifhtml
2851 See
2852 @uref{http://www.dk.xemacs.org/Documentation/packages/html/pgg.html,
2853 @cite{The PGG Manual}}.
2854 @end ifhtml
2855
2856 @node Printing, Files and Pipes, Reading PGP, Reading Mail
2857 @section Printing Your Mail
2858
2859 @cindex printing
2860 @findex mh-ps-print-msg
2861 @findex mh-ps-print-msg-file
2862 @kindex P f
2863 @kindex P p
2864 @vindex mh-lpr-command-format
2865 @vindex mh-print-background-flag
2866
2867 To print messages in MH-E, use the command @kbd{P p}
2868 (@code{mh-ps-print-msg}). You can print all the messages in a range
2869 (as in @kbd{C-u P p 1 3 5-7 last:5 frombob @key{RET}},
2870 @pxref{Ranges}). You can also send the output to a file with @kbd{P f}
2871 (@code{mh-ps-print-msg-file}). This command will print inline text
2872 attachments but will not decrypt messages. However, when a message is
2873 displayed in an MH-Show buffer, then that buffer is used verbatim for
2874 printing with the caveat that only text attachments, if opened inline,
2875 are printed. Therefore, encrypted messages can be printed by showing
2876 and decrypting them first. The commands @kbd{P p} and @kbd{P f} do not
2877 use the options @code{mh-lpr-command-format} or
2878 @code{mh-print-background-flag}, described below.
2879
2880 @findex mh-ps-print-toggle-color
2881 @kindex P C
2882 @vindex ps-print-color-p
2883
2884 Colors are emulated on black-and-white printers with shades of gray.
2885 This might produce illegible output, even if your screen colors only
2886 use shades of gray. If this is the case, try using the command @kbd{P
2887 C} (@code{mh-ps-print-toggle-color}) to toggle between color, no
2888 color, and a black and white representation of the colors and see
2889 which works best. You change this setting permanently by customizing
2890 the option @code{ps-print-color-p}.
2891
2892 @findex mh-ps-print-toggle-faces
2893 @kindex P F
2894
2895 Another related function is the command @kbd{P F}
2896 (@code{mh-ps-print-toggle-faces}). This command toggles between using
2897 faces and not. When faces are enabled, the printed message will look
2898 very similar to the message in the MH-Show buffer.
2899
2900 @cindex ps-print package
2901 @cindex Emacs, packages, ps-print
2902
2903 MH-E uses the @samp{ps-print} package to do the printing, so you can
2904 customize the printing further by going to the @samp{ps-print}
2905 customization group.
2906
2907 @cindex @command{lpr}
2908 @cindex @command{mhl}
2909 @cindex MH commands, @command{mhl}
2910 @cindex Unix commands, @command{lpr}
2911 @findex mh-print-msg
2912 @kindex P l
2913
2914 An alternative to using the @samp{ps-print} package is the command
2915 @kbd{P l} (@code{mh-print-msg}) (the @i{l} is for @i{l}ine printer or
2916 @i{l}pr). You can print all the messages in a range. The message is
2917 formatted with @command{mhl}@footnote{See the section
2918 @uref{@value{MH-BOOK-HOME}/shomes.html#Usisho, Using mhl} in the MH
2919 book.} and printed with the @command{lpr} command.
2920
2921 @kindex P f
2922 @kindex P l
2923 @kindex P p
2924 @vindex mh-lpr-command-format
2925 @vindex mh-print-background-flag
2926
2927 The command @kbd{P l} uses two options. The option
2928 @code{mh-lpr-command-format} contains the Unix command line which
2929 performs the actual printing. The string can contain one escape,
2930 @samp{%s}, which is replaced by the name of the folder and the message
2931 number and is useful for print job names. The default setting is
2932 @code{"lpr -J '%s'"}. I use @code{"mpage -h'%s' -b Letter -H1of -mlrtb
2933 -P"} which produces a nice header and adds a bit of margin so the text
2934 fits within my printer's margins. Normally messages are printed in the
2935 foreground. If this is slow on your system, you may elect to turn on
2936 the option @code{mh-print-background-flag} to print in the background.
2937 If you do this, do not delete the message until it is printed or else
2938 the output may be truncated. These options are not used by the
2939 commands @kbd{P p} or @kbd{P f}.
2940
2941 @node Files and Pipes, Navigating, Printing, Reading Mail
2942 @section Files and Pipes
2943
2944 @cindex files
2945 @cindex pipes
2946 @findex mh-refile-or-write-again
2947 @findex mh-write-msg-to-file
2948 @kindex >
2949 @kindex !
2950
2951 MH-E does offer a couple of commands that are not a part of MH@. The
2952 first one, @kbd{>} (@code{mh-write-msg-to-file}), writes a message to
2953 a file. You are prompted for the filename. If the file already exists,
2954 the message is appended to it. You can also write the message to the
2955 file without the header by specifying a prefix argument (such as
2956 @kbd{C-u > /tmp/foobar @key{RET}}). Subsequent writes to the same file
2957 can be made with the command @kbd{!}
2958 (@code{mh-refile-or-write-again}).
2959
2960 @findex mh-pipe-msg
2961 @kindex |
2962 @kindex l
2963
2964 You can also pipe the message through a Unix shell command with the
2965 command @kbd{|} (@code{mh-pipe-msg}). You are prompted for the Unix
2966 command through which you wish to run your message. If you give a
2967 prefix argument to this command, the message header is included in the
2968 text passed to the command (the contrived example @kbd{C-u | lpr}
2969 would be done with the @kbd{l} command instead).
2970
2971 @cindex @command{shar}
2972 @cindex @command{uuencode}
2973 @cindex Unix commands, @command{shar}
2974 @cindex Unix commands, @command{uuencode}
2975 @findex mh-store-msg
2976 @kindex X s
2977 @vindex mh-store-default-directory
2978
2979 If the message is a shell archive @command{shar} or has been run
2980 through @command{uuencode} use @kbd{X s} (@code{mh-store-msg}) to
2981 extract the body of the message. The default directory for extraction
2982 is the current directory; however, you have a chance to specify a
2983 different extraction directory. The next time you use this command,
2984 the default directory is the last directory you used. If you would
2985 like to change the initial default directory, customize the option
2986 @code{mh-store-default-directory}, change the value from
2987 @samp{Current} to @samp{Directory}, and then enter the name of the
2988 directory for storing the content of these messages.
2989
2990 @findex mh-store-buffer
2991 @kindex @key{RET}
2992 @kindex X s
2993
2994 By the way, @kbd{X s} calls the Emacs Lisp function
2995 @code{mh-store-buffer}. I mention this because you can use it directly
2996 if you're editing a buffer that contains a file that has been run
2997 through @command{uuencode} or @command{shar}. For example, you can
2998 extract the contents of the current buffer in your home directory by
2999 typing @kbd{M-x mh-store-buffer @key{RET} ~ @key{RET}}.
3000
3001 @node Navigating, Miscellaneous Commands and Options, Files and Pipes, Reading Mail
3002 @section Navigating
3003
3004 @cindex moving between messages
3005 @cindex navigation
3006 @findex mh-first-msg
3007 @findex mh-goto-msg
3008 @findex mh-last-msg
3009 @findex mh-next-undeleted-msg
3010 @findex mh-next-unread-msg
3011 @findex mh-previous-undeleted-msg
3012 @findex mh-previous-unread-msg
3013 @kindex g
3014 @kindex M-<
3015 @kindex M->
3016 @kindex M-n
3017 @kindex M-p
3018 @kindex n
3019 @kindex p
3020
3021 To move on to the next message, use the command @kbd{n}
3022 (@code{mh-next-undeleted-msg}); use @kbd{p}
3023 (@code{mh-previous-undeleted-msg}) to read the previous message. To
3024 move to the next unread message, use @kbd{M-n}
3025 (@code{mh-next-unread-msg}); use @kbd{M-p}
3026 (@code{mh-previous-unread-msg}) to move to the previous unread
3027 message. These commands can be given a prefix argument to specify how
3028 many messages to skip (for example, @kbd{5 n}). You can also move to a
3029 specific message with @kbd{g} (@code{mh-goto-msg}). You can enter the
3030 message number either before or after typing @kbd{g}. In the latter
3031 case, Emacs prompts you. Finally, you can go to the first or last
3032 message with @kbd{M-<} (@code{mh-first-msg}) and @kbd{M->}
3033 (@code{mh-last-msg}) respectively.
3034
3035 @cindex MH-Folder mode
3036 @cindex modes, MH-Folder
3037 @findex next-line
3038 @findex previous-line
3039 @kindex C-n
3040 @kindex C-p
3041 @kindex @key{RET}
3042
3043 You can also use the Emacs commands @kbd{C-p} (@code{previous-line})
3044 and @kbd{C-n} (@code{next-line}) to move up and down the scan lines in
3045 the MH-Folder window. These commands can be used in conjunction with
3046 @key{RET} to look at deleted or refiled messages.
3047
3048 @cindex deleting messages
3049 @findex mh-delete-msg
3050 @kindex d
3051 @kindex n
3052 @kindex p
3053
3054 To mark a message for deletion, use the command @kbd{d}
3055 (@code{mh-delete-msg}). A @samp{D} is placed by the message in the
3056 scan window, and the next undeleted message is displayed. If the
3057 previous command had been @kbd{p}, then the next message displayed is
3058 the first undeleted message previous to the message just deleted. Use
3059 @kbd{n} to force subsequent @kbd{d} commands to move forward to the
3060 next undeleted message after deleting the message under the cursor.
3061 You may also specify a range (for example, @kbd{C-u d 1 3 5-7 last:5
3062 frombob @key{RET}}, @pxref{Ranges}).
3063
3064 @findex mh-delete-msg-no-motion
3065 @kindex C-d
3066
3067 The command @kbd{C-d} (@code{mh-delete-msg-no-motion}) marks the
3068 message (or messages in range) for deletion but leaves the cursor at
3069 the current message in case you wish to perform other operations on
3070 the message.
3071
3072 @findex mh-delete-subject
3073 @findex mh-delete-subject-or-thread
3074 @findex mh-thread-delete
3075 @findex mh-undo
3076 @kindex k
3077 @kindex T d
3078 @kindex u
3079
3080 And to delete more messages faster, you can use @kbd{k}
3081 (@code{mh-delete-subject-or-thread}) to delete all the messages with
3082 the same subject as the current message. This command puts these
3083 messages in a sequence named @samp{subject}. You can undo this action
3084 by using @kbd{u} (@code{mh-undo}) with a prefix argument and then
3085 specifying the @samp{subject} sequence. However, if the buffer is
3086 displaying a threaded view of the folder then @kbd{k} behaves like
3087 @kbd{T d} (@code{mh-thread-delete}). @xref{Threading}.
3088
3089 @findex mh-execute-commands
3090 @kindex x
3091
3092 However you mark a message for deletion, the command @kbd{x}
3093 (@code{mh-execute-commands}) actually carries out the deletion
3094 (@pxref{Folders}).
3095
3096 @vindex mh-delete-msg-hook
3097
3098 The hook @code{mh-delete-msg-hook} is called after you mark a message
3099 for deletion. For example, a past maintainer of MH-E used this once
3100 when he kept statistics on his mail usage.
3101
3102 @node Miscellaneous Commands and Options, , Navigating, Reading Mail
3103 @section Miscellaneous Commands and Options
3104
3105 This section contains a few more miscellaneous commands and options.
3106
3107 @cindex editing message
3108 @findex mh-modify
3109 @kindex M
3110
3111 There are times when you need to edit a message. For example, you may
3112 need to fix a broken Content-Type header field. You can do this with
3113 the command @kbd{M} (@code{mh-modify}). It displays the raw message in
3114 an editable buffer. When you are done editing, save and kill the
3115 buffer as you would any other.
3116
3117 @findex mh-kill-folder
3118 @findex mh-pack-folder
3119 @vindex mh-do-not-confirm-flag
3120
3121 Commands such as @code{mh-pack-folder} prompt to confirm whether to
3122 process outstanding moves and deletes or not before continuing.
3123 Turning on the option @code{mh-do-not-confirm-flag} means that these
3124 actions will be performed---which is usually desired but cannot be
3125 retracted---without question@footnote{In previous versions of MH-E,
3126 this option suppressed the confirmation in @code{mh-kill-folder}.
3127 Since this kept most users from setting this option,
3128 @code{mh-kill-folder} was modified in version 6.0 to always ask for
3129 confirmation subject to @code{mh-kill-folder-suppress-prompt-hook}.
3130 @xref{Folders}.}.
3131
3132 @cindex MH-Folder mode
3133 @cindex modes, MH-Folder
3134 @vindex mh-summary-height
3135
3136 The option @code{mh-summary-height} controls the number of scan lines
3137 displayed in the MH-Folder window, including the mode line. The
3138 default value of this option is @samp{Automatic} which means that the
3139 MH-Folder buffer will maintain the same proportional size if the frame
3140 is resized. If you'd prefer a fixed height, then choose the
3141 @samp{Fixed Size} option and enter the number of lines you'd like to
3142 see.
3143
3144 @vindex mh-bury-show-buffer-flag
3145
3146 Normally the buffer for displaying messages is buried at the bottom at
3147 the buffer stack. You may wish to disable this feature by turning off
3148 the option @code{mh-bury-show-buffer-flag}. One advantage of not
3149 burying the show buffer is that one can delete the show buffer more
3150 easily in an electric buffer list because of its proximity to its
3151 associated MH-Folder buffer. Try running @kbd{M-x
3152 electric-buffer-list} to see what I mean.
3153
3154 @cindex @file{.emacs}
3155 @cindex files, @file{.emacs}
3156 @cindex reading mail
3157
3158 Before we leave this section, I'll include a function that I use as a
3159 front end to MH-E@footnote{Stephen Gildea's favorite binding is
3160 @kbd{(global-set-key "\C-cr" 'mh-rmail)}.}. It toggles between your
3161 working window configuration, which may be quite involved---windows
3162 filled with source, compilation output, man pages, and other
3163 documentation---and your MH-E window configuration. Like the rest of
3164 the customization described in this section, simply add the following
3165 code to @file{~/.emacs}.
3166
3167 @iftex
3168 @filbreak
3169 @end iftex
3170
3171 @findex mh-rmail, example
3172
3173 @smalllisp
3174 @group
3175 (defvar my-mh-screen-saved nil
3176 "Set to non-@code{nil} when MH-E window configuration shown.")
3177 (defvar my-normal-screen nil "Normal window configuration.")
3178 (defvar my-mh-screen nil "MH-E window configuration.")
3179
3180 (defun my-mh-rmail (&optional arg)
3181 "Toggle between MH-E and normal screen configurations.
3182 With non-@code{nil} or prefix argument, @i{inc} mailbox as well
3183 when going into mail."
3184 (interactive "P") ; @r{user callable function, P=prefix arg}
3185 (setq my-mh-screen-saved ; @r{save state}
3186 (cond
3187 ;; @r{Bring up MH-E screen if arg or normal window configuration.}
3188 ;; @r{If arg or +inbox buffer doesn't exist, run mh-rmail.}
3189 ((or arg (null my-mh-screen-saved))
3190 (setq my-normal-screen (current-window-configuration))
3191 (if (or arg (null (get-buffer "+inbox")))
3192 (mh-rmail)
3193 (set-window-configuration my-mh-screen))
3194 t) ; @r{set my-mh-screen-saved to @code{t}}
3195 ;; @r{Otherwise, save MH-E screen and restore normal screen.}
3196 (t
3197 (setq my-mh-screen (current-window-configuration))
3198 (set-window-configuration my-normal-screen)
3199 nil)))) ; @r{set my-mh-screen-saved to nil}
3200
3201 (global-set-key "\C-x\r" 'my-mh-rmail) ;@r{ call with C-x @key{RET}}
3202
3203 @i{Starting MH-E}
3204
3205 @end group
3206 @end smalllisp
3207
3208 If you type an argument (@kbd{C-u}) or if @code{my-mh-screen-saved} is
3209 @code{nil} (meaning a non-MH-E window configuration), the current
3210 window configuration is saved, either the @samp{+inbox} buffer is
3211 displayed or @code{mh-rmail} is run, and the MH-E window configuration
3212 is shown. Otherwise, the MH-E window configuration is saved and the
3213 original configuration is displayed.
3214
3215 @node Folders, Sending Mail, Reading Mail, Top
3216 @chapter Organizing Your Mail with Folders
3217
3218 @cindex @samp{Folder} menu
3219 @cindex @samp{Message} menu
3220 @cindex folders
3221 @cindex menu, @samp{Folder}
3222 @cindex menu, @samp{Message}
3223 @cindex using folders
3224
3225 This chapter discusses the things you can do with folders within MH-E.
3226 The commands in this chapter are also found in the @samp{Folder} and
3227 @samp{Message} menus.
3228
3229 @table @kbd
3230 @kindex ?
3231 @findex mh-help
3232 @item ?
3233 Display cheat sheet for the MH-E commands (@code{mh-help}).
3234 @c -------------------------
3235 @kindex !
3236 @findex mh-refile-or-write-again
3237 @item !
3238 Repeat last output command (@code{mh-refile-or-write-again}).
3239 @c -------------------------
3240 @cindex @samp{Message > Copy Message to Folder...} menu item
3241 @cindex menu item, @samp{Message > Copy Message to Folder...}
3242 @kindex c
3243 @findex mh-copy-msg
3244 @item c
3245 Copy range to folder (@code{mh-copy-msg}).
3246 @c -------------------------
3247 @kindex F ?
3248 @findex mh-prefix-help
3249 @item F ?
3250 Display cheat sheet for the commands of the current prefix in
3251 minibuffer (@code{mh-prefix-help}).
3252 @c -------------------------
3253 @kindex F '
3254 @findex mh-index-ticked-messages
3255 @item F '
3256 Display ticked messages (@code{mh-index-ticked-messages}).
3257 @c -------------------------
3258 @kindex F c
3259 @findex mh-catchup
3260 @item F c
3261 Delete range from the @samp{unseen} sequence (@code{mh-catchup}).
3262 @c -------------------------
3263 @kindex F k
3264 @findex mh-kill-folder
3265 @item F k
3266 Remove folder (@code{mh-kill-folder}).
3267 @c -------------------------
3268 @cindex @samp{Folder > List Folders} menu item
3269 @cindex menu item, @samp{Folder > List Folders}
3270 @kindex F l
3271 @findex mh-list-folders
3272 @item F l
3273 List all folders (@code{mh-list-folders}).
3274 @c -------------------------
3275 @cindex @samp{Folder > View New Messages} menu item
3276 @cindex menu item, @samp{Folder > View New Messages}
3277 @kindex F n
3278 @findex mh-index-new-messages
3279 @item F n
3280 Display unseen messages (@code{mh-index-new-messages}).
3281 @c -------------------------
3282 @cindex @samp{Folder > Pack Folder} menu item
3283 @cindex menu item, @samp{Folder > Pack Folder}
3284 @kindex F p
3285 @findex mh-pack-folder
3286 @item F p
3287 Pack folder (@code{mh-pack-folder}).
3288 @c -------------------------
3289 @kindex F q
3290 @findex mh-index-sequenced-messages
3291 @item F q
3292 Display messages in any sequence (@code{mh-index-sequenced-messages}).
3293 @c -------------------------
3294 @cindex @samp{Folder > Rescan Folder} menu item
3295 @cindex menu item, @samp{Folder > Rescan Folder}
3296 @kindex F r
3297 @findex mh-rescan-folder
3298 @item F r
3299 Rescan folder (@code{mh-rescan-folder}).
3300 @c -------------------------
3301 @cindex @samp{Folder > Search...} menu item
3302 @cindex menu item, @samp{Folder > Search...}
3303 @kindex F s
3304 @findex mh-search
3305 @item F s
3306 Search your MH mail (@code{mh-search}).
3307 @c -------------------------
3308 @cindex @samp{Folder > Sort Folder} menu item
3309 @cindex menu item, @samp{Folder > Sort Folder}
3310 @kindex F S
3311 @findex mh-sort-folder
3312 @item F S
3313 Sort folder (@code{mh-sort-folder}).
3314 @c -------------------------
3315 @kindex F u
3316 @findex mh-undo-folder
3317 @item F u
3318 Undo all refiles and deletes in the current folder (@code{mh-undo-folder}).
3319 @c -------------------------
3320 @cindex @samp{Folder > Visit a Folder...} menu item
3321 @cindex menu item, @samp{Folder > Visit a Folder...}
3322 @kindex F v
3323 @findex mh-visit-folder
3324 @item F v
3325 Visit folder (@code{mh-visit-folder}).
3326 @c -------------------------
3327 @cindex @samp{Message > Refile Message} menu item
3328 @cindex menu item, @samp{Message > Refile Message}
3329 @kindex o
3330 @findex mh-refile-msg
3331 @item o
3332 Refile (output) range into folder (@code{mh-refile-msg}).
3333 @c -------------------------
3334 @cindex @samp{Folder > Quit MH-E} menu item
3335 @cindex menu item, @samp{Folder > Quit MH-E}
3336 @kindex q
3337 @findex mh-quit
3338 @item q
3339 Quit the current MH-E folder (@code{mh-quit}).
3340 @c -------------------------
3341 @cindex @samp{Folder > Toggle Show/Folder} menu item
3342 @cindex menu item, @samp{Folder > Toggle Show/Folder}
3343 @kindex t
3344 @findex mh-toggle-showing
3345 @item t
3346 Toggle between MH-Folder and MH-Folder Show modes
3347 (@code{mh-toggle-showing}).
3348 @c -------------------------
3349 @cindex @samp{Message > Undo Delete/Refile} menu item
3350 @cindex menu item, @samp{Message > Undo Delete/Refile}
3351 @kindex u
3352 @findex mh-undo
3353 @item u
3354 Undo pending deletes or refiles in range (@code{mh-undo}).
3355 @c -------------------------
3356 @cindex @samp{Message > Execute Delete/Refile} menu item
3357 @cindex menu item, @samp{Message > Execute Delete/Refile}
3358 @kindex x
3359 @findex mh-execute-commands
3360 @item x
3361 Process outstanding delete and refile requests
3362 (@code{mh-execute-commands}).
3363 @end table
3364
3365 @cindex @samp{mh-folder} customization group
3366 @cindex customization group, @samp{mh-folder}
3367
3368 The @samp{mh-folder} customization group is used to tune these
3369 commands.
3370
3371 @vtable @code
3372 @item mh-new-messages-folders
3373 Folders searched for the @samp{unseen} sequence (default:
3374 @code{Inbox}).
3375 @c -------------------------
3376 @item mh-ticked-messages-folders
3377 Folders searched for @code{mh-tick-seq} (default: @code{t}).
3378 @c -------------------------
3379 @item mh-large-folder
3380 The number of messages that indicates a large folder (default: 200).
3381 @c -------------------------
3382 @item mh-recenter-summary-flag
3383 On means to recenter the summary window (default: @samp{off}).
3384 @c -------------------------
3385 @item mh-recursive-folders-flag
3386 On means that commands which operate on folders do so recursively
3387 (default: @samp{off}).
3388 @c -------------------------
3389 @item mh-sortm-args
3390 Additional arguments for @command{sortm} (default: @code{nil}).
3391 @end vtable
3392
3393 The following hooks are available.
3394
3395 @vtable @code
3396 @item mh-after-commands-processed-hook
3397 Hook run by @kbd{x} after performing outstanding refile and delete
3398 requests (default: @code{nil}).
3399 @c -------------------------
3400 @item mh-before-commands-processed-hook
3401 Hook run by @kbd{x} before performing outstanding refile and delete
3402 requests (default: @code{nil}).
3403 @c -------------------------
3404 @item mh-before-quit-hook
3405 Hook run by q before quitting MH-E (default: @code{nil}).
3406 @c -------------------------
3407 @item mh-folder-mode-hook
3408 Hook run by @code{mh-folder-mode} when visiting a new folder (default:
3409 @code{nil}).
3410 @c -------------------------
3411 @item mh-kill-folder-suppress-prompt-hook
3412 Abnormal hook run at the beginning of @code{mh-kill-folder} (default:
3413 @code{'mh-search-p}).
3414 @c -------------------------
3415 @item mh-pack-folder-hook
3416 Hook run by @code{mh-pack-folder} after renumbering the messages
3417 (default: @code{nil}).
3418 @c -------------------------
3419 @item mh-quit-hook
3420 Hook run by q after quitting MH-E (default: @code{nil}).
3421 @c -------------------------
3422 @item mh-refile-msg-hook
3423 Hook run by o after marking each message for refiling (default:
3424 @code{nil}).
3425 @end vtable
3426
3427 The following faces are available for customizing the appearance of
3428 the MH-Folder buffer. @xref{Scan Line Formats}.
3429
3430 @vtable @code
3431 @item mh-folder-address
3432 Recipient face.
3433 @c -------------------------
3434 @item mh-folder-body
3435 Body text face.
3436 @c -------------------------
3437 @item mh-folder-cur-msg-number
3438 Current message number face.
3439 @c -------------------------
3440 @item mh-folder-date
3441 Date face.
3442 @c -------------------------
3443 @item mh-folder-deleted
3444 Deleted message face.
3445 @c -------------------------
3446 @item mh-folder-followup
3447 @samp{Re:} face.
3448 @c -------------------------
3449 @item mh-folder-msg-number
3450 Message number face.
3451 @c -------------------------
3452 @item mh-folder-refiled
3453 Refiled message face.
3454 @c -------------------------
3455 @vindex mh-scan-format-nmh
3456 @vindex mh-scan-sent-to-me-sender-regexp
3457 @item mh-folder-sent-to-me-hint
3458 Fontification hint face in messages sent directly to us. The detection
3459 of messages sent to us is governed by the scan format
3460 @code{mh-scan-format-nmh} and regular expression
3461 @code{mh-scan-sent-to-me-sender-regexp}.
3462 @c -------------------------
3463 @vindex mh-scan-format-nmh
3464 @vindex mh-scan-sent-to-me-sender-regexp
3465 @item mh-folder-scan-format
3466 Sender face in messages sent directly to us. The detection of messages
3467 sent to us is governed by the scan format @code{mh-scan-format-nmh}
3468 and regular expression @code{mh-scan-sent-to-me-sender-regexp}.
3469 @c -------------------------
3470 @item mh-folder-subject
3471 Subject face.
3472 @c -------------------------
3473 @item mh-folder-tick
3474 Ticked message face.
3475 @c -------------------------
3476 @item mh-folder-to
3477 @samp{To:} face.
3478 @end vtable
3479
3480 @vindex mh-folder-mode-hook
3481
3482 The hook @code{mh-folder-mode-hook} is called when visiting a new
3483 folder in MH-Folder mode. This could be used to set your own key
3484 bindings, for example:
3485
3486 @vindex mh-folder-mode-hook, example
3487
3488 @smalllisp
3489 @group
3490 (defvar my-mh-init-done nil
3491 "Non-@code{nil} when one-time MH-E settings made.")
3492
3493 (defun my-mh-folder-mode-hook ()
3494 "Hook to set key bindings in MH-Folder mode."
3495 (if (not my-mh-init-done) ; @r{only need to bind the keys once }
3496 (progn
3497 (local-set-key "//" 'my-search-msg)
3498 (local-set-key "b" 'mh-burst-digest) ; @r{better use of @kbd{b}}
3499 (setq my-mh-init-done t))))
3500
3501 (add-hook 'mh-folder-mode-hook 'my-mh-folder-mode-hook)
3502
3503 (defun my-search-msg ()
3504 "Search for a regexp in the current message."
3505 (interactive) ; @r{user function}
3506 (save-window-excursion
3507 (other-window 1) ; @r{go to next window}
3508 (isearch-forward-regexp))) ; @r{string search; hit return}
3509 ; @r{ when done}
3510
3511 @i{Create additional key bindings via mh-folder-mode-hook}
3512
3513 @end group
3514 @end smalllisp
3515
3516 @cindex @command{folder}
3517 @cindex @command{refile}
3518 @cindex MH commands, @command{folder}
3519 @cindex MH commands, @command{refile}
3520 @findex mh-refile-msg
3521 @kindex o
3522 @vindex mh-refile-msg-hook
3523
3524 MH-E has analogies for each of the MH @command{folder} and
3525 @command{refile} commands@footnote{See the sections
3526 @uref{@value{MH-BOOK-HOME}/fol.html#Youfol, Your Current Folder:
3527 folder} and @uref{@value{MH-BOOK-HOME}/fol.html#Movref, Moving and
3528 Linking Messages: refile} in the MH book.}. To refile a message in
3529 another folder, use the command @kbd{o} (@code{mh-refile-msg})
3530 (mnemonic: ``output''). You are prompted for the folder name
3531 (@pxref{Folder Selection}). Note that this command can also be used to
3532 create folders. If you specify a folder that does not exist, you will
3533 be prompted to create it. The hook @code{mh-refile-msg-hook} is called
3534 after a message is marked to be refiled.
3535
3536 @findex mh-write-msg-to-file
3537 @kindex !
3538
3539 If you are refiling several messages into the same folder, you can use
3540 the command @kbd{!} (@code{mh-refile-or-write-again}) to repeat the
3541 last refile or write (for the description of @kbd{>}
3542 (@code{mh-write-msg-to-file}), @pxref{Files and Pipes}). You can use a
3543 range in either case (for example, @kbd{C-u o 1 3 5-7 last:5 frombob
3544 @key{RET}}, @pxref{Ranges}).
3545
3546 @cindex expunging refiles and deletes
3547 @cindex undoing refiles and deletes
3548 @findex mh-undo
3549 @kindex u
3550
3551 If you've deleted a message or refiled it, but changed your mind, you
3552 can cancel the action before you've executed it. Use @kbd{u}
3553 (@code{mh-undo}) to undo a refile on or deletion of a single message.
3554 You can also undo refiles and deletes for messages that are found in a
3555 given range (@pxref{Ranges}).
3556
3557 @findex mh-undo-folder
3558 @kindex F u
3559
3560 Alternatively, you can use @kbd{F u} (@code{mh-undo-folder}) to undo
3561 all refiles and deletes in the current folder.
3562
3563 @findex mh-execute-commands
3564 @kindex x
3565
3566 If you've marked messages to be deleted or refiled and you want to go
3567 ahead and delete or refile the messages, use @kbd{x}
3568 (@code{mh-execute-commands}). Many MH-E commands that may affect the
3569 numbering of the messages (such as @kbd{F r} or @kbd{F p}) will ask if
3570 you want to process refiles or deletes first and then either run
3571 @kbd{x} for you or undo the pending refiles and deletes.
3572
3573 @kindex x
3574 @vindex mh-after-commands-processed-hook
3575 @vindex mh-before-commands-processed-hook
3576 @vindex mh-current-folder
3577
3578 The command @kbd{x} runs @code{mh-before-commands-processed-hook}
3579 before the commands are processed and
3580 @code{mh-after-commands-processed-hook} after the commands are
3581 processed. Variables that are useful with the former hook include
3582 @code{mh-delete-list} and @code{mh-refile-list} which can be used to
3583 see which changes will be made to the current folder,
3584 @code{mh-current-folder}. Variables that are useful with the latter
3585 hook include @code{mh-folders-changed}, which lists which folders were
3586 affected by deletes and refiles. This list will always include the
3587 current folder @code{mh-current-folder}.
3588
3589 @findex mh-copy-msg
3590 @kindex c
3591 @kindex o
3592
3593 If you wish to copy a message to another folder, you can use the
3594 command @kbd{c} (@code{mh-copy-msg}) (see the @option{-link} argument
3595 to @command{refile}(1)). Like the command @kbd{o}, this command
3596 prompts you for the name of the target folder and you can specify a
3597 range (@pxref{Ranges}). Note that unlike the command @kbd{o}, the copy
3598 takes place immediately. The original copy remains in the current
3599 folder.
3600
3601 @cindex junk mail
3602 @cindex MH-Folder mode
3603 @cindex MH-Folder Show mode
3604 @cindex modes, MH-Folder
3605 @cindex modes, MH-Folder Show
3606 @cindex spam
3607 @findex mh-toggle-showing
3608 @kindex t
3609
3610 The command @kbd{t} (@code{mh-toggle-showing}) switches between
3611 MH-Folder mode and MH-Folder Show mode@footnote{For you Emacs wizards,
3612 this is implemented as an Emacs minor mode.}. MH-Folder mode turns off
3613 the associated show buffer so that you can perform operations on the
3614 messages quickly without reading them. This is an excellent way to
3615 prune out your junk mail or to refile a group of messages to another
3616 folder for later examination.
3617
3618 @cindex MH-Folder mode
3619 @cindex MH-Show mode
3620 @cindex modes, MH-Folder
3621 @cindex modes, MH-Show
3622 @cindex moving between messages
3623 @kindex t
3624 @vindex mh-recenter-summary-flag
3625
3626 When you use @kbd{t} to toggle from MH-Folder Show mode to MH-Folder
3627 mode, the MH-Show buffer is hidden and the MH-Folder buffer is left
3628 alone. Setting @code{mh-recenter-summary-flag} to a non-@code{nil}
3629 value causes the toggle to display as many scan lines as possible,
3630 with the cursor at the middle. The effect of
3631 @code{mh-recenter-summary-flag} is rather useful, but it can be
3632 annoying on a slow network connection.
3633
3634 @findex mh-visit-folder
3635 @kindex F v
3636 @vindex mh-large-folder
3637
3638 When you want to read the messages that you have refiled into folders,
3639 use the command @kbd{F v} (@code{mh-visit-folder}) to visit the
3640 folder. You are prompted for the folder name. The folder buffer will
3641 show just unseen messages if there are any; otherwise, it will show
3642 all the messages in the buffer as long there are fewer than
3643 @code{mh-large-folder} messages. If there are more, then you are
3644 prompted for a range of messages to scan. You can provide a prefix
3645 argument in order to specify a range of messages to show when you
3646 visit the folder (@pxref{Ranges}). In this case, regions are not used
3647 to specify the range and @code{mh-large-folder} is ignored. Note that
3648 this command can also be used to create folders. If you specify a
3649 folder that does not exist, you will be prompted to create it.
3650
3651 @findex mh-search
3652 @kindex F s
3653
3654 If you forget where you've refiled your messages, you can find them
3655 using @kbd{F s} (@code{mh-search}). @xref{Searching}.
3656
3657 @cindex @command{procmail}
3658 @cindex @samp{unseen} sequence
3659 @cindex sequence, @samp{unseen}
3660 @cindex Unix commands, @command{procmail}
3661 @cindex unseen messages, viewing
3662 @findex mh-index-new-messages
3663 @kindex F n
3664 @vindex mh-new-messages-folders
3665
3666 If you use a program such as @command{procmail} to file your incoming
3667 mail automatically, you can display new, unseen, messages using the
3668 command @kbd{F n} (@code{mh-index-new-messages}). All messages in the
3669 @samp{unseen} sequence from the folders in
3670 @code{mh-new-messages-folders} are listed. However, this list of
3671 folders can be overridden with a prefix argument: with a prefix
3672 argument, enter a space-separated list of folders, or nothing to
3673 search all folders.
3674
3675 @cindex @samp{tick} sequence
3676 @cindex sequence, @samp{tick}
3677 @cindex ticked messages, viewing
3678 @findex mh-index-ticked-messages
3679 @kindex F '
3680 @vindex mh-ticked-messages-folders
3681
3682 If you have ticked messages (@pxref{Sequences}), you can display them
3683 using the command @kbd{F '} (@code{mh-index-ticked-messages}). All
3684 messages in the @samp{tick} sequence from the folders in
3685 @code{mh-ticked-messages-folders} are listed. With a prefix argument,
3686 enter a space-separated list of folders, or nothing to search all
3687 folders.
3688
3689 @findex mh-index-sequenced-messages
3690 @kindex F q
3691 @vindex mh-new-messages-folders
3692
3693 You can display messages in any sequence with the command @kbd{F q}
3694 (@code{mh-index-sequenced-messages}). All messages from the folders in
3695 @code{mh-new-messages-folders} in the sequence you provide are listed.
3696 With a prefix argument, enter a space-separated list of folders at the
3697 prompt, or nothing to search all folders.
3698
3699 @vindex mh-new-messages-folders
3700 @vindex mh-recursive-folders-flag
3701 @vindex mh-ticked-messages-folders
3702
3703 Set the options @code{mh-new-messages-folders} and
3704 @code{mh-ticked-messages-folders} to @samp{Inbox} to search the
3705 @samp{+inbox} folder or @samp{All} to search all of the top level
3706 folders. Otherwise, list the folders that should be searched with the
3707 @samp{Choose Folders} menu item. See @code{mh-recursive-folders-flag}.
3708
3709 @cindex buffers, @samp{*MH-E Folders*}
3710 @cindex @samp{*MH-E Folders*}
3711 @findex mh-kill-folder
3712 @findex mh-list-folders
3713 @findex mh-pack-folder
3714 @findex mh-rescan-folder
3715 @findex mh-sort-folder
3716 @kindex F k
3717 @kindex F l
3718 @kindex F p
3719 @kindex F r
3720 @kindex F S
3721
3722 Other commands you can perform on folders include: @kbd{F l}
3723 (@code{mh-list-folders}), to place a listing of all the folders in
3724 your mail directory in a buffer called @samp{*MH-E Folders*}
3725 (@pxref{Miscellaneous}); @kbd{F k} (@code{mh-kill-folder}), to remove
3726 a folder; @kbd{F S} (@code{mh-sort-folder}), to sort the messages by
3727 date (see @command{sortm}(1) to see how to sort by other criteria);
3728 @kbd{F p} (@code{mh-pack-folder}), to pack a folder, removing gaps
3729 from the numbering sequence; and @kbd{F r} (@code{mh-rescan-folder}),
3730 to rescan the folder, which is useful to grab all messages in your
3731 @samp{+inbox} after processing your new mail for the first time. If
3732 you don't want to rescan the entire folder, the commands @kbd{F r} or
3733 @kbd{F p} will accept a range (@pxref{Ranges}).
3734
3735 @kindex F p
3736 @vindex mh-pack-folder-hook
3737
3738 The command @kbd{F p} runs @code{mh-pack-folder-hook} after
3739 renumbering the messages. A variable that is useful with this hook
3740 is @code{mh-current-folder}.
3741
3742 @kindex @key{TAB}
3743 @vindex mh-recursive-folders-flag
3744
3745 By default, operations on folders work only one level at a time. Set
3746 @code{mh-recursive-folders-flag} to non-@code{nil} to operate on all
3747 folders. This mostly means that you'll be able to see all your folders
3748 when you press @key{TAB} when prompted for a folder name.
3749
3750 @findex mh-search-p
3751 @kindex k
3752 @vindex mh-kill-folder-suppress-prompt-hooks
3753
3754 The hook @code{mh-kill-folder-suppress-prompt-hooks} is an abnormal
3755 hook run at the beginning of the command @kbd{k}. The hook functions
3756 are called with no arguments and should return a non-nil value to
3757 suppress the normal prompt when you remove a folder. This is useful
3758 for folders that are easily regenerated. The default value of
3759 @code{mh-search-p} suppresses the prompt on folders generated by
3760 searching.
3761
3762 @sp 1
3763 @center @strong{NOTE}
3764
3765 @quotation
3766 Use this hook with care. If there is a bug in your hook which returns
3767 @code{t} on @samp{+inbox} and you press @kbd{k} by accident in the
3768 @code{+inbox} folder, you will not be happy.
3769 @end quotation
3770 @sp 1
3771
3772 @cindex @command{sortm}
3773 @cindex @file{.mh_profile}
3774 @cindex files, @file{.mh_profile}
3775 @cindex MH commands, @command{sortm}
3776 @cindex MH profile component, @samp{sortm:}
3777 @cindex @samp{sortm:} MH profile component
3778 @kindex F S
3779 @vindex mh-sortm-args
3780
3781 The option @code{mh-sortm-args} holds extra arguments to pass on to
3782 the command @command{sortm}@footnote{See the section
3783 @uref{@value{MH-BOOK-HOME}/sorsor.html, Sorting Messages: sortm} in the
3784 MH book.} when a prefix argument is used with @kbd{F S}. Normally
3785 default arguments to @command{sortm} are specified in the MH profile.
3786 This option may be used to provide an alternate view. For example,
3787 @samp{'(\"-nolimit\" \"-textfield\" \"subject\")} is a useful setting.
3788
3789 @cindex exiting
3790 @cindex quitting
3791 @findex mh-quit
3792 @kindex q
3793
3794 When you want to quit using MH-E and go back to editing, you can use
3795 the @kbd{q} (@code{mh-quit}) command. This buries the buffers of the
3796 current MH-E folder and restores the buffers that were present when
3797 you first ran @kbd{M-x mh-rmail}. It also removes any MH-E working
3798 buffers whose name begins with @samp{ *mh-} or @samp{*MH-E }
3799 (@pxref{Miscellaneous}). You can later restore your MH-E session by
3800 selecting the @samp{+inbox} buffer or by running @kbd{M-x mh-rmail}
3801 again.
3802
3803 @findex mh-execute-commands
3804 @kindex q
3805 @vindex mh-before-quit-hook
3806 @vindex mh-before-quit-hook, example
3807 @vindex mh-quit-hook
3808 @vindex mh-quit-hook, example
3809
3810 The two hooks @code{mh-before-quit-hook} and @code{mh-quit-hook} are
3811 called by @kbd{q}. The former one is called before the quit occurs, so
3812 you might use it to perform any MH-E operations; you could perform
3813 some query and abort the quit or call @code{mh-execute-commands}, for
3814 example. The latter is not run in an MH-E context, so you might use it
3815 to modify the window setup. If you find that @kbd{q} buries a lot of
3816 buffers that you would rather remove, you can use both
3817 @code{mh-before-quit-hook} and @code{mh-quit-hook} to accomplish that.
3818
3819 @smalllisp
3820 @group
3821 (defvar my-mh-folder-buffer-to-delete nil
3822 "Folder buffer that is being quit.")
3823
3824 (defun my-mh-before-quit-hook ()
3825 "Save folder buffer that is to be deleted."
3826 (setq my-mh-folder-buffer-to-delete (current-buffer)))
3827
3828 (defun my-mh-quit-hook ()
3829 "Kill folder buffer rather than just bury it."
3830 (set-buffer my-mh-folder-buffer-to-delete)
3831 (if (get-buffer mh-show-buffer)
3832 (kill-buffer mh-show-buffer))
3833 (kill-buffer (current-buffer)))
3834
3835 @i{Kill MH-Folder buffer instead of burying it}
3836 @end group
3837 @end smalllisp
3838
3839 @cindex folders, renaming
3840 @cindex renaming folders
3841 @findex dired
3842 @findex dired-do-rename
3843
3844 You can use dired to manipulate the folders themselves. For example, I
3845 renamed my @samp{+out} folder to the more common @samp{+outbox} by
3846 running dired on my mail directory (@kbd{M-x dired RET ~/Mail RET}),
3847 moving my cursor to @samp{out} and using the command @kbd{R}
3848 (@code{dired-do-rename}).
3849
3850 @node Sending Mail, Editing Drafts, Folders, Top
3851 @chapter Sending Mail
3852
3853 @cindex sending mail
3854 @findex mh-smail
3855 @kindex M-x mh-smail
3856
3857 You can send a mail message in several ways. You can call @kbd{M-x
3858 mh-smail} directly, or from the command line like this:
3859
3860 @cindex starting from command line
3861
3862 @smallexample
3863 $ @kbd{emacs -f mh-smail}
3864 @end smallexample
3865
3866 @findex goto-address-at-point
3867 @vindex mail-user-agent
3868
3869 There are some commands that need to send a mail message, such as
3870 @code{goto-address-at-point}. You can configure Emacs to have these
3871 commands use MH-E by setting the option @code{mail-user-agent} to
3872 @samp{Emacs interface to MH}.
3873
3874 @cindex @samp{Message} menu
3875 @cindex menu, @samp{Message}
3876
3877 From within MH-E's MH-Folder mode, other methods of sending mail are
3878 available as well. These can also be found in the @samp{Message} menu.
3879
3880 @table @kbd
3881 @cindex @samp{Message > Edit Message Again} menu item
3882 @cindex menu item, @samp{Message > Edit Message Again}
3883 @kindex e
3884 @findex mh-edit-again
3885 @item e
3886 Edit a message to send it again (@code{mh-edit-again}).
3887 @c -------------------------
3888 @cindex @samp{Message > Re-edit a Bounced Message} menu item
3889 @cindex menu item, @samp{Message > Re-edit a Bounced Message}
3890 @kindex E
3891 @findex mh-extract-rejected-mail
3892 @item E
3893 Edit a message that was returned by the mail system
3894 (@code{mh-extract-rejected-mail}).
3895 @c -------------------------
3896 @cindex @samp{Message > Forward Message...} menu item
3897 @cindex menu item, @samp{Message > Forward Message...}
3898 @kindex f
3899 @findex mh-forward
3900 @item f
3901 Forward message (@code{mh-forward}).
3902 @c -------------------------
3903 @cindex @samp{Message > Reply to Message...} menu item
3904 @cindex menu item, @samp{Message > Reply to Message...}
3905 @kindex r
3906 @findex mh-reply
3907 @item r
3908 Reply to a message (@code{mh-reply}).
3909 @c -------------------------
3910 @cindex @samp{Message > Compose a New Message} menu item
3911 @cindex menu item, @samp{Message > Compose a New Message}
3912 @kindex s
3913 @findex mh-send
3914 @item s
3915 Compose a message (@code{mh-send}).
3916 @c -------------------------
3917 @cindex @samp{Message > Redistribute Message...} menu item
3918 @cindex menu item, @samp{Message > Redistribute Message...}
3919 @kindex M-d
3920 @findex mh-redistribute
3921 @item M-d
3922 Redistribute a message (@code{mh-redistribute}).
3923 @c -------------------------
3924 @findex mh-smail
3925 @item M-x mh-smail
3926 Compose a message with the MH mail system.
3927 @c -------------------------
3928 @findex mh-smail-other-window
3929 @item M-x mh-smail-other-window
3930 Compose a message with the MH mail system in other window.
3931 @end table
3932
3933 @cindex @samp{mh-sending-mail} customization group
3934 @cindex customization group, @samp{mh-sending-mail}
3935
3936 In addition, several options from the @samp{mh-sending-mail}
3937 customization group are useful when sending mail or replying to mail.
3938 They are summarized in the following table.
3939
3940 @vtable @code
3941 @item mh-compose-forward-as-mime-flag
3942 On means that messages are forwarded as attachments (default:
3943 @samp{on}).
3944 @c -------------------------
3945 @item mh-compose-letter-function
3946 Hook run when starting a new draft (default: @code{nil}).
3947 @c -------------------------
3948 @item mh-compose-prompt-flag
3949 On means prompt for header fields when composing a new draft (default:
3950 @samp{off}).
3951 @c -------------------------
3952 @item mh-forward-subject-format
3953 Format string for forwarded message subject (default: @code{"%s:
3954 %s"}).
3955 @c -------------------------
3956 @item mh-insert-x-mailer-flag
3957 On means append an @samp{X-Mailer:} header field to the header
3958 (default: @samp{on}).
3959 @c -------------------------
3960 @item mh-redist-full-contents-flag
3961 On means the @command{dist} command needs entire letter for
3962 redistribution (default: @samp{off}).
3963 @c -------------------------
3964 @item mh-reply-default-reply-to
3965 Sets the person or persons to whom a reply will be sent (default:
3966 @samp{Prompt}).
3967 @c -------------------------
3968 @item mh-reply-show-message-flag
3969 On means the MH-Show buffer is displayed using @kbd{r}
3970 (@code{mh-reply}) (default: @samp{on}).
3971 @end vtable
3972
3973 The following hooks are available.
3974
3975 @vtable @code
3976 @item mh-annotate-msg-hook
3977 Hook run by @code{mh-annotate-msg} after annotation (default:
3978 @code{nil}).
3979 @c -------------------------
3980 @item mh-forward-hook
3981 Hook run by @code{mh-forward} on a forwarded letter (default:
3982 @code{nil}).
3983 @c -------------------------
3984 @item mh-letter-mode-hook
3985 Hook run by @code{mh-letter-mode} on a new letter (default:
3986 @code{nil}).
3987 @end vtable
3988
3989 @findex mh-annotate-msg
3990 @vindex mh-annotate-list
3991 @vindex mh-annotate-msg-hook
3992 @vindex mh-current-folder
3993
3994 A hook that is called whenever a message is sent and after the scan
3995 lines and message are annotated is @code{mh-annotate-msg-hook}. Hook
3996 functions can access the current folder name with
3997 @code{mh-current-folder} and obtain the message numbers of the
3998 annotated messages with @code{mh-annotate-list}.
3999
4000 The rest of the functions and options introduced here are explained in
4001 more detail in the following sections.
4002
4003 @menu
4004 * Composing::
4005 * Replying::
4006 * Forwarding::
4007 * Redistributing::
4008 * Editing Again::
4009 @end menu
4010
4011 @node Composing, Replying, Sending Mail, Sending Mail
4012 @section Composing
4013
4014 @cindex @file{.emacs}
4015 @cindex MH-Folder mode
4016 @cindex composing mail
4017 @cindex draft
4018 @cindex files, @file{.emacs}
4019 @cindex modes, MH-Folder
4020 @cindex sending mail
4021 @findex mh-smail
4022 @findex mh-smail-other-window
4023 @kindex M-x mh-smail
4024 @kindex M-x mh-smail-other-window
4025
4026 Outside of an MH-Folder buffer, you must call either @kbd{M-x
4027 mh-smail} or @kbd{M-x mh-smail-other-window} to compose a new message.
4028 The former command always creates a two-window layout with the current
4029 buffer on top and the draft on the bottom. Use the latter command if
4030 you would rather preserve the window layout. You may find adding the
4031 following key bindings to @file{~/.emacs} useful:
4032
4033 @smalllisp
4034 (global-set-key "\C-xm" 'mh-smail)
4035 (global-set-key "\C-x4m" 'mh-smail-other-window)
4036 @end smalllisp
4037
4038 @cindex draft folder
4039 @cindex MH-Letter mode
4040 @cindex modes, MH-Letter
4041 @findex mh-send
4042 @kindex m
4043
4044 From within a MH-Folder buffer, you can simply use the command @kbd{m}
4045 (@code{mh-send}). However you invoke @code{mh-send}, your letter
4046 appears in an Emacs buffer whose mode is MH-Letter (to see what the
4047 buffer looks like, @pxref{Sending Mail Tour}). MH-Letter mode allows
4048 you to edit your message, to check the validity of the recipients, to
4049 insert attachments and other messages into your message, and to send
4050 the message. We'll go more into depth about editing a
4051 @dfn{draft}@footnote{I highly recommend that you use a @dfn{draft
4052 folder} so that you can edit several drafts in parallel. To do so,
4053 create a folder named @samp{+drafts} for example, and add the profile
4054 component @samp{Draft-Folder: drafts} (see @code{mh-profile}(5)).} (a
4055 message you're composing) in just a moment (@pxref{Editing Drafts}).
4056
4057 @vindex mh-compose-prompt-flag
4058
4059 If you prefer to be prompted for the recipient and subject fields
4060 before the MH-Letter buffer appears, turn on the option
4061 @code{mh-compose-prompt-flag}.
4062
4063 @cindex header field, @samp{X-Mailer:}
4064 @cindex @samp{X-Mailer:} header field
4065 @vindex mh-insert-x-mailer-flag
4066
4067 MH-E adds an @samp{X-Mailer:} header field to the header that includes
4068 the version of MH-E and Emacs that you are using. If you don't want to
4069 participate in our marketing, you can turn off the option
4070 @code{mh-insert-x-mailer-flag}.
4071
4072 @cindex @command{repl}
4073 @cindex @file{components}
4074 @cindex MH commands, @command{repl}
4075 @cindex MH-Letter mode
4076 @cindex Mail mode
4077 @cindex files, @file{components}
4078 @cindex modes, MH-Letter
4079 @cindex modes, Mail
4080 @vindex mail-mode-hook
4081 @vindex mh-letter-mode-hook
4082 @vindex text-mode-hook
4083
4084 Two hooks are provided to run commands on your freshly created draft.
4085 The first hook, @code{mh-letter-mode-hook}, allows you to do some
4086 processing before editing a letter@footnote{Actually, because
4087 MH-Letter mode inherits from Mail mode, the hooks
4088 @code{text-mode-hook} and @code{mail-mode-hook} are run (in that
4089 order) before @code{mh-letter-mode-hook}.}. For example, you may wish
4090 to modify the header after @command{repl} has done its work, or you
4091 may have a complicated @file{components} file and need to tell MH-E
4092 where the cursor should go. Here's an example of how you would use
4093 this hook.
4094
4095 @findex mh-insert-signature, example
4096
4097 @smalllisp
4098 @group
4099 (defvar letter-mode-init-done-flag nil
4100 "Non-nil means one-time MH-E settings have been made.")
4101
4102 (defun my-mh-letter-mode-hook ()
4103 "Prepare letter for editing."
4104 (when (not letter-mode-init-done) ; @r{only need to bind the keys once}
4105 (local-set-key "\C-ctb" 'add-enriched-text)
4106 (local-set-key "\C-cti" 'add-enriched-text)
4107 (local-set-key "\C-ctf" 'add-enriched-text)
4108 (local-set-key "\C-cts" 'add-enriched-text)
4109 (local-set-key "\C-ctB" 'add-enriched-text)
4110 (local-set-key "\C-ctu" 'add-enriched-text)
4111 (local-set-key "\C-ctc" 'add-enriched-text)
4112 (setq letter-mode-init-done t))
4113 (save-excursion
4114 (goto-char (point-max)) ; @r{go to end of message to}
4115 (mh-insert-signature))) ; @r{insert signature}
4116
4117 @i{Prepare draft for editing via mh-letter-mode-hook}
4118
4119 @end group
4120 @end smalllisp
4121
4122 The function, @code{add-enriched-text} is defined in the example in
4123 @ref{Adding Attachments}.
4124
4125 @vindex mh-compose-letter-function
4126 @vindex mh-letter-mode-hook
4127
4128 The second hook, a function really, is
4129 @code{mh-compose-letter-function}. Like @code{mh-letter-mode-hook}, it
4130 is called just before editing a new message; however, it is the last
4131 function called before you edit your message. The consequence of this
4132 is that you can write a function to write and send the message for
4133 you. This function is passed three arguments: the contents of the
4134 @samp{To:}, @samp{Subject:}, and @samp{Cc:} header fields.
4135
4136 @node Replying, Forwarding, Composing, Sending Mail
4137 @section Replying to Mail
4138
4139 @cindex @command{mhl}
4140 @cindex @file{mhl.reply}
4141 @cindex MH commands, @command{mhl}
4142 @cindex files, @file{mhl.reply}
4143 @cindex replying
4144 @findex mh-reply
4145 @kindex r
4146
4147 To compose a reply to a message, use the @kbd{r} (@code{mh-reply})
4148 command.
4149
4150 When you reply to a message, you are first prompted with @samp{Reply
4151 to whom?}. You have several choices here.
4152
4153 @quotation
4154 @multitable @columnfractions .20 .80
4155 @c @headitem Response @tab Reply Goes To
4156 @c XXX @headitem not yet supported by SourceForge's texi2pdf.
4157 @item @b{Response} @tab @b{Reply Goes To}
4158 @c -------------------------
4159 @item @kbd{from}
4160 @tab
4161 The person who sent the message. This is the default, so @key{RET} is
4162 sufficient.
4163 @c -------------------------
4164 @item @kbd{to}
4165 @tab
4166 Replies to the sender, plus all recipients in the @samp{To:} header field.
4167 @c -------------------------
4168 @item @kbd{cc}@*@kbd{all}
4169 @tab
4170 Forms a reply to the addresses in the @samp{Mail-Followup-To:} header
4171 field if one exists; otherwise forms a reply to the sender, plus all
4172 recipients.
4173 @end multitable
4174 @end quotation
4175
4176 @cindex @command{repl}
4177 @cindex MH commands, @command{repl}
4178 @vindex mh-reply-default-reply-to
4179
4180 Depending on your answer, @command{repl}@footnote{See the section
4181 @uref{@value{MH-BOOK-HOME}/reprep.html, Replying to Messages: repl} in
4182 the MH book.} is given a different argument to form your reply.
4183 Specifically, a choice of @kbd{from} or none at all runs @samp{repl
4184 -nocc all}, and a choice of @kbd{to} runs @samp{repl -cc to}. Finally,
4185 either @kbd{cc} or @kbd{all} runs @samp{repl -cc all -nocc me}. If you
4186 find that most of the time you specify one of these choices when you
4187 reply to a message, you can change the option
4188 @code{mh-reply-default-reply-to} from its default value of
4189 @samp{Prompt} to one of the choices listed above. You can always edit
4190 the recipients in the draft.
4191
4192 @cindex @samp{repl:} MH profile component
4193 @cindex MH profile component, @samp{repl:}
4194 @cindex MH-Letter mode
4195 @cindex MH-Show mode
4196 @cindex draft
4197 @cindex modes, MH-Letter
4198 @cindex modes, MH-Show
4199
4200 Two windows are then created. One window contains the message to which
4201 you are replying in an MH-Show buffer. Your draft, in MH-Letter mode
4202 (@pxref{Editing Drafts}), is in the other window. If the reply draft
4203 was not one that you expected, check the things that affect the
4204 behavior of @command{repl} which include the @samp{repl:} profile
4205 component and the @file{replcomps} and @file{replgroupcomps} files.
4206
4207 If you supply a prefix argument (as in @kbd{C-u r}), the message you
4208 are replying to is inserted in your reply after having first been run
4209 through @command{mhl} with the format file @file{mhl.reply}. See
4210 @command{mhl}(1) or the section
4211 @uref{@value{MH-BOOK-HOME}/shomes.html#Usisho, Using mhl} in the MH
4212 book to see how you can modify the default @file{mhl.reply} file.
4213
4214 @vindex mh-yank-behavior
4215
4216 Alternatively, you can customize the option @code{mh-yank-behavior}
4217 and choose one of its @samp{Automatically} variants to do the same
4218 thing. @xref{Inserting Letter}. If you do so, the prefix argument has
4219 no effect.
4220
4221 Another way to include the message automatically in your draft is to
4222 use @samp{repl: -filter repl.filter} in your MH profile.
4223
4224 @vindex mh-reply-show-message-flag
4225
4226 If you include the message automatically, you can hide the MH-Show
4227 buffer by turning off the option @code{mh-reply-show-message-flag}.
4228
4229 If you wish to customize the header or other parts of the reply draft,
4230 please see @command{repl}(1) and @code{mh-format}(5).
4231
4232 @node Forwarding, Redistributing, Replying, Sending Mail
4233 @section Forwarding Mail
4234
4235 @cindex @command{forw}
4236 @cindex draft
4237 @cindex forwarding
4238 @cindex MH commands, @command{forw}
4239 @findex mh-forward
4240 @kindex f
4241 @vindex mh-forward-hook
4242
4243 To forward a message, use the @kbd{f} (@code{mh-forward}) command. You
4244 are prompted for the @samp{To:} and @samp{cc:} recipients. You are
4245 given a draft to edit that looks like it would if you had run the MH
4246 command @command{forw}@footnote{See the section
4247 @uref{@value{MH-BOOK-HOME}/forfor.html, Forwarding Messages: forw} in
4248 the MH book.}. You can then add some text (@pxref{Editing Drafts}).
4249 You can forward several messages by using a range (@pxref{Ranges}).
4250 All of the messages in the range are inserted into your draft. The
4251 hook @code{mh-forward-hook} is called on the draft.
4252
4253 @cindex @file{.mh_profile}
4254 @cindex files, @file{.mh_profile}
4255 @cindex MH profile component, @samp{forw:}
4256 @cindex @samp{forw:} MH profile component
4257 @vindex mh-compose-forward-as-mime-flag
4258
4259 By default, the option @code{mh-compose-forward-as-mime-flag} is on
4260 which means that the forwarded messages are included as attachments.
4261 These are inline attachments so the forwarded message should appear in
4262 the body of your recipient's mail program. If you would prefer to
4263 forward your messages verbatim (as text, inline), then turn off this
4264 option. Forwarding messages verbatim works well for short, textual
4265 messages, but your recipient won't be able to view any non-textual
4266 attachments that were in the forwarded message. Be aware that if you
4267 have @samp{forw: -mime} in your MH profile, then forwarded messages
4268 will always be included as attachments regardless of the settings of
4269 @code{mh-compose-forward-as-mime-flag}.
4270
4271 @vindex mh-forward-subject-format
4272
4273 The format of the @samp{Subject:} header field for forwarded messages
4274 is controlled by the option @code{mh-forward-subject-format}. This
4275 option is a string which includes two escapes (@samp{%s}). The first
4276 @samp{%s} is replaced with the sender of the original message, and the
4277 second one is replaced with the original @samp{Subject:}. The default
4278 value of @code{"%s: %s"} takes a message with the header:
4279
4280 @smallexample
4281 @group
4282 To: Bill Wohler <wohler@@stop.mail-abuse.org>
4283 Subject: Re: 49er football
4284 From: Greg DesBrisay <gd@@stop.mail-abuse.org>
4285 @end group
4286 @end smallexample
4287
4288 and creates a subject header field of:
4289
4290 @smallexample
4291 Subject: Greg DesBrisay: Re: 49er football
4292 @end smallexample
4293
4294 @node Redistributing, Editing Again, Forwarding, Sending Mail
4295 @section Redistributing Your Mail
4296
4297 @cindex @command{dist}
4298 @cindex MH commands, @command{dist}
4299 @cindex redistributing
4300 @findex mh-redistribute
4301 @kindex M-d
4302
4303 The command @kbd{M-d} (@code{mh-redistribute}) is similar in function
4304 to forwarding mail, but it does not allow you to edit the message, nor
4305 does it add your name to the @samp{From:} header field. It appears to
4306 the recipient as if the message had come from the original sender.
4307 When you run this command, you are prompted for the recipients.
4308
4309 @findex mh-edit-again
4310 @kindex e
4311
4312 For more information on redistributing messages, see
4313 @command{dist}(1). Also investigate the command @kbd{e}
4314 (@code{mh-edit-again}) for another way to redistribute messages
4315 (@pxref{Editing Again}).
4316
4317 @cindex @command{send}
4318 @cindex MH commands, @command{send}
4319 @vindex mh-redist-full-contents-flag
4320
4321 The option @code{mh-redist-full-contents-flag} must be turned on if
4322 @command{dist}@footnote{See the section
4323 @uref{@value{MH-BOOK-HOME}/disdis.html, Distributing Messages with
4324 dist} in the MH book.} requires the whole letter for redistribution,
4325 which is the case if @command{send}@footnote{See the section
4326 @uref{@value{MH-BOOK-HOME}/sensen.html, Sending Some Mail: comp send}
4327 in the MH book.} is compiled with the @sc{berk} option (which many
4328 people abhor). If you find that MH will not allow you to redistribute
4329 a message that has been redistributed before, turn off this option.
4330
4331 The hook @code{mh-annotate-msg-hook} is run after annotating the
4332 message and scan line (@pxref{Sending Mail}).
4333
4334 @node Editing Again, , Redistributing, Sending Mail
4335 @section Editing Old Drafts and Bounced Messages
4336
4337 @cindex @file{draft}
4338 @cindex files, @file{draft}
4339 @cindex re-editing drafts
4340 @findex mh-edit-again
4341 @kindex F v drafts
4342 @kindex e
4343 @kindex n
4344
4345 If you don't complete a draft for one reason or another, and if the
4346 draft buffer is no longer available, you can pick your draft up again
4347 with @kbd{e} (@code{mh-edit-again}). If you don't use a draft
4348 folder, your last @file{draft} file will be used. If you use draft
4349 folders, you'll need to visit the draft folder with @kbd{F v drafts
4350 @key{RET}}, use @kbd{n} to move to the appropriate message, and then
4351 use @kbd{e} to prepare the message for editing.
4352
4353 @kindex e
4354
4355 The @kbd{e} command can also be used to take messages that were sent
4356 to you and to send them to more people.
4357
4358 @cindex Mailer-Daemon
4359 @findex mh-extract-rejected-mail
4360 @kindex C-c C-c
4361 @kindex E
4362
4363 Don't use @kbd{e} to re-edit a message from a @i{Mailer-Daemon} who
4364 complained that your mail wasn't posted for some reason or another. In
4365 this case, use @kbd{E} (@code{mh-extract-rejected-mail}) to prepare
4366 the message for editing by removing the @i{Mailer-Daemon} envelope and
4367 unneeded header fields. Fix whatever addressing problem you had, and
4368 send the message again with @kbd{C-c C-c}.
4369
4370 @node Editing Drafts, Aliases, Sending Mail, Top
4371 @chapter Editing a Draft
4372
4373 @cindex @samp{Letter} menu
4374 @cindex MH-Letter mode
4375 @cindex draft
4376 @cindex editing draft
4377 @cindex menu, @samp{Letter}
4378 @cindex modes, MH-Letter
4379
4380 When you edit a message that you want to send (called a @dfn{draft} in
4381 this case), the mode used is MH-Letter. This mode provides several
4382 commands in addition to the normal Emacs editing commands to help you
4383 edit your draft. These can also be found in the @samp{Letter} menu.
4384
4385 @table @kbd
4386 @kindex @key{SPC}
4387 @findex mh-letter-complete-or-space
4388 @item @key{SPC}
4389 Perform completion or insert space (@code{mh-letter-complete-or-space}).
4390 @c -------------------------
4391 @kindex M-@key{TAB}
4392 @findex mh-letter-complete
4393 @item M-@key{TAB}
4394 Perform completion on header field or word preceding point
4395 (@code{mh-letter-complete}).
4396 @c -------------------------
4397 @kindex , (comma)
4398 @findex mh-letter-confirm-address
4399 @item , (comma)
4400 Flash alias expansion (@code{mh-letter-confirm-address}).
4401 @c -------------------------
4402 @kindex @key{TAB}
4403 @findex mh-letter-next-header-field-or-indent
4404 @item @key{TAB}
4405 Cycle to next field (@code{mh-letter-next-header-field-or-indent}).
4406 @c -------------------------
4407 @kindex S-@key{TAB}
4408 @findex mh-letter-previous-header-field
4409 @item S-@key{TAB}
4410 Cycle to the previous header field
4411 (@code{mh-letter-previous-header-field}).
4412 @c -------------------------
4413 @kindex C-c ?
4414 @findex mh-help
4415 @item C-c ?
4416 Display cheat sheet for the MH-E commands (@code{mh-help}).
4417 @c -------------------------
4418 @cindex @samp{Letter > Send This Draft} menu item
4419 @cindex menu item, @samp{Letter > Send This Draft}
4420 @kindex C-c C-c
4421 @findex mh-send-letter
4422 @item C-c C-c
4423 Save draft and send message (@code{mh-send-letter}).
4424 @c -------------------------
4425 @kindex C-c C-d
4426 @findex mh-insert-identity
4427 @item C-c C-d
4428 Insert fields specified by the given identity
4429 (@code{mh-insert-identity}). @xref{Identities}.
4430 @c -------------------------
4431 @cindex @samp{Letter > Pull in All Compositions (MH)} menu item
4432 @cindex menu item, @samp{Letter > Pull in All Compositions (MH)}
4433 @kindex C-c C-e
4434 @findex mh-mh-to-mime
4435 @item C-c C-e
4436 Compose @sc{mime} message from MH-style directives
4437 (@code{mh-mh-to-mime}).
4438 @c -------------------------
4439 @kindex C-c C-f C-a
4440 @kindex C-c C-f a
4441 @findex mh-to-field
4442 @item C-c C-f C-a
4443 @itemx C-c C-f a
4444 Move to @samp{Mail-Reply-To:} header field (@code{mh-to-field}).
4445 @c -------------------------
4446 @kindex C-c C-f C-b
4447 @kindex C-c C-f b
4448 @item C-c C-f C-b
4449 @itemx C-c C-f b
4450 Move to @samp{Bcc:} header field (@code{mh-to-field}).
4451 @c -------------------------
4452 @kindex C-c C-f C-c
4453 @kindex C-c C-f c
4454 @item C-c C-f C-c
4455 @itemx C-c C-f c
4456 Move to @samp{Cc:} header field (@code{mh-to-field}).
4457 @c -------------------------
4458 @kindex C-c C-f C-d
4459 @kindex C-c C-f d
4460 @item C-c C-f C-d
4461 @itemx C-c C-f d
4462 Move to @samp{Dcc:} header field (@code{mh-to-field}).
4463 @c -------------------------
4464 @kindex C-c C-f C-f
4465 @kindex C-c C-f f
4466 @findex mh-to-fcc
4467 @item C-c C-f C-f
4468 @itemx C-c C-f f
4469 Move to @samp{Fcc:} header field (@code{mh-to-fcc}).
4470 @c -------------------------
4471 @kindex C-c C-f C-l
4472 @kindex C-c C-f l
4473 @item C-c C-f C-l
4474 @itemx C-c C-f l
4475 Move to @samp{Mail-Followup-To:} header field (@code{mh-to-field}).
4476 @c -------------------------
4477 @kindex C-c C-f C-m
4478 @kindex C-c C-f m
4479 @item C-c C-f C-m
4480 @itemx C-c C-f m
4481 Move to @samp{From:} header field (@code{mh-to-field}).
4482 @c -------------------------
4483 @kindex C-c C-f C-r
4484 @kindex C-c C-f r
4485 @item C-c C-f C-r
4486 @itemx C-c C-f r
4487 Move to @samp{Reply-To:} header field (@code{mh-to-field}).
4488 @c -------------------------
4489 @kindex C-c C-f C-s
4490 @kindex C-c C-f s
4491 @item C-c C-f C-s
4492 @itemx C-c C-f s
4493 Move to @samp{Subject:} header field (@code{mh-to-field}).
4494 @c -------------------------
4495 @kindex C-c C-f C-t
4496 @kindex C-c C-f t
4497 @item C-c C-f C-t
4498 @itemx C-c C-f t
4499 Move to @samp{To:} header field (@code{mh-to-field}).
4500 @c -------------------------
4501 @cindex @samp{Letter > Insert a Message...} menu item
4502 @cindex menu item, @samp{Letter > Insert a Message...}
4503 @kindex C-c C-i
4504 @findex mh-insert-letter
4505 @item C-c C-i
4506 Insert a message (@code{mh-insert-letter}).
4507 @c -------------------------
4508 @kindex C-c C-m C-e
4509 @findex mh-mml-secure-message-encrypt
4510 @item C-c C-m C-e
4511 Add tag to encrypt the message (@code{mh-mml-secure-message-encrypt}).
4512 @c -------------------------
4513 @cindex @samp{Letter > Compose Forward...} menu item
4514 @cindex menu item, @samp{Letter > Compose Forward...}
4515 @kindex C-c C-m C-f
4516 @kindex C-c C-m f
4517 @findex mh-compose-forward
4518 @item C-c C-m C-f
4519 @itemx C-c C-m f
4520 Add tag to forward a message (@code{mh-compose-forward}).
4521 @c -------------------------
4522 @cindex @samp{Letter > Compose Get File (MH)...} menu item
4523 @cindex menu item, @samp{Letter > Compose Get File (MH)...}
4524 @kindex C-c C-m C-g
4525 @kindex C-c C-m g
4526 @findex mh-mh-compose-anon-ftp
4527 @item C-c C-m C-g
4528 @itemx C-c C-m g
4529 Add tag to include anonymous ftp reference to a file
4530 (@code{mh-mh-compose-anon-ftp}).
4531 @c -------------------------
4532 @cindex @samp{Letter > Compose Insertion...} menu item
4533 @cindex menu item, @samp{Letter > Compose Insertion...}
4534 @kindex C-c C-m C-i
4535 @kindex C-c C-m i
4536 @findex mh-compose-insertion
4537 @item C-c C-m C-i
4538 @itemx C-c C-m i
4539 Add tag to include a file such as an image or sound
4540 (@code{mh-compose-insertion}).
4541 @c -------------------------
4542 @cindex @samp{Letter > Pull in All Compositions (MML)} menu item
4543 @cindex menu item, @samp{Letter > Pull in All Compositions (MML)}
4544 @kindex C-c C-m C-m
4545 @kindex C-c C-m m
4546 @findex mh-mml-to-mime
4547 @item C-c C-m C-m
4548 @itemx C-c C-m m
4549 Compose @sc{mime} message from MML tags (@code{mh-mml-to-mime}).
4550 @c -------------------------
4551 @kindex C-c C-m C-n
4552 @kindex C-c C-m n
4553 @findex mh-mml-unsecure-message
4554 @item C-c C-m C-n
4555 @itemx C-c C-m n
4556 Remove any secure message tags (@code{mh-mml-unsecure-message}).
4557 @c -------------------------
4558 @kindex C-c C-m C-s
4559 @findex mh-mml-secure-message-sign
4560 @item C-c C-m C-s
4561 Add tag to sign the message (@code{mh-mml-secure-message-sign}).
4562 @c -------------------------
4563 @cindex @samp{Letter > Compose Compressed tar (MH)...} menu item
4564 @cindex menu item, @samp{Letter > Compose Compressed tar (MH)...}
4565 @kindex C-c C-m C-t
4566 @kindex C-c C-m t
4567 @findex mh-mh-compose-external-compressed-tar
4568 @item C-c C-m C-t
4569 @itemx C-c C-m t
4570 Add tag to include anonymous ftp reference to a compressed tar file
4571 (@code{mh-mh-compose-external-compressed-tar}).
4572 @c -------------------------
4573 @cindex @samp{Letter > Revert to Non-MIME Edit (MH)} menu item
4574 @cindex menu item, @samp{Letter > Revert to Non-MIME Edit (MH)}
4575 @kindex C-c C-m C-u
4576 @kindex C-c C-m u
4577 @findex mh-mh-to-mime-undo
4578 @item C-c C-m C-u
4579 @itemx C-c C-m u
4580 Undo effects of @kbd{C-c C-e} (@code{mh-mh-to-mime-undo}).
4581 @c -------------------------
4582 @kindex C-c C-m C-x
4583 @kindex C-c C-m x
4584 @findex mh-mh-compose-external-type
4585 @item C-c C-m C-x
4586 @itemx C-c C-m x
4587 Add tag to refer to a remote file
4588 (@code{mh-mh-compose-external-type}).
4589 @c -------------------------
4590 @kindex C-c C-m e e
4591 @findex mh-mml-secure-message-encrypt
4592 @item C-c C-m e e
4593 Add tag to encrypt the message (@code{mh-mml-secure-message-encrypt}).
4594 @c -------------------------
4595 @kindex C-c C-m e s
4596 @findex mh-mml-secure-message-signencrypt
4597 @item C-c C-m e s
4598 Add tag to encrypt and sign the message@*
4599 (@code{mh-mml-secure-message-signencrypt}).
4600 @c -------------------------
4601 @kindex C-c C-m s e
4602 @findex mh-mml-secure-message-signencrypt
4603 @item C-c C-m s e
4604 Add tag to encrypt and sign the message@*
4605 (@code{mh-mml-secure-message-signencrypt}).
4606 @c -------------------------
4607 @kindex C-c C-m s s
4608 @findex mh-mml-secure-message-sign
4609 @item C-c C-m s s
4610 Add tag to sign the message (@code{mh-mml-secure-message-sign}).
4611 @c -------------------------
4612 @cindex @samp{Letter > Split Current Line} menu item
4613 @cindex menu item, @samp{Letter > Split Current Line}
4614 @kindex C-c C-o
4615 @findex mh-open-line
4616 @item C-c C-o
4617 Insert a newline and leave point before it (@code{mh-open-line}).
4618 @c -------------------------
4619 @cindex @samp{Letter > Kill This Draft} menu item
4620 @cindex menu item, @samp{Letter > Kill This Draft}
4621 @kindex C-c C-q
4622 @findex mh-fully-kill-draft
4623 @item C-c C-q
4624 Quit editing and delete draft message (@code{mh-fully-kill-draft}).
4625 @c -------------------------
4626 @cindex @samp{Letter > Insert Signature} menu item
4627 @cindex menu item, @samp{Letter > Insert Signature}
4628 @kindex C-c C-s
4629 @findex mh-insert-signature
4630 @item C-c C-s
4631 Insert signature in message (@code{mh-insert-signature}).
4632 @c -------------------------
4633 @kindex C-c C-t
4634 @findex mh-letter-toggle-header-field-display
4635 @item C-c C-t
4636 Toggle display of header field at point
4637 (@code{mh-letter-toggle-header-field-display}).
4638 @c -------------------------
4639 @cindex @samp{Letter > Check Recipient} menu item
4640 @cindex menu item, @samp{Letter > Check Recipient}
4641 @kindex C-c C-w
4642 @findex mh-check-whom
4643 @item C-c C-w
4644 Verify recipients, showing expansion of any aliases
4645 (@code{mh-check-whom}).
4646 @c -------------------------
4647 @cindex @samp{Letter > Yank Current Message} menu item
4648 @cindex menu item, @samp{Letter > Yank Current Message}
4649 @kindex C-c C-y
4650 @findex mh-yank-cur-msg
4651 @item C-c C-y
4652 Insert the current message into the draft buffer
4653 (@code{mh-yank-cur-msg}).
4654 @c -------------------------
4655 @kindex C-c M-d
4656 @findex mh-insert-auto-fields
4657 @item C-c M-d
4658 Insert custom fields if recipient is found in
4659 @code{mh-auto-fields-list} (@code{mh-insert-auto-fields}).
4660 @xref{Identities}.
4661 @end table
4662
4663 @cindex @samp{mh-letter} customization group
4664 @cindex customization group, @samp{mh-letter}
4665
4666 Several options from the @samp{mh-letter} customization group are used
4667 while editing a draft.
4668
4669 @vtable @code
4670 @item mh-compose-insertion
4671 Type of @sc{mime} message tags in messages (default: @samp{MML} if
4672 available; otherwise @samp{MH}).
4673 @c -------------------------
4674 @item mh-compose-skipped-header-fields
4675 List of header fields to skip over when navigating in draft (default:
4676 @code{'("From"} @code{"Organization"} @code{"References"}
4677 @code{"In-Reply-To"} @code{"X-Face"} @code{"Face"}
4678 @code{"X-Image-URL"} @code{"X-Mailer")}.
4679 @c -------------------------
4680 @item mh-compose-space-does-completion-flag
4681 On means @key{SPC} does completion in message header (default:
4682 @samp{off}).
4683 @c -------------------------
4684 @item mh-delete-yanked-msg-window-flag
4685 On means delete any window displaying the message (default: @samp{off}).
4686 @c -------------------------
4687 @item mh-extract-from-attribution-verb
4688 Verb to use for attribution when a message is yanked by @kbd{C-c C-y}
4689 (default: @code{"wrote:"}).
4690 @c -------------------------
4691 @item mh-ins-buf-prefix
4692 String to put before each line of a yanked or inserted message
4693 (default: @code{"> "}).
4694 @c -------------------------
4695 @item mh-letter-complete-function
4696 Function to call when completing outside of address or folder fields
4697 (default: @code{ispell-complete-word}).
4698 @c -------------------------
4699 @item mh-letter-fill-column
4700 Fill column to use in MH-Letter mode (default: 72).
4701 @c -------------------------
4702 @item mh-mml-method-default
4703 Default method to use in security tags (default: @samp{PGP (MIME)} if
4704 support for it is available; otherwise @samp{None}).
4705 @c -------------------------
4706 @item mh-signature-file-name
4707 Source of user's signature (default: @code{"~/.signature"}).
4708 @c -------------------------
4709 @item mh-signature-separator-flag
4710 On means a signature separator should be inserted (default:
4711 @samp{on}).
4712 @c -------------------------
4713 @item mh-x-face-file
4714 File containing X-Face or Face header field to insert in outgoing mail.
4715 (default: @code{"~/.face"}).
4716 @c -------------------------
4717 @item mh-yank-behavior
4718 Controls which part of a message is yanked by @kbd{C-c C-y} (default:
4719 @samp{Body With Attribution}).
4720 @end vtable
4721
4722 The following hooks are available.
4723
4724 @vtable @code
4725 @item mail-citation-hook
4726 Hook for modifying a citation just inserted in the mail buffer
4727 (default: @code{nil}).
4728 @c -------------------------
4729 @item mh-before-send-letter-hook
4730 Hook run at the beginning of the @kbd{C-c C-c} command (default:
4731 @samp{nil}).
4732 @c -------------------------
4733 @item mh-mh-to-mime-hook
4734 Hook run on the formatted letter by @kbd{C-c C-e} (default:
4735 @samp{nil}).
4736 @c -------------------------
4737 @item mh-insert-signature-hook
4738 Hook run by @kbd{C-c C-s} after signature has been inserted (default:
4739 @code{nil}).
4740 @end vtable
4741
4742 The following face is available.
4743
4744 @vtable @code
4745 @item mh-letter-header-field
4746 Editable header field value face in draft buffers.
4747 @end vtable
4748
4749 The commands and options introduced here are explained in more
4750 detail in the following sections.
4751
4752 @menu
4753 * Editing Message::
4754 * Inserting Letter::
4755 * Inserting Messages::
4756 * Signature::
4757 * Picture::
4758 * Adding Attachments::
4759 * Sending PGP::
4760 * Checking Recipients::
4761 * Sending Message::
4762 * Killing Draft::
4763 @end menu
4764
4765 @node Editing Message, Inserting Letter, Editing Drafts, Editing Drafts
4766 @section Editing the Message
4767
4768 @cindex @samp{Bcc:} header field
4769 @cindex @samp{Cc:} header field
4770 @cindex @samp{Dcc:} header field
4771 @cindex @samp{From:} header field
4772 @cindex @samp{Mail-Followup-To:} header field
4773 @cindex @samp{Mail-Reply-To:} header field
4774 @cindex @samp{Reply-To:} header field
4775 @cindex @samp{Subject:} header field
4776 @cindex @samp{To:} header field
4777 @cindex editing header
4778 @cindex header field, @samp{Bcc:}
4779 @cindex header field, @samp{Cc:}
4780 @cindex header field, @samp{Dcc:}
4781 @cindex header field, @samp{From:}
4782 @cindex header field, @samp{Mail-Followup-To:}
4783 @cindex header field, @samp{Mail-Reply-To:}
4784 @cindex header field, @samp{Reply-To:}
4785 @cindex header field, @samp{Subject:}
4786 @cindex header field, @samp{To:}
4787 @findex mh-to-field
4788 @kindex C-c C-f C-t
4789 @kindex C-c C-f t
4790
4791 Because the header is part of the message, you can edit the header
4792 fields as you wish. However, several convenience commands exist to
4793 help you create and edit them. For example, the command @kbd{C-c C-f
4794 C-t} (@code{mh-to-field}; alternatively, @kbd{C-c C-f t}) moves the
4795 cursor to the @samp{To:} header field, creating it if necessary. The
4796 commands for moving to the @samp{Cc:}, @samp{Subject:}, @samp{From:},
4797 @samp{Reply-To:}, @samp{Mail-Reply-To:}, @samp{Mail-Followup-To},
4798 @samp{Bcc:}, and @samp{Dcc:} header fields are similar.
4799
4800 @findex mh-to-fcc
4801 @kindex C-c C-f C-f
4802 @kindex C-c C-f f
4803
4804 One command behaves differently from the others, namely, @kbd{C-c C-f
4805 C-f} (@code{mh-to-fcc}; alternatively, @kbd{C-c C-f f}). This command
4806 will prompt you for the folder name in which to file a copy of the
4807 draft. @xref{Folder Selection}.
4808
4809 @findex indent-relative
4810 @findex mh-letter-next-header-field-or-indent
4811 @findex mh-letter-previous-header-field
4812 @kindex @key{TAB}
4813 @kindex S-@key{TAB}
4814 @vindex mh-compose-skipped-header-fields
4815 @vindex mh-letter-header-field
4816
4817 Within the header of the message, the command@* @key{TAB}
4818 (@code{mh-letter-next-header-field-or-indent}) moves between fields
4819 that are highlighted with the face @code{mh-letter-header-field},
4820 skipping those fields listed in
4821 @code{mh-compose-skipped-header-fields}. After the last field, this
4822 command then moves point to the message body before cycling back to
4823 the first field. If point is already past the first line of the
4824 message body, then this command indents by calling
4825 @code{indent-relative} with the given prefix argument. The command
4826 @kbd{S-@key{TAB}} (@code{mh-letter-previous-header-field}) moves
4827 backwards between the fields and cycles to the body of the message
4828 after the first field. Unlike the command @key{TAB}, it will always
4829 take point to the last field from anywhere in the body.
4830
4831 @cindex alias completion
4832 @cindex completion
4833 @cindex spell check
4834 @findex ispell-complete-word
4835 @findex mh-letter-complete
4836 @findex mh-letter-complete-or-space
4837 @findex mh-letter-confirm-address
4838 @kindex , (comma)
4839 @kindex @key{SPC}
4840 @kindex M-@key{TAB}
4841 @vindex mh-alias-flash-on-comma
4842 @vindex mh-compose-space-does-completion-flag
4843 @vindex mh-letter-complete-function
4844
4845 If the field contains addresses (for example, @samp{To:} or
4846 @samp{Cc:}) or folders (for example, @samp{Fcc:}) then the command
4847 @kbd{M-@key{TAB}} (@code{mh-letter-complete}) will provide alias
4848 completion (@pxref{Aliases}). In the body of the message,
4849 @kbd{M-@key{TAB}} runs @code{mh-letter-complete-function} instead,
4850 which is set to @samp{'ispell-complete-word} by default. The command
4851 @kbd{M-@key{TAB}} (@code{mh-letter-complete}) takes a prefix argument
4852 that is passed to the @code{mh-letter-complete-function}. In addition,
4853 turn on the option @code{mh-compose-space-does-completion-flag} to use
4854 the command @key{SPC} (@code{mh-letter-complete-or-space}) to perform
4855 completion in the header as well; use a prefix argument to specify
4856 more than one space. Addresses are separated by a comma; when you
4857 press the comma, the command @code{mh-letter-confirm-address} flashes
4858 the alias expansion in the minibuffer if
4859 @code{mh-alias-flash-on-comma} is turned on.
4860
4861 @c XXX Document the replacement for the inaccessible 'long argument.
4862
4863 @findex mh-letter-toggle-header-field-display
4864 @kindex C-c C-t
4865
4866 Use the command @kbd{C-c C-t}
4867 @code{mh-letter-toggle-header-field-display} to display truncated
4868 header fields. This command is a toggle so entering it again will hide
4869 the field. This command takes a prefix argument: if negative then the
4870 field is hidden, if positive then the field is displayed (for example,
4871 @kbd{C-u C-c C-t}).
4872
4873 Be sure to leave a row of dashes or a blank line between the header
4874 and the body of the message.
4875
4876 @vindex mh-letter-fill-column
4877
4878 The body of the message is edited as you would edit any Emacs buffer
4879 although there are a few commands and options to assist you. You can
4880 change the fill column in MH-Letter mode with the option
4881 @code{mh-letter-fill-column}. By default, this option is 72 to allow
4882 others to quote your message without line wrapping.
4883
4884 @cindex filling paragraphs
4885 @cindex paragraphs, filling
4886 @findex fill-paragraph
4887 @kindex M-q
4888 @vindex mh-ins-buf-prefix
4889
4890 You'll often include messages that were sent from user agents that
4891 haven't yet realized that paragraphs consist of more than a single
4892 line. This makes for long lines that wrap in an ugly fashion. You'll
4893 find that @kbd{M-q} (@code{fill-paragraph}) works well even on these
4894 quoted messages, even if they are nested, just as long as all of the
4895 quotes match the value of @code{mh-ins-buf-prefix} (@pxref{Inserting
4896 Letter}). For example, let's assume you have the following in your
4897 draft:
4898
4899 @smallexample
4900 @group
4901 > Hopefully this gives you an idea of what I'm currently doing. I'm \
4902 not sure yet whether I'm completely satisfied with my setup, but \
4903 it's worked okay for me so far.
4904 @end group
4905 @end smallexample
4906
4907 Running @kbd{M-q} on this paragraph produces:
4908
4909 @smallexample
4910 @group
4911 > Hopefully this gives you an idea of what I'm currently doing. I'm not
4912 > sure yet whether I'm completely satisfied with my setup, but it's
4913 > worked okay for me so far.
4914 @end group
4915 @end smallexample
4916
4917 @findex mh-open-line
4918 @findex open-line
4919 @kindex C-c C-o
4920 @kindex C-o
4921
4922 The command @kbd{C-c C-o} (@code{mh-open-line}) is similar to the
4923 command @kbd{C-o} (@code{open-line}) in that it inserts a newline
4924 after point. It differs in that it also inserts the right number of
4925 quoting characters and spaces so that the next line begins in the same
4926 column as it was. This is useful when breaking up paragraphs in
4927 replies. For example, if this command was used when point was after
4928 the first period in the paragraph above, the result would be this:
4929
4930 @smallexample
4931 @group
4932 > Hopefully this gives you an idea of what I'm currently doing.
4933
4934 > I'm not
4935 > sure yet whether I'm completely satisfied with my setup, but it's
4936 > worked okay for me so far.
4937 @end group
4938 @end smallexample
4939
4940 @node Inserting Letter, Inserting Messages, Editing Message, Editing Drafts
4941 @section Inserting Letter to Which You're Replying
4942
4943 @cindex inserting messages
4944 @cindex replying to messages
4945 @cindex yanking messages
4946 @findex mh-yank-cur-msg
4947 @kindex C-c C-y
4948 @vindex mh-ins-buf-prefix
4949
4950 It is often useful to insert a snippet of text from a letter that
4951 someone mailed to provide some context for your reply. The command
4952 @kbd{C-c C-y} (@code{mh-yank-cur-msg}) does this by adding an
4953 attribution, yanking a portion of text from the message to which
4954 you're replying, and inserting @code{mh-ins-buf-prefix} (@samp{> })
4955 before each line.
4956
4957 @smallexample
4958 @group
4959 Michael W Thelen <thelenm@@stop.mail-abuse.org> wrote:
4960
4961 > Hopefully this gives you an idea of what I'm currently doing. I'm not
4962 > sure yet whether I'm completely satisfied with my setup, but it's
4963 > worked okay for me so far.
4964 @end group
4965 @end smallexample
4966
4967 @vindex mh-extract-from-attribution-verb
4968
4969 The attribution consists of the sender's name and email address
4970 followed by the content of the option
4971 @code{mh-extract-from-attribution-verb}. This option can be set to
4972 @samp{wrote:}, @samp{a écrit:}, and @samp{schrieb:}. You can also use
4973 the @samp{Custom String} menu item to enter your own verb.
4974
4975 @vindex mail-citation-hook
4976 @vindex mh-ins-buf-prefix
4977 @vindex mh-yank-behavior
4978
4979 The prefix @code{"> "} is the default setting for the option
4980 @code{mh-ins-buf-prefix}. I suggest that you not modify this option
4981 since it is used by many mailers and news readers: messages are far
4982 easier to read if several included messages have all been indented by
4983 the same string. This prefix is not inserted if you use one of the
4984 supercite flavors of @code{mh-yank-behavior} or you have added a
4985 @code{mail-citation-hook} as described below.
4986
4987 @vindex mh-delete-yanked-msg-window-flag
4988
4989 You can also turn on the @code{mh-delete-yanked-msg-window-flag}
4990 option to delete the window containing the original message after
4991 yanking it to make more room on your screen for your reply.
4992
4993 @cindex Emacs, packages, supercite
4994 @cindex supercite package
4995 @kindex r
4996 @vindex mail-citation-hook
4997 @vindex mh-yank-behavior
4998
4999 You can control how the message to which you are replying is yanked
5000 into your reply using @code{mh-yank-behavior}. To include the entire
5001 message, including the entire header, use @samp{Body and
5002 Header}@footnote{If you'd rather have the header cleaned up, use
5003 @kbd{C-u r} instead of @kbd{r} when replying
5004 (@pxref{Replying}).}@footnote{In the past you would use this setting
5005 and set @code{mail-citation-hook} to @samp{supercite}, but this usage
5006 is now deprecated in favor of the @samp{Invoke supercite} setting.}.
5007 Use @samp{Body} to yank just the body without the header. To yank only
5008 the portion of the message following the point, set this option to
5009 @samp{Below Point}.
5010
5011 Choose @samp{Invoke supercite}@footnote{@emph{Supercite} is a
5012 full-bodied, full-featured, citation package that comes standard with
5013 Emacs.} to pass the entire message and header through supercite.
5014
5015 @vindex mh-extract-from-attribution-verb
5016
5017 If the @samp{Body With Attribution} setting is used, then the message
5018 minus the header is yanked and a simple attribution line is added at
5019 the top using the value of the option
5020 @code{mh-extract-from-attribution-verb}. This is the default.
5021
5022 @kindex C-c C-y
5023 @vindex mh-delete-yanked-msg-window-flag
5024
5025 If the @samp{Invoke supercite} or @samp{Body With Attribution}
5026 settings are used, the @samp{-noformat} argument is passed to the
5027 @command{repl} program to override a @samp{-filter} or @samp{-format}
5028 argument. These settings also have @samp{Automatically} variants that
5029 perform the action automatically when you reply so that you don't need
5030 to use @kbd{C-c C-y} at all. Note that this automatic action is only
5031 performed if the show buffer matches the message being replied to.
5032 People who use the automatic variants tend to turn on the option
5033 @code{mh-delete-yanked-msg-window-flag} as well so that the show
5034 window is never displayed.
5035
5036 @vindex mh-yank-behavior
5037
5038 If the show buffer has a region, the option @code{mh-yank-behavior} is
5039 ignored unless its value is one of @samp{Attribution} variants in
5040 which case the attribution is added to the yanked region.
5041
5042 @findex trivial-cite
5043 @vindex mail-citation-hook
5044 @vindex mh-ins-buf-prefix
5045 @vindex mh-yank-behavior
5046
5047 If this isn't enough, you can gain full control over the appearance of
5048 the included text by setting @code{mail-citation-hook} to a function
5049 that modifies it. This hook is ignored if the option
5050 @code{mh-yank-behavior} is set to one of the supercite flavors.
5051 Otherwise, this option controls how much of the message is passed to
5052 the hook. The function can find the citation between point and mark
5053 and it should leave point and mark around the modified citation text
5054 for the next hook function. The standard prefix
5055 @code{mh-ins-buf-prefix} is not added if this hook is set.
5056
5057 @cindex Emacs, packages, trivial-cite
5058 @cindex trivial-cite package
5059 @vindex mh-yank-behavior
5060
5061 For example, if you use the hook function
5062 @uref{http://shasta.cs.uiuc.edu/~lrclause/tc.html,
5063 @code{trivial-cite}} (which is NOT part of Emacs), set
5064 @code{mh-yank-behavior} to @samp{Body and Header}.
5065
5066 @node Inserting Messages, Signature, Inserting Letter, Editing Drafts
5067 @section Inserting Messages
5068
5069 @cindex inserting messages
5070 @findex mh-insert-letter
5071 @findex mh-yank-behavior
5072 @kindex C-c C-i
5073 @vindex mh-ins-buf-prefix
5074 @vindex mh-invisible-header-fields-compiled
5075 @vindex mh-yank-behavior
5076
5077 Messages can be inserted with @kbd{C-c C-i} (@code{mh-insert-letter}).
5078 This command prompts you for the folder and message number, which
5079 defaults to the current message in that folder. It then inserts the
5080 messages, indented by @code{mh-ins-buf-prefix} (@samp{> }) unless
5081 @code{mh-yank-behavior} is set to one of the supercite flavors in
5082 which case supercite is used to format the message. Certain
5083 undesirable header fields (see
5084 @code{mh-invisible-header-fields-compiled}) are removed before
5085 insertion.
5086
5087 If given a prefix argument (like @kbd{C-u C-c C-i}), the header is
5088 left intact, the message is not indented, and @samp{> } is not
5089 inserted before each line. This command leaves the mark before the
5090 letter and point after it.
5091
5092 @node Signature, Picture, Inserting Messages, Editing Drafts
5093 @section Inserting Your Signature
5094
5095 @cindex signature
5096 @findex mh-insert-signature
5097 @kindex C-c C-s
5098
5099 You can insert your signature at the current cursor location with the
5100 command @kbd{C-c C-s} (@code{mh-insert-signature}).
5101
5102 @cindex files, @file{.signature}
5103 @cindex @file{.signature}
5104 @cindex vCard
5105 @vindex mh-signature-file-name
5106
5107 By default, the text of your signature is taken from the file
5108 @file{~/.signature}. You can read from other sources by changing the
5109 option @code{mh-signature-file-name}. This file may contain a
5110 @dfn{vCard} in which case an attachment is added with the vCard.
5111
5112 @findex mh-signature-separator-p
5113 @vindex mh-signature-file-name
5114 @vindex mh-signature-separator
5115 @vindex mh-signature-separator-regexp
5116
5117 The option @code{mh-signature-file-name} may also be a symbol, in
5118 which case that function is called. You may not want a signature
5119 separator to be added for you; instead you may want to insert one
5120 yourself. Options that you may find useful to do this include
5121 @code{mh-signature-separator} (when inserting a signature separator)
5122 and @code{mh-signature-separator-regexp} (for finding said separator).
5123 The function @code{mh-signature-separator-p}, which reports @code{t}
5124 if the buffer contains a separator, may be useful as well.
5125
5126 @cindex signature separator
5127 @vindex mh-signature-separator-flag
5128
5129 A signature separator (@code{"-- "}) will be added if the signature
5130 block does not contain one and @code{mh-signature-separator-flag} is
5131 on. It is not recommended that you change this option since various
5132 mail user agents, including MH-E, use the separator to present the
5133 signature differently, and to suppress the signature when replying or
5134 yanking a letter into a draft.
5135
5136 @vindex mh-insert-signature-hook
5137 @vindex mh-signature-file-name
5138
5139 The hook @code{mh-insert-signature-hook} is run after the signature is
5140 inserted. Hook functions may access the actual name of the file or the
5141 function used to insert the signature with
5142 @code{mh-signature-file-name}.
5143
5144 The signature can also be inserted using Identities.
5145 @xref{Identities}.
5146
5147 @node Picture, Adding Attachments, Signature, Editing Drafts
5148 @section Inserting Your Picture
5149
5150 @cindex @file{.face}
5151 @cindex files, @file{.face}
5152 @vindex mh-x-face-file
5153
5154 You can insert your picture in the header of your mail message so that
5155 recipients see your face in the @samp{From:} header field if their
5156 mail user agent is sophisticated enough. In MH-E, this is done by
5157 placing your image in the file named by the option
5158 @code{mh-x-face-file} which is @file{~/.face} by default.
5159
5160 @cindex @samp{Face:} header field
5161 @cindex @samp{X-Face:} header field
5162 @cindex @samp{X-Image-URL:} header field
5163 @cindex header field, @samp{Face:}
5164 @cindex header field, @samp{X-Face:}
5165 @cindex header field, @samp{X-Image-URL:}
5166
5167 If the file starts with either of the strings @samp{X-Face:},
5168 @samp{Face:} or @samp{X-Image-URL:} then the contents are added to the
5169 message header verbatim. Otherwise it is assumed that the file
5170 contains the value of the @samp{X-Face:} header field.
5171
5172 @cindex @command{compface}
5173 @cindex Unix commands, @command{compface}
5174
5175 The @samp{X-Face:} header field, which is a low-resolution, black and
5176 white image, can be generated using the
5177 @uref{ftp://ftp.cs.indiana.edu/pub/faces/compface/compface.tar.Z,
5178 @command{compface}} command. The @uref{http://www.dairiki.org/xface/,
5179 @cite{Online X-Face Converter}} is a useful resource for quick
5180 conversion of images into @samp{X-Face:} header fields.
5181
5182 Use the @uref{http://quimby.gnus.org/circus/face/make-face,
5183 @command{make-face}} script to convert a JPEG image to the higher
5184 resolution, color, @samp{Face:} header field.
5185
5186 The URL of any image can be used for the @samp{X-Image-URL:} field and
5187 no processing of the image is required.
5188
5189 @vindex mh-x-face-file
5190
5191 To prevent the setting of any of these header fields, either set
5192 @code{mh-x-face-file} to @code{nil}, or simply ensure that the file
5193 defined by this option doesn't exist.
5194
5195 @xref{Viewing}, to see how these header fields are displayed in MH-E.
5196
5197 @node Adding Attachments, Sending PGP, Picture, Editing Drafts
5198 @section Adding Attachments
5199
5200 @cindex @command{mhbuild}
5201 @cindex @command{mhn}
5202 @cindex MH commands, @command{mhbuild}
5203 @cindex MH commands, @command{mhn}
5204 @cindex MIME
5205 @cindex multimedia mail
5206
5207 MH-E has the capability to create multimedia messages. It uses the
5208 @sc{mime} (Multipurpose Internet Mail Extensions)
5209 protocol@footnote{@sc{mime} is defined in
5210 @uref{http://www.rfc-editor.org/rfc/rfc2045.txt, RFC 2045}.} The
5211 @sc{mime} protocol allows you to incorporate images, sound, video,
5212 binary files, and even commands that fetch a file with @samp{ftp} when
5213 your recipient reads the message!
5214
5215 @kindex C-c C-m
5216
5217 If you were to create a multimedia message with plain MH commands, you
5218 would insert @command{mhbuild} or @command{mhn} directives (henceforth
5219 called @dfn{MH-style directives} into your draft and use the
5220 @command{mhbuild} command in nmh or @command{mhn} command in MH and
5221 GNU mailutils to expand them. MH-E works in much the same way,
5222 although it provides a handful of commands prefixed with @kbd{C-c C-m}
5223 to insert the directives so you don't need to remember the syntax of
5224 them. Remember: you can always add MH-style directives by
5225 hand@footnote{See the section
5226 @uref{@value{MH-BOOK-HOME}/usimim.html#SeMIMa, Sending MIME Mail} in
5227 the MH book.}.
5228
5229 @cindex MIME Meta Language (MML)
5230 @cindex MML
5231 @vindex mh-compose-insertion
5232
5233 In addition to MH-style directives, MH-E also supports MML (@sc{mime}
5234 Meta Language) tags@footnote{
5235 @ifinfo
5236 @c Although the third argument should default to the
5237 @c first, makeinfo goes to the wrong Info file without it being
5238 @c different--it seems to be getting our own Composing node.
5239 @xref{Composing,,Composing with MML,emacs-mime}.
5240 @end ifinfo
5241 @ifnotinfo
5242 See the section Composing in
5243 @uref{http://www.gnus.org/manual/emacs-mime.html, @cite{The Emacs MIME
5244 Manual}}.
5245 @end ifnotinfo
5246 }. The option @code{mh-compose-insertion} can be used to choose
5247 between them. By default, this option is set to @samp{MML} if it is
5248 supported since it provides a lot more functionality. This option can
5249 also be set to @samp{MH} if MH-style directives are preferred.
5250
5251 @cindex media types
5252 @cindex MIME, media types
5253
5254 The MH-E @sc{mime} commands require a @dfn{media type} for each body
5255 part or attachment. For example, a PDF document is of type
5256 @samp{application/pdf} and an HTML document is of type
5257 @samp{text/html}. Some commands fill in the media type for you,
5258 whereas others require you to enter one.
5259
5260 @cindex @command{file}
5261 @cindex @file{/etc/mime.types}
5262 @cindex files, @file{/etc/mime.types}
5263 @cindex Unix commands, @command{file}
5264 @findex mailcap-mime-types
5265
5266 In the cases where MH-E can do so, it will determine the media type
5267 automatically. It uses the @command{file} command to do this. Failing
5268 that, the Emacs function @code{mailcap-mime-types} is used to provide
5269 a list from which to choose. This function usually reads the file
5270 @file{/etc/mime.types}.
5271
5272 Whether the media type is chosen automatically, or you choose it from
5273 a list, use the type that seems to match best the file that you are
5274 including. In the case of binaries, the media type
5275 @samp{application/x-executable} can be useful. If you can't find an
5276 appropriate media type, use @samp{text/plain} for text messages and
5277 @samp{application/octet-stream} for everything else.
5278
5279 @cindex content description
5280 @cindex MIME, content description
5281
5282 You are also sometimes asked for a @dfn{content description}. This is
5283 simply an optional brief phrase, in your own words, that describes the
5284 object. If you don't care to enter a content description, just press
5285 return and none will be included; however, a reader may skip over
5286 multimedia fields unless the content description is compelling.
5287
5288 You can also create your own @sc{mime} body parts. In the following
5289 example, I describe how you can create and edit a @samp{text/enriched}
5290 body part to liven up your plain text messages with boldface,
5291 underlining, and italics. I include an Emacs function which inserts
5292 enriched text tags.
5293
5294 @smalllisp
5295 @group
5296 (defvar enriched-text-types '(("b" . "bold") ("i" . "italic")
5297 ("u" . "underline")
5298 ("s" . "smaller") ("B" . "bigger")
5299 ("f" . "fixed")
5300 ("c" . "center"))
5301 "Alist of (final-character . tag) choices for add-enriched-text.
5302 Additional types can be found in RFC 1563.")
5303
5304 (defun add-enriched-text (begin end)
5305 "Add enriched text tags around region.
5306 The tag used comes from the list enriched-text-types and is
5307 specified by the last keystroke of the command. When called from Lisp,
5308 arguments are BEGIN and END@."
5309 (interactive "r")
5310 ;; @r{Set type to the tag indicated by the last keystroke.}
5311 (let ((type (cdr (assoc (char-to-string (logior last-input-char ?@w{`}))
5312 enriched-text-types))))
5313 (save-restriction ; @r{restores state from narrow-to-region}
5314 (narrow-to-region begin end) ; @r{narrow view to region}
5315 (goto-char (point-min)) ; @r{move to beginning of text}
5316 (insert "<" type ">") ; @r{insert beginning tag}
5317 (goto-char (point-max)) ; @r{move to end of text}
5318 (insert "</" type ">")))) ; @r{insert terminating tag}
5319 @i{Emacs function for entering enriched text}
5320
5321 @end group
5322 @end smalllisp
5323
5324 To use the function @code{add-enriched-text}, first add it to
5325 @file{~/.emacs} and create key bindings for it (@pxref{Composing}).
5326
5327 Then, in your plain text message, set the mark with @kbd{C-@@} or
5328 @kbd{C-@key{SPC}}, type in the text to be highlighted, and type @kbd{C-c t
5329 b}. This adds @samp{<bold>} where you set the mark and adds
5330 @samp{</bold>} at the location of your cursor, giving you something
5331 like: @samp{You should be <bold>very</bold>}.
5332
5333 Before sending this message, use @kbd{C-c C-m C-m}
5334 (@code{mh-mml-to-mime})@footnote{Use @kbd{C-c C-e}
5335 (@code{mh-mh-to-mime}) if you're using MH-style directives.} to add
5336 MIME header fields. Then replace @samp{text/plain} with
5337 @samp{text/enriched} in the @samp{Content-Type:} header field.
5338
5339 You may also be interested in investigating @code{sgml-mode}.
5340
5341 @subheading Including Files
5342
5343 @cindex attachments, inserting
5344 @cindex images
5345 @cindex MIME, images
5346 @cindex MIME, sound
5347 @cindex MIME, video
5348 @cindex sound
5349 @cindex video
5350 @findex mh-compose-insertion
5351 @kindex C-c C-m C-i
5352 @kindex C-c C-m i
5353 @vindex mh-compose-insertion
5354
5355 Binaries, images, sound, and video can be inserted in your message
5356 with the command @kbd{C-c C-m C-i} (@code{mh-compose-insertion}). You
5357 are prompted for the filename containing the object, the media type if
5358 it cannot be determined automatically, and a content description. If
5359 you're using MH-style directives, you will also be prompted for
5360 additional attributes.
5361
5362 @subheading Forwarding Multimedia Messages
5363
5364 @findex mh-compose-forward
5365 @kindex C-c C-m C-f
5366 @kindex C-c C-m f
5367
5368 Mail may be forwarded with @sc{mime} using the command @kbd{C-c C-m
5369 C-f} (@code{mh-compose-forward}). You are prompted for a content
5370 description, the name of the folder in which the messages to forward
5371 are located, and a range of messages, which defaults to the current
5372 message in that folder. @xref{Ranges}.
5373
5374 @subheading Including an FTP Reference
5375
5376 @cindex @command{ftp}
5377 @cindex MIME, @command{ftp}
5378 @cindex Unix commands, @command{ftp}
5379 @findex mh-mh-compose-anon-ftp
5380 @kindex C-c C-m C-g
5381 @kindex C-c C-m g
5382
5383 You can have your message initiate an @command{ftp} transfer when the
5384 recipient reads the message. To do this, use the command @kbd{C-c C-m
5385 C-g} (@code{mh-mh-compose-anon-ftp}). You are prompted for the remote
5386 host and filename, the media type, and the content description.
5387
5388 @subheading Including tar Files
5389
5390 @cindex @command{ftp}
5391 @cindex @command{tar}
5392 @cindex MIME, @command{ftp}
5393 @cindex MIME, @command{tar}
5394 @cindex Unix commands, @command{ftp}
5395 @cindex Unix commands, @command{tar}
5396 @findex mh-mh-compose-anon-ftp
5397 @findex mh-mh-compose-external-compressed-tar
5398 @kindex C-c C-m C-g
5399 @kindex C-c C-m C-t
5400 @kindex C-c C-m t
5401
5402 If the remote file is a compressed tar file, you can use @kbd{C-c C-m
5403 C-t} (@code{mh-mh-compose-external-compressed-tar}). Then, in addition
5404 to retrieving the file via anonymous @emph{ftp} as per the command
5405 @kbd{C-c C-m C-g} (@code{mh-mh-compose-anon-ftp}), the file will also
5406 be uncompressed and untarred. You are prompted for the remote host and
5407 filename and the content description.
5408
5409 @subheading Including Other External Files
5410
5411 @findex mh-mh-compose-external-type
5412 @kindex C-c C-m C-x
5413 @kindex C-c C-m x
5414
5415 The command @kbd{C-c C-m C-x} (@code{mh-mh-compose-external-type}) is
5416 a general utility for referencing external files. In fact, all of the
5417 other commands that insert tags to access external files call this
5418 command. You are prompted for the access type, remote host and
5419 filename, and content type. If you provide a prefix argument, you are
5420 also prompted for a content description, attributes, parameters, and a
5421 comment.
5422
5423 @subheading Previewing Multimedia Messages
5424
5425 When you are finished editing a @sc{mime} message, it might look like this:
5426
5427 @cartouche
5428 @smallexample
5429 3 t08/24 root received fax files on Wed Aug 24 11:00:
5430 4+t08/24 To:wohler Test<<This is a test message to get the
5431
5432
5433
5434
5435
5436 --:%% @{+inbox@} 4 msgs (1-4) Bot L4 (MH-Folder Show)---------------
5437 To: wohler
5438 cc:
5439 Subject: Test of MIME
5440 --------
5441 Here is the SETI@@Home logo:
5442
5443 <#part type="image/x-xpm" filename="~/lib/images/setiathome.xpm"
5444 disposition=inline description="SETI@@home logo">
5445 <#/part>
5446 --:** @{draft@} All L8 (MH-Letter)----------------------------------
5447
5448 @end smallexample
5449 @end cartouche
5450 @i{MH-E @sc{mime} draft}
5451
5452 @findex mh-mml-to-mime
5453 @kindex C-c C-m C-m
5454 @kindex C-c C-m m
5455
5456 Typically, you send a message with attachments just like any other
5457 message (@pxref{Sending Message}).
5458
5459 @findex mh-mml-to-mime
5460 @kindex C-c C-m C-m
5461
5462 However, you may take a sneak preview of the @sc{mime} encoding if you
5463 wish by running the command @kbd{C-c C-m C-m} (@code{mh-mml-to-mime}).
5464 The following screen shows the @sc{mime} encoding specified by the
5465 tags. You can see why mail user agents are usually built to hide these
5466 details from the user.
5467
5468 @cartouche
5469 @smallexample
5470 To: wohler
5471 cc:
5472 Subject: Test of MIME
5473 X-Mailer: MH-E 8.1; nmh 1.1; GNU Emacs 23.1
5474 MIME-Version: 1.0
5475 Content-Type: multipart/mixed; boundary="=-=-="
5476 --------
5477 --=-=-=
5478
5479 Here is the SETI@@Home logo:
5480
5481
5482 --=-=-=
5483 Content-Type: image/x-xpm
5484 Content-Disposition: inline; filename=setiathome.xpm
5485 Content-Transfer-Encoding: base64
5486 Content-Description: SETI@@home logo
5487
5488 LyogWFBNICovCnN0YXRpYyBjaGFyICogc2V0aWF0aG9tZV94cG1bXSA9IHsKIjQ1IDQ1IDc2N
5489 --:-- @{draft@} Top L1 (MH-Letter)----------------------------------
5490
5491 @end smallexample
5492 @end cartouche
5493 @i{MH-E @sc{mime} draft ready to send}
5494
5495 @cindex undo effects of mh-mml-to-mime
5496
5497 This action can be undone by running @kbd{C-_} (@code{undo}).
5498
5499 @cindex @command{mhbuild}
5500 @cindex @command{mhn}
5501 @cindex MH commands, @command{mhbuild}
5502 @cindex MH commands, @command{mhn}
5503 @cindex undo effects of mh-mh-to-mime
5504 @findex mh-mh-to-mime
5505 @findex mh-mh-to-mime-undo
5506 @kindex C-c C-e
5507 @kindex C-c C-m C-m
5508 @kindex C-c C-m C-u
5509 @kindex C-c C-m u
5510
5511 If you're using MH-style directives, use @kbd{C-c C-e}
5512 (@code{mh-mh-to-mime}) instead of @kbd{C-c C-m C-m}. This runs the
5513 command @command{mhbuild} (@command{mhn}) on the message which expands
5514 the tags@footnote{See the section
5515 @uref{@value{MH-BOOK-HOME}/usimim.html#SeMIMa, Sending MIME Mail} in
5516 the MH book.}. This action can be undone by running @kbd{C-c C-m C-u}
5517 (@code{mh-mh-to-mime-undo}), which works by reverting to a backup
5518 file. You are prompted to confirm this action, but you can avoid the
5519 confirmation by adding an argument (for example, @kbd{C-u C-c C-m
5520 C-u}).
5521
5522 @kindex C-c C-e
5523 @vindex mh-mh-to-mime-args
5524
5525 If you wish to pass additional arguments to @command{mhbuild}
5526 (@command{mhn}) to affect how it builds your message, use the option
5527 @code{mh-mh-to-mime-args}. For example, you can build a consistency
5528 check into the message by setting @code{mh-mh-to-mime-args} to
5529 @samp{-check}. The recipient of your message can then run
5530 @samp{mhbuild -check} on the message---@command{mhbuild}
5531 (@command{mhn}) will complain if the message has been corrupted on the
5532 way. The command @kbd{C-c C-e} only consults this option when given a
5533 prefix argument (as in @kbd{C-u C-c C-e}).
5534
5535 @kindex C-c C-e
5536 @vindex mh-mh-to-mime-hook
5537
5538 The hook @code{mh-mh-to-mime-hook} is called after the message has
5539 been formatted by @kbd{C-c C-e}.
5540
5541 @node Sending PGP, Checking Recipients, Adding Attachments, Editing Drafts
5542 @section Signing and Encrypting Messages
5543
5544 @cindex signing messages
5545 @cindex encrypting messages
5546 @cindex RFC 3156
5547
5548 MH-E can sign and encrypt messages as defined in
5549 @uref{http://www.rfc-editor.org/rfc/rfc3156.txt, RFC 3156}. If you
5550 should choose to sign or encrypt your message, use one of the
5551 following commands to do so any time before sending your message.
5552
5553 @findex mh-mml-secure-message-encrypt
5554 @findex mh-mml-secure-message-sign
5555 @findex mh-mml-secure-message-signencrypt
5556 @kindex C-c C-m C-e
5557 @kindex C-c C-m C-s
5558 @kindex C-c C-m e e
5559 @kindex C-c C-m e s
5560 @kindex C-c C-m s e
5561 @kindex C-c C-m s s
5562
5563 The command @kbd{C-c C-m C-s} (@code{mh-mml-secure-message-sign})
5564 inserts the following tag:
5565
5566 @smallexample
5567 <#secure method=pgpmime mode=sign>
5568 @end smallexample
5569
5570 This is used to sign your message digitally. Likewise, the command
5571 @kbd{C-c C-m C-e} (@code{mh-mml-secure-message-encrypt}) inserts the
5572 following tag:
5573
5574 @smallexample
5575 <#secure method=pgpmime mode=encrypt>
5576 @end smallexample
5577
5578 This is used to encrypt your message. Finally, the command @kbd{C-c
5579 C-m s e} (@code{mh-mml-secure-message-signencrypt}) inserts the
5580 following tag:
5581
5582 @smallexample
5583 <#secure method=pgpmime mode=signencrypt>
5584 @end smallexample
5585
5586 @findex mh-mml-unsecure-message
5587 @kindex C-c C-m C-n
5588 @kindex C-c C-m n
5589 @vindex mh-mml-method-default
5590
5591 This is used to sign and encrypt your message. In each of these cases,
5592 a proper multipart message is created for you when you send the
5593 message. Use the command @kbd{C-c C-m C-n}
5594 (@code{mh-mml-unsecure-message}) to remove these tags. Use a prefix
5595 argument (as in @kbd{C-u C-c C-m s e}) to be prompted for one of the
5596 possible security methods (see @code{mh-mml-method-default}).
5597
5598 @vindex mh-mml-method-default
5599
5600 The option @code{mh-mml-method-default} is used to select between a
5601 variety of mail security mechanisms. The default is @samp{PGP (MIME)}
5602 if it is supported; otherwise, the default is @samp{None}. Other
5603 mechanisms include vanilla @samp{PGP} and @samp{S/MIME}.
5604
5605 @cindex @samp{pgg} customization group
5606 @cindex PGG
5607 @cindex customization group, @samp{pgg}
5608
5609 The @samp{pgg} customization group may have some settings which may
5610 interest you.
5611 @iftex
5612 See @cite{The PGG Manual}.
5613 @end iftex
5614 @ifinfo
5615 @xref{Top, , The PGG Manual, pgg, The PGG Manual}.
5616 @end ifinfo
5617 @ifhtml
5618 See
5619 @uref{http://www.dk.xemacs.org/Documentation/packages/html/pgg.html,
5620 @cite{The PGG Manual}}.
5621 @end ifhtml
5622
5623 @cindex header field, @samp{Fcc:}
5624 @cindex @samp{Fcc:} header field
5625 @vindex pgg-encrypt-for-me
5626
5627 In particular, I turn on the option @code{pgg-encrypt-for-me} so that
5628 all messages I encrypt are encrypted with my public key as well. If
5629 you keep a copy of all of your outgoing mail with a @samp{Fcc:} header
5630 field, this setting is vital so that you can read the mail you write!
5631
5632 @node Checking Recipients, Sending Message, Sending PGP, Editing Drafts
5633 @section Checking Recipients
5634
5635 @cindex @samp{*MH-E Recipients*}
5636 @cindex @command{whom}
5637 @cindex MH commands, @command{whom}
5638 @cindex buffers, @samp{*MH-E Recipients*}
5639 @cindex checking recipients
5640 @cindex recipients, checking
5641 @findex mh-check-whom
5642 @kindex C-c C-w
5643
5644 The command @kbd{C-c C-w} (@code{mh-check-whom}) expands aliases so
5645 you can check the actual address(es) in the alias. A new buffer named
5646 @samp{*MH-E Recipients*} is created with the output of @command{whom}
5647 (@pxref{Miscellaneous})@footnote{See the section
5648 @uref{@value{MH-BOOK-HOME}/senove.html#WhaPro, What now? -- and the
5649 whatnow Program} in the MH book.}.
5650
5651 @node Sending Message, Killing Draft, Checking Recipients, Editing Drafts
5652 @section Sending a Message
5653
5654 @cindex buffers, @samp{*MH-E Mail Delivery*}
5655 @cindex @samp{*MH-E Mail Delivery*}
5656 @cindex sending mail
5657 @findex mh-send-letter
5658 @kindex C-c C-c
5659
5660 When you are all through editing a message, you send it with the
5661 command @kbd{C-c C-c} (@code{mh-send-letter}). You can give a prefix
5662 argument (as in @kbd{C-u C-c C-c}) to monitor the first stage of the
5663 delivery; this output can be found in a buffer called @samp{*MH-E Mail
5664 Delivery*} (@pxref{Miscellaneous}).
5665
5666 @cindex sending mail
5667 @cindex spell check
5668 @findex ispell-message
5669 @kindex C-c C-c
5670 @vindex mh-before-send-letter-hook
5671
5672 The hook @code{mh-before-send-letter-hook} is run at the beginning of
5673 the command @kbd{C-c C-c}. For example, if you want to check your
5674 spelling in your message before sending, add the function
5675 @code{ispell-message}.
5676
5677 @cindex @command{send}
5678 @cindex MH commands, @command{send}
5679 @vindex mh-send-prog
5680
5681 In case the MH @command{send} program@footnote{See the section
5682 @uref{@value{MH-BOOK-HOME}/sensen.html, Sending Some Mail: comp send}
5683 in the MH book.} is installed under a different name, use
5684 @code{mh-send-prog} to tell MH-E the name.
5685
5686 The hook @code{mh-annotate-msg-hook} is run after annotating the
5687 message and scan line (@pxref{Sending Mail}).
5688
5689 @node Killing Draft, , Sending Message, Editing Drafts
5690 @section Killing the Draft
5691
5692 @cindex killing draft
5693 @findex kill-buffer
5694 @findex mh-fully-kill-draft
5695 @kindex C-c C-q
5696 @kindex C-x k
5697
5698 If for some reason you are not happy with the draft, you can use the
5699 command @kbd{C-c C-q} (@code{mh-fully-kill-draft}) to kill the draft
5700 buffer and delete the draft message. Use the command @kbd{C-x k}
5701 (@code{kill-buffer}) if you don't want to delete the draft message.
5702
5703 @node Aliases, Identities, Editing Drafts, Top
5704 @chapter Aliases
5705
5706 @cindex aliases
5707
5708 MH aliases are used in the same way in MH-E as they are in MH. Any
5709 alias listed as a recipient will be expanded when the message is sent.
5710 This chapter discusses other things you can do with aliases in MH-E.
5711
5712 @cindex MH-Letter mode
5713 @cindex modes, MH-Letter
5714
5715 The following commands are available in MH-Letter mode with the
5716 exception of @code{mh-alias-reload} which can be called from anywhere.
5717
5718 @table @kbd
5719 @kindex @key{SPC}
5720 @findex mh-letter-complete-or-space
5721 @item @key{SPC}
5722 Perform completion or insert space (@code{mh-letter-complete-or-space}).
5723 @c -------------------------
5724 @kindex M-@key{TAB}
5725 @findex mh-letter-complete
5726 @item M-@key{TAB}
5727 Perform completion on header field or word preceding point
5728 (@code{mh-letter-complete}).
5729 @c -------------------------
5730 @findex mh-alias-apropos
5731 @item mh-alias-apropos
5732 Show all aliases or addresses that match a regular expression.
5733 @c -------------------------
5734 @findex mh-alias-grab-from-field
5735 @item mh-alias-grab-from-field
5736 Add alias for the sender of the current message
5737 @c -------------------------
5738 @findex mh-alias-reload
5739 @item mh-alias-reload
5740 Reload MH aliases.
5741 @end table
5742
5743 @cindex @samp{mh-alias} customization group
5744 @cindex customization group, @samp{mh-alias}
5745
5746 The @samp{mh-alias} customization group contains options associated
5747 with aliases.
5748
5749 @vtable @code
5750 @item mh-alias-completion-ignore-case-flag
5751 On means don't consider case significant in MH alias completion
5752 (default: @samp{on}).
5753 @c -------------------------
5754 @item mh-alias-expand-aliases-flag
5755 On means to expand aliases entered in the minibuffer (default:
5756 @samp{off}).
5757 @c -------------------------
5758 @item mh-alias-flash-on-comma
5759 Specify whether to flash address or warn on translation (default: @samp{Flash
5760 but Don't Warn If No Alias}).
5761 @c -------------------------
5762 @item mh-alias-insert-file
5763 Filename used to store a new MH-E alias (default: @samp{Use Aliasfile
5764 Profile Component}).
5765 @c -------------------------
5766 @item mh-alias-insertion-location
5767 Specifies where new aliases are entered in alias files (default:
5768 @samp{Alphabetical}).
5769 @c -------------------------
5770 @item mh-alias-local-users
5771 If @samp{on}, local users are added to alias completion (default:
5772 @samp{on}).
5773 @c -------------------------
5774 @item mh-alias-local-users-prefix
5775 String prefixed to the real names of users from the password file
5776 (default: @code{"local."}.
5777 @c -------------------------
5778 @item mh-alias-passwd-gecos-comma-separator-flag
5779 On means the GECOS field in the password file uses a comma separator
5780 (default: @samp{on}).
5781 @end vtable
5782
5783 The following hook is available.
5784
5785 @vtable @code
5786 @item mh-alias-reloaded-hook
5787 Hook run by @code{mh-alias-reload} after loading aliases (default:
5788 @code{nil}).
5789 @end vtable
5790
5791 @subheading Adding Addresses to Draft
5792
5793 You can use aliases when you are adding recipients to a message.
5794
5795 @findex minibuffer-complete
5796 @kindex @key{TAB}
5797 @vindex mh-alias-expand-aliases-flag
5798 @vindex mh-compose-prompt-flag
5799
5800 In order to use minibuffer prompting for recipients and the subject
5801 line in the minibuffer, turn on the option
5802 @code{mh-compose-prompt-flag} (@pxref{Composing}), and use the
5803 @key{TAB} (@code{minibuffer-complete}) command to complete aliases
5804 (and optionally local logins) when prompted for the recipients. Turn
5805 on the option @code{mh-alias-expand-aliases-flag} if you want these
5806 aliases to be expanded to their respective addresses in the draft.
5807
5808 @findex mh-letter-complete
5809 @findex mh-letter-complete-or-space
5810 @kindex @key{SPC}
5811 @kindex M-@key{TAB}
5812
5813 Otherwise, you can complete aliases in the header of the draft with
5814 @kbd{M-@key{TAB}} (@code{mh-letter-complete}) or @key{SPC}
5815 (@code{mh-letter-complete-or-space}).
5816
5817 @vindex mh-alias-completion-ignore-case-flag
5818
5819 As MH ignores case in the aliases, so too does MH-E. However, you may
5820 turn off the option @code{mh-alias-completion-ignore-case-flag} to
5821 make case significant which can be used to segregate completion of
5822 your aliases. You might use uppercase for mailing lists and lowercase
5823 for people. For example, you might have:
5824
5825 @smallexample
5826 mark.baushke: Mark Baushke <mdb@@stop.mail-abuse.org>
5827 MH-E: MH-E Mailing List <mh-e-devel@@stop.mail-abuse.org>
5828 @end smallexample
5829
5830 When this option is turned off, if you were to type @kbd{M} in the
5831 @samp{To:} field and then @kbd{M-@key{TAB}}, then you'd get the list;
5832 if you started with @kbd{m} and then entered @kbd{M-@key{TAB}}, then
5833 you'd get Mark's address. Note that this option affects completion
5834 only. If you were to enter @kbd{Mark.Baushke}, it would still be
5835 identified with your @samp{mark.baushke} alias.
5836
5837 @findex mh-alias-minibuffer-confirm-address
5838 @findex mh-letter-confirm-address
5839 @vindex mh-alias-flash-on-comma
5840 @vindex mh-compose-prompt-flag
5841
5842 To verify that the alias you've entered is valid, the alias will be
5843 displayed in the minibuffer when you type a comma
5844 (@code{mh-letter-confirm-address} or
5845 @code{mh-alias-minibuffer-confirm-address} if the option
5846 @code{mh-compose-prompt-flag} is turned on). @xref{Composing}. This
5847 behavior can be controlled with the option
5848 @code{mh-alias-flash-on-comma} which provides three choices:
5849 @samp{Flash but Don't Warn If No Alias}, @samp{Flash and Warn If No
5850 Alias}, and @samp{Don't Flash Nor Warn If No Alias}.
5851
5852 For another way to verify the alias expansion, see @ref{Checking
5853 Recipients}.
5854
5855 @subheading Loading Aliases
5856
5857 @cindex @command{ali}
5858 @cindex @file{/etc/nmh/MailAliases}
5859 @cindex @samp{Aliasfile:} MH profile component
5860 @cindex MH commands, @command{ali}
5861 @cindex MH profile component, @samp{Aliasfile:}
5862 @cindex files, @file{/etc/nmh/MailAliases}
5863
5864 MH-E loads aliases for completion and folder name hints from various
5865 places. It uses the MH command @command{ali}@footnote{See the section
5866 @uref{@value{MH-BOOK-HOME}/mh.html, MH Aliases} in the MH book.} to
5867 read aliases from the files listed in the profile component
5868 @samp{Aliasfile:} as well as system-wide aliases (for example,
5869 @file{/etc/nmh/MailAliases}).
5870
5871 @cindex @file{/etc/passwd}
5872 @cindex files, @file{/etc/passwd}
5873
5874 In addition, aliases are created from @file{/etc/passwd} entries with
5875 a user ID larger than a magical number, typically 200. This can be a
5876 handy tool on a machine where you and co-workers exchange messages.
5877 These aliases have the form @samp{local.@var{first.last}} if a real
5878 name is present in the password file. Otherwise, the alias will have
5879 the form @samp{local.@var{login}}.
5880
5881 @vindex mh-alias-local-users-prefix
5882
5883 The prefix @samp{local.} can be modified via the option
5884 @code{mh-alias-local-users-prefix}. This option can also be set to
5885 @samp{Use Login}.
5886
5887 For example, consider the following password file entry:
5888
5889 @smallexample
5890 psg:x:1000:1000:Peter S Galbraith,,,:/home/psg:/bin/tcsh
5891 @end smallexample
5892
5893 @vindex mh-alias-local-users-prefix
5894
5895 The following settings of option @code{mh-alias-local-users-prefix}
5896 will produce the associated aliases:
5897
5898 @table @code
5899 @item "local."
5900 local.peter.galbraith
5901 @c -------------------------
5902 @item ""
5903 peter.galbraith
5904 @c -------------------------
5905 @item Use Login
5906 psg
5907 @end table
5908
5909 @vindex mh-alias-passwd-gecos-comma-separator-flag
5910
5911 In the example above, commas are used to separate different values
5912 within the so-called GECOS field. This is a fairly common usage.
5913 However, in the rare case that the GECOS field in your password file
5914 is not separated by commas and whose contents may contain commas, you
5915 can turn the option @code{mh-alias-passwd-gecos-comma-separator-flag}
5916 off.
5917
5918 @cindex NIS, obtaining local aliases from
5919 @cindex @samp{ypcat passwd}
5920 @vindex mh-alias-local-users
5921
5922 If you're on a system with thousands of users you don't know, and the
5923 loading of local aliases slows MH-E down noticeably, then the local
5924 alias feature can be disabled by turning off the option
5925 @code{mh-alias-local-users}. This option also takes a string which is
5926 executed to generate the password file. For example, use @samp{ypcat
5927 passwd} to obtain the NIS password file.
5928
5929 @findex mh-alias-reload
5930 @kindex M-x mh-alias-reload
5931 @vindex mh-alias-reloaded-hook
5932
5933 Since aliases are updated frequently, MH-E reloads aliases
5934 automatically whenever an alias lookup occurs if an alias source has
5935 changed. However, you can reload your aliases manually by calling the
5936 command @kbd{M-x mh-alias-reload} directly. This command runs
5937 @code{mh-alias-reloaded-hook} after the aliases have been loaded.
5938
5939 @subheading Adding Aliases
5940
5941 In the past, you have manually added aliases to your alias file(s)
5942 listed in your @samp{Aliasfile:} profile component. MH-E provides
5943 other methods for maintaining your alias file(s).
5944
5945 @findex mh-alias-add-alias
5946 @kindex M-x mh-alias-add-alias
5947
5948 You can use the @kbd{M-x mh-alias-add-alias} command which will prompt
5949 you for the alias and address that you would like to add. If the alias
5950 exists already, you will have the choice of inserting the new alias
5951 before or after the old alias. In the former case, this alias will be
5952 used when sending mail to this alias. In the latter case, the alias
5953 serves as an additional folder name hint when filing messages
5954 (@pxref{Folder Selection}).
5955
5956 Earlier, the alias prefix @samp{local} was presented. You can use
5957 other prefixes to organize your aliases or disambiguate entries. You
5958 might use prefixes for locales, jobs, or activities. For example, I
5959 have:
5960
5961 @smallexample
5962 @group
5963 ; Work
5964 attensity.don.mitchell: Don Mitchell <dmitchell@@stop.mail-abuse.com>
5965 isharp.don.mitchell: Don Mitchell <donaldsmitchell@@stop.mail-abuse.com>
5966 ...
5967 ; Sport
5968 diving.ken.mayer: Ken Mayer <kmayer@@stop.mail-abuse.com>
5969 sailing.mike.maloney: Mike Maloney <mmaloney@@stop.mail-abuse.com>
5970 ...
5971 ; Personal
5972 ariane.kolkmann: Ariane Kolkmann <ArianeKolkmann@@stop.mail-abuse.com>
5973 ...
5974 @end group
5975 @end smallexample
5976
5977 Using prefixes instead of postfixes helps you explore aliases during
5978 completion. If you forget the name of an old dive buddy, you can enter
5979 @samp{div} and then @key{SPC} to get a listing of all your dive buddies.
5980
5981 @kindex M-x mh-alias-add-address-under-point
5982 @kindex M-x mh-alias-grab-from-field
5983
5984 An alias for the sender of the current message is added automatically
5985 by clicking on the @samp{Grab From alias} tool bar button or by running
5986 the @kbd{M-x mh-alias-grab-from-field} command. Aliases for other
5987 recipients of the current message are added by placing your cursor
5988 over the desired recipient and giving the @kbd{M-x
5989 mh-alias-add-address-under-point} command.
5990
5991 @vindex mh-alias-insert-file
5992 @vindex mh-alias-insertion-location
5993
5994 The options @code{mh-alias-insert-file} and
5995 @code{mh-alias-insertion-location} controls how and where these aliases
5996 are inserted.
5997
5998 @vindex mh-alias-insert-file
5999
6000 The default setting of option @code{mh-alias-insert-file} is @samp{Use
6001 Aliasfile Profile Component}. This option can also hold the name of a
6002 file or a list a file names. If this option is set to a list of file
6003 names, or the @samp{Aliasfile:} profile component contains more than
6004 one file name, MH-E will prompt for one of them.
6005
6006 @vindex mh-alias-insertion-location
6007
6008 The option @code{mh-alias-insertion-location} is set to
6009 @samp{Alphabetical} by default. If you organize your alias file in
6010 other ways, then the settings @samp{Top} and @samp{Bottom} might be
6011 more appropriate.
6012
6013 @subheading Querying Aliases
6014
6015 @cindex regular expressions, @code{mh-alias-apropos}
6016 @findex mh-alias-apropos
6017 @kindex M-x mh-alias-apropos
6018
6019 If you can't quite remember an alias, you can use @kbd{M-x
6020 mh-alias-apropos} to show all aliases or addresses that match a
6021 regular expression
6022 @ifnothtml
6023 (@pxref{Regexps, , Syntax of Regular Expressions, emacs, The
6024 GNU Emacs Manual}).
6025 @end ifnothtml
6026 @ifhtml
6027 (see the section
6028 @uref{http://www.gnu.org/software/emacs/manual/html_node/Regexps.html,
6029 Syntax of Regular Expressions} in
6030 @cite{The GNU Emacs Manual}).
6031 @end ifhtml
6032
6033 @node Identities, Speedbar, Aliases, Top
6034 @chapter Identities
6035
6036 @cindex identities
6037 @cindex multiple personalities
6038
6039 MH-E supports the concept of multiple personalities or identities.
6040 This means that you can easily have a different header and signature
6041 at home and at work.
6042
6043 @cindex @samp{Identity} menu
6044 @cindex menu, @samp{Identity}
6045
6046 A couple of commands are used to insert identities in MH-Letter mode
6047 which are also found in the @samp{Identity} menu.
6048
6049 @table @kbd
6050 @kindex C-c C-d
6051 @findex mh-insert-identity
6052 @item C-c C-d
6053 Insert fields specified by given identity (@code{mh-insert-identity}).
6054 @c -------------------------
6055 @cindex @samp{Identity > Insert Auto Fields} menu item
6056 @cindex menu item, @samp{Identity > Insert Auto Fields}
6057 @kindex C-c M-d
6058 @findex mh-insert-auto-fields
6059 @item C-c M-d
6060 Insert custom fields if recipient found in @code{mh-auto-fields-list}
6061 (@code{mh-insert-auto-fields}).
6062 @end table
6063
6064 @cindex @samp{mh-identity} customization group
6065 @cindex customization group, @samp{mh-identity}
6066
6067 The @samp{mh-identity} customization group contains the following
6068 options.
6069
6070 @vtable @code
6071 @item mh-auto-fields-list
6072 List of recipients for which header lines are automatically inserted
6073 (default: @code{nil}).
6074 @c -------------------------
6075 @item mh-auto-fields-prompt-flag
6076 On means to prompt before sending if fields inserted (default:
6077 @samp{on})
6078 @c -------------------------
6079 @item mh-identity-default
6080 Default identity to use when @code{mh-letter-mode} is called (default:
6081 @samp{None}).
6082 @c -------------------------
6083 @item mh-identity-handlers
6084 Handler functions for fields in @code{mh-identity-list}.
6085 @c -------------------------
6086 @item mh-identity-list
6087 List of identities (default: @code{nil}).
6088 @end vtable
6089
6090 Some of the common header fields that people change depending on the
6091 context are the @samp{From:} and @samp{Organization:} fields, as well
6092 as the signature.
6093
6094 @vindex mh-identity-list
6095
6096 This is done by customizing the option @code{mh-identity-list}. In the
6097 customization buffer for this option, click on the @samp{INS} button
6098 and enter a label such as @samp{Home} or @samp{Work}. Then click on
6099 the @samp{INS} button with the label @samp{Add at least one item
6100 below}. The @samp{Value Menu} has the following menu items:
6101
6102 @table @samp
6103 @cindex header field, @samp{From:}
6104 @cindex @samp{From:} header field
6105 @item From Field
6106 Specify an alternate @samp{From:} header field. You must include a
6107 valid email address. A standard format is @samp{First Last
6108 <login@@host.domain>}. If you use an initial with a period, then you
6109 must quote your name as in @samp{"First I. Last"
6110 <login@@host.domain>}.
6111 @c -------------------------
6112 @cindex header field, @samp{Organization:}
6113 @cindex @samp{Organization:} header field
6114 @item Organization Field
6115 People usually list the name of the company where they work here.
6116 @c -------------------------
6117 @item Other Field
6118 Set any arbitrary header field and value here. Unless the header field
6119 is a standard one, precede the name of your field's label with
6120 @samp{X-}, as in @samp{X-Fruit-of-the-Day:}.
6121 @c -------------------------
6122 @item Attribution Verb
6123 This value overrides the setting of
6124 @code{mh-extract-from-attribution-verb}. @xref{Inserting Letter}.
6125 @c -------------------------
6126 @cindex signature
6127 @vindex mh-signature-file-name
6128 @item Signature
6129 Set your signature with this item. You can specify the contents of
6130 @code{mh-signature-file-name}, a file, or a function.
6131 @xref{Signature}.
6132 @c -------------------------
6133 @item GPG Key ID
6134 Specify a different key to sign or encrypt messages.
6135 @end table
6136
6137 @cindex Identity menu
6138 @cindex menu, Identity
6139 @findex mh-insert-identity
6140 @kindex C-c C-d
6141
6142 You can select the identities you have added via the menu called
6143 @samp{Identity} in the MH-Letter buffer. You can also use @kbd{C-c
6144 C-d} (@code{mh-insert-identity}). To clear the fields and signature
6145 added by the identity, select the @samp{None} identity.
6146
6147 @cindex menu item, @samp{Identity > Customize Identities}
6148 @cindex menu item, @samp{Identity > Save as Default}
6149 @cindex menu item, @samp{Identity > Set Default for Session}
6150 @cindex @samp{Identity > Customize Identities} menu item
6151 @cindex @samp{Identity > Save as Default} menu item
6152 @cindex @samp{Identity > Set Default for Session} menu item
6153 @vindex mh-identity-default
6154
6155 The @samp{Identity} menu contains two other items to save you from
6156 having to set the identity on every message. The menu item @samp{Set
6157 Default for Session} can be used to set the default identity to the
6158 current identity until you exit Emacs. The menu item @samp{Save as
6159 Default} sets the option @code{mh-identity-default} to the current
6160 identity setting. You can also customize the option
6161 @code{mh-identity-default} in the usual fashion. If you find that you
6162 need to add another identity, the menu item @samp{Customize
6163 Identities} is available for your convenience.
6164
6165 @cindex regular expressions, @code{mh-auto-fields-list}
6166 @vindex mh-auto-fields-list
6167
6168 The option @code{mh-auto-fields-list} can also be used to set the
6169 identity depending on the recipient to provide even more control. To
6170 customize @code{mh-auto-fields-list}, click on the @samp{INS} button
6171 and enter a regular expression for the recipient's address
6172 @ifnothtml
6173 (@pxref{Regexps, , Syntax of Regular Expressions, emacs, The
6174 GNU Emacs Manual}).
6175 @end ifnothtml
6176 @ifhtml
6177 (see the section
6178 @uref{http://www.gnu.org/software/emacs/manual/html_node/Regexps.html,
6179 Syntax of Regular Expressions} in
6180 @cite{The GNU Emacs Manual}).
6181 @end ifhtml
6182 Click on the @samp{INS} button with the @samp{Add at least one item
6183 below} label. The @samp{Value Menu} contains the following menu items:
6184
6185 @table @samp
6186 @item Identity
6187 Select an identity from those configured in @code{mh-identity-list}.
6188 All of the information for that identity will be added if the
6189 recipient matches.
6190 @c -------------------------
6191 @cindex @samp{Fcc:} header field
6192 @cindex header field, @samp{Fcc:}
6193 @item Fcc Field
6194 Insert an @samp{Fcc:} header field with the folder you provide. When
6195 you send the message, MH will put a copy of your message in this
6196 folder.
6197 @c -------------------------
6198 @cindex @samp{Mail-Followup-To:} header field
6199 @cindex header field, @samp{Mail-Followup-To:}
6200 @item Mail-Followup-To Field
6201 Insert an @samp{Mail-Followup-To:} header field with the recipients
6202 you provide. If the recipient's mail user agent supports this header
6203 field@footnote{@samp{Mail-Followup-To:} is supported by nmh.}, then
6204 their replies will go to the addresses listed. This is useful if their
6205 replies go both to the list and to you and you don't have a mechanism
6206 to suppress duplicates. If you reply to someone not on the list, you
6207 must either remove the @samp{Mail-Followup-To:} field, or ensure the
6208 recipient is also listed there so that he receives replies to your
6209 reply.
6210 @c -------------------------
6211 @item Other Field
6212 Other header fields may be added using this menu item.
6213 @end table
6214
6215 @findex mh-insert-auto-fields
6216 @kindex C-c M-d
6217 @vindex mh-auto-fields-prompt-flag
6218
6219 These fields can only be added after the recipient is known. Because
6220 you can continue to add recipients as you edit the draft, MH-E waits
6221 until the message is sent to perform the auto-insertions. This seems
6222 strange at first, but you'll get used to it. There are two ways to
6223 help you feel that the desired fields are added. The first is the
6224 action when the message is sent: if any fields are added
6225 automatically, you are given a chance to see and to confirm these
6226 fields before the message is actually sent. You can do away with this
6227 confirmation by turning off the option
6228 @code{mh-auto-fields-prompt-flag}. The second method is manual: once
6229 the header contains one or more recipients, you may run the command
6230 @kbd{C-c M-d} (@code{mh-insert-auto-fields}) or choose the
6231 @samp{Identity -> Insert Auto Fields} menu item to insert these fields
6232 manually. However, if you use this command, the automatic insertion
6233 when the message is sent is disabled.
6234
6235 @vindex mh-auto-fields-list
6236 @vindex mh-identity-list
6237
6238 You should avoid using the same header field in
6239 @code{mh-auto-fields-list} and @code{mh-identity-list} definitions
6240 that may apply to the same message as the result is undefined.
6241
6242 @vindex mh-identity-handlers
6243 @vindex mh-identity-list
6244
6245 The option @code{mh-identity-handlers} is used to change the way that
6246 fields, signatures, and attributions in @code{mh-identity-list} are
6247 added. To customize @code{mh-identity-handlers}, replace the name of
6248 an existing handler function associated with the field you want to
6249 change with the name of a function you have written. You can also
6250 click on an @samp{INS} button and insert a field of your choice and
6251 the name of the function you have written to handle it.
6252
6253 @vindex mh-identity-list
6254
6255 The @samp{Field} field can be any field that you've used in your
6256 @code{mh-identity-list}. The special fields @samp{:attribution-verb},
6257 @samp{:signature}, or @samp{:pgg-default-user-id} are used for the
6258 @code{mh-identity-list} choices @samp{Attribution Verb},
6259 @samp{Signature}, and @samp{GPG Key ID} respectively.
6260
6261 The handler associated with the @samp{:default} field is used when no
6262 other field matches.
6263
6264 The handler functions are passed two or three arguments: the field
6265 itself (for example, @samp{From}), or one of the special fields (for
6266 example, @samp{:signature}), and the action @samp{'remove} or
6267 @samp{'add}. If the action is @samp{'add}, an additional argument
6268 containing the value for the field is given.
6269
6270 @node Speedbar, Menu Bar, Identities, Top
6271 @chapter The Speedbar
6272
6273 @cindex folder navigation
6274 @cindex speedbar
6275 @findex mh-visit-folder
6276 @kindex F v
6277 @kindex M-x speedbar
6278 @kindex Mouse-2
6279
6280 You can also use the speedbar
6281 @ifnothtml
6282 (@pxref{Speedbar, , Speedbar Frames, emacs, The GNU Emacs Manual},)
6283 @end ifnothtml
6284 @ifhtml
6285 (see the section
6286 @uref{http://www.gnu.org/software/emacs/manual/html_node/Speedbar.html,
6287 Speedbar Frames} in @cite{The GNU Emacs Manual})
6288 @end ifhtml
6289 to view your folders. To bring up the speedbar, run @kbd{M-x speedbar
6290 @key{RET}}. You will see a new frame appear with all of your MH
6291 folders. Folders with unseen messages appear in boldface. Click on a
6292 folder name with @kbd{Mouse-2} to visit that folder in a similar
6293 fashion to the command @kbd{F v} (@code{mh-visit-folder})
6294 (@pxref{Folders}). Click on the @samp{+} icon to expand and view the
6295 sub-folders of that folder.
6296
6297 The speedbar can be manipulated with the keyboard as well. Use the
6298 Emacs navigational keys (like the arrow keys, or @kbd{C-n}) to move
6299 the cursor over the desired folder and then use the shortcuts for the
6300 menu items listed in the table below.
6301
6302 @table @samp
6303 @findex mh-speed-view
6304 @item Visit Folder (@key{RET})
6305 Visits the selected folder just as if you had used @kbd{F v}
6306 (@code{mh-speed-view}).
6307 @c -------------------------
6308 @findex mh-speed-expand-folder
6309 @item Expand Nested Folders (@kbd{+})
6310 Expands the selected folder in the speedbar, exposing the children
6311 folders inside it (@code{mh-speed-expand-folder}).
6312 @c -------------------------
6313 @findex mh-speed-contract-folder
6314 @item Contract Nested Folders (@kbd{-})
6315 Contracts or collapses the selected folder in the speedbar, hiding the
6316 children folders inside it (@code{mh-speed-contract-folder}).
6317 @c -------------------------
6318 @findex mh-speed-refresh
6319 @item Refresh Speedbar (@kbd{r})
6320 Regenerates the list of folders in the speedbar. Run this command if
6321 you've added or deleted a folder, or want to update the unseen message
6322 count before the next automatic update (@code{mh-speed-refresh}).
6323 @end table
6324
6325 @findex delete-frame
6326 @kindex C-x 5 0
6327 @kindex Mouse-3
6328
6329 You can click on @kbd{Mouse-3} to bring up a context menu that
6330 contains these items. Dismiss the speedbar with @kbd{C-x 5 0}
6331 (@code{delete-frame}).
6332
6333 @cindex @command{flists}
6334 @cindex MH commands, @command{flists}
6335 @cindex @samp{mh-speedbar} customization group
6336 @cindex customization group, @samp{mh-speedbar}
6337
6338 The MH-E speedbar uses the MH command @command{flists}@footnote{See
6339 the section @uref{@value{MH-BOOK-HOME}/morseq.html#flist, Searching for
6340 Sequences with flist} in the MH book.} to generate the list of
6341 folders. The @samp{mh-speedbar} customization group contains the
6342 following option which controls how often the speedbar calls
6343 @command{flists}.
6344
6345 @vtable @code
6346 @item mh-speed-update-interval
6347 Time between speedbar updates in seconds (default: 60). Set to 0 to
6348 disable automatic update.
6349 @end vtable
6350
6351 You can modify the appearance of the folders in the speedbar by
6352 customizing the following faces.
6353
6354 @vtable @code
6355 @item mh-speedbar-folder
6356 Basic folder face.
6357 @c -------------------------
6358 @item mh-speedbar-folder-with-unseen-messages
6359 Folder face when folder contains unread messages.
6360 @c -------------------------
6361 @item mh-speedbar-selected-folder
6362 Selected folder face.
6363 @c -------------------------
6364 @item mh-speedbar-selected-folder-with-unseen-messages
6365 Selected folder face when folder contains unread messages.
6366 @end vtable
6367
6368 @node Menu Bar, Tool Bar, Speedbar, Top
6369 @chapter The Menu Bar
6370
6371 @cindex @samp{Folder} menu
6372 @cindex @samp{Identity} menu
6373 @cindex @samp{Letter} menu
6374 @cindex @samp{Message} menu
6375 @cindex @samp{Search} menu
6376 @cindex @samp{Sequence} menu
6377 @cindex Folder menu
6378 @cindex Identity menu
6379 @cindex Letter menu
6380 @cindex MH-Folder mode
6381 @cindex MH-Letter mode
6382 @cindex MH-Search mode
6383 @cindex Message menu
6384 @cindex Search menu
6385 @cindex Sequence menu
6386 @cindex menu bar
6387 @cindex menu, Folder
6388 @cindex menu, Identity
6389 @cindex menu, Letter
6390 @cindex menu, Message
6391 @cindex menu, Search
6392 @cindex menu, Sequence
6393 @cindex menu, @samp{Folder}
6394 @cindex menu, @samp{Identity}
6395 @cindex menu, @samp{Letter}
6396 @cindex menu, @samp{Message}
6397 @cindex menu, @samp{Search}
6398 @cindex menu, @samp{Sequence}
6399 @cindex modes, MH-Folder
6400 @cindex modes, MH-Letter
6401 @cindex modes, MH-Search
6402
6403 For those of you who prefer to mouse and menu instead of using the
6404 meta-coke-bottle-bucky keys, MH-E provides menu items for most of its
6405 functions. The MH-Folder buffer adds the @samp{Folder},
6406 @samp{Message}, and @samp{Sequence} menus. The MH-Letter buffer adds
6407 the @samp{Identity} and @samp{Letter} menus. The MH-Search buffer adds
6408 the @samp{Search} menu. There's no need to list the actual items here,
6409 as you can more easily see them for yourself, and the functions are
6410 already described elsewhere in this manual.
6411
6412 For a description of the menu bar, please
6413 @ifnothtml
6414 @xref{Menu Bar, , The Menu Bar, emacs, The GNU Emacs Manual}.
6415 @end ifnothtml
6416 @ifhtml
6417 see the section
6418 @uref{http://www.gnu.org/software/emacs/manual/html_node/Menu-Bar.html,
6419 The Menu Bar} in @cite{The GNU Emacs Manual}.
6420 @end ifhtml
6421
6422 The Emacs manual describes how to get online help for a particular
6423 menu item. You can also look up a menu item in the index of this
6424 manual in two ways: all of the menu items are listed alphabetically,
6425 and you can also browse all of the items under the index entry
6426 @samp{menu item}.
6427
6428 @node Tool Bar, Searching, Menu Bar, Top
6429 @chapter The Tool Bar
6430
6431 @cindex tool bar
6432
6433 Emacs also provides a graphical tool bar. For a description of the
6434 tool bar, please
6435 @ifnothtml
6436 @xref{Tool Bars, , Tool Bars, emacs, The GNU Emacs Manual}.
6437 @end ifnothtml
6438 @ifhtml
6439 see the section
6440 @uref{http://www.gnu.org/software/emacs/manual/html_node/Tool-Bars.html,
6441 Tool Bars} in @cite{The GNU Emacs Manual}.
6442 @end ifhtml
6443
6444 @cindex @samp{mh-tool-bar} customization group
6445 @cindex customization group, @samp{mh-tool-bar}
6446
6447 MH-E adds several icons to this tool bar; you can modify the MH-E
6448 aspects of the tool bar via the @samp{mh-tool-bar} customization group.
6449
6450 @vtable @code
6451 @item mh-tool-bar-folder-buttons
6452 List of buttons to include in MH-Folder tool bar (default: a checklist
6453 too long to list here).
6454 @c -------------------------
6455 @item mh-tool-bar-letter-buttons
6456 List of buttons to include in MH-Letter tool bar (default: a checklist
6457 too long to list here).
6458 @c -------------------------
6459 @item mh-tool-bar-search-function
6460 Function called by the tool bar search button (default:
6461 @code{mh-search}).
6462 @c -------------------------
6463 @item mh-xemacs-tool-bar-position
6464 Tool bar location (default: @samp{Same As Default Tool Bar}).
6465 @c -------------------------
6466 @item mh-xemacs-use-tool-bar-flag
6467 If @samp{on}, use tool bar (default: @samp{on}, if supported).
6468 @end vtable
6469
6470 In GNU Emacs, icons for some of MH-E's functions are added to the tool
6471 bar. In XEmacs, you have the opportunity to create a separate tool bar for
6472 the MH-E icons.
6473
6474 @vindex mh-tool-bar-folder-buttons
6475 @vindex mh-tool-bar-letter-buttons
6476
6477 In either case, you can select which of these functions you'd like to
6478 see by customizing the options @code{mh-tool-bar-folder-buttons} and
6479 @code{mh-tool-bar-letter-buttons}. As you probably guessed, the former
6480 customizes the tool bar in MH-Folder mode and the latter in MH-Letter
6481 mode. Both of these options present you with a list of functions;
6482 check the functions whose icons you want to see and clear the check
6483 boxes for those you don't.
6484
6485 @findex mh-search
6486 @vindex mh-tool-bar-search-function
6487
6488 The function associated with the searching icon can be set via the
6489 option @code{mh-tool-bar-search-function}. By default, this is set to
6490 @code{mh-search}. @xref{Searching}. You can also choose @samp{Other
6491 Function} from the @samp{Value Menu} and enter a function of your own
6492 choosing.
6493
6494 @vindex mh-xemacs-use-tool-bar-flag
6495
6496 XEmacs provides a couple of extra options. The first,
6497 @code{mh-xemacs-use-tool-bar-flag}, controls whether to show the MH-E
6498 icons at all. By default, this option is turned on if the window
6499 system supports tool bars. If your system doesn't support tool bars,
6500 then you won't be able to turn on this option.
6501
6502 @vindex mh-xemacs-tool-bar-position
6503
6504 The second extra option is @code{mh-xemacs-tool-bar-position} which
6505 controls the placement of the tool bar along the four edges of the
6506 frame. You can choose from one of @samp{Same As Default Tool Bar},
6507 @samp{Top}, @samp{Bottom}, @samp{Left}, or @samp{Right}. If this
6508 variable is set to anything other than @samp{Same As Default Tool Bar}
6509 and the default tool bar is in a different location, then two tool
6510 bars will be displayed: the MH-E tool bar and the default tool bar.
6511
6512 @node Searching, Threading, Tool Bar, Top
6513 @chapter Searching Through Messages
6514
6515 @cindex @samp{Search} menu
6516 @cindex menu, @samp{Search}
6517 @cindex searching
6518 @findex mh-search
6519 @kindex F s
6520
6521 Earlier, the command @kbd{F s} (@code{mh-search}) was introduced which
6522 helps you find messages that lie buried in your folders
6523 (@pxref{Folders}). This chapter covers this command in more detail.
6524 Several commands are used to compose the search criteria and to start
6525 searching. A couple of them can be found in the @samp{Search} menu.
6526
6527 @table @kbd
6528 @kindex C-c ?
6529 @findex mh-help
6530 @item C-c ?
6531 Display cheat sheet for the MH-E commands (@code{mh-help}).
6532 @c -------------------------
6533 @cindex @samp{Search > Perform Search} menu item
6534 @cindex menu item, @samp{Search > Perform Search}
6535 @kindex C-c C-c
6536 @findex mh-index-do-search
6537 @item C-c C-c
6538 Find messages using @code{mh-search-program}
6539 (@code{mh-index-do-search}).
6540 @c -------------------------
6541 @cindex @samp{Search > Search with pick} menu item
6542 @cindex menu item, @samp{Search > Search with pick}
6543 @kindex C-c C-p
6544 @findex mh-pick-do-search
6545 @item C-c C-p
6546 Find messages using @command{pick} (@code{mh-pick-do-search}).
6547 @c -------------------------
6548 @kindex C-c ?
6549 @findex mh-help
6550 @item C-c ?
6551 Display cheat sheet for the MH-E commands (@code{mh-help}).
6552 @c -------------------------
6553 @kindex C-c C-f C-a
6554 @kindex C-c C-f a
6555 @findex mh-to-field
6556 @item C-c C-f a
6557 @itemx C-c C-f C-a
6558 Move to @samp{Mail-Reply-To:} header field (@code{mh-to-field}).
6559 @c -------------------------
6560 @kindex C-c C-f C-b
6561 @kindex C-c C-f b
6562 @item C-c C-f b
6563 @itemx C-c C-f C-b
6564 Move to @samp{Bcc:} header field (@code{mh-to-field}).
6565 @c -------------------------
6566 @kindex C-c C-f C-c
6567 @kindex C-c C-f c
6568 @item C-c C-f c
6569 @itemx C-c C-f C-c
6570 Move to @samp{Cc:} header field (@code{mh-to-field}).
6571 @c -------------------------
6572 @kindex C-c C-f C-d
6573 @kindex C-c C-f d
6574 @item C-c C-f d
6575 @itemx C-c C-f C-d
6576 Move to @samp{Dcc:} header field (@code{mh-to-field}).
6577 @c -------------------------
6578 @kindex C-c C-f C-f
6579 @kindex C-c C-f f
6580 @item C-c C-f f
6581 @itemx C-c C-f C-f
6582 Move to @samp{Fcc:} header field (@code{mh-to-field}).
6583 @c -------------------------
6584 @kindex C-c C-f C-l
6585 @kindex C-c C-f l
6586 @item C-c C-f l
6587 @itemx C-c C-f C-l
6588 Move to @samp{Mail-Followup-To:} header field (@code{mh-to-field}).
6589 @c -------------------------
6590 @kindex C-c C-f C-m
6591 @kindex C-c C-f m
6592 @item C-c C-f m
6593 @itemx C-c C-f C-m
6594 Move to @samp{From:} header field (@code{mh-to-field}).
6595 @c -------------------------
6596 @kindex C-c C-f C-r
6597 @kindex C-c C-f r
6598 @item C-c C-f r
6599 @itemx C-c C-f C-r
6600 Move to @samp{Reply-To:} header field (@code{mh-to-field}).
6601 @c -------------------------
6602 @kindex C-c C-f C-s
6603 @kindex C-c C-f s
6604 @item C-c C-f s
6605 @itemx C-c C-f C-s
6606 Move to @samp{Subject:} header field (@code{mh-to-field}).
6607 @c -------------------------
6608 @kindex C-c C-f C-t
6609 @kindex C-c C-f t
6610 @item C-c C-f t
6611 @itemx C-c C-f C-t
6612 Move to @samp{To:} header field (@code{mh-to-field}).
6613 @end table
6614
6615 Another few commands are available in the MH-Folder buffer resulting
6616 from a search.
6617
6618 @table @kbd
6619 @kindex @key{TAB}
6620 @findex mh-index-next-folder
6621 @item @key{TAB}
6622 Jump to the next folder marker (@code{mh-index-next-folder}).
6623 @c -------------------------
6624 @kindex S-@key{TAB}
6625 @findex mh-index-previous-folder
6626 @item S-@key{TAB}
6627 Jump to the previous folder marker (@code{mh-index-previous-folder}).
6628 @c -------------------------
6629 @kindex v
6630 @findex mh-index-visit-folder
6631 @item v
6632 Visit original folder from where the message at point was found
6633 (@code{mh-index-visit-folder}).
6634 @end table
6635
6636 @cindex @samp{mh-search} customization group
6637 @cindex customization group, @samp{mh-search}
6638
6639 There is one option from the @samp{mh-search} customization group used
6640 in searching.
6641
6642 @vtable @code
6643 @item mh-search-program
6644 Search program that MH-E shall use (default: @samp{Auto-detect}).
6645 @end vtable
6646
6647 The following hook is available.
6648
6649 @vtable @code
6650 @item mh-search-mode-hook
6651 Hook run upon entry to @code{mh-search-mode} (default: @code{nil}).
6652 @end vtable
6653
6654 The following face is available.
6655
6656 @vtable @code
6657 @item mh-search-folder
6658 Folder heading face in MH-Folder buffers created by searches.
6659 @end vtable
6660
6661 @findex mh-search-folder
6662 @kindex F s
6663
6664 The command @kbd{F s} (@code{mh-search-folder}) helps you find
6665 messages in your entire corpus of mail. You can search for messages to
6666 or from a particular person or about a particular subject. In fact,
6667 you can also search for messages containing selected strings in any
6668 arbitrary header field or any string found within the messages.
6669
6670 @cindex @command{pick}
6671 @cindex MH commands, @command{pick}
6672
6673 Out of the box, MH-E uses @command{pick} to find messages. With a
6674 little extra effort, you can set an indexing program which rewards you
6675 with extremely quick results. The drawback is that sometimes the index
6676 does not contain the words you're looking for. You can still use
6677 @command{pick} in these situations.
6678
6679 You are prompted for the folder to search. This can be @samp{all} to
6680 search all folders. Note that the search works recursively on the
6681 listed folder.
6682
6683 @cindex MH-Search mode
6684 @cindex modes, MH-Search
6685
6686 Next, an MH-Search buffer appears where you can enter search criteria.
6687
6688 @cartouche
6689 @smallexample
6690 From:
6691 To:
6692 Cc:
6693 Date:
6694 Subject:
6695 --------
6696 #
6697
6698
6699
6700
6701
6702
6703
6704
6705 --:** search-pattern All L7 (MH-Search)---------------------------
6706 Type C-c C-c to search messages, C-c C-p to use pick, C-c ? for help
6707 @end smallexample
6708 @end cartouche
6709 @i{Search window}
6710
6711 @cindex @command{pick}
6712 @cindex MH commands, @command{pick}
6713
6714 Edit this template by entering your search criteria in an appropriate
6715 header field that is already there, or create a new field yourself. If
6716 the string you're looking for could be anywhere in a message, then
6717 place the string underneath the row of dashes.
6718
6719 As an example, let's say that we want to find messages from Ginnean
6720 about horseback riding in the Kosciusko National Park (Australia)
6721 during January, 1994. Normally we would start with a broad search and
6722 narrow it down if necessary to produce a manageable amount of data,
6723 but we'll cut to the chase and create a fairly restrictive set of
6724 criteria as follows:
6725
6726 @smallexample
6727 @group
6728 From: ginnean
6729 To:
6730 Cc:
6731 Date: Jan 1994
6732 Subject:
6733 --------
6734 horse
6735 kosciusko
6736 @end group
6737 @end smallexample
6738
6739 @findex mh-to-field
6740 @kindex C-c C-f C-t
6741
6742 As with MH-Letter mode, MH-Search provides commands like @kbd{C-c C-f
6743 C-t} (@code{mh-to-field}) to help you fill in the blanks.
6744 @xref{Editing Message}.
6745
6746 @kindex F s
6747 @vindex mh-search-mode-hook
6748
6749 If you find that you do the same thing over and over when editing the
6750 search template, you may wish to bind some shortcuts to keys. This can
6751 be done with the variable @code{mh-search-mode-hook}, which is called
6752 when @kbd{F s} is run on a new pattern.
6753
6754 @findex mh-index-do-search
6755 @findex mh-pick-do-search
6756 @kindex C-c C-c
6757 @kindex C-c C-p
6758
6759 To perform the search, type @kbd{C-c C-c} (@code{mh-index-do-search}).
6760 Sometimes you're searching for text that is either not indexed, or
6761 hasn't been indexed yet. In this case you can override the default
6762 method with the pick method by running the command @kbd{C-c C-p}
6763 (@code{mh-pick-do-search}).
6764
6765 @cindex folders, @samp{+mhe-index}
6766 @cindex @samp{+mhe-index}
6767 @findex mh-index-next-folder
6768 @findex mh-index-previous-folder
6769 @kindex @key{TAB}
6770 @kindex S-@key{TAB}
6771 @vindex mh-search-folder
6772
6773 The messages that are found are put in a temporary sub-folder of
6774 @samp{+mhe-index} and are displayed in an MH-Folder buffer. This
6775 buffer is special because it displays messages from multiple folders;
6776 each set of messages from a given folder has a heading with the folder
6777 name. The appearance of the heading can be modified by customizing the
6778 face @code{mh-search-folder}. You can jump back and forth between the
6779 headings using the commands @kbd{@key{TAB}}
6780 (@code{mh-index-next-folder}) and @kbd{S-@key{TAB}}
6781 (@code{mh-index-previous-folder}).
6782
6783 @findex mh-index-visit-folder
6784 @findex mh-rescan-folder
6785 @kindex F r
6786 @kindex v
6787
6788 In addition, the command @kbd{v} (@code{mh-index-visit-folder}) can be
6789 used to visit the folder of the message at point. Initially, only the
6790 messages that matched the search criteria are displayed in the folder.
6791 While the temporary buffer has its own set of message numbers, the
6792 actual messages numbers are shown in the visited folder. Thus, the
6793 command @kbd{v} is useful to find the actual message number of an
6794 interesting message, or to view surrounding messages with the command
6795 @kbd{F r} @code{mh-rescan-folder}. @xref{Folders}.
6796
6797 @findex mh-kill-folder
6798 @kindex F k
6799
6800 Because this folder is temporary, you'll probably get in the habit of
6801 killing it when you're done with @kbd{F k} (@code{mh-kill-folder}).
6802 @xref{Folders}.
6803
6804 @kindex F s
6805
6806 You can regenerate the results by running @kbd{F s} with a prefix
6807 argument.
6808
6809 @cindex @command{procmail}
6810 @cindex Unix commands, @command{procmail}
6811 @cindex @samp{X-MHE-Checksum:} header field
6812 @cindex header field, @samp{X-MHE-Checksum:}
6813
6814 Note: This command uses an @samp{X-MHE-Checksum:} header field to
6815 cache the MD5 checksum of a message. This means that if an incoming
6816 message already contains an @samp{X-MHE-Checksum:} field, that message
6817 might not be found by this command. The following @command{procmail}
6818 recipe avoids this problem by renaming the existing header field:
6819
6820 @smallexample
6821 @group
6822 :0 wf
6823 | formail -R "X-MHE-Checksum" "X-Old-MHE-Checksum"
6824 @end group
6825 @end smallexample
6826
6827 @xref{Limits}, for an alternative interface to searching.
6828
6829 @section Configuring Indexed Searches
6830
6831 @cindex @command{grep}
6832 @cindex @command{mairix}
6833 @cindex @command{namazu}
6834 @cindex @command{pick}
6835 @cindex @command{swish++}
6836 @cindex @command{swish-e}
6837 @cindex Unix commands, @command{grep}
6838 @cindex Unix commands, @command{mairix}
6839 @cindex Unix commands, @command{namazu}
6840 @cindex Unix commands, @command{pick}
6841 @cindex Unix commands, @command{swish++}
6842 @cindex Unix commands, @command{swish-e}
6843 @findex mh-search
6844 @kindex F s
6845 @vindex mh-search-program
6846
6847 The command @kbd{F s} (@code{mh-search}) runs the command defined by
6848 the option @code{mh-search-program}. The default value is
6849 @samp{Auto-detect} which means that MH-E will automatically choose one
6850 of @command{swish++}, @command{swish-e}, @command{mairix},
6851 @command{namazu}, @command{pick} and @command{grep} in that order. If,
6852 for example, you have both @command{swish++} and @command{mairix}
6853 installed and you want to use @command{mairix}, then you can set this
6854 option to @samp{mairix}.
6855
6856 The following sub-sections describe how to set up the various indexing
6857 programs to use with MH-E.
6858
6859 @subsection swish++
6860
6861 @cindex @command{swish++}
6862 @cindex Unix commands, @command{swish++}
6863
6864 In the examples below, replace @file{/home/user/Mail} with the path to
6865 your MH directory.
6866
6867 First create the directory @file{/home/user/Mail/.swish++}. Then
6868 create the file @file{/home/user/Mail/.swish++/swish++.conf} with the
6869 following contents:
6870
6871 @smallexample
6872 @group
6873 IncludeMeta Bcc Cc Comments Content-Description From Keywords
6874 IncludeMeta Newsgroups Resent-To Subject To
6875 IncludeMeta Message-Id References In-Reply-To
6876 IncludeFile Mail *
6877 IndexFile /home/user/Mail/.swish++/swish++.index
6878 @end group
6879 @end smallexample
6880
6881 Use the following command line to generate the swish index. Run this
6882 daily from cron:
6883
6884 @smallexample
6885 @group
6886 find /home/user/Mail -path /home/user/Mail/mhe-index -prune \
6887 -o -path /home/user/Mail/.swish++ -prune \
6888 -o -name "[0-9]*" -print \
6889 | index -c /home/user/Mail/.swish++/swish++.conf -
6890 @end group
6891 @end smallexample
6892
6893 This command does not index the folders that hold the results of your
6894 searches in @samp{+mhe-index} since they tend to be ephemeral and the
6895 original messages are indexed anyway.
6896
6897 @cindex @command{index}
6898 @cindex Unix commands, @command{index}
6899 @cindex @command{index++}
6900 @cindex Unix commands, @command{index++}
6901
6902 On some systems (Debian GNU/Linux, for example), use @command{index++}
6903 instead of @command{index}.
6904
6905 @subsection swish
6906
6907 @cindex @command{swish-e}
6908 @cindex Unix commands, @command{swish-e}
6909
6910 In the examples below, replace @file{/home/user/Mail} with the path to
6911 your MH directory.
6912
6913 First create the directory @file{/home/user/Mail/.swish}. Then create
6914 the file @file{/home/user/Mail/.swish/config} with the following
6915 contents:
6916
6917 @smallexample
6918 @group
6919 DefaultContents TXT*
6920 IndexDir /home/user/Mail
6921 IndexFile /home/user/Mail/.swish/index
6922 IndexName "Mail Index"
6923 IndexDescription "Mail Index"
6924 IndexPointer "http://nowhere"
6925 IndexAdmin "nobody"
6926 #MetaNames automatic
6927 IndexReport 3
6928 FollowSymLinks no
6929 UseStemming no
6930 IgnoreTotalWordCountWhenRanking yes
6931 WordCharacters abcdefghijklmnopqrstuvwxyz0123456789-
6932 BeginCharacters abcdefghijklmnopqrstuvwxyz
6933 EndCharacters abcdefghijklmnopqrstuvwxyz0123456789
6934 IgnoreLimit 50 1000
6935 IndexComments 0
6936 FileRules filename contains \D
6937 FileRules pathname contains /home/user/Mail/.swish
6938 FileRules pathname contains /home/user/Mail/mhe-index
6939 FileRules filename is index
6940 @end group
6941 @end smallexample
6942
6943 This configuration does not index the folders that hold the results of
6944 your searches in @samp{+mhe-index} since they tend to be ephemeral and
6945 the original messages are indexed anyway.
6946
6947 If there are any directories you would like to ignore, append lines
6948 like the following to @file{config}:
6949
6950 @smallexample
6951 FileRules pathname contains /home/user/Mail/scripts
6952 @end smallexample
6953
6954 @cindex @command{swish-e}
6955 @cindex Unix commands, @command{swish-e}
6956
6957 Use the following command line to generate the swish index. Run this
6958 daily from cron:
6959
6960 @smallexample
6961 swish-e -c /home/user/Mail/.swish/config
6962 @end smallexample
6963
6964 @subsection mairix
6965
6966 @cindex @command{mairix}
6967 @cindex Unix commands, @command{mairix}
6968
6969 In the examples below, replace @file{/home/user/Mail} with the path to
6970 your MH directory.
6971
6972 First create the directory @file{/home/user/Mail/.mairix}. Then create
6973 the file @file{/home/user/Mail/.mairix/config} with the following
6974 contents:
6975
6976 @smallexample
6977 @group
6978 base=/home/user/Mail
6979
6980 # List of folders that should be indexed. 3 dots at the end means there
6981 # are subfolders within the folder
6982 mh=archive...:inbox:drafts:news:sent:trash
6983
6984 vfolder_format=raw
6985 database=/home/user/Mail/mairix/database
6986 @end group
6987 @end smallexample
6988
6989 Use the following command line to generate the mairix index. Run this daily
6990 from cron:
6991
6992 @smallexample
6993 mairix -f /home/user/Mail/.mairix/config
6994 @end smallexample
6995
6996 @subsection namazu
6997
6998 @cindex @command{namazu}
6999 @cindex Unix commands, @command{namazu}
7000
7001 In the examples below, replace @file{/home/user/Mail} with the path to
7002 your MH directory.
7003
7004 First create the directory @file{/home/user/Mail/.namazu}. Then create
7005 the file @file{/home/user/Mail/.namazu/mknmzrc} with the following
7006 contents:
7007
7008 @smallexample
7009 @group
7010 package conf; # Don't remove this line!
7011 $ADDRESS = 'user@@localhost';
7012 $ALLOW_FILE = "[0-9]*";
7013 $EXCLUDE_PATH = "^/home/user/Mail/(mhe-index|spam)";
7014 @end group
7015 @end smallexample
7016
7017 This configuration does not index the folders that hold the results of
7018 your searches in @samp{+mhe-index} since they tend to be ephemeral and
7019 the original messages are indexed anyway.
7020
7021 Use the following command line to generate the namazu index. Run this
7022 daily from cron:
7023
7024 @smallexample
7025 mknmz -f /home/user/Mail/.namazu/mknmzrc -O /home/user/Mail/.namazu \
7026 /home/user/Mail
7027 @end smallexample
7028
7029 @subsection pick
7030
7031 @cindex @command{pick}
7032 @cindex MH commands, @command{pick}
7033
7034 This search method does not require any setup.
7035
7036 Read @command{pick}(1) or the section
7037 @uref{@value{MH-BOOK-HOME}/finpic.html, Finding Messages with pick} in
7038 the MH book to find out more about how to enter the criteria.
7039
7040 @subsection grep
7041
7042 @cindex @command{grep}
7043 @cindex Unix commands, @command{grep}
7044
7045 This search method does not require any setup.
7046
7047 Unlike the other search methods, this method does not use the
7048 MH-Search buffer. Instead, you simply enter a regular expression in
7049 the minibuffer. For help in constructing regular expressions, see your
7050 man page for @command{grep}.
7051
7052 @node Threading, Limits, Searching, Top
7053 @chapter Viewing Message Threads
7054
7055 @cindex threading
7056
7057 MH-E groups messages by @dfn{threads} which are messages that are part
7058 of the same discussion and usually all have the same @samp{Subject:}
7059 header field. Other ways to organize messages in a folder include
7060 limiting (@pxref{Limits}) or using full-text indexed searches
7061 (@pxref{Searching}).
7062
7063 @cindex root, in threads
7064 @cindex siblings, in threads
7065 @cindex ancestor, in threads
7066
7067 A thread begins with a single message called a @dfn{root}. All replies
7068 to the same message are @dfn{siblings} of each other. Any message that
7069 has replies to it is an @dfn{ancestor} of those replies.
7070
7071 There are several commands that you can use to navigate and operate on
7072 threads.
7073
7074 @table @kbd
7075 @kindex T ?
7076 @findex mh-prefix-help
7077 @item T ?
7078 Display cheat sheet for the commands of the current prefix in
7079 minibuffer (@code{mh-prefix-help}).
7080 @c -------------------------
7081 @kindex T o
7082 @findex mh-thread-refile
7083 @item T o
7084 Refile (output) thread into folder (@code{mh-thread-refile}).
7085 @c -------------------------
7086 @kindex T d
7087 @findex mh-thread-delete
7088 @item T d
7089 Delete thread (@code{mh-thread-delete}).
7090 @c -------------------------
7091 @kindex T t
7092 @findex mh-toggle-threads
7093 @item T t
7094 Toggle threaded view of folder (@code{mh-toggle-threads}).
7095 @c -------------------------
7096 @kindex T n
7097 @findex mh-thread-next-sibling
7098 @item T n
7099 Display next sibling (@code{mh-thread-next-sibling}).
7100 @c -------------------------
7101 @kindex T p
7102 @findex mh-thread-previous-sibling
7103 @item T p
7104 Display previous sibling (@code{mh-thread-previous-sibling}).
7105 @c -------------------------
7106 @kindex T u
7107 @findex mh-thread-ancestor
7108 @item T u
7109 Display ancestor of current message (@code{mh-thread-ancestor}).
7110 @end table
7111
7112 @cindex @samp{mh-thread} customization group
7113 @cindex customization group, @samp{mh-thread}
7114
7115 The @samp{mh-thread} customization group contains one option.
7116
7117 @vtable @code
7118 @item mh-show-threads-flag
7119 On means new folders start in threaded mode (default: @samp{off}).
7120 @end vtable
7121
7122 @findex mh-toggle-threads
7123 @kindex T t
7124 @vindex mh-large-folder
7125 @vindex mh-show-threads-flag
7126
7127 Threading large number of messages can be time consuming so the option
7128 @code{mh-show-threads-flag} is turned off by default. If you turn on
7129 this option, then threading will be done only if the number of
7130 messages being threaded is less than @code{mh-large-folder}. In any
7131 event, threading can be turned on (and off) with the command @kbd{T t}
7132 (@code{mh-toggle-threads}).
7133
7134 @findex mh-thread-ancestor
7135 @findex mh-thread-next-sibling
7136 @findex mh-thread-previous-sibling
7137 @kindex T n
7138 @kindex T p
7139 @kindex T u
7140
7141 There are a few commands to help you navigate threads. If you do not
7142 care for the way a particular thread has turned, you can move up the
7143 chain of messages with the command @kbd{T u}
7144 (@code{mh-thread-ancestor}. At any point you can use @kbd{T n}
7145 (@code{mh-thread-next-sibling} or @kbd{T p}
7146 (@code{mh-thread-previous-sibling}) to jump to the next or previous
7147 sibling, skipping the sub-threads. The command @kbd{T u} can also take
7148 a prefix argument to jump to the message that started everything.
7149
7150 @findex mh-delete-subject-or-thread
7151 @findex mh-thread-delete
7152 @findex mh-thread-refile
7153 @kindex k
7154 @kindex T d
7155 @kindex T o
7156
7157 There are threaded equivalents for the commands that delete and refile
7158 messages. For example, @kbd{T o} (@code{mh-thread-refile}) refiles the
7159 current message and all its children. Similarly, the command @kbd{T d}
7160 (@code{mh-thread-delete}) deletes the current message and all its
7161 children. These commands do not refile or delete sibling messages.
7162 @xref{Navigating}, for a description of the similar command @kbd{k}
7163 (@code{mh-delete-subject-or-thread}).
7164
7165 @vindex mh-large-folder
7166
7167 If you find that threading is too slow, it may be that you have
7168 @code{mh-large-folder} set too high. Also, threading is one of the few
7169 features of MH-E that really benefits from compiling. If you haven't
7170 compiled MH-E, I encourage you to do so@footnote{If you're not sure if
7171 MH-E has been byte-compiled, you could try running @samp{locate
7172 mh-thread.elc} or otherwise find MH-E on your system and ensure that
7173 @file{mh-thread.elc} exists. If you have multiple versions and you
7174 find that one is compiled but the other is not, then go into your
7175 @samp{*scratch*} buffer in Emacs, enter @kbd{load-path C-j}, and
7176 ensure that the byte-compiled version appears first in the
7177 @code{load-path}. If you find that MH-E is not compiled and you
7178 installed MH-E yourself, please refer to the installation directions
7179 in the file @file{README} in the distribution.}.
7180
7181 @node Limits, Sequences, Threading, Top
7182 @chapter Limiting Display
7183
7184 @cindex limits
7185 @cindex filters
7186
7187 Another way to organize messages in a folder besides threading
7188 (@pxref{Threading}) or using full-text indexed searches
7189 (@pxref{Searching}) is by limiting the folder display to messages that
7190 are similar to the current message.
7191
7192 @table @kbd
7193 @kindex / ?
7194 @findex mh-prefix-help
7195 @item / ?
7196 Display cheat sheet for the commands of the current prefix in
7197 minibuffer (@code{mh-prefix-help}).
7198 @c -------------------------
7199 @cindex @samp{Sequence > Narrow to Tick Sequence} menu item
7200 @cindex menu item, @samp{Sequence > Narrow to Tick Sequence}
7201 @kindex / '
7202 @findex mh-narrow-to-tick
7203 @item / '
7204 Limit to messages in the @samp{tick} sequence
7205 (@code{mh-narrow-to-tick}).
7206 @c -------------------------
7207 @kindex / c
7208 @findex mh-narrow-to-cc
7209 @item / c
7210 Limit to messages with the same @samp{Cc:} field
7211 (@code{mh-narrow-to-cc}).
7212 @c -------------------------
7213 @kindex / m
7214 @findex mh-narrow-to-from
7215 @item / m
7216 Limit to messages with the same @samp{From:} field
7217 (@code{mh-narrow-to-from}).
7218 @c -------------------------
7219 @kindex / g
7220 @findex mh-narrow-to-range
7221 @item / g
7222 Limit to range (@code{mh-narrow-to-range}).
7223 @c -------------------------
7224 @cindex @samp{Sequence > Narrow to Subject Sequence} menu item
7225 @cindex menu item, @samp{Sequence > Narrow to Subject Sequence}
7226 @kindex / s
7227 @findex mh-narrow-to-subject
7228 @item / s
7229 Limit to messages with the same @samp{Subject:} field
7230 (@code{mh-narrow-to-subject}).
7231 @c -------------------------
7232 @kindex / t
7233 @findex mh-narrow-to-to
7234 @item / t
7235 Limit to messages with the same @samp{To:} field
7236 (@code{mh-narrow-to-to}).
7237 @c -------------------------
7238 @cindex @samp{Sequence > Widen from Sequence} menu item
7239 @cindex menu item, @samp{Sequence > Widen from Sequence}
7240 @kindex / w
7241 @findex mh-widen
7242 @item / w
7243 Remove last restriction (@code{mh-widen}).
7244 @end table
7245
7246 All of the limiting commands above refine the display in some way.
7247
7248 @cindex @command{pick}
7249 @cindex MH commands, @command{pick}
7250 @findex mh-narrow-to-cc
7251 @findex mh-narrow-to-from
7252 @findex mh-narrow-to-subject
7253 @findex mh-narrow-to-to
7254 @kindex / c
7255 @kindex / m
7256 @kindex / s
7257 @kindex / t
7258
7259 The commands @kbd{/ c} (@code{mh-narrow-to-cc}), @kbd{/ m}
7260 (@code{mh-narrow-to-from}), @kbd{/ s} (@code{mh-narrow-to-subject}),
7261 and @kbd{/ t} (@code{mh-narrow-to-to}) restrict the display to
7262 messages matching the content of the respective field in the current
7263 message. However, you can give any of these a prefix argument to edit
7264 the @command{pick} expression used to narrow the view@footnote{See
7265 @command{pick}(1) or the section
7266 @uref{@value{MH-BOOK-HOME}/finpic.html, Finding Messages with pick} in
7267 the MH book.}.
7268
7269 @cindex @samp{tick} sequence
7270 @cindex sequence, @samp{tick}
7271 @cindex ticked messages, viewing
7272 @findex mh-narrow-to-range
7273 @findex mh-narrow-to-tick
7274 @kindex / '
7275 @kindex / g
7276
7277 You can also limit the display to messages in the @samp{tick} sequence
7278 with the command @kbd{/ '} (@code{mh-narrow-to-tick}).
7279 @xref{Sequences}, for information on putting message into the
7280 @samp{tick} sequence. Use the @kbd{/ g} (@code{mh-narrow-to-range})
7281 command to limit the display to messages in a range (@pxref{Ranges}).
7282
7283 @findex mh-widen
7284 @kindex / w
7285
7286 Each limit can be undone in turn with the @kbd{/ w} (@code{mh-widen})
7287 command. Give this command a prefix argument to remove all limits.
7288
7289 @node Sequences, Junk, Limits, Top
7290 @chapter Using Sequences
7291
7292 @cindex @samp{Sequence} menu
7293 @cindex menu, @samp{Sequence}
7294 @cindex sequences
7295
7296 For the whole scoop on MH sequences, refer to
7297 @samp{mh-sequence}(5)@footnote{See the section
7298 @uref{@value{MH-BOOK-HOME}/morseq.html, More About Sequences} in the MH
7299 book.}. As you've read, several of the MH-E commands can operate on a
7300 sequence, which is a shorthand for a range or group of messages. For
7301 example, you might want to forward several messages to a friend or
7302 colleague. Here's how to manipulate sequences. These commands are also
7303 available in the @samp{Sequence} menu.
7304
7305 @table @kbd
7306 @cindex @samp{Sequence > Toggle Tick Mark} menu item
7307 @cindex menu item, @samp{Sequence > Toggle Tick Mark}
7308 @kindex '
7309 @findex mh-toggle-tick
7310 @item '
7311 Toggle tick mark of range (@code{mh-toggle-tick}).
7312 @c -------------------------
7313 @kindex S ?
7314 @findex mh-prefix-help
7315 @item S ?
7316 Display cheat sheet for the commands of the current prefix in
7317 minibuffer (@code{mh-prefix-help}).
7318 @c -------------------------
7319 @cindex @samp{Sequence > Narrow to Tick Sequence} menu item
7320 @cindex menu item, @samp{Sequence > Narrow to Tick Sequence}
7321 @kindex S '
7322 @findex mh-narrow-to-tick
7323 @item S '
7324 Limit to ticked messages (@code{mh-narrow-to-tick}).
7325 @c -------------------------
7326 @cindex @samp{Sequence > Delete Message from Sequence...} menu item
7327 @cindex menu item, @samp{Sequence > Delete Message from Sequence...}
7328 @kindex S d
7329 @findex mh-delete-msg-from-seq
7330 @item S d
7331 Delete range from sequence (@code{mh-delete-msg-from-seq}).
7332 @c -------------------------
7333 @cindex @samp{Sequence > Delete Sequence...} menu item
7334 @cindex menu item, @samp{Sequence > Delete Sequence...}
7335 @kindex S k
7336 @findex mh-delete-seq
7337 @item S k
7338 Delete sequence (@code{mh-delete-seq}).
7339 @c -------------------------
7340 @cindex @samp{Sequence > List Sequences in Folder...} menu item
7341 @cindex menu item, @samp{Sequence > List Sequences in Folder...}
7342 @kindex S l
7343 @findex mh-list-sequences
7344 @item S l
7345 List all sequences in folder (@code{mh-list-sequences}).
7346 @c -------------------------
7347 @cindex @samp{Sequence > Narrow to Sequence...} menu item
7348 @cindex menu item, @samp{Sequence > Narrow to Sequence...}
7349 @kindex S n
7350 @findex mh-narrow-to-seq
7351 @item S n
7352 Restrict display to messages in sequence (@code{mh-narrow-to-seq}).
7353 @c -------------------------
7354 @cindex @samp{Sequence > Add Message to Sequence...} menu item
7355 @cindex menu item, @samp{Sequence > Add Message to Sequence...}
7356 @kindex S p
7357 @findex mh-put-msg-in-seq
7358 @item S p
7359 Add range to sequence (@code{mh-put-msg-in-seq}).
7360 @c -------------------------
7361 @cindex @samp{Sequence > List Sequences for Message} menu item
7362 @cindex menu item, @samp{Sequence > List Sequences for Message}
7363 @kindex S s
7364 @findex mh-msg-is-in-seq
7365 @item S s
7366 Display the sequences in which the current message appears
7367 (@code{mh-msg-is-in-seq}).
7368 @c -------------------------
7369 @cindex @samp{Sequence > Widen from Sequence} menu item
7370 @cindex menu item, @samp{Sequence > Widen from Sequence}
7371 @kindex S w
7372 @findex mh-widen
7373 @item S w
7374 Remove last restriction (@code{mh-widen}).
7375 @c -------------------------
7376 @findex mh-update-sequences
7377 @item M-x mh-update-sequences
7378 Flush MH-E's state out to MH@.
7379 @end table
7380
7381 @cindex @samp{mh-sequences} customization group
7382 @cindex customization group, @samp{mh-sequences}
7383
7384 The @samp{mh-sequences} customization group contains the options
7385 associated with sequences.
7386
7387 @vtable @code
7388 @item mh-refile-preserves-sequences-flag
7389 On means that sequences are preserved when messages are refiled
7390 (default: @samp{on}).
7391 @c -------------------------
7392 @item mh-tick-seq
7393 The name of the MH sequence for ticked messages (default: @samp{'tick}).
7394 @c -------------------------
7395 @item mh-update-sequences-after-mh-show-flag
7396 On means flush MH sequences to disk after message is shown (default:
7397 @samp{on}).
7398 @end vtable
7399
7400 The following hook is available.
7401
7402 @vtable @code
7403 @item mh-unseen-updated-hook
7404 Hook run after the unseen sequence has been updated (default: @code{nil}).
7405 @end vtable
7406
7407 @cindex @command{pick}
7408 @cindex MH commands, @command{pick}
7409 @findex mh-put-msg-in-seq
7410 @kindex S p
7411
7412 To place a message in a sequence, use @kbd{S p}
7413 (@code{mh-put-msg-in-seq}). Give @kbd{S p} a range and you can add all
7414 the messages in a sequence to another sequence (for example, @kbd{C-u
7415 S p SourceSequence @key{RET} DestSequence @key{RET}}, @pxref{Ranges}).
7416
7417 @cindex @samp{tick} sequence
7418 @cindex sequence, @samp{tick}
7419 @cindex ticking messages
7420 @findex mh-index-ticked-messages
7421 @findex mh-toggle-tick
7422 @kindex '
7423 @kindex F '
7424 @kindex S p
7425
7426 One specific use of the @kbd{S p} command is @kbd{'}
7427 (@code{mh-toggle-tick}) which adds messages to the @samp{tick}
7428 sequence. This sequence can be viewed later with the @kbd{F '}
7429 (@code{mh-index-ticked-messages}) command (@pxref{Folders}).
7430
7431 @vindex mh-tick-seq
7432
7433 You can customize the option @code{mh-tick-seq} if you already use the
7434 @samp{tick} sequence for your own use. You can also disable all of the
7435 ticking functions by choosing the @samp{Disable Ticking} item but
7436 there isn't much advantage to that.
7437
7438 @cindex MH-Folder mode
7439 @cindex modes, MH-Folder
7440 @findex mh-narrow-to-seq
7441 @findex mh-narrow-to-tick
7442 @findex mh-widen
7443 @kindex S '
7444 @kindex S n
7445 @kindex S w
7446
7447 Once you've placed some messages in a sequence, you may wish to narrow
7448 the field of view to just those messages in the sequence you've
7449 created. To do this, use @kbd{S n} (@code{mh-narrow-to-seq}). You are
7450 prompted for the name of the sequence. What this does is show only
7451 those messages that are in the selected sequence in the MH-Folder
7452 buffer. In addition, it limits further MH-E searches to just those
7453 messages. To narrow the view to the messages in the @samp{tick}
7454 sequence, use @kbd{S '} (@code{mh-narrow-to-tick}). When you want to
7455 widen the view to all your messages again, use @kbd{S w}
7456 (@code{mh-widen}).
7457
7458 @cindex buffers, @samp{*MH-E Sequences*}
7459 @cindex @samp{*MH-E Sequences*}
7460 @findex mh-list-sequences
7461 @findex mh-msg-is-in-seq
7462 @kindex S l
7463 @kindex S s
7464
7465 You can see which sequences in which a message appears with the
7466 command @kbd{S s} (@code{mh-msg-is-in-seq}). Use a prefix argument to
7467 display the sequences in which another message appears (as in @kbd{C-u
7468 42 S s @key{RET}}). Or, you can list all sequences in a selected
7469 folder (default is current folder) with @kbd{S l}
7470 (@code{mh-list-sequences}). The list appears in a buffer named
7471 @samp{*MH-E Sequences*} (@pxref{Miscellaneous}).
7472
7473 @cindex MH profile component, @samp{Previous-Sequence:}
7474 @cindex @samp{cur} sequence
7475 @cindex @samp{Previous-Sequence:} MH profile component
7476 @cindex sequence, @samp{cur}
7477 @cindex sequence, @samp{Previous-Sequence}
7478 @vindex mh-refile-preserves-sequences-flag
7479
7480 If a message is in any sequence (except
7481 @samp{Previous-Sequence:}@footnote{See @samp{mh-profile}(5)).} and
7482 @samp{cur}) when it is refiled, then it will still be in those
7483 sequences in the destination folder. If this behavior is not desired,
7484 then turn off the option @code{mh-refile-preserves-sequences-flag}.
7485
7486 @findex mh-delete-msg-from-seq
7487 @findex mh-delete-seq
7488 @kindex d
7489 @kindex S d
7490 @kindex S k
7491
7492 If you want to remove a message (or range, @pxref{Ranges}) from a
7493 sequence, use @kbd{S d} (@code{mh-delete-msg-from-seq}). If you want
7494 to delete an entire sequence, use @kbd{S k} (@code{mh-delete-seq}). In
7495 the latter case you are prompted for the sequence to delete. Note that
7496 this deletes only the sequence, not the messages in the sequence. If
7497 you want to delete the messages, use @kbd{C-u d} (@pxref{Reading
7498 Mail}).
7499
7500 @cindex @samp{Unseen-Sequence:} MH profile component
7501 @cindex @samp{cur} sequence
7502 @cindex @samp{tick} sequence
7503 @cindex MH profile component, @samp{Unseen-Sequence:}
7504 @cindex sequence, @samp{Unseen-Sequence}
7505 @cindex sequence, @samp{cur}
7506 @cindex sequence, @samp{tick}
7507 @findex mh-update-sequences
7508 @kindex M-x mh-update-sequences
7509 @kindex q
7510 @kindex x
7511 @vindex mh-tick-seq
7512 @vindex mh-update-sequences-after-mh-show-flag
7513
7514 Three sequences are maintained internally by MH-E and pushed out to MH
7515 when a message is shown. They include the sequence specified by your
7516 @samp{Unseen-Sequence:} profile component, @samp{cur}, and the
7517 sequence listed by the option @code{mh-tick-seq} which is @samp{tick}
7518 by default. If you do not like this behavior, turn off the option
7519 @code{mh-update-sequences-after-mh-show-flag}. You can then update the
7520 state manually with the @kbd{x}, @kbd{q}, or @kbd{M-x
7521 mh-update-sequences} commands.
7522
7523 @vindex mh-seen-list
7524 @vindex mh-unseen-updated-hook
7525
7526 The hook @code{mh-unseen-updated-hook} is run after the unseen
7527 sequence has been updated. The variable @code{mh-seen-list} can be
7528 used by this hook to obtain the list of messages which were removed
7529 from the unseen sequence.
7530
7531 @cindex @command{mark}
7532 @cindex MH commands, @command{mark}
7533 @kindex S n
7534 @kindex S w
7535
7536 With the exceptions of @kbd{S n} and @kbd{S w}, the underlying MH
7537 command dealing with sequences is @command{mark}@footnote{See the
7538 section @uref{@value{MH-BOOK-HOME}/mmbwm.html, Make Message Bookmarks
7539 with mark} in the MH book.}.
7540
7541 @node Junk, Miscellaneous, Sequences, Top
7542 @chapter Dealing With Junk Mail
7543
7544 @cindex Marshall Rose
7545 @cindex junk mail
7546 @cindex spam
7547
7548 Marshall Rose once wrote a paper on MH entitled, @cite{How to process
7549 200 messages a day and still get some real work done}. This chapter
7550 could be entitled, @cite{How to process 1000 spams a day and still get
7551 some real work done}.
7552
7553 @cindex blacklisting
7554 @cindex ham
7555 @cindex viruses
7556 @cindex whitelisting
7557 @cindex worms
7558
7559 We use the terms @dfn{junk mail} and @dfn{spam} interchangeably for
7560 any unwanted message which includes spam, @dfn{viruses}, and
7561 @dfn{worms}. The opposite of spam is @dfn{ham}. The act of classifying
7562 a sender as one who sends junk mail is called @dfn{blacklisting}; the
7563 opposite is called @dfn{whitelisting}.
7564
7565 @table @kbd
7566 @kindex J ?
7567 @findex mh-prefix-help
7568 @item J ?
7569 Display cheat sheet for the commands of the current prefix in
7570 minibuffer (@code{mh-prefix-help}).
7571 @c -------------------------
7572 @kindex J b
7573 @findex mh-junk-blacklist
7574 @item J b
7575 Blacklist range as spam (@code{mh-junk-blacklist}).
7576 @c -------------------------
7577 @kindex J w
7578 @findex mh-junk-whitelist
7579 @item J w
7580 Whitelist range as ham (@code{mh-junk-whitelist}).
7581 @c -------------------------
7582 @item @code{mh-spamassassin-identify-spammers}
7583 Identify spammers who are repeat offenders.
7584 @end table
7585
7586 @cindex @samp{mh-junk} customization group
7587 @cindex customization group, @samp{mh-junk}
7588
7589 The following table lists the options from the @samp{mh-junk}
7590 customization group.
7591
7592 @vtable @code
7593 @item mh-junk-background
7594 If on, spam programs are run in background (default: @samp{off}).
7595 @c -------------------------
7596 @item mh-junk-disposition
7597 Disposition of junk mail (default: @samp{Delete Spam}).
7598 @c -------------------------
7599 @item mh-junk-program
7600 Spam program that MH-E should use (default: @samp{Auto-detect}).
7601 @end vtable
7602
7603 @cindex SpamProbe
7604 @cindex Spamassassin
7605 @cindex bogofilter
7606 @cindex spam filters, SpamProbe
7607 @cindex spam filters, Spamassassin
7608 @cindex spam filters, bogofilter
7609
7610 MH-E depends on @uref{http://spamassassin.apache.org/, SpamAssassin},
7611 @uref{http://bogofilter.sourceforge.net/, bogofilter}, or
7612 @uref{http://spamprobe.sourceforge.net/, SpamProbe} to throw the dreck
7613 away. This chapter describes briefly how to configure these programs
7614 to work well with MH-E and how to use MH-E's interface that provides
7615 continuing education for these programs.
7616
7617 @vindex mh-junk-program
7618
7619 The default setting of the option @code{mh-junk-program} is
7620 @samp{Auto-detect} which means that MH-E will automatically choose one
7621 of SpamAssassin, bogofilter, or SpamProbe in that order. If, for
7622 example, you have both SpamAssassin and bogofilter installed and you
7623 want to use bogofilter, then you can set this option to
7624 @samp{Bogofilter}.
7625
7626 @findex mh-junk-blacklist
7627 @kindex J b
7628 @vindex mh-junk-disposition
7629
7630 The command @kbd{J b} (@code{mh-junk-blacklist}) trains the spam
7631 program in use with the content of the range (@pxref{Ranges}) and then
7632 handles the message(s) as specified by the option
7633 @code{mh-junk-disposition}. By default, this option is set to
7634 @samp{Delete Spam} but you can also specify the name of the folder
7635 which is useful for building a corpus of spam for training purposes.
7636
7637 @findex mh-junk-whitelist
7638 @kindex J w
7639
7640 In contrast, the command @kbd{J w} (@code{mh-junk-whitelist})
7641 reclassifies a range of messages (@pxref{Ranges}) as ham if it were
7642 incorrectly classified as spam. It then refiles the message into the
7643 @file{+inbox} folder.
7644
7645 @cindex @samp{*MH-E Log*}
7646 @cindex buffers, @samp{*MH-E Log*}
7647 @findex call-process
7648 @vindex mh-junk-background
7649
7650 By default, the programs are run in the foreground, but this can be
7651 slow when junking large numbers of messages. If you have enough memory
7652 or don't junk that many messages at the same time, you might try
7653 turning on the option @code{mh-junk-background}. @footnote{Note that
7654 the option @code{mh-junk-background} is used as the @code{display}
7655 argument in the call to @code{call-process}. Therefore, turning on
7656 this option means setting its value to @samp{0}. You can also set its
7657 value to @samp{t} to direct the programs' output to the @samp{*MH-E
7658 Log*} buffer; this may be useful for debugging.}
7659
7660 The following sections discuss the various counter-spam measures that
7661 MH-E can work with.
7662
7663 @cindex @file{.procmailrc}
7664 @cindex files, @file{.procmailrc}
7665
7666 @subheading SpamAssassin
7667
7668 @cindex Spamassassin
7669 @cindex spam filters, Spamassassin
7670
7671 SpamAssassin is one of the more popular spam filtering programs. Get
7672 it from your local distribution or from the
7673 @uref{http://spamassassin.apache.org/, SpamAssassin web site}.
7674
7675 To use SpamAssassin, add the following recipes to @file{~/.procmailrc}:
7676
7677 @cindex @command{spamc}
7678 @cindex @samp{X-Spam-Level:} header field
7679 @cindex @samp{X-Spam-Status:} header field
7680 @cindex header field, @samp{X-Spam-Level:}
7681 @cindex header field, @samp{X-Spam-Status:}
7682
7683 @smallexample
7684 PATH=$PATH:/usr/bin/mh
7685 MAILDIR=$HOME/`mhparam Path`
7686
7687 # Fight spam with SpamAssassin.
7688 :0fw
7689 | spamc
7690
7691 # Anything with a spam level of 10 or more is junked immediately.
7692 :0:
7693 * ^X-Spam-Level: ..........
7694 /dev/null
7695
7696 :0:
7697 * ^X-Spam-Status: Yes
7698 spam/.
7699 @end smallexample
7700
7701 If you don't use @command{spamc}, use @samp{spamassassin -P -a}.
7702
7703 Note that one of the recipes above throws away messages with a score
7704 greater than or equal to 10. Here's how you can determine a value that
7705 works best for you.
7706
7707 First, run @samp{spamassassin -t} on every mail message in your
7708 archive and use @command{gnumeric} to verify that the average plus the
7709 standard deviation of good mail is under 5, the SpamAssassin default
7710 for ``spam''.
7711
7712 Using @command{gnumeric}, sort the messages by score and view the
7713 messages with the highest score. Determine the score which encompasses
7714 all of your interesting messages and add a couple of points to be
7715 conservative. Add that many dots to the @samp{X-Spam-Level:} header
7716 field above to send messages with that score down the drain.
7717
7718 In the example above, messages with a score of 5-9 are set aside in
7719 the @samp{+spam} folder for later review. The major weakness of
7720 rules-based filters is a plethora of false positives so it is
7721 worthwhile to check.
7722
7723 @findex mh-junk-blacklist
7724 @findex mh-junk-whitelist
7725 @kindex J b
7726 @kindex J w
7727
7728 If SpamAssassin classifies a message incorrectly, or is unsure, you can
7729 use the MH-E commands @kbd{J b} (@code{mh-junk-blacklist}) and
7730 @kbd{J w} (@code{mh-junk-whitelist}).
7731
7732 @cindex @command{sa-learn}
7733 @cindex @file{.spamassassin/user_prefs}
7734 @cindex files, @file{.spamassassin/user_prefs}
7735
7736 The command @kbd{J b} (@code{mh-junk-blacklist}) adds a
7737 @samp{blacklist_from} entry to @file{~/spamassassin/user_prefs},
7738 deletes the message, and sends the message to the Razor, so that
7739 others might not see this spam. If the @command{sa-learn} command is
7740 available, the message is also recategorized as spam.
7741
7742 The command@kbd{J w} (@code{mh-junk-whitelist}) adds a
7743 @samp{whitelist_from} rule to @samp{~/.spamassassin/user_prefs}. If
7744 the @command{sa-learn} command is available, the message is also
7745 recategorized as ham.
7746
7747 Over time, you'll observe that the same host or domain occurs
7748 repeatedly in the @samp{blacklist_from} entries, so you might think
7749 that you could avoid future spam by blacklisting all mail from a
7750 particular domain. The utility function
7751 @code{mh-spamassassin-identify-spammers} helps you do precisely that.
7752 This function displays a frequency count of the hosts and domains in
7753 the @samp{blacklist_from} entries from the last blank line in
7754 @file{~/.spamassassin/user_prefs} to the end of the file. This
7755 information can be used so that you can replace multiple
7756 @samp{blacklist_from} entries with a single wildcard entry such as:
7757
7758 @smallexample
7759 blacklist_from *@@*amazingoffersdirect2u.com
7760 @end smallexample
7761
7762 In versions of SpamAssassin (2.50 and on) that support a Bayesian
7763 classifier, @kbd{J b} @code{(mh-junk-blacklist}) uses the program
7764 @command{sa-learn} to recategorize the message as spam. Neither MH-E,
7765 nor SpamAssassin, rebuilds the database after adding words, so you
7766 will need to run @samp{sa-learn --rebuild} periodically. This can be
7767 done by adding the following to your @file{crontab}:
7768
7769 @smallexample
7770 0 * * * * sa-learn --rebuild > /dev/null 2>&1
7771 @end smallexample
7772
7773 @subheading Bogofilter
7774
7775 @cindex bogofilter
7776 @cindex spam filters, bogofilter
7777
7778 Bogofilter is a Bayesian spam filtering program. Get it from your
7779 local distribution or from the
7780 @uref{http://bogofilter.sourceforge.net/, bogofilter web site}.
7781
7782 Bogofilter is taught by running:
7783
7784 @smallexample
7785 bogofilter -n < good-message
7786 @end smallexample
7787
7788 on every good message, and
7789
7790 @smallexample
7791 bogofilter -s < spam-message
7792 @end smallexample
7793
7794 @cindex full training
7795
7796 on every spam message. This is called a @dfn{full training}; three
7797 other training methods are described in the FAQ that is distributed
7798 with bogofilter. Note that most Bayesian filters need 1000 to 5000 of
7799 each type of message to start doing a good job.
7800
7801 To use bogofilter, add the following recipes to @file{~/.procmailrc}:
7802
7803 @cindex @samp{X-Bogosity:} header field
7804 @cindex header field, @samp{X-Bogosity:}
7805
7806 @smallexample
7807 PATH=$PATH:/usr/bin/mh
7808 MAILDIR=$HOME/`mhparam Path`
7809
7810 # Fight spam with Bogofilter.
7811 :0fw
7812 | bogofilter -3 -e -p
7813
7814 :0:
7815 * ^X-Bogosity: Yes, tests=bogofilter
7816 spam/.
7817
7818 :0:
7819 * ^X-Bogosity: Unsure, tests=bogofilter
7820 spam/unsure/.
7821 @end smallexample
7822
7823 @findex mh-junk-blacklist
7824 @findex mh-junk-whitelist
7825 @kindex J b
7826 @kindex J w
7827
7828 If bogofilter classifies a message incorrectly, or is unsure, you can
7829 use the MH-E commands @kbd{J b} (@code{mh-junk-blacklist}) and @kbd{J
7830 w} (@code{mh-junk-whitelist}) to update bogofilter's training.
7831
7832 The @cite{Bogofilter FAQ} suggests that you run the following
7833 occasionally to shrink the database:
7834
7835 @smallexample
7836 bogoutil -d wordlist.db | bogoutil -l wordlist.db.new
7837 mv wordlist.db wordlist.db.prv
7838 mv wordlist.db.new wordlist.db
7839 @end smallexample
7840
7841 The @cite{Bogofilter tuning HOWTO} describes how you can fine-tune
7842 bogofilter.
7843
7844 @subheading SpamProbe
7845
7846 @cindex SpamProbe
7847 @cindex spam filters, SpamProbe
7848
7849 SpamProbe is a Bayesian spam filtering program. Get it from your local
7850 distribution or from the @uref{http://spamprobe.sourceforge.net,
7851 SpamProbe web site}.
7852
7853 To use SpamProbe, add the following recipes to @file{~/.procmailrc}:
7854
7855 @cindex @command{formail}
7856 @cindex @samp{X-SpamProbe:} header field
7857 @cindex header field, @samp{X-SpamProbe:}
7858
7859 @smallexample
7860 PATH=$PATH:/usr/bin/mh
7861 MAILDIR=$HOME/`mhparam Path`
7862
7863 # Fight spam with SpamProbe.
7864 :0
7865 SCORE=| spamprobe receive
7866
7867 :0 wf
7868 | formail -I "X-SpamProbe: $SCORE"
7869
7870 :0:
7871 *^X-SpamProbe: SPAM
7872 spam/.
7873 @end smallexample
7874
7875 @findex mh-junk-blacklist
7876 @findex mh-junk-whitelist
7877 @kindex J b
7878 @kindex J w
7879
7880 If SpamProbe classifies a message incorrectly, you can use the MH-E
7881 commands @kbd{J b} (@code{mh-junk-blacklist}) and @kbd{J w}
7882 (@code{mh-junk-whitelist}) to update SpamProbe's training.
7883
7884 @subheading Other Things You Can Do
7885
7886 There are a couple of things that you can add to @file{~/.procmailrc}
7887 in order to filter out a lot of spam and viruses. The first is to
7888 eliminate any message with a Windows executable (which is most likely
7889 a virus). The second is to eliminate mail in character sets that you
7890 can't read.
7891
7892 @cindex @samp{Content-Transfer-Encoding:} header field
7893 @cindex @samp{Content-Type:} header field
7894 @cindex @samp{Subject:} header field
7895 @cindex header field, @samp{Content-Transfer-Encoding:}
7896 @cindex header field, @samp{Content-Type:}
7897 @cindex header field, @samp{Subject:}
7898
7899 @smallexample
7900 PATH=$PATH:/usr/bin/mh
7901 MAILDIR=$HOME/`mhparam Path`
7902
7903 #
7904 # Filter messages with win32 executables/virii.
7905 #
7906 # These attachments are base64 and have a TVqQAAMAAAAEAAAA//8AALg
7907 # pattern. The string "this program cannot be run in MS-DOS mode"
7908 # encoded in base64 is 4fug4AtAnNIbg and helps to avoid false
7909 # positives (Roland Smith via Pete from the bogofilter mailing list).
7910 #
7911 :0 B:
7912 * ^Content-Transfer-Encoding:.*base64
7913 * ^TVqQAAMAAAAEAAAA//8AALg
7914 * 4fug4AtAnNIbg
7915 spam/exe/.
7916
7917 #
7918 # Filter mail in unreadable character sets (from the Bogofilter FAQ).
7919 #
7920 UNREADABLE='[^?"]*big5|iso-2022-jp|ISO-2022-KR|euc-kr|gb2312|ks_c_5601-1987'
7921
7922 :0:
7923 * 1^0 $ ^Subject:.*=\?($UNREADABLE)
7924 * 1^0 $ ^Content-Type:.*charset="?($UNREADABLE)
7925 spam/unreadable/.
7926
7927 :0:
7928 * ^Content-Type:.*multipart
7929 * B ?? $ ^Content-Type:.*^?.*charset="?($UNREADABLE)
7930 spam/unreadable/.
7931 @end smallexample
7932
7933 @node Miscellaneous, Scan Line Formats, Junk, Top
7934 @chapter Miscellaneous Commands, Variables, and Buffers
7935
7936 This chapter covers the following command and the various MH-E
7937 buffers,
7938
7939 @ftable @code
7940 @item mh-version
7941 Display version information about MH-E and the MH mail handling
7942 system.
7943 @end ftable
7944
7945 @cindex buffers, @samp{*MH-E Info*}
7946 @cindex MH-E version
7947 @cindex @samp{*MH-E Info*}
7948 @cindex version
7949 @kindex M-x mh-version
7950
7951 One command worth noting is @kbd{M-x mh-version}. You can compare the
7952 version this command prints to the latest release (@pxref{Getting
7953 MH-E}). The output of @kbd{M-x mh-version}, found in a buffer named
7954 @samp{*MH-E Info*}, should usually be included with any bug report you
7955 submit (@pxref{Bug Reports}).
7956
7957 @subheading MH-E Buffers
7958
7959 Besides the MH-Folder, MH-Show, and MH-Letter buffers, MH-E creates
7960 several other buffers. They are:
7961
7962 @table @samp
7963 @cindex @samp{*MH-E Folders*}
7964 @cindex buffers, @samp{*MH-E Folders*}
7965 @findex mh-list-folders
7966 @item *MH-E Folders*
7967 @kindex F l
7968 This buffer contains the output of @kbd{F l} (@code{mh-list-folders}).
7969 @xref{Folders}.
7970 @c -------------------------
7971 @cindex @samp{*MH-E Help*}
7972 @cindex buffers, @samp{*MH-E Help*}
7973 @findex mh-help
7974 @item *MH-E Help*
7975 @kindex ?
7976 @kindex C-c ?
7977 This buffer contains the output of @kbd{?} (@code{mh-help}) and
7978 @kbd{C-c ?} in MH-Letter mode. @xref{Using This Manual}.
7979 @c -------------------------
7980 @cindex @samp{*MH-E Info*}
7981 @cindex buffers, @samp{*MH-E Info*}
7982 @item *MH-E Info*
7983 This buffer contains the output of @kbd{M-x mh-version @key{RET}}.
7984 @c -------------------------
7985 @cindex @samp{*MH-E Log*}
7986 @cindex buffers, @samp{*MH-E Log*}
7987 @item *MH-E Log*
7988 This buffer contains the last 100 lines of the output of the various
7989 MH commands.
7990 @c -------------------------
7991 @cindex @samp{*MH-E Mail Delivery*}
7992 @cindex buffers, @samp{*MH-E Mail Delivery*}
7993 @item *MH-E Mail Delivery*
7994 This buffer contains the transcript of a mail delivery. @xref{Sending
7995 Message}.
7996 @c -------------------------
7997 @cindex @samp{*MH-E Recipients*}
7998 @cindex buffers, @samp{*MH-E Recipients*}
7999 @findex mh-check-whom
8000 @item *MH-E Recipients*
8001 @kindex C-c C-w
8002 This buffer contains the output of @kbd{C-c C-w}
8003 (@code{mh-check-whom}) and is killed when draft is sent.
8004 @xref{Checking Recipients}.
8005 @c -------------------------
8006 @cindex @samp{*MH-E Sequences*}
8007 @cindex buffers, @samp{*MH-E Sequences*}
8008 @item *MH-E Sequences*
8009 This buffer contains the output of @kbd{S l}
8010 (@code{mh-list-sequences}). @xref{Sequences}.
8011 @c -------------------------
8012 @cindex @samp{*mh-temp*}
8013 @cindex buffers, @samp{*mh-temp*}
8014 @item *mh-temp*
8015 This is a scratch, ephemeral, buffer used by MH-E functions. Note that
8016 it is hidden because the first character in the name is a space.
8017 You'll generally not have any need for this buffer.
8018 @end table
8019
8020 @node Scan Line Formats, Procmail, Miscellaneous, Top
8021 @appendix Scan Line Formats
8022
8023 @cindex scan line formats
8024
8025 This appendix discusses how MH-E creates, parses, and manipulates scan
8026 lines. If you have your own MH scan or inc format files, you
8027 @strong{can} teach MH-E how to handle them, but it isn't easy as
8028 you'll see.
8029
8030 @cindex @samp{mh-scan-line-formats} customization group
8031 @cindex customization group, @samp{mh-scan-line-formats}
8032
8033 This table lists the options in the @samp{mh-scan-line-formats}
8034 customization group.
8035
8036 @vtable @code
8037 @item mh-adaptive-cmd-note-flag
8038 On means that the message number width is determined dynamically
8039 (default: @samp{on}).
8040 @c -------------------------
8041 @item mh-scan-format-file
8042 Specifies the format file to pass to the scan program (default:
8043 @samp{Use MH-E scan Format}).
8044 @c -------------------------
8045 @item mh-scan-prog
8046 Program used to scan messages (default: @code{"scan"}).
8047 @end vtable
8048
8049 @vindex mh-adaptive-cmd-note-flag
8050
8051 There are a couple of caveats when creating your own scan format file.
8052 First, MH-E will not work if your scan lines do not include message
8053 numbers. It will work poorly if you don't dedicate a column for
8054 showing the current message and notations. It is also best to keep the
8055 first column empty to make room for the cursor and so that text isn't
8056 obscured by the current message's overlay arrow when running in a
8057 terminal. You won't be able to use the option
8058 @code{mh-adaptive-cmd-note-flag} or the threading features
8059 (@pxref{Threading}).
8060
8061 @cindex message numbers
8062 @findex mh-set-cmd-note
8063 @vindex mh-adaptive-cmd-note-flag
8064 @vindex mh-scan-format-file
8065
8066 If you've created your own format to handle long message numbers,
8067 you'll be pleased to know you no longer need it since MH-E adapts its
8068 internal format based upon the largest message number if
8069 @code{mh-adaptive-cmd-note-flag} is on (the default). If you prefer
8070 fixed-width message numbers, turn off @code{mh-adaptive-cmd-note-flag}
8071 and call @code{mh-set-cmd-note} with the width specified by your
8072 format file (see @code{mh-scan-format-file}). For example, the default
8073 width is 4, so you would use @samp{(mh-set-cmd-note 4)}.
8074
8075 @vindex mh-adaptive-cmd-note-flag
8076 @vindex mh-scan-format-file
8077 @vindex mh-scan-format-mh
8078 @vindex mh-scan-format-nmh
8079
8080 The default setting for @code{mh-scan-format-file} is @samp{Use MH-E
8081 scan Format}. This means that the format string will be taken from the
8082 either @code{mh-scan-format-mh} or @code{mh-scan-format-nmh} depending
8083 on whether MH or nmh (or GNU mailutils MH) is in use. This setting
8084 also enables you to turn on the option
8085 @code{mh-adaptive-cmd-note-flag}. You can also set this option to
8086 @samp{Use Default scan Format} to get the same output as you would get
8087 if you ran @command{scan} from the shell. If you have a format file
8088 that you want MH-E to use but not MH, you can set this option to
8089 @samp{Specify a scan Format File} and enter the name of your format
8090 file.
8091
8092 @vindex mh-scan-format-file
8093 @vindex mh-scan-format-mh
8094 @vindex mh-scan-format-nmh
8095
8096 The scan format that MH-E uses when @code{mh-scan-format-file} is set
8097 to its default of @samp{Use MH-E scan Format} is held in the variables
8098 @code{mh-scan-format-nmh} and @code{mh-scan-format-mh} depending on
8099 whether you are using nmh (or GNU mailutils MH) or not. Typically, you
8100 create your own format files rather than modifying these variables.
8101 The value of @code{mh-scan-format-nmh} is:
8102
8103 @smallexample
8104 (concat
8105 "%4(msg)"
8106 "%<(cur)+%| %>"
8107 "%<@{replied@}-"
8108 "%?(nonnull(comp@{to@}))%<(mymbox@{to@})t%>"
8109 "%?(nonnull(comp@{cc@}))%<(mymbox@{cc@})c%>"
8110 "%?(nonnull(comp@{bcc@}))%<(mymbox@{bcc@})b%>"
8111 "%?(nonnull(comp@{newsgroups@}))n%>"
8112 "%<(zero) %>"
8113 "%02(mon@{date@})/%02(mday@{date@})%<@{date@} %|*%>"
8114 "%<(mymbox@{from@})%<@{to@}To:%14(decode(friendly@{to@}))%>%>"
8115 "%<(zero)%17(decode(friendly@{from@}))%> "
8116 "%(decode@{subject@})%<@{body@}<<%@{body@}%>")
8117 @end smallexample
8118
8119 @cindex decoding RFC 2047
8120 @cindex RFC 2047, decoding
8121 @vindex mh-scan-format-mh
8122
8123 The setting for @code{mh-scan-format-mh} is similar, except that MH
8124 doesn't have the function @code{decode} (which is used to decode RFC
8125 2047 encodings).
8126
8127 @cindex notations, scan line
8128 @cindex scan line notations
8129
8130 These strings are passed to the @command{scan} program via the
8131 @option{-format} argument. The formats are identical to the defaults
8132 except that additional hints for fontification have been added to the
8133 existing notations in the fifth column (remember that in Emacs, the
8134 columns start at 0). The values of the fifth column, in priority
8135 order, are: @samp{-} if the message has been replied to, @samp{t} if
8136 an address in the @samp{To:} field matches one of the mailboxes of the
8137 current user, @samp{c} if the @samp{Cc:} field matches, @samp{b} if
8138 the @samp{Bcc:} field matches, and @samp{n} if a non-empty
8139 @samp{Newsgroups:} field is present.
8140
8141 @cindex @command{scan}
8142 @cindex MH commands, @command{scan}
8143 @vindex mh-progs
8144 @vindex mh-scan-prog
8145
8146 The name of the program that generates a listing of one line per
8147 message is held in @code{mh-scan-prog} (default: @code{"scan"}).
8148 Unless this variable contains an absolute pathname, it is assumed to
8149 be in the @code{mh-progs} directory (@pxref{Getting Started}). You may
8150 link another program to @command{scan} (see @samp{mh-profile}(5)) to
8151 produce a different type of listing@footnote{See the section
8152 @uref{@value{MH-BOOK-HOME}/faswsprs.html, Find and Specify with scan
8153 pick Ranges Sequences} in the MH book.}.
8154
8155 @cindex regular expressions, scan line formats
8156 @findex mh-set-cmd-note
8157 @findex setq
8158
8159 If you change the format of the scan lines you'll need to tell MH-E
8160 how to parse the new format. As you will see, quite a lot of variables
8161 are involved to do that. Use @kbd{M-x apropos @key{RET}
8162 mh-scan.*regexp @key{RET}} to obtain a list of these variables. You
8163 will also have to call @code{mh-set-cmd-note} if your notations are
8164 not in column 4 (columns in Emacs start with 0). Note that unlike most
8165 of the user options described in this manual, these are variables and
8166 must be set with @code{setq} instead of in a customization buffer. For
8167 help with regular expressions, see
8168 @ifnothtml
8169 @ref{Regexps, , Syntax of Regular Expressions, emacs, The
8170 GNU Emacs Manual}.
8171 @end ifnothtml
8172 @ifhtml
8173 section
8174 @uref{http://www.gnu.org/software/emacs/manual/html_node/Regexps.html,
8175 Syntax of Regular Expressions} in @cite{The GNU Emacs Manual}.
8176 @end ifhtml
8177
8178 The first variable has to do with pruning out garbage.
8179
8180 @vtable @code
8181 @cindex @command{inc}
8182 @cindex MH commands, @command{inc}
8183 @cindex @command{scan}
8184 @cindex MH commands, @command{scan}
8185 @item mh-scan-valid-regexp
8186 This regular expression describes a valid scan line. This is used to
8187 eliminate error messages that are occasionally produced by
8188 @command{inc}@footnote{See the section
8189 @uref{@value{MH-BOOK-HOME}/reapre.html, Reading Mail: inc show next
8190 prev} in the MH book.} or @command{scan} (default: @code{"^ *[0-9]"}).
8191 @end vtable
8192
8193 Next, many variables control how the scan lines are parsed.
8194
8195 @vtable @code
8196 @vindex mh-folder-body
8197 @vindex mh-folder-font-lock-keywords
8198 @item mh-scan-body-regexp
8199 This regular expression matches the message body fragment. Note that
8200 the default setting of @code{mh-folder-font-lock-keywords} expects
8201 this expression to contain at least one parenthesized expression which
8202 matches the body text as in the default of
8203 @code{"\\(<<\\([^\n]+\\)?\\)"}. If this regular expression is not
8204 correct, the body fragment will not be highlighted with the face
8205 @code{mh-folder-body}.
8206 @c -------------------------
8207 @vindex mh-folder-cur-msg-number
8208 @vindex mh-folder-font-lock-keywords
8209 @vindex mh-note-cur
8210 @item mh-scan-cur-msg-number-regexp
8211 This regular expression matches the current message. It must match
8212 from the beginning of the line. Note that the default setting of
8213 @code{mh-folder-font-lock-keywords} expects this expression to contain
8214 at least one parenthesized expression which matches the message number
8215 as in the default of @w{@code{"^\\( *[0-9]+\\+\\).*"}}. This
8216 expression includes the leading space and current message marker
8217 @samp{+} within the parenthesis since it looks better to highlight
8218 these items as well. The highlighting is done with the face
8219 @code{mh-folder-cur-msg-number}. This regular expression should be
8220 correct as it is needed by non-fontification functions. See also
8221 @code{mh-note-cur}.
8222 @c -------------------------
8223 @vindex mh-folder-date
8224 @vindex mh-folder-font-lock-keywords
8225 @vindex mh-scan-sent-to-me-sender-regexp
8226 @item mh-scan-date-regexp
8227 This regular expression matches a valid date. It must @strong{not} be
8228 anchored to the beginning or the end of the line. Note that the
8229 default setting of @code{mh-folder-font-lock-keywords} expects this
8230 expression to contain only one parenthesized expression which matches
8231 the date field as in the default of
8232 @code{"\\([0-9][0-9]/[0-9][0-9]\\)"}. If this regular expression is
8233 not correct, the date will not be highlighted with the face
8234 @code{mh-folder-date}.
8235 @c -------------------------
8236 @vindex mh-folder-deleted
8237 @vindex mh-folder-font-lock-keywords
8238 @vindex mh-note-deleted
8239 @item mh-scan-deleted-msg-regexp
8240 This regular expression matches deleted messages. It must match from
8241 the beginning of the line. Note that the default setting of
8242 @code{mh-folder-font-lock-keywords} expects this expression to contain
8243 at least one parenthesized expression which matches the message number
8244 as in the default of @code{"^\\( *[0-9]+\\)D"}. This expression
8245 includes the leading space within the parenthesis since it looks
8246 better to highlight it as well. The highlighting is done with the face
8247 @code{mh-folder-deleted}. This regular expression should be correct as
8248 it is needed by non-fontification functions. See also
8249 @code{mh-note-deleted}.
8250 @c -------------------------
8251 @vindex mh-folder-font-lock-keywords
8252 @vindex mh-folder-msg-number
8253 @item mh-scan-good-msg-regexp
8254 This regular expression matches ``good'' messages. It must match from
8255 the beginning of the line. Note that the default setting of
8256 @code{mh-folder-font-lock-keywords} expects this expression to contain
8257 at least one parenthesized expression which matches the message number
8258 as in the default of @w{@code{"^\\( *[0-9]+\\)[^D^0-9]"}}. This
8259 expression includes the leading space within the parenthesis since it
8260 looks better to highlight it as well. The highlighting is done with
8261 the face @code{mh-folder-msg-number}. This regular expression should
8262 be correct as it is needed by non-fontification functions.
8263 @c -------------------------
8264 @vindex mh-scan-format-file
8265 @item mh-scan-msg-format-regexp
8266 This regular expression finds the message number width in a scan
8267 format. Note that the message number must be placed in a parenthesized
8268 expression as in the default of @code{"%\\([0-9]*\\)(msg)"}. This
8269 variable is only consulted if @code{mh-scan-format-file} is set to
8270 @samp{Use MH-E scan Format}.
8271 @c -------------------------
8272 @vindex mh-scan-format-file
8273 @item mh-scan-msg-format-string
8274 This is a format string for the width of the message number in a scan
8275 format. Use @samp{0%d} for zero-filled message numbers. This variable
8276 is only consulted if @code{mh-scan-format-file} is set to @samp{Use
8277 MH-E scan Format} (default: @code{"%d"}).
8278 @c -------------------------
8279 @item mh-scan-msg-number-regexp
8280 This regular expression extracts the message number. It must match
8281 from the beginning of the line. Note that the message number must be
8282 placed in a parenthesized expression as in the default of @w{@code{"^
8283 *\\([0-9]+\\)"}}.
8284 @c -------------------------
8285 @item mh-scan-msg-overflow-regexp
8286 This regular expression matches overflowed message numbers (default:
8287 @code{"^[?0-9][0-9]"}).
8288 @c -------------------------
8289 @item mh-scan-msg-search-regexp
8290 This regular expression matches a particular message. It is a format
8291 string; use @samp{%d} to represent the location of the message number
8292 within the expression as in the default of @code{"^[^0-9]*%d[^0-9]"}.
8293 @c -------------------------
8294 @vindex mh-folder-address
8295 @vindex mh-folder-font-lock-keywords
8296 @vindex mh-folder-to
8297 @item mh-scan-rcpt-regexp
8298 This regular expression specifies the recipient in messages you sent.
8299 Note that the default setting of @code{mh-folder-font-lock-keywords}
8300 expects this expression to contain two parenthesized expressions. The
8301 first is expected to match the @samp{To:} that the default scan format
8302 file generates. The second is expected to match the recipient's name
8303 as in the default of @code{"\\(To:\\)\\(..............\\)"}. If this
8304 regular expression is not correct, the @samp{To:} string will not be
8305 highlighted with the face @code{mh-folder-to} and the recipient will not be
8306 highlighted with the face @code{mh-folder-address}.
8307 @c -------------------------
8308 @vindex mh-folder-font-lock-keywords
8309 @vindex mh-folder-refiled
8310 @vindex mh-note-refiled
8311 @item mh-scan-refiled-msg-regexp
8312 This regular expression matches refiled messages. It must match from
8313 the beginning of the line. Note that the default setting of
8314 @code{mh-folder-font-lock-keywords} expects this expression to contain
8315 at least one parenthesized expression which matches the message number
8316 as in the default of @w{@code{"^\\( *[0-9]+\\)\\^"}}. This expression
8317 includes the leading space within the parenthesis since it looks
8318 better to highlight it as well. The highlighting is done with the face
8319 @code{mh-folder-refiled}. This regular expression should be correct as
8320 it is needed by non-fontification functions. See also
8321 @code{mh-note-refiled}.
8322 @c -------------------------
8323 @vindex mh-folder-font-lock-keywords
8324 @vindex mh-folder-sent-to-me-sender
8325 @vindex mh-mh-folder-sent-to-me-hint
8326 @vindex mh-scan-format-nmh
8327 @item mh-scan-sent-to-me-sender-regexp
8328 This regular expression matches messages sent to us. Note that the
8329 default setting of @code{mh-folder-font-lock-keywords} expects this
8330 expression to contain at least two parenthesized expressions. The
8331 first should match the fontification hint (see
8332 @code{mh-scan-format-nmh}) and the second should match the user name
8333 as in the default of
8334 @w{@code{"^ *[0-9]+.\\([bct]\\).....[ ]*\\(..................\\)"}}.
8335 If this regular expression is not correct, the notation hints will not
8336 be highlighted with the face @code{mh-mh-folder-sent-to-me-hint} and
8337 the sender will not be highlighted with the face
8338 @code{mh-folder-sent-to-me-sender}.
8339 @c -------------------------
8340 @vindex mh-folder-followup
8341 @vindex mh-folder-font-lock-keywords
8342 @vindex mh-folder-subject
8343 @item mh-scan-subject-regexp
8344 This regular expression matches the subject. It must match from the
8345 beginning of the line. Note that the default setting of
8346 @samp{mh-folder-font-lock-keywords} expects this expression to contain
8347 at least three parenthesized expressions. The first is expected to
8348 match the @samp{Re:} string, if any, and is highlighted with the face
8349 @code{mh-folder-followup}. The second matches an optional bracketed
8350 number after @samp{Re:}, such as in @samp{Re[2]:} (and is thus a
8351 sub-expression of the first expression). The third is expected to
8352 match the subject line itself which is highlighted with the face
8353 @code{mh-folder-subject}. For example, the default is
8354 @w{@code{"^ *[0-9]+........[ ]*...................}}@*
8355 @w{@code{\\([Rr][Ee]\\(\\[[0-9]+\\]\\)?:\\s-*\\)*\\([^<\n]*\\)"}}.
8356 This regular expression should be correct as it is needed by
8357 non-fontification functions. Note that this example is broken up on
8358 two lines for readability, but is actually a single string.
8359 @end vtable
8360
8361 Finally, there are a slew of variables that control how MH-E annotates
8362 the scan lines.
8363
8364 @vtable @code
8365 @findex mh-set-cmd-note
8366 @vindex mh-adaptive-cmd-note-flag
8367 @item mh-cmd-note
8368 Column for notations (default: 4). This variable should be set with
8369 the function @code{mh-set-cmd-note}. This variable may be updated
8370 dynamically if @code{mh-adaptive-cmd-note-flag} is on. The following
8371 variables contain the notational characters. Note that columns in
8372 Emacs start with 0.
8373 @c -------------------------
8374 @item mh-note-copied
8375 Messages that have been copied are marked by this character (default:
8376 @code{?C}).
8377 @c -------------------------
8378 @vindex mh-scan-cur-msg-number-regexp
8379 @item mh-note-cur
8380 The current message (in MH, not in MH-E) is marked by this character
8381 (default: @code{?+}). See also @code{mh-scan-cur-msg-number-regexp}.
8382 @c -------------------------
8383 @vindex mh-scan-deleted-msg-regexp
8384 @item mh-note-deleted
8385 Messages that have been deleted are marked by this character (default:
8386 @code{?D}). See also @code{mh-scan-deleted-msg-regexp}.
8387 @c -------------------------
8388 @item mh-note-dist
8389 Messages that have been redistributed are marked by this character
8390 (default: @code{?R}).
8391 @c -------------------------
8392 @item mh-note-forw
8393 Messages that have been forwarded are marked by this character
8394 (default: @code{?F}).
8395 @c -------------------------
8396 @item mh-note-printed
8397 Messages that have been printed are marked by this character (default:
8398 @code{?P}).
8399 @c -------------------------
8400 @vindex mh-scan-refiled-msg-regexp
8401 @item mh-note-refiled
8402 Messages that have been refiled are marked by this character (default:
8403 @code{?^}). See also @code{mh-scan-refiled-msg-regexp}.
8404 @c -------------------------
8405 @item mh-note-repl
8406 Messages that have been replied to are marked by this character
8407 (default: @code{?-}).
8408 @c -------------------------
8409 @item mh-note-seq
8410 Messages in a user-defined sequence are marked by this character
8411 (default: @code{?%}). Messages in the @samp{search} sequence are
8412 marked by this character as well.
8413 @end vtable
8414
8415 For example, let's say I have the following in @file{scan.format}
8416 which displays the sender, the subject, and the message number. This
8417 format places a @samp{+} after the message number for the current
8418 message according to MH; it also uses that column for notations.
8419
8420 @smallexample
8421 %20(decode(friendly@{from@})) %50(decode@{subject@}) %4(msg)%<(cur)+%| %>
8422 @end smallexample
8423
8424 @vindex mh-adaptive-cmd-note-flag
8425 @vindex mh-scan-format-file
8426 @vindex mh-scan-format-file, example
8427
8428 The first thing you have to do is tell MH-E to use this file.
8429 Customize @code{mh-scan-format-file} and set its value to @samp{Use
8430 Default scan Format}. If you didn't get already turn off
8431 @code{mh-adaptive-cmd-note-flag}, you'll need to do that first.
8432
8433 Next, tell MH-E what a valid scan line looks like so that you can at
8434 least display the output of scan in your MH-Folder buffer.
8435
8436 @vindex mh-scan-valid-regexp, example
8437
8438 @smalllisp
8439 (setq mh-scan-valid-regexp "[0-9]+[+D^ ]$")
8440 @end smalllisp
8441
8442 Now, in order to get rid of the @samp{Cursor not pointing to message}
8443 message, you need to tell MH-E how to access the message number. You
8444 should also see why MH-E requires that you include a message number in
8445 the first place.
8446
8447 @vindex mh-scan-msg-number-regexp, example
8448 @vindex mh-scan-msg-search-regexp, example
8449
8450 @smalllisp
8451 (setq mh-scan-msg-number-regexp "^.* \\([0-9]+\\)[+D^ ]$")
8452 (setq mh-scan-msg-search-regexp " %d[+D^ ]$")
8453 @end smalllisp
8454
8455 In order to get the next and previous commands working, add this.
8456
8457 @vindex mh-scan-good-msg-regexp, example
8458
8459 @smalllisp
8460 (setq mh-scan-good-msg-regexp "^.* \\([0-9]+\\)[+D^ ]$")
8461 @end smalllisp
8462
8463 Note that the current message isn't marked with a @samp{+} when moving
8464 between the next and previous messages. Here is the code required to
8465 get this working.
8466
8467 @vindex set-mh-cmd-note, example
8468 @vindex mh-scan-cur-msg-number-regexp, example
8469
8470 @smalllisp
8471 (set-mh-cmd-note 76)
8472 (setq mh-scan-cur-msg-number-regexp "^.* \\([0-9]+\\)\\+$")
8473 @end smalllisp
8474
8475 Finally, add the following to delete and refile messages.
8476
8477 @vindex mh-scan-deleted-msg-regexp, example
8478 @vindex mh-scan-refiled-msg-regexp, example
8479
8480 @smalllisp
8481 (setq mh-scan-deleted-msg-regexp "^.* \\([0-9]+\\)D$")
8482 (setq mh-scan-refiled-msg-regexp "^.* \\([0-9]+\\)\\^$")
8483 @end smalllisp
8484
8485 This is just a bare minimum; it's best to adjust all of the regular
8486 expressions to ensure that MH-E and highlighting perform well.
8487
8488 @node Procmail, Odds and Ends, Scan Line Formats, Top
8489 @appendix Reading Mailing Lists Effectively
8490
8491 @cindex @command{procmail}
8492 @cindex @command{slocal}
8493 @cindex Gnus
8494 @cindex MH commands, @command{slocal}
8495 @cindex Unix commands, @command{procmail}
8496 @cindex mailing lists, reading
8497
8498 This appendix explains how to use @uref{http://www.procmail.org/,
8499 procmail} to file mail from mailing lists into folders which can then
8500 be read easily with MH-E@footnote{The MH equivalent, @command{slocal},
8501 can be used as well, but procmail is more flexible and more packages
8502 exist for procmail than for slocal.}. Some mailing lists have such
8503 high traffic that Gnus must be used and I discuss how to use Gnus
8504 side-by-side with MH-E.
8505
8506 @cindex @file{.procmailrc}
8507 @cindex files, @file{.procmailrc}
8508
8509 First, I'll describe how to put mail from your mailing lists directly
8510 into an MH folder using @command{procmail}. First, add the following
8511 to @file{~/.procmailrc}. While the logging variables aren't strictly
8512 necessary, they are extremely useful.
8513
8514 @smallexample
8515 [1] # Update PATH so procmail can find myrcvstore, rcvstore and mhparam.
8516 [2] PATH=$PATH:/usr/lib/mh:/usr/bin/mh:$HOME/bin
8517 [3]
8518 [4] # Point LOGFILE at the actual log file.
8519 [5] LOGFILE=$HOME/.procmail.log
8520 [6]
8521 [7] # This setting provides just the right amount of information.
8522 [8] LOGABSTRACT=all
8523 [9]
8524 [10] # Uncomment the following line to see how your patterns match.
8525 [11] #VERBOSE=yes
8526 [12]
8527 [13] # Place mail sent to any MH-E mailing list in +mh-e.
8528 [14] :0 w: mh-e$LOCKEXT
8529 [15] * ^TO.*mh-e-.*@.*sourceforge.net
8530 [16] | myrcvstore -create +mh-e
8531 @end smallexample
8532
8533 @cindex @command{rcvstore}
8534 @cindex MH commands, @command{rcvstore}
8535
8536 Line 14 creates a lock file in your mail directory based upon the name
8537 of the folder. This is done because @command{rcvstore} does not
8538 perform locking. While this lock file will prevent @command{procmail}
8539 from writing to a folder concurrently, there is a slight chance that
8540 you might lose a message if you're performing operations on a folder
8541 at the same time @command{rcvstore} is placing a message there. You
8542 have been warned. Now that that disclaimer is out of the way, note
8543 that I've been using this set-up for over a decade and haven't lost
8544 anything to my knowledge@footnote{See
8545 @uref{https://savannah.nongnu.org/bugs/?func=detailbug&bug_id=4361&group_id=2166,
8546 Savannah issue #4361} to see if @command{rcvstore} locking is still an
8547 issue.}.
8548
8549 @cindex @samp{Unseen-Sequence:} MH profile component
8550 @cindex MH profile component, @samp{Unseen-Sequence:}
8551
8552 Line 16 uses the following script, @code{myrcvstore}, to massage the
8553 message as described in the comment and file the message in the given
8554 folder@footnote{The @samp{-create} argument wasn't always the default
8555 to @command{rcvstore}.}.
8556
8557 @smallexample
8558 #! /bin/sh
8559
8560 # Accepts a message on standard input and passes it through rcvstore
8561 # after first passing it through any filters. All arguments are passed
8562 # on to rcvstore.
8563
8564 # Force the "From user date" to become part of header. One reason this
8565 # is done is because the presence of the From field confuses dist so
8566 # that dist adds a new header, rather than using the existing header.
8567 # Note that this should not be done for any message that goes into a
8568 # Gnus incoming file (Gnus will thrown an error) nor should it be
8569 # applied to any message that goes to the system mailbox because the
8570 # entire mailbox will be incorporated as a single message.
8571 formail -c -z -R 'From ' X-Envelope-From: |
8572 rcvstore $@@
8573 @end smallexample
8574
8575 If your version of @command{rcvstore} doesn't add messages to the
8576 @samp{unseen} sequence by default, add the following line to your MH
8577 profile:
8578
8579 @smallexample
8580 Unseen-Sequence: unseen
8581 @end smallexample
8582
8583 Now view your new messages with the speedbar (@pxref{Speedbar}) or with
8584 @kbd{F n} (@code{mh-index-new-messages}). @xref{Folders}.
8585
8586 If you're on a mailing list that is so voluminous that it is
8587 impossible to read every message, it usually better to read the
8588 mailing list like a newsgroup in a news reader. Emacs has a built-in
8589 newsreader called Gnus. The remainder of this appendix talks about how
8590 to use Gnus with an MH message store. The version of Gnus that was
8591 used to prepare this manual was 5.10. Versions 5.8 through 5.10 should
8592 work but versions prior to 5.8 use different options.
8593
8594 This table contains a list of Gnus options that you will have to
8595 modify. Note that for them to become accessible, you'll have to load
8596 @file{nnml.el} first. This can be done with @kbd{M-x load-library
8597 @key{RET} nnml @key{RET}}.
8598
8599 @vtable @code
8600 @item gnus-secondary-select-methods
8601 Select the @samp{nnml} value. This select method uses directories for
8602 folders and individual files for messages, just like MH. You do not
8603 have to set an address.
8604 @c -------------------------
8605 @item mail-sources
8606 Select the @samp{Several files in a directory} value, check the
8607 @samp{Path} box and enter @file{~/Mail} to tell Gnus where to find
8608 your mail.
8609 @c -------------------------
8610 @vindex mail-user-agent
8611 @item message-mail-user-agent
8612 In order to send mail within Gnus using MH-E, set this option to
8613 @samp{mail-user-agent} and set the @code{mail-user-agent} option to
8614 @samp{Emacs interface to MH}.
8615 @c -------------------------
8616 @item nnmail-keep-last-article
8617 Since Gnus keeps track of which messages you have read, it would be
8618 bad if Gnus expired the last message, for example, message 100, and
8619 @command{rcvstore} gave the next new message number 1. Gnus would then
8620 ignore it since it thinks that you've read messages 1-100. Turning on
8621 this option ensures that the last message is never removed thereby
8622 eliminating this problem.
8623 @end vtable
8624
8625 Next add the following to @file{~/.procmailrc}. If you don't subscribe
8626 to the GnuCash mailing list, substitute one to which you are
8627 subscribed.
8628
8629 @smallexample
8630 PATH=$PATH:/usr/bin/mh
8631 MAILDIR=$HOME/`mhparam Path`
8632 # Place mail sent to the GnuCash mailing list in gnucash.spool, where
8633 # Gnus will pick it up.
8634 :0:
8635 * ^TO.*gnucash.*@.*gnucash.org
8636 gnucash.spool
8637 @end smallexample
8638
8639 Wait for some messages to appear in @file{gnucash.spool} and run Gnus
8640 with @kbd{M-x gnus @key{RET}}. To view the folder created in the
8641 example above, you would tell Gnus about it the first time only with
8642 @kbd{G m gnucash @key{RET} nnml @key{RET}}. In MH-E, this folder is
8643 known as @samp{+gnucash}.
8644
8645 @node Odds and Ends, History, Procmail, Top
8646 @appendix Odds and Ends
8647
8648 This appendix covers a few topics that don't fit elsewhere. Here I
8649 tell you how to report bugs and how to get on the MH-E mailing lists.
8650 I also point out some additional sources of information.
8651
8652 @menu
8653 * Bug Reports::
8654 * Mailing Lists::
8655 * MH FAQ and Support::
8656 * Getting MH-E::
8657 @end menu
8658
8659 @node Bug Reports, Mailing Lists, Odds and Ends, Odds and Ends
8660 @appendixsec Bug Reports
8661
8662 @cindex bugs
8663 @cindex SourceForge
8664 @kindex M-x mh-version
8665
8666 Bug reports should be filed at
8667 @uref{https://sourceforge.net/tracker/?group_id=13357&atid=113357,
8668 SourceForge}. You need to be a SourceForge user to submit bug reports,
8669 but this is easy enough to do that it shouldn't be a restriction for
8670 you. Please include the output of @kbd{M-x mh-version}
8671 (@pxref{Miscellaneous}) in any bug report you send unless you're 110%
8672 positive we won't ask for it.
8673
8674 @node Mailing Lists, MH FAQ and Support, Bug Reports, Odds and Ends
8675 @appendixsec MH-E Mailing Lists
8676
8677 @cindex SourceForge
8678 @cindex mailing lists
8679
8680 There are several mailing lists for MH-E. They are @i{mh-e-users at
8681 lists.sourceforge.net}, @i{mh-e-announce at lists.sourceforge.net},
8682 and @i{mh-e-devel at lists.sourceforge.net}. You can subscribe or view
8683 the archives at @uref{https://sourceforge.net/mail/?group_id=13357,
8684 SourceForge}. Do not report bugs on these lists; please submit them
8685 via SourceForge (@pxref{Bug Reports}).
8686
8687 @node MH FAQ and Support, Getting MH-E, Mailing Lists, Odds and Ends
8688 @appendixsec MH FAQ and Support
8689
8690 @cindex FAQ
8691 @cindex MH FAQ
8692
8693 The article @uref{http://www.newt.com/faq/mh.html, @cite{MH Frequently
8694 Asked Questions (FAQ) with Answers}} appears monthly in the newsgroup
8695 @samp{comp.mail.mh}. While very little is there that deals with MH-E
8696 specifically, there is an incredible wealth of material about MH
8697 itself which you will find useful.
8698
8699 @cindex support
8700
8701 You can find FAQs on MH-E at the
8702 @uref{https://sourceforge.net/tracker/?group_id=13357&atid=213357,
8703 Support Requests} page on SourceForge. If you don't find the answer to
8704 your question, file a support request and your question will become a
8705 new FAQ!
8706
8707 @node Getting MH-E, , MH FAQ and Support, Odds and Ends
8708 @appendixsec Getting MH-E
8709
8710 @cindex MH-E, obtaining
8711 @cindex getting MH-E
8712 @cindex obtaining MH-E
8713
8714 Because MH-E is undergoing a phase of sustained growth, the version of
8715 MH-E in your Emacs is likely to be out of date although it is most
8716 likely to be more up to date than the copy that comes with the MH
8717 distribution in @file{miscellany/mh-e}.
8718
8719 @cindex change log
8720 @cindex release notes
8721
8722 New MH-E releases are always available for downloading at
8723 @uref{https://sourceforge.net/project/showfiles.php?group_id=13357,
8724 SourceForge} before they appear in an Emacs release. You can read the
8725 release notes on that page to determine if the given release of MH-E
8726 is already installed in your version of Emacs. You can also read the
8727 change log to see if you are interested in what the given release of
8728 MH-E has to offer (although we have no doubt that you will be
8729 extremely interested in all new releases).
8730
8731 @cindex Debian
8732
8733 If you use Debian, you can install the Debian
8734 @uref{http://packages.debian.org/unstable/mail/mh-e, mh-e package}
8735 instead.
8736
8737 @cindex files, @samp{MH-E-NEWS}
8738 @cindex files, @samp{README}
8739 @cindex news
8740 @cindex @samp{MH-E-NEWS}
8741 @cindex @samp{README}
8742 @kindex M-x mh-version
8743
8744 After you download and extract the MH-E tarball, read the
8745 @file{README} file and @file{MH-E-NEWS}. These correspond to the
8746 release notes and change log mentioned above. The file @file{README}
8747 contains instructions on installing MH-E. If you're already running
8748 Emacs, please quit that session and start again to load in the new
8749 MH-E. Check that you're running the new version with the command
8750 @kbd{M-x mh-version}.
8751
8752 @cindex contributed software
8753 @cindex manual
8754 @cindex documentation
8755
8756 In addition to the mh-e package, the
8757 @uref{https://sourceforge.net/project/showfiles.php?group_id=13357,
8758 SourceForge} site also contains doc and contrib packages. The former
8759 is the latest release of this manual, and the latter contains a few
8760 contributed packages you might find useful.
8761
8762 @node History, GFDL, Odds and Ends, Top
8763 @appendix History of MH-E
8764
8765 @cindex Bill Wohler
8766 @cindex Brian Reid
8767 @cindex Gildea, Stephen
8768 @cindex Jim Larus
8769 @cindex Larus, Jim
8770 @cindex MH-E, versions
8771 @cindex Reid, Brian
8772 @cindex SourceForge
8773 @cindex Stephen Gildea
8774 @cindex Wohler, Bill
8775 @cindex history of MH-E
8776 @cindex versions of MH-E
8777
8778 MH-E was originally written by Brian Reid in 1983 and has changed
8779 hands several times since then. Jim Larus wanted to do something
8780 similar for GNU Emacs, and ended up completely rewriting it that same
8781 year. In 1989, Stephen Gildea picked it up and added many
8782 improvements. Bill Wohler then took over in 2000 and moved its
8783 development to @uref{http://sourceforge.net/, SourceForge} where it
8784 lives today.
8785
8786 @menu
8787 * From Brian Reid::
8788 * From Jim Larus::
8789 * From Stephen Gildea::
8790 * From Bill Wohler::
8791 @end menu
8792
8793 @node From Brian Reid, From Jim Larus, History, History
8794 @appendixsec From Brian Reid
8795
8796 @cindex Brian Reid
8797 @cindex Reid, Brian
8798
8799 One day in 1983 I got the flu and had to stay home from work for three
8800 days with nothing to do. I used that time to write MHE@. The
8801 fundamental idea behind MHE was that it was a ``puppeteer'' driving
8802 the MH programs underneath it. MH had a model that the editor was
8803 supposed to run as a sub-process of the mailer, which seemed to me at
8804 the time to be the tail wagging the dog. So I turned it around and
8805 made the editor drive the MH programs. I made sure that the UCI people
8806 (who were maintaining MH at the time) took in my changes and made them
8807 stick.
8808
8809 Today, I still use my own version of MHE because I don't at all like
8810 the way that GNU MH-E works and I've never gotten to be good enough at
8811 hacking Emacs Lisp to make GNU MH-E do what I want. The Gosling-emacs
8812 version of MHE and the GNU Emacs version of MH-E have almost nothing
8813 in common except similar names. They work differently, have different
8814 conceptual models, and have different key bindings@footnote{After
8815 reading this article, I questioned Brian about his version of MHE, and
8816 received some great ideas for improving MH-E such as a dired-like
8817 method of selecting folders; and removing the prompting when sending
8818 mail, filling in the blanks in the draft buffer instead. I passed them
8819 on to Stephen Gildea, the current maintainer, and he was excited about
8820 the ideas as well. Perhaps one day, MH-E will again resemble MHE
8821 (draft form editing was introduced in version 7.4).}.
8822
8823 Brian Reid, June 1994
8824
8825 @node From Jim Larus, From Stephen Gildea, From Brian Reid, History
8826 @appendixsec From Jim Larus
8827
8828 @cindex Jim Larus
8829 @cindex Larus, Jim
8830
8831 Brian Reid, while at CMU or shortly after going to Stanford wrote a
8832 mail reading program called MHE for Gosling Emacs. It had much the
8833 same structure as MH-E (i.e., invoked MH programs), though it was
8834 simpler and the commands were slightly different. Unfortunately, I no
8835 longer have a copy so the differences are lost in the mists of time.
8836
8837 In '82-83, I was working at BBN and wrote a lot of mlisp code in
8838 Gosling Emacs to make it look more like Tennex Emacs. One of the
8839 packages that I picked up and improved was Reid's mail system. In '83,
8840 I went back to Berkeley. About that time, Stallman's first version of
8841 GNU Emacs came out and people started to move to it from Gosling Emacs
8842 (as I recall, the transition took a year or two). I decided to port
8843 Reid's MHE and used the mlisp to Emacs Lisp translator that came with
8844 GNU Emacs. It did a lousy job and the resulting code didn't work, so I
8845 bit the bullet and rewrote the code by hand (it was a lot smaller and
8846 simpler then, so it took only a day or two).
8847
8848 Soon after that, MH-E became part of the standard Emacs distribution
8849 and suggestions kept dribbling in for improvements. MH-E soon reached
8850 sufficient functionality to keep me happy, but I kept on improving it
8851 because I was a graduate student with plenty of time on my hands and
8852 it was more fun than my dissertation. In retrospect, the one thing
8853 that I regret is not writing any documentation, which seriously
8854 limited the use and appeal of the package.
8855
8856 @cindex @command{xmh}, in MH-E history
8857
8858 In '89, I came to Wisconsin as a professor and decided not to work on
8859 MH-E. It was stable, except for minor bugs, and had enough
8860 functionality, so I let it be for a few years. Stephen Gildea of BBN
8861 began to pester me about the bugs, but I ignored them. In 1990, he
8862 went off to the X Consortium, said good bye, and said that he would
8863 now be using @command{xmh}. A few months later, he came back and said
8864 that he couldn't stand @command{xmh} and could I put a few more bug fixes
8865 into MH-E. At that point, I had no interest in fixing MH-E, so I gave
8866 the responsibility of maintenance to him and he has done a fine job
8867 since then.
8868
8869 Jim Larus, June 1994
8870
8871 @node From Stephen Gildea, From Bill Wohler, From Jim Larus, History
8872 @appendixsec From Stephen Gildea
8873
8874 @cindex Gildea, Stephen
8875 @cindex Stephen Gildea
8876
8877 In 1987 I went to work for Bolt Beranek and Newman, as Jim had before
8878 me. In my previous job, I had been using RMAIL, but as my folders tend
8879 to run large, I was frustrated with the speed of RMAIL@. However, I
8880 stuck with it because I wanted the GNU Emacs interface. I am very
8881 familiar and comfortable with the Emacs interface (with just a few
8882 modifications of my own) and dislike having to use applications with
8883 embedded editors; they never live up to Emacs.
8884
8885 MH is the mail reader of choice at BBN, so I converted to it. Since I
8886 didn't want to give up using an Emacs interface, I started using MH-E.
8887 As is my wont, I started hacking on it almost immediately. I first
8888 used version 3.4m. One of the first features I added was to treat the
8889 folder buffer as a file-visiting buffer: you could lock it, save it,
8890 and be warned of unsaved changes when killing it. I also worked to
8891 bring its functionality a little closer to RMAIL@. Jim Larus was very
8892 cooperative about merging in my changes, and my efforts first appeared
8893 in version 3.6, distributed with Emacs 18.52 in 1988. Next I decided
8894 MH-E was too slow and optimized it a lot. Version, 3.7, distributed
8895 with Emacs 18.56 in 1990, was noticeably faster.
8896
8897 When I moved to the X Consortium I became the first person there to
8898 not use xmh. (There is now one other engineer there using MH-E.) About
8899 this point I took over maintenance of MH-E from Jim and was finally
8900 able to add some features Jim hadn't accepted, such as the backward
8901 searching undo. My first release was 3.8 (Emacs 18.58) in 1992.
8902
8903 Now, in 1994, we see a flurry of releases, with both 4.0 and 5.0.
8904 Version 4.0 added many new features, including background folder
8905 collection and support for composing @sc{mime} messages. (Reading
8906 @sc{mime} messages remains to be done, alas.) While writing this book,
8907 Bill Wohler gave MH-E its closest examination ever, uncovering bugs
8908 and inconsistencies that required a new major version to fix, and so
8909 version 5 was released.
8910
8911 Stephen Gildea, June 1994
8912
8913 @node From Bill Wohler, , From Stephen Gildea, History
8914 @appendixsec From Bill Wohler
8915
8916 @cindex Wohler, Bill
8917 @cindex Bill Wohler
8918
8919 The preface originally included the following text which I use to
8920 begin my story:
8921
8922 @quotation
8923 But it's important to note a brief history of MH-E.
8924
8925 @w{Version 3} was prevalent through the @w{Emacs 18} and early
8926 @w{Emacs 19} years. Then @w{Version 4} came out (@w{Emacs 19.23}),
8927 which introduced several new and changed commands. Next, @w{Version
8928 5.0} was released, which fixed some bugs and incompatibilities, and
8929 was incorporated into @w{Emacs 19.29}.
8930 @end quotation
8931
8932 After a long break, Stephen handed the reins over to me in 2000. I
8933 moved the project to a new site called SourceForge and organized a
8934 great team of developers. Our first release in late 2001 was version
8935 6. It appeared around the time of Emacs 21.2 and had menus and tool
8936 bar buttons.
8937
8938 Then, indexed searches, improved MIME handling, a speedbar, multiple
8939 identities, alias completion, an index view of unseen messages, spam
8940 software support, Face and X-Image-URL header field support, Fcc
8941 completion, arbitrary range handling, and draft form editing were
8942 introduced in the version 7 series around the time of Emacs 21.4
8943 (2004). Still, Emacs itself contained version 5 of MH-E released back
8944 in 1994.
8945
8946 Version 8 development was mostly driven by the rewrite of the manual.
8947 It also brought GNU mailutils MH support, S/MIME support, picon
8948 support, and an improved interface for hiding header fields. The CVS
8949 repository was migrated from SourceForge to Savannah (only for those
8950 files that were already part of Emacs) and the software was completely
8951 reorganized to push back two decades of entropy. Version 8 appeared in
8952 Emacs 22.1 in 2006.
8953
8954 Development was then quiet for a couple of years. Emacs 23.1, which is
8955 due out in 2009, will contain version 8.1. This version includes a few
8956 new features and several bug fixes.
8957
8958 Bill Wohler, August 2008
8959
8960 @node GFDL, GPL, History, Top
8961 @appendix GNU Free Documentation License
8962 @include doclicense.texi
8963
8964 @node GPL, Key Index, GFDL, Top
8965 @appendix GNU General Public License
8966 @include gpl.texi
8967
8968 @node Key Index, Command Index, GPL, Top
8969 @unnumbered Key (Character) Index
8970 @printindex ky
8971
8972 @node Command Index, Option Index, Key Index, Top
8973 @unnumbered Command Index
8974 @printindex fn
8975
8976 @node Option Index, Concept Index, Command Index, Top
8977 @unnumbered Option (Variable) Index
8978 @printindex vr
8979
8980 @node Concept Index, , Option Index, Top
8981 @unnumbered Concept Index
8982 @printindex cp
8983
8984 @bye
8985
8986 @c Ispell Helpers
8987 @c
8988 @c The following are words that ispell should ignore that would not
8989 @c normally be in a dictionary (global or personal). Be careful not to
8990 @c include words here that could potentially be typos of other words
8991 @c (such as url, elisp, or MHE).
8992 @c
8993 @c LocalWords: CTRL ESC SPC f's
8994 @c LocalWords: addr Aliasfile alist
8995 @c LocalWords: Baushke Bcc BBN Beranek bogofilter bogofilter's
8996 @c LocalWords: cmd CMU contrib cron
8997 @c LocalWords: DesBrisay Dcc devel dir dired docstring filll forw
8998 @c LocalWords: GECOS Gildea Gildea's Ginnean GnuCash goto gnuserv htm
8999 @c LocalWords: ImageMagick inbox ispell keychain
9000 @c LocalWords: Larus licensor LocalWords lookup lpr
9001 @c LocalWords: makeinfo mairix mbox mh mhbuild mhl mhpath mlisp
9002 @c LocalWords: MML msg multipart
9003 @c LocalWords: Namazu NIS nenscript nnml num
9004 @c LocalWords: packmbox passphrase pathname prev procmail prog repl
9005 @c LocalWords: slocal sortm SpamAssassin spammers SpamProbe SpamProbe's
9006 @c LocalWords: sublicense supercite speedbar
9007 @c LocalWords: Tennex texi texinfo Thelen thelenm
9008 @c LocalWords: UCI undeleted whatnow wohler xmh ypcat
9009 @c
9010 @c See http://www.oreilly.com/oreilly/author/stylesheet.html.
9011 @c See http://en.wikipedia.org/.
9012 @c
9013 @c Note the lowercase mh which is needed to avoid hits in the
9014 @c functions and variables. Occasionally, check for accidental
9015 @c inclusion of mh in text by uncommenting the following and executing
9016 @c it with C-x C-e. You want to see "Search failed"
9017 @c (let ((case-fold-search nil))
9018 @c (goto-char (point-min))
9019 @c (search-forward-regexp "^mh\\( \\|$\\)"))
9020 @c
9021 @c An extremely useful setting for texinfo-mode-hook is:
9022 @c (add-to-list
9023 @c 'ispell-skip-region-alist
9024 @c (list
9025 @c (concat "\\(@\\(small\\)?\\(example\\|lisp\\)"
9026 @c "\\(@\\([irw]\\|code\\|var\\){[^}]+}\\|"
9027 @c "@[@{}.]\\|"
9028 @c "[^@]\\|"
9029 @c "@\\(end \\)?group\\|"
9030 @c "@\\(end \\)?cartouche\\)+"
9031 @c "@end \\(small\\)?\\(example\\|lisp\\)\\|"
9032 @c "@\\(code\\|command\\|file\\|kbd\\|sc\\){[^}]+}\\|"
9033 @c "^@end [a-z]+$\\|"
9034 @c "^@\\([fv]\\|print\\)index .*$\\|"
9035 @c "@uref{[^,]+,\\|"
9036 @c "@[a-z]+\\|"
9037 @c "/[a-z.]+[/}]\\)")))))
9038 @c
9039 @c Cross References
9040 @c
9041 @c See existing cross-references to the Emacs manual and the Emacs
9042 @c Lisp manual (search for ``GNU Emacs Manual'' and ``GNU
9043 @c Emacs Lisp Reference Manual'' respectively).
9044
9045 @c @ftable Sorting
9046 @c
9047 @c As per index (sort of): Punctuation, keyboard characters (such as
9048 @c RET and BS) upper and lowercase mixed (lower comes before
9049 @c uppercase), control characters go with uppercase C, meta characters
9050 @c go with uppercase M.
9051 @c In some cases, the sort isn't strictly ASCII.
9052 @c For example, SPC (mh-page-msg) reads better before BS
9053 @c (mh-previous-page) and . (mh-show) is better before ,
9054 @c (mh-header-display).
9055
9056 @c @vtable Sorting
9057 @c
9058 @c Alphabetical, pull hooks into their own table.
9059
9060 @c Local Variables:
9061 @c sentence-end-double-space: nil
9062 @c End:
9063
9064 @ignore
9065 arch-tag: b778477d-1a10-4a99-84de-f877a2ea6bef
9066 @end ignore