]> code.delx.au - gnu-emacs/blob - doc/misc/mh-e.texi
(Preface): Add Gnus to requirements.
[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.0.3+CVS
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 2007-09-25
16 @set UPDATE-MONTH September, 2007
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 Free
28 Software Foundation, Inc.
29
30 @quotation
31 The MH-E manual is free documentation; you can redistribute it and/or
32 modify it under the terms of either:
33
34 @enumerate a
35 @item
36 the GNU Free Documentation License, Version 1.2 or any later version
37 published by the Free Software Foundation; with no Invariant Sections,
38 no Front-Cover Texts, and no Back-Cover Texts.
39
40 @item
41 the GNU General Public License as published by the Free Software
42 Foundation; either version 3, or (at your option) any later version.
43 @end enumerate
44
45 The MH-E manual is distributed in the hope that it will be useful, but
46 WITHOUT ANY WARRANTY; without even the implied warranty of
47 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
48 General Public License or GNU Free Documentation License for more
49 details.
50
51 The GNU General Public License and the GNU Free Documentation License
52 appear as appendices to this document. You may also request copies by
53 writing to the Free Software Foundation, Inc., 51 Franklin Street,
54 Fifth Floor, Boston, MA 02110-1301, USA.
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 @setchapternewpage odd
66 @titlepage
67 @title The MH-E Manual
68 @subtitle Version @value{VERSION}@value{EDITION}
69 @subtitle @value{UPDATE-MONTH}
70 @author Bill Wohler
71
72 @c Copyright Page
73 @page
74 @vskip 0pt plus 1filll
75 @insertcopying
76 @end titlepage
77
78 @ifnottex
79 @html
80 <!--
81 @end html
82 @node Top, Preface, (dir), (dir)
83 @top The MH-E Manual
84 @html
85 -->
86 @end html
87 @insertcopying
88 @end ifnottex
89
90 @c Table of Contents
91 @contents
92
93 @html
94 <!--
95 @end html
96
97 @menu
98 * Preface:: Preface
99 * Conventions:: GNU Emacs Terms and Conventions
100 * Getting Started:: Getting Started
101 * Tour Through MH-E:: Tour Through MH-E
102 * Using This Manual:: Using This Manual
103 * Incorporating Mail:: Incorporating Mail
104 * Reading Mail:: Reading Mail
105 * Folders:: Organizing Your Mail with Folders
106 * Sending Mail:: Sending Mail
107 * Editing Drafts:: Editing a Draft
108 * Aliases:: Aliases
109 * Identities:: Identities
110 * Speedbar:: The Speedbar
111 * Menu Bar:: The Menu Bar
112 * Tool Bar:: The Tool Bar
113 * Searching:: Searching Through Messages
114 * Threading:: Viewing Message Threads
115 * Limits:: Limiting Display
116 * Sequences:: Using Sequences
117 * Junk:: Dealing With Junk Mail
118 * Miscellaneous:: Miscellaneous Commands, Variables, and Buffers
119 * Scan Line Formats:: Scan Line Formats
120 * Procmail:: Reading Mailing Lists Effectively
121 * Odds and Ends:: Odds and Ends
122 * History:: History of MH-E
123 * GFDL:: GNU Free Documentation License
124 * GPL:: GNU Public License
125 * Key Index:: Key (Character) Index
126 * Command Index:: Command Index
127 * Option Index:: Option (Variable) Index
128 * Concept Index:: Concept Index
129
130 @detailmenu
131 --- The Detailed Node Listing ---
132
133 Tour Through MH-E
134
135 * Sending Mail Tour::
136 * Reading Mail Tour::
137 * Processing Mail Tour::
138 * Leaving MH-E::
139 * More About MH-E::
140
141 Using This Manual
142
143 * Options::
144 * Ranges::
145 * Folder Selection::
146
147 Reading Your Mail
148
149 * Viewing::
150 * Viewing Attachments::
151 * HTML::
152 * Digests::
153 * Reading PGP::
154 * Printing::
155 * Files and Pipes::
156 * Navigating::
157 * Miscellaneous Commands and Options::
158
159 Sending Mail
160
161 * Composing::
162 * Replying::
163 * Forwarding::
164 * Redistributing::
165 * Editing Again::
166
167 Editing a Draft
168
169 * Editing Message::
170 * Inserting Letter::
171 * Inserting Messages::
172 * Signature::
173 * Picture::
174 * Adding Attachments::
175 * Sending PGP::
176 * Checking Recipients::
177 * Sending Message::
178 * Killing Draft::
179
180 Odds and Ends
181
182 * Bug Reports::
183 * Mailing Lists::
184 * MH FAQ and Support::
185 * Getting MH-E::
186
187 History of MH-E
188
189 * From Brian Reid::
190 * From Jim Larus::
191 * From Stephen Gildea::
192 * From Bill Wohler::
193
194 @end detailmenu
195 @end menu
196
197 @html
198 -->
199 @end html
200
201 @node Preface, Conventions, Top, Top
202 @unnumbered Preface
203
204 @cindex Emacs
205 @cindex Unix commands, Emacs
206 @cindex preface
207
208 This manual introduces another interface to the MH mail system that is
209 accessible through the GNU Emacs editor, namely, @emph{MH-E}. MH-E is
210 easy to use. I don't assume that you know GNU Emacs or even MH at this
211 point, since I didn't know either of them when I discovered MH-E.
212 However, MH-E was the tip of the iceberg, and I discovered more and
213 more niceties about GNU Emacs and MH@. Now I'm fully hooked on both of
214 them.
215
216 The MH-E package is distributed with GNU Emacs@footnote{Version
217 @value{VERSION} of MH-E will appear in GNU Emacs 22.1. It is supported
218 in GNU Emacs 21, as well as XEmacs 21 (except for versions
219 21.5.9-21.5.16). It is compatible with MH versions 6.8.4 and higher,
220 all versions of nmh, and GNU mailutils 1.0 and higher.}, so you
221 shouldn't have to do anything special to use it. Gnus is also
222 required; version 5.10 or higher is recommended. This manual covers
223 MH-E version @value{VERSION}. To help you decide which version you
224 have, see @ref{Getting Started}.
225
226 @findex help-with-tutorial
227 @kindex C-h t
228
229 If you don't already use GNU Emacs but want to learn more, you can
230 read an online tutorial by starting GNU Emacs and typing @kbd{C-h t}
231 (@code{help-with-tutorial}). (To learn about this notation, see
232 @ref{Conventions}.) If you want to take the plunge, consult the
233 @iftex
234 @cite{GNU Emacs Manual},
235 @end iftex
236 @ifinfo
237 @ref{top, , GNU Emacs Manual, emacs, GNU Emacs Manual},
238 @end ifinfo
239 @ifhtml
240 @uref{http://www.gnu.org/software/emacs/manual/html_node/,
241 @cite{GNU Emacs Manual}},
242 @end ifhtml
243 from the Free Software Foundation.
244
245 If more information is needed, you can go to the Unix manual pages of
246 the individual MH commands. When the name is not obvious, I'll guide
247 you to a relevant MH manual page that describes the action more fully.
248
249 @cindex @cite{MH & nmh: Email for Users & Programmers}
250 @cindex MH book
251 @cindex info
252 @kindex C-h i
253
254 This manual is available in both Info and online formats. The Info
255 version is distributed with Emacs and can be accessed with the
256 @command{info} command (@samp{info mh-e}) or within Emacs (@kbd{C-h i
257 m mh-e @key{RET}}). The online version is available at
258 @uref{http://mh-e.sourceforge.net/manual/, SourceForge}. Another great
259 online resource is the book @uref{http://www.ics.uci.edu/~mh/book/,
260 @cite{MH & nmh: Email for Users & Programmers}} (also known as
261 @dfn{the MH book}).
262
263 I hope you enjoy this manual! If you have any comments, or suggestions
264 for this document, please let me know.
265
266 @cindex Bill Wohler
267 @cindex Wohler, Bill
268
269 @noindent
270 Bill Wohler <@i{wohler at newt.com}>@*
271 8 February 1995@*
272 24 February 2006
273
274 @node Conventions, Getting Started, Preface, Top
275 @chapter GNU Emacs Terms and Conventions
276
277 @cindex Emacs
278 @cindex Emacs, conventions
279 @cindex Emacs, terms
280 @cindex Unix commands, Emacs
281 @cindex conventions, Emacs
282 @cindex terms, Emacs
283
284 If you're an experienced Emacs user, you can skip the following
285 conventions and definition of terms and go directly to the next
286 section (@pxref{Getting Started}).
287
288 @cindex Emacs commands
289 @cindex MH commands
290 @cindex Unix commands
291 @cindex commands
292 @cindex commands, MH
293 @cindex commands, Unix
294 @cindex commands, shell
295 @cindex functions
296 @cindex shell commands
297
298 In general, @dfn{functions} in this text refer to Emacs Lisp functions
299 that one would call from within Emacs Lisp programs (for example,
300 @code{(mh-inc-folder)}). On the other hand, @dfn{commands} are those
301 things that are run by the user, such as @kbd{i} or @kbd{M-x
302 mh-inc-folder}. Programs outside of Emacs are specifically called MH
303 commands, shell commands, or Unix commands.
304
305 @cindex conventions, key names
306 @cindex key names
307
308 The conventions for key names are as follows:
309
310 @table @kbd
311 @item C-x
312 Hold down the @key{CTRL} (Control) key and press the @kbd{x} key.
313 @c -------------------------
314 @item M-x
315 Hold down the @key{META} or @key{ALT} key and press the @kbd{x} key.
316
317 Since some keyboards don't have a @key{META} key, you can generate
318 @kbd{M-x}, for example, by pressing @key{ESC} (Escape),
319 @emph{releasing it}, and then pressing the @kbd{x} key.
320 @c -------------------------
321 @item @key{RET}
322 Press the @key{RETURN} or @key{ENTER} key. This is normally used to
323 complete a command.
324 @c -------------------------
325 @item @key{SPC}
326 Press the space bar.
327 @c -------------------------
328 @item @key{TAB}
329 Press the @key{TAB} key.
330 @c -------------------------
331 @item @key{DEL}
332 Press the @key{DELETE} key.
333 @c -------------------------
334 @item @key{BS}
335 Press the @key{BACKSPACE} key@footnote{If you are using Version 20 or
336 earlier of Emacs, you will need to use the @key{DEL} key.}.
337 @end table
338
339 @cindex Emacs, prefix argument
340 @cindex prefix argument
341 @kindex C-u
342
343 A @dfn{prefix argument} allows you to pass an argument to any Emacs
344 function. To pass an argument, type @kbd{C-u} before the Emacs command
345 or keystroke. Numeric arguments can be passed as well. For example, to
346 insert five f's, use @kbd{C-u 5 f}. There is a default of four when
347 using @kbd{C-u}, and you can use multiple prefix arguments to provide
348 arguments of powers of four. To continue our example, you could insert
349 four f's with @kbd{C-u f}, 16 f's with @kbd{C-u C-u f}, 64 f's with
350 @kbd{C-u C-u C-u f}, and so on. Numeric and valueless negative
351 arguments can also be inserted with the @key{META} key. Examples
352 include @kbd{M-5} to specify an argument of 5, or @kbd{M--} which
353 specifies a negative argument with no particular value.
354
355 @sp 1
356 @center @strong{NOTE}
357
358 @quotation
359 The prefix @kbd{C-u} or @kbd{M-} is not necessary in MH-E's MH-Folder
360 mode (@pxref{Reading Mail Tour}). In this mode, simply enter the
361 numerical argument before entering the command.
362 @end quotation
363 @sp 1
364
365 @cindex @file{.emacs}
366 @cindex Emacs, variables
367 @cindex files, @file{.emacs}
368 @cindex variables
369 @findex setq
370
371 Emacs uses @dfn{variables} to hold values. These can be changed via
372 calls to the function @code{setq} in @file{~/.emacs}.
373
374 @cindex Emacs, options
375 @cindex options
376 @findex customize-group
377 @findex customize-option
378
379 Variables in MH-E that are normally modified by the user are called
380 @dfn{options} and are modified through the customize functions (such
381 as @kbd{M-x customize-option} or @kbd{M-x customize-group}).
382 @ifnothtml
383 @xref{Easy Customization,,,emacs,The GNU Emacs Manual}, in @cite{The
384 GNU Emacs Manual}.
385 @end ifnothtml
386 @ifhtml
387 See section
388 @uref{http://www.gnu.org/software/emacs/manual/html_node/Easy-Customization.html,
389 Easy Customization} in @cite{The GNU Emacs Manual}.
390 @end ifhtml
391 @xref{Options}.
392
393 @cindex Emacs, faces
394 @cindex faces
395 @cindex highlighting
396 @findex customize-face
397
398 You can specify various styles for displaying text using @dfn{faces}.
399 MH-E provides a set of faces that you can use to personalize the look
400 of your MH-E buffers. Use the command @kbd{M-x customize-face} to do
401 this.
402 @ifnothtml
403 @xref{Face Customization,,,emacs,The GNU Emacs Manual}, in @cite{The
404 GNU Emacs Manual}.
405 @end ifnothtml
406 @ifhtml
407 See section
408 @uref{http://www.gnu.org/software/emacs/manual/html_node/Face-Customization.html,
409 Face Customization} in @cite{The GNU Emacs Manual}.
410 @end ifhtml
411
412 @cindex abnormal hooks
413 @cindex hooks
414 @cindex normal hooks
415 @findex add-hook
416 @findex customize-option
417
418 Commands often offer @dfn{hooks} which enable you to extend or modify
419 the way a command works.
420 @ifnothtml
421 @ref{Hooks, , Hooks, emacs, The GNU Emacs Manual}, in @cite{The GNU
422 Emacs Manual}
423 @end ifnothtml
424 @ifhtml
425 See section
426 @uref{http://www.gnu.org/software/emacs/manual/html_node/Hooks.html,
427 Hooks} in @cite{The GNU Emacs Manual}
428 @end ifhtml
429 for a description about @dfn{normal hooks} and @dfn{abnormal hooks}.
430 MH-E uses normal hooks in nearly all cases, so you can assume that we
431 are talking about normal hooks unless we explicitly mention that a
432 hook is abnormal. We also follow the conventions described in that
433 section: the name of the abnormal hooks end in @code{-hooks} and all
434 the rest of the MH-E hooks end in @code{-hook}. You can add hooks with
435 either @code{customize-option} or @code{add-hook}.
436
437 @cindex Emacs, mark
438 @cindex Emacs, point
439 @cindex Emacs, region
440 @cindex mark
441 @cindex point
442 @cindex region
443 @kindex C-@@
444 @kindex C-@key{SPC}
445
446 There are several other terms that are used in Emacs that you should
447 know. The @dfn{point} is where the cursor currently is. You can save
448 your current place in the file by setting a @dfn{mark}. This operation
449 is useful in several ways. The mark can be later used when defining a
450 @dfn{region}, which is the text between the point and mark. Many
451 commands operate on regions, such as those for deleting text or
452 filling paragraphs. A mark can be set with @kbd{C-@@} (or
453 @kbd{C-@key{SPC}}).
454
455 @cindex completion
456 @cindex Emacs, completion
457 @cindex Emacs, file completion
458 @cindex Emacs, folder completion
459 @cindex Emacs, minibuffer
460 @cindex file completion
461 @cindex folder completion
462 @cindex minibuffer
463 @kindex SPC
464 @kindex TAB
465
466 The @dfn{minibuffer} is the bottom line of the Emacs window, where all
467 prompting and multiple-character input is directed. You can use
468 @dfn{completion} to enter values such as folders. Completion means
469 that Emacs fills in text for you when you type @key{SPC} or @key{TAB}.
470 A second @key{SPC} or @key{TAB} will list all possibilities at that
471 point.
472 @ifnothtml
473 @xref{Completion, , Completion, emacs, The GNU Emacs Manual}.
474 @end ifnothtml
475 @ifhtml
476 See the section
477 @uref{http://www.gnu.org/software/emacs/manual/html_node/Completion.html,
478 Completion} in @cite{The GNU Emacs Manual}.
479 @end ifhtml
480 Note that @key{SPC} cannot be used for completing filenames and
481 folders.
482
483 @findex help-with-tutorial
484 @kindex C-h t
485 @kindex M-x
486
487 The minibuffer is also where you enter Emacs function names after
488 typing @kbd{M-x}. For example, in the preface, I mentioned that you
489 could obtain help with @kbd{C-h t} (@code{help-with-tutorial}). What
490 this means is that you can get a tutorial by typing either @kbd{C-h t}
491 or @kbd{M-x help-with-tutorial}. In the latter case, you are prompted
492 for @samp{help-with-tutorial} in the minibuffer after typing
493 @kbd{M-x}.
494
495 @cindex ~
496
497 The @samp{~} notation in filenames represents your home directory.
498 This notation is used by many shells including @command{bash},
499 @code{tcsh}, and @command{csh}. It is analogous to the environment
500 variable @samp{$HOME}. For example, @file{~/.emacs} can be written
501 @file{$HOME/.emacs} or using the absolute path as in
502 @file{/home/wohler/.emacs} instead.
503
504 @cindex Emacs, interrupting
505 @cindex Emacs, quitting
506 @cindex interrupting
507 @cindex quitting
508
509 @i{In case of trouble:} Emacs can be interrupted at any time with
510 @kbd{C-g}. For example, if you've started a command that requests that
511 you enter something in the minibuffer, but then you change your mind,
512 type @kbd{C-g} and you'll be back where you started. If you want to
513 exit Emacs entirely, use @kbd{C-x C-c}.
514
515 @node Getting Started, Tour Through MH-E, Conventions, Top
516 @chapter Getting Started
517
518 @cindex MH-E, versions
519 @cindex history
520 @cindex versions of MH-E
521
522 Because there are many old versions of MH-E out there, it is important
523 to know which version you have. I'll be talking about @w{Version 8}
524 which is pretty close to @w{Version 6} and @w{Version 7}. It differs
525 from @w{Version 4} and @w{Version 5} and is vastly different from
526 @w{Version 3}. @xref{History}.
527
528 @findex mh-version
529
530 To determine which version of MH-E that you have, enter @kbd{M-x
531 mh-version @key{RET}}. Hopefully it says that you're running
532 @w{Version @value{VERSION}} which is the latest version as of this
533 printing.
534
535 If your version is much older than this, please consider upgrading.
536 You can have your system administrator upgrade the system-wide
537 version, or you can install your own personal version. It's really
538 quite easy. @xref{Getting MH-E}, for instructions for getting and
539 installing MH-E.
540
541 If the @code{mh-version} command displays @samp{No MH variant
542 detected}@footnote{In very old versions of MH-E, you may get the error
543 message, @samp{Cannot find the commands `inc' and `mhl' and the file
544 `components'} if MH-E can't find MH. In this case, you need to update
545 MH-E, and you may need to install MH too. However, newer versions of
546 MH-E are better at finding MH if it is on your system.}, then you need
547 to install MH or tell MH-E where to find MH.
548
549 @cindex Debian
550 @cindex nmh
551 @cindex GNU mailutils
552
553 If you don't have MH on your system already, you must install a
554 variant of MH. The Debian mh-e package does this for you automatically
555 (@pxref{Getting MH-E}). Most people use
556 @uref{http://www.nongnu.org/nmh/, nmh}, but you may be interested in
557 trying out @uref{http://www.gnu.org/software/mailutils/, GNU
558 mailutils}, which supports IMAP. Your GNU/Linux distribution probably
559 has packages for both of these.
560
561 @cindex @command{install-mh}
562 @cindex MH commands, @command{install-mh}
563 @cindex MH book
564
565 If you've never run MH before, you need to run @command{install-mh}
566 from the shell before you continue. This sets up your personal MH
567 environment@footnote{See the section
568 @uref{@value{MH-BOOK-HOME}/../overall/setup.html, Setting Up MH} in the
569 MH book.}. If you don't, you'll be greeted with the error message:
570 @samp{Install MH and run install-mh before running MH-E}. This is all
571 you need to know about MH to use MH-E, but the more you know about MH,
572 the more you can leverage its power. See the
573 @uref{@value{MH-BOOK-HOME}/../, MH book} to learn more about MH.
574
575 @cindex @samp{Path:} MH profile component
576 @cindex MH profile
577 @cindex MH profile component
578 @cindex MH profile component, @samp{Path:}
579
580 Your MH environment includes your @dfn{MH profile} which is found in
581 the file @file{~/.mh_profile}. 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 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 mailutils installed (for example) and
604 @code{mh-variant-in-use} was initialized to nmh but you want to use
605 mailutils, then you can set @code{mh-variant} to @samp{mailutils}.
606
607 @vindex mh-flists-present-flag
608 @vindex mh-lib
609 @vindex mh-lib-progs
610 @vindex mh-progs
611
612 When @code{mh-variant} is changed, MH-E resets @code{mh-progs},
613 @code{mh-lib}, @code{mh-lib-progs}, @code{mh-flists-present-flag}, and
614 @code{mh-variant-in-use} accordingly.
615
616 @cindex @file{.emacs}
617 @cindex files, @file{.emacs}
618
619 @sp 1
620 @center @strong{NOTE}
621
622 @quotation
623 Prior to version 8, it was often necessary to set some of these
624 variables in @file{~/.emacs}; now it is no longer necessary and can
625 actually cause problems.
626 @end quotation
627 @sp 1
628
629 @cindex MH profile component, @samp{Draft-Folder:}
630 @cindex MH profile component, @samp{Path:}
631 @cindex MH profile component, @samp{Previous-Sequence:}
632 @cindex MH profile component, @samp{Unseen-Sequence:}
633 @cindex @samp{Draft-Folder:} MH profile component
634 @cindex @samp{Path:} MH profile component
635 @cindex @samp{Previous-Sequence:} MH profile component
636 @cindex @samp{Unseen-Sequence:} MH profile component
637 @findex mh-find-path
638 @vindex mh-draft-folder
639 @vindex mh-find-path-hook
640 @vindex mh-inbox
641 @vindex mh-previous-seq
642 @vindex mh-unseen-seq
643 @vindex mh-user-path
644
645 In addition to setting variables that point to MH itself, MH-E also
646 sets a handful of variables that point to where you keep your mail.
647 During initialization, the function @code{mh-find-path} sets
648 @code{mh-user-path} from your @samp{Path:} MH profile component (but
649 defaults to @samp{Mail} if one isn't present), @code{mh-draft-folder}
650 from @samp{Draft-Folder:}, @code{mh-unseen-seq} from
651 @samp{Unseen-Sequence:}, @code{mh-previous-seq} from
652 @samp{Previous-Sequence:}, and @code{mh-inbox} from @samp{Inbox:}
653 (defaults to @samp{+inbox}). The hook @code{mh-find-path-hook} is run
654 after these variables have been set. This hook can be used the change
655 the value of these variables if you need to run with different values
656 between MH and MH-E.
657
658 @node Tour Through MH-E, Using This Manual, Getting Started, Top
659 @chapter Tour Through MH-E
660
661 @cindex introduction
662 @cindex tour
663 @cindex tutorial
664
665 This chapter introduces some of the terms you'll need to know and then
666 takes you on a tour of MH-E@footnote{The keys mentioned in these
667 chapters refer to the default key bindings. If you've changed the
668 bindings, refer to the command summaries at the beginning of each
669 chapter for a mapping between default key bindings and function
670 names.}. When you're done, you'll be able to send, read, and file
671 mail, which is all that a lot of people ever do. But if you're the
672 curious or adventurous type, read the rest of the manual to be able to
673 use all the features of MH-E. I suggest you read this chapter first to
674 get the big picture, and then you can read the manual as you wish.
675
676 @menu
677 * Sending Mail Tour::
678 * Reading Mail Tour::
679 * Processing Mail Tour::
680 * Leaving MH-E::
681 * More About MH-E::
682 @end menu
683
684 @node Sending Mail Tour, Reading Mail Tour, Tour Through MH-E, Tour Through MH-E
685 @section Sending Mail
686
687 @cindex MH-Letter mode
688 @cindex mode
689 @cindex modes, MH-Letter
690 @cindex sending mail
691 @findex mh-smail
692 @kindex M-x mh-smail
693
694 Let's start our tour by sending ourselves a message which we can later
695 read and process. Enter @kbd{M-x mh-smail} to invoke the MH-E program
696 to send messages. Your message appears in an Emacs buffer whose
697 mode@footnote{A @dfn{mode} changes Emacs to make it easier to edit a
698 particular type of text.} is MH-Letter.
699
700 Enter your login name in the @samp{To:} header field. Press the
701 @key{TAB} twice to move the cursor past the @samp{Cc:} field, since no
702 carbon copies are to be sent, and on to the @samp{Subject:} field.
703 Enter @kbd{Test} or anything else that comes to mind.
704
705 Press @key{TAB} again to move the cursor to the body of the message.
706 Enter some text, using normal Emacs commands. You should now have
707 something like this@footnote{If you're running Emacs under the X
708 Window System, then you would also see a menu bar and a tool bar. I've
709 left out the menu bar and tool bar in all of the example screens.}:
710
711 @cartouche
712 @smallexample
713
714
715
716
717
718
719 --:-- *scratch* All L1 (Lisp Interaction)-------------------------
720 To: wohler
721 cc:
722 Subject: Test
723 X-Mailer: MH-E 8.0; nmh 1.1; GNU Emacs 22.1
724 --------
725 This is a test message to get the wheels churning...#
726
727
728 --:** @{draft@} All L5 (MH-Letter)----------------------------------
729 Type C-c C-c to send message, C-C ? for help
730 @end smallexample
731 @end cartouche
732 @i{MH-E message composition window}
733
734 Note the line of dashes that separates the header and the body of the
735 message. It is essential that these dashes (or a blank line) are
736 present or the body of your message will be considered to be part of
737 the header.
738
739 @cindex help
740 @findex describe-mode
741 @kindex C-c ?
742 @kindex C-c C-c
743 @kindex C-h m
744
745 There are several commands specific to MH-Letter mode@footnote{You can
746 get quick help for the commands used most often with @kbd{C-c ?} or
747 more complete help with the @kbd{C-h m} (@code{describe-mode})
748 command.}, but at this time we'll only use @kbd{C-c C-c} to send your
749 message. Type @kbd{C-c C-c} now. That's all there is to it!
750
751 @node Reading Mail Tour, Processing Mail Tour, Sending Mail Tour, Tour Through MH-E
752 @section Receiving Mail
753
754 @cindex @command{inc}
755 @cindex @command{scan}
756 @cindex MH commands, @command{inc}
757 @cindex MH commands, @command{scan}
758 @cindex MH-Folder mode
759 @cindex modes, MH-Folder
760 @cindex reading mail
761 @findex mh-rmail
762 @kindex M-x mh-rmail
763
764 To read the mail you've just sent yourself, enter @kbd{M-x mh-rmail}.
765 This incorporates the new mail and puts the output from
766 @command{inc}@footnote{See the section
767 @uref{@value{MH-BOOK-HOME}/reapre.html, Reading Mail: inc show next
768 prev} in the MH book.} (called @dfn{scan lines} after the MH program
769 @command{scan}@footnote{See the section
770 @uref{@value{MH-BOOK-HOME}/faswsprs.html, Find and Specify with scan
771 pick Ranges Sequences} in the MH book.} which prints a one-line
772 summary of each message) into a buffer called @samp{+inbox} whose
773 major mode is MH-Folder.
774
775 @findex mh-rmail
776 @kindex F r
777 @kindex M-x mh-rmail
778
779 @sp 1
780 @center @strong{NOTE}
781
782 @quotation
783
784 The @kbd{M-x mh-rmail} command will show you only new mail, not mail
785 you have already read. If you were to run this tour again, you would
786 use @kbd{F r} to pull all your messages into MH-E.
787 @end quotation
788 @sp 1
789
790 @kindex @key{RET}
791 @kindex n
792 @kindex p
793
794 You should see the scan line for your message, and perhaps others. Use
795 @kbd{n} or @kbd{p} to move the cursor to your test message and type
796 @key{RET} to read your message. You should see something like:
797
798 @cartouche
799 @smallexample
800 3 t08/24 root received fax files on Wed Aug 24 11:00:13 PDT 1
801 # 4+t08/24 To:wohler Test<<This is a test message to get the wheels
802
803 -:%% @{+inbox/select@} 4 msgs (1-4) Bot L4 (MH-Folder Show)---------
804 To: wohler
805 Subject: Test
806 X-Mailer: MH-E 8.0; nmh 1.1; GNU Emacs 22.1
807 Date: Fri, 17 Mar 2006 10:49:11 -0800
808 From: Bill Wohler <wohler@@stop.mail-abuse.org>
809
810 This is a test message to get the wheels churning...
811
812
813
814 --:-- @{show-+inbox@} 4 All L1 (MH-Show)----------------------------
815
816 @end smallexample
817 @end cartouche
818 @i{After incorporating new messages}
819
820 @kindex @key{DEL}
821 @kindex @key{SPC}
822
823 If you typed a long message, you can view subsequent pages with
824 @key{SPC} and previous pages with @key{DEL}.
825
826 @node Processing Mail Tour, Leaving MH-E, Reading Mail Tour, Tour Through MH-E
827 @section Processing Mail
828
829 @cindex processing mail
830 @kindex @key{RET}
831 @kindex r
832
833 The first thing we want to do is reply to the message that we sent
834 ourselves. Ensure that the cursor is still on the same line as your
835 test message and type @kbd{r}. You are prompted in the minibuffer with
836 @samp{Reply to whom:}. Here MH-E is asking whether you'd like to reply
837 to the original sender only, to the sender and primary recipients, or
838 to the sender and all recipients. You can press @key{TAB} to see these
839 choices. If you simply press @key{RET}, you'll reply only to the
840 sender. Press @key{RET} now.
841
842 You'll find yourself in an Emacs buffer similar to that when you were
843 sending the original message, like this:
844
845 @cartouche
846 @smallexample
847 To:
848 cc:
849 Subject: Re: Test
850 In-reply-to: <31054.1142621351@@stop.mail-abuse.org>
851 References: <31054.1142621351@@stop.mail-abuse.org>
852 Comments: In-reply-to Bill Wohler <wohler@@stop.mail-abuse.org>
853 message dated "Fri, 17 Mar 2006 10:49:11 -0800."
854 X-Mailer: MH-E 8.0; nmh 1.1; GNU Emacs 22.1
855 --------
856 #
857
858 --:-- @{draft@} All L10 (MH-Letter)----------------------------------
859 To: wohler
860 Subject: Test
861 X-Mailer: MH-E 8.0; nmh 1.1; GNU Emacs 22.1
862 Date: Fri, 17 Mar 2006 10:49:11 -0800
863 From: Bill Wohler <wohler@@stop.mail-abuse.org>
864
865 This is a test message to get the wheels churning...
866
867 --:-- @{show-+inbox@} 4 All L1 (MH-Show)----------------------------
868 Type C-c C-c to send message, C-c ? for help
869 @end smallexample
870 @end cartouche
871 @i{Composition window during reply}
872
873 @findex backward-char
874 @findex forward-char
875 @findex next-line
876 @findex previous-line
877 @kindex C-b
878 @kindex C-c C-c
879 @kindex C-c C-f C-t
880 @kindex C-f
881 @kindex C-n
882 @kindex C-p
883 @kindex @key{BS}
884
885 By default, MH will not add you to the address list of your replies,
886 so if you find that the @samp{To:} header field is missing, don't
887 worry. In this case, type @kbd{C-c C-f C-t} to create and go to the
888 @samp{To:} field, where you can type your login name again. You can
889 move around with the arrow keys or with @kbd{C-p}
890 (@code{previous-line}), @kbd{C-n} (@code{next-line}), @kbd{C-b}
891 (@code{backward-char}), and @kbd{C-f} (@code{forward-char}) and can
892 delete the previous character with @key{BS}. When you're finished
893 editing your message, send it with @kbd{C-c C-c} as before.
894
895 @cindex @command{refile}
896 @cindex MH commands, @command{refile}
897 @cindex folders
898 @kindex @key{SPC}
899 @kindex o
900
901 You'll often want to save messages that were sent to you in an
902 organized fashion. This is done with @dfn{folders}. You can use
903 folders to keep messages from your friends, or messages related to a
904 particular topic. With your cursor in the MH-Folder buffer and
905 positioned on the message you sent to yourself, type @kbd{o} to output
906 (@command{refile} in MH parlance) that message to a folder. Enter
907 @kbd{test} at the @samp{Destination folder:} prompt and type @kbd{y}
908 (or @key{SPC}) when MH-E asks to create the folder @samp{+test}. Note
909 that a @samp{^} (caret) appears next to the message number, which
910 means that the message has been marked for refiling but has not yet
911 been refiled. We'll talk about how the refile is actually carried out
912 in a moment.
913
914 @cindex MH-Folder mode
915 @cindex modes, MH-Folder
916 @kindex d
917 @kindex i
918 @kindex @key{RET}
919 @kindex n
920 @kindex p
921 @kindex x
922
923 Your previous reply is now waiting in the system mailbox. You
924 incorporate this mail into your MH-Folder buffer named @samp{+inbox}
925 with the @kbd{i} command. Do this now. After the mail is incorporated,
926 use @kbd{n} or @kbd{p} to move the cursor to the new message, and read
927 it with @key{RET}. Let's delete this message by typing @kbd{d}. Note
928 that a @samp{D} appears next to the message number. This means that
929 the message is marked for deletion but is not yet deleted. To perform
930 the deletion (and the refile we did previously), use the @kbd{x}
931 command.
932
933 @findex mh-smail
934 @kindex m
935 @kindex M-x mh-smail
936
937 If you want to send another message you can use @kbd{m} instead of
938 @kbd{M-x mh-smail}. So go ahead, send some mail to your friends!
939
940 @cindex help
941 @cindex prefix characters
942 @findex describe-mode
943 @kindex ?
944 @kindex C-h m
945 @kindex F ?
946
947 You can get a quick reminder about these commands by typing @kbd{?}.
948 This lists several @dfn{prefix characters}. To list the commands
949 available via the prefix characters, type the prefix character
950 followed by a @kbd{?}, for example, @kbd{F ?}. More complete help is
951 available with the @kbd{C-h m} (@code{describe-mode}) command.
952
953 @node Leaving MH-E, More About MH-E, Processing Mail Tour, Tour Through MH-E
954 @section Leaving MH-E
955
956 @cindex Emacs, quitting
957 @cindex quitting
958 @kindex C-x C-c
959 @kindex x
960
961 You may now wish to exit @command{emacs} entirely. Use @kbd{C-x C-c}
962 to exit @command{emacs}. If you exited without running @kbd{x} in the
963 @samp{+inbox} buffer, Emacs will offer to save it for you. Type
964 @kbd{y} or @key{SPC} to save @samp{+inbox} changes, which means to
965 perform any refiles and deletes that you did there.
966
967 @findex mh-rmail
968 @kindex C-x b
969 @kindex C-x k
970 @kindex M-x mh-rmail
971 @kindex q
972
973 If you don't want to leave Emacs, you can type @kbd{q} to bury (hide)
974 the MH-E folder or delete it entirely with @kbd{C-x k}. You can then
975 later recall it with @kbd{C-x b} or @kbd{M-x mh-rmail}.
976
977 @cindex @command{packf}
978 @cindex MH commands, @command{packf}
979 @cindex exporting folders
980 @cindex folders, exporting
981 @cindex mbox-style folder
982
983 On the other hand, if you no longer want to use MH and MH-E, you can
984 take your mail with you. You can copy all of your mail into a single
985 file, mbox-style, by using the MH command @command{packf}. For
986 example, to create a file called @file{msgbox} with the messages in
987 your @samp{+inbox} folder, use @samp{packf +inbox}. The
988 @command{packf} command will append the messages to the file if it
989 already exists, so you can use @samp{folders -recurse -fast} in a
990 script to copy all of your messages into a single file, or using the
991 @samp{-file} argument, a file for each folder.
992
993 @node More About MH-E, , Leaving MH-E, Tour Through MH-E
994 @section More About MH-E
995
996 These are the basic commands to get you going, but there are plenty
997 more. If you think that MH-E is for you, read the rest of the manual
998 to find out how you can:
999
1000 @itemize @bullet
1001 @item
1002 Print your messages (@pxref{Printing}).
1003 @c -------------------------
1004 @item
1005 Edit messages and include your signature (@pxref{Editing Drafts}).
1006 @c -------------------------
1007 @item
1008 Forward messages (@pxref{Forwarding}).
1009 @c -------------------------
1010 @item
1011 Read digests (@pxref{Digests}).
1012 @c -------------------------
1013 @item
1014 Edit bounced messages (@pxref{Editing Again}).
1015 @c -------------------------
1016 @item
1017 Send multimedia messages (@pxref{Adding Attachments}).
1018 @c -------------------------
1019 @item
1020 Read HTML messages (@pxref{HTML}).
1021 @c -------------------------
1022 @item
1023 Use aliases and identities (see @ref{Aliases}, @pxref{Identities}).
1024 @c -------------------------
1025 @item
1026 Create different views of your mail (see @ref{Threading}, @pxref{Limits}).
1027 @c -------------------------
1028 @item
1029 Deal with junk mail (@pxref{Junk}).
1030 @c -------------------------
1031 @item
1032 Handle signed and encrypted messages (see @ref{Reading PGP},
1033 @pxref{Sending PGP}).
1034 @c -------------------------
1035 @item
1036 Process mail that was sent with @command{shar} or @command{uuencode}
1037 (@pxref{Files and Pipes}).
1038 @c -------------------------
1039 @item
1040 Use sequences conveniently (@pxref{Sequences}).
1041 @c -------------------------
1042 @item
1043 Use the speedbar, tool bar, and menu bar (see @ref{Speedbar}, see @ref{Tool
1044 Bar}, @pxref{Menu Bar}).
1045 @c -------------------------
1046 @item
1047 Show header fields in different fonts (@pxref{Reading Mail}).
1048 @c -------------------------
1049 @item
1050 Find previously refiled messages (@pxref{Searching}).
1051 @c -------------------------
1052 @item
1053 Place messages in a file (@pxref{Files and Pipes}).
1054 @end itemize
1055
1056 Remember that you can also use MH commands when you're not running
1057 MH-E (and when you are!).
1058
1059 @node Using This Manual, Incorporating Mail, Tour Through MH-E, Top
1060 @chapter Using This Manual
1061
1062 This chapter begins the meat of the manual which goes into more detail
1063 about every MH-E command and option.
1064
1065 @cindex Emacs, info
1066 @cindex Emacs, online help
1067 @cindex info
1068 @cindex online help
1069 @findex describe-mode
1070 @findex mh-help
1071 @kindex ?
1072 @kindex C-c ?
1073 @kindex C-h C-h
1074 @kindex C-h C-k i
1075 @kindex C-h i
1076 @kindex C-h m
1077
1078 There are many commands, but don't get intimidated. There are command
1079 summaries at the beginning of each chapter. In case you have or would
1080 like to rebind the keys, the command summaries also list the
1081 associated Emacs Lisp function. Furthermore, even if you're stranded
1082 on a desert island with a laptop and are without your manuals, you can
1083 get a summary of all these commands with GNU Emacs online help: use
1084 @kbd{C-h m} (@code{describe-mode}) for a brief summary of commands,
1085 @kbd{?} (@code{mh-help}) for an even briefer summary@footnote{This
1086 help appears in a buffer called @samp{*MH-E Help*}
1087 (@pxref{Miscellaneous}).} (@kbd{C-c ?} in MH-Letter mode), or @kbd{C-h
1088 i} to read this manual via Info. The online help is quite good; try
1089 running @kbd{C-h C-h}. This brings up a list of available help topics,
1090 one of which displays the documentation for a given key (like @kbd{C-h
1091 k C-n}). Another useful help feature is to view the manual section
1092 that describes a given key (such as @kbd{C-h K i}). In addition,
1093 review @ref{Conventions}, if any of the GNU Emacs conventions are
1094 strange to you.
1095
1096 In addition to all of the commands, it is also possible to reconfigure
1097 MH-E to fit the needs of even the most demanding user. The following
1098 chapters also describe all of the options, show the defaults, and make
1099 recommendations for customization.
1100
1101 However, when customizing your mail environment, first try to change
1102 what you want in MH, and only change MH-E if changing MH is not
1103 possible. That way you will get the same behavior inside and outside
1104 GNU Emacs. Note that MH-E does not provide hooks for customizations
1105 that can be done in MH; this omission is intentional.
1106
1107 @cindex Emacs Lisp Manual
1108 @cindex Emacs, Emacs Lisp Manual
1109 @cindex Emacs, info
1110 @cindex Emacs, online help
1111 @cindex info
1112 @cindex online help
1113
1114 I hope I've included enough examples here to get you well on your way.
1115 If you want to explore Emacs Lisp further, a programming manual does
1116 exist,
1117 @c Yes, some of the stuff in the following sections is redundant, but
1118 @c TeX barfs if the @ifs are inside the @footnote.
1119 @iftex
1120 @footnote{The @cite{GNU Emacs Lisp Reference Manual} may be available
1121 online in the Info system by typing @kbd{C-h i m Emacs Lisp
1122 @key{RET}}. It is also available online at @*
1123 @uref{http://www.gnu.org/software/emacs/elisp-manual/html_node/}. You
1124 can also order a printed manual, which has the desirable side-effect
1125 of helping to support the Free Software Foundation which made all this
1126 great software available. You can find an order form by running
1127 @kbd{C-h C-d}, or you can request an order form from @i{gnu at
1128 gnu.org}.}
1129 @end iftex
1130 @ifinfo
1131 @footnote{@xref{Top, The GNU Emacs Lisp Reference Manual, , elisp, GNU
1132 Emacs Lisp Reference Manual}, which may be available online in the
1133 Info system. It is also available online at
1134 @uref{http://www.gnu.org/software/emacs/elisp-manual/html_node/}. You
1135 can also order a printed manual, which has the desirable side-effect
1136 of helping to support the Free Software Foundation which made all this
1137 great software available. You can find an order form by running
1138 @kbd{C-h C-d}, or you can request an order form from @i{gnu at
1139 gnu.org}.}
1140 @end ifinfo
1141 @ifhtml
1142 @footnote{The
1143 @uref{http://www.gnu.org/software/emacs/elisp-manual/html_node/,
1144 The GNU Emacs Lisp Reference Manual} may also be available online in
1145 the Info system by typing @kbd{C-h i m Emacs Lisp @key{RET}}. You can
1146 also order a printed manual, which has the desirable side-effect of
1147 helping to support the Free Software Foundation which made all this
1148 great software available. You can find an order form by running
1149 @kbd{C-h C-d}, or you can request an order form from @i{gnu at
1150 gnu.org}.}
1151 @end ifhtml
1152 and you can look at the code itself for examples. Look in the Emacs
1153 Lisp directory on your system (such as
1154 @file{/usr/local/lib/emacs/lisp/mh-e}) and find all the @file{mh-*.el}
1155 files there. When calling MH-E and other Emacs Lisp functions directly
1156 from Emacs Lisp code, you'll need to know the correct arguments. Use
1157 the online help for this. For example, try @kbd{C-h f
1158 mh-execute-commands @key{RET}}. If you write your own functions,
1159 please do not prefix your symbols (variables and functions) with
1160 @samp{mh-}. This prefix is reserved for the MH-E package. To avoid
1161 conflicts with existing MH-E symbols, use a prefix like @samp{my-} or
1162 your initials. (Unless, of course, your initials happen to be @emph{mh}!)
1163
1164 @menu
1165 * Options::
1166 * Ranges::
1167 * Folder Selection::
1168 @end menu
1169
1170 @node Options, Ranges, Using This Manual, Using This Manual
1171 @section Options
1172
1173 @cindex Emacs, customizing
1174 @cindex Emacs, setting options
1175 @cindex customizing MH-E
1176 @cindex setting options
1177 @findex customize-option
1178 @vindex mh-lpr-command-format, example
1179
1180 Many string or integer options are easy to modify using @kbd{M-x
1181 customize-option}. For example, to modify the option that controls
1182 printing, you would run @kbd{M-x customize-option @key{RET}
1183 mh-lpr-command-format @key{RET}}. In the buffer that appears, modify
1184 the string to the right of the variable. For example, you may change
1185 the @command{lpr} command with @samp{nenscript -G -r -2 -i'%s'}. Then
1186 use the @samp{State} combo box and select @samp{Save for Future
1187 Sessions}. To read more about @code{mh-lpr-command-format}, see
1188 @ref{Printing}.
1189
1190 @cindex nil
1191 @cindex off, option
1192 @cindex on, option
1193 @cindex option, turning on and off
1194 @cindex t
1195 @findex customize-option
1196 @vindex mh-bury-show-buffer-flag, example
1197
1198 Options can also hold boolean values. In Emacs Lisp, the boolean
1199 values are @code{nil}, which means false, and @code{t}, which means
1200 true. The @code{customize-option} function makes it easy to change
1201 boolean values; simply click on the toggle button in the customize
1202 buffer to switch between @samp{on} (@code{t}) and @samp{off}
1203 (@code{nil}). For example, try setting @code{mh-bury-show-buffer-flag}
1204 to @samp{off} to keep the MH-Show buffer at the top of the buffer
1205 stack. Use the @samp{State} combo box and choose @samp{Set for Current
1206 Session} to see how the option affects the show buffer. Then choose
1207 the @samp{Erase Customization} menu item to reset the option to the
1208 default, which places the MH-Show buffer at the bottom of the buffer
1209 stack.
1210
1211 @vindex mh-mhl-format-file, example
1212
1213 The text usually says to turn on an option by setting it to a
1214 @emph{non-@code{nil}} value, because sometimes values other than
1215 @samp{on} are meaningful. An example of this is the variable
1216 @code{mh-mhl-format-file} (@pxref{Viewing}). Other options, such as
1217 hooks, involve a little more Emacs Lisp programming expertise.
1218
1219 @cindex customization group, @samp{mh}
1220 @cindex @samp{mh} customization group
1221 @findex customize-group
1222 @findex mh-customize
1223
1224 You can browse all of the MH-E options with the @code{customize-group}
1225 function. Try entering @kbd{M-x customize-group @key{RET} mh
1226 @key{RET}} to view the top-level options as well as buttons for all of
1227 the MH-E customization groups. Another way to view the MH-E
1228 customization group is to use @kbd{M-x mh-customize @key{RET}}.
1229
1230 @node Ranges, Folder Selection, Options, Using This Manual
1231 @section Ranges
1232
1233 @c Sync with mh-folder-mode docstring.
1234
1235 @cindex message abbreviations
1236 @cindex message ranges
1237 @cindex ranges
1238
1239 Many commands that operate on individual messages, such as
1240 @code{mh-forward} or @code{mh-refile-msg} take a @code{RANGE}
1241 argument. This argument can be used in several ways.
1242
1243 @kindex C-u, with ranges
1244
1245 If you provide the prefix argument @kbd{C-u} to these commands, then
1246 you will be prompted for the message range. This can be any valid MH
1247 range which can include messages, sequences (@pxref{Sequences}), and
1248 the abbreviations (described in the @command{mh}(1) man page):
1249
1250 @table @samp
1251 @item <num1>-<num2>
1252 Indicates all messages in the range <num1> to <num2>, inclusive. The
1253 range must be nonempty.
1254 @c -------------------------
1255 @item <num>:N
1256 @itemx <num>:+N
1257 @itemx <num>:-N
1258 Up to N messages beginning with (or ending with) message num. Num may
1259 be any of the predefined symbols: first, prev, cur, next or last.
1260 @c -------------------------
1261 @item first:N
1262 @itemx prev:N
1263 @itemx next:N
1264 @itemx last:N
1265 The first, previous, next or last messages, if they exist.
1266 @c -------------------------
1267 @item all
1268 All of the messages.
1269 @end table
1270
1271 For example, a range that shows all of these things is @samp{1 2 3
1272 5-10 last:5 unseen}.
1273
1274 @vindex transient-mark-mode
1275
1276 If the option @code{transient-mark-mode} is turned on and you set a
1277 region in the MH-Folder buffer, then the MH-E command will perform the
1278 operation on all messages in that region.
1279
1280 @cindex @samp{mh-range} customization group
1281 @cindex customization group, @samp{mh-range}
1282
1283 The @samp{mh-range} customization group contains a single option which
1284 affects how ranges are interpreted.
1285
1286 @vtable @code
1287 @item mh-interpret-number-as-range-flag
1288 On means interpret a number as a range (default: @samp{on}).
1289 @end vtable
1290
1291 @vindex mh-interpret-number-as-range-flag
1292
1293 Since one of the most frequent ranges used is @samp{last:N}, MH-E will
1294 interpret input such as @samp{200} as @samp{last:200} if the
1295 @code{mh-interpret-number-as-range-flag} option is on (which is the
1296 default). If you need to scan just the message 200, then use the range
1297 @samp{200:1} or @samp{200-200}.
1298
1299 @node Folder Selection, , Ranges, Using This Manual
1300 @section Folder Selection
1301
1302 @cindex completion, folders
1303 @cindex folders, completion
1304 @cindex folders, selecting
1305
1306 When you choose a folder in MH-E via a command such as @kbd{o}
1307 (@code{mh-refile-msg}), completion is used to enter the folder
1308 @ifnothtml
1309 (@pxref{Completion, , , emacs, The GNU Emacs Manual}).
1310 @end ifnothtml
1311 @ifhtml
1312 (see the section
1313 @uref{http://www.gnu.org/software/emacs/manual/html_node/Completion.html,
1314 Completion} in @cite{The GNU Emacs Manual}).
1315 @end ifhtml
1316 In addition, MH-E has several ways of choosing a suitable default so
1317 that the folder can often be selected with a single @key{RET} key.
1318
1319 @cindex customization group, @samp{mh-folder-selection}
1320 @cindex @samp{mh-folder-selection} customization group
1321
1322 The @samp{mh-folder-selection} customization group contains some
1323 options which are used to help with this.
1324
1325 @vtable @code
1326 @item mh-default-folder-for-message-function
1327 Function to select a default folder for refiling or @samp{Fcc:}
1328 (default: @code{nil}).
1329 @c -------------------------
1330 @item mh-default-folder-list
1331 List of addresses and folders (default: @code{nil}).
1332 @c -------------------------
1333 @item mh-default-folder-must-exist-flag
1334 On means guessed folder name must exist to be used (default:
1335 @samp{on}).
1336 @c -------------------------
1337 @item mh-default-folder-prefix
1338 Prefix used for folder names generated from aliases (default: @code{""}).
1339 @end vtable
1340
1341 @vindex mh-default-folder-for-message-function
1342
1343 You can set the option @code{mh-default-folder-for-message-function}
1344 to a function that provides a default folder for the message to be
1345 refiled. When this function is called, the current buffer contains the
1346 message being refiled and point is at the start of the message. This
1347 function should return the default folder as a string with a leading
1348 @samp{+} sign. It can also return @code{nil} so that the last folder
1349 name is used as the default, or an empty string to suppress the
1350 default entirely.
1351
1352 Otherwise, the name of the destination folder is derived from the
1353 sender as follows:
1354
1355 @enumerate
1356 @vindex mh-default-folder-list
1357 @item
1358 The folder name associated with the first address found in the list
1359 @code{mh-default-folder-list} is used. Each element in this list
1360 contains a @samp{Check Recipient} item. If this item is turned on,
1361 then the address is checked against the recipient instead of the
1362 sender. This is useful for mailing lists.
1363 @c -------------------------
1364 @vindex mh-default-folder-prefix
1365 @item
1366 An alias prefixed by @code{mh-default-folder-prefix} corresponding to
1367 the address is used. The prefix is used to prevent clutter in your
1368 mail directory. @xref{Aliases}.
1369 @end enumerate
1370
1371 @vindex mh-default-folder-must-exist-flag
1372
1373 If the derived folder does not exist, and
1374 @code{mh-default-folder-must-exist-flag} is @code{t}, then the last
1375 folder name used is suggested. This is useful if you get mail from
1376 various people for whom you have an alias, but file them all in the
1377 same project folder.
1378
1379 @node Incorporating Mail, Reading Mail, Using This Manual, Top
1380 @chapter Incorporating Your Mail
1381
1382 @cindex @samp{Folder} menu
1383 @cindex incorporating
1384 @cindex menu, @samp{Folder}
1385
1386 This chapter talks about getting mail from your system mailbox into
1387 your MH @samp{+inbox} folder. The following command accomplishes that
1388 and is found in the @samp{Folder} menu.
1389
1390 @table @kbd
1391 @cindex @samp{Folder > Incorporate New Mail} menu item
1392 @cindex menu item, @samp{Folder > Incorporate New Mail}
1393 @findex mh-inc-folder
1394 @kindex i
1395 @item i
1396 Incorporate new mail into a folder (@code{mh-inc-folder}).
1397 @end table
1398
1399 @cindex @samp{mh-inc} customization group
1400 @cindex customization group, @samp{mh-inc}
1401
1402 The following options in the @samp{mh-inc} customization group are
1403 used.
1404
1405 @vtable @code
1406 @item mh-inc-prog
1407 Program to incorporate mail (default: @code{"inc"}).
1408 @c -------------------------
1409 @item mh-inc-spool-list
1410 Alternate spool files (default: @code{nil}).
1411 @end vtable
1412
1413 The following hook is available.
1414
1415 @vtable @code
1416 @findex mh-inc-folder
1417 @item mh-inc-folder-hook
1418 Hook run by @code{mh-inc-folder} after incorporating mail into a
1419 folder (default: @code{nil}).
1420 @end vtable
1421
1422 @cindex @samp{+inbox}
1423 @findex mh-inc-folder
1424 @kindex i
1425
1426 If at any time you receive new mail, incorporate the new mail into
1427 your @samp{+inbox} buffer with @kbd{i} (@code{mh-inc-folder}). Note
1428 that @kbd{i} will display the @samp{+inbox} buffer, even if there
1429 isn't any new mail. You can incorporate mail from any file into the
1430 current folder by specifying a prefix argument; you'll be prompted for
1431 the name of the file to use as well as the destination folder (for
1432 example, @kbd{C-u i ~/mbox @key{RET} +tmp @key{RET}}).
1433
1434 @cindex @file{.emacs}
1435 @cindex Emacs, notification of new mail
1436 @cindex files, @file{.emacs}
1437 @cindex new mail
1438 @cindex notification of new mail
1439
1440 Emacs can notify you when you have new mail by displaying @samp{Mail}
1441 in the mode line. To enable this behavior, and to have a clock in the
1442 mode line as well, add the following to @file{~/.emacs}:
1443
1444 @findex display-time
1445
1446 @smalllisp
1447 (display-time)
1448 @end smalllisp
1449
1450 @cindex @command{inc}
1451 @cindex incorporating
1452 @cindex MH commands, @command{inc}
1453 @vindex mh-inc-prog
1454 @vindex mh-progs
1455
1456 The name of the program that incorporates new mail is stored in
1457 @code{mh-inc-prog}; it is @code{"inc"} by default. This program
1458 generates a one-line summary for each of the new messages. Unless it
1459 is an absolute pathname, the file is assumed to be in the
1460 @code{mh-progs} directory (@pxref{Getting Started}). You may also link
1461 a file to @command{inc} that uses a different format (see
1462 @samp{mh-profile}(5), and sections
1463 @uref{@value{MH-BOOK-HOME}/reapre.html, Reading Mail: inc show next
1464 prev} and @uref{@value{MH-BOOK-HOME}/mhstr.html, MH Format Strings} in
1465 the MH book). You'll then need to modify several variables
1466 appropriately (@pxref{Scan Line Formats}).
1467
1468 @vindex mh-inc-spool-list
1469
1470 You can use the @code{mh-inc-spool-list} variable to direct MH-E to
1471 retrieve mail from arbitrary spool files other than your system
1472 mailbox, file it in folders other than your @samp{+inbox}, and assign
1473 key bindings to incorporate this mail.
1474
1475 @cindex @command{procmail}
1476 @cindex @file{.procmailrc}
1477 @cindex Unix commands, @command{procmail}
1478 @cindex files, @file{.procmailrc}
1479
1480 Suppose you are subscribed to the @i{mh-e-devel} mailing list and you
1481 use @command{procmail} to filter this mail into @file{~/mail/mh-e}
1482 with the following recipe in @file{.procmailrc}:
1483
1484 @smallexample
1485 PATH=$PATH:/usr/bin/mh
1486 MAILDIR=$HOME/`mhparam Path`
1487 :0:
1488 * ^From mh-e-devel-admin@@stop.mail-abuse.org
1489 mh-e
1490 @end smallexample
1491
1492 @findex mh-inc-spool-*
1493 @kindex I *
1494
1495 In order to incorporate @file{~/mail/mh-e} into @samp{+mh-e} with an
1496 @kbd{I m} (@code{mh-inc-spool-mh-e}) command, customize this option,
1497 and click on the @samp{INS} button. Enter a @samp{Spool File} of
1498 @samp{~/mail/mh-e}, a @samp{Folder} of @samp{mh-e}, and a @samp{Key
1499 Binding} of @samp{m}.
1500
1501 @cindex @command{emacsclient}
1502 @cindex @command{gnuclient}
1503 @cindex @command{xbuffy}
1504 @cindex @samp{gnuserv}
1505 @cindex Unix commands, @command{emacsclient}
1506 @cindex Unix commands, @command{gnuclient}
1507 @cindex Unix commands, @command{xbuffy}
1508
1509 You can use @command{xbuffy} to automate the incorporation of this
1510 mail using the Emacs 22 command @command{emacsclient} as follows:
1511
1512 @smallexample
1513 box ~/mail/mh-e
1514 title mh-e
1515 origMode
1516 polltime 10
1517 headertime 0
1518 command emacsclient --eval '(mh-inc-spool-mh-e)'
1519 @end smallexample
1520
1521 In XEmacs, the command @command{gnuclient} is used in a similar
1522 fashion.
1523
1524 @findex mh-inc-folder
1525 @kindex i
1526 @vindex mh-inc-folder-hook
1527
1528 You can set the hook @code{mh-inc-folder-hook}, which is called after
1529 new mail is incorporated by the @kbd{i} (@code{mh-inc-folder})
1530 command. A good use of this hook is to rescan the whole folder either
1531 after running @kbd{M-x mh-rmail} the first time or when you've changed
1532 the message numbers from outside of MH-E.
1533
1534 @findex mh-execute-commands
1535 @findex mh-rescan-folder, example
1536 @findex mh-show, example
1537 @vindex mh-inc-folder-hook, example
1538
1539 @smalllisp
1540 @group
1541 (defun my-mh-inc-folder-hook ()
1542 "Hook to rescan folder after incorporating mail."
1543 (if (buffer-modified-p) ; @r{if outstanding refiles and deletes,}
1544 (mh-execute-commands)) ; @r{carry them out}
1545 (mh-rescan-folder) ; @r{synchronize with +inbox}
1546 (mh-show)) ; @r{show the current message}
1547
1548 (add-hook 'mh-inc-folder-hook 'my-mh-inc-folder-hook)
1549
1550 @i{Rescan folder after incorporating new mail via mh-inc-folder-hook}
1551
1552 @end group
1553 @end smalllisp
1554
1555 @node Reading Mail, Folders, Incorporating Mail, Top
1556 @chapter Reading Your Mail
1557
1558 @cindex @samp{+inbox}
1559 @cindex MH-Folder mode
1560 @cindex MH-Show mode
1561 @cindex modes, MH-Folder
1562 @cindex modes, MH-Show
1563 @cindex reading mail
1564 @findex mh-rmail
1565 @kindex F r
1566 @kindex F v
1567 @kindex M-x mh-rmail
1568
1569 The MH-E entry point for reading mail is @kbd{M-x mh-rmail}. This
1570 command incorporates your mail and creates a buffer called
1571 @samp{+inbox} in MH-Folder mode. The command @kbd{M-x mh-rmail} shows
1572 you only new mail, not mail you have already read@footnote{If you want
1573 to see your old mail as well, use @kbd{F r} to pull all your messages
1574 into MH-E. Or, give a prefix argument to @code{mh-rmail} so it will
1575 prompt you for folder to visit like @kbd{F v} (for example, @kbd{C-u
1576 M-x mh-rmail @key{RET} bob @key{RET}}). @xref{Folders}.}.
1577
1578 @findex display-time
1579 @vindex read-mail-command
1580
1581 There are some commands that need to read mail, such as @kbd{Mouse-2}
1582 over the @samp{Mail} button that @code{display-time} adds to the mode
1583 line. You can configure Emacs to have these commands use MH-E by
1584 setting the option @code{read-mail-command} to @samp{mh-rmail}.
1585
1586 @cindex @command{scan}
1587 @cindex @samp{Message} menu
1588 @cindex MH commands, @command{scan}
1589 @cindex menu, @samp{Message}
1590 @cindex scan lines
1591
1592 The @samp{+inbox} buffer contains @dfn{scan lines}, which are one-line
1593 summaries of each incorporated message. You can perform most MH
1594 commands on these messages via one- or two-letter commands in either
1595 the MH-Folder or MH-Show buffers or by using the @samp{Message} menu.
1596 See @command{scan}(1) for a description of the contents of the scan
1597 lines, and see the Figure in @ref{Reading Mail Tour}, for an example.
1598
1599 @table @kbd
1600 @kindex ?
1601 @findex mh-help
1602 @item ?
1603 Display cheat sheet for the MH-E commands (@code{mh-help}).
1604 @c -------------------------
1605 @cindex @samp{Message > Show Message} menu item
1606 @cindex menu item, @samp{Message > Show Message}
1607 @kindex @key{RET}
1608 @findex mh-show
1609 @item @key{RET}
1610 Display message (@code{mh-show}).
1611 @c -------------------------
1612 @cindex @samp{Message > Show Message with Header} menu item
1613 @cindex menu item, @samp{Message > Show Message with Header}
1614 @kindex , (comma)
1615 @findex mh-header-display
1616 @item , (comma)
1617 Display message with all header fields (@code{mh-header-display}).
1618 @c -------------------------
1619 @kindex ; (semicolon)
1620 @findex mh-toggle-mh-decode-mime-flag
1621 @item ; (semicolon)
1622 Toggle the value of @code{mh-decode-mime-flag}
1623 (@code{mh-toggle-mh-decode-mime-flag}).
1624 @c -------------------------
1625 @kindex @key{SPC}
1626 @findex mh-page-msg
1627 @item @key{SPC}
1628 Display next page in message (@code{mh-page-msg}).
1629 @c -------------------------
1630 @kindex @key{BS}
1631 @findex mh-previous-page
1632 @item @key{BS}
1633 Display previous page in message (@code{mh-previous-page}).
1634 @c -------------------------
1635 @cindex @samp{Message > Write Message to File...} menu item
1636 @cindex menu item, @samp{Message > Write Message to File...}
1637 @kindex >
1638 @findex mh-write-msg-to-file
1639 @item >
1640 Append message to end of file (@code{mh-write-msg-to-file}).
1641 @c -------------------------
1642 @cindex @samp{Message > Pipe Message to Command...} menu item
1643 @cindex menu item, @samp{Message > Pipe Message to Command...}
1644 @kindex |
1645 @findex mh-pipe-msg
1646 @item |
1647 Pipe message through shell command (@code{mh-pipe-msg}).
1648 @c -------------------------
1649 @kindex C-d
1650 @findex mh-delete-msg-no-motion
1651 @item C-d
1652 Delete range, don't move to next message
1653 (@code{mh-delete-msg-no-motion}).
1654 @c -------------------------
1655 @cindex @samp{Message > Delete Message} menu item
1656 @cindex menu item, @samp{Message > Delete Message}
1657 @kindex d
1658 @findex mh-delete-msg
1659 @item d
1660 Delete range (@code{mh-delete-msg}).
1661 @c -------------------------
1662 @kindex D ?
1663 @findex mh-prefix-help
1664 @item D ?
1665 Display cheat sheet for the commands of the current prefix in
1666 minibuffer (@code{mh-prefix-help}).
1667 @c -------------------------
1668 @kindex D @key{SPC}
1669 @findex mh-page-digest
1670 @item D @key{SPC}
1671 Display next message in digest (@code{mh-page-digest}).
1672 @c -------------------------
1673 @kindex D @key{BS}
1674 @findex mh-page-digest-backwards
1675 @item D @key{BS}
1676 Display previous message in digest (@code{mh-page-digest-backwards}).
1677 @c -------------------------
1678 @cindex @samp{Message > Burst Digest Message} menu item
1679 @cindex menu item, @samp{Message > Burst Digest Message}
1680 @kindex D b
1681 @findex mh-burst-digest
1682 @item D b
1683 Break up digest into separate messages (@code{mh-burst-digest}).
1684 @c -------------------------
1685 @cindex @samp{Message > Go to Message by Number...} menu item
1686 @cindex menu item, @samp{Message > Go to Message by Number...}
1687 @kindex g
1688 @findex mh-goto-msg
1689 @item g
1690 Go to a message (@code{mh-goto-msg}).
1691 @c -------------------------
1692 @kindex k
1693 @findex mh-delete-subject-or-thread
1694 @item k
1695 Delete messages with same subject or thread
1696 (@code{mh-delete-subject-or-thread}).
1697 @c -------------------------
1698 @kindex K ?
1699 @findex mh-prefix-help
1700 @item K ?
1701 Display cheat sheet for the commands of the current prefix in
1702 minibuffer (@code{mh-prefix-help}).
1703 @c -------------------------
1704 @kindex K @key{TAB}
1705 @findex mh-next-button
1706 @item K @key{TAB}
1707 Go to the next button (@code{mh-next-button}).
1708 @c -------------------------
1709 @kindex K S-@key{TAB}
1710 @findex mh-prev-button
1711 @item K S-@key{TAB}
1712 Go to the previous button (@code{mh-prev-button}).
1713 @c -------------------------
1714 @kindex K a
1715 @findex mh-mime-save-parts
1716 @item K a
1717 Save attachments (@code{mh-mime-save-parts}).
1718 @c -------------------------
1719 @kindex K e
1720 @findex mh-display-with-external-viewer
1721 @item K e
1722 View attachment externally (@code{mh-display-with-external-viewer}).
1723 @c -------------------------
1724 @kindex K i
1725 @findex mh-folder-inline-mime-part
1726 @item K i
1727 Show attachment verbatim (@code{mh-folder-inline-mime-part}).
1728 @c -------------------------
1729 @kindex K o
1730 @findex mh-folder-save-mime-part
1731 @item K o
1732 Save (output) attachment (@code{mh-folder-save-mime-part}).
1733 @c -------------------------
1734 @kindex K t
1735 @findex mh-toggle-mime-buttons
1736 @item K t
1737 Toggle option @code{mh-display-buttons-for-inline-parts-flag}
1738 (@code{mh-toggle-mime-buttons}).
1739 @c -------------------------
1740 @kindex K v
1741 @findex mh-folder-toggle-mime-part
1742 @item K v
1743 View attachment (@code{mh-folder-toggle-mime-part}).
1744 @c -------------------------
1745 @cindex @samp{Message > Modify Message} menu item
1746 @cindex menu item, @samp{Message > Modify Message}
1747 @kindex M
1748 @findex mh-modify
1749 @item M
1750 Edit message (@code{mh-modify}).
1751 @c -------------------------
1752 @cindex @samp{Message > Go to First Message} menu item
1753 @cindex menu item, @samp{Message > Go to First Message}
1754 @kindex M-<
1755 @findex mh-first-msg
1756 @item M-<
1757 Display first message (@code{mh-first-msg}).
1758 @c -------------------------
1759 @cindex @samp{Message > Go to Last Message} menu item
1760 @cindex menu item, @samp{Message > Go to Last Message}
1761 @kindex M->
1762 @findex mh-last-msg
1763 @item M->
1764 Display last message (@code{mh-last-msg}).
1765 @c -------------------------
1766 @kindex M-n
1767 @findex mh-next-unread-msg
1768 @item M-n
1769 Display next unread message (@code{mh-next-unread-msg}).
1770 @c -------------------------
1771 @kindex M-p
1772 @findex mh-previous-unread-msg
1773 @item M-p
1774 Display previous unread message (@code{mh-previous-unread-msg}).
1775 @c -------------------------
1776 @cindex @samp{Message > Next Message} menu item
1777 @cindex menu item, @samp{Message > Next Message}
1778 @kindex n
1779 @findex mh-next-undeleted-msg
1780 @item n
1781 Display next message (@code{mh-next-undeleted-msg}).
1782 @c -------------------------
1783 @cindex @samp{Message > Previous Message} menu item
1784 @cindex menu item, @samp{Message > Previous Message}
1785 @kindex p
1786 @findex mh-previous-undeleted-msg
1787 @item p
1788 Display previous message (@code{mh-previous-undeleted-msg}).
1789 @c -------------------------
1790 @kindex P ?
1791 @findex mh-prefix-help
1792 @item P ?
1793 Display cheat sheet for the commands of the current prefix in
1794 minibuffer (@code{mh-prefix-help}).
1795 @c -------------------------
1796 @kindex P C
1797 @findex mh-ps-print-toggle-color
1798 @item P C
1799 Toggle whether color is used in printing messages
1800 (@code{mh-ps-print-toggle-color}).
1801 @c -------------------------
1802 @kindex P F
1803 @findex mh-ps-print-toggle-faces
1804 @item P F
1805 Toggle whether printing is done with faces or not
1806 (@code{mh-ps-print-toggle-faces}).
1807 @c -------------------------
1808 @kindex P f
1809 @findex mh-ps-print-msg-file
1810 @item P f
1811 Print range to file (@code{mh-ps-print-msg-file}).
1812 @c -------------------------
1813 @cindex @samp{Message > Print Message} menu item
1814 @cindex menu item, @samp{Message > Print Message}
1815 @kindex P l
1816 @findex mh-print-msg
1817 @item P l
1818 Print range the old fashioned way
1819 (@code{mh-print-msg}).
1820 @c -------------------------
1821 @kindex P p
1822 @findex mh-ps-print-msg
1823 @item P p
1824 Print range (@code{mh-ps-print-msg}).
1825 @c -------------------------
1826 @kindex X ?
1827 @findex mh-prefix-help
1828 @item X ?
1829 Display cheat sheet for the commands of the current prefix in
1830 minibuffer (@code{mh-prefix-help}).
1831 @c -------------------------
1832 @cindex @samp{Message > Unpack Uuencoded Message...} menu item
1833 @cindex menu item, @samp{Message > Unpack Uuencoded Message...}
1834 @kindex X s
1835 @kindex X u
1836 @findex mh-store-msg
1837 @item X s
1838 @itemx X u
1839 Unpack message created with @command{uudecode} or @command{shar}
1840 (@code{mh-store-msg}).
1841 @c -------------------------
1842 @kindex Mouse-2
1843 @findex mh-show-mouse
1844 @item Mouse-2
1845 Move point to mouse event and show message (@code{mh-show-mouse}).
1846 @end table
1847
1848 Within the MH-Show buffer, the following command is defined.
1849
1850 @table @kbd
1851 @kindex @key{RET}
1852 @kindex Mouse-1
1853 @kindex Mouse-2
1854 @findex mh-press-button
1855 @item @key{RET}
1856 @itemx Mouse-1
1857 @itemx Mouse-2
1858 View contents of button (@code{mh-press-button}).
1859 @end table
1860
1861 @cindex @samp{mh-show} customization group
1862 @cindex customization group, @samp{mh-show}
1863
1864 The following table lists options in the @samp{mh-show} customization
1865 group that are used while reading mail.
1866
1867 @vtable @code
1868 @item mh-bury-show-buffer-flag
1869 On means show buffer is buried (default: @samp{on}).
1870 @c -------------------------
1871 @item mh-clean-message-header-flag
1872 On means remove extraneous header fields (default: @samp{on}).
1873 @c -------------------------
1874 @item mh-decode-mime-flag
1875 On means attachments are handled (default: @samp{on} if the Gnus
1876 @samp{mm-decode} package is present).
1877 @c -------------------------
1878 @item mh-display-buttons-for-alternatives-flag
1879 On means display buttons for all alternative attachments (default:
1880 @samp{off}).
1881 @c -------------------------
1882 @item mh-display-buttons-for-inline-parts-flag
1883 On means display buttons for all inline attachments (default:
1884 @samp{off}).
1885 @c -------------------------
1886 @item mh-do-not-confirm-flag
1887 On means non-reversible commands do not prompt for confirmation
1888 (default: @samp{off}).
1889 @c -------------------------
1890 @item mh-fetch-x-image-url
1891 Control fetching of @samp{X-Image-URL:} header field image (default:
1892 @samp{Never Fetch}).
1893 @c -------------------------
1894 @item mh-graphical-smileys-flag
1895 On means graphical smileys are displayed (default: @samp{on}).
1896 @c -------------------------
1897 @item mh-graphical-emphasis-flag
1898 On means graphical emphasis is displayed (default: @samp{on}).
1899 @c -------------------------
1900 @item mh-highlight-citation-style
1901 Style for highlighting citations (default: @samp{Multicolor}).
1902 @c -------------------------
1903 @item mh-invisible-header-fields-default
1904 List of hidden header fields (default: a checklist too long to list
1905 here).
1906 @c -------------------------
1907 @item mh-invisible-header-fields
1908 Additional header fields to hide (default: @code{nil}).
1909 @c -------------------------
1910 @item mh-lpr-command-format
1911 Command used to print (default: @code{"lpr -J '%s'"}).
1912 @c -------------------------
1913 @item mh-max-inline-image-height
1914 Maximum inline image height if @samp{Content-Disposition:} is not
1915 present (default: 0).
1916 @c -------------------------
1917 @item mh-max-inline-image-width
1918 Maximum inline image width if @samp{Content-Disposition:} is not
1919 present(default: 0).
1920 @c -------------------------
1921 @item mh-mhl-format-file
1922 Specifies the format file to pass to the @command{mhl} program
1923 (default: @samp{Use Default mhl Format (Printing Only)}).
1924 @c -------------------------
1925 @item mh-mime-save-parts-default-directory
1926 Default directory to use for @kbd{K a}.
1927 @c -------------------------
1928 @item mh-print-background-flag
1929 On means messages should be printed in the background (default:
1930 @samp{off}).
1931 @c -------------------------
1932 @item mh-show-buffer-mode-line-buffer-id
1933 Format string to produce @code{mode-line-buffer-identification} for
1934 show buffers (default: @code{" @{show-%s@} %d"}).
1935 @c -------------------------
1936 @item mh-show-maximum-size
1937 Maximum size of message (in bytes) to display automatically (default:
1938 0).
1939 @c -------------------------
1940 @item mh-show-use-xface-flag
1941 On means display face images in MH-Show buffers (default: @samp{on}).
1942 @c -------------------------
1943 @item mh-store-default-directory
1944 Default directory for @kbd{X s} (default: @samp{Current}).
1945 @c -------------------------
1946 @item mh-summary-height
1947 Number of lines in MH-Folder buffer (including the mode line)
1948 (default: depends on size of frame).
1949 @end vtable
1950
1951 The following hooks are available.
1952
1953 @vtable @code
1954 @item mh-delete-msg-hook
1955 Hook run after marking each message for deletion (default: @code{nil}).
1956 @c -------------------------
1957 @item mh-show-hook
1958 Hook run after @key{RET} shows a message (default: @code{nil}).
1959 @c -------------------------
1960 @item mh-show-mode-hook
1961 Hook run upon entry to @code{mh-show-mode} (default: @code{nil}).
1962 @end vtable
1963
1964 The following faces are available.
1965
1966 @vtable @code
1967 @item mh-show-cc
1968 Face used to highlight @samp{cc:} header fields.
1969 @c -------------------------
1970 @item mh-show-date
1971 Face used to highlight @samp{Date:} header fields.
1972 @c -------------------------
1973 @item mh-show-from
1974 Face used to highlight @samp{From:} header fields.
1975 @c -------------------------
1976 @item mh-show-header
1977 Face used to deemphasize less interesting header fields.
1978 @c -------------------------
1979 @item mh-show-pgg-bad
1980 Bad PGG signature face.
1981 @c -------------------------
1982 @item mh-show-pgg-good
1983 Good PGG signature face.
1984 @c -------------------------
1985 @item mh-show-pgg-unknown
1986 Unknown or untrusted PGG signature face.
1987 @c -------------------------
1988 @item mh-show-signature
1989 Signature face.
1990 @c -------------------------
1991 @item mh-show-subject
1992 Face used to highlight @samp{Subject:} header fields.
1993 @c -------------------------
1994 @item mh-show-to
1995 Face used to highlight @samp{To:} header fields.
1996 @c -------------------------
1997 @item mh-show-xface
1998 X-Face image face.
1999 @end vtable
2000
2001 The functions and variables introduced here are explained in more
2002 detail in the following sections.
2003
2004 @menu
2005 * Viewing::
2006 * Viewing Attachments::
2007 * HTML::
2008 * Digests::
2009 * Reading PGP::
2010 * Printing::
2011 * Files and Pipes::
2012 * Navigating::
2013 * Miscellaneous Commands and Options::
2014 @end menu
2015
2016 @node Viewing, Viewing Attachments, Reading Mail, Reading Mail
2017 @section Viewing Your Mail
2018
2019 @findex mh-header-display
2020 @findex mh-page-msg
2021 @findex mh-previous-page
2022 @findex mh-show
2023 @findex mh-show-mouse
2024 @kindex , (comma)
2025 @kindex . (period)
2026 @kindex @key{BS}
2027 @kindex @key{RET}
2028 @kindex @key{SPC}
2029 @kindex Mouse-2
2030
2031 The command @key{RET} (@code{mh-show}) displays the message that the
2032 cursor is on while @kbd{Mouse-2} (@code{mh-show-mouse}) displays the
2033 message that the mouse cursor is on. If the message is already
2034 displayed, it scrolls to the beginning of the message. Use @key{SPC}
2035 (@code{mh-page-msg}) and @key{BS} (@code{mh-previous-page}) to move
2036 forwards and backwards one page at a time through the message. You can
2037 give either of these commands a prefix argument that specifies the
2038 number of lines to scroll (such as @kbd{10 @key{SPC}}). The @key{SPC}
2039 command will also show the next undeleted message if it is used at the
2040 bottom of a message. MH-E normally hides a lot of the superfluous
2041 header fields that mailers add to a message, but if you wish to see
2042 all of them, use the command @kbd{,} (comma;
2043 @code{mh-header-display}).
2044
2045 @vindex mh-show-maximum-size
2046
2047 The option @code{mh-show-maximum-size} provides an opportunity to skip
2048 over large messages which may be slow to load. The default value of 0
2049 means that all message are shown regardless of size.
2050
2051 A litany of options control what displayed messages look like.
2052
2053 @vindex mh-show-cc
2054 @vindex mh-show-date
2055 @vindex mh-show-from
2056 @vindex mh-show-header
2057 @vindex mh-show-subject
2058 @vindex mh-show-to
2059
2060 First, the appearance of the header fields can be modified by
2061 customizing the associated face: @code{mh-show-to}, @code{mh-show-cc},
2062 @code{mh-show-from}, @code{mh-show-date}, and @code{mh-show-subject}.
2063 The face @code{mh-show-header} is used to deemphasize the other, less
2064 interesting, header fields.
2065
2066 @cindex regular expressions, @code{mh-invisible-header-fields}
2067 @vindex mh-clean-message-header-flag
2068 @vindex mh-invisible-header-fields
2069 @vindex mh-invisible-header-fields-default
2070
2071 Normally messages are delivered with a handful of uninteresting header
2072 fields. These are hidden by turning on the option
2073 @code{mh-clean-message-header-flag} (which it is by default). The
2074 header fields listed in the option
2075 @code{mh-invisible-header-fields-default} are hidden, although you can
2076 check off any field that you would like to see. Header fields that you
2077 would like to hide that aren't listed can be added to the option
2078 @code{mh-invisible-header-fields} with a couple of caveats. Regular
2079 expressions are not allowed. Unique fields should have a @samp{:}
2080 suffix; otherwise, the element can be used to render invisible an
2081 entire class of fields that start with the same prefix. If you think a
2082 header field should be generally ignored, report a bug (@pxref{Bug
2083 Reports}).
2084
2085 @cindex header field, @samp{Face:}
2086 @cindex header field, @samp{X-Face:}
2087 @cindex header field, @samp{X-Image-URL:}
2088 @cindex @samp{Face:} header field
2089 @cindex @samp{X-Face:} header field
2090 @cindex @samp{X-Image-URL:} header field
2091 @vindex mh-show-use-xface-flag
2092
2093 MH-E can display the content of @samp{Face:}, @samp{X-Face:}, and
2094 @samp{X-Image-URL:} header fields. If any of these fields occur in the
2095 header of your message, the sender's face will appear in the
2096 @samp{From:} header field. If more than one of these fields appear,
2097 then the first field found in the order @samp{Face:}, @samp{X-Face:},
2098 and @samp{X-Image-URL:} will be used. The option
2099 @code{mh-show-use-xface-flag} is used to turn this feature on and off.
2100 This feature will be turned on by default if your system supports it.
2101
2102 The first header field used, if present, is the Gnus-specific
2103 @samp{Face:} field@footnote{The @samp{Face:} field appeared in GNU
2104 Emacs 21 and XEmacs. For more information, see
2105 @uref{http://quimby.gnus.org/circus/face/}.}.
2106
2107 @cindex @command{uncompface}
2108 @cindex Emacs, packages, x-face
2109 @cindex Unix commands, @command{uncompface}
2110 @cindex x-face package
2111 @vindex mh-show-xface
2112
2113 Next is the traditional @samp{X-Face:} header field@footnote{The
2114 display of this field requires the
2115 @uref{ftp://ftp.cs.indiana.edu/pub/faces/compface/compface.tar.Z,
2116 @command{uncompface} program}. Recent versions of XEmacs have internal
2117 support for @samp{X-Face:} images. If your version of XEmacs does not,
2118 then you'll need both @command{uncompface} and the
2119 @uref{ftp://ftp.jpl.org/pub/elisp/, @samp{x-face} package}.}. MH-E
2120 renders the foreground and background of the image using the
2121 associated attributes of the face @code{mh-show-xface}.
2122
2123 @cindex @command{convert}
2124 @cindex @command{wget}
2125 @cindex ImageMagick
2126 @cindex Unix commands, @command{convert}
2127 @cindex Unix commands, @command{wget}
2128 @vindex mh-fetch-x-image-url
2129
2130 Finally, MH-E will display images referenced by the
2131 @samp{X-Image-URL:} header field if neither the @samp{Face:} nor the
2132 @samp{X-Face:} fields are present@footnote{The display of the images
2133 requires the @uref{http://www.gnu.org/software/wget/wget.html,
2134 @command{wget} program} to fetch the image and the @command{convert}
2135 program from the @uref{http://www.imagemagick.org/, ImageMagick
2136 suite}.}. Of the three header fields this is the most efficient in
2137 terms of network usage since the image doesn't need to be transmitted
2138 with every single mail. The option @code{mh-fetch-x-image-url}
2139 controls the fetching of the @samp{X-Image-URL:} header field image
2140 with the following values:
2141
2142 @table @samp
2143 @item Ask Before Fetching
2144 You are prompted before the image is fetched. MH-E will remember your
2145 reply and will either use the already fetched image the next time the
2146 same URL is encountered or silently skip it if you didn't fetch it the
2147 first time. This is a good setting.
2148 @c -------------------------
2149 @item Never Fetch
2150 Images are never fetched and only displayed if they are already
2151 present in the cache. This is the default.
2152 @end table
2153
2154 There isn't a value of @samp{Always Fetch} for privacy and DOS (denial
2155 of service) reasons. For example, fetching a URL can tip off a spammer
2156 that you've read his email (which is why you shouldn't blindly answer
2157 yes if you've set this option to @samp{Ask Before Fetching}). Someone
2158 may also flood your network and fill your disk drive by sending a
2159 torrent of messages, each specifying a unique URL to a very large
2160 file.
2161
2162 @cindex @file{.mhe-x-image-cache}
2163 @cindex files, @file{.mhe-x-image-cache}
2164
2165 The cache of images is found in the directory
2166 @file{.mhe-x-image-cache} within your MH directory. You can add your
2167 own face to the @samp{From:} field too. @xref{Picture}.
2168
2169 @cindex @command{mhl}
2170 @cindex MH commands, @command{mhl}
2171 @vindex mh-mhl-format-file
2172
2173 Normally MH-E takes care of displaying messages itself (rather than
2174 calling an MH program to do the work). If you'd rather have
2175 @command{mhl} display the message (within MH-E), change the option
2176 @code{mh-mhl-format-file} from its default value of @samp{Use Default
2177 mhl Format (Printing Only)}. You can set this option to @samp{Use
2178 Default mhl Format} to get the same output as you would get if you ran
2179 @command{mhl} from the shell. If you have a format file that you want
2180 MH-E to use, you can set this option to @samp{Specify an mhl Format
2181 File} and enter the name of your format file (@command{mhl}(1) or
2182 section @uref{@value{MH-BOOK-HOME}/shomes.html#Usisho, Using mhl} in
2183 the MH book tells you how to write one). Your format file should
2184 specify a non-zero value for @samp{overflowoffset} to allow MH-E to
2185 parse the header. Note that @command{mhl} is always used for printing
2186 and forwarding; in this case, the value of @code{mh-mhl-format-file}
2187 is consulted if you have specified a format file.
2188
2189 @cindex citations, highlighting
2190 @cindex highlighting citations
2191 @vindex mh-highlight-citation-style
2192
2193 If the sender of the message has cited other messages in his message,
2194 then MH-E will highlight these citations to emphasize the sender's
2195 actual response. The option @code{mh-highlight-citation-style} can be
2196 customized to change the highlighting style. The @samp{Multicolor}
2197 method uses a different color for each indentation while the
2198 @samp{Monotone} method highlights all citations in red. To disable
2199 highlighting of citations entirely, choose @samp{None}.
2200
2201 @cindex URLs, highlighting
2202 @cindex email addresses, highlighting
2203 @cindex highlighting URLs
2204 @cindex highlighting email addresses
2205 @cindex links, following
2206 @findex goto-address-at-point
2207 @kindex C-c @key{RET}
2208 @kindex Mouse-2
2209 @vindex goto-address-highlight-p
2210
2211 Email addresses and URLs in the message are highlighted if the option
2212 @code{goto-address-highlight-p} is on, which it is by default. To view
2213 the web page for a highlighted URL or to send a message using a
2214 highlighted email address, use @kbd{Mouse-2} or @kbd{C-c @key{RET}}
2215 (@code{goto-address-at-point}). @xref{Sending Mail}, to see how to
2216 configure Emacs to send the message using MH-E.
2217
2218 @cindex boldface, showing
2219 @cindex emphasis
2220 @cindex italics, showing
2221 @cindex smileys
2222 @cindex typesetting
2223 @cindex underline, showing
2224 @vindex gnus-emphasis-alist
2225 @vindex mh-decode-mime-flag
2226 @vindex mh-graphical-emphasis-flag
2227 @vindex mh-graphical-smileys-flag
2228
2229 It is a long standing custom to inject body language using a
2230 cornucopia of punctuation, also known as the @dfn{smileys}. MH-E can
2231 render these as graphical widgets if the option
2232 @code{mh-graphical-smileys-flag} is turned on, which it is by default.
2233 Smileys include patterns such as :-) and ;-). Similarly, a few
2234 typesetting features are indicated in ASCII text with certain
2235 characters. If your terminal supports it, MH-E can render these
2236 typesetting directives naturally if the option
2237 @code{mh-graphical-emphasis-flag} is turned on, which it is by
2238 default. For example, _underline_ will be
2239 @ifhtml
2240 @html
2241 <u>underlined</u>,
2242 @end html
2243 @end ifhtml
2244 @ifnothtml
2245 underlined,
2246 @end ifnothtml
2247 *bold* will appear in @b{bold}, /italics/ will appear in @i{italics},
2248 and so on. See the option @code{gnus-emphasis-alist} for the whole
2249 list. Both of these options are disabled if the option
2250 @code{mh-decode-mime-flag} is turned off. @xref{Viewing Attachments}.
2251
2252 @cindex signature separator
2253 @cindex vCard
2254 @vindex mh-show-signature
2255
2256 MH-E normally renders signatures and vCards in italics so that the
2257 body of the message stands out more. MH-E depends on the presence of
2258 the @dfn{signature separator} (@code{"-- "}) to do this. You can also
2259 customize the face @code{mh-show-signature} so the appearance of the
2260 signature block is more to your liking.
2261
2262 @vindex mh-show-hook
2263 @vindex mh-show-mode-hook
2264
2265 Two hooks can be used to control how messages are displayed. The first
2266 hook, @code{mh-show-mode-hook}, is called early on in the process of
2267 the message display. It is usually used to perform some action on the
2268 message's content. The second hook, @code{mh-show-hook}, is the last
2269 thing called after messages are displayed. It's used to affect the
2270 behavior of MH-E in general or when @code{mh-show-mode-hook} is too
2271 early.
2272
2273 @cindex MH-Show mode
2274 @cindex modes, MH-Show
2275 @vindex mh-show-buffer-mode-line-buffer-id
2276
2277 For those who like to modify their mode lines, use
2278 @code{mh-show-buffer-mode-line-buffer-id} to modify the mode line in
2279 the MH-Show buffers. Place the two escape strings @samp{%s} and
2280 @samp{%d}, which will display the folder name and the message number,
2281 respectively, somewhere in the string in that order. The default value
2282 of @code{"@{show-%s@} %d"} yields a mode line of
2283
2284 @smallexample
2285 -----@{show-+inbox@} 4 (MH-Show)--Bot--------------------------------
2286 @end smallexample
2287
2288 @node Viewing Attachments, HTML, Viewing, Reading Mail
2289 @section Viewing Attachments
2290
2291 @cindex attachments
2292 @cindex body parts
2293 @cindex @command{mhshow}
2294 @cindex @command{show}
2295 @cindex MH commands, @command{mhshow}
2296 @cindex MH commands, @command{show}
2297 @cindex MIME
2298 @cindex multimedia mail
2299
2300 MH has the ability to display @dfn{@sc{mime}} (Multipurpose Internet
2301 Mail Extensions) messages which are simply messages with additional
2302 @dfn{body parts} or @dfn{attachments}. You can use the MH commands
2303 @command{show}@footnote{See the section
2304 @uref{@value{MH-BOOK-HOME}/reapre.html, Reading Mail: inc show next
2305 prev} in the MH book.} or @command{mhshow}@footnote{See the section
2306 @uref{@value{MH-BOOK-HOME}/usimim.html#ReMIMa, Reading MIME Mail} in
2307 the MH book.} from the shell to read @sc{mime} messages@footnote{You
2308 can call them directly from Emacs if you're running the X Window
2309 System: type @kbd{M-! xterm -e mhshow @var{message-number}}. You can
2310 leave out the @samp{xterm -e} if you use @command{mhlist} or
2311 @command{mhstore}.}.
2312
2313 @cindex Emacs, packages, mm-decode
2314 @cindex mm-decode package
2315 @findex mh-toggle-mh-decode-mime-flag
2316 @kindex ; (semicolon)
2317 @vindex mh-decode-mime-flag
2318
2319 MH-E can handle attachments as well if the Gnus @samp{mm-decode}
2320 package is present. If so, the option @code{mh-decode-mime-flag} will
2321 be on. Otherwise, you'll see the @sc{mime} body parts rather than text
2322 or attachments. There isn't much point in turning off the option
2323 @code{mh-decode-mime-flag}; however, you can inspect it if it appears
2324 that the body parts are not being interpreted correctly or toggle it
2325 with the command @kbd{;} (semicolon;
2326 @code{mh-toggle-mh-decode-mime-flag}) to view the raw message. This
2327 option also controls the display of quoted-printable messages and
2328 other graphical widgets. @xref{Viewing}.
2329
2330 @cindex buttons
2331
2332 Attachments in MH-E are indicated by @dfn{buttons} like this:
2333
2334 @smallexample
2335 [1. image/jpeg; foo.jpg]...
2336 @end smallexample
2337
2338 @findex mh-next-button
2339 @findex mh-press-button
2340 @findex mh-prev-button
2341 @kindex @key{RET}
2342 @kindex K @key{TAB}
2343 @kindex K S-@key{TAB}
2344 @kindex Mouse-1
2345 @kindex Mouse-2
2346
2347 To view the contents of the button, use either @kbd{Mouse-1} or
2348 @kbd{Mouse-2} on the button or @key{RET} (@code{mh-press-button}) when
2349 the cursor is over the button. This command is a toggle so if you use
2350 it again on the same attachment, it is hidden. If Emacs does not know
2351 how to display the attachment, then Emacs offers to save the
2352 attachment in a file. To move the cursor to the next button, use the
2353 command @kbd{K @key{TAB}} (@code{mh-next-button}). If the end of the
2354 buffer is reached then the search wraps over to the start of the
2355 buffer. To move the cursor to the previous button, use the command
2356 @kbd{K S-@key{TAB}} (@code{mh-prev-button}). If the beginning of the
2357 buffer is reached then the search wraps over to the end of the buffer.
2358
2359 @cindex attachments, viewing
2360 @cindex viewing attachments
2361 @findex mh-folder-toggle-mime-part
2362 @kindex K v
2363
2364 Another way to view the contents of a button is to use the command
2365 @kbd{K v} (@code{mh-folder-toggle-mime-part}). This command displays
2366 (or hides) the attachment associated with the button under the cursor.
2367 If the cursor is not located over a button, then the cursor first
2368 moves to the next button, wrapping to the beginning of the message if
2369 necessary. This command has the advantage over the previous commands
2370 of working from the MH-Folder buffer. You can also provide a numeric
2371 prefix argument (as in @kbd{4 K v}) to view the attachment labeled
2372 with that number. If Emacs does not know how to display the
2373 attachment, then Emacs offers to save the attachment in a file.
2374
2375 @cindex @file{/etc/mailcap}
2376 @cindex files, @file{/etc/mailcap}
2377 @findex mailcap-mime-info
2378 @findex mh-display-with-external-viewer
2379 @kindex K e
2380
2381 If Emacs does not know how to view an attachment, you could save it
2382 into a file and then run some program to open it. It is easier,
2383 however, to launch the program directly from MH-E with the command
2384 @kbd{K e} (@code{mh-display-with-external-viewer}). While you'll most
2385 likely use this to view spreadsheets and documents, it is also useful
2386 to use your browser to view HTML attachments with higher fidelity than
2387 what Emacs can provide. This command displays the attachment
2388 associated with the button under the cursor. If the cursor is not
2389 located over a button, then the cursor first moves to the next button,
2390 wrapping to the beginning of the message if necessary. You can provide
2391 a numeric prefix argument (as in @kbd{4 K e}) to view the attachment
2392 labeled with that number. This command tries to provide a reasonable
2393 default for the viewer by calling the Emacs function
2394 @code{mailcap-mime-info}. This function usually reads the file
2395 @file{/etc/mailcap}.
2396
2397 @cindex attachments, saving
2398 @cindex saving attachments
2399 @findex mh-folder-save-mime-part
2400 @kindex K o
2401
2402 Use the command @kbd{K o} (@code{mh-folder-save-mime-part}) to save
2403 attachments (the mnemonic is ``output''). This command saves the
2404 attachment associated with the button under the cursor. If the cursor
2405 is not located over a button, then the cursor first moves to the next
2406 button, wrapping to the beginning of the message if necessary. You can
2407 also provide a numeric prefix argument (as in @kbd{3 K o}) to save the
2408 attachment labeled with that number. This command prompts you for a
2409 filename and suggests a specific name if it is available.
2410
2411 @cindex @command{mhn}
2412 @cindex @command{mhstore}
2413 @cindex MH commands, @command{mhn}
2414 @cindex MH commands, @command{mhstore}
2415 @findex mh-mime-save-parts
2416 @kindex K a
2417 @vindex mh-mime-save-parts-default-directory
2418
2419 You can save all of the attachments at once with the command @kbd{K a}
2420 (@code{mh-mime-save-parts}). The attachments are saved in the
2421 directory specified by the option
2422 @code{mh-mime-save-parts-default-directory} unless you use a prefix
2423 argument (as in @kbd{C-u K a}) in which case you are prompted for the
2424 directory. These directories may be superseded by MH profile
2425 components, since this function calls on @command{mhstore}
2426 (@command{mhn}) to do the work.
2427
2428 @vindex mh-mime-save-parts-default-directory
2429
2430 The default value for the option
2431 @code{mh-mime-save-parts-default-directory} is @samp{Prompt Always} so
2432 that you are always prompted for the directory in which to save the
2433 attachments. However, if you usually use the same directory within a
2434 session, then you can set this option to @samp{Prompt the First Time}
2435 to avoid the prompt each time. you can make this directory permanent
2436 by choosing @samp{Directory} and entering the directory's name.
2437
2438 @cindex attachments, inline
2439 @cindex inline attachments
2440 @findex mh-toggle-mime-buttons
2441 @kindex K t
2442 @vindex mh-display-buttons-for-inline-parts-flag
2443
2444 The sender can request that attachments should be viewed inline so
2445 that they do not really appear like an attachment at all to the
2446 reader. Most of the time, this is desirable, so by default MH-E
2447 suppresses the buttons for inline attachments. On the other hand, you
2448 may receive code or HTML which the sender has added to his message as
2449 inline attachments so that you can read them in MH-E. In this case, it
2450 is useful to see the buttons so that you know you don't have to cut
2451 and paste the code into a file; you can simply save the attachment. If
2452 you want to make the buttons visible for inline attachments, you can
2453 use the command @kbd{K t} (@code{mh-toggle-mime-buttons}) to toggle
2454 the visibility of these buttons. You can turn on these buttons
2455 permanently by turning on the option
2456 @code{mh-display-buttons-for-inline-parts-flag}.
2457
2458 MH-E cannot display all attachments inline however. It can display
2459 text (including @sc{html}) and images.
2460
2461 @cindex header field, @samp{Content-Disposition:}
2462 @cindex inline images
2463 @cindex @samp{Content-Disposition:} header field
2464 @vindex mh-max-inline-image-height
2465 @vindex mh-max-inline-image-width
2466
2467 Some older mail programs do not insert the needed
2468 plumbing@footnote{This plumbing is the @samp{Content-Disposition:}
2469 header field.} to tell MH-E whether to display the attachments inline
2470 or not. If this is the case, MH-E will display these images inline if
2471 they are smaller than the window. However, you might want to allow
2472 larger images to be displayed inline. To do this, you can change the
2473 options @code{mh-max-inline-image-width} and
2474 @code{mh-max-inline-image-height} from their default value of zero to
2475 a large number. The size of your screen is a good choice for these
2476 numbers.
2477
2478 @cindex alternatives
2479 @cindex attachments, alternatives
2480 @vindex mh-display-buttons-for-alternatives-flag
2481
2482 Sometimes, a mail program will produce multiple alternatives of an
2483 attachment in increasing degree of faithfulness to the original
2484 content. By default, only the preferred alternative is displayed. If
2485 the option @code{mh-display-buttons-for-alternatives-flag} is on, then
2486 the preferred part is shown inline and buttons are shown for each of
2487 the other alternatives.
2488
2489 @vindex mm-discouraged-alternatives
2490
2491 Many people prefer to see the @samp{text/plain} alternative rather
2492 than the @samp{text/html} alternative. To do this in MH-E, customize
2493 the option @code{mm-discouraged-alternatives}, and add
2494 @samp{text/html}. The next best alternative, if any, will be shown.
2495
2496 @kindex K i
2497 @findex mh-folder-inline-mime-part
2498
2499 You can view the raw contents of an attachment with the command @kbd{K
2500 i} (@code{mh-folder-inline-mime-part}). This command displays (or
2501 hides) the contents of the attachment associated with the button under
2502 the cursor verbatim. If the cursor is not located over a button, then
2503 the cursor first moves to the next button, wrapping to the beginning
2504 of the message if necessary. You can also provide a numeric prefix
2505 argument (as in @kbd{4 K i}) to view the attachment labeled with that
2506 number.
2507
2508 For additional information on buttons, see
2509 @ifinfo
2510 @ref{Article Buttons,,,gnus}, and @ref{MIME Commands,,,gnus}.
2511 @end ifinfo
2512 @ifnotinfo
2513 the chapters @uref{http://www.gnus.org/manual/gnus_101.html#SEC101,
2514 Article Buttons} and
2515 @uref{http://www.gnus.org/manual/gnus_108.html#SEC108, MIME Commands}
2516 in the @cite{The Gnus Manual}.
2517 @end ifnotinfo
2518
2519 @node HTML, Digests, Viewing Attachments, Reading Mail
2520 @section HTML
2521
2522 @cindex HTML
2523 @cindex Gnus
2524
2525 MH-E can display messages that have been sent in HTML@footnote{This
2526 feature depends on a version of Gnus that is at least 5.10.}. The
2527 content of the message will appear in the MH-Show buffer as you would
2528 expect if the entire message is HTML, or there is an inline HTML body
2529 part. However, if there is an HTML body part that is an attachment,
2530 then you'll see a button like this:
2531
2532 @smallexample
2533 [1. text/html; foo.html]...
2534 @end smallexample
2535
2536 To see how to read the contents of this body part, see @ref{Viewing
2537 Attachments}.
2538
2539 @vindex mm-text-html-renderer
2540
2541 The browser that MH-E uses is determined by the option
2542 @code{mm-text-html-renderer}. The default setting is set automatically
2543 based upon the presence of a known browser on your system. If you wish
2544 to use a different browser, then set this option accordingly. See the
2545 documentation for the browser you use for additional information on
2546 how to use it. In particular, find and disable the option to render
2547 images as this can tip off spammers that the email address they have
2548 used is valid.
2549
2550 @vindex mm-text-html-renderer
2551
2552 If you're confused about which @code{mm-text-html-renderer} to use,
2553 here's a brief description of each, sorted by popularity, that
2554 includes the results of a quick poll of MH-E users from 2005-12-23.
2555
2556 @table @asis
2557 @cindex browser, @samp{w3m}
2558 @cindex @samp{w3m}
2559 @kindex Mouse-2
2560 @item @samp{w3m} 7
2561 The @samp{w3m} browser requires an external program. It's quick,
2562 produces pretty nice output, and best of all, it's the only browser
2563 that highlights links. These can be clicked with @kbd{Mouse-2} to view
2564 the content of the link in @samp{w3m}. The @samp{w3m} browser handles
2565 tables well and actually respects the table's width parameter (which
2566 can cause text to wrap if the author didn't anticipate that the page
2567 would be viewed in Emacs).
2568 @c -------------------------
2569 @cindex browser, @samp{w3m-standalone}
2570 @cindex @samp{w3m-standalone}
2571 @item @samp{w3m-standalone} 3
2572 This browser, along with @samp{nil} for the external browser, are the
2573 only choices that work without having to download a separate lisp
2574 package or external program. This browser is quick, but does not show
2575 links. It handles simple tables but some tables get rendered much
2576 wider than the Emacs frame. This browser was the only one not to
2577 handle the escape @samp{&ndash;} (it printed a @samp{?}), but it did
2578 render @samp{&reg;}.
2579 @c -------------------------
2580 @cindex browser, @samp{links}
2581 @cindex @samp{links}
2582 @item @samp{links} 1
2583 The @samp{links} browser requires an external program. It's quick, and
2584 produces nicer output than @samp{lynx} on single column mails in
2585 tables. However, it doesn't show links and it doesn't do as nice a job
2586 on multi-column tables as some lines wrap. At least it fits in 80
2587 columns and thus seems better than @samp{w3} and
2588 @samp{w3m-standalone}. Converts escapes such as @samp{&reg;} to (R).
2589 @c -------------------------
2590 @cindex browser, @samp{lynx}
2591 @cindex @samp{lynx}
2592 @item @samp{lynx} 1
2593 The @samp{lynx} browser requires an external program. It's quick and
2594 produces pretty decent output but it doesn't show links. It doesn't
2595 seem to do multi-column tables which makes output much cleaner. It
2596 centers the output and wraps long lines more than most. Handles
2597 @samp{&reg;}.
2598 @c -------------------------
2599 @item @samp{nil} 1
2600 This choice obviously requires an external browser. Like
2601 @samp{w3m-standalone}, it works out of the box. With this setting,
2602 HTML messages have a button for the body part which you can view with
2603 @kbd{K v} (@code{mh-folder-toggle-mime-part}).
2604 @c -------------------------
2605 @cindex browser, @samp{w3}
2606 @cindex @samp{w3}
2607 @item @samp{w3} 0
2608 This choice does not require an external program as all of the
2609 rendering is done in lisp. You do need to get the package separately.
2610 This browser is @strong{slow}, and doesn't appear to have been updated
2611 since 2001 and the author hasn't responded to my emails. It displays
2612 unknown tags instead of hiding them, so you get to see all the
2613 Microsoft crap in certain messages. Tends to make multi-column tables
2614 wider than even a full-screen Emacs can handle. Like @samp{w3m}, you
2615 can follow links, but you have to find them first as they are not
2616 highlighted. Performs well on single-column tables and handles escapes
2617 such as @samp{&reg;}.
2618 @c -------------------------
2619 @cindex browser, @samp{html2text}
2620 @cindex @samp{html2text}
2621 @item @samp{html2text} 0
2622 The @samp{html2text} browser requires an external program. I noticed
2623 that it can do some nasty things with simple HTML mails (like filling
2624 the entire message as if it were one paragraph, including signature).
2625 On another message, it displayed half of the HTML tags for some
2626 reason.
2627 @end table
2628
2629 @vindex mm-text-html-renderer
2630
2631 For a couple more sources of information about
2632 @code{mm-text-html-renderer},
2633 @ifinfo
2634 @xref{Display Customization,,,emacs-mime}, and the documentation for
2635 the Gnus command @kbd{W h} (@pxref{Article Washing,,,gnus},).
2636 @end ifinfo
2637 @ifnotinfo
2638 see section @uref{http://www.gnus.org/manual/emacs-mime_6.html,
2639 Display Customization} in the @cite{The Emacs MIME Manual} and the
2640 documentation for the Gnus command @kbd{W h} (see section
2641 @uref{http://www.gnus.org/manual/gnus_99.html, Article Washing} in the
2642 @cite{The Gnus Manual}).
2643 @end ifnotinfo
2644
2645 @cindex @file{.emacs}
2646 @cindex files, @file{.emacs}
2647 @findex browse-url-at-mouse
2648 @kindex S-Mouse-2
2649
2650 A useful key binding that you can add to to @file{~/.emacs} is the
2651 following which displays an HTML link or textual URL in an external
2652 browser when clicked with @kbd{S-mouse-2}. This binding works in any
2653 buffer, including HTML buffers.
2654
2655 @smalllisp
2656 (global-set-key [S-mouse-2] 'browse-url-at-mouse)
2657 @end smalllisp
2658
2659 @node Digests, Reading PGP, HTML, Reading Mail
2660 @section Digests
2661
2662 @cindex digests
2663 @findex mh-page-digest
2664 @findex mh-page-digest-backwards
2665 @kindex D @key{BS}
2666 @kindex D @key{SPC}
2667 @kindex @key{BS}
2668 @kindex @key{SPC}
2669
2670 A digest is a message that contains other messages. Special MH-E
2671 commands let you read digests conveniently. You can use @key{SPC} and
2672 @key{BS} to page through the digest as if it were a normal message,
2673 but if you wish to skip to the next message in the digest, use
2674 @kbd{D @key{SPC}} (@code{mh-page-digest}). To return to a previous message,
2675 use @kbd{D @key{BS}} (@code{mh-page-digest-backwards}).
2676
2677 @cindex @command{burst}
2678 @cindex MH commands, @command{burst}
2679 @cindex MH-Folder Show mode
2680 @cindex modes, MH-Folder Show
2681 @findex mh-burst-digest
2682 @kindex d
2683 @kindex D b
2684 @kindex t
2685
2686 Another handy command is @kbd{D b} (@code{mh-burst-digest}). This
2687 command uses the MH command @command{burst}@footnote{See the section
2688 @uref{@value{MH-BOOK-HOME}/burdig.html, Bursting Messages} in the MH
2689 book.} to break out each message in the digest into its own message.
2690 Using this command, you can quickly delete unwanted messages, like
2691 this: Once the digest is split up, toggle out of MH-Folder Show mode
2692 with @kbd{t} (@pxref{Folders}) so that the scan lines fill the screen
2693 and messages aren't displayed. Then use @kbd{d} (@pxref{Reading Mail})
2694 to quickly delete messages that you don't want to read (based on the
2695 @samp{Subject:} header field). You can also burst the digest to reply
2696 directly to the people who posted the messages in the digest. One
2697 problem you may encounter is that the @samp{From:} header fields are
2698 preceded with a @samp{>} so that your reply can't create the
2699 @samp{To:} field correctly. In this case, you must correct the
2700 @samp{To:} field yourself. This is described later (@pxref{Editing
2701 Drafts}).
2702
2703 @node Reading PGP, Printing, Digests, Reading Mail
2704 @section Signed and Encrypted Messages
2705
2706 @cindex GPG
2707 @cindex GnuPG
2708 @cindex Gnus
2709 @cindex OpenPGP
2710 @cindex PGP
2711 @cindex RFC 3156
2712 @cindex encrypted messages
2713 @cindex security
2714 @cindex signed messages
2715
2716 You can read encrypted or signed PGP or GPG messages with
2717 MH-E@footnote{This feature depends on post-5.10 versions of Gnus.
2718 @cite{MIME Security with OpenPGP} is documented in
2719 @uref{http://www.rfc-editor.org/rfc/rfc3156.txt, RFC 3156}. However,
2720 MH-E can also decrypt old-style PGP messages that are not in MIME
2721 format.}. This section assumes that you already have a good
2722 understanding of GPG and have set up your keys appropriately.
2723
2724 If someone sends you a signed message, here is what you'll see:
2725
2726 @smallexample
2727 @group
2728 [[PGP Signed Part:Bill Wohler <wohler@@stop.mail-abuse.org>]]
2729 This is a signed message.
2730
2731 [[End of PGP Signed Part]]
2732 @end group
2733 @end smallexample
2734
2735 @cindex keychain
2736 @cindex key server
2737 @cindex signed messages
2738
2739 If the key for the given signature is not in your keychain, you'll be
2740 given the opportunity to fetch the key from a key server and verify
2741 the key. If the message is really large, the verification process can
2742 take a long time. You can press @kbd{C-g} at any time to
2743 cancel@footnote{Unfortunately in the current version, the validation
2744 process doesn't display a message so it appears that MH-E has hung. We
2745 hope that this will be fixed in the future.}.
2746
2747 If the signature doesn't check out, you might see something like this:
2748
2749 @smallexample
2750 @group
2751 [[PGP Signed Part:Failed]]
2752 This is a signed message.
2753 This is garbage added after the signature was made.
2754
2755 [[End of PGP Signed Part]]
2756 @end group
2757 @end smallexample
2758
2759 @cindex decrypting messages
2760
2761 If someone sends you an encrypted message, MH-E will ask for your
2762 passphrase to decrypt the message. You should see something like this:
2763
2764 @smallexample
2765 @group
2766 [[PGP Encrypted Part:OK]]
2767
2768 [[PGP Signed Part:Bill Wohler <wohler@@stop.mail-abuse.org>]]
2769 This is the secret message.
2770
2771 [[End of PGP Signed Part]]
2772
2773 [[End of PGP Encrypted Part]]
2774 @end group
2775 @end smallexample
2776
2777 If there is a problem decrypting the message, the button will say:
2778
2779 @smallexample
2780 [[PGP Encrypted Part:Failed]]
2781 @end smallexample
2782
2783 You can read the contents of this button using the methods described in
2784 @ref{Viewing Attachments}. If the message were corrupted, you'd see
2785 this:
2786
2787 @smallexample
2788 [[PGP Encrypted Part:Failed]
2789 Invalid base64 data]
2790 @end smallexample
2791
2792 If your passphrase were incorrect, you'd see something like this:
2793
2794 @smallexample
2795 [GNUPG:] ENC_TO CD9C88BB610BD9AD 1 0
2796 [GNUPG:] USERID_HINT CD9C88BB610BD9AD Bill Wohler <wohler@@stop.mail-abuse.org>
2797 [GNUPG:] NEED_PASSPHRASE CD9C88BB610BD9AD CD9C88BB610BD9AD 1 0
2798 [GNUPG:] BAD_PASSPHRASE CD9C88BB610BD9AD
2799 gpg: encrypted with 1024-bit RSA key, ID 610BD9AD, created 1997-09-09
2800 "Bill Wohler <wohler@@stop.mail-abuse.org>"
2801 gpg: public key decryption failed: bad passphrase
2802 [GNUPG:] BEGIN_DECRYPTION
2803 [GNUPG:] DECRYPTION_FAILED
2804 gpg: decryption failed: secret key not available
2805 [GNUPG:] END_DECRYPTION
2806
2807 gpg exited abnormally: '2'
2808 @end smallexample
2809
2810 @vindex mh-show-pgg-bad
2811 @vindex mh-show-pgg-good
2812 @vindex mh-show-pgg-unknown
2813
2814 The appearance of the buttons is controlled by the faces
2815 @code{mh-show-pgg-good}, @code{mh-show-pgg-bad}, and
2816 @code{mh-show-pgg-unknown} depending on the validity of the signature.
2817 The latter is used whether the signature is unknown or untrusted.
2818
2819 @cindex @samp{pgg} customization group
2820 @cindex PGG
2821 @cindex customization group, @samp{pgg}
2822
2823 The @samp{pgg} customization group may have some settings which may
2824 interest you.
2825 @iftex
2826 See @cite{The PGG Manual}.
2827 @end iftex
2828 @ifinfo
2829 @xref{Top, , The PGG Manual, pgg, The PGG Manual}.
2830 @end ifinfo
2831 @ifhtml
2832 See
2833 @uref{http://www.dk.xemacs.org/Documentation/packages/html/pgg.html,
2834 @cite{The PGG Manual}}.
2835 @end ifhtml
2836
2837 @node Printing, Files and Pipes, Reading PGP, Reading Mail
2838 @section Printing Your Mail
2839
2840 @cindex printing
2841 @findex mh-ps-print-msg
2842 @findex mh-ps-print-msg-file
2843 @kindex P f
2844 @kindex P p
2845 @vindex mh-lpr-command-format
2846 @vindex mh-print-background-flag
2847
2848 To print messages in MH-E, use the command @kbd{P p}
2849 (@code{mh-ps-print-msg}). You can print all the messages in a range
2850 (as in @kbd{C-u P p 1 3 5-7 last:5 frombob @key{RET}},
2851 @pxref{Ranges}). You can also send the output to a file with @kbd{P f}
2852 (@code{mh-ps-print-msg-file}). This command will print inline text
2853 attachments but will not decrypt messages. However, when a message is
2854 displayed in an MH-Show buffer, then that buffer is used verbatim for
2855 printing with the caveat that only text attachments, if opened inline,
2856 are printed. Therefore, encrypted messages can be printed by showing
2857 and decrypting them first. The commands @kbd{P p} and @kbd{P f} do not
2858 use the options @code{mh-lpr-command-format} or
2859 @code{mh-print-background-flag}, described below.
2860
2861 @findex mh-ps-print-toggle-color
2862 @kindex P C
2863 @vindex ps-print-color-p
2864
2865 Colors are emulated on black-and-white printers with shades of gray.
2866 This might produce illegible output, even if your screen colors only
2867 use shades of gray. If this is the case, try using the command @kbd{P
2868 C} (@code{mh-ps-print-toggle-color}) to toggle between color, no
2869 color, and a black and white representation of the colors and see
2870 which works best. You change this setting permanently by customizing
2871 the option @code{ps-print-color-p}.
2872
2873 @findex mh-ps-print-toggle-faces
2874 @kindex P F
2875
2876 Another related function is the command @kbd{P F}
2877 (@code{mh-ps-print-toggle-faces}). This command toggles between using
2878 faces and not. When faces are enabled, the printed message will look
2879 very similar to the message in the MH-Show buffer.
2880
2881 @cindex ps-print package
2882 @cindex Emacs, packages, ps-print
2883
2884 MH-E uses the @samp{ps-print} package to do the printing, so you can
2885 customize the printing further by going to the @samp{ps-print}
2886 customization group.
2887
2888 @cindex @command{lpr}
2889 @cindex @command{mhl}
2890 @cindex MH commands, @command{mhl}
2891 @cindex Unix commands, @command{lpr}
2892 @findex mh-print-msg
2893 @kindex P l
2894
2895 An alternative to using the @samp{ps-print} package is the command
2896 @kbd{P l} (@code{mh-print-msg}) (the @i{l} is for @i{l}ine printer or
2897 @i{l}pr). You can print all the messages in a range. The message is
2898 formatted with @command{mhl}@footnote{See the section
2899 @uref{@value{MH-BOOK-HOME}/shomes.html#Usisho, Using mhl} in the MH
2900 book.} and printed with the @command{lpr} command.
2901
2902 @kindex P f
2903 @kindex P l
2904 @kindex P p
2905 @vindex mh-lpr-command-format
2906 @vindex mh-print-background-flag
2907
2908 The command @kbd{P l} uses two options. The option
2909 @code{mh-lpr-command-format} contains the Unix command line which
2910 performs the actual printing. The string can contain one escape,
2911 @samp{%s}, which is replaced by the name of the folder and the message
2912 number and is useful for print job names. The default setting is
2913 @code{"lpr -J '%s'"}. I use @code{"mpage -h'%s' -b Letter -H1of -mlrtb
2914 -P"} which produces a nice header and adds a bit of margin so the text
2915 fits within my printer's margins. Normally messages are printed in the
2916 foreground. If this is slow on your system, you may elect to turn on
2917 the option @code{mh-print-background-flag} to print in the background.
2918 If you do this, do not delete the message until it is printed or else
2919 the output may be truncated. These options are not used by the
2920 commands @kbd{P p} or @kbd{P f}.
2921
2922 @node Files and Pipes, Navigating, Printing, Reading Mail
2923 @section Files and Pipes
2924
2925 @cindex files
2926 @cindex pipes
2927 @findex mh-refile-or-write-again
2928 @findex mh-write-msg-to-file
2929 @kindex >
2930 @kindex !
2931
2932 MH-E does offer a couple of commands that are not a part of MH@. The
2933 first one, @kbd{>} (@code{mh-write-msg-to-file}), writes a message to
2934 a file. You are prompted for the filename. If the file already exists,
2935 the message is appended to it. You can also write the message to the
2936 file without the header by specifying a prefix argument (such as
2937 @kbd{C-u > /tmp/foobar @key{RET}}). Subsequent writes to the same file
2938 can be made with the command @kbd{!}
2939 (@code{mh-refile-or-write-again}).
2940
2941 @findex mh-pipe-msg
2942 @kindex |
2943 @kindex l
2944
2945 You can also pipe the message through a Unix shell command with the
2946 command @kbd{|} (@code{mh-pipe-msg}). You are prompted for the Unix
2947 command through which you wish to run your message. If you give a
2948 prefix argument to this command, the message header is included in the
2949 text passed to the command (the contrived example @kbd{C-u | lpr}
2950 would be done with the @kbd{l} command instead).
2951
2952 @cindex @command{shar}
2953 @cindex @command{uuencode}
2954 @cindex Unix commands, @command{shar}
2955 @cindex Unix commands, @command{uuencode}
2956 @findex mh-store-msg
2957 @kindex X s
2958 @vindex mh-store-default-directory
2959
2960 If the message is a shell archive @command{shar} or has been run
2961 through @command{uuencode} use @kbd{X s} (@code{mh-store-msg}) to
2962 extract the body of the message. The default directory for extraction
2963 is the current directory; however, you have a chance to specify a
2964 different extraction directory. The next time you use this command,
2965 the default directory is the last directory you used. If you would
2966 like to change the initial default directory, customize the option
2967 @code{mh-store-default-directory}, change the value from
2968 @samp{Current} to @samp{Directory}, and then enter the name of the
2969 directory for storing the content of these messages.
2970
2971 @findex mh-store-buffer
2972 @kindex @key{RET}
2973 @kindex X s
2974
2975 By the way, @kbd{X s} calls the Emacs Lisp function
2976 @code{mh-store-buffer}. I mention this because you can use it directly
2977 if you're editing a buffer that contains a file that has been run
2978 through @command{uuencode} or @command{shar}. For example, you can
2979 extract the contents of the current buffer in your home directory by
2980 typing @kbd{M-x mh-store-buffer @key{RET} ~ @key{RET}}.
2981
2982 @node Navigating, Miscellaneous Commands and Options, Files and Pipes, Reading Mail
2983 @section Navigating
2984
2985 @cindex moving between messages
2986 @cindex navigation
2987 @findex mh-first-msg
2988 @findex mh-goto-msg
2989 @findex mh-last-msg
2990 @findex mh-next-undeleted-msg
2991 @findex mh-next-unread-msg
2992 @findex mh-previous-undeleted-msg
2993 @findex mh-previous-unread-msg
2994 @kindex g
2995 @kindex M-<
2996 @kindex M->
2997 @kindex M-n
2998 @kindex M-p
2999 @kindex n
3000 @kindex p
3001
3002 To move on to the next message, use the command @kbd{n}
3003 (@code{mh-next-undeleted-msg}); use @kbd{p}
3004 (@code{mh-previous-undeleted-msg}) to read the previous message. To
3005 move to the next unread message, use @kbd{M-n}
3006 (@code{mh-next-unread-msg}); use @kbd{M-p}
3007 (@code{mh-previous-unread-msg}) to move to the previous unread
3008 message. These commands can be given a prefix argument to specify how
3009 many messages to skip (for example, @kbd{5 n}). You can also move to a
3010 specific message with @kbd{g} (@code{mh-goto-msg}). You can enter the
3011 message number either before or after typing @kbd{g}. In the latter
3012 case, Emacs prompts you. Finally, you can go to the first or last
3013 message with @kbd{M-<} (@code{mh-first-msg}) and @kbd{M->}
3014 (@code{mh-last-msg}) respectively.
3015
3016 @cindex MH-Folder mode
3017 @cindex modes, MH-Folder
3018 @findex next-line
3019 @findex previous-line
3020 @kindex C-n
3021 @kindex C-p
3022 @kindex @key{RET}
3023
3024 You can also use the Emacs commands @kbd{C-p} (@code{previous-line})
3025 and @kbd{C-n} (@code{next-line}) to move up and down the scan lines in
3026 the MH-Folder window. These commands can be used in conjunction with
3027 @key{RET} to look at deleted or refiled messages.
3028
3029 @cindex deleting messages
3030 @findex mh-delete-msg
3031 @kindex d
3032 @kindex n
3033 @kindex p
3034
3035 To mark a message for deletion, use the command @kbd{d}
3036 (@code{mh-delete-msg}). A @samp{D} is placed by the message in the
3037 scan window, and the next undeleted message is displayed. If the
3038 previous command had been @kbd{p}, then the next message displayed is
3039 the first undeleted message previous to the message just deleted. Use
3040 @kbd{n} to force subsequent @kbd{d} commands to move forward to the
3041 next undeleted message after deleting the message under the cursor.
3042 You may also specify a range (for example, @kbd{C-u d 1 3 5-7 last:5
3043 frombob @key{RET}}, @pxref{Ranges}).
3044
3045 @findex mh-delete-msg-no-motion
3046 @kindex C-d
3047
3048 The command @kbd{C-d} (@code{mh-delete-msg-no-motion}) marks the
3049 message (or messages in range) for deletion but leaves the cursor at
3050 the current message in case you wish to perform other operations on
3051 the message.
3052
3053 @findex mh-delete-subject
3054 @findex mh-delete-subject-or-thread
3055 @findex mh-thread-delete
3056 @findex mh-undo
3057 @kindex k
3058 @kindex T d
3059 @kindex u
3060
3061 And to delete more messages faster, you can use @kbd{k}
3062 (@code{mh-delete-subject-or-thread}) to delete all the messages with
3063 the same subject as the current message. This command puts these
3064 messages in a sequence named @samp{subject}. You can undo this action
3065 by using @kbd{u} (@code{mh-undo}) with a prefix argument and then
3066 specifying the @samp{subject} sequence. However, if the buffer is
3067 displaying a threaded view of the folder then @kbd{k} behaves like
3068 @kbd{T d} (@code{mh-thread-delete}). @xref{Threading}.
3069
3070 @findex mh-execute-commands
3071 @kindex x
3072
3073 However you mark a message for deletion, the command @kbd{x}
3074 (@code{mh-execute-commands}) actually carries out the deletion
3075 (@pxref{Folders}).
3076
3077 @vindex mh-delete-msg-hook
3078
3079 The hook @code{mh-delete-msg-hook} is called after you mark a message
3080 for deletion. For example, a past maintainer of MH-E used this once
3081 when he kept statistics on his mail usage.
3082
3083 @node Miscellaneous Commands and Options, , Navigating, Reading Mail
3084 @section Miscellaneous Commands and Options
3085
3086 This section contains a few more miscellaneous commands and options.
3087
3088 @cindex editing message
3089 @findex mh-modify
3090 @kindex M
3091
3092 There are times when you need to edit a message. For example, you may
3093 need to fix a broken Content-Type header field. You can do this with
3094 the command @kbd{M} (@code{mh-modify}). It displays the raw message in
3095 an editable buffer. When you are done editing, save and kill the
3096 buffer as you would any other.
3097
3098 @findex mh-kill-folder
3099 @findex mh-pack-folder
3100 @vindex mh-do-not-confirm-flag
3101
3102 Commands such as @code{mh-pack-folder} prompt to confirm whether to
3103 process outstanding moves and deletes or not before continuing.
3104 Turning on the option @code{mh-do-not-confirm-flag} means that these
3105 actions will be performed---which is usually desired but cannot be
3106 retracted---without question@footnote{In previous versions of MH-E,
3107 this option suppressed the confirmation in @code{mh-kill-folder}.
3108 Since this kept most users from setting this option,
3109 @code{mh-kill-folder} was modified in version 6.0 to always ask for
3110 confirmation subject to @code{mh-kill-folder-suppress-prompt-hook}.
3111 @xref{Folders}.}.
3112
3113 @cindex MH-Folder mode
3114 @cindex modes, MH-Folder
3115 @vindex mh-summary-height
3116
3117 The option @code{mh-summary-height} controls the number of scan lines
3118 displayed in the MH-Folder window, including the mode line. The
3119 default value of this option is @samp{Automatic} which means that the
3120 MH-Folder buffer will maintain the same proportional size if the frame
3121 is resized. If you'd prefer a fixed height, then choose the
3122 @samp{Fixed Size} option and enter the number of lines you'd like to
3123 see.
3124
3125 @vindex mh-bury-show-buffer-flag
3126
3127 Normally the buffer for displaying messages is buried at the bottom at
3128 the buffer stack. You may wish to disable this feature by turning off
3129 the option @code{mh-bury-show-buffer-flag}. One advantage of not
3130 burying the show buffer is that one can delete the show buffer more
3131 easily in an electric buffer list because of its proximity to its
3132 associated MH-Folder buffer. Try running @kbd{M-x
3133 electric-buffer-list} to see what I mean.
3134
3135 @cindex @file{.emacs}
3136 @cindex files, @file{.emacs}
3137 @cindex reading mail
3138
3139 Before we leave this section, I'll include a function that I use as a
3140 front end to MH-E@footnote{Stephen Gildea's favorite binding is
3141 @kbd{(global-set-key "\C-cr" 'mh-rmail)}.}. It toggles between your
3142 working window configuration, which may be quite involved---windows
3143 filled with source, compilation output, man pages, and other
3144 documentation---and your MH-E window configuration. Like the rest of
3145 the customization described in this section, simply add the following
3146 code to @file{~/.emacs}.
3147
3148 @iftex
3149 @filbreak
3150 @end iftex
3151
3152 @findex mh-rmail, example
3153
3154 @smalllisp
3155 @group
3156 (defvar my-mh-screen-saved nil
3157 "Set to non-@code{nil} when MH-E window configuration shown.")
3158 (defvar my-normal-screen nil "Normal window configuration.")
3159 (defvar my-mh-screen nil "MH-E window configuration.")
3160
3161 (defun my-mh-rmail (&optional arg)
3162 "Toggle between MH-E and normal screen configurations.
3163 With non-@code{nil} or prefix argument, @i{inc} mailbox as well
3164 when going into mail."
3165 (interactive "P") ; @r{user callable function, P=prefix arg}
3166 (setq my-mh-screen-saved ; @r{save state}
3167 (cond
3168 ;; @r{Bring up MH-E screen if arg or normal window configuration.}
3169 ;; @r{If arg or +inbox buffer doesn't exist, run mh-rmail.}
3170 ((or arg (null my-mh-screen-saved))
3171 (setq my-normal-screen (current-window-configuration))
3172 (if (or arg (null (get-buffer "+inbox")))
3173 (mh-rmail)
3174 (set-window-configuration my-mh-screen))
3175 t) ; @r{set my-mh-screen-saved to @code{t}}
3176 ;; @r{Otherwise, save MH-E screen and restore normal screen.}
3177 (t
3178 (setq my-mh-screen (current-window-configuration))
3179 (set-window-configuration my-normal-screen)
3180 nil)))) ; @r{set my-mh-screen-saved to nil}
3181
3182 (global-set-key "\C-x\r" 'my-mh-rmail) ;@r{ call with C-x @key{RET}}
3183
3184 @i{Starting MH-E}
3185
3186 @end group
3187 @end smalllisp
3188
3189 If you type an argument (@kbd{C-u}) or if @code{my-mh-screen-saved} is
3190 @code{nil} (meaning a non-MH-E window configuration), the current
3191 window configuration is saved, either the @samp{+inbox} buffer is
3192 displayed or @code{mh-rmail} is run, and the MH-E window configuration
3193 is shown. Otherwise, the MH-E window configuration is saved and the
3194 original configuration is displayed.
3195
3196 @node Folders, Sending Mail, Reading Mail, Top
3197 @chapter Organizing Your Mail with Folders
3198
3199 @cindex @samp{Folder} menu
3200 @cindex @samp{Message} menu
3201 @cindex folders
3202 @cindex menu, @samp{Folder}
3203 @cindex menu, @samp{Message}
3204 @cindex using folders
3205
3206 This chapter discusses the things you can do with folders within MH-E.
3207 The commands in this chapter are also found in the @samp{Folder} and
3208 @samp{Message} menus.
3209
3210 @table @kbd
3211 @kindex ?
3212 @findex mh-help
3213 @item ?
3214 Display cheat sheet for the MH-E commands (@code{mh-help}).
3215 @c -------------------------
3216 @kindex !
3217 @findex mh-refile-or-write-again
3218 @item !
3219 Repeat last output command (@code{mh-refile-or-write-again}).
3220 @c -------------------------
3221 @cindex @samp{Message > Copy Message to Folder...} menu item
3222 @cindex menu item, @samp{Message > Copy Message to Folder...}
3223 @kindex c
3224 @findex mh-copy-msg
3225 @item c
3226 Copy range to folder (@code{mh-copy-msg}).
3227 @c -------------------------
3228 @kindex F ?
3229 @findex mh-prefix-help
3230 @item F ?
3231 Display cheat sheet for the commands of the current prefix in
3232 minibuffer (@code{mh-prefix-help}).
3233 @c -------------------------
3234 @kindex F '
3235 @findex mh-index-ticked-messages
3236 @item F '
3237 Display ticked messages (@code{mh-index-ticked-messages}).
3238 @c -------------------------
3239 @kindex F c
3240 @findex mh-catchup
3241 @item F c
3242 Delete range from the @samp{unseen} sequence (@code{mh-catchup}).
3243 @c -------------------------
3244 @kindex F k
3245 @findex mh-kill-folder
3246 @item F k
3247 Remove folder (@code{mh-kill-folder}).
3248 @c -------------------------
3249 @cindex @samp{Folder > List Folders} menu item
3250 @cindex menu item, @samp{Folder > List Folders}
3251 @kindex F l
3252 @findex mh-list-folders
3253 @item F l
3254 List all folders (@code{mh-list-folders}).
3255 @c -------------------------
3256 @cindex @samp{Folder > View New Messages} menu item
3257 @cindex menu item, @samp{Folder > View New Messages}
3258 @kindex F n
3259 @findex mh-index-new-messages
3260 @item F n
3261 Display unseen messages (@code{mh-index-new-messages}).
3262 @c -------------------------
3263 @cindex @samp{Folder > Pack Folder} menu item
3264 @cindex menu item, @samp{Folder > Pack Folder}
3265 @kindex F p
3266 @findex mh-pack-folder
3267 @item F p
3268 Pack folder (@code{mh-pack-folder}).
3269 @c -------------------------
3270 @kindex F q
3271 @findex mh-index-sequenced-messages
3272 @item F q
3273 Display messages in any sequence (@code{mh-index-sequenced-messages}).
3274 @c -------------------------
3275 @cindex @samp{Folder > Rescan Folder} menu item
3276 @cindex menu item, @samp{Folder > Rescan Folder}
3277 @kindex F r
3278 @findex mh-rescan-folder
3279 @item F r
3280 Rescan folder (@code{mh-rescan-folder}).
3281 @c -------------------------
3282 @cindex @samp{Folder > Search...} menu item
3283 @cindex menu item, @samp{Folder > Search...}
3284 @kindex F s
3285 @findex mh-search
3286 @item F s
3287 Search your MH mail (@code{mh-search}).
3288 @c -------------------------
3289 @cindex @samp{Folder > Sort Folder} menu item
3290 @cindex menu item, @samp{Folder > Sort Folder}
3291 @kindex F S
3292 @findex mh-sort-folder
3293 @item F S
3294 Sort folder (@code{mh-sort-folder}).
3295 @c -------------------------
3296 @kindex F u
3297 @findex mh-undo-folder
3298 @item F u
3299 Undo all refiles and deletes in the current folder (@code{mh-undo-folder}).
3300 @c -------------------------
3301 @cindex @samp{Folder > Visit a Folder...} menu item
3302 @cindex menu item, @samp{Folder > Visit a Folder...}
3303 @kindex F v
3304 @findex mh-visit-folder
3305 @item F v
3306 Visit folder (@code{mh-visit-folder}).
3307 @c -------------------------
3308 @cindex @samp{Message > Refile Message} menu item
3309 @cindex menu item, @samp{Message > Refile Message}
3310 @kindex o
3311 @findex mh-refile-msg
3312 @item o
3313 Refile (output) range into folder (@code{mh-refile-msg}).
3314 @c -------------------------
3315 @cindex @samp{Folder > Quit MH-E} menu item
3316 @cindex menu item, @samp{Folder > Quit MH-E}
3317 @kindex q
3318 @findex mh-quit
3319 @item q
3320 Quit the current MH-E folder (@code{mh-quit}).
3321 @c -------------------------
3322 @cindex @samp{Folder > Toggle Show/Folder} menu item
3323 @cindex menu item, @samp{Folder > Toggle Show/Folder}
3324 @kindex t
3325 @findex mh-toggle-showing
3326 @item t
3327 Toggle between MH-Folder and MH-Folder Show modes
3328 (@code{mh-toggle-showing}).
3329 @c -------------------------
3330 @cindex @samp{Message > Undo Delete/Refile} menu item
3331 @cindex menu item, @samp{Message > Undo Delete/Refile}
3332 @kindex u
3333 @findex mh-undo
3334 @item u
3335 Undo pending deletes or refiles in range (@code{mh-undo}).
3336 @c -------------------------
3337 @cindex @samp{Message > Execute Delete/Refile} menu item
3338 @cindex menu item, @samp{Message > Execute Delete/Refile}
3339 @kindex x
3340 @findex mh-execute-commands
3341 @item x
3342 Process outstanding delete and refile requests
3343 (@code{mh-execute-commands}).
3344 @end table
3345
3346 @cindex @samp{mh-folder} customization group
3347 @cindex customization group, @samp{mh-folder}
3348
3349 The @samp{mh-folder} customization group is used to tune these
3350 commands.
3351
3352 @vtable @code
3353 @item mh-new-messages-folders
3354 Folders searched for the @samp{unseen} sequence (default:
3355 @code{Inbox}).
3356 @c -------------------------
3357 @item mh-ticked-messages-folders
3358 Folders searched for @code{mh-tick-seq} (default: @code{t}).
3359 @c -------------------------
3360 @item mh-large-folder
3361 The number of messages that indicates a large folder (default: 200).
3362 @c -------------------------
3363 @item mh-recenter-summary-flag
3364 On means to recenter the summary window (default: @samp{off}).
3365 @c -------------------------
3366 @item mh-recursive-folders-flag
3367 On means that commands which operate on folders do so recursively
3368 (default: @samp{off}).
3369 @c -------------------------
3370 @item mh-sortm-args
3371 Additional arguments for @command{sortm} (default: @code{nil}).
3372 @end vtable
3373
3374 The following hooks are available.
3375
3376 @vtable @code
3377 @item mh-after-commands-processed-hook
3378 Hook run by @kbd{x} after performing outstanding refile and delete
3379 requests (default: @code{nil}).
3380 @c -------------------------
3381 @item mh-before-commands-processed-hook
3382 Hook run by @kbd{x} before performing outstanding refile and delete
3383 requests (default: @code{nil}).
3384 @c -------------------------
3385 @item mh-before-quit-hook
3386 Hook run by q before quitting MH-E (default: @code{nil}).
3387 @c -------------------------
3388 @item mh-folder-mode-hook
3389 Hook run by @code{mh-folder-mode} when visiting a new folder (default:
3390 @code{nil}).
3391 @c -------------------------
3392 @item mh-kill-folder-suppress-prompt-hook
3393 Abnormal hook run at the beginning of @code{mh-kill-folder} (default:
3394 @code{'mh-search-p}).
3395 @c -------------------------
3396 @item mh-quit-hook
3397 Hook run by q after quitting MH-E (default: @code{nil}).
3398 @c -------------------------
3399 @item mh-refile-msg-hook
3400 Hook run by o after marking each message for refiling (default:
3401 @code{nil}).
3402 @end vtable
3403
3404 The following faces are available for customizing the appearance of
3405 the MH-Folder buffer. @xref{Scan Line Formats}.
3406
3407 @vtable @code
3408 @item mh-folder-address
3409 Recipient face.
3410 @c -------------------------
3411 @item mh-folder-body
3412 Body text face.
3413 @c -------------------------
3414 @item mh-folder-cur-msg-number
3415 Current message number face.
3416 @c -------------------------
3417 @item mh-folder-date
3418 Date face.
3419 @c -------------------------
3420 @item mh-folder-deleted
3421 Deleted message face.
3422 @c -------------------------
3423 @item mh-folder-followup
3424 @samp{Re:} face.
3425 @c -------------------------
3426 @item mh-folder-msg-number
3427 Message number face.
3428 @c -------------------------
3429 @item mh-folder-refiled
3430 Refiled message face.
3431 @c -------------------------
3432 @vindex mh-scan-format-nmh
3433 @vindex mh-scan-sent-to-me-sender-regexp
3434 @item mh-folder-sent-to-me-hint
3435 Fontification hint face in messages sent directly to us. The detection
3436 of messages sent to us is governed by the scan format
3437 @code{mh-scan-format-nmh} and regular expression
3438 @code{mh-scan-sent-to-me-sender-regexp}.
3439 @c -------------------------
3440 @vindex mh-scan-format-nmh
3441 @vindex mh-scan-sent-to-me-sender-regexp
3442 @item mh-folder-scan-format
3443 Sender face in messages sent directly to us. The detection of messages
3444 sent to us is governed by the scan format @code{mh-scan-format-nmh}
3445 and regular expression @code{mh-scan-sent-to-me-sender-regexp}.
3446 @c -------------------------
3447 @item mh-folder-subject
3448 Subject face.
3449 @c -------------------------
3450 @item mh-folder-tick
3451 Ticked message face.
3452 @c -------------------------
3453 @item mh-folder-to
3454 @samp{To:} face.
3455 @end vtable
3456
3457 @vindex mh-folder-mode-hook
3458
3459 The hook @code{mh-folder-mode-hook} is called when visiting a new
3460 folder in MH-Folder mode. This could be used to set your own key
3461 bindings, for example:
3462
3463 @vindex mh-folder-mode-hook, example
3464
3465 @smalllisp
3466 @group
3467 (defvar my-mh-init-done nil
3468 "Non-@code{nil} when one-time MH-E settings made.")
3469
3470 (defun my-mh-folder-mode-hook ()
3471 "Hook to set key bindings in MH-Folder mode."
3472 (if (not my-mh-init-done) ; @r{only need to bind the keys once }
3473 (progn
3474 (local-set-key "//" 'my-search-msg)
3475 (local-set-key "b" 'mh-burst-digest) ; @r{better use of @kbd{b}}
3476 (setq my-mh-init-done t))))
3477
3478 (add-hook 'mh-folder-mode-hook 'my-mh-folder-mode-hook)
3479
3480 (defun my-search-msg ()
3481 "Search for a regexp in the current message."
3482 (interactive) ; @r{user function}
3483 (save-window-excursion
3484 (other-window 1) ; @r{go to next window}
3485 (isearch-forward-regexp))) ; @r{string search; hit return}
3486 ; @r{ when done}
3487
3488 @i{Create additional key bindings via mh-folder-mode-hook}
3489
3490 @end group
3491 @end smalllisp
3492
3493 @cindex @command{folder}
3494 @cindex @command{refile}
3495 @cindex MH commands, @command{folder}
3496 @cindex MH commands, @command{refile}
3497 @findex mh-refile-msg
3498 @kindex o
3499 @vindex mh-refile-msg-hook
3500
3501 MH-E has analogies for each of the MH @command{folder} and
3502 @command{refile} commands@footnote{See the sections
3503 @uref{@value{MH-BOOK-HOME}/fol.html#Youfol, Your Current Folder:
3504 folder} and @uref{@value{MH-BOOK-HOME}/fol.html#Movref, Moving and
3505 Linking Messages: refile} in the MH book.}. To refile a message in
3506 another folder, use the command @kbd{o} (@code{mh-refile-msg})
3507 (mnemonic: ``output''). You are prompted for the folder name
3508 (@pxref{Folder Selection}). Note that this command can also be used to
3509 create folders. If you specify a folder that does not exist, you will
3510 be prompted to create it. The hook @code{mh-refile-msg-hook} is called
3511 after a message is marked to be refiled.
3512
3513 @findex mh-write-msg-to-file
3514 @kindex !
3515
3516 If you are refiling several messages into the same folder, you can use
3517 the command @kbd{!} (@code{mh-refile-or-write-again}) to repeat the
3518 last refile or write (for the description of @kbd{>}
3519 (@code{mh-write-msg-to-file}), @pxref{Files and Pipes}). You can use a
3520 range in either case (for example, @kbd{C-u o 1 3 5-7 last:5 frombob
3521 @key{RET}}, @pxref{Ranges}).
3522
3523 @cindex expunging refiles and deletes
3524 @cindex undoing refiles and deletes
3525 @findex mh-undo
3526 @kindex u
3527
3528 If you've deleted a message or refiled it, but changed your mind, you
3529 can cancel the action before you've executed it. Use @kbd{u}
3530 (@code{mh-undo}) to undo a refile on or deletion of a single message.
3531 You can also undo refiles and deletes for messages that are found in a
3532 given range (@pxref{Ranges}).
3533
3534 @findex mh-undo-folder
3535 @kindex F u
3536
3537 Alternatively, you can use @kbd{F u} (@code{mh-undo-folder}) to undo
3538 all refiles and deletes in the current folder.
3539
3540 @findex mh-execute-commands
3541 @kindex x
3542
3543 If you've marked messages to be deleted or refiled and you want to go
3544 ahead and delete or refile the messages, use @kbd{x}
3545 (@code{mh-execute-commands}). Many MH-E commands that may affect the
3546 numbering of the messages (such as @kbd{F r} or @kbd{F p}) will ask if
3547 you want to process refiles or deletes first and then either run
3548 @kbd{x} for you or undo the pending refiles and deletes.
3549
3550 @kindex x
3551 @vindex mh-after-commands-processed-hook
3552 @vindex mh-before-commands-processed-hook
3553
3554 The command @kbd{x} runs @code{mh-before-commands-processed-hook}
3555 before the commands are processed and
3556 @code{mh-after-commands-processed-hook} after the commands are
3557 processed. Variables that are useful with the former hook include
3558 @code{mh-delete-list} and @code{mh-refile-list} which can be used to
3559 see which changes will be made to the current folder,
3560 @code{mh-current-folder}. Variables that are useful with the latter
3561 hook include @code{mh-folders-changed}, which lists which folders were
3562 affected by deletes and refiles. This list will always include the
3563 current folder @code{mh-current-folder}.
3564
3565 @findex mh-copy-msg
3566 @kindex c
3567 @kindex o
3568
3569 If you wish to copy a message to another folder, you can use the
3570 command @kbd{c} (@code{mh-copy-msg}) (see the @option{-link} argument
3571 to @command{refile}(1)). Like the command @kbd{o}, this command
3572 prompts you for the name of the target folder and you can specify a
3573 range (@pxref{Ranges}). Note that unlike the command @kbd{o}, the copy
3574 takes place immediately. The original copy remains in the current
3575 folder.
3576
3577 @cindex junk mail
3578 @cindex MH-Folder mode
3579 @cindex MH-Folder Show mode
3580 @cindex modes, MH-Folder
3581 @cindex modes, MH-Folder Show
3582 @cindex spam
3583 @findex mh-toggle-showing
3584 @kindex t
3585
3586 The command @kbd{t} (@code{mh-toggle-showing}) switches between
3587 MH-Folder mode and MH-Folder Show mode@footnote{For you Emacs wizards,
3588 this is implemented as an Emacs minor mode.}. MH-Folder mode turns off
3589 the associated show buffer so that you can perform operations on the
3590 messages quickly without reading them. This is an excellent way to
3591 prune out your junk mail or to refile a group of messages to another
3592 folder for later examination.
3593
3594 @cindex MH-Folder mode
3595 @cindex MH-Show mode
3596 @cindex modes, MH-Folder
3597 @cindex modes, MH-Show
3598 @cindex moving between messages
3599 @kindex t
3600 @vindex mh-recenter-summary-flag
3601
3602 When you use @kbd{t} to toggle from MH-Folder Show mode to MH-Folder
3603 mode, the MH-Show buffer is hidden and the MH-Folder buffer is left
3604 alone. Setting @code{mh-recenter-summary-flag} to a non-@code{nil}
3605 value causes the toggle to display as many scan lines as possible,
3606 with the cursor at the middle. The effect of
3607 @code{mh-recenter-summary-flag} is rather useful, but it can be
3608 annoying on a slow network connection.
3609
3610 @findex mh-visit-folder
3611 @kindex F v
3612 @vindex mh-large-folder
3613
3614 When you want to read the messages that you have refiled into folders,
3615 use the command @kbd{F v} (@code{mh-visit-folder}) to visit the
3616 folder. You are prompted for the folder name. The folder buffer will
3617 show just unseen messages if there are any; otherwise, it will show
3618 all the messages in the buffer as long there are fewer than
3619 @code{mh-large-folder} messages. If there are more, then you are
3620 prompted for a range of messages to scan. You can provide a prefix
3621 argument in order to specify a range of messages to show when you
3622 visit the folder (@pxref{Ranges}). In this case, regions are not used
3623 to specify the range and @code{mh-large-folder} is ignored. Note that
3624 this command can also be used to create folders. If you specify a
3625 folder that does not exist, you will be prompted to create it.
3626
3627 @findex mh-search
3628 @kindex F s
3629
3630 If you forget where you've refiled your messages, you can find them
3631 using @kbd{F s} (@code{mh-search}). @xref{Searching}.
3632
3633 @cindex @command{procmail}
3634 @cindex @samp{unseen} sequence
3635 @cindex sequence, @samp{unseen}
3636 @cindex Unix commands, @command{procmail}
3637 @cindex unseen messages, viewing
3638 @findex mh-index-new-messages
3639 @kindex F n
3640 @vindex mh-new-messages-folders
3641
3642 If you use a program such as @command{procmail} to file your incoming
3643 mail automatically, you can display new, unseen, messages using the
3644 command @kbd{F n} (@code{mh-index-new-messages}). All messages in the
3645 @samp{unseen} sequence from the folders in
3646 @code{mh-new-messages-folders} are listed. However, this list of
3647 folders can be overridden with a prefix argument: with a prefix
3648 argument, enter a space-separated list of folders, or nothing to
3649 search all folders.
3650
3651 @cindex @samp{tick} sequence
3652 @cindex sequence, @samp{tick}
3653 @cindex ticked messages, viewing
3654 @findex mh-index-ticked-messages
3655 @kindex F '
3656 @vindex mh-ticked-messages-folders
3657
3658 If you have ticked messages (@pxref{Sequences}), you can display them
3659 using the command @kbd{F '} (@code{mh-index-ticked-messages}). All
3660 messages in the @samp{tick} sequence from the folders in
3661 @code{mh-ticked-messages-folders} are listed. With a prefix argument,
3662 enter a space-separated list of folders, or nothing to search all
3663 folders.
3664
3665 @findex mh-index-sequenced-messages
3666 @kindex F q
3667 @vindex mh-new-messages-folders
3668
3669 You can display messages in any sequence with the command @kbd{F q}
3670 (@code{mh-index-sequenced-messages}). All messages from the folders in
3671 @code{mh-new-messages-folders} in the sequence you provide are listed.
3672 With a prefix argument, enter a space-separated list of folders at the
3673 prompt, or nothing to search all folders.
3674
3675 @vindex mh-new-messages-folders
3676 @vindex mh-recursive-folders-flag
3677 @vindex mh-ticked-messages-folders
3678
3679 Set the options @code{mh-new-messages-folders} and
3680 @code{mh-ticked-messages-folders} to @samp{Inbox} to search the
3681 @samp{+inbox} folder or @samp{All} to search all of the top level
3682 folders. Otherwise, list the folders that should be searched with the
3683 @samp{Choose Folders} menu item. See @code{mh-recursive-folders-flag}.
3684
3685 @cindex buffers, @samp{*MH-E Folders*}
3686 @cindex @samp{*MH-E Folders*}
3687 @findex mh-kill-folder
3688 @findex mh-list-folders
3689 @findex mh-pack-folder
3690 @findex mh-rescan-folder
3691 @findex mh-sort-folder
3692 @kindex F k
3693 @kindex F l
3694 @kindex F p
3695 @kindex F r
3696 @kindex F S
3697
3698 Other commands you can perform on folders include: @kbd{F l}
3699 (@code{mh-list-folders}), to place a listing of all the folders in
3700 your mail directory in a buffer called @samp{*MH-E Folders*}
3701 (@pxref{Miscellaneous}); @kbd{F k} (@code{mh-kill-folder}), to remove
3702 a folder; @kbd{F S} (@code{mh-sort-folder}), to sort the messages by
3703 date (see @command{sortm}(1) to see how to sort by other criteria);
3704 @kbd{F p} (@code{mh-pack-folder}), to pack a folder, removing gaps
3705 from the numbering sequence; and @kbd{F r} (@code{mh-rescan-folder}),
3706 to rescan the folder, which is useful to grab all messages in your
3707 @samp{+inbox} after processing your new mail for the first time. If
3708 you don't want to rescan the entire folder, the commands @kbd{F r} or
3709 @kbd{F p} will accept a range (@pxref{Ranges}).
3710
3711 @kindex @key{TAB}
3712 @vindex mh-recursive-folders-flag
3713
3714 By default, operations on folders work only one level at a time. Set
3715 @code{mh-recursive-folders-flag} to non-@code{nil} to operate on all
3716 folders. This mostly means that you'll be able to see all your folders
3717 when you press @key{TAB} when prompted for a folder name.
3718
3719 @findex mh-search-p
3720 @kindex k
3721 @vindex mh-kill-folder-suppress-prompt-hooks
3722
3723 The hook @code{mh-kill-folder-suppress-prompt-hooks} is an abnormal
3724 hook run at the beginning of the command @kbd{k}. The hook functions
3725 are called with no arguments and should return a non-nil value to
3726 suppress the normal prompt when you remove a folder. This is useful
3727 for folders that are easily regenerated. The default value of
3728 @code{mh-search-p} suppresses the prompt on folders generated by
3729 searching.
3730
3731 @sp 1
3732 @center @strong{NOTE}
3733
3734 @quotation
3735 Use this hook with care. If there is a bug in your hook which returns
3736 @code{t} on @samp{+inbox} and you press @kbd{k} by accident in the
3737 @code{+inbox} folder, you will not be happy.
3738 @end quotation
3739 @sp 1
3740
3741 @cindex @command{sortm}
3742 @cindex @file{.mh_profile}
3743 @cindex files, @file{.mh_profile}
3744 @cindex MH commands, @command{sortm}
3745 @cindex MH profile component, @samp{sortm:}
3746 @cindex @samp{sortm:} MH profile component
3747 @kindex F S
3748 @vindex mh-sortm-args
3749
3750 The option @code{mh-sortm-args} holds extra arguments to pass on to
3751 the command @command{sortm}@footnote{See the section
3752 @uref{@value{MH-BOOK-HOME}/sorsor.html, Sorting Messages: sortm} in the
3753 MH book.} when a prefix argument is used with @kbd{F S}. Normally
3754 default arguments to @command{sortm} are specified in the MH profile.
3755 This option may be used to provide an alternate view. For example,
3756 @samp{'(\"-nolimit\" \"-textfield\" \"subject\")} is a useful setting.
3757
3758 @cindex exiting
3759 @cindex quitting
3760 @findex mh-quit
3761 @kindex q
3762
3763 When you want to quit using MH-E and go back to editing, you can use
3764 the @kbd{q} (@code{mh-quit}) command. This buries the buffers of the
3765 current MH-E folder and restores the buffers that were present when
3766 you first ran @kbd{M-x mh-rmail}. It also removes any MH-E working
3767 buffers whose name begins with @samp{ *mh-} or @samp{*MH-E }
3768 (@pxref{Miscellaneous}). You can later restore your MH-E session by
3769 selecting the @samp{+inbox} buffer or by running @kbd{M-x mh-rmail}
3770 again.
3771
3772 @findex mh-execute-commands
3773 @kindex q
3774 @vindex mh-before-quit-hook
3775 @vindex mh-before-quit-hook, example
3776 @vindex mh-quit-hook
3777 @vindex mh-quit-hook, example
3778
3779 The two hooks @code{mh-before-quit-hook} and @code{mh-quit-hook} are
3780 called by @kbd{q}. The former one is called before the quit occurs, so
3781 you might use it to perform any MH-E operations; you could perform
3782 some query and abort the quit or call @code{mh-execute-commands}, for
3783 example. The latter is not run in an MH-E context, so you might use it
3784 to modify the window setup. If you find that @kbd{q} buries a lot of
3785 buffers that you would rather remove, you can use both
3786 @code{mh-before-quit-hook} and @code{mh-quit-hook} to accomplish that.
3787
3788 @smalllisp
3789 @group
3790 (defvar my-mh-folder-buffer-to-delete nil
3791 "Folder buffer that is being quit.")
3792
3793 (defun my-mh-before-quit-hook ()
3794 "Save folder buffer that is to be deleted."
3795 (setq my-mh-folder-buffer-to-delete (current-buffer)))
3796
3797 (defun my-mh-quit-hook ()
3798 "Kill folder buffer rather than just bury it."
3799 (set-buffer my-mh-folder-buffer-to-delete)
3800 (if (get-buffer mh-show-buffer)
3801 (kill-buffer mh-show-buffer))
3802 (kill-buffer (current-buffer)))
3803
3804 @i{Kill MH-Folder buffer instead of burying it}
3805 @end group
3806 @end smalllisp
3807
3808 @cindex folders, renaming
3809 @cindex renaming folders
3810 @findex dired
3811 @findex dired-do-rename
3812
3813 You can use dired to manipulate the folders themselves. For example, I
3814 renamed my @samp{+out} folder to the more common @samp{+outbox} by
3815 running dired on my mail directory (@kbd{M-x dired RET ~/Mail RET}),
3816 moving my cursor to @samp{out} and using the command @kbd{R}
3817 (@code{dired-do-rename}).
3818
3819 @node Sending Mail, Editing Drafts, Folders, Top
3820 @chapter Sending Mail
3821
3822 @cindex sending mail
3823 @findex mh-smail
3824 @kindex M-x mh-smail
3825
3826 You can send a mail message in several ways. You can call @kbd{M-x
3827 mh-smail} directly, or from the command line like this:
3828
3829 @cindex starting from command line
3830
3831 @smallexample
3832 $ @kbd{emacs -f mh-smail}
3833 @end smallexample
3834
3835 @findex goto-address-at-point
3836 @vindex mail-user-agent
3837
3838 There are some commands that need to send a mail message, such as
3839 @code{goto-address-at-point}. You can configure Emacs to have these
3840 commands use MH-E by setting the option @code{mail-user-agent} to
3841 @samp{Emacs interface to MH}.
3842
3843 @cindex @samp{Message} menu
3844 @cindex menu, @samp{Message}
3845
3846 From within MH-E's MH-Folder mode, other methods of sending mail are
3847 available as well. These can also be found in the @samp{Message} menu.
3848
3849 @table @kbd
3850 @cindex @samp{Message > Edit Message Again} menu item
3851 @cindex menu item, @samp{Message > Edit Message Again}
3852 @kindex e
3853 @findex mh-edit-again
3854 @item e
3855 Edit a message to send it again (@code{mh-edit-again}).
3856 @c -------------------------
3857 @cindex @samp{Message > Re-edit a Bounced Message} menu item
3858 @cindex menu item, @samp{Message > Re-edit a Bounced Message}
3859 @kindex E
3860 @findex mh-extract-rejected-mail
3861 @item E
3862 Edit a message that was returned by the mail system
3863 (@code{mh-extract-rejected-mail}).
3864 @c -------------------------
3865 @cindex @samp{Message > Forward Message...} menu item
3866 @cindex menu item, @samp{Message > Forward Message...}
3867 @kindex f
3868 @findex mh-forward
3869 @item f
3870 Forward message (@code{mh-forward}).
3871 @c -------------------------
3872 @cindex @samp{Message > Reply to Message...} menu item
3873 @cindex menu item, @samp{Message > Reply to Message...}
3874 @kindex r
3875 @findex mh-reply
3876 @item r
3877 Reply to a message (@code{mh-reply}).
3878 @c -------------------------
3879 @cindex @samp{Message > Compose a New Message} menu item
3880 @cindex menu item, @samp{Message > Compose a New Message}
3881 @kindex s
3882 @findex mh-send
3883 @item s
3884 Compose a message (@code{mh-send}).
3885 @c -------------------------
3886 @cindex @samp{Message > Redistribute Message...} menu item
3887 @cindex menu item, @samp{Message > Redistribute Message...}
3888 @kindex M-d
3889 @findex mh-redistribute
3890 @item M-d
3891 Redistribute a message (@code{mh-redistribute}).
3892 @c -------------------------
3893 @findex mh-smail
3894 @item M-x mh-smail
3895 Compose a message with the MH mail system.
3896 @c -------------------------
3897 @findex mh-smail-other-window
3898 @item M-x mh-smail-other-window
3899 Compose a message with the MH mail system in other window.
3900 @end table
3901
3902 @cindex @samp{mh-sending-mail} customization group
3903 @cindex customization group, @samp{mh-sending-mail}
3904
3905 In addition, several options from the @samp{mh-sending-mail}
3906 customization group are useful when sending mail or replying to mail.
3907 They are summarized in the following table.
3908
3909 @vtable @code
3910 @item mh-compose-forward-as-mime-flag
3911 On means that messages are forwarded as attachments (default:
3912 @samp{on}).
3913 @c -------------------------
3914 @item mh-compose-letter-function
3915 Hook run when starting a new draft (default: @code{nil}).
3916 @c -------------------------
3917 @item mh-compose-prompt-flag
3918 On means prompt for header fields when composing a new draft (default:
3919 @samp{off}).
3920 @c -------------------------
3921 @item mh-forward-subject-format
3922 Format string for forwarded message subject (default: @code{"%s:
3923 %s"}).
3924 @c -------------------------
3925 @item mh-insert-x-mailer-flag
3926 On means append an @samp{X-Mailer:} header field to the header
3927 (default: @samp{on}).
3928 @c -------------------------
3929 @item mh-redist-full-contents-flag
3930 On means the @command{dist} command needs entire letter for
3931 redistribution (default: @samp{off}).
3932 @c -------------------------
3933 @item mh-reply-default-reply-to
3934 Sets the person or persons to whom a reply will be sent (default:
3935 @samp{Prompt}).
3936 @c -------------------------
3937 @item mh-reply-show-message-flag
3938 On means the MH-Show buffer is displayed using @kbd{r}
3939 (@code{mh-reply}) (default: @samp{on}).
3940 @end vtable
3941
3942 The following hooks are available.
3943
3944 @vtable @code
3945 @item mh-forward-hook
3946 Hook run by @code{mh-forward} on a forwarded letter (default:
3947 @code{nil}).
3948 @c -------------------------
3949 @item mh-letter-mode-hook
3950 Hook run by @code{mh-letter-mode} on a new letter (default:
3951 @code{nil}).
3952 @end vtable
3953
3954 The functions and options introduced here are explained in more detail
3955 in the following sections.
3956
3957 @menu
3958 * Composing::
3959 * Replying::
3960 * Forwarding::
3961 * Redistributing::
3962 * Editing Again::
3963 @end menu
3964
3965 @node Composing, Replying, Sending Mail, Sending Mail
3966 @section Composing
3967
3968 @cindex @file{.emacs}
3969 @cindex MH-Folder mode
3970 @cindex composing mail
3971 @cindex draft
3972 @cindex files, @file{.emacs}
3973 @cindex modes, MH-Folder
3974 @cindex sending mail
3975 @findex mh-smail
3976 @findex mh-smail-other-window
3977 @kindex M-x mh-smail
3978 @kindex M-x mh-smail-other-window
3979
3980 Outside of an MH-Folder buffer, you must call either @kbd{M-x
3981 mh-smail} or @kbd{M-x mh-smail-other-window} to compose a new message.
3982 The former command always creates a two-window layout with the current
3983 buffer on top and the draft on the bottom. Use the latter command if
3984 you would rather preserve the window layout. You may find adding the
3985 following key bindings to @file{~/.emacs} useful:
3986
3987 @smalllisp
3988 (global-set-key "\C-xm" 'mh-smail)
3989 (global-set-key "\C-x4m" 'mh-smail-other-window)
3990 @end smalllisp
3991
3992 @cindex draft folder
3993 @cindex MH-Letter mode
3994 @cindex modes, MH-Letter
3995 @findex mh-send
3996 @kindex m
3997
3998 From within a MH-Folder buffer, you can simply use the command @kbd{m}
3999 (@code{mh-send}). However you invoke @code{mh-send}, your letter
4000 appears in an Emacs buffer whose mode is MH-Letter (to see what the
4001 buffer looks like, @pxref{Sending Mail Tour}). MH-Letter mode allows
4002 you to edit your message, to check the validity of the recipients, to
4003 insert attachments and other messages into your message, and to send
4004 the message. We'll go more into depth about editing a
4005 @dfn{draft}@footnote{I highly recommend that you use a @dfn{draft
4006 folder} so that you can edit several drafts in parallel. To do so,
4007 create a folder named @samp{+drafts} for example, and add the profile
4008 component @samp{Draft-Folder: drafts} (see @code{mh-profile}(5)).} (a
4009 message you're composing) in just a moment (@pxref{Editing Drafts}).
4010
4011 @vindex mh-compose-prompt-flag
4012
4013 If you prefer to be prompted for the recipient and subject fields
4014 before the MH-Letter buffer appears, turn on the option
4015 @code{mh-compose-prompt-flag}.
4016
4017 @cindex header field, @samp{X-Mailer:}
4018 @cindex @samp{X-Mailer:} header field
4019 @vindex mh-insert-x-mailer-flag
4020
4021 MH-E adds an @samp{X-Mailer:} header field to the header that includes
4022 the version of MH-E and Emacs that you are using. If you don't want to
4023 participate in our marketing, you can turn off the option
4024 @code{mh-insert-x-mailer-flag}.
4025
4026 @cindex @command{repl}
4027 @cindex @file{components}
4028 @cindex MH commands, @command{repl}
4029 @cindex MH-Letter mode
4030 @cindex Mail mode
4031 @cindex files, @file{components}
4032 @cindex modes, MH-Letter
4033 @cindex modes, Mail
4034 @vindex mail-mode-hook
4035 @vindex mh-letter-mode-hook
4036 @vindex text-mode-hook
4037
4038 Two hooks are provided to run commands on your freshly created draft.
4039 The first hook, @code{mh-letter-mode-hook}, allows you to do some
4040 processing before editing a letter@footnote{Actually, because
4041 MH-Letter mode inherits from Mail mode, the hooks
4042 @code{text-mode-hook} and @code{mail-mode-hook} are run (in that
4043 order) before @code{mh-letter-mode-hook}.}. For example, you may wish
4044 to modify the header after @command{repl} has done its work, or you
4045 may have a complicated @file{components} file and need to tell MH-E
4046 where the cursor should go. Here's an example of how you would use
4047 this hook.
4048
4049 @findex mh-insert-signature, example
4050
4051 @smalllisp
4052 @group
4053 (defvar letter-mode-init-done-flag nil
4054 "Non-nil means one-time MH-E settings have been made.")
4055
4056 (defun my-mh-letter-mode-hook ()
4057 "Prepare letter for editing."
4058 (when (not letter-mode-init-done) ; @r{only need to bind the keys once}
4059 (local-set-key "\C-ctb" 'add-enriched-text)
4060 (local-set-key "\C-cti" 'add-enriched-text)
4061 (local-set-key "\C-ctf" 'add-enriched-text)
4062 (local-set-key "\C-cts" 'add-enriched-text)
4063 (local-set-key "\C-ctB" 'add-enriched-text)
4064 (local-set-key "\C-ctu" 'add-enriched-text)
4065 (local-set-key "\C-ctc" 'add-enriched-text)
4066 (setq letter-mode-init-done t))
4067 (save-excursion
4068 (goto-char (point-max)) ; @r{go to end of message to}
4069 (mh-insert-signature))) ; @r{insert signature}
4070
4071 @i{Prepare draft for editing via mh-letter-mode-hook}
4072
4073 @end group
4074 @end smalllisp
4075
4076 The function, @code{add-enriched-text} is defined in the example in
4077 @ref{Adding Attachments}.
4078
4079 @vindex mh-compose-letter-function
4080 @vindex mh-letter-mode-hook
4081
4082 The second hook, a function really, is
4083 @code{mh-compose-letter-function}. Like @code{mh-letter-mode-hook}, it
4084 is called just before editing a new message; however, it is the last
4085 function called before you edit your message. The consequence of this
4086 is that you can write a function to write and send the message for
4087 you. This function is passed three arguments: the contents of the
4088 @samp{To:}, @samp{Subject:}, and @samp{Cc:} header fields.
4089
4090 @node Replying, Forwarding, Composing, Sending Mail
4091 @section Replying to Mail
4092
4093 @cindex @command{mhl}
4094 @cindex @file{mhl.reply}
4095 @cindex MH commands, @command{mhl}
4096 @cindex files, @file{mhl.reply}
4097 @cindex replying
4098 @findex mh-reply
4099 @kindex r
4100
4101 To compose a reply to a message, use the @kbd{r} (@code{mh-reply})
4102 command.
4103
4104 When you reply to a message, you are first prompted with @samp{Reply
4105 to whom?}. You have several choices here.
4106
4107 @quotation
4108 @multitable @columnfractions .20 .80
4109 @c @headitem Response @tab Reply Goes To
4110 @c XXX @headitem not yet supported by SourceForge's texi2pdf.
4111 @item @b{Response} @tab @b{Reply Goes To}
4112 @c -------------------------
4113 @item @kbd{from}
4114 @tab
4115 The person who sent the message. This is the default, so @key{RET} is
4116 sufficient.
4117 @c -------------------------
4118 @item @kbd{to}
4119 @tab
4120 Replies to the sender, plus all recipients in the @samp{To:} header field.
4121 @c -------------------------
4122 @item @kbd{cc}@*@kbd{all}
4123 @tab
4124 Forms a reply to the addresses in the @samp{Mail-Followup-To:} header
4125 field if one exists; otherwise forms a reply to the sender, plus all
4126 recipients.
4127 @end multitable
4128 @end quotation
4129
4130 @cindex @command{repl}
4131 @cindex MH commands, @command{repl}
4132 @vindex mh-reply-default-reply-to
4133
4134 Depending on your answer, @command{repl}@footnote{See the section
4135 @uref{@value{MH-BOOK-HOME}/reprep.html, Replying to Messages: repl} in
4136 the MH book.} is given a different argument to form your reply.
4137 Specifically, a choice of @kbd{from} or none at all runs @samp{repl
4138 -nocc all}, and a choice of @kbd{to} runs @samp{repl -cc to}. Finally,
4139 either @kbd{cc} or @kbd{all} runs @samp{repl -cc all -nocc me}. If you
4140 find that most of the time you specify one of these choices when you
4141 reply to a message, you can change the option
4142 @code{mh-reply-default-reply-to} from its default value of
4143 @samp{Prompt} to one of the choices listed above. You can always edit
4144 the recipients in the draft.
4145
4146 @cindex @samp{repl:} MH profile component
4147 @cindex MH profile component, @samp{repl:}
4148 @cindex MH-Letter mode
4149 @cindex MH-Show mode
4150 @cindex draft
4151 @cindex modes, MH-Letter
4152 @cindex modes, MH-Show
4153
4154 Two windows are then created. One window contains the message to which
4155 you are replying in an MH-Show buffer. Your draft, in MH-Letter mode
4156 (@pxref{Editing Drafts}), is in the other window. If the reply draft
4157 was not one that you expected, check the things that affect the
4158 behavior of @command{repl} which include the @samp{repl:} profile
4159 component and the @file{replcomps} and @file{replgroupcomps} files.
4160
4161 If you supply a prefix argument (as in @kbd{C-u r}), the message you
4162 are replying to is inserted in your reply after having first been run
4163 through @command{mhl} with the format file @file{mhl.reply}. See
4164 @command{mhl}(1) or the section
4165 @uref{@value{MH-BOOK-HOME}/shomes.html#Usisho, Using mhl} in the MH
4166 book to see how you can modify the default @file{mhl.reply} file.
4167
4168 @vindex mh-yank-behavior
4169
4170 Alternatively, you can customize the option @code{mh-yank-behavior}
4171 and choose one of its @samp{Automatically} variants to do the same
4172 thing. @xref{Inserting Letter}. If you do so, the prefix argument has
4173 no effect.
4174
4175 Another way to include the message automatically in your draft is to
4176 use @samp{repl: -filter repl.filter} in your MH profile.
4177
4178 @vindex mh-reply-show-message-flag
4179
4180 If you include the message automatically, you can hide the MH-Show
4181 buffer by turning off the option @code{mh-reply-show-message-flag}.
4182
4183 If you wish to customize the header or other parts of the reply draft,
4184 please see @command{repl}(1) and @code{mh-format}(5).
4185
4186 @node Forwarding, Redistributing, Replying, Sending Mail
4187 @section Forwarding Mail
4188
4189 @cindex @command{forw}
4190 @cindex draft
4191 @cindex forwarding
4192 @cindex MH commands, @command{forw}
4193 @findex mh-forward
4194 @kindex f
4195 @vindex mh-forward-hook
4196
4197 To forward a message, use the @kbd{f} (@code{mh-forward}) command. You
4198 are prompted for the @samp{To:} and @samp{cc:} recipients. You are
4199 given a draft to edit that looks like it would if you had run the MH
4200 command @command{forw}@footnote{See the section
4201 @uref{@value{MH-BOOK-HOME}/forfor.html, Forwarding Messages: forw} in
4202 the MH book.}. You can then add some text (@pxref{Editing Drafts}).
4203 You can forward several messages by using a range (@pxref{Ranges}).
4204 All of the messages in the range are inserted into your draft. The
4205 hook @code{mh-forward-hook} is called on the draft.
4206
4207 @cindex @file{.mh_profile}
4208 @cindex files, @file{.mh_profile}
4209 @cindex MH profile component, @samp{forw:}
4210 @cindex @samp{forw:} MH profile component
4211 @vindex mh-compose-forward-as-mime-flag
4212
4213 By default, the option @code{mh-compose-forward-as-mime-flag} is on
4214 which means that the forwarded messages are included as attachments.
4215 These are inline attachments so the forwarded message should appear in
4216 the body of your recipient's mail program. If you would prefer to
4217 forward your messages verbatim (as text, inline), then turn off this
4218 option. Forwarding messages verbatim works well for short, textual
4219 messages, but your recipient won't be able to view any non-textual
4220 attachments that were in the forwarded message. Be aware that if you
4221 have @samp{forw: -mime} in your MH profile, then forwarded messages
4222 will always be included as attachments regardless of the settings of
4223 @code{mh-compose-forward-as-mime-flag}.
4224
4225 @vindex mh-forward-subject-format
4226
4227 The format of the @samp{Subject:} header field for forwarded messages
4228 is controlled by the option @code{mh-forward-subject-format}. This
4229 option is a string which includes two escapes (@samp{%s}). The first
4230 @samp{%s} is replaced with the sender of the original message, and the
4231 second one is replaced with the original @samp{Subject:}. The default
4232 value of @code{"%s: %s"} takes a message with the header:
4233
4234 @smallexample
4235 @group
4236 To: Bill Wohler <wohler@@stop.mail-abuse.org>
4237 Subject: Re: 49er football
4238 From: Greg DesBrisay <gd@@stop.mail-abuse.org>
4239 @end group
4240 @end smallexample
4241
4242 and creates a subject header field of:
4243
4244 @smallexample
4245 Subject: Greg DesBrisay: Re: 49er football
4246 @end smallexample
4247
4248 @node Redistributing, Editing Again, Forwarding, Sending Mail
4249 @section Redistributing Your Mail
4250
4251 @cindex @command{dist}
4252 @cindex MH commands, @command{dist}
4253 @cindex redistributing
4254 @findex mh-redistribute
4255 @kindex M-d
4256
4257 The command @kbd{M-d} (@code{mh-redistribute}) is similar in function
4258 to forwarding mail, but it does not allow you to edit the message, nor
4259 does it add your name to the @samp{From:} header field. It appears to
4260 the recipient as if the message had come from the original sender.
4261 When you run this command, you are prompted for the recipients.
4262
4263 @findex mh-edit-again
4264 @kindex e
4265
4266 For more information on redistributing messages, see
4267 @command{dist}(1). Also investigate the command @kbd{e}
4268 (@code{mh-edit-again}) for another way to redistribute messages
4269 (@pxref{Editing Again}).
4270
4271 @cindex @command{send}
4272 @cindex MH commands, @command{send}
4273 @vindex mh-redist-full-contents-flag
4274
4275 The option @code{mh-redist-full-contents-flag} must be turned on if
4276 @command{dist}@footnote{See the section
4277 @uref{@value{MH-BOOK-HOME}/disdis.html, Distributing Messages with
4278 dist} in the MH book.} requires the whole letter for redistribution,
4279 which is the case if @command{send}@footnote{See the section
4280 @uref{@value{MH-BOOK-HOME}/sensen.html, Sending Some Mail: comp send}
4281 in the MH book.} is compiled with the @sc{berk} option (which many
4282 people abhor). If you find that MH will not allow you to redistribute
4283 a message that has been redistributed before, turn off this option.
4284
4285 @node Editing Again, , Redistributing, Sending Mail
4286 @section Editing Old Drafts and Bounced Messages
4287
4288 @cindex @file{draft}
4289 @cindex files, @file{draft}
4290 @cindex re-editing drafts
4291 @findex mh-edit-again
4292 @kindex F v drafts
4293 @kindex e
4294 @kindex n
4295
4296 If you don't complete a draft for one reason or another, and if the
4297 draft buffer is no longer available, you can pick your draft up again
4298 with @kbd{e} (@code{mh-edit-again}). If you don't use a draft
4299 folder, your last @file{draft} file will be used. If you use draft
4300 folders, you'll need to visit the draft folder with @kbd{F v drafts
4301 @key{RET}}, use @kbd{n} to move to the appropriate message, and then
4302 use @kbd{e} to prepare the message for editing.
4303
4304 @kindex e
4305
4306 The @kbd{e} command can also be used to take messages that were sent
4307 to you and to send them to more people.
4308
4309 @cindex Mailer-Daemon
4310 @findex mh-extract-rejected-mail
4311 @kindex C-c C-c
4312 @kindex E
4313
4314 Don't use @kbd{e} to re-edit a message from a @i{Mailer-Daemon} who
4315 complained that your mail wasn't posted for some reason or another. In
4316 this case, use @kbd{E} (@code{mh-extract-rejected-mail}) to prepare
4317 the message for editing by removing the @i{Mailer-Daemon} envelope and
4318 unneeded header fields. Fix whatever addressing problem you had, and
4319 send the message again with @kbd{C-c C-c}.
4320
4321 @node Editing Drafts, Aliases, Sending Mail, Top
4322 @chapter Editing a Draft
4323
4324 @cindex @samp{Letter} menu
4325 @cindex MH-Letter mode
4326 @cindex draft
4327 @cindex editing draft
4328 @cindex menu, @samp{Letter}
4329 @cindex modes, MH-Letter
4330
4331 When you edit a message that you want to send (called a @dfn{draft} in
4332 this case), the mode used is MH-Letter. This mode provides several
4333 commands in addition to the normal Emacs editing commands to help you
4334 edit your draft. These can also be found in the @samp{Letter} menu.
4335
4336 @table @kbd
4337 @kindex @key{SPC}
4338 @findex mh-letter-complete-or-space
4339 @item @key{SPC}
4340 Perform completion or insert space (@code{mh-letter-complete-or-space}).
4341 @c -------------------------
4342 @kindex M-@key{TAB}
4343 @findex mh-letter-complete
4344 @item M-@key{TAB}
4345 Perform completion on header field or word preceding point
4346 (@code{mh-letter-complete}).
4347 @c -------------------------
4348 @kindex , (comma)
4349 @findex mh-letter-confirm-address
4350 @item , (comma)
4351 Flash alias expansion (@code{mh-letter-confirm-address}).
4352 @c -------------------------
4353 @kindex @key{TAB}
4354 @findex mh-letter-next-header-field-or-indent
4355 @item @key{TAB}
4356 Cycle to next field (@code{mh-letter-next-header-field-or-indent}).
4357 @c -------------------------
4358 @kindex S-@key{TAB}
4359 @findex mh-letter-previous-header-field
4360 @item S-@key{TAB}
4361 Cycle to the previous header field
4362 (@code{mh-letter-previous-header-field}).
4363 @c -------------------------
4364 @kindex C-c ?
4365 @findex mh-help
4366 @item C-c ?
4367 Display cheat sheet for the MH-E commands (@code{mh-help}).
4368 @c -------------------------
4369 @cindex @samp{Letter > Send This Draft} menu item
4370 @cindex menu item, @samp{Letter > Send This Draft}
4371 @kindex C-c C-c
4372 @findex mh-send-letter
4373 @item C-c C-c
4374 Save draft and send message (@code{mh-send-letter}).
4375 @c -------------------------
4376 @kindex C-c C-d
4377 @findex mh-insert-identity
4378 @item C-c C-d
4379 Insert fields specified by the given identity
4380 (@code{mh-insert-identity}). @xref{Identities}.
4381 @c -------------------------
4382 @cindex @samp{Letter > Pull in All Compositions (MH)} menu item
4383 @cindex menu item, @samp{Letter > Pull in All Compositions (MH)}
4384 @kindex C-c C-e
4385 @findex mh-mh-to-mime
4386 @item C-c C-e
4387 Compose @sc{mime} message from MH-style directives
4388 (@code{mh-mh-to-mime}).
4389 @c -------------------------
4390 @kindex C-c C-f C-a
4391 @kindex C-c C-f a
4392 @findex mh-to-field
4393 @item C-c C-f C-a
4394 @itemx C-c C-f a
4395 Move to @samp{Mail-Reply-To:} header field (@code{mh-to-field}).
4396 @c -------------------------
4397 @kindex C-c C-f C-b
4398 @kindex C-c C-f b
4399 @item C-c C-f C-b
4400 @itemx C-c C-f b
4401 Move to @samp{Bcc:} header field (@code{mh-to-field}).
4402 @c -------------------------
4403 @kindex C-c C-f C-c
4404 @kindex C-c C-f c
4405 @item C-c C-f C-c
4406 @itemx C-c C-f c
4407 Move to @samp{Cc:} header field (@code{mh-to-field}).
4408 @c -------------------------
4409 @kindex C-c C-f C-d
4410 @kindex C-c C-f d
4411 @item C-c C-f C-d
4412 @itemx C-c C-f d
4413 Move to @samp{Dcc:} header field (@code{mh-to-field}).
4414 @c -------------------------
4415 @kindex C-c C-f C-f
4416 @kindex C-c C-f f
4417 @findex mh-to-fcc
4418 @item C-c C-f C-f
4419 @itemx C-c C-f f
4420 Move to @samp{Fcc:} header field (@code{mh-to-fcc}).
4421 @c -------------------------
4422 @kindex C-c C-f C-l
4423 @kindex C-c C-f l
4424 @item C-c C-f C-l
4425 @itemx C-c C-f l
4426 Move to @samp{Mail-Followup-To:} header field (@code{mh-to-field}).
4427 @c -------------------------
4428 @kindex C-c C-f C-m
4429 @kindex C-c C-f m
4430 @item C-c C-f C-m
4431 @itemx C-c C-f m
4432 Move to @samp{From:} header field (@code{mh-to-field}).
4433 @c -------------------------
4434 @kindex C-c C-f C-r
4435 @kindex C-c C-f r
4436 @item C-c C-f C-r
4437 @itemx C-c C-f r
4438 Move to @samp{Reply-To:} header field (@code{mh-to-field}).
4439 @c -------------------------
4440 @kindex C-c C-f C-s
4441 @kindex C-c C-f s
4442 @item C-c C-f C-s
4443 @itemx C-c C-f s
4444 Move to @samp{Subject:} header field (@code{mh-to-field}).
4445 @c -------------------------
4446 @kindex C-c C-f C-t
4447 @kindex C-c C-f t
4448 @item C-c C-f C-t
4449 @itemx C-c C-f t
4450 Move to @samp{To:} header field (@code{mh-to-field}).
4451 @c -------------------------
4452 @cindex @samp{Letter > Insert a Message...} menu item
4453 @cindex menu item, @samp{Letter > Insert a Message...}
4454 @kindex C-c C-i
4455 @findex mh-insert-letter
4456 @item C-c C-i
4457 Insert a message (@code{mh-insert-letter}).
4458 @c -------------------------
4459 @kindex C-c C-m C-e
4460 @findex mh-mml-secure-message-encrypt
4461 @item C-c C-m C-e
4462 Add tag to encrypt the message (@code{mh-mml-secure-message-encrypt}).
4463 @c -------------------------
4464 @cindex @samp{Letter > Compose Forward...} menu item
4465 @cindex menu item, @samp{Letter > Compose Forward...}
4466 @kindex C-c C-m C-f
4467 @kindex C-c C-m f
4468 @findex mh-compose-forward
4469 @item C-c C-m C-f
4470 @itemx C-c C-m f
4471 Add tag to forward a message (@code{mh-compose-forward}).
4472 @c -------------------------
4473 @cindex @samp{Letter > Compose Get File (MH)...} menu item
4474 @cindex menu item, @samp{Letter > Compose Get File (MH)...}
4475 @kindex C-c C-m C-g
4476 @kindex C-c C-m g
4477 @findex mh-mh-compose-anon-ftp
4478 @item C-c C-m C-g
4479 @itemx C-c C-m g
4480 Add tag to include anonymous ftp reference to a file
4481 (@code{mh-mh-compose-anon-ftp}).
4482 @c -------------------------
4483 @cindex @samp{Letter > Compose Insertion...} menu item
4484 @cindex menu item, @samp{Letter > Compose Insertion...}
4485 @kindex C-c C-m C-i
4486 @kindex C-c C-m i
4487 @findex mh-compose-insertion
4488 @item C-c C-m C-i
4489 @itemx C-c C-m i
4490 Add tag to include a file such as an image or sound
4491 (@code{mh-compose-insertion}).
4492 @c -------------------------
4493 @cindex @samp{Letter > Pull in All Compositions (MML)} menu item
4494 @cindex menu item, @samp{Letter > Pull in All Compositions (MML)}
4495 @kindex C-c C-m C-m
4496 @kindex C-c C-m m
4497 @findex mh-mml-to-mime
4498 @item C-c C-m C-m
4499 @itemx C-c C-m m
4500 Compose @sc{mime} message from MML tags (@code{mh-mml-to-mime}).
4501 @c -------------------------
4502 @kindex C-c C-m C-n
4503 @kindex C-c C-m n
4504 @findex mh-mml-unsecure-message
4505 @item C-c C-m C-n
4506 @itemx C-c C-m n
4507 Remove any secure message tags (@code{mh-mml-unsecure-message}).
4508 @c -------------------------
4509 @kindex C-c C-m C-s
4510 @findex mh-mml-secure-message-sign
4511 @item C-c C-m C-s
4512 Add tag to sign the message (@code{mh-mml-secure-message-sign}).
4513 @c -------------------------
4514 @cindex @samp{Letter > Compose Compressed tar (MH)...} menu item
4515 @cindex menu item, @samp{Letter > Compose Compressed tar (MH)...}
4516 @kindex C-c C-m C-t
4517 @kindex C-c C-m t
4518 @findex mh-mh-compose-external-compressed-tar
4519 @item C-c C-m C-t
4520 @itemx C-c C-m t
4521 Add tag to include anonymous ftp reference to a compressed tar file
4522 (@code{mh-mh-compose-external-compressed-tar}).
4523 @c -------------------------
4524 @cindex @samp{Letter > Revert to Non-MIME Edit (MH)} menu item
4525 @cindex menu item, @samp{Letter > Revert to Non-MIME Edit (MH)}
4526 @kindex C-c C-m C-u
4527 @kindex C-c C-m u
4528 @findex mh-mh-to-mime-undo
4529 @item C-c C-m C-u
4530 @itemx C-c C-m u
4531 Undo effects of @kbd{C-c C-e} (@code{mh-mh-to-mime-undo}).
4532 @c -------------------------
4533 @kindex C-c C-m C-x
4534 @kindex C-c C-m x
4535 @findex mh-mh-compose-external-type
4536 @item C-c C-m C-x
4537 @itemx C-c C-m x
4538 Add tag to refer to a remote file
4539 (@code{mh-mh-compose-external-type}).
4540 @c -------------------------
4541 @kindex C-c C-m e e
4542 @findex mh-mml-secure-message-encrypt
4543 @item C-c C-m e e
4544 Add tag to encrypt the message (@code{mh-mml-secure-message-encrypt}).
4545 @c -------------------------
4546 @kindex C-c C-m e s
4547 @findex mh-mml-secure-message-signencrypt
4548 @item C-c C-m e s
4549 Add tag to encrypt and sign the message@*
4550 (@code{mh-mml-secure-message-signencrypt}).
4551 @c -------------------------
4552 @kindex C-c C-m s e
4553 @findex mh-mml-secure-message-signencrypt
4554 @item C-c C-m s e
4555 Add tag to encrypt and sign the message@*
4556 (@code{mh-mml-secure-message-signencrypt}).
4557 @c -------------------------
4558 @kindex C-c C-m s s
4559 @findex mh-mml-secure-message-sign
4560 @item C-c C-m s s
4561 Add tag to sign the message (@code{mh-mml-secure-message-sign}).
4562 @c -------------------------
4563 @cindex @samp{Letter > Split Current Line} menu item
4564 @cindex menu item, @samp{Letter > Split Current Line}
4565 @kindex C-c C-o
4566 @findex mh-open-line
4567 @item C-c C-o
4568 Insert a newline and leave point before it (@code{mh-open-line}).
4569 @c -------------------------
4570 @cindex @samp{Letter > Kill This Draft} menu item
4571 @cindex menu item, @samp{Letter > Kill This Draft}
4572 @kindex C-c C-q
4573 @findex mh-fully-kill-draft
4574 @item C-c C-q
4575 Quit editing and delete draft message (@code{mh-fully-kill-draft}).
4576 @c -------------------------
4577 @cindex @samp{Letter > Insert Signature} menu item
4578 @cindex menu item, @samp{Letter > Insert Signature}
4579 @kindex C-c C-s
4580 @findex mh-insert-signature
4581 @item C-c C-s
4582 Insert signature in message (@code{mh-insert-signature}).
4583 @c -------------------------
4584 @kindex C-c C-t
4585 @findex mh-letter-toggle-header-field-display
4586 @item C-c C-t
4587 Toggle display of header field at point
4588 (@code{mh-letter-toggle-header-field-display}).
4589 @c -------------------------
4590 @cindex @samp{Letter > Check Recipient} menu item
4591 @cindex menu item, @samp{Letter > Check Recipient}
4592 @kindex C-c C-w
4593 @findex mh-check-whom
4594 @item C-c C-w
4595 Verify recipients, showing expansion of any aliases
4596 (@code{mh-check-whom}).
4597 @c -------------------------
4598 @cindex @samp{Letter > Yank Current Message} menu item
4599 @cindex menu item, @samp{Letter > Yank Current Message}
4600 @kindex C-c C-y
4601 @findex mh-yank-cur-msg
4602 @item C-c C-y
4603 Insert the current message into the draft buffer
4604 (@code{mh-yank-cur-msg}).
4605 @c -------------------------
4606 @kindex C-c M-d
4607 @findex mh-insert-auto-fields
4608 @item C-c M-d
4609 Insert custom fields if recipient is found in
4610 @code{mh-auto-fields-list} (@code{mh-insert-auto-fields}).
4611 @xref{Identities}.
4612 @end table
4613
4614 @cindex @samp{mh-letter} customization group
4615 @cindex customization group, @samp{mh-letter}
4616
4617 Several options from the @samp{mh-letter} customization group are used
4618 while editing a draft.
4619
4620 @vtable @code
4621 @item mh-compose-insertion
4622 Type of @sc{mime} message tags in messages (default: @samp{MML} if
4623 available; otherwise @samp{MH}).
4624 @c -------------------------
4625 @item mh-compose-skipped-header-fields
4626 List of header fields to skip over when navigating in draft (default:
4627 @code{'("From"} @code{"Organization"} @code{"References"}
4628 @code{"In-Reply-To"} @code{"X-Face"} @code{"Face"}
4629 @code{"X-Image-URL"} @code{"X-Mailer")}.
4630 @c -------------------------
4631 @item mh-compose-space-does-completion-flag
4632 On means @key{SPC} does completion in message header (default:
4633 @samp{off}).
4634 @c -------------------------
4635 @item mh-delete-yanked-msg-window-flag
4636 On means delete any window displaying the message (default: @samp{off}).
4637 @c -------------------------
4638 @item mh-extract-from-attribution-verb
4639 Verb to use for attribution when a message is yanked by @kbd{C-c C-y}
4640 (default: @code{"wrote:"}).
4641 @c -------------------------
4642 @item mh-ins-buf-prefix
4643 String to put before each line of a yanked or inserted message
4644 (default: @code{"> "}).
4645 @c -------------------------
4646 @item mh-letter-complete-function
4647 Function to call when completing outside of address or folder fields
4648 (default: @code{ispell-complete-word}).
4649 @c -------------------------
4650 @item mh-letter-fill-column
4651 Fill column to use in MH-Letter mode (default: 72).
4652 @c -------------------------
4653 @item mh-mml-method-default
4654 Default method to use in security tags (default: @samp{PGP (MIME)} if
4655 support for it is available; otherwise @samp{None}).
4656 @c -------------------------
4657 @item mh-signature-file-name
4658 Source of user's signature (default: @code{"~/.signature"}).
4659 @c -------------------------
4660 @item mh-signature-separator-flag
4661 On means a signature separator should be inserted (default:
4662 @samp{on}).
4663 @c -------------------------
4664 @item mh-x-face-file
4665 File containing X-Face or Face header field to insert in outgoing mail.
4666 (default: @code{"~/.face"}).
4667 @c -------------------------
4668 @item mh-yank-behavior
4669 Controls which part of a message is yanked by @kbd{C-c C-y} (default:
4670 @samp{Body With Attribution}).
4671 @end vtable
4672
4673 The following hooks are available.
4674
4675 @vtable @code
4676 @item mail-citation-hook
4677 Hook for modifying a citation just inserted in the mail buffer
4678 (default: @code{nil}).
4679 @c -------------------------
4680 @item mh-before-send-letter-hook
4681 Hook run at the beginning of the @kbd{C-c C-c} command (default:
4682 @samp{nil}).
4683 @c -------------------------
4684 @item mh-mh-to-mime-hook
4685 Hook run on the formatted letter by @kbd{C-c C-e} (default:
4686 @samp{nil}).
4687 @c -------------------------
4688 @item mh-insert-signature-hook
4689 Hook run by @kbd{C-c C-s} after signature has been inserted (default:
4690 @code{nil}).
4691 @end vtable
4692
4693 The following face is available.
4694
4695 @vtable @code
4696 @item mh-letter-header-field
4697 Editable header field value face in draft buffers.
4698 @end vtable
4699
4700 The commands and options introduced here are explained in more
4701 detail in the following sections.
4702
4703 @menu
4704 * Editing Message::
4705 * Inserting Letter::
4706 * Inserting Messages::
4707 * Signature::
4708 * Picture::
4709 * Adding Attachments::
4710 * Sending PGP::
4711 * Checking Recipients::
4712 * Sending Message::
4713 * Killing Draft::
4714 @end menu
4715
4716 @node Editing Message, Inserting Letter, Editing Drafts, Editing Drafts
4717 @section Editing the Message
4718
4719 @cindex @samp{Bcc:} header field
4720 @cindex @samp{Cc:} header field
4721 @cindex @samp{Dcc:} header field
4722 @cindex @samp{From:} header field
4723 @cindex @samp{Mail-Followup-To:} header field
4724 @cindex @samp{Mail-Reply-To:} header field
4725 @cindex @samp{Reply-To:} header field
4726 @cindex @samp{Subject:} header field
4727 @cindex @samp{To:} header field
4728 @cindex editing header
4729 @cindex header field, @samp{Bcc:}
4730 @cindex header field, @samp{Cc:}
4731 @cindex header field, @samp{Dcc:}
4732 @cindex header field, @samp{From:}
4733 @cindex header field, @samp{Mail-Followup-To:}
4734 @cindex header field, @samp{Mail-Reply-To:}
4735 @cindex header field, @samp{Reply-To:}
4736 @cindex header field, @samp{Subject:}
4737 @cindex header field, @samp{To:}
4738 @findex mh-to-field
4739 @kindex C-c C-f C-t
4740 @kindex C-c C-f t
4741
4742 Because the header is part of the message, you can edit the header
4743 fields as you wish. However, several convenience commands exist to
4744 help you create and edit them. For example, the command @kbd{C-c C-f
4745 C-t} (@code{mh-to-field}; alternatively, @kbd{C-c C-f t}) moves the
4746 cursor to the @samp{To:} header field, creating it if necessary. The
4747 commands for moving to the @samp{Cc:}, @samp{Subject:}, @samp{From:},
4748 @samp{Reply-To:}, @samp{Mail-Reply-To:}, @samp{Mail-Followup-To},
4749 @samp{Bcc:}, and @samp{Dcc:} header fields are similar.
4750
4751 @findex mh-to-fcc
4752 @kindex C-c C-f C-f
4753 @kindex C-c C-f f
4754
4755 One command behaves differently from the others, namely, @kbd{C-c C-f
4756 C-f} (@code{mh-to-fcc}; alternatively, @kbd{C-c C-f f}). This command
4757 will prompt you for the folder name in which to file a copy of the
4758 draft. @xref{Folder Selection}.
4759
4760 @findex indent-relative
4761 @findex mh-letter-next-header-field-or-indent
4762 @findex mh-letter-previous-header-field
4763 @kindex @key{TAB}
4764 @kindex S-@key{TAB}
4765 @vindex mh-compose-skipped-header-fields
4766 @vindex mh-letter-header-field
4767
4768 Within the header of the message, the command@* @key{TAB}
4769 (@code{mh-letter-next-header-field-or-indent}) moves between fields
4770 that are highlighted with the face @code{mh-letter-header-field},
4771 skipping those fields listed in
4772 @code{mh-compose-skipped-header-fields}. After the last field, this
4773 command then moves point to the message body before cycling back to
4774 the first field. If point is already past the first line of the
4775 message body, then this command indents by calling
4776 @code{indent-relative} with the given prefix argument. The command
4777 @kbd{S-@key{TAB}} (@code{mh-letter-previous-header-field}) moves
4778 backwards between the fields and cycles to the body of the message
4779 after the first field. Unlike the command @key{TAB}, it will always
4780 take point to the last field from anywhere in the body.
4781
4782 @cindex alias completion
4783 @cindex completion
4784 @cindex spell check
4785 @findex ispell-complete-word
4786 @findex mh-letter-complete
4787 @findex mh-letter-complete-or-space
4788 @findex mh-letter-confirm-address
4789 @kindex , (comma)
4790 @kindex @key{SPC}
4791 @kindex M-@key{TAB}
4792 @vindex mh-alias-flash-on-comma
4793 @vindex mh-compose-space-does-completion-flag
4794 @vindex mh-letter-complete-function
4795
4796 If the field contains addresses (for example, @samp{To:} or
4797 @samp{Cc:}) or folders (for example, @samp{Fcc:}) then the command
4798 @kbd{M-@key{TAB}} (@code{mh-letter-complete}) will provide alias
4799 completion (@pxref{Aliases}). In the body of the message,
4800 @kbd{M-@key{TAB}} runs @code{mh-letter-complete-function} instead,
4801 which is set to @samp{'ispell-complete-word} by default. The command
4802 @kbd{M-@key{TAB}} (@code{mh-letter-complete}) takes a prefix argument
4803 that is passed to the @code{mh-letter-complete-function}. In addition,
4804 turn on the option @code{mh-compose-space-does-completion-flag} to use
4805 the command @key{SPC} (@code{mh-letter-complete-or-space}) to perform
4806 completion in the header as well; use a prefix argument to specify
4807 more than one space. Addresses are separated by a comma; when you
4808 press the comma, the command @code{mh-letter-confirm-address} flashes
4809 the alias expansion in the minibuffer if
4810 @code{mh-alias-flash-on-comma} is turned on.
4811
4812 @c XXX Document the replacement for the inaccessible 'long argument.
4813
4814 @findex mh-letter-toggle-header-field-display
4815 @kindex C-c C-t
4816
4817 Use the command @kbd{C-c C-t}
4818 @code{mh-letter-toggle-header-field-display} to display truncated
4819 header fields. This command is a toggle so entering it again will hide
4820 the field. This command takes a prefix argument: if negative then the
4821 field is hidden, if positive then the field is displayed (for example,
4822 @kbd{C-u C-c C-t}).
4823
4824 Be sure to leave a row of dashes or a blank line between the header
4825 and the body of the message.
4826
4827 @vindex mh-letter-fill-column
4828
4829 The body of the message is edited as you would edit any Emacs buffer
4830 although there are a few commands and options to assist you. You can
4831 change the fill column in MH-Letter mode with the option
4832 @code{mh-letter-fill-column}. By default, this option is 72 to allow
4833 others to quote your message without line wrapping.
4834
4835 @cindex filling paragraphs
4836 @cindex paragraphs, filling
4837 @findex fill-paragraph
4838 @kindex M-q
4839 @vindex mh-ins-buf-prefix
4840
4841 You'll often include messages that were sent from user agents that
4842 haven't yet realized that paragraphs consist of more than a single
4843 line. This makes for long lines that wrap in an ugly fashion. You'll
4844 find that @kbd{M-q} (@code{fill-paragraph}) works well even on these
4845 quoted messages, even if they are nested, just as long as all of the
4846 quotes match the value of @code{mh-ins-buf-prefix} (@pxref{Inserting
4847 Letter}). For example, let's assume you have the following in your
4848 draft:
4849
4850 @smallexample
4851 @group
4852 > Hopefully this gives you an idea of what I'm currently doing. I'm \
4853 not sure yet whether I'm completely satisfied with my setup, but \
4854 it's worked okay for me so far.
4855 @end group
4856 @end smallexample
4857
4858 Running @kbd{M-q} on this paragraph produces:
4859
4860 @smallexample
4861 @group
4862 > Hopefully this gives you an idea of what I'm currently doing. I'm not
4863 > sure yet whether I'm completely satisfied with my setup, but it's
4864 > worked okay for me so far.
4865 @end group
4866 @end smallexample
4867
4868 @findex mh-open-line
4869 @findex open-line
4870 @kindex C-c C-o
4871 @kindex C-o
4872
4873 The command @kbd{C-c C-o} (@code{mh-open-line}) is similar to the
4874 command @kbd{C-o} (@code{open-line}) in that it inserts a newline
4875 after point. It differs in that it also inserts the right number of
4876 quoting characters and spaces so that the next line begins in the same
4877 column as it was. This is useful when breaking up paragraphs in
4878 replies. For example, if this command was used when point was after
4879 the first period in the paragraph above, the result would be this:
4880
4881 @smallexample
4882 @group
4883 > Hopefully this gives you an idea of what I'm currently doing.
4884
4885 > I'm not
4886 > sure yet whether I'm completely satisfied with my setup, but it's
4887 > worked okay for me so far.
4888 @end group
4889 @end smallexample
4890
4891 @node Inserting Letter, Inserting Messages, Editing Message, Editing Drafts
4892 @section Inserting Letter to Which You're Replying
4893
4894 @cindex inserting messages
4895 @cindex replying to messages
4896 @cindex yanking messages
4897 @findex mh-yank-cur-msg
4898 @kindex C-c C-y
4899 @vindex mh-ins-buf-prefix
4900
4901 It is often useful to insert a snippet of text from a letter that
4902 someone mailed to provide some context for your reply. The command
4903 @kbd{C-c C-y} (@code{mh-yank-cur-msg}) does this by adding an
4904 attribution, yanking a portion of text from the message to which
4905 you're replying, and inserting @code{mh-ins-buf-prefix} (@samp{> })
4906 before each line.
4907
4908 @smallexample
4909 @group
4910 Michael W Thelen <thelenm@@stop.mail-abuse.org> wrote:
4911
4912 > Hopefully this gives you an idea of what I'm currently doing. I'm not
4913 > sure yet whether I'm completely satisfied with my setup, but it's
4914 > worked okay for me so far.
4915 @end group
4916 @end smallexample
4917
4918 @vindex mh-extract-from-attribution-verb
4919
4920 The attribution consists of the sender's name and email address
4921 followed by the content of the option
4922 @code{mh-extract-from-attribution-verb}. This option can be set to
4923 @samp{wrote:}, @samp{a écrit:}, and @samp{schrieb:}. You can also use
4924 the @samp{Custom String} menu item to enter your own verb.
4925
4926 @vindex mail-citation-hook
4927 @vindex mh-ins-buf-prefix
4928 @vindex mh-yank-behavior
4929
4930 The prefix @code{"> "} is the default setting for the option
4931 @code{mh-ins-buf-prefix}. I suggest that you not modify this option
4932 since it is used by many mailers and news readers: messages are far
4933 easier to read if several included messages have all been indented by
4934 the same string. This prefix is not inserted if you use one of the
4935 supercite flavors of @code{mh-yank-behavior} or you have added a
4936 @code{mail-citation-hook} as described below.
4937
4938 @vindex mh-delete-yanked-msg-window-flag
4939
4940 You can also turn on the @code{mh-delete-yanked-msg-window-flag}
4941 option to delete the window containing the original message after
4942 yanking it to make more room on your screen for your reply.
4943
4944 @cindex Emacs, packages, supercite
4945 @cindex supercite package
4946 @kindex r
4947 @vindex mail-citation-hook
4948 @vindex mh-yank-behavior
4949
4950 You can control how the message to which you are replying is yanked
4951 into your reply using @code{mh-yank-behavior}. To include the entire
4952 message, including the entire header, use @samp{Body and
4953 Header}@footnote{If you'd rather have the header cleaned up, use
4954 @kbd{C-u r} instead of @kbd{r} when replying
4955 (@pxref{Replying}).}@footnote{In the past you would use this setting
4956 and set @code{mail-citation-hook} to @samp{supercite}, but this usage
4957 is now deprecated in favor of the @samp{Invoke supercite} setting.}.
4958 Use @samp{Body} to yank just the body without the header. To yank only
4959 the portion of the message following the point, set this option to
4960 @samp{Below Point}.
4961
4962 Choose @samp{Invoke supercite}@footnote{@emph{Supercite} is a
4963 full-bodied, full-featured, citation package that comes standard with
4964 Emacs.} to pass the entire message and header through supercite.
4965
4966 @vindex mh-extract-from-attribution-verb
4967
4968 If the @samp{Body With Attribution} setting is used, then the message
4969 minus the header is yanked and a simple attribution line is added at
4970 the top using the value of the option
4971 @code{mh-extract-from-attribution-verb}. This is the default.
4972
4973 @kindex C-c C-y
4974 @vindex mh-delete-yanked-msg-window-flag
4975
4976 If the @samp{Invoke supercite} or @samp{Body With Attribution}
4977 settings are used, the @samp{-noformat} argument is passed to the
4978 @command{repl} program to override a @samp{-filter} or @samp{-format}
4979 argument. These settings also have @samp{Automatically} variants that
4980 perform the action automatically when you reply so that you don't need
4981 to use @kbd{C-c C-y} at all. Note that this automatic action is only
4982 performed if the show buffer matches the message being replied to.
4983 People who use the automatic variants tend to turn on the option
4984 @code{mh-delete-yanked-msg-window-flag} as well so that the show
4985 window is never displayed.
4986
4987 @vindex mh-yank-behavior
4988
4989 If the show buffer has a region, the option @code{mh-yank-behavior} is
4990 ignored unless its value is one of @samp{Attribution} variants in
4991 which case the attribution is added to the yanked region.
4992
4993 @findex trivial-cite
4994 @vindex mail-citation-hook
4995 @vindex mh-ins-buf-prefix
4996 @vindex mh-yank-behavior
4997
4998 If this isn't enough, you can gain full control over the appearance of
4999 the included text by setting @code{mail-citation-hook} to a function
5000 that modifies it. This hook is ignored if the option
5001 @code{mh-yank-behavior} is set to one of the supercite flavors.
5002 Otherwise, this option controls how much of the message is passed to
5003 the hook. The function can find the citation between point and mark
5004 and it should leave point and mark around the modified citation text
5005 for the next hook function. The standard prefix
5006 @code{mh-ins-buf-prefix} is not added if this hook is set.
5007
5008 @cindex Emacs, packages, trivial-cite
5009 @cindex trivial-cite package
5010 @vindex mh-yank-behavior
5011
5012 For example, if you use the hook function
5013 @uref{http://shasta.cs.uiuc.edu/~lrclause/tc.html,
5014 @code{trivial-cite}} (which is NOT part of Emacs), set
5015 @code{mh-yank-behavior} to @samp{Body and Header}.
5016
5017 @node Inserting Messages, Signature, Inserting Letter, Editing Drafts
5018 @section Inserting Messages
5019
5020 @cindex inserting messages
5021 @findex mh-insert-letter
5022 @findex mh-yank-behavior
5023 @kindex C-c C-i
5024 @vindex mh-ins-buf-prefix
5025 @vindex mh-invisible-header-fields-compiled
5026 @vindex mh-yank-behavior
5027
5028 Messages can be inserted with @kbd{C-c C-i} (@code{mh-insert-letter}).
5029 This command prompts you for the folder and message number, which
5030 defaults to the current message in that folder. It then inserts the
5031 messages, indented by @code{mh-ins-buf-prefix} (@samp{> }) unless
5032 @code{mh-yank-behavior} is set to one of the supercite flavors in
5033 which case supercite is used to format the message. Certain
5034 undesirable header fields (see
5035 @code{mh-invisible-header-fields-compiled}) are removed before
5036 insertion.
5037
5038 If given a prefix argument (like @kbd{C-u C-c C-i}), the header is
5039 left intact, the message is not indented, and @samp{> } is not
5040 inserted before each line. This command leaves the mark before the
5041 letter and point after it.
5042
5043 @node Signature, Picture, Inserting Messages, Editing Drafts
5044 @section Inserting Your Signature
5045
5046 @cindex signature
5047 @findex mh-insert-signature
5048 @kindex C-c C-s
5049
5050 You can insert your signature at the current cursor location with the
5051 command @kbd{C-c C-s} (@code{mh-insert-signature}).
5052
5053 @cindex files, @file{.signature}
5054 @cindex @file{.signature}
5055 @cindex vCard
5056 @vindex mh-signature-file-name
5057
5058 By default, the text of your signature is taken from the file
5059 @file{~/.signature}. You can read from other sources by changing the
5060 option @code{mh-signature-file-name}. This file may contain a
5061 @dfn{vCard} in which case an attachment is added with the vCard.
5062
5063 @findex mh-signature-separator-p
5064 @vindex mh-signature-file-name
5065 @vindex mh-signature-separator
5066 @vindex mh-signature-separator-regexp
5067
5068 The option @code{mh-signature-file-name} may also be a symbol, in
5069 which case that function is called. You may not want a signature
5070 separator to be added for you; instead you may want to insert one
5071 yourself. Options that you may find useful to do this include
5072 @code{mh-signature-separator} (when inserting a signature separator)
5073 and @code{mh-signature-separator-regexp} (for finding said separator).
5074 The function @code{mh-signature-separator-p}, which reports @code{t}
5075 if the buffer contains a separator, may be useful as well.
5076
5077 @cindex signature separator
5078 @vindex mh-signature-separator-flag
5079
5080 A signature separator (@code{"-- "}) will be added if the signature
5081 block does not contain one and @code{mh-signature-separator-flag} is
5082 on. It is not recommended that you change this option since various
5083 mail user agents, including MH-E, use the separator to present the
5084 signature differently, and to suppress the signature when replying or
5085 yanking a letter into a draft.
5086
5087 @vindex mh-insert-signature-hook
5088 @vindex mh-signature-file-name
5089
5090 The hook @code{mh-insert-signature-hook} is run after the signature is
5091 inserted. Hook functions may access the actual name of the file or the
5092 function used to insert the signature with
5093 @code{mh-signature-file-name}.
5094
5095 The signature can also be inserted using Identities.
5096 @xref{Identities}.
5097
5098 @node Picture, Adding Attachments, Signature, Editing Drafts
5099 @section Inserting Your Picture
5100
5101 @cindex @file{.face}
5102 @cindex files, @file{.face}
5103 @vindex mh-x-face-file
5104
5105 You can insert your picture in the header of your mail message so that
5106 recipients see your face in the @samp{From:} header field if their
5107 mail user agent is sophisticated enough. In MH-E, this is done by
5108 placing your image in the file named by the option
5109 @code{mh-x-face-file} which is @file{~/.face} by default.
5110
5111 @cindex @samp{Face:} header field
5112 @cindex @samp{X-Face:} header field
5113 @cindex @samp{X-Image-URL:} header field
5114 @cindex header field, @samp{Face:}
5115 @cindex header field, @samp{X-Face:}
5116 @cindex header field, @samp{X-Image-URL:}
5117
5118 If the file starts with either of the strings @samp{X-Face:},
5119 @samp{Face:} or @samp{X-Image-URL:} then the contents are added to the
5120 message header verbatim. Otherwise it is assumed that the file
5121 contains the value of the @samp{X-Face:} header field.
5122
5123 @cindex @command{compface}
5124 @cindex Unix commands, @command{compface}
5125
5126 The @samp{X-Face:} header field, which is a low-resolution, black and
5127 white image, can be generated using the
5128 @uref{ftp://ftp.cs.indiana.edu/pub/faces/compface/compface.tar.Z,
5129 @command{compface}} command. The @uref{http://www.dairiki.org/xface/,
5130 @cite{Online X-Face Converter}} is a useful resource for quick
5131 conversion of images into @samp{X-Face:} header fields.
5132
5133 Use the @uref{http://quimby.gnus.org/circus/face/make-face,
5134 @command{make-face}} script to convert a JPEG image to the higher
5135 resolution, color, @samp{Face:} header field.
5136
5137 The URL of any image can be used for the @samp{X-Image-URL:} field and
5138 no processing of the image is required.
5139
5140 @vindex mh-x-face-file
5141
5142 To prevent the setting of any of these header fields, either set
5143 @code{mh-x-face-file} to @code{nil}, or simply ensure that the file
5144 defined by this option doesn't exist.
5145
5146 @xref{Viewing}, to see how these header fields are displayed in MH-E.
5147
5148 @node Adding Attachments, Sending PGP, Picture, Editing Drafts
5149 @section Adding Attachments
5150
5151 @cindex @command{mhbuild}
5152 @cindex @command{mhn}
5153 @cindex MH commands, @command{mhbuild}
5154 @cindex MH commands, @command{mhn}
5155 @cindex MIME
5156 @cindex multimedia mail
5157
5158 MH-E has the capability to create multimedia messages. It uses the
5159 @sc{mime} (Multipurpose Internet Mail Extensions)
5160 protocol@footnote{@sc{mime} is defined in
5161 @uref{http://www.rfc-editor.org/rfc/rfc2045.txt, RFC 2045}.} The
5162 @sc{mime} protocol allows you to incorporate images, sound, video,
5163 binary files, and even commands that fetch a file with @samp{ftp} when
5164 your recipient reads the message!
5165
5166 @kindex C-c C-m
5167
5168 If you were to create a multimedia message with plain MH commands, you
5169 would insert @command{mhbuild} or @command{mhn} directives (henceforth
5170 called @dfn{MH-style directives} into your draft and use the
5171 @command{mhbuild} command in nmh or @command{mhn} command in MH and
5172 GNU mailutils to expand them. MH-E works in much the same way,
5173 although it provides a handful of commands prefixed with @kbd{C-c C-m}
5174 to insert the directives so you don't need to remember the syntax of
5175 them. Remember: you can always add MH-style directives by
5176 hand@footnote{See the section
5177 @uref{@value{MH-BOOK-HOME}/usimim.html#SeMIMa, Sending MIME Mail} in
5178 the MH book.}.
5179
5180 @cindex MIME Meta Language (MML)
5181 @cindex MML
5182 @vindex mh-compose-insertion
5183
5184 In addition to MH-style directives, MH-E also supports MML (@sc{mime}
5185 Meta Language) tags@footnote{
5186 @ifinfo
5187 @c Although the third argument should default to the
5188 @c first, makeinfo goes to the wrong Info file without it being
5189 @c different--it seems to be getting our own Composing node.
5190 @xref{Composing,,Composing with MML,emacs-mime}.
5191 @end ifinfo
5192 @ifnotinfo
5193 See the section Composing in
5194 @uref{http://www.gnus.org/manual/emacs-mime.html, @cite{The Emacs MIME
5195 Manual}}.
5196 @end ifnotinfo
5197 }. The option @code{mh-compose-insertion} can be used to choose
5198 between them. By default, this option is set to @samp{MML} if it is
5199 supported since it provides a lot more functionality. This option can
5200 also be set to @samp{MH} if MH-style directives are preferred.
5201
5202 @cindex media types
5203 @cindex MIME, media types
5204
5205 The MH-E @sc{mime} commands require a @dfn{media type} for each body
5206 part or attachment. For example, a PDF document is of type
5207 @samp{application/pdf} and an HTML document is of type
5208 @samp{text/html}. Some commands fill in the media type for you,
5209 whereas others require you to enter one.
5210
5211 @cindex @command{file}
5212 @cindex @file{/etc/mime.types}
5213 @cindex files, @file{/etc/mime.types}
5214 @cindex Unix commands, @command{file}
5215 @findex mailcap-mime-types
5216
5217 In the cases where MH-E can do so, it will determine the media type
5218 automatically. It uses the @command{file} command to do this. Failing
5219 that, the Emacs function @code{mailcap-mime-types} is used to provide
5220 a list from which to choose. This function usually reads the file
5221 @file{/etc/mime.types}.
5222
5223 Whether the media type is chosen automatically, or you choose it from
5224 a list, use the type that seems to match best the file that you are
5225 including. In the case of binaries, the media type
5226 @samp{application/x-executable} can be useful. If you can't find an
5227 appropriate media type, use @samp{text/plain} for text messages and
5228 @samp{application/octet-stream} for everything else.
5229
5230 @cindex content description
5231 @cindex MIME, content description
5232
5233 You are also sometimes asked for a @dfn{content description}. This is
5234 simply an optional brief phrase, in your own words, that describes the
5235 object. If you don't care to enter a content description, just press
5236 return and none will be included; however, a reader may skip over
5237 multimedia fields unless the content description is compelling.
5238
5239 You can also create your own @sc{mime} body parts. In the following
5240 example, I describe how you can create and edit a @samp{text/enriched}
5241 body part to liven up your plain text messages with boldface,
5242 underlining, and italics. I include an Emacs function which inserts
5243 enriched text tags.
5244
5245 @smalllisp
5246 @group
5247 (defvar enriched-text-types '(("b" . "bold") ("i" . "italic")
5248 ("u" . "underline")
5249 ("s" . "smaller") ("B" . "bigger")
5250 ("f" . "fixed")
5251 ("c" . "center"))
5252 "Alist of (final-character . tag) choices for add-enriched-text.
5253 Additional types can be found in RFC 1563.")
5254
5255 (defun add-enriched-text (begin end)
5256 "Add enriched text tags around region.
5257 The tag used comes from the list enriched-text-types and is
5258 specified by the last keystroke of the command. When called from Lisp,
5259 arguments are BEGIN and END@."
5260 (interactive "r")
5261 ;; @r{Set type to the tag indicated by the last keystroke.}
5262 (let ((type (cdr (assoc (char-to-string (logior last-input-char ?@w{`}))
5263 enriched-text-types))))
5264 (save-restriction ; @r{restores state from narrow-to-region}
5265 (narrow-to-region begin end) ; @r{narrow view to region}
5266 (goto-char (point-min)) ; @r{move to beginning of text}
5267 (insert "<" type ">") ; @r{insert beginning tag}
5268 (goto-char (point-max)) ; @r{move to end of text}
5269 (insert "</" type ">")))) ; @r{insert terminating tag}
5270 @i{Emacs function for entering enriched text}
5271
5272 @end group
5273 @end smalllisp
5274
5275 To use the function @code{add-enriched-text}, first add it to
5276 @file{~/.emacs} and create key bindings for it (@pxref{Composing}).
5277
5278 Then, in your plain text message, set the mark with @kbd{C-@@} or
5279 @kbd{C-@key{SPC}}, type in the text to be highlighted, and type @kbd{C-c t
5280 b}. This adds @samp{<bold>} where you set the mark and adds
5281 @samp{</bold>} at the location of your cursor, giving you something
5282 like: @samp{You should be <bold>very</bold>}.
5283
5284 Before sending this message, use @kbd{C-c C-m C-m}
5285 (@code{mh-mml-to-mime})@footnote{Use @kbd{C-c C-e}
5286 (@code{mh-mh-to-mime}) if you're using MH-style directives.} to add
5287 MIME header fields. Then replace @samp{text/plain} with
5288 @samp{text/enriched} in the @samp{Content-Type:} header field.
5289
5290 You may also be interested in investigating @code{sgml-mode}.
5291
5292 @subheading Including Files
5293
5294 @cindex attachments, inserting
5295 @cindex images
5296 @cindex MIME, images
5297 @cindex MIME, sound
5298 @cindex MIME, video
5299 @cindex sound
5300 @cindex video
5301 @findex mh-compose-insertion
5302 @kindex C-c C-m C-i
5303 @kindex C-c C-m i
5304 @vindex mh-compose-insertion
5305
5306 Binaries, images, sound, and video can be inserted in your message
5307 with the command @kbd{C-c C-m C-i} (@code{mh-compose-insertion}). You
5308 are prompted for the filename containing the object, the media type if
5309 it cannot be determined automatically, and a content description. If
5310 you're using MH-style directives, you will also be prompted for
5311 additional attributes.
5312
5313 @subheading Forwarding Multimedia Messages
5314
5315 @findex mh-compose-forward
5316 @kindex C-c C-m C-f
5317 @kindex C-c C-m f
5318
5319 Mail may be forwarded with @sc{mime} using the command @kbd{C-c C-m
5320 C-f} (@code{mh-compose-forward}). You are prompted for a content
5321 description, the name of the folder in which the messages to forward
5322 are located, and a range of messages, which defaults to the current
5323 message in that folder. @xref{Ranges}.
5324
5325 @subheading Including an FTP Reference
5326
5327 @cindex @command{ftp}
5328 @cindex MIME, @command{ftp}
5329 @cindex Unix commands, @command{ftp}
5330 @findex mh-mh-compose-anon-ftp
5331 @kindex C-c C-m C-g
5332 @kindex C-c C-m g
5333
5334 You can have your message initiate an @command{ftp} transfer when the
5335 recipient reads the message. To do this, use the command @kbd{C-c C-m
5336 C-g} (@code{mh-mh-compose-anon-ftp}). You are prompted for the remote
5337 host and filename, the media type, and the content description.
5338
5339 @subheading Including tar Files
5340
5341 @cindex @command{ftp}
5342 @cindex @command{tar}
5343 @cindex MIME, @command{ftp}
5344 @cindex MIME, @command{tar}
5345 @cindex Unix commands, @command{ftp}
5346 @cindex Unix commands, @command{tar}
5347 @findex mh-mh-compose-anon-ftp
5348 @findex mh-mh-compose-external-compressed-tar
5349 @kindex C-c C-m C-g
5350 @kindex C-c C-m C-t
5351 @kindex C-c C-m t
5352
5353 If the remote file is a compressed tar file, you can use @kbd{C-c C-m
5354 C-t} (@code{mh-mh-compose-external-compressed-tar}). Then, in addition
5355 to retrieving the file via anonymous @emph{ftp} as per the command
5356 @kbd{C-c C-m C-g} (@code{mh-mh-compose-anon-ftp}), the file will also
5357 be uncompressed and untarred. You are prompted for the remote host and
5358 filename and the content description.
5359
5360 @subheading Including Other External Files
5361
5362 @findex mh-mh-compose-external-type
5363 @kindex C-c C-m C-x
5364 @kindex C-c C-m x
5365
5366 The command @kbd{C-c C-m C-x} (@code{mh-mh-compose-external-type}) is
5367 a general utility for referencing external files. In fact, all of the
5368 other commands that insert tags to access external files call this
5369 command. You are prompted for the access type, remote host and
5370 filename, and content type. If you provide a prefix argument, you are
5371 also prompted for a content description, attributes, parameters, and a
5372 comment.
5373
5374 @subheading Previewing Multimedia Messages
5375
5376 When you are finished editing a @sc{mime} message, it might look like this:
5377
5378 @cartouche
5379 @smallexample
5380 3 t08/24 root received fax files on Wed Aug 24 11:00:
5381 4+t08/24 To:wohler Test<<This is a test message to get the
5382
5383
5384
5385
5386
5387 --:%% @{+inbox@} 4 msgs (1-4) Bot L4 (MH-Folder Show)---------------
5388 To: wohler
5389 cc:
5390 Subject: Test of MIME
5391 --------
5392 Here is the SETI@@Home logo:
5393
5394 <#part type="image/x-xpm" filename="~/lib/images/setiathome.xpm"
5395 disposition=inline description="SETI@@home logo">
5396 <#/part>
5397 --:** @{draft@} All L8 (MH-Letter)----------------------------------
5398
5399 @end smallexample
5400 @end cartouche
5401 @i{MH-E @sc{mime} draft}
5402
5403 @findex mh-mml-to-mime
5404 @kindex C-c C-m C-m
5405 @kindex C-c C-m m
5406
5407 Typically, you send a message with attachments just like any other
5408 message (@pxref{Sending Message}).
5409
5410 @findex mh-mml-to-mime
5411 @kindex C-c C-m C-m
5412
5413 However, you may take a sneak preview of the @sc{mime} encoding if you
5414 wish by running the command @kbd{C-c C-m C-m} (@code{mh-mml-to-mime}).
5415 The following screen shows the @sc{mime} encoding specified by the
5416 tags. You can see why mail user agents are usually built to hide these
5417 details from the user.
5418
5419 @cartouche
5420 @smallexample
5421 To: wohler
5422 cc:
5423 Subject: Test of MIME
5424 X-Mailer: MH-E 8.0; nmh 1.1; GNU Emacs 22.1
5425 MIME-Version: 1.0
5426 Content-Type: multipart/mixed; boundary="=-=-="
5427 --------
5428 --=-=-=
5429
5430 Here is the SETI@@Home logo:
5431
5432
5433 --=-=-=
5434 Content-Type: image/x-xpm
5435 Content-Disposition: inline; filename=setiathome.xpm
5436 Content-Transfer-Encoding: base64
5437 Content-Description: SETI@@home logo
5438
5439 LyogWFBNICovCnN0YXRpYyBjaGFyICogc2V0aWF0aG9tZV94cG1bXSA9IHsKIjQ1IDQ1IDc2N
5440 --:-- @{draft@} Top L1 (MH-Letter)----------------------------------
5441
5442 @end smallexample
5443 @end cartouche
5444 @i{MH-E @sc{mime} draft ready to send}
5445
5446 @cindex undo effects of mh-mml-to-mime
5447
5448 This action can be undone by running @kbd{C-_} (@code{undo}).
5449
5450 @cindex @command{mhbuild}
5451 @cindex @command{mhn}
5452 @cindex MH commands, @command{mhbuild}
5453 @cindex MH commands, @command{mhn}
5454 @cindex undo effects of mh-mh-to-mime
5455 @findex mh-mh-to-mime
5456 @findex mh-mh-to-mime-undo
5457 @kindex C-c C-e
5458 @kindex C-c C-m C-m
5459 @kindex C-c C-m C-u
5460 @kindex C-c C-m u
5461
5462 If you're using MH-style directives, use @kbd{C-c C-e}
5463 (@code{mh-mh-to-mime}) instead of @kbd{C-c C-m C-m}. This runs the
5464 command @command{mhbuild} (@command{mhn}) on the message which expands
5465 the tags@footnote{See the section
5466 @uref{@value{MH-BOOK-HOME}/usimim.html#SeMIMa, Sending MIME Mail} in
5467 the MH book.}. This action can be undone by running @kbd{C-c C-m C-u}
5468 (@code{mh-mh-to-mime-undo}), which works by reverting to a backup
5469 file. You are prompted to confirm this action, but you can avoid the
5470 confirmation by adding an argument (for example, @kbd{C-u C-c C-m
5471 C-u}).
5472
5473 @kindex C-c C-e
5474 @vindex mh-mh-to-mime-args
5475
5476 If you wish to pass additional arguments to @command{mhbuild}
5477 (@command{mhn}) to affect how it builds your message, use the option
5478 @code{mh-mh-to-mime-args}. For example, you can build a consistency
5479 check into the message by setting @code{mh-mh-to-mime-args} to
5480 @samp{-check}. The recipient of your message can then run
5481 @samp{mhbuild -check} on the message---@command{mhbuild}
5482 (@command{mhn}) will complain if the message has been corrupted on the
5483 way. The command @kbd{C-c C-e} only consults this option when given a
5484 prefix argument (as in @kbd{C-u C-c C-e}).
5485
5486 @kindex C-c C-e
5487 @vindex mh-mh-to-mime-hook
5488
5489 The hook @code{mh-mh-to-mime-hook} is called after the message has
5490 been formatted by @kbd{C-c C-e}.
5491
5492 @node Sending PGP, Checking Recipients, Adding Attachments, Editing Drafts
5493 @section Signing and Encrypting Messages
5494
5495 @cindex signing messages
5496 @cindex encrypting messages
5497 @cindex RFC 3156
5498
5499 MH-E can sign and encrypt messages as defined in
5500 @uref{http://www.rfc-editor.org/rfc/rfc3156.txt, RFC 3156}. If you
5501 should choose to sign or encrypt your message, use one of the
5502 following commands to do so any time before sending your message.
5503
5504 @findex mh-mml-secure-message-encrypt
5505 @findex mh-mml-secure-message-sign
5506 @findex mh-mml-secure-message-signencrypt
5507 @kindex C-c C-m C-e
5508 @kindex C-c C-m C-s
5509 @kindex C-c C-m e e
5510 @kindex C-c C-m e s
5511 @kindex C-c C-m s e
5512 @kindex C-c C-m s s
5513
5514 The command @kbd{C-c C-m C-s} (@code{mh-mml-secure-message-sign})
5515 inserts the following tag:
5516
5517 @smallexample
5518 <#secure method=pgpmime mode=sign>
5519 @end smallexample
5520
5521 This is used to sign your message digitally. Likewise, the command
5522 @kbd{C-c C-m C-e} (@code{mh-mml-secure-message-encrypt}) inserts the
5523 following tag:
5524
5525 @smallexample
5526 <#secure method=pgpmime mode=encrypt>
5527 @end smallexample
5528
5529 This is used to encrypt your message. Finally, the command @kbd{C-c
5530 C-m s e} (@code{mh-mml-secure-message-signencrypt}) inserts the
5531 following tag:
5532
5533 @smallexample
5534 <#secure method=pgpmime mode=signencrypt>
5535 @end smallexample
5536
5537 @findex mh-mml-unsecure-message
5538 @kindex C-c C-m C-n
5539 @kindex C-c C-m n
5540 @vindex mh-mml-method-default
5541
5542 This is used to sign and encrypt your message. In each of these cases,
5543 a proper multipart message is created for you when you send the
5544 message. Use the command @kbd{C-c C-m C-n}
5545 (@code{mh-mml-unsecure-message}) to remove these tags. Use a prefix
5546 argument (as in @kbd{C-u C-c C-m s e}) to be prompted for one of the
5547 possible security methods (see @code{mh-mml-method-default}).
5548
5549 @vindex mh-mml-method-default
5550
5551 The option @code{mh-mml-method-default} is used to select between a
5552 variety of mail security mechanisms. The default is @samp{PGP (MIME)}
5553 if it is supported; otherwise, the default is @samp{None}. Other
5554 mechanisms include vanilla @samp{PGP} and @samp{S/MIME}.
5555
5556 @cindex @samp{pgg} customization group
5557 @cindex PGG
5558 @cindex customization group, @samp{pgg}
5559
5560 The @samp{pgg} customization group may have some settings which may
5561 interest you.
5562 @iftex
5563 See @cite{The PGG Manual}.
5564 @end iftex
5565 @ifinfo
5566 @xref{Top, , The PGG Manual, pgg, The PGG Manual}.
5567 @end ifinfo
5568 @ifhtml
5569 See
5570 @uref{http://www.dk.xemacs.org/Documentation/packages/html/pgg.html,
5571 @cite{The PGG Manual}}.
5572 @end ifhtml
5573
5574 @cindex header field, @samp{Fcc:}
5575 @cindex @samp{Fcc:} header field
5576 @vindex pgg-encrypt-for-me
5577
5578 In particular, I turn on the option @code{pgg-encrypt-for-me} so that
5579 all messages I encrypt are encrypted with my public key as well. If
5580 you keep a copy of all of your outgoing mail with a @samp{Fcc:} header
5581 field, this setting is vital so that you can read the mail you write!
5582
5583 @node Checking Recipients, Sending Message, Sending PGP, Editing Drafts
5584 @section Checking Recipients
5585
5586 @cindex @samp{*MH-E Recipients*}
5587 @cindex @command{whom}
5588 @cindex MH commands, @command{whom}
5589 @cindex buffers, @samp{*MH-E Recipients*}
5590 @cindex checking recipients
5591 @cindex recipients, checking
5592 @findex mh-check-whom
5593 @kindex C-c C-w
5594
5595 The command @kbd{C-c C-w} (@code{mh-check-whom}) expands aliases so
5596 you can check the actual address(es) in the alias. A new buffer named
5597 @samp{*MH-E Recipients*} is created with the output of @command{whom}
5598 (@pxref{Miscellaneous})@footnote{See the section
5599 @uref{@value{MH-BOOK-HOME}/senove.html#WhaPro, What now? -- and the
5600 whatnow Program} in the MH book.}.
5601
5602 @node Sending Message, Killing Draft, Checking Recipients, Editing Drafts
5603 @section Sending a Message
5604
5605 @cindex buffers, @samp{*MH-E Mail Delivery*}
5606 @cindex @samp{*MH-E Mail Delivery*}
5607 @cindex sending mail
5608 @findex mh-send-letter
5609 @kindex C-c C-c
5610
5611 When you are all through editing a message, you send it with the
5612 command @kbd{C-c C-c} (@code{mh-send-letter}). You can give a prefix
5613 argument (as in @kbd{C-u C-c C-c}) to monitor the first stage of the
5614 delivery; this output can be found in a buffer called @samp{*MH-E Mail
5615 Delivery*} (@pxref{Miscellaneous}).
5616
5617 @cindex sending mail
5618 @cindex spell check
5619 @findex ispell-message
5620 @kindex C-c C-c
5621 @vindex mh-before-send-letter-hook
5622
5623 The hook @code{mh-before-send-letter-hook} is run at the beginning of
5624 the command @kbd{C-c C-c}. For example, if you want to check your
5625 spelling in your message before sending, add the function
5626 @code{ispell-message}.
5627
5628 @cindex @command{send}
5629 @cindex MH commands, @command{send}
5630 @vindex mh-send-prog
5631
5632 In case the MH @command{send} program@footnote{See the section
5633 @uref{@value{MH-BOOK-HOME}/sensen.html, Sending Some Mail: comp send}
5634 in the MH book.} is installed under a different name, use
5635 @code{mh-send-prog} to tell MH-E the name.
5636
5637 @node Killing Draft, , Sending Message, Editing Drafts
5638 @section Killing the Draft
5639
5640 @cindex killing draft
5641 @findex kill-buffer
5642 @findex mh-fully-kill-draft
5643 @kindex C-c C-q
5644 @kindex C-x k
5645
5646 If for some reason you are not happy with the draft, you can use the
5647 command @kbd{C-c C-q} (@code{mh-fully-kill-draft}) to kill the draft
5648 buffer and delete the draft message. Use the command @kbd{C-x k}
5649 (@code{kill-buffer}) if you don't want to delete the draft message.
5650
5651 @node Aliases, Identities, Editing Drafts, Top
5652 @chapter Aliases
5653
5654 @cindex aliases
5655
5656 MH aliases are used in the same way in MH-E as they are in MH. Any
5657 alias listed as a recipient will be expanded when the message is sent.
5658 This chapter discusses other things you can do with aliases in MH-E.
5659
5660 @cindex MH-Letter mode
5661 @cindex modes, MH-Letter
5662
5663 The following commands are available in MH-Letter mode with the
5664 exception of @code{mh-alias-reload} which can be called from anywhere.
5665
5666 @table @kbd
5667 @kindex @key{SPC}
5668 @findex mh-letter-complete-or-space
5669 @item @key{SPC}
5670 Perform completion or insert space (@code{mh-letter-complete-or-space}).
5671 @c -------------------------
5672 @kindex M-@key{TAB}
5673 @findex mh-letter-complete
5674 @item M-@key{TAB}
5675 Perform completion on header field or word preceding point
5676 (@code{mh-letter-complete}).
5677 @c -------------------------
5678 @findex mh-alias-apropos
5679 @item mh-alias-apropos
5680 Show all aliases or addresses that match a regular expression.
5681 @c -------------------------
5682 @findex mh-alias-grab-from-field
5683 @item mh-alias-grab-from-field
5684 Add alias for the sender of the current message
5685 @c -------------------------
5686 @findex mh-alias-reload
5687 @item mh-alias-reload
5688 Reload MH aliases.
5689 @end table
5690
5691 @cindex @samp{mh-alias} customization group
5692 @cindex customization group, @samp{mh-alias}
5693
5694 The @samp{mh-alias} customization group contains options associated
5695 with aliases.
5696
5697 @vtable @code
5698 @item mh-alias-completion-ignore-case-flag
5699 On means don't consider case significant in MH alias completion
5700 (default: @samp{on}).
5701 @c -------------------------
5702 @item mh-alias-expand-aliases-flag
5703 On means to expand aliases entered in the minibuffer (default:
5704 @samp{off}).
5705 @c -------------------------
5706 @item mh-alias-flash-on-comma
5707 Specify whether to flash address or warn on translation (default: @samp{Flash
5708 but Don't Warn If No Alias}).
5709 @c -------------------------
5710 @item mh-alias-insert-file
5711 Filename used to store a new MH-E alias (default: @samp{Use Aliasfile
5712 Profile Component}).
5713 @c -------------------------
5714 @item mh-alias-insertion-location
5715 Specifies where new aliases are entered in alias files (default:
5716 @samp{Alphabetical}).
5717 @c -------------------------
5718 @item mh-alias-local-users
5719 If @samp{on}, local users are added to alias completion (default:
5720 @samp{on}).
5721 @c -------------------------
5722 @item mh-alias-local-users-prefix
5723 String prefixed to the real names of users from the password file
5724 (default: @code{"local."}.
5725 @c -------------------------
5726 @item mh-alias-passwd-gecos-comma-separator-flag
5727 On means the GECOS field in the password file uses a comma separator
5728 (default: @samp{on}).
5729 @end vtable
5730
5731 The following hook is available.
5732
5733 @vtable @code
5734 @item mh-alias-reloaded-hook
5735 Hook run by @code{mh-alias-reload} after loading aliases (default:
5736 @code{nil}).
5737 @end vtable
5738
5739 @subheading Adding Addresses to Draft
5740
5741 You can use aliases when you are adding recipients to a message.
5742
5743 @findex minibuffer-complete
5744 @kindex @key{TAB}
5745 @vindex mh-alias-expand-aliases-flag
5746 @vindex mh-compose-prompt-flag
5747
5748 In order to use minibuffer prompting for recipients and the subject
5749 line in the minibuffer, turn on the option
5750 @code{mh-compose-prompt-flag} (@pxref{Composing}), and use the
5751 @key{TAB} (@code{minibuffer-complete}) command to complete aliases
5752 (and optionally local logins) when prompted for the recipients. Turn
5753 on the option @code{mh-alias-expand-aliases-flag} if you want these
5754 aliases to be expanded to their respective addresses in the draft.
5755
5756 @findex mh-letter-complete
5757 @findex mh-letter-complete-or-space
5758 @kindex @key{SPC}
5759 @kindex M-@key{TAB}
5760
5761 Otherwise, you can complete aliases in the header of the draft with
5762 @kbd{M-@key{TAB}} (@code{mh-letter-complete}) or @key{SPC}
5763 (@code{mh-letter-complete-or-space}).
5764
5765 @vindex mh-alias-completion-ignore-case-flag
5766
5767 As MH ignores case in the aliases, so too does MH-E. However, you may
5768 turn off the option @code{mh-alias-completion-ignore-case-flag} to
5769 make case significant which can be used to segregate completion of
5770 your aliases. You might use uppercase for mailing lists and lowercase
5771 for people. For example, you might have:
5772
5773 @smallexample
5774 mark.baushke: Mark Baushke <mdb@@stop.mail-abuse.org>
5775 MH-E: MH-E Mailing List <mh-e-devel@@stop.mail-abuse.org>
5776 @end smallexample
5777
5778 When this option is turned off, if you were to type @kbd{M} in the
5779 @samp{To:} field and then @kbd{M-@key{TAB}}, then you'd get the list;
5780 if you started with @kbd{m} and then entered @kbd{M-@key{TAB}}, then
5781 you'd get Mark's address. Note that this option affects completion
5782 only. If you were to enter @kbd{Mark.Baushke}, it would still be
5783 identified with your @samp{mark.baushke} alias.
5784
5785 @findex mh-alias-minibuffer-confirm-address
5786 @findex mh-letter-confirm-address
5787 @vindex mh-alias-flash-on-comma
5788 @vindex mh-compose-prompt-flag
5789
5790 To verify that the alias you've entered is valid, the alias will be
5791 displayed in the minibuffer when you type a comma
5792 (@code{mh-letter-confirm-address} or
5793 @code{mh-alias-minibuffer-confirm-address} if the option
5794 @code{mh-compose-prompt-flag} is turned on). @xref{Composing}. This
5795 behavior can be controlled with the option
5796 @code{mh-alias-flash-on-comma} which provides three choices:
5797 @samp{Flash but Don't Warn If No Alias}, @samp{Flash and Warn If No
5798 Alias}, and @samp{Don't Flash Nor Warn If No Alias}.
5799
5800 For another way to verify the alias expansion, see @ref{Checking
5801 Recipients}.
5802
5803 @subheading Loading Aliases
5804
5805 @cindex @command{ali}
5806 @cindex @file{/etc/nmh/MailAliases}
5807 @cindex @samp{Aliasfile:} MH profile component
5808 @cindex MH commands, @command{ali}
5809 @cindex MH profile component, @samp{Aliasfile:}
5810 @cindex files, @file{/etc/nmh/MailAliases}
5811
5812 MH-E loads aliases for completion and folder name hints from various
5813 places. It uses the MH command @command{ali}@footnote{See the section
5814 @uref{@value{MH-BOOK-HOME}/mh.html, MH Aliases} in the MH book.} to
5815 read aliases from the files listed in the profile component
5816 @samp{Aliasfile:} as well as system-wide aliases (for example,
5817 @file{/etc/nmh/MailAliases}).
5818
5819 @cindex @file{/etc/passwd}
5820 @cindex files, @file{/etc/passwd}
5821
5822 In addition, aliases are created from @file{/etc/passwd} entries with
5823 a user ID larger than a magical number, typically 200. This can be a
5824 handy tool on a machine where you and co-workers exchange messages.
5825 These aliases have the form @samp{local.@var{first.last}} if a real
5826 name is present in the password file. Otherwise, the alias will have
5827 the form @samp{local.@var{login}}.
5828
5829 @vindex mh-alias-local-users-prefix
5830
5831 The prefix @samp{local.} can be modified via the option
5832 @code{mh-alias-local-users-prefix}. This option can also be set to
5833 @samp{Use Login}.
5834
5835 For example, consider the following password file entry:
5836
5837 @smallexample
5838 psg:x:1000:1000:Peter S Galbraith,,,:/home/psg:/bin/tcsh
5839 @end smallexample
5840
5841 @vindex mh-alias-local-users-prefix
5842
5843 The following settings of option @code{mh-alias-local-users-prefix}
5844 will produce the associated aliases:
5845
5846 @table @code
5847 @item "local."
5848 local.peter.galbraith
5849 @c -------------------------
5850 @item ""
5851 peter.galbraith
5852 @c -------------------------
5853 @item Use Login
5854 psg
5855 @end table
5856
5857 @vindex mh-alias-passwd-gecos-comma-separator-flag
5858
5859 In the example above, commas are used to separate different values
5860 within the so-called GECOS field. This is a fairly common usage.
5861 However, in the rare case that the GECOS field in your password file
5862 is not separated by commas and whose contents may contain commas, you
5863 can turn the option @code{mh-alias-passwd-gecos-comma-separator-flag}
5864 off.
5865
5866 @cindex NIS, obtaining local aliases from
5867 @cindex @samp{ypcat passwd}
5868 @vindex mh-alias-local-users
5869
5870 If you're on a system with thousands of users you don't know, and the
5871 loading of local aliases slows MH-E down noticeably, then the local
5872 alias feature can be disabled by turning off the option
5873 @code{mh-alias-local-users}. This option also takes a string which is
5874 executed to generate the password file. For example, use @samp{ypcat
5875 passwd} to obtain the NIS password file.
5876
5877 @findex mh-alias-reload
5878 @kindex M-x mh-alias-reload
5879 @vindex mh-alias-reloaded-hook
5880
5881 Since aliases are updated frequently, MH-E reloads aliases
5882 automatically whenever an alias lookup occurs if an alias source has
5883 changed. However, you can reload your aliases manually by calling the
5884 command @kbd{M-x mh-alias-reload} directly. This command runs
5885 @code{mh-alias-reloaded-hook} after the aliases have been loaded.
5886
5887 @subheading Adding Aliases
5888
5889 In the past, you have manually added aliases to your alias file(s)
5890 listed in your @samp{Aliasfile:} profile component. MH-E provides
5891 other methods for maintaining your alias file(s).
5892
5893 @findex mh-alias-add-alias
5894 @kindex M-x mh-alias-add-alias
5895
5896 You can use the @kbd{M-x mh-alias-add-alias} command which will prompt
5897 you for the alias and address that you would like to add. If the alias
5898 exists already, you will have the choice of inserting the new alias
5899 before or after the old alias. In the former case, this alias will be
5900 used when sending mail to this alias. In the latter case, the alias
5901 serves as an additional folder name hint when filing messages
5902 (@pxref{Folder Selection}).
5903
5904 Earlier, the alias prefix @samp{local} was presented. You can use
5905 other prefixes to organize your aliases or disambiguate entries. You
5906 might use prefixes for locales, jobs, or activities. For example, I
5907 have:
5908
5909 @smallexample
5910 @group
5911 ; Work
5912 attensity.don.mitchell: Don Mitchell <dmitchell@@stop.mail-abuse.com>
5913 isharp.don.mitchell: Don Mitchell <donaldsmitchell@@stop.mail-abuse.com>
5914 ...
5915 ; Sport
5916 diving.ken.mayer: Ken Mayer <kmayer@@stop.mail-abuse.com>
5917 sailing.mike.maloney: Mike Maloney <mmaloney@@stop.mail-abuse.com>
5918 ...
5919 ; Personal
5920 ariane.kolkmann: Ariane Kolkmann <ArianeKolkmann@@stop.mail-abuse.com>
5921 ...
5922 @end group
5923 @end smallexample
5924
5925 Using prefixes instead of postfixes helps you explore aliases during
5926 completion. If you forget the name of an old dive buddy, you can enter
5927 @samp{div} and then @key{SPC} to get a listing of all your dive buddies.
5928
5929 @kindex M-x mh-alias-add-address-under-point
5930 @kindex M-x mh-alias-grab-from-field
5931
5932 An alias for the sender of the current message is added automatically
5933 by clicking on the @samp{Grab From alias} tool bar button or by running
5934 the @kbd{M-x mh-alias-grab-from-field} command. Aliases for other
5935 recipients of the current message are added by placing your cursor
5936 over the desired recipient and giving the @kbd{M-x
5937 mh-alias-add-address-under-point} command.
5938
5939 @vindex mh-alias-insert-file
5940 @vindex mh-alias-insertion-location
5941
5942 The options @code{mh-alias-insert-file} and
5943 @code{mh-alias-insertion-location} controls how and where these aliases
5944 are inserted.
5945
5946 @vindex mh-alias-insert-file
5947
5948 The default setting of option @code{mh-alias-insert-file} is @samp{Use
5949 Aliasfile Profile Component}. This option can also hold the name of a
5950 file or a list a file names. If this option is set to a list of file
5951 names, or the @samp{Aliasfile:} profile component contains more than
5952 one file name, MH-E will prompt for one of them.
5953
5954 @vindex mh-alias-insertion-location
5955
5956 The option @code{mh-alias-insertion-location} is set to
5957 @samp{Alphabetical} by default. If you organize your alias file in
5958 other ways, then the settings @samp{Top} and @samp{Bottom} might be
5959 more appropriate.
5960
5961 @subheading Querying Aliases
5962
5963 @cindex regular expressions, @code{mh-alias-apropos}
5964 @findex mh-alias-apropos
5965 @kindex M-x mh-alias-apropos
5966
5967 If you can't quite remember an alias, you can use @kbd{M-x
5968 mh-alias-apropos} to show all aliases or addresses that match a
5969 regular expression
5970 @ifnothtml
5971 (@pxref{Regexps, , Syntax of Regular Expressions, emacs, The
5972 GNU Emacs Manual}).
5973 @end ifnothtml
5974 @ifhtml
5975 (see the section
5976 @uref{http://www.gnu.org/software/emacs/manual/html_node/Regexps.html,
5977 Syntax of Regular Expressions} in
5978 @cite{The GNU Emacs Manual}).
5979 @end ifhtml
5980
5981 @node Identities, Speedbar, Aliases, Top
5982 @chapter Identities
5983
5984 @cindex identities
5985 @cindex multiple personalities
5986
5987 MH-E supports the concept of multiple personalities or identities.
5988 This means that you can easily have a different header and signature
5989 at home and at work.
5990
5991 @cindex @samp{Identity} menu
5992 @cindex menu, @samp{Identity}
5993
5994 A couple of commands are used to insert identities in MH-Letter mode
5995 which are also found in the @samp{Identity} menu.
5996
5997 @table @kbd
5998 @kindex C-c C-d
5999 @findex mh-insert-identity
6000 @item C-c C-d
6001 Insert fields specified by given identity (@code{mh-insert-identity}).
6002 @c -------------------------
6003 @cindex @samp{Identity > Insert Auto Fields} menu item
6004 @cindex menu item, @samp{Identity > Insert Auto Fields}
6005 @kindex C-c M-d
6006 @findex mh-insert-auto-fields
6007 @item C-c M-d
6008 Insert custom fields if recipient found in @code{mh-auto-fields-list}
6009 (@code{mh-insert-auto-fields}).
6010 @end table
6011
6012 @cindex @samp{mh-identity} customization group
6013 @cindex customization group, @samp{mh-identity}
6014
6015 The @samp{mh-identity} customization group contains the following
6016 options.
6017
6018 @vtable @code
6019 @item mh-auto-fields-list
6020 List of recipients for which header lines are automatically inserted
6021 (default: @code{nil}).
6022 @c -------------------------
6023 @item mh-auto-fields-prompt-flag
6024 On means to prompt before sending if fields inserted (default:
6025 @samp{on})
6026 @c -------------------------
6027 @item mh-identity-default
6028 Default identity to use when @code{mh-letter-mode} is called (default:
6029 @samp{None}).
6030 @c -------------------------
6031 @item mh-identity-handlers
6032 Handler functions for fields in @code{mh-identity-list}.
6033 @c -------------------------
6034 @item mh-identity-list
6035 List of identities (default: @code{nil}).
6036 @end vtable
6037
6038 Some of the common header fields that people change depending on the
6039 context are the @samp{From:} and @samp{Organization:} fields, as well
6040 as the signature.
6041
6042 @vindex mh-identity-list
6043
6044 This is done by customizing the option @code{mh-identity-list}. In the
6045 customization buffer for this option, click on the @samp{INS} button
6046 and enter a label such as @samp{Home} or @samp{Work}. Then click on
6047 the @samp{INS} button with the label @samp{Add at least one item
6048 below}. The @samp{Value Menu} has the following menu items:
6049
6050 @table @samp
6051 @cindex header field, @samp{From:}
6052 @cindex @samp{From:} header field
6053 @item From Field
6054 Specify an alternate @samp{From:} header field. You must include a
6055 valid email address. A standard format is @samp{First Last
6056 <login@@host.domain>}. If you use an initial with a period, then you
6057 must quote your name as in @samp{"First I. Last"
6058 <login@@host.domain>}.
6059 @c -------------------------
6060 @cindex header field, @samp{Organization:}
6061 @cindex @samp{Organization:} header field
6062 @item Organization Field
6063 People usually list the name of the company where they work here.
6064 @c -------------------------
6065 @item Other Field
6066 Set any arbitrary header field and value here. Unless the header field
6067 is a standard one, precede the name of your field's label with
6068 @samp{X-}, as in @samp{X-Fruit-of-the-Day:}.
6069 @c -------------------------
6070 @item Attribution Verb
6071 This value overrides the setting of
6072 @code{mh-extract-from-attribution-verb}. @xref{Inserting Letter}.
6073 @c -------------------------
6074 @cindex signature
6075 @vindex mh-signature-file-name
6076 @item Signature
6077 Set your signature with this item. You can specify the contents of
6078 @code{mh-signature-file-name}, a file, or a function.
6079 @xref{Signature}.
6080 @c -------------------------
6081 @item GPG Key ID
6082 Specify a different key to sign or encrypt messages.
6083 @end table
6084
6085 @cindex Identity menu
6086 @cindex menu, Identity
6087 @findex mh-insert-identity
6088 @kindex C-c C-d
6089
6090 You can select the identities you have added via the menu called
6091 @samp{Identity} in the MH-Letter buffer. You can also use @kbd{C-c
6092 C-d} (@code{mh-insert-identity}). To clear the fields and signature
6093 added by the identity, select the @samp{None} identity.
6094
6095 @cindex menu item, @samp{Identity > Customize Identities}
6096 @cindex menu item, @samp{Identity > Save as Default}
6097 @cindex menu item, @samp{Identity > Set Default for Session}
6098 @cindex @samp{Identity > Customize Identities} menu item
6099 @cindex @samp{Identity > Save as Default} menu item
6100 @cindex @samp{Identity > Set Default for Session} menu item
6101 @vindex mh-identity-default
6102
6103 The @samp{Identity} menu contains two other items to save you from
6104 having to set the identity on every message. The menu item @samp{Set
6105 Default for Session} can be used to set the default identity to the
6106 current identity until you exit Emacs. The menu item @samp{Save as
6107 Default} sets the option @code{mh-identity-default} to the current
6108 identity setting. You can also customize the option
6109 @code{mh-identity-default} in the usual fashion. If you find that you
6110 need to add another identity, the menu item @samp{Customize
6111 Identities} is available for your convenience.
6112
6113 @cindex regular expressions, @code{mh-auto-fields-list}
6114 @vindex mh-auto-fields-list
6115
6116 The option @code{mh-auto-fields-list} can also be used to set the
6117 identity depending on the recipient to provide even more control. To
6118 customize @code{mh-auto-fields-list}, click on the @samp{INS} button
6119 and enter a regular expression for the recipient's address
6120 @ifnothtml
6121 (@pxref{Regexps, , Syntax of Regular Expressions, emacs, The
6122 GNU Emacs Manual}).
6123 @end ifnothtml
6124 @ifhtml
6125 (see the section
6126 @uref{http://www.gnu.org/software/emacs/manual/html_node/Regexps.html,
6127 Syntax of Regular Expressions} in
6128 @cite{The GNU Emacs Manual}).
6129 @end ifhtml
6130 Click on the @samp{INS} button with the @samp{Add at least one item
6131 below} label. The @samp{Value Menu} contains the following menu items:
6132
6133 @table @samp
6134 @item Identity
6135 Select an identity from those configured in @code{mh-identity-list}.
6136 All of the information for that identity will be added if the
6137 recipient matches.
6138 @c -------------------------
6139 @cindex @samp{Fcc:} header field
6140 @cindex header field, @samp{Fcc:}
6141 @item Fcc Field
6142 Insert an @samp{Fcc:} header field with the folder you provide. When
6143 you send the message, MH will put a copy of your message in this
6144 folder.
6145 @c -------------------------
6146 @cindex @samp{Mail-Followup-To:} header field
6147 @cindex header field, @samp{Mail-Followup-To:}
6148 @item Mail-Followup-To Field
6149 Insert an @samp{Mail-Followup-To:} header field with the recipients
6150 you provide. If the recipient's mail user agent supports this header
6151 field@footnote{@samp{Mail-Followup-To:} is supported by nmh.}, then
6152 their replies will go to the addresses listed. This is useful if their
6153 replies go both to the list and to you and you don't have a mechanism
6154 to suppress duplicates. If you reply to someone not on the list, you
6155 must either remove the @samp{Mail-Followup-To:} field, or ensure the
6156 recipient is also listed there so that he receives replies to your
6157 reply.
6158 @c -------------------------
6159 @item Other Field
6160 Other header fields may be added using this menu item.
6161 @end table
6162
6163 @findex mh-insert-auto-fields
6164 @kindex C-c M-d
6165 @vindex mh-auto-fields-prompt-flag
6166
6167 These fields can only be added after the recipient is known. Because
6168 you can continue to add recipients as you edit the draft, MH-E waits
6169 until the message is sent to perform the auto-insertions. This seems
6170 strange at first, but you'll get used to it. There are two ways to
6171 help you feel that the desired fields are added. The first is the
6172 action when the message is sent: if any fields are added
6173 automatically, you are given a chance to see and to confirm these
6174 fields before the message is actually sent. You can do away with this
6175 confirmation by turning off the option
6176 @code{mh-auto-fields-prompt-flag}. The second method is manual: once
6177 the header contains one or more recipients, you may run the command
6178 @kbd{C-c M-d} (@code{mh-insert-auto-fields}) or choose the
6179 @samp{Identity -> Insert Auto Fields} menu item to insert these fields
6180 manually. However, if you use this command, the automatic insertion
6181 when the message is sent is disabled.
6182
6183 @vindex mh-auto-fields-list
6184 @vindex mh-identity-list
6185
6186 You should avoid using the same header field in
6187 @code{mh-auto-fields-list} and @code{mh-identity-list} definitions
6188 that may apply to the same message as the result is undefined.
6189
6190 @vindex mh-identity-handlers
6191 @vindex mh-identity-list
6192
6193 The option @code{mh-identity-handlers} is used to change the way that
6194 fields, signatures, and attributions in @code{mh-identity-list} are
6195 added. To customize @code{mh-identity-handlers}, replace the name of
6196 an existing handler function associated with the field you want to
6197 change with the name of a function you have written. You can also
6198 click on an @samp{INS} button and insert a field of your choice and
6199 the name of the function you have written to handle it.
6200
6201 @vindex mh-identity-list
6202
6203 The @samp{Field} field can be any field that you've used in your
6204 @code{mh-identity-list}. The special fields @samp{:attribution-verb},
6205 @samp{:signature}, or @samp{:pgg-default-user-id} are used for the
6206 @code{mh-identity-list} choices @samp{Attribution Verb},
6207 @samp{Signature}, and @samp{GPG Key ID} respectively.
6208
6209 The handler associated with the @samp{:default} field is used when no
6210 other field matches.
6211
6212 The handler functions are passed two or three arguments: the field
6213 itself (for example, @samp{From}), or one of the special fields (for
6214 example, @samp{:signature}), and the action @samp{'remove} or
6215 @samp{'add}. If the action is @samp{'add}, an additional argument
6216 containing the value for the field is given.
6217
6218 @node Speedbar, Menu Bar, Identities, Top
6219 @chapter The Speedbar
6220
6221 @cindex folder navigation
6222 @cindex speedbar
6223 @findex mh-visit-folder
6224 @kindex F v
6225 @kindex M-x speedbar
6226 @kindex Mouse-2
6227
6228 You can also use the speedbar
6229 @ifnothtml
6230 (@pxref{Speedbar, , Speedbar Frames, emacs, The GNU Emacs Manual},)
6231 @end ifnothtml
6232 @ifhtml
6233 (see the section
6234 @uref{http://www.gnu.org/software/emacs/manual/html_node/Speedbar.html,
6235 Speedbar Frames} in @cite{The GNU Emacs Manual})
6236 @end ifhtml
6237 to view your folders. To bring up the speedbar, run @kbd{M-x speedbar
6238 @key{RET}}. You will see a new frame appear with all of your MH
6239 folders. Folders with unseen messages appear in boldface. Click on a
6240 folder name with @kbd{Mouse-2} to visit that folder in a similar
6241 fashion to the command @kbd{F v} (@code{mh-visit-folder})
6242 (@pxref{Folders}). Click on the @samp{+} icon to expand and view the
6243 sub-folders of that folder.
6244
6245 The speedbar can be manipulated with the keyboard as well. Use the
6246 Emacs navigational keys (like the arrow keys, or @kbd{C-n}) to move
6247 the cursor over the desired folder and then use the shortcuts for the
6248 menu items listed in the table below.
6249
6250 @table @samp
6251 @findex mh-speed-view
6252 @item Visit Folder (@key{RET})
6253 Visits the selected folder just as if you had used @kbd{F v}
6254 (@code{mh-speed-view}).
6255 @c -------------------------
6256 @findex mh-speed-expand-folder
6257 @item Expand Nested Folders (@kbd{+})
6258 Expands the selected folder in the speedbar, exposing the children
6259 folders inside it (@code{mh-speed-expand-folder}).
6260 @c -------------------------
6261 @findex mh-speed-contract-folder
6262 @item Contract Nested Folders (@kbd{-})
6263 Contracts or collapses the selected folder in the speedbar, hiding the
6264 children folders inside it (@code{mh-speed-contract-folder}).
6265 @c -------------------------
6266 @findex mh-speed-refresh
6267 @item Refresh Speedbar (@kbd{r})
6268 Regenerates the list of folders in the speedbar. Run this command if
6269 you've added or deleted a folder, or want to update the unseen message
6270 count before the next automatic update (@code{mh-speed-refresh}).
6271 @end table
6272
6273 @findex delete-frame
6274 @kindex C-x 5 0
6275 @kindex Mouse-3
6276
6277 You can click on @kbd{Mouse-3} to bring up a context menu that
6278 contains these items. Dismiss the speedbar with @kbd{C-x 5 0}
6279 (@code{delete-frame}).
6280
6281 @cindex @command{flists}
6282 @cindex MH commands, @command{flists}
6283 @cindex @samp{mh-speedbar} customization group
6284 @cindex customization group, @samp{mh-speedbar}
6285
6286 The MH-E speedbar uses the MH command @command{flists}@footnote{See
6287 the section @uref{@value{MH-BOOK-HOME}/morseq.html#flist, Searching for
6288 Sequences with flist} in the MH book.} to generate the list of
6289 folders. The @samp{mh-speedbar} customization group contains the
6290 following option which controls how often the speedbar calls
6291 @command{flists}.
6292
6293 @vtable @code
6294 @item mh-speed-update-interval
6295 Time between speedbar updates in seconds (default: 60). Set to 0 to
6296 disable automatic update.
6297 @end vtable
6298
6299 You can modify the appearance of the folders in the speedbar by
6300 customizing the following faces.
6301
6302 @vtable @code
6303 @item mh-speedbar-folder
6304 Basic folder face.
6305 @c -------------------------
6306 @item mh-speedbar-folder-with-unseen-messages
6307 Folder face when folder contains unread messages.
6308 @c -------------------------
6309 @item mh-speedbar-selected-folder
6310 Selected folder face.
6311 @c -------------------------
6312 @item mh-speedbar-selected-folder-with-unseen-messages
6313 Selected folder face when folder contains unread messages.
6314 @end vtable
6315
6316 @node Menu Bar, Tool Bar, Speedbar, Top
6317 @chapter The Menu Bar
6318
6319 @cindex @samp{Folder} menu
6320 @cindex @samp{Identity} menu
6321 @cindex @samp{Letter} menu
6322 @cindex @samp{Message} menu
6323 @cindex @samp{Search} menu
6324 @cindex @samp{Sequence} menu
6325 @cindex Folder menu
6326 @cindex Identity menu
6327 @cindex Letter menu
6328 @cindex MH-Folder mode
6329 @cindex MH-Letter mode
6330 @cindex MH-Search mode
6331 @cindex Message menu
6332 @cindex Search menu
6333 @cindex Sequence menu
6334 @cindex menu bar
6335 @cindex menu, Folder
6336 @cindex menu, Identity
6337 @cindex menu, Letter
6338 @cindex menu, Message
6339 @cindex menu, Search
6340 @cindex menu, Sequence
6341 @cindex menu, @samp{Folder}
6342 @cindex menu, @samp{Identity}
6343 @cindex menu, @samp{Letter}
6344 @cindex menu, @samp{Message}
6345 @cindex menu, @samp{Search}
6346 @cindex menu, @samp{Sequence}
6347 @cindex modes, MH-Folder
6348 @cindex modes, MH-Letter
6349 @cindex modes, MH-Search
6350
6351 For those of you who prefer to mouse and menu instead of using the
6352 meta-coke-bottle-bucky keys, MH-E provides menu items for most of its
6353 functions. The MH-Folder buffer adds the @samp{Folder},
6354 @samp{Message}, and @samp{Sequence} menus. The MH-Letter buffer adds
6355 the @samp{Identity} and @samp{Letter} menus. The MH-Search buffer adds
6356 the @samp{Search} menu. There's no need to list the actual items here,
6357 as you can more easily see them for yourself, and the functions are
6358 already described elsewhere in this manual.
6359
6360 For a description of the menu bar, please
6361 @ifnothtml
6362 @xref{Menu Bar, , The Menu Bar, emacs, The GNU Emacs Manual}.
6363 @end ifnothtml
6364 @ifhtml
6365 see the section
6366 @uref{http://www.gnu.org/software/emacs/manual/html_node/Menu-Bar.html,
6367 The Menu Bar} in @cite{The GNU Emacs Manual}.
6368 @end ifhtml
6369
6370 The Emacs manual describes how to get online help for a particular
6371 menu item. You can also look up a menu item in the index of this
6372 manual in two ways: all of the menu items are listed alphabetically,
6373 and you can also browse all of the items under the index entry
6374 @samp{menu item}.
6375
6376 @node Tool Bar, Searching, Menu Bar, Top
6377 @chapter The Tool Bar
6378
6379 @cindex tool bar
6380
6381 Emacs also provides a graphical tool bar. For a description of the
6382 tool bar, please
6383 @ifnothtml
6384 @xref{Tool Bars, , Tool Bars, emacs, The GNU Emacs Manual}.
6385 @end ifnothtml
6386 @ifhtml
6387 see the section
6388 @uref{http://www.gnu.org/software/emacs/manual/html_node/Tool-Bars.html,
6389 Tool Bars} in @cite{The GNU Emacs Manual}.
6390 @end ifhtml
6391
6392 @cindex @samp{mh-tool-bar} customization group
6393 @cindex customization group, @samp{mh-tool-bar}
6394
6395 MH-E adds several icons to this tool bar; you can modify the MH-E
6396 aspects of the tool bar via the @samp{mh-tool-bar} customization group.
6397
6398 @vtable @code
6399 @item mh-tool-bar-folder-buttons
6400 List of buttons to include in MH-Folder tool bar (default: a checklist
6401 too long to list here).
6402 @c -------------------------
6403 @item mh-tool-bar-letter-buttons
6404 List of buttons to include in MH-Letter tool bar (default: a checklist
6405 too long to list here).
6406 @c -------------------------
6407 @item mh-tool-bar-search-function
6408 Function called by the tool bar search button (default:
6409 @code{mh-search}).
6410 @c -------------------------
6411 @item mh-xemacs-tool-bar-position
6412 Tool bar location (default: @samp{Same As Default Tool Bar}).
6413 @c -------------------------
6414 @item mh-xemacs-use-tool-bar-flag
6415 If @samp{on}, use tool bar (default: @samp{on}, if supported).
6416 @end vtable
6417
6418 In GNU Emacs, icons for some of MH-E's functions are added to the tool
6419 bar. In XEmacs, you have the opportunity to create a separate tool bar for
6420 the MH-E icons.
6421
6422 @vindex mh-tool-bar-folder-buttons
6423 @vindex mh-tool-bar-letter-buttons
6424
6425 In either case, you can select which of these functions you'd like to
6426 see by customizing the options @code{mh-tool-bar-folder-buttons} and
6427 @code{mh-tool-bar-letter-buttons}. As you probably guessed, the former
6428 customizes the tool bar in MH-Folder mode and the latter in MH-Letter
6429 mode. Both of these options present you with a list of functions;
6430 check the functions whose icons you want to see and clear the check
6431 boxes for those you don't.
6432
6433 @findex mh-search
6434 @vindex mh-tool-bar-search-function
6435
6436 The function associated with the searching icon can be set via the
6437 option @code{mh-tool-bar-search-function}. By default, this is set to
6438 @code{mh-search}. @xref{Searching}. You can also choose @samp{Other
6439 Function} from the @samp{Value Menu} and enter a function of your own
6440 choosing.
6441
6442 @vindex mh-xemacs-use-tool-bar-flag
6443
6444 XEmacs provides a couple of extra options. The first,
6445 @code{mh-xemacs-use-tool-bar-flag}, controls whether to show the MH-E
6446 icons at all. By default, this option is turned on if the window
6447 system supports tool bars. If your system doesn't support tool bars,
6448 then you won't be able to turn on this option.
6449
6450 @vindex mh-xemacs-tool-bar-position
6451
6452 The second extra option is @code{mh-xemacs-tool-bar-position} which
6453 controls the placement of the tool bar along the four edges of the
6454 frame. You can choose from one of @samp{Same As Default Tool Bar},
6455 @samp{Top}, @samp{Bottom}, @samp{Left}, or @samp{Right}. If this
6456 variable is set to anything other than @samp{Same As Default Tool Bar}
6457 and the default tool bar is in a different location, then two tool
6458 bars will be displayed: the MH-E tool bar and the default tool bar.
6459
6460 @node Searching, Threading, Tool Bar, Top
6461 @chapter Searching Through Messages
6462
6463 @cindex @samp{Search} menu
6464 @cindex menu, @samp{Search}
6465 @cindex searching
6466 @findex mh-search
6467 @kindex F s
6468
6469 Earlier, the command @kbd{F s} (@code{mh-search}) was introduced which
6470 helps you find messages that lie buried in your folders
6471 (@pxref{Folders}). This chapter covers this command in more detail.
6472 Several commands are used to compose the search criteria and to start
6473 searching. A couple of them can be found in the @samp{Search} menu.
6474
6475 @table @kbd
6476 @kindex C-c ?
6477 @findex mh-help
6478 @item C-c ?
6479 Display cheat sheet for the MH-E commands (@code{mh-help}).
6480 @c -------------------------
6481 @cindex @samp{Search > Perform Search} menu item
6482 @cindex menu item, @samp{Search > Perform Search}
6483 @kindex C-c C-c
6484 @findex mh-index-do-search
6485 @item C-c C-c
6486 Find messages using @code{mh-search-program}
6487 (@code{mh-index-do-search}).
6488 @c -------------------------
6489 @cindex @samp{Search > Search with pick} menu item
6490 @cindex menu item, @samp{Search > Search with pick}
6491 @kindex C-c C-p
6492 @findex mh-pick-do-search
6493 @item C-c C-p
6494 Find messages using @command{pick} (@code{mh-pick-do-search}).
6495 @c -------------------------
6496 @kindex C-c ?
6497 @findex mh-help
6498 @item C-c ?
6499 Display cheat sheet for the MH-E commands (@code{mh-help}).
6500 @c -------------------------
6501 @kindex C-c C-f C-a
6502 @kindex C-c C-f a
6503 @findex mh-to-field
6504 @item C-c C-f a
6505 @itemx C-c C-f C-a
6506 Move to @samp{Mail-Reply-To:} header field (@code{mh-to-field}).
6507 @c -------------------------
6508 @kindex C-c C-f C-b
6509 @kindex C-c C-f b
6510 @item C-c C-f b
6511 @itemx C-c C-f C-b
6512 Move to @samp{Bcc:} header field (@code{mh-to-field}).
6513 @c -------------------------
6514 @kindex C-c C-f C-c
6515 @kindex C-c C-f c
6516 @item C-c C-f c
6517 @itemx C-c C-f C-c
6518 Move to @samp{Cc:} header field (@code{mh-to-field}).
6519 @c -------------------------
6520 @kindex C-c C-f C-d
6521 @kindex C-c C-f d
6522 @item C-c C-f d
6523 @itemx C-c C-f C-d
6524 Move to @samp{Dcc:} header field (@code{mh-to-field}).
6525 @c -------------------------
6526 @kindex C-c C-f C-f
6527 @kindex C-c C-f f
6528 @item C-c C-f f
6529 @itemx C-c C-f C-f
6530 Move to @samp{Fcc:} header field (@code{mh-to-field}).
6531 @c -------------------------
6532 @kindex C-c C-f C-l
6533 @kindex C-c C-f l
6534 @item C-c C-f l
6535 @itemx C-c C-f C-l
6536 Move to @samp{Mail-Followup-To:} header field (@code{mh-to-field}).
6537 @c -------------------------
6538 @kindex C-c C-f C-m
6539 @kindex C-c C-f m
6540 @item C-c C-f m
6541 @itemx C-c C-f C-m
6542 Move to @samp{From:} header field (@code{mh-to-field}).
6543 @c -------------------------
6544 @kindex C-c C-f C-r
6545 @kindex C-c C-f r
6546 @item C-c C-f r
6547 @itemx C-c C-f C-r
6548 Move to @samp{Reply-To:} header field (@code{mh-to-field}).
6549 @c -------------------------
6550 @kindex C-c C-f C-s
6551 @kindex C-c C-f s
6552 @item C-c C-f s
6553 @itemx C-c C-f C-s
6554 Move to @samp{Subject:} header field (@code{mh-to-field}).
6555 @c -------------------------
6556 @kindex C-c C-f C-t
6557 @kindex C-c C-f t
6558 @item C-c C-f t
6559 @itemx C-c C-f C-t
6560 Move to @samp{To:} header field (@code{mh-to-field}).
6561 @end table
6562
6563 Another few commands are available in the MH-Folder buffer resulting
6564 from a search.
6565
6566 @table @kbd
6567 @kindex @key{TAB}
6568 @findex mh-index-next-folder
6569 @item @key{TAB}
6570 Jump to the next folder marker (@code{mh-index-next-folder}).
6571 @c -------------------------
6572 @kindex S-@key{TAB}
6573 @findex mh-index-previous-folder
6574 @item S-@key{TAB}
6575 Jump to the previous folder marker (@code{mh-index-previous-folder}).
6576 @c -------------------------
6577 @kindex v
6578 @findex mh-index-visit-folder
6579 @item v
6580 Visit original folder from where the message at point was found
6581 (@code{mh-index-visit-folder}).
6582 @end table
6583
6584 @cindex @samp{mh-search} customization group
6585 @cindex customization group, @samp{mh-search}
6586
6587 There is one option from the @samp{mh-search} customization group used
6588 in searching.
6589
6590 @vtable @code
6591 @item mh-search-program
6592 Search program that MH-E shall use (default: @samp{Auto-detect}).
6593 @end vtable
6594
6595 The following hook is available.
6596
6597 @vtable @code
6598 @item mh-search-mode-hook
6599 Hook run upon entry to @code{mh-search-mode} (default: @code{nil}).
6600 @end vtable
6601
6602 The following face is available.
6603
6604 @vtable @code
6605 @item mh-search-folder
6606 Folder heading face in MH-Folder buffers created by searches.
6607 @end vtable
6608
6609 @findex mh-search-folder
6610 @kindex F s
6611
6612 The command @kbd{F s} (@code{mh-search-folder}) helps you find
6613 messages in your entire corpus of mail. You can search for messages to
6614 or from a particular person or about a particular subject. In fact,
6615 you can also search for messages containing selected strings in any
6616 arbitrary header field or any string found within the messages.
6617
6618 @cindex @command{pick}
6619 @cindex MH commands, @command{pick}
6620
6621 Out of the box, MH-E uses @command{pick} to find messages. With a
6622 little extra effort, you can set an indexing program which rewards you
6623 with extremely quick results. The drawback is that sometimes the index
6624 does not contain the words you're looking for. You can still use
6625 @command{pick} in these situations.
6626
6627 You are prompted for the folder to search. This can be @samp{all} to
6628 search all folders. Note that the search works recursively on the
6629 listed folder.
6630
6631 @cindex MH-Search mode
6632 @cindex modes, MH-Search
6633
6634 Next, an MH-Search buffer appears where you can enter search criteria.
6635
6636 @cartouche
6637 @smallexample
6638 From:
6639 To:
6640 Cc:
6641 Date:
6642 Subject:
6643 --------
6644 #
6645
6646
6647
6648
6649
6650
6651
6652
6653 --:** search-pattern All L7 (MH-Search)---------------------------
6654 Type C-c C-c to search messages, C-c C-p to use pick, C-c ? for help
6655 @end smallexample
6656 @end cartouche
6657 @i{Search window}
6658
6659 @cindex @command{pick}
6660 @cindex MH commands, @command{pick}
6661
6662 Edit this template by entering your search criteria in an appropriate
6663 header field that is already there, or create a new field yourself. If
6664 the string you're looking for could be anywhere in a message, then
6665 place the string underneath the row of dashes.
6666
6667 As an example, let's say that we want to find messages from Ginnean
6668 about horseback riding in the Kosciusko National Park (Australia)
6669 during January, 1994. Normally we would start with a broad search and
6670 narrow it down if necessary to produce a manageable amount of data,
6671 but we'll cut to the chase and create a fairly restrictive set of
6672 criteria as follows:
6673
6674 @smallexample
6675 @group
6676 From: ginnean
6677 To:
6678 Cc:
6679 Date: Jan 1994
6680 Subject:
6681 --------
6682 horse
6683 kosciusko
6684 @end group
6685 @end smallexample
6686
6687 @findex mh-to-field
6688 @kindex C-c C-f C-t
6689
6690 As with MH-Letter mode, MH-Search provides commands like @kbd{C-c C-f
6691 C-t} (@code{mh-to-field}) to help you fill in the blanks.
6692 @xref{Editing Message}.
6693
6694 @kindex F s
6695 @vindex mh-search-mode-hook
6696
6697 If you find that you do the same thing over and over when editing the
6698 search template, you may wish to bind some shortcuts to keys. This can
6699 be done with the variable @code{mh-search-mode-hook}, which is called
6700 when @kbd{F s} is run on a new pattern.
6701
6702 @findex mh-index-do-search
6703 @findex mh-pick-do-search
6704 @kindex C-c C-c
6705 @kindex C-c C-p
6706
6707 To perform the search, type @kbd{C-c C-c} (@code{mh-index-do-search}).
6708 Sometimes you're searching for text that is either not indexed, or
6709 hasn't been indexed yet. In this case you can override the default
6710 method with the pick method by running the command @kbd{C-c C-p}
6711 (@code{mh-pick-do-search}).
6712
6713 @cindex folders, @samp{+mhe-index}
6714 @cindex @samp{+mhe-index}
6715 @findex mh-index-next-folder
6716 @findex mh-index-previous-folder
6717 @kindex @key{TAB}
6718 @kindex S-@key{TAB}
6719 @vindex mh-search-folder
6720
6721 The messages that are found are put in a temporary sub-folder of
6722 @samp{+mhe-index} and are displayed in an MH-Folder buffer. This
6723 buffer is special because it displays messages from multiple folders;
6724 each set of messages from a given folder has a heading with the folder
6725 name. The appearance of the heading can be modified by customizing the
6726 face @code{mh-search-folder}. You can jump back and forth between the
6727 headings using the commands @kbd{@key{TAB}}
6728 (@code{mh-index-next-folder}) and @kbd{S-@key{TAB}}
6729 (@code{mh-index-previous-folder}).
6730
6731 @findex mh-index-visit-folder
6732 @findex mh-rescan-folder
6733 @kindex F r
6734 @kindex v
6735
6736 In addition, the command @kbd{v} (@code{mh-index-visit-folder}) can be
6737 used to visit the folder of the message at point. Initially, only the
6738 messages that matched the search criteria are displayed in the folder.
6739 While the temporary buffer has its own set of message numbers, the
6740 actual messages numbers are shown in the visited folder. Thus, the
6741 command @kbd{v} is useful to find the actual message number of an
6742 interesting message, or to view surrounding messages with the command
6743 @kbd{F r} @code{mh-rescan-folder}. @xref{Folders}.
6744
6745 @findex mh-kill-folder
6746 @kindex F k
6747
6748 Because this folder is temporary, you'll probably get in the habit of
6749 killing it when you're done with @kbd{F k} (@code{mh-kill-folder}).
6750 @xref{Folders}.
6751
6752 @kindex F s
6753
6754 You can regenerate the results by running @kbd{F s} with a prefix
6755 argument.
6756
6757 @cindex @command{procmail}
6758 @cindex Unix commands, @command{procmail}
6759 @cindex @samp{X-MHE-Checksum:} header field
6760 @cindex header field, @samp{X-MHE-Checksum:}
6761
6762 Note: This command uses an @samp{X-MHE-Checksum:} header field to
6763 cache the MD5 checksum of a message. This means that if an incoming
6764 message already contains an @samp{X-MHE-Checksum:} field, that message
6765 might not be found by this command. The following @command{procmail}
6766 recipe avoids this problem by renaming the existing header field:
6767
6768 @smallexample
6769 @group
6770 :0 wf
6771 | formail -R "X-MHE-Checksum" "X-Old-MHE-Checksum"
6772 @end group
6773 @end smallexample
6774
6775 @xref{Limits}, for an alternative interface to searching.
6776
6777 @section Configuring Indexed Searches
6778
6779 @cindex @command{grep}
6780 @cindex @command{mairix}
6781 @cindex @command{namazu}
6782 @cindex @command{pick}
6783 @cindex @command{swish++}
6784 @cindex @command{swish-e}
6785 @cindex Unix commands, @command{grep}
6786 @cindex Unix commands, @command{mairix}
6787 @cindex Unix commands, @command{namazu}
6788 @cindex Unix commands, @command{pick}
6789 @cindex Unix commands, @command{swish++}
6790 @cindex Unix commands, @command{swish-e}
6791 @findex mh-search
6792 @kindex F s
6793 @vindex mh-search-program
6794
6795 The command @kbd{F s} (@code{mh-search}) runs the command defined by
6796 the option @code{mh-search-program}. The default value is
6797 @samp{Auto-detect} which means that MH-E will automatically choose one
6798 of @command{swish++}, @command{swish-e}, @command{mairix},
6799 @command{namazu}, @command{pick} and @command{grep} in that order. If,
6800 for example, you have both @command{swish++} and @command{mairix}
6801 installed and you want to use @command{mairix}, then you can set this
6802 option to @samp{mairix}.
6803
6804 The following sub-sections describe how to set up the various indexing
6805 programs to use with MH-E.
6806
6807 @subsection swish++
6808
6809 @cindex @command{swish++}
6810 @cindex Unix commands, @command{swish++}
6811
6812 In the examples below, replace @file{/home/user/Mail} with the path to
6813 your MH directory.
6814
6815 First create the directory @file{/home/user/Mail/.swish++}. Then
6816 create the file @file{/home/user/Mail/.swish++/swish++.conf} with the
6817 following contents:
6818
6819 @smallexample
6820 @group
6821 IncludeMeta Bcc Cc Comments Content-Description From Keywords
6822 IncludeMeta Newsgroups Resent-To Subject To
6823 IncludeMeta Message-Id References In-Reply-To
6824 IncludeFile Mail *
6825 IndexFile /home/user/Mail/.swish++/swish++.index
6826 @end group
6827 @end smallexample
6828
6829 Use the following command line to generate the swish index. Run this
6830 daily from cron:
6831
6832 @smallexample
6833 @group
6834 find /home/user/Mail -path /home/user/Mail/mhe-index -prune \
6835 -o -path /home/user/Mail/.swish++ -prune \
6836 -o -name "[0-9]*" -print \
6837 | index -c /home/user/Mail/.swish++/swish++.conf -
6838 @end group
6839 @end smallexample
6840
6841 This command does not index the folders that hold the results of your
6842 searches in @samp{+mhe-index} since they tend to be ephemeral and the
6843 original messages are indexed anyway.
6844
6845 @cindex @command{index}
6846 @cindex Unix commands, @command{index}
6847 @cindex @command{index++}
6848 @cindex Unix commands, @command{index++}
6849
6850 On some systems (Debian GNU/Linux, for example), use @command{index++}
6851 instead of @command{index}.
6852
6853 @subsection swish
6854
6855 @cindex @command{swish-e}
6856 @cindex Unix commands, @command{swish-e}
6857
6858 In the examples below, replace @file{/home/user/Mail} with the path to
6859 your MH directory.
6860
6861 First create the directory @file{/home/user/Mail/.swish}. Then create
6862 the file @file{/home/user/Mail/.swish/config} with the following
6863 contents:
6864
6865 @smallexample
6866 @group
6867 DefaultContents TXT*
6868 IndexDir /home/user/Mail
6869 IndexFile /home/user/Mail/.swish/index
6870 IndexName "Mail Index"
6871 IndexDescription "Mail Index"
6872 IndexPointer "http://nowhere"
6873 IndexAdmin "nobody"
6874 #MetaNames automatic
6875 IndexReport 3
6876 FollowSymLinks no
6877 UseStemming no
6878 IgnoreTotalWordCountWhenRanking yes
6879 WordCharacters abcdefghijklmnopqrstuvwxyz0123456789-
6880 BeginCharacters abcdefghijklmnopqrstuvwxyz
6881 EndCharacters abcdefghijklmnopqrstuvwxyz0123456789
6882 IgnoreLimit 50 1000
6883 IndexComments 0
6884 FileRules filename contains \D
6885 FileRules pathname contains /home/user/Mail/.swish
6886 FileRules pathname contains /home/user/Mail/mhe-index
6887 FileRules filename is index
6888 @end group
6889 @end smallexample
6890
6891 This configuration does not index the folders that hold the results of
6892 your searches in @samp{+mhe-index} since they tend to be ephemeral and
6893 the original messages are indexed anyway.
6894
6895 If there are any directories you would like to ignore, append lines
6896 like the following to @file{config}:
6897
6898 @smallexample
6899 FileRules pathname contains /home/user/Mail/scripts
6900 @end smallexample
6901
6902 @cindex @command{swish-e}
6903 @cindex Unix commands, @command{swish-e}
6904
6905 Use the following command line to generate the swish index. Run this
6906 daily from cron:
6907
6908 @smallexample
6909 swish-e -c /home/user/Mail/.swish/config
6910 @end smallexample
6911
6912 @subsection mairix
6913
6914 @cindex @command{mairix}
6915 @cindex Unix commands, @command{mairix}
6916
6917 In the examples below, replace @file{/home/user/Mail} with the path to
6918 your MH directory.
6919
6920 First create the directory @file{/home/user/Mail/.mairix}. Then create
6921 the file @file{/home/user/Mail/.mairix/config} with the following
6922 contents:
6923
6924 @smallexample
6925 @group
6926 base=/home/user/Mail
6927
6928 # List of folders that should be indexed. 3 dots at the end means there
6929 # are subfolders within the folder
6930 mh=archive...:inbox:drafts:news:sent:trash
6931
6932 vfolder_format=raw
6933 database=/home/user/Mail/mairix/database
6934 @end group
6935 @end smallexample
6936
6937 Use the following command line to generate the mairix index. Run this daily
6938 from cron:
6939
6940 @smallexample
6941 mairix -f /home/user/Mail/.mairix/config
6942 @end smallexample
6943
6944 @subsection namazu
6945
6946 @cindex @command{namazu}
6947 @cindex Unix commands, @command{namazu}
6948
6949 In the examples below, replace @file{/home/user/Mail} with the path to
6950 your MH directory.
6951
6952 First create the directory @file{/home/user/Mail/.namazu}. Then create
6953 the file @file{/home/user/Mail/.namazu/mknmzrc} with the following
6954 contents:
6955
6956 @smallexample
6957 @group
6958 package conf; # Don't remove this line!
6959 $ADDRESS = 'user@@localhost';
6960 $ALLOW_FILE = "[0-9]*";
6961 $EXCLUDE_PATH = "^/home/user/Mail/(mhe-index|spam)";
6962 @end group
6963 @end smallexample
6964
6965 This configuration does not index the folders that hold the results of
6966 your searches in @samp{+mhe-index} since they tend to be ephemeral and
6967 the original messages are indexed anyway.
6968
6969 Use the following command line to generate the namazu index. Run this
6970 daily from cron:
6971
6972 @smallexample
6973 mknmz -f /home/user/Mail/.namazu/mknmzrc -O /home/user/Mail/.namazu \
6974 /home/user/Mail
6975 @end smallexample
6976
6977 @subsection pick
6978
6979 @cindex @command{pick}
6980 @cindex MH commands, @command{pick}
6981
6982 This search method does not require any setup.
6983
6984 Read @command{pick}(1) or the section
6985 @uref{@value{MH-BOOK-HOME}/finpic.html, Finding Messages with pick} in
6986 the MH book to find out more about how to enter the criteria.
6987
6988 @subsection grep
6989
6990 @cindex @command{grep}
6991 @cindex Unix commands, @command{grep}
6992
6993 This search method does not require any setup.
6994
6995 Unlike the other search methods, this method does not use the
6996 MH-Search buffer. Instead, you simply enter a regular expression in
6997 the minibuffer. For help in constructing regular expressions, see your
6998 man page for @command{grep}.
6999
7000 @node Threading, Limits, Searching, Top
7001 @chapter Viewing Message Threads
7002
7003 @cindex threading
7004
7005 MH-E groups messages by @dfn{threads} which are messages that are part
7006 of the same discussion and usually all have the same @samp{Subject:}
7007 header field. Other ways to organize messages in a folder include
7008 limiting (@pxref{Limits}) or using full-text indexed searches
7009 (@pxref{Searching}).
7010
7011 @cindex root, in threads
7012 @cindex siblings, in threads
7013 @cindex ancestor, in threads
7014
7015 A thread begins with a single message called a @dfn{root}. All replies
7016 to the same message are @dfn{siblings} of each other. Any message that
7017 has replies to it is an @dfn{ancestor} of those replies.
7018
7019 There are several commands that you can use to navigate and operate on
7020 threads.
7021
7022 @table @kbd
7023 @kindex T ?
7024 @findex mh-prefix-help
7025 @item T ?
7026 Display cheat sheet for the commands of the current prefix in
7027 minibuffer (@code{mh-prefix-help}).
7028 @c -------------------------
7029 @kindex T o
7030 @findex mh-thread-refile
7031 @item T o
7032 Refile (output) thread into folder (@code{mh-thread-refile}).
7033 @c -------------------------
7034 @kindex T d
7035 @findex mh-thread-delete
7036 @item T d
7037 Delete thread (@code{mh-thread-delete}).
7038 @c -------------------------
7039 @kindex T t
7040 @findex mh-toggle-threads
7041 @item T t
7042 Toggle threaded view of folder (@code{mh-toggle-threads}).
7043 @c -------------------------
7044 @kindex T n
7045 @findex mh-thread-next-sibling
7046 @item T n
7047 Display next sibling (@code{mh-thread-next-sibling}).
7048 @c -------------------------
7049 @kindex T p
7050 @findex mh-thread-previous-sibling
7051 @item T p
7052 Display previous sibling (@code{mh-thread-previous-sibling}).
7053 @c -------------------------
7054 @kindex T u
7055 @findex mh-thread-ancestor
7056 @item T u
7057 Display ancestor of current message (@code{mh-thread-ancestor}).
7058 @end table
7059
7060 @cindex @samp{mh-thread} customization group
7061 @cindex customization group, @samp{mh-thread}
7062
7063 The @samp{mh-thread} customization group contains one option.
7064
7065 @vtable @code
7066 @item mh-show-threads-flag
7067 On means new folders start in threaded mode (default: @samp{off}).
7068 @end vtable
7069
7070 @findex mh-toggle-threads
7071 @kindex T t
7072 @vindex mh-large-folder
7073 @vindex mh-show-threads-flag
7074
7075 Threading large number of messages can be time consuming so the option
7076 @code{mh-show-threads-flag} is turned off by default. If you turn on
7077 this option, then threading will be done only if the number of
7078 messages being threaded is less than @code{mh-large-folder}. In any
7079 event, threading can be turned on (and off) with the command @kbd{T t}
7080 (@code{mh-toggle-threads}).
7081
7082 @findex mh-thread-ancestor
7083 @findex mh-thread-next-sibling
7084 @findex mh-thread-previous-sibling
7085 @kindex T n
7086 @kindex T p
7087 @kindex T u
7088
7089 There are a few commands to help you navigate threads. If you do not
7090 care for the way a particular thread has turned, you can move up the
7091 chain of messages with the command @kbd{T u}
7092 (@code{mh-thread-ancestor}. At any point you can use @kbd{T n}
7093 (@code{mh-thread-next-sibling} or @kbd{T p}
7094 (@code{mh-thread-previous-sibling}) to jump to the next or previous
7095 sibling, skipping the sub-threads. The command @kbd{T u} can also take
7096 a prefix argument to jump to the message that started everything.
7097
7098 @findex mh-delete-subject-or-thread
7099 @findex mh-thread-delete
7100 @findex mh-thread-refile
7101 @kindex k
7102 @kindex T d
7103 @kindex T o
7104
7105 There are threaded equivalents for the commands that delete and refile
7106 messages. For example, @kbd{T o} (@code{mh-thread-refile}) refiles the
7107 current message and all its children. Similarly, the command @kbd{T d}
7108 (@code{mh-thread-delete}) deletes the current message and all its
7109 children. These commands do not refile or delete sibling messages.
7110 @xref{Navigating}, for a description of the similar command @kbd{k}
7111 (@code{mh-delete-subject-or-thread}).
7112
7113 @vindex mh-large-folder
7114
7115 If you find that threading is too slow, it may be that you have
7116 @code{mh-large-folder} set too high. Also, threading is one of the few
7117 features of MH-E that really benefits from compiling. If you haven't
7118 compiled MH-E, I encourage you to do so@footnote{If you're not sure if
7119 MH-E has been byte-compiled, you could try running @samp{locate
7120 mh-thread.elc} or otherwise find MH-E on your system and ensure that
7121 @file{mh-thread.elc} exists. If you have multiple versions and you
7122 find that one is compiled but the other is not, then go into your
7123 @samp{*scratch*} buffer in Emacs, enter @kbd{load-path C-j}, and
7124 ensure that the byte-compiled version appears first in the
7125 @code{load-path}. If you find that MH-E is not compiled and you
7126 installed MH-E yourself, please refer to the installation directions
7127 in the file @file{README} in the distribution.}.
7128
7129 @node Limits, Sequences, Threading, Top
7130 @chapter Limiting Display
7131
7132 @cindex limits
7133 @cindex filters
7134
7135 Another way to organize messages in a folder besides threading
7136 (@pxref{Threading}) or using full-text indexed searches
7137 (@pxref{Searching}) is by limiting the folder display to messages that
7138 are similar to the current message.
7139
7140 @table @kbd
7141 @kindex / ?
7142 @findex mh-prefix-help
7143 @item / ?
7144 Display cheat sheet for the commands of the current prefix in
7145 minibuffer (@code{mh-prefix-help}).
7146 @c -------------------------
7147 @cindex @samp{Sequence > Narrow to Tick Sequence} menu item
7148 @cindex menu item, @samp{Sequence > Narrow to Tick Sequence}
7149 @kindex / '
7150 @findex mh-narrow-to-tick
7151 @item / '
7152 Limit to messages in the @samp{tick} sequence
7153 (@code{mh-narrow-to-tick}).
7154 @c -------------------------
7155 @kindex / c
7156 @findex mh-narrow-to-cc
7157 @item / c
7158 Limit to messages with the same @samp{Cc:} field
7159 (@code{mh-narrow-to-cc}).
7160 @c -------------------------
7161 @kindex / m
7162 @findex mh-narrow-to-from
7163 @item / m
7164 Limit to messages with the same @samp{From:} field
7165 (@code{mh-narrow-to-from}).
7166 @c -------------------------
7167 @kindex / g
7168 @findex mh-narrow-to-range
7169 @item / g
7170 Limit to range (@code{mh-narrow-to-range}).
7171 @c -------------------------
7172 @cindex @samp{Sequence > Narrow to Subject Sequence} menu item
7173 @cindex menu item, @samp{Sequence > Narrow to Subject Sequence}
7174 @kindex / s
7175 @findex mh-narrow-to-subject
7176 @item / s
7177 Limit to messages with the same @samp{Subject:} field
7178 (@code{mh-narrow-to-subject}).
7179 @c -------------------------
7180 @kindex / t
7181 @findex mh-narrow-to-to
7182 @item / t
7183 Limit to messages with the same @samp{To:} field
7184 (@code{mh-narrow-to-to}).
7185 @c -------------------------
7186 @cindex @samp{Sequence > Widen from Sequence} menu item
7187 @cindex menu item, @samp{Sequence > Widen from Sequence}
7188 @kindex / w
7189 @findex mh-widen
7190 @item / w
7191 Remove last restriction (@code{mh-widen}).
7192 @end table
7193
7194 All of the limiting commands above refine the display in some way.
7195
7196 @cindex @command{pick}
7197 @cindex MH commands, @command{pick}
7198 @findex mh-narrow-to-cc
7199 @findex mh-narrow-to-from
7200 @findex mh-narrow-to-subject
7201 @findex mh-narrow-to-to
7202 @kindex / c
7203 @kindex / m
7204 @kindex / s
7205 @kindex / t
7206
7207 The commands @kbd{/ c} (@code{mh-narrow-to-cc}), @kbd{/ m}
7208 (@code{mh-narrow-to-from}), @kbd{/ s} (@code{mh-narrow-to-subject}),
7209 and @kbd{/ t} (@code{mh-narrow-to-to}) restrict the display to
7210 messages matching the content of the respective field in the current
7211 message. However, you can give any of these a prefix argument to edit
7212 the @command{pick} expression used to narrow the view@footnote{See
7213 @command{pick}(1) or the section
7214 @uref{@value{MH-BOOK-HOME}/finpic.html, Finding Messages with pick} in
7215 the MH book.}.
7216
7217 @cindex @samp{tick} sequence
7218 @cindex sequence, @samp{tick}
7219 @cindex ticked messages, viewing
7220 @findex mh-narrow-to-range
7221 @findex mh-narrow-to-tick
7222 @kindex / '
7223 @kindex / g
7224
7225 You can also limit the display to messages in the @samp{tick} sequence
7226 with the command @kbd{/ '} (@code{mh-narrow-to-tick}).
7227 @xref{Sequences}, for information on putting message into the
7228 @samp{tick} sequence. Use the @kbd{/ g} (@code{mh-narrow-to-range})
7229 command to limit the display to messages in a range (@pxref{Ranges}).
7230
7231 @findex mh-widen
7232 @kindex / w
7233
7234 Each limit can be undone in turn with the @kbd{/ w} (@code{mh-widen})
7235 command. Give this command a prefix argument to remove all limits.
7236
7237 @node Sequences, Junk, Limits, Top
7238 @chapter Using Sequences
7239
7240 @cindex @samp{Sequence} menu
7241 @cindex menu, @samp{Sequence}
7242 @cindex sequences
7243
7244 For the whole scoop on MH sequences, refer to
7245 @samp{mh-sequence}(5)@footnote{See the section
7246 @uref{@value{MH-BOOK-HOME}/morseq.html, More About Sequences} in the MH
7247 book.}. As you've read, several of the MH-E commands can operate on a
7248 sequence, which is a shorthand for a range or group of messages. For
7249 example, you might want to forward several messages to a friend or
7250 colleague. Here's how to manipulate sequences. These commands are also
7251 available in the @samp{Sequence} menu.
7252
7253 @table @kbd
7254 @cindex @samp{Sequence > Toggle Tick Mark} menu item
7255 @cindex menu item, @samp{Sequence > Toggle Tick Mark}
7256 @kindex '
7257 @findex mh-toggle-tick
7258 @item '
7259 Toggle tick mark of range (@code{mh-toggle-tick}).
7260 @c -------------------------
7261 @kindex S ?
7262 @findex mh-prefix-help
7263 @item S ?
7264 Display cheat sheet for the commands of the current prefix in
7265 minibuffer (@code{mh-prefix-help}).
7266 @c -------------------------
7267 @cindex @samp{Sequence > Narrow to Tick Sequence} menu item
7268 @cindex menu item, @samp{Sequence > Narrow to Tick Sequence}
7269 @kindex S '
7270 @findex mh-narrow-to-tick
7271 @item S '
7272 Limit to ticked messages (@code{mh-narrow-to-tick}).
7273 @c -------------------------
7274 @cindex @samp{Sequence > Delete Message from Sequence...} menu item
7275 @cindex menu item, @samp{Sequence > Delete Message from Sequence...}
7276 @kindex S d
7277 @findex mh-delete-msg-from-seq
7278 @item S d
7279 Delete range from sequence (@code{mh-delete-msg-from-seq}).
7280 @c -------------------------
7281 @cindex @samp{Sequence > Delete Sequence...} menu item
7282 @cindex menu item, @samp{Sequence > Delete Sequence...}
7283 @kindex S k
7284 @findex mh-delete-seq
7285 @item S k
7286 Delete sequence (@code{mh-delete-seq}).
7287 @c -------------------------
7288 @cindex @samp{Sequence > List Sequences in Folder...} menu item
7289 @cindex menu item, @samp{Sequence > List Sequences in Folder...}
7290 @kindex S l
7291 @findex mh-list-sequences
7292 @item S l
7293 List all sequences in folder (@code{mh-list-sequences}).
7294 @c -------------------------
7295 @cindex @samp{Sequence > Narrow to Sequence...} menu item
7296 @cindex menu item, @samp{Sequence > Narrow to Sequence...}
7297 @kindex S n
7298 @findex mh-narrow-to-seq
7299 @item S n
7300 Restrict display to messages in sequence (@code{mh-narrow-to-seq}).
7301 @c -------------------------
7302 @cindex @samp{Sequence > Add Message to Sequence...} menu item
7303 @cindex menu item, @samp{Sequence > Add Message to Sequence...}
7304 @kindex S p
7305 @findex mh-put-msg-in-seq
7306 @item S p
7307 Add range to sequence (@code{mh-put-msg-in-seq}).
7308 @c -------------------------
7309 @cindex @samp{Sequence > List Sequences for Message} menu item
7310 @cindex menu item, @samp{Sequence > List Sequences for Message}
7311 @kindex S s
7312 @findex mh-msg-is-in-seq
7313 @item S s
7314 Display the sequences in which the current message appears
7315 (@code{mh-msg-is-in-seq}).
7316 @c -------------------------
7317 @cindex @samp{Sequence > Widen from Sequence} menu item
7318 @cindex menu item, @samp{Sequence > Widen from Sequence}
7319 @kindex S w
7320 @findex mh-widen
7321 @item S w
7322 Remove last restriction (@code{mh-widen}).
7323 @c -------------------------
7324 @findex mh-update-sequences
7325 @item M-x mh-update-sequences
7326 Flush MH-E's state out to MH@.
7327 @end table
7328
7329 @cindex @samp{mh-sequences} customization group
7330 @cindex customization group, @samp{mh-sequences}
7331
7332 The @samp{mh-sequences} customization group contains the options
7333 associated with sequences.
7334
7335 @vtable @code
7336 @item mh-refile-preserves-sequences-flag
7337 On means that sequences are preserved when messages are refiled
7338 (default: @samp{on}).
7339 @c -------------------------
7340 @item mh-tick-seq
7341 The name of the MH sequence for ticked messages (default: @samp{'tick}).
7342 @c -------------------------
7343 @item mh-update-sequences-after-mh-show-flag
7344 On means flush MH sequences to disk after message is shown (default:
7345 @samp{on}).
7346 @end vtable
7347
7348 The following hook is available.
7349
7350 @vtable @code
7351 @item mh-unseen-updated-hook
7352 Hook run after the unseen sequence has been updated (default: @code{nil}).
7353 @end vtable
7354
7355 @cindex @command{pick}
7356 @cindex MH commands, @command{pick}
7357 @findex mh-put-msg-in-seq
7358 @kindex S p
7359
7360 To place a message in a sequence, use @kbd{S p}
7361 (@code{mh-put-msg-in-seq}). Give @kbd{S p} a range and you can add all
7362 the messages in a sequence to another sequence (for example, @kbd{C-u
7363 S p SourceSequence @key{RET} DestSequence @key{RET}}, @pxref{Ranges}).
7364
7365 @cindex @samp{tick} sequence
7366 @cindex sequence, @samp{tick}
7367 @cindex ticking messages
7368 @findex mh-index-ticked-messages
7369 @findex mh-toggle-tick
7370 @kindex '
7371 @kindex F '
7372 @kindex S p
7373
7374 One specific use of the @kbd{S p} command is @kbd{'}
7375 (@code{mh-toggle-tick}) which adds messages to the @samp{tick}
7376 sequence. This sequence can be viewed later with the @kbd{F '}
7377 (@code{mh-index-ticked-messages}) command (@pxref{Folders}).
7378
7379 @vindex mh-tick-seq
7380
7381 You can customize the option @code{mh-tick-seq} if you already use the
7382 @samp{tick} sequence for your own use. You can also disable all of the
7383 ticking functions by choosing the @samp{Disable Ticking} item but
7384 there isn't much advantage to that.
7385
7386 @cindex MH-Folder mode
7387 @cindex modes, MH-Folder
7388 @findex mh-narrow-to-seq
7389 @findex mh-narrow-to-tick
7390 @findex mh-widen
7391 @kindex S '
7392 @kindex S n
7393 @kindex S w
7394
7395 Once you've placed some messages in a sequence, you may wish to narrow
7396 the field of view to just those messages in the sequence you've
7397 created. To do this, use @kbd{S n} (@code{mh-narrow-to-seq}). You are
7398 prompted for the name of the sequence. What this does is show only
7399 those messages that are in the selected sequence in the MH-Folder
7400 buffer. In addition, it limits further MH-E searches to just those
7401 messages. To narrow the view to the messages in the @samp{tick}
7402 sequence, use @kbd{S '} (@code{mh-narrow-to-tick}). When you want to
7403 widen the view to all your messages again, use @kbd{S w}
7404 (@code{mh-widen}).
7405
7406 @cindex buffers, @samp{*MH-E Sequences*}
7407 @cindex @samp{*MH-E Sequences*}
7408 @findex mh-list-sequences
7409 @findex mh-msg-is-in-seq
7410 @kindex S l
7411 @kindex S s
7412
7413 You can see which sequences in which a message appears with the
7414 command @kbd{S s} (@code{mh-msg-is-in-seq}). Use a prefix argument to
7415 display the sequences in which another message appears (as in @kbd{C-u
7416 42 S s @key{RET}}). Or, you can list all sequences in a selected
7417 folder (default is current folder) with @kbd{S l}
7418 (@code{mh-list-sequences}). The list appears in a buffer named
7419 @samp{*MH-E Sequences*} (@pxref{Miscellaneous}).
7420
7421 @cindex MH profile component, @samp{Previous-Sequence:}
7422 @cindex @samp{cur} sequence
7423 @cindex @samp{Previous-Sequence:} MH profile component
7424 @cindex sequence, @samp{cur}
7425 @cindex sequence, @samp{Previous-Sequence}
7426 @vindex mh-refile-preserves-sequences-flag
7427
7428 If a message is in any sequence (except
7429 @samp{Previous-Sequence:}@footnote{See @samp{mh-profile}(5)).} and
7430 @samp{cur}) when it is refiled, then it will still be in those
7431 sequences in the destination folder. If this behavior is not desired,
7432 then turn off the option @code{mh-refile-preserves-sequences-flag}.
7433
7434 @findex mh-delete-msg-from-seq
7435 @findex mh-delete-seq
7436 @kindex d
7437 @kindex S d
7438 @kindex S k
7439
7440 If you want to remove a message (or range, @pxref{Ranges}) from a
7441 sequence, use @kbd{S d} (@code{mh-delete-msg-from-seq}). If you want
7442 to delete an entire sequence, use @kbd{S k} (@code{mh-delete-seq}). In
7443 the latter case you are prompted for the sequence to delete. Note that
7444 this deletes only the sequence, not the messages in the sequence. If
7445 you want to delete the messages, use @kbd{C-u d} (@pxref{Reading
7446 Mail}).
7447
7448 @cindex @samp{Unseen-Sequence:} MH profile component
7449 @cindex @samp{cur} sequence
7450 @cindex @samp{tick} sequence
7451 @cindex MH profile component, @samp{Unseen-Sequence:}
7452 @cindex sequence, @samp{Unseen-Sequence}
7453 @cindex sequence, @samp{cur}
7454 @cindex sequence, @samp{tick}
7455 @findex mh-update-sequences
7456 @kindex M-x mh-update-sequences
7457 @kindex q
7458 @kindex x
7459 @vindex mh-tick-seq
7460 @vindex mh-update-sequences-after-mh-show-flag
7461
7462 Three sequences are maintained internally by MH-E and pushed out to MH
7463 when a message is shown. They include the sequence specified by your
7464 @samp{Unseen-Sequence:} profile component, @samp{cur}, and the
7465 sequence listed by the option @code{mh-tick-seq} which is @samp{tick}
7466 by default. If you do not like this behavior, turn off the option
7467 @code{mh-update-sequences-after-mh-show-flag}. You can then update the
7468 state manually with the @kbd{x}, @kbd{q}, or @kbd{M-x
7469 mh-update-sequences} commands.
7470
7471 @vindex mh-seen-list
7472 @vindex mh-unseen-updated-hook
7473
7474 The hook @code{mh-unseen-updated-hook} is run after the unseen
7475 sequence has been updated. The variable @code{mh-seen-list} can be
7476 used by this hook to obtain the list of messages which were removed
7477 from the unseen sequence.
7478
7479 @cindex @command{mark}
7480 @cindex MH commands, @command{mark}
7481 @kindex S n
7482 @kindex S w
7483
7484 With the exceptions of @kbd{S n} and @kbd{S w}, the underlying MH
7485 command dealing with sequences is @command{mark}@footnote{See the
7486 section @uref{@value{MH-BOOK-HOME}/mmbwm.html, Make Message Bookmarks
7487 with mark} in the MH book.}.
7488
7489 @node Junk, Miscellaneous, Sequences, Top
7490 @chapter Dealing With Junk Mail
7491
7492 @cindex Marshall Rose
7493 @cindex junk mail
7494 @cindex spam
7495
7496 Marshall Rose once wrote a paper on MH entitled, @cite{How to process
7497 200 messages a day and still get some real work done}. This chapter
7498 could be entitled, @cite{How to process 1000 spams a day and still get
7499 some real work done}.
7500
7501 @cindex blacklisting
7502 @cindex ham
7503 @cindex viruses
7504 @cindex whitelisting
7505 @cindex worms
7506
7507 We use the terms @dfn{junk mail} and @dfn{spam} interchangeably for
7508 any unwanted message which includes spam, @dfn{viruses}, and
7509 @dfn{worms}. The opposite of spam is @dfn{ham}. The act of classifying
7510 a sender as one who sends junk mail is called @dfn{blacklisting}; the
7511 opposite is called @dfn{whitelisting}.
7512
7513 @table @kbd
7514 @kindex J ?
7515 @findex mh-prefix-help
7516 @item J ?
7517 Display cheat sheet for the commands of the current prefix in
7518 minibuffer (@code{mh-prefix-help}).
7519 @c -------------------------
7520 @kindex J b
7521 @findex mh-junk-blacklist
7522 @item J b
7523 Blacklist range as spam (@code{mh-junk-blacklist}).
7524 @c -------------------------
7525 @kindex J w
7526 @findex mh-junk-whitelist
7527 @item J w
7528 Whitelist range as ham (@code{mh-junk-whitelist}).
7529 @c -------------------------
7530 @item @code{mh-spamassassin-identify-spammers}
7531 Identify spammers who are repeat offenders.
7532 @end table
7533
7534 @cindex @samp{mh-junk} customization group
7535 @cindex customization group, @samp{mh-junk}
7536
7537 The following table lists the options from the @samp{mh-junk}
7538 customization group.
7539
7540 @vtable @code
7541 @item mh-junk-background
7542 If on, spam programs are run in background (default: @samp{off}).
7543 @c -------------------------
7544 @item mh-junk-disposition
7545 Disposition of junk mail (default: @samp{Delete Spam}).
7546 @c -------------------------
7547 @item mh-junk-program
7548 Spam program that MH-E should use (default: @samp{Auto-detect}).
7549 @end vtable
7550
7551 @cindex SpamProbe
7552 @cindex Spamassassin
7553 @cindex bogofilter
7554 @cindex spam filters, SpamProbe
7555 @cindex spam filters, Spamassassin
7556 @cindex spam filters, bogofilter
7557
7558 MH-E depends on @uref{http://spamassassin.apache.org/, SpamAssassin},
7559 @uref{http://bogofilter.sourceforge.net/, bogofilter}, or
7560 @uref{http://spamprobe.sourceforge.net/, SpamProbe} to throw the dreck
7561 away. This chapter describes briefly how to configure these programs
7562 to work well with MH-E and how to use MH-E's interface that provides
7563 continuing education for these programs.
7564
7565 @vindex mh-junk-program
7566
7567 The default setting of the option @code{mh-junk-program} is
7568 @samp{Auto-detect} which means that MH-E will automatically choose one
7569 of SpamAssassin, bogofilter, or SpamProbe in that order. If, for
7570 example, you have both SpamAssassin and bogofilter installed and you
7571 want to use bogofilter, then you can set this option to
7572 @samp{Bogofilter}.
7573
7574 @findex mh-junk-blacklist
7575 @kindex J b
7576 @vindex mh-junk-disposition
7577
7578 The command @kbd{J b} (@code{mh-junk-blacklist}) trains the spam
7579 program in use with the content of the range (@pxref{Ranges}) and then
7580 handles the message(s) as specified by the option
7581 @code{mh-junk-disposition}. By default, this option is set to
7582 @samp{Delete Spam} but you can also specify the name of the folder
7583 which is useful for building a corpus of spam for training purposes.
7584
7585 @findex mh-junk-whitelist
7586 @kindex J w
7587
7588 In contrast, the command @kbd{J w} (@code{mh-junk-whitelist})
7589 reclassifies a range of messages (@pxref{Ranges}) as ham if it were
7590 incorrectly classified as spam. It then refiles the message into the
7591 @file{+inbox} folder.
7592
7593 @cindex @samp{*MH-E Log*}
7594 @cindex buffers, @samp{*MH-E Log*}
7595 @findex call-process
7596 @vindex mh-junk-background
7597
7598 By default, the programs are run in the foreground, but this can be
7599 slow when junking large numbers of messages. If you have enough memory
7600 or don't junk that many messages at the same time, you might try
7601 turning on the option @code{mh-junk-background}. @footnote{Note that
7602 the option @code{mh-junk-background} is used as the @code{display}
7603 argument in the call to @code{call-process}. Therefore, turning on
7604 this option means setting its value to @samp{0}. You can also set its
7605 value to @samp{t} to direct the programs' output to the @samp{*MH-E
7606 Log*} buffer; this may be useful for debugging.}
7607
7608 The following sections discuss the various counter-spam measures that
7609 MH-E can work with.
7610
7611 @cindex @file{.procmailrc}
7612 @cindex files, @file{.procmailrc}
7613
7614 @subheading SpamAssassin
7615
7616 @cindex Spamassassin
7617 @cindex spam filters, Spamassassin
7618
7619 SpamAssassin is one of the more popular spam filtering programs. Get
7620 it from your local distribution or from the
7621 @uref{http://spamassassin.apache.org/, SpamAssassin web site}.
7622
7623 To use SpamAssassin, add the following recipes to @file{~/.procmailrc}:
7624
7625 @cindex @command{spamc}
7626 @cindex @samp{X-Spam-Level:} header field
7627 @cindex @samp{X-Spam-Status:} header field
7628 @cindex header field, @samp{X-Spam-Level:}
7629 @cindex header field, @samp{X-Spam-Status:}
7630
7631 @smallexample
7632 PATH=$PATH:/usr/bin/mh
7633 MAILDIR=$HOME/`mhparam Path`
7634
7635 # Fight spam with SpamAssassin.
7636 :0fw
7637 | spamc
7638
7639 # Anything with a spam level of 10 or more is junked immediately.
7640 :0:
7641 * ^X-Spam-Level: ..........
7642 /dev/null
7643
7644 :0:
7645 * ^X-Spam-Status: Yes
7646 spam/.
7647 @end smallexample
7648
7649 If you don't use @command{spamc}, use @samp{spamassassin -P -a}.
7650
7651 Note that one of the recipes above throws away messages with a score
7652 greater than or equal to 10. Here's how you can determine a value that
7653 works best for you.
7654
7655 First, run @samp{spamassassin -t} on every mail message in your
7656 archive and use @command{gnumeric} to verify that the average plus the
7657 standard deviation of good mail is under 5, the SpamAssassin default
7658 for ``spam''.
7659
7660 Using @command{gnumeric}, sort the messages by score and view the
7661 messages with the highest score. Determine the score which encompasses
7662 all of your interesting messages and add a couple of points to be
7663 conservative. Add that many dots to the @samp{X-Spam-Level:} header
7664 field above to send messages with that score down the drain.
7665
7666 In the example above, messages with a score of 5-9 are set aside in
7667 the @samp{+spam} folder for later review. The major weakness of
7668 rules-based filters is a plethora of false positives so it is
7669 worthwhile to check.
7670
7671 @findex mh-junk-blacklist
7672 @findex mh-junk-whitelist
7673 @kindex J b
7674 @kindex J w
7675
7676 If SpamAssassin classifies a message incorrectly, or is unsure, you can
7677 use the MH-E commands @kbd{J b} (@code{mh-junk-blacklist}) and
7678 @kbd{J w} (@code{mh-junk-whitelist}).
7679
7680 @cindex @command{sa-learn}
7681 @cindex @file{.spamassassin/user_prefs}
7682 @cindex files, @file{.spamassassin/user_prefs}
7683
7684 The command @kbd{J b} (@code{mh-junk-blacklist}) adds a
7685 @samp{blacklist_from} entry to @file{~/spamassassin/user_prefs},
7686 deletes the message, and sends the message to the Razor, so that
7687 others might not see this spam. If the @command{sa-learn} command is
7688 available, the message is also recategorized as spam.
7689
7690 The command@kbd{J w} (@code{mh-junk-whitelist}) adds a
7691 @samp{whitelist_from} rule to @samp{~/.spamassassin/user_prefs}. If
7692 the @command{sa-learn} command is available, the message is also
7693 recategorized as ham.
7694
7695 Over time, you'll observe that the same host or domain occurs
7696 repeatedly in the @samp{blacklist_from} entries, so you might think
7697 that you could avoid future spam by blacklisting all mail from a
7698 particular domain. The utility function
7699 @code{mh-spamassassin-identify-spammers} helps you do precisely that.
7700 This function displays a frequency count of the hosts and domains in
7701 the @samp{blacklist_from} entries from the last blank line in
7702 @file{~/.spamassassin/user_prefs} to the end of the file. This
7703 information can be used so that you can replace multiple
7704 @samp{blacklist_from} entries with a single wildcard entry such as:
7705
7706 @smallexample
7707 blacklist_from *@@*amazingoffersdirect2u.com
7708 @end smallexample
7709
7710 In versions of SpamAssassin (2.50 and on) that support a Bayesian
7711 classifier, @kbd{J b} @code{(mh-junk-blacklist}) uses the program
7712 @command{sa-learn} to recategorize the message as spam. Neither MH-E,
7713 nor SpamAssassin, rebuilds the database after adding words, so you
7714 will need to run @samp{sa-learn --rebuild} periodically. This can be
7715 done by adding the following to your @file{crontab}:
7716
7717 @smallexample
7718 0 * * * * sa-learn --rebuild > /dev/null 2>&1
7719 @end smallexample
7720
7721 @subheading Bogofilter
7722
7723 @cindex bogofilter
7724 @cindex spam filters, bogofilter
7725
7726 Bogofilter is a Bayesian spam filtering program. Get it from your
7727 local distribution or from the
7728 @uref{http://bogofilter.sourceforge.net/, bogofilter web site}.
7729
7730 Bogofilter is taught by running:
7731
7732 @smallexample
7733 bogofilter -n < good-message
7734 @end smallexample
7735
7736 on every good message, and
7737
7738 @smallexample
7739 bogofilter -s < spam-message
7740 @end smallexample
7741
7742 @cindex full training
7743
7744 on every spam message. This is called a @dfn{full training}; three
7745 other training methods are described in the FAQ that is distributed
7746 with bogofilter. Note that most Bayesian filters need 1000 to 5000 of
7747 each type of message to start doing a good job.
7748
7749 To use bogofilter, add the following recipes to @file{~/.procmailrc}:
7750
7751 @cindex @samp{X-Bogosity:} header field
7752 @cindex header field, @samp{X-Bogosity:}
7753
7754 @smallexample
7755 PATH=$PATH:/usr/bin/mh
7756 MAILDIR=$HOME/`mhparam Path`
7757
7758 # Fight spam with Bogofilter.
7759 :0fw
7760 | bogofilter -3 -e -p
7761
7762 :0:
7763 * ^X-Bogosity: Yes, tests=bogofilter
7764 spam/.
7765
7766 :0:
7767 * ^X-Bogosity: Unsure, tests=bogofilter
7768 spam/unsure/.
7769 @end smallexample
7770
7771 @findex mh-junk-blacklist
7772 @findex mh-junk-whitelist
7773 @kindex J b
7774 @kindex J w
7775
7776 If bogofilter classifies a message incorrectly, or is unsure, you can
7777 use the MH-E commands @kbd{J b} (@code{mh-junk-blacklist}) and @kbd{J
7778 w} (@code{mh-junk-whitelist}) to update bogofilter's training.
7779
7780 The @cite{Bogofilter FAQ} suggests that you run the following
7781 occasionally to shrink the database:
7782
7783 @smallexample
7784 bogoutil -d wordlist.db | bogoutil -l wordlist.db.new
7785 mv wordlist.db wordlist.db.prv
7786 mv wordlist.db.new wordlist.db
7787 @end smallexample
7788
7789 The @cite{Bogofilter tuning HOWTO} describes how you can fine-tune
7790 bogofilter.
7791
7792 @subheading SpamProbe
7793
7794 @cindex SpamProbe
7795 @cindex spam filters, SpamProbe
7796
7797 SpamProbe is a Bayesian spam filtering program. Get it from your local
7798 distribution or from the @uref{http://spamprobe.sourceforge.net,
7799 SpamProbe web site}.
7800
7801 To use SpamProbe, add the following recipes to @file{~/.procmailrc}:
7802
7803 @cindex @command{formail}
7804 @cindex @samp{X-SpamProbe:} header field
7805 @cindex header field, @samp{X-SpamProbe:}
7806
7807 @smallexample
7808 PATH=$PATH:/usr/bin/mh
7809 MAILDIR=$HOME/`mhparam Path`
7810
7811 # Fight spam with SpamProbe.
7812 :0
7813 SCORE=| spamprobe receive
7814
7815 :0 wf
7816 | formail -I "X-SpamProbe: $SCORE"
7817
7818 :0:
7819 *^X-SpamProbe: SPAM
7820 spam/.
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 SpamProbe classifies a message incorrectly, you can use the MH-E
7829 commands @kbd{J b} (@code{mh-junk-blacklist}) and @kbd{J w}
7830 (@code{mh-junk-whitelist}) to update SpamProbe's training.
7831
7832 @subheading Other Things You Can Do
7833
7834 There are a couple of things that you can add to @file{~/.procmailrc}
7835 in order to filter out a lot of spam and viruses. The first is to
7836 eliminate any message with a Windows executable (which is most likely
7837 a virus). The second is to eliminate mail in character sets that you
7838 can't read.
7839
7840 @cindex @samp{Content-Transfer-Encoding:} header field
7841 @cindex @samp{Content-Type:} header field
7842 @cindex @samp{Subject:} header field
7843 @cindex header field, @samp{Content-Transfer-Encoding:}
7844 @cindex header field, @samp{Content-Type:}
7845 @cindex header field, @samp{Subject:}
7846
7847 @smallexample
7848 PATH=$PATH:/usr/bin/mh
7849 MAILDIR=$HOME/`mhparam Path`
7850
7851 #
7852 # Filter messages with win32 executables/virii.
7853 #
7854 # These attachments are base64 and have a TVqQAAMAAAAEAAAA//8AALg
7855 # pattern. The string "this program cannot be run in MS-DOS mode"
7856 # encoded in base64 is 4fug4AtAnNIbg and helps to avoid false
7857 # positives (Roland Smith via Pete from the bogofilter mailing list).
7858 #
7859 :0 B:
7860 * ^Content-Transfer-Encoding:.*base64
7861 * ^TVqQAAMAAAAEAAAA//8AALg
7862 * 4fug4AtAnNIbg
7863 spam/exe/.
7864
7865 #
7866 # Filter mail in unreadable character sets (from the Bogofilter FAQ).
7867 #
7868 UNREADABLE='[^?"]*big5|iso-2022-jp|ISO-2022-KR|euc-kr|gb2312|ks_c_5601-1987'
7869
7870 :0:
7871 * 1^0 $ ^Subject:.*=\?($UNREADABLE)
7872 * 1^0 $ ^Content-Type:.*charset="?($UNREADABLE)
7873 spam/unreadable/.
7874
7875 :0:
7876 * ^Content-Type:.*multipart
7877 * B ?? $ ^Content-Type:.*^?.*charset="?($UNREADABLE)
7878 spam/unreadable/.
7879 @end smallexample
7880
7881 @node Miscellaneous, Scan Line Formats, Junk, Top
7882 @chapter Miscellaneous Commands, Variables, and Buffers
7883
7884 This chapter covers the following command and the various MH-E
7885 buffers,
7886
7887 @ftable @code
7888 @item mh-version
7889 Display version information about MH-E and the MH mail handling
7890 system.
7891 @end ftable
7892
7893 @cindex buffers, @samp{*MH-E Info*}
7894 @cindex MH-E version
7895 @cindex @samp{*MH-E Info*}
7896 @cindex version
7897 @kindex M-x mh-version
7898
7899 One command worth noting is @kbd{M-x mh-version}. You can compare the
7900 version this command prints to the latest release (@pxref{Getting
7901 MH-E}). The output of @kbd{M-x mh-version}, found in a buffer named
7902 @samp{*MH-E Info*}, should usually be included with any bug report you
7903 submit (@pxref{Bug Reports}).
7904
7905 @subheading MH-E Buffers
7906
7907 Besides the MH-Folder, MH-Show, and MH-Letter buffers, MH-E creates
7908 several other buffers. They are:
7909
7910 @table @samp
7911 @cindex @samp{*MH-E Folders*}
7912 @cindex buffers, @samp{*MH-E Folders*}
7913 @findex mh-list-folders
7914 @item *MH-E Folders*
7915 @kindex F l
7916 This buffer contains the output of @kbd{F l} (@code{mh-list-folders}).
7917 @xref{Folders}.
7918 @c -------------------------
7919 @cindex @samp{*MH-E Help*}
7920 @cindex buffers, @samp{*MH-E Help*}
7921 @findex mh-help
7922 @item *MH-E Help*
7923 @kindex ?
7924 @kindex C-c ?
7925 This buffer contains the output of @kbd{?} (@code{mh-help}) and
7926 @kbd{C-c ?} in MH-Letter mode. @xref{Using This Manual}.
7927 @c -------------------------
7928 @cindex @samp{*MH-E Info*}
7929 @cindex buffers, @samp{*MH-E Info*}
7930 @item *MH-E Info*
7931 This buffer contains the output of @kbd{M-x mh-version @key{RET}}.
7932 @c -------------------------
7933 @cindex @samp{*MH-E Log*}
7934 @cindex buffers, @samp{*MH-E Log*}
7935 @item *MH-E Log*
7936 This buffer contains the last 100 lines of the output of the various
7937 MH commands.
7938 @c -------------------------
7939 @cindex @samp{*MH-E Mail Delivery*}
7940 @cindex buffers, @samp{*MH-E Mail Delivery*}
7941 @item *MH-E Mail Delivery*
7942 This buffer contains the transcript of a mail delivery. @xref{Sending
7943 Message}.
7944 @c -------------------------
7945 @cindex @samp{*MH-E Recipients*}
7946 @cindex buffers, @samp{*MH-E Recipients*}
7947 @findex mh-check-whom
7948 @item *MH-E Recipients*
7949 @kindex C-c C-w
7950 This buffer contains the output of @kbd{C-c C-w}
7951 (@code{mh-check-whom}) and is killed when draft is sent.
7952 @xref{Checking Recipients}.
7953 @c -------------------------
7954 @cindex @samp{*MH-E Sequences*}
7955 @cindex buffers, @samp{*MH-E Sequences*}
7956 @item *MH-E Sequences*
7957 This buffer contains the output of @kbd{S l}
7958 (@code{mh-list-sequences}). @xref{Sequences}.
7959 @c -------------------------
7960 @cindex @samp{*mh-temp*}
7961 @cindex buffers, @samp{*mh-temp*}
7962 @item *mh-temp*
7963 This is a scratch, ephemeral, buffer used by MH-E functions. Note that
7964 it is hidden because the first character in the name is a space.
7965 You'll generally not have any need for this buffer.
7966 @end table
7967
7968 @node Scan Line Formats, Procmail, Miscellaneous, Top
7969 @appendix Scan Line Formats
7970
7971 @cindex scan line formats
7972
7973 This appendix discusses how MH-E creates, parses, and manipulates scan
7974 lines. If you have your own MH scan or inc format files, you
7975 @strong{can} teach MH-E how to handle them, but it isn't easy as
7976 you'll see.
7977
7978 @cindex @samp{mh-scan-line-formats} customization group
7979 @cindex customization group, @samp{mh-scan-line-formats}
7980
7981 This table lists the options in the @samp{mh-scan-line-formats}
7982 customization group.
7983
7984 @vtable @code
7985 @item mh-adaptive-cmd-note-flag
7986 On means that the message number width is determined dynamically
7987 (default: @samp{on}).
7988 @c -------------------------
7989 @item mh-scan-format-file
7990 Specifies the format file to pass to the scan program (default:
7991 @samp{Use MH-E scan Format}).
7992 @c -------------------------
7993 @item mh-scan-prog
7994 Program used to scan messages (default: @code{"scan"}).
7995 @end vtable
7996
7997 @vindex mh-adaptive-cmd-note-flag
7998
7999 There are a couple of caveats when creating your own scan format file.
8000 First, MH-E will not work if your scan lines do not include message
8001 numbers. It will work poorly if you don't dedicate a column for
8002 showing the current message and notations. You won't be able to use
8003 the option @code{mh-adaptive-cmd-note-flag} or the threading features
8004 (@pxref{Threading}).
8005
8006 @cindex message numbers
8007 @findex mh-set-cmd-note
8008 @vindex mh-adaptive-cmd-note-flag
8009 @vindex mh-scan-format-file
8010
8011 If you've created your own format to handle long message numbers,
8012 you'll be pleased to know you no longer need it since MH-E adapts its
8013 internal format based upon the largest message number if
8014 @code{mh-adaptive-cmd-note-flag} is on (the default). If you prefer
8015 fixed-width message numbers, turn off @code{mh-adaptive-cmd-note-flag}
8016 and call @code{mh-set-cmd-note} with the width specified by your
8017 format file (see @code{mh-scan-format-file}). For example, the default
8018 width is 4, so you would use @samp{(mh-set-cmd-note 4)}.
8019
8020 @vindex mh-adaptive-cmd-note-flag
8021 @vindex mh-scan-format-file
8022 @vindex mh-scan-format-mh
8023 @vindex mh-scan-format-nmh
8024
8025 The default setting for @code{mh-scan-format-file} is @samp{Use MH-E
8026 scan Format}. This means that the format string will be taken from the
8027 either @code{mh-scan-format-mh} or @code{mh-scan-format-nmh} depending
8028 on whether MH or nmh (or GNU mailutils) is in use. This setting also
8029 enables you to turn on the option @code{mh-adaptive-cmd-note-flag}.
8030 You can also set this option to @samp{Use Default scan Format} to get
8031 the same output as you would get if you ran @command{scan} from the
8032 shell. If you have a format file that you want MH-E to use but not MH,
8033 you can set this option to @samp{Specify a scan Format File} and enter
8034 the name of your format file.
8035
8036 @vindex mh-scan-format-file
8037 @vindex mh-scan-format-mh
8038 @vindex mh-scan-format-nmh
8039
8040 The scan format that MH-E uses when @code{mh-scan-format-file} is set
8041 to its default of @samp{Use MH-E scan Format} is held in the variables
8042 @code{mh-scan-format-nmh} and @code{mh-scan-format-mh} depending on
8043 whether you are using nmh (or GNU mailutils) or not. Typically, you
8044 create your own format files rather than modifying these variables.
8045 The value of @code{mh-scan-format-nmh} is:
8046
8047 @smallexample
8048 (concat
8049 "%4(msg)"
8050 "%<(cur)+%| %>"
8051 "%<@{replied@}-"
8052 "%?(nonnull(comp@{to@}))%<(mymbox@{to@})t%>"
8053 "%?(nonnull(comp@{cc@}))%<(mymbox@{cc@})c%>"
8054 "%?(nonnull(comp@{bcc@}))%<(mymbox@{bcc@})b%>"
8055 "%?(nonnull(comp@{newsgroups@}))n%>"
8056 "%<(zero) %>"
8057 "%02(mon@{date@})/%02(mday@{date@})%<@{date@} %|*%>"
8058 "%<(mymbox@{from@})%<@{to@}To:%14(decode(friendly@{to@}))%>%>"
8059 "%<(zero)%17(decode(friendly@{from@}))%> "
8060 "%(decode@{subject@})%<@{body@}<<%@{body@}%>")
8061 @end smallexample
8062
8063 @cindex decoding RFC 2047
8064 @cindex RFC 2047, decoding
8065 @vindex mh-scan-format-mh
8066
8067 The setting for @code{mh-scan-format-mh} is similar, except that MH
8068 doesn't have the function @code{decode} (which is used to decode RFC
8069 2047 encodings).
8070
8071 @cindex notations, scan line
8072 @cindex scan line notations
8073
8074 These strings are passed to the @command{scan} program via the
8075 @option{-format} argument. The formats are identical to the defaults
8076 except that additional hints for fontification have been added to the
8077 existing notations in the fifth column (remember that in Emacs, the
8078 columns start at 0). The values of the fifth column, in priority
8079 order, are: @samp{-} if the message has been replied to, @samp{t} if
8080 an address in the @samp{To:} field matches one of the mailboxes of the
8081 current user, @samp{c} if the @samp{Cc:} field matches, @samp{b} if
8082 the @samp{Bcc:} field matches, and @samp{n} if a non-empty
8083 @samp{Newsgroups:} field is present.
8084
8085 @cindex @command{scan}
8086 @cindex MH commands, @command{scan}
8087 @vindex mh-progs
8088 @vindex mh-scan-prog
8089
8090 The name of the program that generates a listing of one line per
8091 message is held in @code{mh-scan-prog} (default: @code{"scan"}).
8092 Unless this variable contains an absolute pathname, it is assumed to
8093 be in the @code{mh-progs} directory (@pxref{Getting Started}). You may
8094 link another program to @command{scan} (see @samp{mh-profile}(5)) to
8095 produce a different type of listing@footnote{See the section
8096 @uref{@value{MH-BOOK-HOME}/faswsprs.html, Find and Specify with scan
8097 pick Ranges Sequences} in the MH book.}.
8098
8099 @cindex regular expressions, scan line formats
8100 @findex mh-set-cmd-note
8101 @findex setq
8102
8103 If you change the format of the scan lines you'll need to tell MH-E
8104 how to parse the new format. As you will see, quite a lot of variables
8105 are involved to do that. Use @kbd{M-x apropos @key{RET}
8106 mh-scan.*regexp @key{RET}} to obtain a list of these variables. You
8107 will also have to call @code{mh-set-cmd-note} if your notations are
8108 not in column 4 (columns in Emacs start with 0). Note that unlike most
8109 of the user options described in this manual, these are variables and
8110 must be set with @code{setq} instead of in a customization buffer. For
8111 help with regular expressions, see
8112 @ifnothtml
8113 @ref{Regexps, , Syntax of Regular Expressions, emacs, The
8114 GNU Emacs Manual}.
8115 @end ifnothtml
8116 @ifhtml
8117 section
8118 @uref{http://www.gnu.org/software/emacs/manual/html_node/Regexps.html,
8119 Syntax of Regular Expressions} in @cite{The GNU Emacs Manual}.
8120 @end ifhtml
8121
8122 The first variable has to do with pruning out garbage.
8123
8124 @vtable @code
8125 @cindex @command{inc}
8126 @cindex MH commands, @command{inc}
8127 @cindex @command{scan}
8128 @cindex MH commands, @command{scan}
8129 @item mh-scan-valid-regexp
8130 This regular expression describes a valid scan line. This is used to
8131 eliminate error messages that are occasionally produced by
8132 @command{inc}@footnote{See the section
8133 @uref{@value{MH-BOOK-HOME}/reapre.html, Reading Mail: inc show next
8134 prev} in the MH book.} or @command{scan} (default: @code{"^ *[0-9]"}).
8135 @end vtable
8136
8137 Next, many variables control how the scan lines are parsed.
8138
8139 @vtable @code
8140 @vindex mh-folder-body
8141 @vindex mh-folder-font-lock-keywords
8142 @item mh-scan-body-regexp
8143 This regular expression matches the message body fragment. Note that
8144 the default setting of @code{mh-folder-font-lock-keywords} expects
8145 this expression to contain at least one parenthesized expression which
8146 matches the body text as in the default of
8147 @code{"\\(<<\\([^\n]+\\)?\\)"}. If this regular expression is not
8148 correct, the body fragment will not be highlighted with the face
8149 @code{mh-folder-body}.
8150 @c -------------------------
8151 @vindex mh-folder-cur-msg-number
8152 @vindex mh-folder-font-lock-keywords
8153 @vindex mh-note-cur
8154 @item mh-scan-cur-msg-number-regexp
8155 This regular expression matches the current message. It must match
8156 from the beginning of the line. Note that the default setting of
8157 @code{mh-folder-font-lock-keywords} expects this expression to contain
8158 at least one parenthesized expression which matches the message number
8159 as in the default of @w{@code{"^\\( *[0-9]+\\+\\).*"}}. This
8160 expression includes the leading space and current message marker
8161 @samp{+} within the parenthesis since it looks better to highlight
8162 these items as well. The highlighting is done with the face
8163 @code{mh-folder-cur-msg-number}. This regular expression should be
8164 correct as it is needed by non-fontification functions. See also
8165 @code{mh-note-cur}.
8166 @c -------------------------
8167 @vindex mh-folder-date
8168 @vindex mh-folder-font-lock-keywords
8169 @vindex mh-scan-sent-to-me-sender-regexp
8170 @item mh-scan-date-regexp
8171 This regular expression matches a valid date. It must @strong{not} be
8172 anchored to the beginning or the end of the line. Note that the
8173 default setting of @code{mh-folder-font-lock-keywords} expects this
8174 expression to contain only one parenthesized expression which matches
8175 the date field as in the default of
8176 @code{"\\([0-9][0-9]/[0-9][0-9]\\)"}. If this regular expression is
8177 not correct, the date will not be highlighted with the face
8178 @code{mh-folder-date}.
8179 @c -------------------------
8180 @vindex mh-folder-deleted
8181 @vindex mh-folder-font-lock-keywords
8182 @vindex mh-note-deleted
8183 @item mh-scan-deleted-msg-regexp
8184 This regular expression matches deleted messages. It must match from
8185 the beginning of the line. Note that the default setting of
8186 @code{mh-folder-font-lock-keywords} expects this expression to contain
8187 at least one parenthesized expression which matches the message number
8188 as in the default of @code{"^\\( *[0-9]+\\)D"}. This expression
8189 includes the leading space within the parenthesis since it looks
8190 better to highlight it as well. The highlighting is done with the face
8191 @code{mh-folder-deleted}. This regular expression should be correct as
8192 it is needed by non-fontification functions. See also
8193 @code{mh-note-deleted}.
8194 @c -------------------------
8195 @vindex mh-folder-font-lock-keywords
8196 @vindex mh-folder-msg-number
8197 @item mh-scan-good-msg-regexp
8198 This regular expression matches ``good'' messages. It must match from
8199 the beginning of the line. Note that the default setting of
8200 @code{mh-folder-font-lock-keywords} expects this expression to contain
8201 at least one parenthesized expression which matches the message number
8202 as in the default of @w{@code{"^\\( *[0-9]+\\)[^D^0-9]"}}. This
8203 expression includes the leading space within the parenthesis since it
8204 looks better to highlight it as well. The highlighting is done with
8205 the face @code{mh-folder-msg-number}. This regular expression should
8206 be correct as it is needed by non-fontification functions.
8207 @c -------------------------
8208 @vindex mh-scan-format-file
8209 @item mh-scan-msg-format-regexp
8210 This regular expression finds the message number width in a scan
8211 format. Note that the message number must be placed in a parenthesized
8212 expression as in the default of @code{"%\\([0-9]*\\)(msg)"}. This
8213 variable is only consulted if @code{mh-scan-format-file} is set to
8214 @samp{Use MH-E scan Format}.
8215 @c -------------------------
8216 @vindex mh-scan-format-file
8217 @item mh-scan-msg-format-string
8218 This is a format string for the width of the message number in a scan
8219 format. Use @samp{0%d} for zero-filled message numbers. This variable
8220 is only consulted if @code{mh-scan-format-file} is set to @samp{Use
8221 MH-E scan Format} (default: @code{"%d"}).
8222 @c -------------------------
8223 @item mh-scan-msg-number-regexp
8224 This regular expression extracts the message number. It must match
8225 from the beginning of the line. Note that the message number must be
8226 placed in a parenthesized expression as in the default of @w{@code{"^
8227 *\\([0-9]+\\)"}}.
8228 @c -------------------------
8229 @item mh-scan-msg-overflow-regexp
8230 This regular expression matches overflowed message numbers (default:
8231 @code{"^[?0-9][0-9]"}).
8232 @c -------------------------
8233 @item mh-scan-msg-search-regexp
8234 This regular expression matches a particular message. It is a format
8235 string; use @samp{%d} to represent the location of the message number
8236 within the expression as in the default of @code{"^[^0-9]*%d[^0-9]"}.
8237 @c -------------------------
8238 @vindex mh-folder-address
8239 @vindex mh-folder-font-lock-keywords
8240 @vindex mh-folder-to
8241 @item mh-scan-rcpt-regexp
8242 This regular expression specifies the recipient in messages you sent.
8243 Note that the default setting of @code{mh-folder-font-lock-keywords}
8244 expects this expression to contain two parenthesized expressions. The
8245 first is expected to match the @samp{To:} that the default scan format
8246 file generates. The second is expected to match the recipient's name
8247 as in the default of @code{"\\(To:\\)\\(..............\\)"}. If this
8248 regular expression is not correct, the @samp{To:} string will not be
8249 highlighted with the face @code{mh-folder-to} and the recipient will not be
8250 highlighted with the face @code{mh-folder-address}.
8251 @c -------------------------
8252 @vindex mh-folder-font-lock-keywords
8253 @vindex mh-folder-refiled
8254 @vindex mh-note-refiled
8255 @item mh-scan-refiled-msg-regexp
8256 This regular expression matches refiled messages. It must match from
8257 the beginning of the line. Note that the default setting of
8258 @code{mh-folder-font-lock-keywords} expects this expression to contain
8259 at least one parenthesized expression which matches the message number
8260 as in the default of @w{@code{"^\\( *[0-9]+\\)\\^"}}. This expression
8261 includes the leading space within the parenthesis since it looks
8262 better to highlight it as well. The highlighting is done with the face
8263 @code{mh-folder-refiled}. This regular expression should be correct as
8264 it is needed by non-fontification functions. See also
8265 @code{mh-note-refiled}.
8266 @c -------------------------
8267 @vindex mh-folder-font-lock-keywords
8268 @vindex mh-folder-sent-to-me-sender
8269 @vindex mh-mh-folder-sent-to-me-hint
8270 @vindex mh-scan-format-nmh
8271 @item mh-scan-sent-to-me-sender-regexp
8272 This regular expression matches messages sent to us. Note that the
8273 default setting of @code{mh-folder-font-lock-keywords} expects this
8274 expression to contain at least two parenthesized expressions. The
8275 first should match the fontification hint (see
8276 @code{mh-scan-format-nmh}) and the second should match the user name
8277 as in the default of
8278 @w{@code{"^ *[0-9]+.\\([bct]\\).....[ ]*\\(..................\\)"}}.
8279 If this regular expression is not correct, the notation hints will not
8280 be highlighted with the face @code{mh-mh-folder-sent-to-me-hint} and
8281 the sender will not be highlighted with the face
8282 @code{mh-folder-sent-to-me-sender}.
8283 @c -------------------------
8284 @vindex mh-folder-followup
8285 @vindex mh-folder-font-lock-keywords
8286 @vindex mh-folder-subject
8287 @item mh-scan-subject-regexp
8288 This regular expression matches the subject. It must match from the
8289 beginning of the line. Note that the default setting of
8290 @samp{mh-folder-font-lock-keywords} expects this expression to contain
8291 at least three parenthesized expressions. The first is expected to
8292 match the @samp{Re:} string, if any, and is highlighted with the face
8293 @code{mh-folder-followup}. The second matches an optional bracketed
8294 number after @samp{Re:}, such as in @samp{Re[2]:} (and is thus a
8295 sub-expression of the first expression). The third is expected to
8296 match the subject line itself which is highlighted with the face
8297 @code{mh-folder-subject}. For example, the default is
8298 @w{@code{"^ *[0-9]+........[ ]*...................}}@*
8299 @w{@code{\\([Rr][Ee]\\(\\[[0-9]+\\]\\)?:\\s-*\\)*\\([^<\n]*\\)"}}.
8300 This regular expression should be correct as it is needed by
8301 non-fontification functions. Note that this example is broken up on
8302 two lines for readability, but is actually a single string.
8303 @end vtable
8304
8305 Finally, there are a slew of variables that control how MH-E annotates
8306 the scan lines.
8307
8308 @vtable @code
8309 @findex mh-set-cmd-note
8310 @vindex mh-adaptive-cmd-note-flag
8311 @item mh-cmd-note
8312 Column for notations (default: 4). This variable should be set with
8313 the function @code{mh-set-cmd-note}. This variable may be updated
8314 dynamically if @code{mh-adaptive-cmd-note-flag} is on. The following
8315 variables contain the notational characters. Note that columns in
8316 Emacs start with 0.
8317 @c -------------------------
8318 @item mh-note-copied
8319 Messages that have been copied are marked by this character (default:
8320 @code{?C}).
8321 @c -------------------------
8322 @vindex mh-scan-cur-msg-number-regexp
8323 @item mh-note-cur
8324 The current message (in MH, not in MH-E) is marked by this character
8325 (default: @code{?+}). See also @code{mh-scan-cur-msg-number-regexp}.
8326 @c -------------------------
8327 @vindex mh-scan-deleted-msg-regexp
8328 @item mh-note-deleted
8329 Messages that have been deleted are marked by this character (default:
8330 @code{?D}). See also @code{mh-scan-deleted-msg-regexp}.
8331 @c -------------------------
8332 @item mh-note-dist
8333 Messages that have been redistributed are marked by this character
8334 (default: @code{?R}).
8335 @c -------------------------
8336 @item mh-note-forw
8337 Messages that have been forwarded are marked by this character
8338 (default: @code{?F}).
8339 @c -------------------------
8340 @item mh-note-printed
8341 Messages that have been printed are marked by this character (default:
8342 @code{?P}).
8343 @c -------------------------
8344 @vindex mh-scan-refiled-msg-regexp
8345 @item mh-note-refiled
8346 Messages that have been refiled are marked by this character (default:
8347 @code{?^}). See also @code{mh-scan-refiled-msg-regexp}.
8348 @c -------------------------
8349 @item mh-note-repl
8350 Messages that have been replied to are marked by this character
8351 (default: @code{?-}).
8352 @c -------------------------
8353 @item mh-note-seq
8354 Messages in a user-defined sequence are marked by this character
8355 (default: @code{?%}). Messages in the @samp{search} sequence are
8356 marked by this character as well.
8357 @end vtable
8358
8359 For example, let's say I have the following in @file{scan.format}
8360 which displays the sender, the subject, and the message number. This
8361 format places a @samp{+} after the message number for the current
8362 message according to MH; it also uses that column for notations.
8363
8364 @smallexample
8365 %20(decode(friendly@{from@})) %50(decode@{subject@}) %4(msg)%<(cur)+%| %>
8366 @end smallexample
8367
8368 @vindex mh-adaptive-cmd-note-flag
8369 @vindex mh-scan-format-file
8370 @vindex mh-scan-format-file, example
8371
8372 The first thing you have to do is tell MH-E to use this file.
8373 Customize @code{mh-scan-format-file} and set its value to @samp{Use
8374 Default scan Format}. If you didn't get already turn off
8375 @code{mh-adaptive-cmd-note-flag}, you'll need to do that first.
8376
8377 Next, tell MH-E what a valid scan line looks like so that you can at
8378 least display the output of scan in your MH-Folder buffer.
8379
8380 @vindex mh-scan-valid-regexp, example
8381
8382 @smalllisp
8383 (setq mh-scan-valid-regexp "[0-9]+[+D^ ]$")
8384 @end smalllisp
8385
8386 Now, in order to get rid of the @samp{Cursor not pointing to message}
8387 message, you need to tell MH-E how to access the message number. You
8388 should also see why MH-E requires that you include a message number in
8389 the first place.
8390
8391 @vindex mh-scan-msg-number-regexp, example
8392 @vindex mh-scan-msg-search-regexp, example
8393
8394 @smalllisp
8395 (setq mh-scan-msg-number-regexp "^.* \\([0-9]+\\)[+D^ ]$")
8396 (setq mh-scan-msg-search-regexp " %d[+D^ ]$")
8397 @end smalllisp
8398
8399 In order to get the next and previous commands working, add this.
8400
8401 @vindex mh-scan-good-msg-regexp, example
8402
8403 @smalllisp
8404 (setq mh-scan-good-msg-regexp "^.* \\([0-9]+\\)[+D^ ]$")
8405 @end smalllisp
8406
8407 Note that the current message isn't marked with a @samp{+} when moving
8408 between the next and previous messages. Here is the code required to
8409 get this working.
8410
8411 @vindex set-mh-cmd-note, example
8412 @vindex mh-scan-cur-msg-number-regexp, example
8413
8414 @smalllisp
8415 (set-mh-cmd-note 76)
8416 (setq mh-scan-cur-msg-number-regexp "^.* \\([0-9]+\\)\\+$")
8417 @end smalllisp
8418
8419 Finally, add the following to delete and refile messages.
8420
8421 @vindex mh-scan-deleted-msg-regexp, example
8422 @vindex mh-scan-refiled-msg-regexp, example
8423
8424 @smalllisp
8425 (setq mh-scan-deleted-msg-regexp "^.* \\([0-9]+\\)D$")
8426 (setq mh-scan-refiled-msg-regexp "^.* \\([0-9]+\\)\\^$")
8427 @end smalllisp
8428
8429 This is just a bare minimum; it's best to adjust all of the regular
8430 expressions to ensure that MH-E and highlighting perform well.
8431
8432 @node Procmail, Odds and Ends, Scan Line Formats, Top
8433 @appendix Reading Mailing Lists Effectively
8434
8435 @cindex @command{procmail}
8436 @cindex @command{slocal}
8437 @cindex Gnus
8438 @cindex MH commands, @command{slocal}
8439 @cindex Unix commands, @command{procmail}
8440 @cindex mailing lists, reading
8441
8442 This appendix explains how to use @uref{http://www.procmail.org/,
8443 procmail} to file mail from mailing lists into folders which can then
8444 be read easily with MH-E@footnote{The MH equivalent, @command{slocal},
8445 can be used as well, but procmail is more flexible and more packages
8446 exist for procmail than for slocal.}. Some mailing lists have such
8447 high traffic that Gnus must be used and I discuss how to use Gnus
8448 side-by-side with MH-E.
8449
8450 @cindex @file{.procmailrc}
8451 @cindex files, @file{.procmailrc}
8452
8453 First, I'll describe how to put mail from your mailing lists directly
8454 into an MH folder using @command{procmail}. First, add the following
8455 to @file{~/.procmailrc}. While the logging variables aren't strictly
8456 necessary, they are extremely useful.
8457
8458 @smallexample
8459 [1] # Update PATH so procmail can find myrcvstore, rcvstore and mhparam.
8460 [2] PATH=$PATH:/usr/lib/mh:/usr/bin/mh:$HOME/bin
8461 [3]
8462 [4] # Point LOGFILE at the actual log file.
8463 [5] LOGFILE=$HOME/.procmail.log
8464 [6]
8465 [7] # This setting provides just the right amount of information.
8466 [8] LOGABSTRACT=all
8467 [9]
8468 [10] # Uncomment the following line to see how your patterns match.
8469 [11] #VERBOSE=yes
8470 [12]
8471 [13] # Place mail sent to any MH-E mailing list in +mh-e.
8472 [14] :0 w: mh-e$LOCKEXT
8473 [15] * ^TO.*mh-e-.*@.*sourceforge.net
8474 [16] | myrcvstore -create +mh-e
8475 @end smallexample
8476
8477 @cindex @command{rcvstore}
8478 @cindex MH commands, @command{rcvstore}
8479
8480 Line 14 creates a lock file in your mail directory based upon the name
8481 of the folder. This is done because @command{rcvstore} does not
8482 perform locking. While this lock file will prevent @command{procmail}
8483 from writing to a folder concurrently, there is a slight chance that
8484 you might lose a message if you're performing operations on a folder
8485 at the same time @command{rcvstore} is placing a message there. You
8486 have been warned. Now that that disclaimer is out of the way, note
8487 that I've been using this set-up for over a decade and haven't lost
8488 anything to my knowledge@footnote{See
8489 @uref{https://savannah.nongnu.org/bugs/?func=detailbug&bug_id=4361&group_id=2166,
8490 Savannah issue #4361} to see if @command{rcvstore} locking is still an
8491 issue.}.
8492
8493 @cindex @samp{Unseen-Sequence:} MH profile component
8494 @cindex MH profile component, @samp{Unseen-Sequence:}
8495
8496 Line 16 uses the following script, @code{myrcvstore}, to massage the
8497 message as described in the comment and file the message in the given
8498 folder@footnote{The @samp{-create} argument wasn't always the default
8499 to @command{rcvstore}.}.
8500
8501 @smallexample
8502 #! /bin/sh
8503
8504 # Accepts a message on standard input and passes it through rcvstore
8505 # after first passing it through any filters. All arguments are passed
8506 # on to rcvstore.
8507
8508 # Force the "From user date" to become part of header. One reason this
8509 # is done is because the presence of the From field confuses dist so
8510 # that dist adds a new header, rather than using the existing header.
8511 # Note that this should not be done for any message that goes into a
8512 # Gnus incoming file (Gnus will thrown an error) nor should it be
8513 # applied to any message that goes to the system mailbox because the
8514 # entire mailbox will be incorporated as a single message.
8515 formail -c -z -R 'From ' X-Envelope-From: |
8516 rcvstore $@@
8517 @end smallexample
8518
8519 If your version of @command{rcvstore} doesn't add messages to the
8520 @samp{unseen} sequence by default, add the following line to your MH
8521 profile:
8522
8523 @smallexample
8524 Unseen-Sequence: unseen
8525 @end smallexample
8526
8527 Now view your new messages with the speedbar (@pxref{Speedbar}) or with
8528 @kbd{F n} (@code{mh-index-new-messages}). @xref{Folders}.
8529
8530 If you're on a mailing list that is so voluminous that it is
8531 impossible to read every message, it usually better to read the
8532 mailing list like a newsgroup in a news reader. Emacs has a built-in
8533 newsreader called Gnus. The remainder of this appendix talks about how
8534 to use Gnus with an MH message store. The version of Gnus that was
8535 used to prepare this manual was 5.10. Versions 5.8 through 5.10 should
8536 work but versions prior to 5.8 use different options.
8537
8538 This table contains a list of Gnus options that you will have to
8539 modify. Note that for them to become accessible, you'll have to load
8540 @file{nnml.el} first. This can be done with @kbd{M-x load-library
8541 @key{RET} nnml @key{RET}}.
8542
8543 @vtable @code
8544 @item gnus-secondary-select-methods
8545 Select the @samp{nnml} value. This select method uses directories for
8546 folders and individual files for messages, just like MH. You do not
8547 have to set an address.
8548 @c -------------------------
8549 @item mail-sources
8550 Select the @samp{Several files in a directory} value, check the
8551 @samp{Path} box and enter @file{~/Mail} to tell Gnus where to find
8552 your mail.
8553 @c -------------------------
8554 @vindex mail-user-agent
8555 @item message-mail-user-agent
8556 In order to send mail within Gnus using MH-E, set this option to
8557 @samp{mail-user-agent} and set the @code{mail-user-agent} option to
8558 @samp{Emacs interface to MH}.
8559 @c -------------------------
8560 @item nnmail-keep-last-article
8561 Since Gnus keeps track of which messages you have read, it would be
8562 bad if Gnus expired the last message, for example, message 100, and
8563 @command{rcvstore} gave the next new message number 1. Gnus would then
8564 ignore it since it thinks that you've read messages 1-100. Turning on
8565 this option ensures that the last message is never removed thereby
8566 eliminating this problem.
8567 @end vtable
8568
8569 Next add the following to @file{~/.procmailrc}. If you don't subscribe
8570 to the GnuCash mailing list, substitute one to which you are
8571 subscribed.
8572
8573 @smallexample
8574 PATH=$PATH:/usr/bin/mh
8575 MAILDIR=$HOME/`mhparam Path`
8576 # Place mail sent to the GnuCash mailing list in gnucash.spool, where
8577 # Gnus will pick it up.
8578 :0:
8579 * ^TO.*gnucash.*@.*gnucash.org
8580 gnucash.spool
8581 @end smallexample
8582
8583 Wait for some messages to appear in @file{gnucash.spool} and run Gnus
8584 with @kbd{M-x gnus @key{RET}}. To view the folder created in the
8585 example above, you would tell Gnus about it the first time only with
8586 @kbd{G m gnucash @key{RET} nnml @key{RET}}. In MH-E, this folder is
8587 known as @samp{+gnucash}.
8588
8589 @node Odds and Ends, History, Procmail, Top
8590 @appendix Odds and Ends
8591
8592 This appendix covers a few topics that don't fit elsewhere. Here I
8593 tell you how to report bugs and how to get on the MH-E mailing lists.
8594 I also point out some additional sources of information.
8595
8596 @menu
8597 * Bug Reports::
8598 * Mailing Lists::
8599 * MH FAQ and Support::
8600 * Getting MH-E::
8601 @end menu
8602
8603 @node Bug Reports, Mailing Lists, Odds and Ends, Odds and Ends
8604 @appendixsec Bug Reports
8605
8606 @cindex bugs
8607 @cindex SourceForge
8608 @kindex M-x mh-version
8609
8610 Bug reports should be filed at
8611 @uref{https://sourceforge.net/tracker/?group_id=13357&atid=113357,
8612 SourceForge}. You need to be a SourceForge user to submit bug reports,
8613 but this is easy enough to do that it shouldn't be a restriction for
8614 you. Please include the output of @kbd{M-x mh-version}
8615 (@pxref{Miscellaneous}) in any bug report you send unless you're 110%
8616 positive we won't ask for it.
8617
8618 @node Mailing Lists, MH FAQ and Support, Bug Reports, Odds and Ends
8619 @appendixsec MH-E Mailing Lists
8620
8621 @cindex SourceForge
8622 @cindex mailing lists
8623
8624 There are several mailing lists for MH-E. They are @i{mh-e-users at
8625 lists.sourceforge.net}, @i{mh-e-announce at lists.sourceforge.net},
8626 and @i{mh-e-devel at lists.sourceforge.net}. You can subscribe or view
8627 the archives at @uref{https://sourceforge.net/mail/?group_id=13357,
8628 SourceForge}. Do not report bugs on these lists; please submit them
8629 via SourceForge (@pxref{Bug Reports}).
8630
8631 @node MH FAQ and Support, Getting MH-E, Mailing Lists, Odds and Ends
8632 @appendixsec MH FAQ and Support
8633
8634 @cindex FAQ
8635 @cindex MH FAQ
8636
8637 The article @uref{http://www.newt.com/faq/mh.html, @cite{MH Frequently
8638 Asked Questions (FAQ) with Answers}} appears monthly in the newsgroup
8639 @samp{comp.mail.mh}. While very little is there that deals with MH-E
8640 specifically, there is an incredible wealth of material about MH
8641 itself which you will find useful.
8642
8643 @cindex support
8644
8645 You can find FAQs on MH-E at the
8646 @uref{https://sourceforge.net/tracker/?group_id=13357&atid=213357,
8647 Support Requests} page on SourceForge. If you don't find the answer to
8648 your question, file a support request and your question will become a
8649 new FAQ!
8650
8651 @node Getting MH-E, , MH FAQ and Support, Odds and Ends
8652 @appendixsec Getting MH-E
8653
8654 @cindex MH-E, obtaining
8655 @cindex getting MH-E
8656 @cindex obtaining MH-E
8657
8658 Because MH-E is undergoing a phase of sustained growth, the version of
8659 MH-E in your Emacs is likely to be out of date although it is most
8660 likely to be more up to date than the copy that comes with the MH
8661 distribution in @file{miscellany/mh-e}.
8662
8663 @cindex change log
8664 @cindex release notes
8665
8666 New MH-E releases are always available for downloading at
8667 @uref{https://sourceforge.net/project/showfiles.php?group_id=13357,
8668 SourceForge} before they appear in an Emacs release. You can read the
8669 release notes on that page to determine if the given release of MH-E
8670 is already installed in your version of Emacs. You can also read the
8671 change log to see if you are interested in what the given release of
8672 MH-E has to offer (although we have no doubt that you will be
8673 extremely interested in all new releases).
8674
8675 @cindex Debian
8676
8677 If you use Debian, you can install the Debian
8678 @uref{http://packages.debian.org/unstable/mail/mh-e, mh-e package}
8679 instead.
8680
8681 @cindex files, @samp{MH-E-NEWS}
8682 @cindex files, @samp{README}
8683 @cindex news
8684 @cindex @samp{MH-E-NEWS}
8685 @cindex @samp{README}
8686 @kindex M-x mh-version
8687
8688 After you download and extract the MH-E tarball, read the
8689 @file{README} file and @file{MH-E-NEWS}. These correspond to the
8690 release notes and change log mentioned above. The file @file{README}
8691 contains instructions on installing MH-E. If you're already running
8692 Emacs, please quit that session and start again to load in the new
8693 MH-E. Check that you're running the new version with the command
8694 @kbd{M-x mh-version}.
8695
8696 @cindex contributed software
8697 @cindex manual
8698 @cindex documentation
8699
8700 In addition to the mh-e package, the
8701 @uref{https://sourceforge.net/project/showfiles.php?group_id=13357,
8702 SourceForge} site also contains doc and contrib packages. The former
8703 is the latest release of this manual, and the latter contains a few
8704 contributed packages you might find useful.
8705
8706 @node History, GFDL, Odds and Ends, Top
8707 @appendix History of MH-E
8708
8709 @cindex Bill Wohler
8710 @cindex Brian Reid
8711 @cindex Gildea, Stephen
8712 @cindex Jim Larus
8713 @cindex Larus, Jim
8714 @cindex MH-E, versions
8715 @cindex Reid, Brian
8716 @cindex SourceForge
8717 @cindex Stephen Gildea
8718 @cindex Wohler, Bill
8719 @cindex history of MH-E
8720 @cindex versions of MH-E
8721
8722 MH-E was originally written by Brian Reid in 1983 and has changed
8723 hands several times since then. Jim Larus wanted to do something
8724 similar for GNU Emacs, and ended up completely rewriting it that same
8725 year. In 1989, Stephen Gildea picked it up and added many
8726 improvements. Bill Wohler then took over in 2000 and moved its
8727 development to @uref{http://sourceforge.net/, SourceForge} where it
8728 lives today.
8729
8730 @menu
8731 * From Brian Reid::
8732 * From Jim Larus::
8733 * From Stephen Gildea::
8734 * From Bill Wohler::
8735 @end menu
8736
8737 @node From Brian Reid, From Jim Larus, History, History
8738 @appendixsec From Brian Reid
8739
8740 @cindex Brian Reid
8741 @cindex Reid, Brian
8742
8743 One day in 1983 I got the flu and had to stay home from work for three
8744 days with nothing to do. I used that time to write MHE@. The
8745 fundamental idea behind MHE was that it was a ``puppeteer'' driving
8746 the MH programs underneath it. MH had a model that the editor was
8747 supposed to run as a sub-process of the mailer, which seemed to me at
8748 the time to be the tail wagging the dog. So I turned it around and
8749 made the editor drive the MH programs. I made sure that the UCI people
8750 (who were maintaining MH at the time) took in my changes and made them
8751 stick.
8752
8753 Today, I still use my own version of MHE because I don't at all like
8754 the way that GNU MH-E works and I've never gotten to be good enough at
8755 hacking Emacs Lisp to make GNU MH-E do what I want. The Gosling-emacs
8756 version of MHE and the GNU Emacs version of MH-E have almost nothing
8757 in common except similar names. They work differently, have different
8758 conceptual models, and have different key bindings@footnote{After
8759 reading this article, I questioned Brian about his version of MHE, and
8760 received some great ideas for improving MH-E such as a dired-like
8761 method of selecting folders; and removing the prompting when sending
8762 mail, filling in the blanks in the draft buffer instead. I passed them
8763 on to Stephen Gildea, the current maintainer, and he was excited about
8764 the ideas as well. Perhaps one day, MH-E will again resemble MHE
8765 (draft form editing was introduced in version 7.4).}.
8766
8767 Brian Reid, June 1994
8768
8769 @node From Jim Larus, From Stephen Gildea, From Brian Reid, History
8770 @appendixsec From Jim Larus
8771
8772 @cindex Jim Larus
8773 @cindex Larus, Jim
8774
8775 Brian Reid, while at CMU or shortly after going to Stanford wrote a
8776 mail reading program called MHE for Gosling Emacs. It had much the
8777 same structure as MH-E (i.e., invoked MH programs), though it was
8778 simpler and the commands were slightly different. Unfortunately, I no
8779 longer have a copy so the differences are lost in the mists of time.
8780
8781 In '82-83, I was working at BBN and wrote a lot of mlisp code in
8782 Gosling Emacs to make it look more like Tennex Emacs. One of the
8783 packages that I picked up and improved was Reid's mail system. In '83,
8784 I went back to Berkeley. About that time, Stallman's first version of
8785 GNU Emacs came out and people started to move to it from Gosling Emacs
8786 (as I recall, the transition took a year or two). I decided to port
8787 Reid's MHE and used the mlisp to Emacs Lisp translator that came with
8788 GNU Emacs. It did a lousy job and the resulting code didn't work, so I
8789 bit the bullet and rewrote the code by hand (it was a lot smaller and
8790 simpler then, so it took only a day or two).
8791
8792 Soon after that, MH-E became part of the standard Emacs distribution
8793 and suggestions kept dribbling in for improvements. MH-E soon reached
8794 sufficient functionality to keep me happy, but I kept on improving it
8795 because I was a graduate student with plenty of time on my hands and
8796 it was more fun than my dissertation. In retrospect, the one thing
8797 that I regret is not writing any documentation, which seriously
8798 limited the use and appeal of the package.
8799
8800 @cindex @command{xmh}, in MH-E history
8801
8802 In '89, I came to Wisconsin as a professor and decided not to work on
8803 MH-E. It was stable, except for minor bugs, and had enough
8804 functionality, so I let it be for a few years. Stephen Gildea of BBN
8805 began to pester me about the bugs, but I ignored them. In 1990, he
8806 went off to the X Consortium, said good bye, and said that he would
8807 now be using @command{xmh}. A few months later, he came back and said
8808 that he couldn't stand @command{xmh} and could I put a few more bug fixes
8809 into MH-E. At that point, I had no interest in fixing MH-E, so I gave
8810 the responsibility of maintenance to him and he has done a fine job
8811 since then.
8812
8813 Jim Larus, June 1994
8814
8815 @node From Stephen Gildea, From Bill Wohler, From Jim Larus, History
8816 @appendixsec From Stephen Gildea
8817
8818 @cindex Gildea, Stephen
8819 @cindex Stephen Gildea
8820
8821 In 1987 I went to work for Bolt Beranek and Newman, as Jim had before
8822 me. In my previous job, I had been using RMAIL, but as my folders tend
8823 to run large, I was frustrated with the speed of RMAIL@. However, I
8824 stuck with it because I wanted the GNU Emacs interface. I am very
8825 familiar and comfortable with the Emacs interface (with just a few
8826 modifications of my own) and dislike having to use applications with
8827 embedded editors; they never live up to Emacs.
8828
8829 MH is the mail reader of choice at BBN, so I converted to it. Since I
8830 didn't want to give up using an Emacs interface, I started using MH-E.
8831 As is my wont, I started hacking on it almost immediately. I first
8832 used version 3.4m. One of the first features I added was to treat the
8833 folder buffer as a file-visiting buffer: you could lock it, save it,
8834 and be warned of unsaved changes when killing it. I also worked to
8835 bring its functionality a little closer to RMAIL@. Jim Larus was very
8836 cooperative about merging in my changes, and my efforts first appeared
8837 in version 3.6, distributed with Emacs 18.52 in 1988. Next I decided
8838 MH-E was too slow and optimized it a lot. Version, 3.7, distributed
8839 with Emacs 18.56 in 1990, was noticeably faster.
8840
8841 When I moved to the X Consortium I became the first person there to
8842 not use xmh. (There is now one other engineer there using MH-E.) About
8843 this point I took over maintenance of MH-E from Jim and was finally
8844 able to add some features Jim hadn't accepted, such as the backward
8845 searching undo. My first release was 3.8 (Emacs 18.58) in 1992.
8846
8847 Now, in 1994, we see a flurry of releases, with both 4.0 and 5.0.
8848 Version 4.0 added many new features, including background folder
8849 collection and support for composing @sc{mime} messages. (Reading
8850 @sc{mime} messages remains to be done, alas.) While writing this book,
8851 Bill Wohler gave MH-E its closest examination ever, uncovering bugs
8852 and inconsistencies that required a new major version to fix, and so
8853 version 5 was released.
8854
8855 Stephen Gildea, June 1994
8856
8857 @node From Bill Wohler, , From Stephen Gildea, History
8858 @appendixsec From Bill Wohler
8859
8860 @cindex Wohler, Bill
8861 @cindex Bill Wohler
8862
8863 The preface originally included the following text which I use to
8864 begin my story:
8865
8866 @quotation
8867 But it's important to note a brief history of MH-E.
8868
8869 @w{Version 3} was prevalent through the @w{Emacs 18} and early
8870 @w{Emacs 19} years. Then @w{Version 4} came out (@w{Emacs 19.23}),
8871 which introduced several new and changed commands. Next, @w{Version
8872 5.0} was released, which fixed some bugs and incompatibilities, and
8873 was incorporated into @w{Emacs 19.29}.
8874 @end quotation
8875
8876 After a long break, Stephen handed the reins over to me in 2000. I
8877 moved the project to a new site called SourceForge and organized a
8878 great team of developers. Our first release in late 2001 was version
8879 6. It appeared around the time of Emacs 21.2 and had menus and tool
8880 bar buttons.
8881
8882 Then, indexed searches, improved MIME handling, a speedbar, multiple
8883 identities, alias completion, an index view of unseen messages, spam
8884 software support, Face and X-Image-URL header field support, Fcc
8885 completion, arbitrary range handling, and draft form editing were
8886 introduced in the version 7 series around the time of Emacs 21.4
8887 (2004). Still, Emacs itself contained version 5 of MH-E released back
8888 in 1994.
8889
8890 Version 8 development was mostly driven by the rewrite of the manual.
8891 It also brought mailutils support, S/MIME support, picon support, and
8892 an improved interface for hiding header fields. The CVS repository was
8893 migrated from SourceForge to Savannah (only for those files that were
8894 already part of Emacs) and the software was completely reorganized to
8895 push back two decades of entropy. Version 8 will appear in Emacs 22.1,
8896 expected to be released in 2006.
8897
8898 Bill Wohler, February 2006
8899
8900 @node GFDL, GPL, History, Top
8901 @appendix GNU FREE DOCUMENTATION LICENSE
8902 @center Version 1.2, November 2002
8903
8904 @display
8905 Copyright (C) 2000,2001,2002 Free Software Foundation, Inc.
8906 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
8907
8908 Everyone is permitted to copy and distribute verbatim copies
8909 of this license document, but changing it is not allowed.
8910 @end display
8911 @sp 1
8912 @enumerate 0
8913 @item
8914 PREAMBLE
8915
8916 The purpose of this License is to make a manual, textbook, or other
8917 functional and useful document ``free'' in the sense of freedom: to
8918 assure everyone the effective freedom to copy and redistribute it,
8919 with or without modifying it, either commercially or noncommercially.
8920 Secondarily, this License preserves for the author and publisher a way
8921 to get credit for their work, while not being considered responsible
8922 for modifications made by others.
8923
8924 This License is a kind of ``copyleft'', which means that derivative
8925 works of the document must themselves be free in the same sense. It
8926 complements the GNU General Public License, which is a copyleft
8927 license designed for free software.
8928
8929 We have designed this License in order to use it for manuals for free
8930 software, because free software needs free documentation: a free
8931 program should come with manuals providing the same freedoms that the
8932 software does. But this License is not limited to software manuals;
8933 it can be used for any textual work, regardless of subject matter or
8934 whether it is published as a printed book. We recommend this License
8935 principally for works whose purpose is instruction or reference.
8936
8937 @sp 1
8938 @item
8939 APPLICABILITY AND DEFINITIONS
8940
8941 This License applies to any manual or other work, in any medium, that
8942 contains a notice placed by the copyright holder saying it can be
8943 distributed under the terms of this License. Such a notice grants a
8944 world-wide, royalty-free license, unlimited in duration, to use that
8945 work under the conditions stated herein. The ``Document'', below,
8946 refers to any such manual or work. Any member of the public is a
8947 licensee, and is addressed as ``you''. You accept the license if you
8948 copy, modify or distribute the work in a way requiring permission
8949 under copyright law.
8950
8951 A ``Modified Version'' of the Document means any work containing the
8952 Document or a portion of it, either copied verbatim, or with
8953 modifications and/or translated into another language.
8954
8955 A ``Secondary Section'' is a named appendix or a front-matter section of
8956 the Document that deals exclusively with the relationship of the
8957 publishers or authors of the Document to the Document's overall subject
8958 (or to related matters) and contains nothing that could fall directly
8959 within that overall subject. (Thus, if the Document is in part a
8960 textbook of mathematics, a Secondary Section may not explain any
8961 mathematics.) The relationship could be a matter of historical
8962 connection with the subject or with related matters, or of legal,
8963 commercial, philosophical, ethical or political position regarding
8964 them.
8965
8966 The ``Invariant Sections'' are certain Secondary Sections whose titles
8967 are designated, as being those of Invariant Sections, in the notice
8968 that says that the Document is released under this License. If a
8969 section does not fit the above definition of Secondary then it is not
8970 allowed to be designated as Invariant. The Document may contain zero
8971 Invariant Sections. If the Document does not identify any Invariant
8972 Sections then there are none.
8973
8974 The ``Cover Texts'' are certain short passages of text that are listed,
8975 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
8976 the Document is released under this License. A Front-Cover Text may
8977 be at most 5 words, and a Back-Cover Text may be at most 25 words.
8978
8979 A ``Transparent'' copy of the Document means a machine-readable copy,
8980 represented in a format whose specification is available to the
8981 general public, that is suitable for revising the document
8982 straightforwardly with generic text editors or (for images composed of
8983 pixels) generic paint programs or (for drawings) some widely available
8984 drawing editor, and that is suitable for input to text formatters or
8985 for automatic translation to a variety of formats suitable for input
8986 to text formatters. A copy made in an otherwise Transparent file
8987 format whose markup, or absence of markup, has been arranged to thwart
8988 or discourage subsequent modification by readers is not Transparent.
8989 An image format is not Transparent if used for any substantial amount
8990 of text. A copy that is not ``Transparent'' is called ``Opaque.''
8991
8992
8993 Examples of suitable formats for Transparent copies include plain
8994 ASCII without markup, Texinfo input format, LaTeX input format, SGML
8995 or XML using a publicly available DTD, and standard-conforming simple
8996 HTML, PostScript or PDF designed for human modification. Examples of
8997 transparent image formats include PNG, XCF and JPG. Opaque formats
8998 include proprietary formats that can be read and edited only by
8999 proprietary word processors, SGML or XML for which the DTD and/or
9000 processing tools are not generally available, and the
9001 machine-generated HTML, PostScript or PDF produced by some word
9002 processors for output purposes only.
9003
9004 The ``Title Page'' means, for a printed book, the title page itself,
9005 plus such following pages as are needed to hold, legibly, the material
9006 this License requires to appear in the title page. For works in
9007 formats which do not have any title page as such, ``Title Page'' means
9008 the text near the most prominent appearance of the work's title,
9009 preceding the beginning of the body of the text.
9010
9011 A section ``Entitled XYZ'' means a named subunit of the Document whose
9012 title either is precisely XYZ or contains XYZ in parentheses following
9013 text that translates XYZ in another language. (Here XYZ stands for a
9014 specific section name mentioned below, such as ``Acknowledgements'',
9015 ``Dedications'', ``Endorsements'', or ``History''.) To ``Preserve the Title''
9016 of such a section when you modify the Document means that it remains a
9017 section ``Entitled XYZ'' according to this definition.
9018
9019 The Document may include Warranty Disclaimers next to the notice which
9020 states that this License applies to the Document. These Warranty
9021 Disclaimers are considered to be included by reference in this
9022 License, but only as regards disclaiming warranties: any other
9023 implication that these Warranty Disclaimers may have is void and has
9024 no effect on the meaning of this License.
9025 @sp 1
9026 @item
9027 VERBATIM COPYING
9028
9029 You may copy and distribute the Document in any medium, either
9030 commercially or noncommercially, provided that this License, the
9031 copyright notices, and the license notice saying this License applies
9032 to the Document are reproduced in all copies, and that you add no other
9033 conditions whatsoever to those of this License. You may not use
9034 technical measures to obstruct or control the reading or further
9035 copying of the copies you make or distribute. However, you may accept
9036 compensation in exchange for copies. If you distribute a large enough
9037 number of copies you must also follow the conditions in section 3.
9038
9039 You may also lend copies, under the same conditions stated above, and
9040 you may publicly display copies.
9041 @sp 1
9042 @item
9043 COPYING IN QUANTITY
9044
9045 If you publish printed copies (or copies in media that commonly have
9046 printed covers) of the Document, numbering more than 100, and the
9047 Document's license notice requires Cover Texts, you must enclose the
9048 copies in covers that carry, clearly and legibly, all these Cover
9049 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
9050 the back cover. Both covers must also clearly and legibly identify
9051 you as the publisher of these copies. The front cover must present
9052 the full title with all words of the title equally prominent and
9053 visible. You may add other material on the covers in addition.
9054 Copying with changes limited to the covers, as long as they preserve
9055 the title of the Document and satisfy these conditions, can be treated
9056 as verbatim copying in other respects.
9057
9058 If the required texts for either cover are too voluminous to fit
9059 legibly, you should put the first ones listed (as many as fit
9060 reasonably) on the actual cover, and continue the rest onto adjacent
9061 pages.
9062
9063 If you publish or distribute Opaque copies of the Document numbering
9064 more than 100, you must either include a machine-readable Transparent
9065 copy along with each Opaque copy, or state in or with each Opaque copy
9066 a computer-network location from which the general network-using
9067 public has access to download using public-standard network protocols
9068 a complete Transparent copy of the Document, free of added material.
9069 If you use the latter option, you must take reasonably prudent steps,
9070 when you begin distribution of Opaque copies in quantity, to ensure
9071 that this Transparent copy will remain thus accessible at the stated
9072 location until at least one year after the last time you distribute an
9073 Opaque copy (directly or through your agents or retailers) of that
9074 edition to the public.
9075
9076 It is requested, but not required, that you contact the authors of the
9077 Document well before redistributing any large number of copies, to give
9078 them a chance to provide you with an updated version of the Document.
9079 @sp 1
9080 @item
9081 MODIFICATIONS
9082
9083 You may copy and distribute a Modified Version of the Document under
9084 the conditions of sections 2 and 3 above, provided that you release
9085 the Modified Version under precisely this License, with the Modified
9086 Version filling the role of the Document, thus licensing distribution
9087 and modification of the Modified Version to whoever possesses a copy
9088 of it. In addition, you must do these things in the Modified Version:
9089
9090 A. Use in the Title Page (and on the covers, if any) a title distinct
9091 from that of the Document, and from those of previous versions
9092 (which should, if there were any, be listed in the History section
9093 of the Document). You may use the same title as a previous version
9094 if the original publisher of that version gives permission.@*
9095 B. List on the Title Page, as authors, one or more persons or entities
9096 responsible for authorship of the modifications in the Modified
9097 Version, together with at least five of the principal authors of the
9098 Document (all of its principal authors, if it has fewer than five),
9099 unless they release you from this requirement.@*
9100 C. State on the Title page the name of the publisher of the
9101 Modified Version, as the publisher.@*
9102 D. Preserve all the copyright notices of the Document.@*
9103 E. Add an appropriate copyright notice for your modifications
9104 adjacent to the other copyright notices.@*
9105 F. Include, immediately after the copyright notices, a license notice
9106 giving the public permission to use the Modified Version under the
9107 terms of this License, in the form shown in the Addendum below.@*
9108 G. Preserve in that license notice the full lists of Invariant Sections
9109 and required Cover Texts given in the Document's license notice.@*
9110 H. Include an unaltered copy of this License.@*
9111 I. Preserve the section Entitled ``History'', Preserve its Title, and add
9112 to it an item stating at least the title, year, new authors, and
9113 publisher of the Modified Version as given on the Title Page. If
9114 there is no section Entitled ``History'' in the Document, create one
9115 stating the title, year, authors, and publisher of the Document as
9116 given on its Title Page, then add an item describing the Modified
9117 Version as stated in the previous sentence.@*
9118 J. Preserve the network location, if any, given in the Document for
9119 public access to a Transparent copy of the Document, and likewise
9120 the network locations given in the Document for previous versions
9121 it was based on. These may be placed in the ``History'' section.
9122 You may omit a network location for a work that was published at
9123 least four years before the Document itself, or if the original
9124 publisher of the version it refers to gives permission.@*
9125 K. For any section Entitled ``Acknowledgements'' or ``Dedications'',
9126 Preserve the Title of the section, and preserve in the section all
9127 the substance and tone of each of the contributor acknowledgements
9128 and/or dedications given therein.@*
9129 L. Preserve all the Invariant Sections of the Document,
9130 unaltered in their text and in their titles. Section numbers
9131 or the equivalent are not considered part of the section titles.@*
9132 M. Delete any section Entitled ``Endorsements.'' Such a section
9133 may not be included in the Modified Version.@*
9134 N. Do not retitle any existing section to be Entitled ``Endorsements''
9135 or to conflict in title with any Invariant Section.@*
9136 O. Preserve any Warranty Disclaimers.@*
9137 @sp 1
9138 If the Modified Version includes new front-matter sections or
9139 appendices that qualify as Secondary Sections and contain no material
9140 copied from the Document, you may at your option designate some or all
9141 of these sections as invariant. To do this, add their titles to the
9142 list of Invariant Sections in the Modified Version's license notice.
9143 These titles must be distinct from any other section titles.
9144
9145 You may add a section Entitled ``Endorsements'', provided it contains
9146 nothing but endorsements of your Modified Version by various
9147 parties--for example, statements of peer review or that the text has
9148 been approved by an organization as the authoritative definition of a
9149 standard.
9150
9151 You may add a passage of up to five words as a Front-Cover Text, and a
9152 passage of up to 25 words as a Back-Cover Text, to the end of the list
9153 of Cover Texts in the Modified Version. Only one passage of
9154 Front-Cover Text and one of Back-Cover Text may be added by (or
9155 through arrangements made by) any one entity. If the Document already
9156 includes a cover text for the same cover, previously added by you or
9157 by arrangement made by the same entity you are acting on behalf of,
9158 you may not add another; but you may replace the old one, on explicit
9159 permission from the previous publisher that added the old one.
9160
9161 The author(s) and publisher(s) of the Document do not by this License
9162 give permission to use their names for publicity for or to assert or
9163 imply endorsement of any Modified Version.
9164 @sp 1
9165 @item
9166 COMBINING DOCUMENTS
9167
9168 You may combine the Document with other documents released under this
9169 License, under the terms defined in section 4 above for modified
9170 versions, provided that you include in the combination all of the
9171 Invariant Sections of all of the original documents, unmodified, and
9172 list them all as Invariant Sections of your combined work in its
9173 license notice, and that you preserve all their Warranty Disclaimers.
9174
9175 The combined work need only contain one copy of this License, and
9176 multiple identical Invariant Sections may be replaced with a single
9177 copy. If there are multiple Invariant Sections with the same name but
9178 different contents, make the title of each such section unique by
9179 adding at the end of it, in parentheses, the name of the original
9180 author or publisher of that section if known, or else a unique number.
9181 Make the same adjustment to the section titles in the list of
9182 Invariant Sections in the license notice of the combined work.
9183
9184 In the combination, you must combine any sections Entitled ``History''
9185 in the various original documents, forming one section Entitled
9186 ``History''; likewise combine any sections Entitled ``Acknowledgements'',
9187 and any sections Entitled ``Dedications.'' You must delete all sections
9188 Entitled ``Endorsements.''
9189 @sp 1
9190 @item
9191 COLLECTIONS OF DOCUMENTS
9192
9193 You may make a collection consisting of the Document and other documents
9194 released under this License, and replace the individual copies of this
9195 License in the various documents with a single copy that is included in
9196 the collection, provided that you follow the rules of this License for
9197 verbatim copying of each of the documents in all other respects.
9198
9199 You may extract a single document from such a collection, and distribute
9200 it individually under this License, provided you insert a copy of this
9201 License into the extracted document, and follow this License in all
9202 other respects regarding verbatim copying of that document.
9203 @sp 1
9204 @item
9205 AGGREGATION WITH INDEPENDENT WORKS
9206
9207 A compilation of the Document or its derivatives with other separate
9208 and independent documents or works, in or on a volume of a storage or
9209 distribution medium, is called an ``aggregate'' if the copyright
9210 resulting from the compilation is not used to limit the legal rights
9211 of the compilation's users beyond what the individual works permit.
9212 When the Document is included in an aggregate, this License does not
9213 apply to the other works in the aggregate which are not themselves
9214 derivative works of the Document.
9215
9216 If the Cover Text requirement of section 3 is applicable to these
9217 copies of the Document, then if the Document is less than one half of
9218 the entire aggregate, the Document's Cover Texts may be placed on
9219 covers that bracket the Document within the aggregate, or the
9220 electronic equivalent of covers if the Document is in electronic form.
9221 Otherwise they must appear on printed covers that bracket the whole
9222 aggregate.
9223 @sp 1
9224 @item
9225 TRANSLATION
9226
9227 Translation is considered a kind of modification, so you may
9228 distribute translations of the Document under the terms of section 4.
9229 Replacing Invariant Sections with translations requires special
9230 permission from their copyright holders, but you may include
9231 translations of some or all Invariant Sections in addition to the
9232 original versions of these Invariant Sections. You may include a
9233 translation of this License, and all the license notices in the
9234 Document, and any Warranty Disclaimers, provided that you also include
9235 the original English version of this License and the original versions
9236 of those notices and disclaimers. In case of a disagreement between
9237 the translation and the original version of this License or a notice
9238 or disclaimer, the original version will prevail.
9239
9240 If a section in the Document is Entitled ``Acknowledgements'',
9241 ``Dedications'', or ``History'', the requirement (section 4) to Preserve
9242 its Title (section 1) will typically require changing the actual
9243 title.
9244 @sp 1
9245 @item
9246 TERMINATION
9247
9248 You may not copy, modify, sublicense, or distribute the Document except
9249 as expressly provided for under this License. Any other attempt to
9250 copy, modify, sublicense or distribute the Document is void, and will
9251 automatically terminate your rights under this License. However,
9252 parties who have received copies, or rights, from you under this
9253 License will not have their licenses terminated so long as such
9254 parties remain in full compliance.
9255 @sp 1
9256 @item
9257 FUTURE REVISIONS OF THIS LICENSE
9258
9259 The Free Software Foundation may publish new, revised versions
9260 of the GNU Free Documentation License from time to time. Such new
9261 versions will be similar in spirit to the present version, but may
9262 differ in detail to address new problems or concerns. See
9263 http://www.gnu.org/copyleft/.
9264
9265 Each version of the License is given a distinguishing version number.
9266 If the Document specifies that a particular numbered version of this
9267 License ``or any later version'' applies to it, you have the option of
9268 following the terms and conditions either of that specified version or
9269 of any later version that has been published (not as a draft) by the
9270 Free Software Foundation. If the Document does not specify a version
9271 number of this License, you may choose any version ever published (not
9272 as a draft) by the Free Software Foundation.
9273
9274 @end enumerate
9275
9276 @unnumberedsec ADDENDUM: How to use this License for your documents
9277
9278 To use this License in a document you have written, include a copy of
9279 the License in the document and put the following copyright and
9280 license notices just after the title page:
9281
9282 @smallexample
9283 @group
9284 Copyright (C) @var{year} @var{your name}.
9285 Permission is granted to copy, distribute and/or modify this document
9286 under the terms of the GNU Free Documentation License, Version 1.2
9287 or any later version published by the Free Software Foundation;
9288 with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
9289 A copy of the license is included in the section entitled ``GNU
9290 Free Documentation License''.
9291 @end group
9292 @end smallexample
9293
9294 If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
9295 replace the ``with...Texts.'' line with this:
9296
9297 @smallexample
9298 @group
9299 with the Invariant Sections being @var{list their titles}, with the
9300 Front-Cover Texts being @var{list}, and with the Back-Cover Texts being
9301 @var{list}.
9302 @end group
9303 @end smallexample
9304
9305 If you have Invariant Sections without Cover Texts, or some other
9306 combination of the three, merge those two alternatives to suit the
9307 situation.
9308
9309 If your document contains nontrivial examples of program code, we
9310 recommend releasing these examples in parallel under your choice of
9311 free software license, such as the GNU General Public License,
9312 to permit their use in free software.
9313
9314 @node GPL, Key Index, GFDL, Top
9315 @appendix GNU GENERAL PUBLIC LICENSE
9316 @center Version 2, June 1991
9317
9318 @display
9319 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
9320 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
9321
9322 Everyone is permitted to copy and distribute verbatim copies
9323 of this license document, but changing it is not allowed.
9324 @end display
9325
9326 @unnumberedsec Preamble
9327
9328 The licenses for most software are designed to take away your
9329 freedom to share and change it. By contrast, the GNU General Public
9330 License is intended to guarantee your freedom to share and change free
9331 software---to make sure the software is free for all its users. This
9332 General Public License applies to most of the Free Software
9333 Foundation's software and to any other program whose authors commit to
9334 using it. (Some other Free Software Foundation software is covered by
9335 the GNU Lesser General Public License instead.) You can apply it to
9336 your programs, too.
9337
9338 When we speak of free software, we are referring to freedom, not
9339 price. Our General Public Licenses are designed to make sure that you
9340 have the freedom to distribute copies of free software (and charge for
9341 this service if you wish), that you receive source code or can get it
9342 if you want it, that you can change the software or use pieces of it
9343 in new free programs; and that you know you can do these things.
9344
9345 To protect your rights, we need to make restrictions that forbid
9346 anyone to deny you these rights or to ask you to surrender the rights.
9347 These restrictions translate to certain responsibilities for you if you
9348 distribute copies of the software, or if you modify it.
9349
9350 For example, if you distribute copies of such a program, whether
9351 gratis or for a fee, you must give the recipients all the rights that
9352 you have. You must make sure that they, too, receive or can get the
9353 source code. And you must show them these terms so they know their
9354 rights.
9355
9356 We protect your rights with two steps: (1) copyright the software, and
9357 (2) offer you this license which gives you legal permission to copy,
9358 distribute and/or modify the software.
9359
9360 Also, for each author's protection and ours, we want to make certain
9361 that everyone understands that there is no warranty for this free
9362 software. If the software is modified by someone else and passed on, we
9363 want its recipients to know that what they have is not the original, so
9364 that any problems introduced by others will not reflect on the original
9365 authors' reputations.
9366
9367 Finally, any free program is threatened constantly by software
9368 patents. We wish to avoid the danger that redistributors of a free
9369 program will individually obtain patent licenses, in effect making the
9370 program proprietary. To prevent this, we have made it clear that any
9371 patent must be licensed for everyone's free use or not licensed at all.
9372
9373 The precise terms and conditions for copying, distribution and
9374 modification follow.
9375
9376 @iftex
9377 @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
9378 @end iftex
9379 @ifinfo
9380 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
9381 @end ifinfo
9382
9383 @enumerate 0
9384 @item
9385 This License applies to any program or other work which contains
9386 a notice placed by the copyright holder saying it may be distributed
9387 under the terms of this General Public License. The ``Program,'' below,
9388 refers to any such program or work, and a ``work based on the Program''
9389 means either the Program or any derivative work under copyright law:
9390 that is to say, a work containing the Program or a portion of it,
9391 either verbatim or with modifications and/or translated into another
9392 language. (Hereinafter, translation is included without limitation in
9393 the term ``modification.'') Each licensee is addressed as ``you.''
9394
9395 Activities other than copying, distribution and modification are not
9396 covered by this License; they are outside its scope. The act of
9397 running the Program is not restricted, and the output from the Program
9398 is covered only if its contents constitute a work based on the
9399 Program (independent of having been made by running the Program).
9400 Whether that is true depends on what the Program does.
9401
9402 @item
9403 You may copy and distribute verbatim copies of the Program's
9404 source code as you receive it, in any medium, provided that you
9405 conspicuously and appropriately publish on each copy an appropriate
9406 copyright notice and disclaimer of warranty; keep intact all the
9407 notices that refer to this License and to the absence of any warranty;
9408 and give any other recipients of the Program a copy of this License
9409 along with the Program.
9410
9411 You may charge a fee for the physical act of transferring a copy, and
9412 you may at your option offer warranty protection in exchange for a fee.
9413
9414 @item
9415 You may modify your copy or copies of the Program or any portion
9416 of it, thus forming a work based on the Program, and copy and
9417 distribute such modifications or work under the terms of Section 1
9418 above, provided that you also meet all of these conditions:
9419
9420 @enumerate a
9421 @item
9422 You must cause the modified files to carry prominent notices
9423 stating that you changed the files and the date of any change.
9424
9425 @item
9426 You must cause any work that you distribute or publish, that in
9427 whole or in part contains or is derived from the Program or any
9428 part thereof, to be licensed as a whole at no charge to all third
9429 parties under the terms of this License.
9430
9431 @item
9432 If the modified program normally reads commands interactively
9433 when run, you must cause it, when started running for such
9434 interactive use in the most ordinary way, to print or display an
9435 announcement including an appropriate copyright notice and a
9436 notice that there is no warranty (or else, saying that you provide
9437 a warranty) and that users may redistribute the program under
9438 these conditions, and telling the user how to view a copy of this
9439 License. (Exception: if the Program itself is interactive but
9440 does not normally print such an announcement, your work based on
9441 the Program is not required to print an announcement.)
9442 @end enumerate
9443
9444 These requirements apply to the modified work as a whole. If
9445 identifiable sections of that work are not derived from the Program,
9446 and can be reasonably considered independent and separate works in
9447 themselves, then this License, and its terms, do not apply to those
9448 sections when you distribute them as separate works. But when you
9449 distribute the same sections as part of a whole which is a work based
9450 on the Program, the distribution of the whole must be on the terms of
9451 this License, whose permissions for other licensees extend to the
9452 entire whole, and thus to each and every part regardless of who wrote it.
9453
9454 Thus, it is not the intent of this section to claim rights or contest
9455 your rights to work written entirely by you; rather, the intent is to
9456 exercise the right to control the distribution of derivative or
9457 collective works based on the Program.
9458
9459 In addition, mere aggregation of another work not based on the Program
9460 with the Program (or with a work based on the Program) on a volume of
9461 a storage or distribution medium does not bring the other work under
9462 the scope of this License.
9463
9464 @item
9465 You may copy and distribute the Program (or a work based on it,
9466 under Section 2) in object code or executable form under the terms of
9467 Sections 1 and 2 above provided that you also do one of the following:
9468
9469 @enumerate a
9470 @item
9471 Accompany it with the complete corresponding machine-readable
9472 source code, which must be distributed under the terms of Sections
9473 1 and 2 above on a medium customarily used for software interchange; or,
9474
9475 @item
9476 Accompany it with a written offer, valid for at least three
9477 years, to give any third party, for a charge no more than your
9478 cost of physically performing source distribution, a complete
9479 machine-readable copy of the corresponding source code, to be
9480 distributed under the terms of Sections 1 and 2 above on a medium
9481 customarily used for software interchange; or,
9482
9483 @item
9484 Accompany it with the information you received as to the offer
9485 to distribute corresponding source code. (This alternative is
9486 allowed only for noncommercial distribution and only if you
9487 received the program in object code or executable form with such
9488 an offer, in accord with Subsection b above.)
9489 @end enumerate
9490
9491 The source code for a work means the preferred form of the work for
9492 making modifications to it. For an executable work, complete source
9493 code means all the source code for all modules it contains, plus any
9494 associated interface definition files, plus the scripts used to
9495 control compilation and installation of the executable. However, as a
9496 special exception, the source code distributed need not include
9497 anything that is normally distributed (in either source or binary
9498 form) with the major components (compiler, kernel, and so on) of the
9499 operating system on which the executable runs, unless that component
9500 itself accompanies the executable.
9501
9502 If distribution of executable or object code is made by offering
9503 access to copy from a designated place, then offering equivalent
9504 access to copy the source code from the same place counts as
9505 distribution of the source code, even though third parties are not
9506 compelled to copy the source along with the object code.
9507
9508 @item
9509 You may not copy, modify, sublicense, or distribute the Program
9510 except as expressly provided under this License. Any attempt
9511 otherwise to copy, modify, sublicense or distribute the Program is
9512 void, and will automatically terminate your rights under this License.
9513 However, parties who have received copies, or rights, from you under
9514 this License will not have their licenses terminated so long as such
9515 parties remain in full compliance.
9516
9517 @item
9518 You are not required to accept this License, since you have not
9519 signed it. However, nothing else grants you permission to modify or
9520 distribute the Program or its derivative works. These actions are
9521 prohibited by law if you do not accept this License. Therefore, by
9522 modifying or distributing the Program (or any work based on the
9523 Program), you indicate your acceptance of this License to do so, and
9524 all its terms and conditions for copying, distributing or modifying
9525 the Program or works based on it.
9526
9527 @item
9528 Each time you redistribute the Program (or any work based on the
9529 Program), the recipient automatically receives a license from the
9530 original licensor to copy, distribute or modify the Program subject to
9531 these terms and conditions. You may not impose any further
9532 restrictions on the recipients' exercise of the rights granted herein.
9533 You are not responsible for enforcing compliance by third parties to
9534 this License.
9535
9536 @item
9537 If, as a consequence of a court judgment or allegation of patent
9538 infringement or for any other reason (not limited to patent issues),
9539 conditions are imposed on you (whether by court order, agreement or
9540 otherwise) that contradict the conditions of this License, they do not
9541 excuse you from the conditions of this License. If you cannot
9542 distribute so as to satisfy simultaneously your obligations under this
9543 License and any other pertinent obligations, then as a consequence you
9544 may not distribute the Program at all. For example, if a patent
9545 license would not permit royalty-free redistribution of the Program by
9546 all those who receive copies directly or indirectly through you, then
9547 the only way you could satisfy both it and this License would be to
9548 refrain entirely from distribution of the Program.
9549
9550 If any portion of this section is held invalid or unenforceable under
9551 any particular circumstance, the balance of the section is intended to
9552 apply and the section as a whole is intended to apply in other
9553 circumstances.
9554
9555 It is not the purpose of this section to induce you to infringe any
9556 patents or other property right claims or to contest validity of any
9557 such claims; this section has the sole purpose of protecting the
9558 integrity of the free software distribution system, which is
9559 implemented by public license practices. Many people have made
9560 generous contributions to the wide range of software distributed
9561 through that system in reliance on consistent application of that
9562 system; it is up to the author/donor to decide if he or she is willing
9563 to distribute software through any other system and a licensee cannot
9564 impose that choice.
9565
9566 This section is intended to make thoroughly clear what is believed to
9567 be a consequence of the rest of this License.
9568
9569 @item
9570 If the distribution and/or use of the Program is restricted in
9571 certain countries either by patents or by copyrighted interfaces, the
9572 original copyright holder who places the Program under this License
9573 may add an explicit geographical distribution limitation excluding
9574 those countries, so that distribution is permitted only in or among
9575 countries not thus excluded. In such case, this License incorporates
9576 the limitation as if written in the body of this License.
9577
9578 @item
9579 The Free Software Foundation may publish revised and/or new versions
9580 of the General Public License from time to time. Such new versions will
9581 be similar in spirit to the present version, but may differ in detail to
9582 address new problems or concerns.
9583
9584 Each version is given a distinguishing version number. If the Program
9585 specifies a version number of this License which applies to it and ``any
9586 later version,'' you have the option of following the terms and conditions
9587 either of that version or of any later version published by the Free
9588 Software Foundation. If the Program does not specify a version number of
9589 this License, you may choose any version ever published by the Free Software
9590 Foundation.
9591
9592 @item
9593 If you wish to incorporate parts of the Program into other free
9594 programs whose distribution conditions are different, write to the author
9595 to ask for permission. For software which is copyrighted by the Free
9596 Software Foundation, write to the Free Software Foundation; we sometimes
9597 make exceptions for this. Our decision will be guided by the two goals
9598 of preserving the free status of all derivatives of our free software and
9599 of promoting the sharing and reuse of software generally.
9600
9601 @iftex
9602 @heading NO WARRANTY
9603 @end iftex
9604 @ifinfo
9605 @center NO WARRANTY
9606 @end ifinfo
9607
9608 @item
9609 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
9610 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW@. EXCEPT WHEN
9611 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
9612 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
9613 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
9614 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE@. THE ENTIRE RISK AS
9615 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU@. SHOULD THE
9616 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
9617 REPAIR OR CORRECTION.
9618
9619 @item
9620 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
9621 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
9622 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
9623 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
9624 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
9625 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
9626 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
9627 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
9628 POSSIBILITY OF SUCH DAMAGES.
9629 @end enumerate
9630
9631 @iftex
9632 @heading END OF TERMS AND CONDITIONS
9633 @end iftex
9634 @ifinfo
9635 @center END OF TERMS AND CONDITIONS
9636 @end ifinfo
9637
9638 @page
9639 @unnumberedsec How to Apply These Terms to Your New Programs
9640
9641 If you develop a new program, and you want it to be of the greatest
9642 possible use to the public, the best way to achieve this is to make it
9643 free software which everyone can redistribute and change under these terms.
9644
9645 To do so, attach the following notices to the program. It is safest
9646 to attach them to the start of each source file to most effectively
9647 convey the exclusion of warranty; and each file should have at least
9648 the ``copyright'' line and a pointer to where the full notice is found.
9649
9650 @smallexample
9651 @var{one line to give the program's name and an idea of what it does.}
9652 Copyright (C) @var{yyyy} @var{name of author}
9653
9654 This program is free software; you can redistribute it and/or
9655 modify it under the terms of the GNU General Public License
9656 as published by the Free Software Foundation; either version 3
9657 of the License, or (at your option) any later version.
9658
9659 This program is distributed in the hope that it will be useful,
9660 but WITHOUT ANY WARRANTY; without even the implied warranty of
9661 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE@. See the
9662 GNU General Public License for more details.
9663
9664 You should have received a copy of the GNU General Public License along
9665 with this program; if not, write to the Free Software Foundation, Inc.,
9666 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
9667 @end smallexample
9668
9669 Also add information on how to contact you by electronic and paper mail.
9670
9671 If the program is interactive, make it output a short notice like this
9672 when it starts in an interactive mode:
9673
9674 @smallexample
9675 Gnomovision version 69, Copyright (C) @var{yyyy} @var{name of author}
9676 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
9677 type `show w'. This is free software, and you are welcome
9678 to redistribute it under certain conditions; type `show c'
9679 for details.
9680 @end smallexample
9681
9682 The hypothetical commands @samp{show w} and @samp{show c} should show
9683 the appropriate parts of the General Public License. Of course, the
9684 commands you use may be called something other than @samp{show w} and
9685 @samp{show c}; they could even be mouse-clicks or menu items---whatever
9686 suits your program.
9687
9688 You should also get your employer (if you work as a programmer) or your
9689 school, if any, to sign a ``copyright disclaimer'' for the program, if
9690 necessary. Here is a sample; alter the names:
9691
9692 @smallexample
9693 @group
9694 Yoyodyne, Inc., hereby disclaims all copyright
9695 interest in the program `Gnomovision'
9696 (which makes passes at compilers) written
9697 by James Hacker.
9698
9699 @var{signature of Ty Coon}, 1 April 1989
9700 Ty Coon, President of Vice
9701 @end group
9702 @end smallexample
9703
9704 This General Public License does not permit incorporating your program into
9705 proprietary programs. If your program is a subroutine library, you may
9706 consider it more useful to permit linking proprietary applications with the
9707 library. If this is what you want to do, use the GNU Lesser General
9708 Public License instead of this License.
9709
9710 @node Key Index, Command Index, GPL, Top
9711 @unnumbered Key (Character) Index
9712 @printindex ky
9713
9714 @node Command Index, Option Index, Key Index, Top
9715 @unnumbered Command Index
9716 @printindex fn
9717
9718 @node Option Index, Concept Index, Command Index, Top
9719 @unnumbered Option (Variable) Index
9720 @printindex vr
9721
9722 @node Concept Index, , Option Index, Top
9723 @unnumbered Concept Index
9724 @printindex cp
9725
9726 @bye
9727
9728 @c Ispell Helpers
9729 @c
9730 @c The following are words that ispell should ignore that would not
9731 @c normally be in a dictionary (global or personal). Be careful not to
9732 @c include words here that could potentially be typos of other words
9733 @c (such as url, elisp, or MHE).
9734 @c
9735 @c LocalWords: CTRL ESC SPC f's
9736 @c LocalWords: addr Aliasfile alist
9737 @c LocalWords: Baushke Bcc BBN Beranek bogofilter bogofilter's
9738 @c LocalWords: cmd CMU contrib cron
9739 @c LocalWords: DesBrisay Dcc devel dir dired docstring filll forw
9740 @c LocalWords: GECOS Gildea Gildea's Ginnean GnuCash goto gnuserv htm
9741 @c LocalWords: ImageMagick inbox ispell keychain
9742 @c LocalWords: Larus licensor LocalWords lookup lpr
9743 @c LocalWords: makeinfo mairix mbox mh mhbuild mhl mhpath mlisp
9744 @c LocalWords: MML msg multipart
9745 @c LocalWords: Namazu NIS nenscript nnml num
9746 @c LocalWords: packmbox passphrase pathname prev procmail prog repl
9747 @c LocalWords: slocal sortm SpamAssassin spammers SpamProbe SpamProbe's
9748 @c LocalWords: sublicense supercite speedbar
9749 @c LocalWords: Tennex texi texinfo Thelen thelenm
9750 @c LocalWords: UCI undeleted whatnow wohler xmh ypcat
9751 @c
9752 @c See http://www.oreilly.com/oreilly/author/stylesheet.html.
9753 @c See http://en.wikipedia.org/.
9754 @c
9755 @c Note the lowercase mh which is needed to avoid hits in the
9756 @c functions and variables. Occasionally, check for accidental
9757 @c inclusion of mh in text by uncommenting the following and executing
9758 @c it with C-x C-e. You want to see "Search failed"
9759 @c (let ((case-fold-search nil))
9760 @c (goto-char (point-min))
9761 @c (search-forward-regexp "^mh\\( \\|$\\)"))
9762 @c
9763 @c An extremely useful setting for texinfo-mode-hook is:
9764 @c (add-to-list
9765 @c 'ispell-skip-region-alist
9766 @c (list
9767 @c (concat "\\(@\\(small\\)?\\(example\\|lisp\\)"
9768 @c "\\(@\\([irw]\\|code\\|var\\){[^}]+}\\|"
9769 @c "@[@{}.]\\|"
9770 @c "[^@]\\|"
9771 @c "@\\(end \\)?group\\|"
9772 @c "@\\(end \\)?cartouche\\)+"
9773 @c "@end \\(small\\)?\\(example\\|lisp\\)\\|"
9774 @c "@\\(code\\|command\\|file\\|kbd\\|sc\\){[^}]+}\\|"
9775 @c "^@end [a-z]+$\\|"
9776 @c "^@\\([fv]\\|print\\)index .*$\\|"
9777 @c "@uref{[^,]+,\\|"
9778 @c "@[a-z]+\\|"
9779 @c "/[a-z.]+[/}]\\)")))))
9780 @c
9781 @c Cross References
9782 @c
9783 @c See existing cross-references to the Emacs manual and the Emacs
9784 @c Lisp manual (search for ``GNU Emacs Manual'' and ``GNU
9785 @c Emacs Lisp Reference Manual'' respectively).
9786
9787 @c @ftable Sorting
9788 @c
9789 @c As per index (sort of): Punctuation, keyboard characters (such as
9790 @c RET and BS) upper and lowercase mixed (lower comes before
9791 @c uppercase), control characters go with uppercase C, meta characters
9792 @c go with uppercase M.
9793 @c In some cases, the sort isn't strictly ASCII.
9794 @c For example, SPC (mh-page-msg) reads better before BS
9795 @c (mh-previous-page) and . (mh-show) is better before ,
9796 @c (mh-header-display).
9797
9798 @c @vtable Sorting
9799 @c
9800 @c Alphabetical, pull hooks into their own table.
9801
9802 @c Local Variables:
9803 @c sentence-end-double-space: nil
9804 @c End:
9805
9806 @ignore
9807 arch-tag: b778477d-1a10-4a99-84de-f877a2ea6bef
9808 @end ignore