(sigchld_handler): Set synch_process_termsig
[emacs.git] / man / message.texi
blob41c563ca3831799432c197ce19e751136329ee9f
1 \input texinfo                  @c -*-texinfo-*-
3 @setfilename ../info/message
4 @settitle Message 5.9.0 Manual
5 @synindex fn cp
6 @synindex vr cp
7 @synindex pg cp
8 @copying
9 This file documents Message, the Emacs message composition mode.
11 Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002 Free Software
12 Foundation, Inc.
14 @quotation
15 Permission is granted to copy, distribute and/or modify this document
16 under the terms of the GNU Free Documentation License, Version 1.1 or
17 any later version published by the Free Software Foundation; with no
18 Invariant Sections, with the Front-Cover texts being ``A GNU
19 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
20 license is included in the section entitled ``GNU Free Documentation
21 License'' in the Emacs manual.
23 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
24 this GNU Manual, like GNU software.  Copies published by the Free
25 Software Foundation raise funds for GNU development.''
27 This document is part of a collection distributed under the GNU Free
28 Documentation License.  If you want to distribute this document
29 separately from the collection, you can do so by adding a copy of the
30 license to the document, as described in section 6 of the license.
31 @end quotation
32 @end copying
34 @dircategory Emacs
35 @direntry
36 * Message: (message).   Mail and news composition mode that goes with Gnus.
37 @end direntry
38 @iftex
39 @finalout
40 @end iftex
41 @setchapternewpage odd
44 @titlepage
45 @title Message 5.9.0 Manual
47 @author by Lars Magne Ingebrigtsen
48 @page
49 @vskip 0pt plus 1filll
50 @insertcopying
51 @end titlepage
52 @page
54 @node Top
55 @top Message
57 All message composition from Gnus (both mail and news) takes place in
58 Message mode buffers.
60 @menu
61 * Interface::         Setting up message buffers.
62 * Commands::          Commands you can execute in message mode buffers.
63 * Variables::         Customizing the message buffers.
64 * Compatibility::     Making Message backwards compatible.
65 * Appendices::        More technical things.
66 * Index::             Variable, function and concept index.
67 * Key Index::         List of Message mode keys.
68 @end menu
70 This manual corresponds to Message 5.9.0.  Message is distributed with
71 the Gnus distribution bearing the same version number as this manual.
74 @node Interface
75 @chapter Interface
77 When a program (or a person) wants to respond to a message -- reply,
78 follow up, forward, cancel -- the program (or person) should just put
79 point in the buffer where the message is and call the required command.
80 @code{Message} will then pop up a new @code{message} mode buffer with
81 appropriate headers filled out, and the user can edit the message before
82 sending it.
84 @menu
85 * New Mail Message::     Editing a brand new mail message.
86 * New News Message::     Editing a brand new news message.
87 * Reply::                Replying via mail.
88 * Wide Reply::           Responding to all people via mail.
89 * Followup::             Following up via news.
90 * Canceling News::       Canceling a news article.
91 * Superseding::          Superseding a message.
92 * Forwarding::           Forwarding a message via news or mail.
93 * Resending::            Resending a mail message.
94 * Bouncing::             Bouncing a mail message.
95 @end menu
98 @node New Mail Message
99 @section New Mail Message
101 @findex message-mail
102 The @code{message-mail} command pops up a new message buffer.
104 Two optional parameters are accepted: The first will be used as the
105 @code{To} header and the second as the @code{Subject} header.  If these
106 are @code{nil}, those two headers will be empty.
109 @node New News Message
110 @section New News Message
112 @findex message-news
113 The @code{message-news} command pops up a new message buffer.
115 This function accepts two optional parameters.  The first will be used
116 as the @code{Newsgroups} header and the second as the @code{Subject}
117 header.  If these are @code{nil}, those two headers will be empty.
120 @node Reply
121 @section Reply
123 @findex message-reply
124 The @code{message-reply} function pops up a message buffer that's a
125 reply to the message in the current buffer.
127 @vindex message-reply-to-function
128 Message uses the normal methods to determine where replies are to go
129 (@pxref{Responses}), but you can change the behavior to suit your needs
130 by fiddling with the @code{message-reply-to-function} variable.
132 If you want the replies to go to the @code{Sender} instead of the
133 @code{From}, you could do something like this:
135 @lisp
136 (setq message-reply-to-function
137       (lambda ()
138        (cond ((equal (mail-fetch-field "from") "somebody")
139                (list (cons 'To (mail-fetch-field "sender"))))
140              (t
141               nil))))
142 @end lisp
144 This function will be called narrowed to the head of the article that is
145 being replied to.
147 As you can see, this function should return a string if it has an
148 opinion as to what the To header should be.  If it does not, it should
149 just return @code{nil}, and the normal methods for determining the To
150 header will be used.
152 This function can also return a list.  In that case, each list element
153 should be a cons, where the car should be the name of an header
154 (eg. @code{Cc}) and the cdr should be the header value
155 (eg. @samp{larsi@@ifi.uio.no}).  All these headers will be inserted into
156 the head of the outgoing mail.
159 @node Wide Reply
160 @section Wide Reply
162 @findex message-wide-reply
163 The @code{message-wide-reply} pops up a message buffer that's a wide
164 reply to the message in the current buffer.  A @dfn{wide reply} is a
165 reply that goes out to all people listed in the @code{To}, @code{From}
166 (or @code{Reply-to}) and @code{Cc} headers.
168 @vindex message-wide-reply-to-function
169 Message uses the normal methods to determine where wide replies are to go,
170 but you can change the behavior to suit your needs by fiddling with the
171 @code{message-wide-reply-to-function}.  It is used in the same way as
172 @code{message-reply-to-function} (@pxref{Reply}).
174 @findex message-dont-reply-to-names
175 Addresses that match the @code{message-dont-reply-to-names} regular
176 expression will be removed from the @code{Cc} header.
179 @node Followup
180 @section Followup
182 @findex message-followup
183 The @code{message-followup} command pops up a message buffer that's a
184 followup to the message in the current buffer.
186 @vindex message-followup-to-function
187 Message uses the normal methods to determine where followups are to go,
188 but you can change the behavior to suit your needs by fiddling with the
189 @code{message-followup-to-function}.  It is used in the same way as
190 @code{message-reply-to-function} (@pxref{Reply}).
192 @vindex message-use-followup-to
193 The @code{message-use-followup-to} variable says what to do about
194 @code{Followup-To} headers.  If it is @code{use}, always use the value.
195 If it is @code{ask} (which is the default), ask whether to use the
196 value.  If it is @code{t}, use the value unless it is @samp{poster}.  If
197 it is @code{nil}, don't use the value.
200 @node Canceling News
201 @section Canceling News
203 @findex message-cancel-news
204 The @code{message-cancel-news} command cancels the article in the
205 current buffer.
208 @node Superseding
209 @section Superseding
211 @findex message-supersede
212 The @code{message-supersede} command pops up a message buffer that will
213 supersede the message in the current buffer.
215 @vindex message-ignored-supersedes-headers
216 Headers matching the @code{message-ignored-supersedes-headers} are
217 removed before popping up the new message buffer.  The default is@*
218 @samp{^Path:\\|^Date\\|^NNTP-Posting-Host:\\|^Xref:\\|^Lines:\\|@*
219 ^Received:\\|^X-From-Line:\\|Return-Path:\\|^Supersedes:}.
223 @node Forwarding
224 @section Forwarding
226 @findex message-forward
227 The @code{message-forward} command pops up a message buffer to forward
228 the message in the current buffer.  If given a prefix, forward using
229 news.
231 @table @code
232 @item message-forward-ignored-headers
233 @vindex message-forward-ignored-headers
234 All headers that match this regexp will be deleted when forwarding a message.
236 @item message-make-forward-subject-function
237 @vindex message-make-forward-subject-function
238 A list of functions that are called to generate a subject header for
239 forwarded messages.  The subject generated by the previous function is
240 passed into each successive function.
242 The provided functions are:
244 @table @code
245 @item message-forward-subject-author-subject
246 @findex message-forward-subject-author-subject
247 Source of article (author or newsgroup), in brackets followed by the
248 subject.
250 @item message-forward-subject-fwd
251 Subject of article with @samp{Fwd:} prepended to it.
252 @end table
254 @item message-wash-forwarded-subjects
255 @vindex message-wash-forwarded-subjects
256 If this variable is @code{t}, the subjects of forwarded messages have
257 the evidence of previous forwards (such as @samp{Fwd:}, @samp{Re:},
258 @samp{(fwd)}) removed before the new subject is
259 constructed.  The default value is @code{nil}.
261 @item message-forward-as-mime
262 @vindex message-forward-as-mime
263 If this variable is @code{t} (the default), forwarded messages are
264 included as inline MIME RFC822 parts.  If it's @code{nil}, forwarded
265 messages will just be copied inline to the new message, like previous,
266 non MIME-savvy versions of gnus would do.
267 @end table
270 @node Resending
271 @section Resending
273 @findex message-resend
274 The @code{message-resend} command will prompt the user for an address
275 and resend the message in the current buffer to that address.
277 @vindex message-ignored-resent-headers
278 Headers that match the @code{message-ignored-resent-headers} regexp will
279 be removed before sending the message.  The default is
280 @samp{^Return-receipt}.
283 @node Bouncing
284 @section Bouncing
286 @findex message-bounce
287 The @code{message-bounce} command will, if the current buffer contains a
288 bounced mail message, pop up a message buffer stripped of the bounce
289 information.  A @dfn{bounced message} is typically a mail you've sent
290 out that has been returned by some @code{mailer-daemon} as
291 undeliverable.
293 @vindex message-ignored-bounced-headers
294 Headers that match the @code{message-ignored-bounced-headers} regexp
295 will be removed before popping up the buffer.  The default is
296 @samp{^\\(Received\\|Return-Path\\):}.
299 @node Commands
300 @chapter Commands
302 @menu
303 * Buffer Entry::        Commands after entering a Message buffer.
304 * Header Commands::     Commands for moving to headers.
305 * Movement::            Moving around in message buffers.
306 * Insertion::           Inserting things into message buffers.
307 * MIME::                @sc{mime} considerations.
308 * Various Commands::    Various things.
309 * Sending::             Actually sending the message.
310 * Mail Aliases::        How to use mail aliases.
311 * Spelling::            Having Emacs check your spelling.
312 @end menu
315 @node Buffer Entry
316 @section Buffer Entry
317 @cindex undo
318 @kindex C-_
320 You most often end up in a Message buffer when responding to some other
321 message of some sort.  Message does lots of handling of quoted text, and
322 may remove signatures, reformat the text, or the like---depending on
323 which used settings you're using.  Message usually gets things right,
324 but sometimes it stumbles.  To help the user unwind these stumblings,
325 Message sets the undo boundary before each major automatic action it
326 takes.  If you press the undo key (usually located at @kbd{C-_}) a few
327 times, you will get back the un-edited message you're responding to.
330 @node Header Commands
331 @section Header Commands
333 All these commands move to the header in question.  If it doesn't exist,
334 it will be inserted.
336 @table @kbd
338 @item C-c ?
339 @kindex C-c ?
340 @findex message-goto-to
341 Describe the message mode.
343 @item C-c C-f C-t
344 @kindex C-c C-f C-t
345 @findex message-goto-to
346 Go to the @code{To} header (@code{message-goto-to}).
348 @item C-c C-f C-b
349 @kindex C-c C-f C-b
350 @findex message-goto-bcc
351 Go to the @code{Bcc} header (@code{message-goto-bcc}).
353 @item C-c C-f C-w
354 @kindex C-c C-f C-w
355 @findex message-goto-fcc
356 Go to the @code{Fcc} header (@code{message-goto-fcc}).
358 @item C-c C-f C-c
359 @kindex C-c C-f C-c
360 @findex message-goto-cc
361 Go to the @code{Cc} header (@code{message-goto-cc}).
363 @item C-c C-f C-s
364 @kindex C-c C-f C-s
365 @findex message-goto-subject
366 Go to the @code{Subject} header (@code{message-goto-subject}).
368 @item C-c C-f C-r
369 @kindex C-c C-f C-r
370 @findex message-goto-reply-to
371 Go to the @code{Reply-To} header (@code{message-goto-reply-to}).
373 @item C-c C-f C-n
374 @kindex C-c C-f C-n
375 @findex message-goto-newsgroups
376 Go to the @code{Newsgroups} header (@code{message-goto-newsgroups}).
378 @item C-c C-f C-d
379 @kindex C-c C-f C-d
380 @findex message-goto-distribution
381 Go to the @code{Distribution} header (@code{message-goto-distribution}).
383 @item C-c C-f C-f
384 @kindex C-c C-f C-f
385 @findex message-goto-followup-to
386 Go to the @code{Followup-To} header (@code{message-goto-followup-to}).
388 @item C-c C-f C-k
389 @kindex C-c C-f C-k
390 @findex message-goto-keywords
391 Go to the @code{Keywords} header (@code{message-goto-keywords}).
393 @item C-c C-f C-u
394 @kindex C-c C-f C-u
395 @findex message-goto-summary
396 Go to the @code{Summary} header (@code{message-goto-summary}).
398 @end table
401 @node Movement
402 @section Movement
404 @table @kbd
405 @item C-c C-b
406 @kindex C-c C-b
407 @findex message-goto-body
408 Move to the beginning of the body of the message
409 (@code{message-goto-body}).
411 @item C-c C-i
412 @kindex C-c C-i
413 @findex message-goto-signature
414 Move to the signature of the message (@code{message-goto-signature}).
416 @end table
419 @node Insertion
420 @section Insertion
422 @table @kbd
424 @item C-c C-y
425 @kindex C-c C-y
426 @findex message-yank-original
427 Yank the message that's being replied to into the message buffer
428 (@code{message-yank-original}).
430 @item C-c C-M-y
431 @kindex C-c C-M-y
432 @findex message-yank-buffer
433 Prompt for a buffer name and yank the contents of that buffer into the
434 message buffer (@code{message-yank-buffer}).
436 @item C-c C-q
437 @kindex C-c C-q
438 @findex message-fill-yanked-message
439 Fill the yanked message (@code{message-fill-yanked-message}).  Warning:
440 Can severely mess up the yanked text if its quoting conventions are
441 strange.  You'll quickly get a feel for when it's safe, though.  Anyway,
442 just remember that @kbd{C-x u} (@code{undo}) is available and you'll be
443 all right.
445 @item C-c C-w
446 @kindex C-c C-w
447 @findex message-insert-signature
448 Insert a signature at the end of the buffer
449 (@code{message-insert-signature}).
451 @item C-c M-h
452 @kindex C-c M-h
453 @findex message-insert-headers
454 Insert the message headers (@code{message-insert-headers}).
456 @end table
458 @table @code
459 @item message-ignored-cited-headers
460 @vindex message-ignored-cited-headers
461 All headers that match this regexp will be removed from yanked
462 messages.  The default is @samp{.}, which means that all headers will be
463 removed.
465 @item message-citation-line-function
466 @vindex message-citation-line-function
467 Function called to insert the citation line.  The default is
468 @code{message-insert-citation-line}, which will lead to citation lines
469 that look like:
471 @example
472 Hallvard B Furuseth <h.b.furuseth@@usit.uio.no> writes:
473 @end example
475 Point will be at the beginning of the body of the message when this
476 function is called.
478 @item message-yank-prefix
479 @vindex message-yank-prefix
480 @cindex yanking
481 @cindex quoting
482 When you are replying to or following up an article, you normally want
483 to quote the person you are answering.  Inserting quoted text is done by
484 @dfn{yanking}, and each quoted line you yank will have
485 @code{message-yank-prefix} prepended to it.  The default is @samp{> }.
487 @item message-indentation-spaces
488 @vindex message-indentation-spaces
489 Number of spaces to indent yanked messages.
491 @item message-cite-function
492 @vindex message-cite-function
493 @findex message-cite-original
494 @findex sc-cite-original
495 @findex message-cite-original-without-signature
496 @cindex Supercite
497 Function for citing an original message.  The default is
498 @code{message-cite-original}, which simply inserts the original message
499 and prepends @samp{> } to each line.
500 @code{message-cite-original-without-signature} does the same, but elides
501 the signature.  You can also set it to @code{sc-cite-original} to use
502 Supercite.
504 @item message-indent-citation-function
505 @vindex message-indent-citation-function
506 Function for modifying a citation just inserted in the mail buffer.
507 This can also be a list of functions.  Each function can find the
508 citation between @code{(point)} and @code{(mark t)}.  And each function
509 should leave point and mark around the citation text as modified.
511 @item message-signature
512 @vindex message-signature
513 String to be inserted at the end of the message buffer.  If @code{t}
514 (which is the default), the @code{message-signature-file} file will be
515 inserted instead.  If a function, the result from the function will be
516 used instead.  If a form, the result from the form will be used instead.
517 If this variable is @code{nil}, no signature will be inserted at all.
519 @item message-signature-file
520 @vindex message-signature-file
521 If non-@code{nil} the name of a file containing the signature to be
522 inserted at the end of the buffer.  This is ignored if the file
523 doesn't exist.  The default is @samp{~/.signature}.
525 @end table
527 Note that RFC1036bis says that a signature should be preceded by the three
528 characters @samp{-- } on a line by themselves.  This is to make it
529 easier for the recipient to automatically recognize and process the
530 signature.  So don't remove those characters, even though you might feel
531 that they ruin your beautiful design, like, totally.
533 Also note that no signature should be more than four lines long.
534 Including ASCII graphics is an efficient way to get everybody to believe
535 that you are silly and have nothing important to say.
538 @node MIME
539 @section MIME
540 @cindex MML
541 @cindex MIME
542 @cindex multipart
543 @cindex attachment
545 Message is a @sc{mime}-compliant posting agent.  The user generally
546 doesn't have to do anything to make the @sc{mime} happen---Message will
547 automatically add the @code{Content-Type} and
548 @code{Content-Transfer-Encoding} headers.
550 The most typical thing users want to use the multipart things in
551 @sc{mime} for is to add ``attachments'' to mail they send out.  This can
552 be done with the @code{C-c C-a} command, which will prompt for a file
553 name and a @sc{mime} type.
555 You can also create arbitrarily complex multiparts using the MML
556 language (@pxref{Composing, , Composing, emacs-mime, The Emacs MIME
557 Manual}).
560 @node Various Commands
561 @section Various Commands
563 @table @kbd
565 @item C-c C-r
566 @kindex C-c C-r
567 @findex message-caesar-buffer-body
568 Caesar rotate (aka. rot13) the current message
569 (@code{message-caesar-buffer-body}).  If narrowing is in effect, just
570 rotate the visible portion of the buffer.  A numerical prefix says how
571 many places to rotate the text.  The default is 13.
573 @item C-c C-e
574 @kindex C-c C-e
575 @findex message-elide-region
576 Elide the text between point and mark (@code{message-elide-region}).
577 The text is killed and replaced with the contents of the variable
578 @code{message-elide-ellipsis}. The default value is to use an ellipsis
579 (@samp{[...]}).
581 @item C-c C-z
582 @kindex C-c C-x
583 @findex message-kill-to-signature
584 Kill all the text up to the signature, or if that's missing, up to the
585 end of the message (@code{message-kill-to-signature}).
587 @item C-c C-v
588 @kindex C-c C-v
589 @findex message-delete-not-region
590 Delete all text in the body of the message that is outside the region
591 (@code{message-delete-not-region}).
593 @item M-RET
594 @kindex M-RET
595 @kindex message-newline-and-reformat
596 Insert four newlines, and then reformat if inside quoted text.
598 Here's an example:
600 @example
601 > This is some quoted text.  And here's more quoted text.
602 @end example
604 If point is before @samp{And} and you press @kbd{M-RET}, you'll get:
606 @example
607 > This is some quoted text.
611 > And here's more quoted text.
612 @end example
614 @samp{*} says where point will be placed.
616 @item C-c C-t
617 @kindex C-c C-t
618 @findex message-insert-to
619 Insert a @code{To} header that contains the @code{Reply-To} or
620 @code{From} header of the message you're following up
621 (@code{message-insert-to}).
623 @item C-c C-n
624 @kindex C-c C-n
625 @findex message-insert-newsgroups
626 Insert a @code{Newsgroups} header that reflects the @code{Followup-To}
627 or @code{Newsgroups} header of the article you're replying to
628 (@code{message-insert-newsgroups}).
630 @item C-c M-r
631 @kindex C-c M-r
632 @findex message-rename-buffer
633 Rename the buffer (@code{message-rename-buffer}).  If given a prefix,
634 prompt for a new buffer name.
636 @end table
639 @node Sending
640 @section Sending
642 @table @kbd
643 @item C-c C-c
644 @kindex C-c C-c
645 @findex message-send-and-exit
646 Send the message and bury the current buffer
647 (@code{message-send-and-exit}).
649 @item C-c C-s
650 @kindex C-c C-s
651 @findex message-send
652 Send the message (@code{message-send}).
654 @item C-c C-d
655 @kindex C-c C-d
656 @findex message-dont-send
657 Bury the message buffer and exit (@code{message-dont-send}).
659 @item C-c C-k
660 @kindex C-c C-k
661 @findex message-kill-buffer
662 Kill the message buffer and exit (@code{message-kill-buffer}).
664 @end table
668 @node Mail Aliases
669 @section Mail Aliases
670 @cindex mail aliases
671 @cindex aliases
673 @vindex message-mail-alias-type
674 The @code{message-mail-alias-type} variable controls what type of mail
675 alias expansion to use.  Currently only one form is supported---Message
676 uses @code{mailabbrev} to handle mail aliases.  If this variable is
677 @code{nil}, no mail alias expansion will be performed.
679 @code{mailabbrev} works by parsing the @file{/etc/mailrc} and
680 @file{~/.mailrc} files.  These files look like:
682 @example
683 alias lmi "Lars Magne Ingebrigtsen <larsi@@ifi.uio.no>"
684 alias ding "ding@@ifi.uio.no (ding mailing list)"
685 @end example
687 After adding lines like this to your @file{~/.mailrc} file, you should
688 be able to just write @samp{lmi} in the @code{To} or @code{Cc} (and so
689 on) headers and press @kbd{SPC} to expand the alias.
691 No expansion will be performed upon sending of the message---all
692 expansions have to be done explicitly.
695 @node Spelling
696 @section Spelling
697 @cindex spelling
698 @findex ispell-message
700 There are two popular ways to have Emacs spell-check your messages:
701 @code{ispell} and @code{flyspell}.  @code{ispell} is the older and
702 probably more popular package.  You typically first write the message,
703 and then run the entire thing through @code{ispell} and fix all the
704 typos.  To have this happen automatically when you send a message, put
705 something like the following in your @file{.emacs} file:
707 @lisp
708 (add-hook 'message-send-hook 'ispell-message)
709 @end lisp
711 @vindex ispell-message-dictionary-alist
712 If you're in the habit of writing in different languages, this can be
713 controlled by the @code{ispell-message-dictionary-alist} variable:
715 @lisp
716 (setq ispell-message-dictionary-alist
717       '(("^Newsgroups:.*\\bde\\." . "deutsch8")
718         (".*" . "default")))
719 @end lisp
721 @code{ispell} depends on having the external @samp{ispell} command
722 installed.
724 The other popular method is using @code{flyspell}.  This package checks
725 your spelling while you're writing, and marks any mis-spelled words in
726 various ways.
728 To use @code{flyspell}, put something like the following in your
729 @file{.emacs} file:
731 @lisp
732 (defun my-message-setup-routine ()
733   (flyspell-mode 1))
734 (add-hook 'message-setup-hook 'my-message-setup-routine)
735 @end lisp
737 @code{flyspell} depends on having the external @samp{ispell} command
738 installed.
741 @node Variables
742 @chapter Variables
744 @menu
745 * Message Headers::             General message header stuff.
746 * Mail Headers::                Customizing mail headers.
747 * Mail Variables::              Other mail variables.
748 * News Headers::                Customizing news headers.
749 * News Variables::              Other news variables.
750 * Various Message Variables::   Other message variables.
751 * Sending Variables::           Variables for sending.
752 * Message Buffers::             How Message names its buffers.
753 * Message Actions::             Actions to be performed when exiting.
754 @end menu
757 @node Message Headers
758 @section Message Headers
760 Message is quite aggressive on the message generation front.  It has to
761 be -- it's a combined news and mail agent.  To be able to send combined
762 messages, it has to generate all headers itself (instead of letting the
763 mail/news system do it) to ensure that mail and news copies of messages
764 look sufficiently similar.
766 @table @code
768 @item message-generate-headers-first
769 @vindex message-generate-headers-first
770 If non-@code{nil}, generate all required headers before starting to
771 compose the message.
773 The variables @code{message-required-mail-headers} and
774 @code{message-required-news-headers} specify which headers are required.
776 @item message-from-style
777 @vindex message-from-style
778 Specifies how @code{From} headers should look.  There are four valid
779 values:
781 @table @code
782 @item nil
783 Just the address -- @samp{king@@grassland.com}.
785 @item parens
786 @samp{king@@grassland.com (Elvis Parsley)}.
788 @item angles
789 @samp{Elvis Parsley <king@@grassland.com>}.
791 @item default
792 Look like @code{angles} if that doesn't require quoting, and
793 @code{parens} if it does.  If even @code{parens} requires quoting, use
794 @code{angles} anyway.
796 @end table
798 @item message-deletable-headers
799 @vindex message-deletable-headers
800 Headers in this list that were previously generated by Message will be
801 deleted before posting.  Let's say you post an article.  Then you decide
802 to post it again to some other group, you naughty boy, so you jump back
803 to the @code{*post-buf*} buffer, edit the @code{Newsgroups} line, and
804 ship it off again.  By default, this variable makes sure that the old
805 generated @code{Message-ID} is deleted, and a new one generated.  If
806 this isn't done, the entire empire would probably crumble, anarchy would
807 prevail, and cats would start walking on two legs and rule the world.
808 Allegedly.
810 @item message-default-headers
811 @vindex message-default-headers
812 This string is inserted at the end of the headers in all message
813 buffers.
815 @item message-subject-re-regexp
816 @vindex message-subject-re-regexp
817 Responses to messages have subjects that start with @samp{Re: }.  This
818 is @emph{not} an abbreviation of the English word ``response'', but is
819 Latin, and means ``in response to''.  Some illiterate nincompoops have
820 failed to grasp this fact, and have ``internationalized'' their software
821 to use abominations like @samp{Aw: } (``antwort'') or @samp{Sv: }
822 (``svar'') instead, which is meaningless and evil.  However, you may
823 have to deal with users that use these evil tools, in which case you may
824 set this variable to a regexp that matches these prefixes.  Myself, I
825 just throw away non-compliant mail.
827 @item message-alternative-emails
828 @vindex message-alternative-emails
829 A regexp to match the alternative email addresses.  The first matched
830 address (not primary one) is used in the @code{From} field.
832 @end table
835 @node Mail Headers
836 @section Mail Headers
838 @table @code
839 @item message-required-mail-headers
840 @vindex message-required-mail-headers
841 @xref{News Headers}, for the syntax of this variable.  It is
842 @code{(From Date Subject (optional . In-Reply-To) Message-ID Lines
843 (optional . User-Agent))} by default.
845 @item message-ignored-mail-headers
846 @vindex message-ignored-mail-headers
847 Regexp of headers to be removed before mailing.  The default is
848 @samp{^[GF]cc:\|^Resent-Fcc:\|^Xref:}.
850 @item message-default-mail-headers
851 @vindex message-default-mail-headers
852 This string is inserted at the end of the headers in all message
853 buffers that are initialized as mail.
855 @end table
858 @node Mail Variables
859 @section Mail Variables
861 @table @code
862 @item message-send-mail-function
863 @vindex message-send-mail-function
864 Function used to send the current buffer as mail.  The default is
865 @code{message-send-mail-with-sendmail}.   If you prefer using MH
866 instead, set this variable to @code{message-send-mail-with-mh}.
868 @item message-mh-deletable-headers
869 @vindex message-mh-deletable-headers
870 Most versions of MH doesn't like being fed messages that contain the
871 headers in this variable.  If this variable is non-@code{nil} (which is
872 the default), these headers will be removed before mailing when sending
873 messages via MH.  Set it to @code{nil} if your MH can handle these
874 headers.
876 @item message-send-mail-partially-limit
877 @vindex message-send-mail-partially-limit
878 The limit on the size of messages sent as @samp{message/partial}.
879 This is the minimum message size in characters beyond which the
880 message should be sent in several parts.  If it is @code{nil}, the
881 size is unlimited.
883 @end table
886 @node News Headers
887 @section News Headers
889 @vindex message-required-news-headers
890 @code{message-required-news-headers} a list of header symbols.  These
891 headers will either be automatically generated, or, if that's
892 impossible, they will be prompted for.  The following symbols are valid:
894 @table @code
896 @item From
897 @cindex From
898 @findex user-full-name
899 @findex user-mail-address
900 This required header will be filled out with the result of the
901 @code{message-make-from} function, which depends on the
902 @code{message-from-style}, @code{user-full-name},
903 @code{user-mail-address} variables.
905 @item Subject
906 @cindex Subject
907 This required header will be prompted for if not present already.
909 @item Newsgroups
910 @cindex Newsgroups
911 This required header says which newsgroups the article is to be posted
912 to.  If it isn't present already, it will be prompted for.
914 @item Organization
915 @cindex organization
916 This optional header will be filled out depending on the
917 @code{message-user-organization} variable.
918 @code{message-user-organization-file} will be used if this variable is
919 @code{t}.  This variable can also be a string (in which case this string
920 will be used), or it can be a function (which will be called with no
921 parameters and should return a string to be used).
923 @item Lines
924 @cindex Lines
925 This optional header will be computed by Message.
927 @item Message-ID
928 @cindex Message-ID
929 @vindex mail-host-address
930 @findex system-name
931 @cindex Sun
932 This required header will be generated by Message.  A unique ID will be
933 created based on the date, time, user name and system name.  Message
934 will use @code{system-name} to determine the name of the system.  If
935 this isn't a fully qualified domain name (FQDN), Message will use
936 @code{mail-host-address} as the FQDN of the machine.
938 @item User-Agent
939 @cindex User-Agent
940 This optional header will be filled out according to the
941 @code{message-newsreader} local variable.
943 @item In-Reply-To
944 This optional header is filled out using the @code{Date} and @code{From}
945 header of the article being replied to.
947 @item Expires
948 @cindex Expires
949 This extremely optional header will be inserted according to the
950 @code{message-expires} variable.  It is highly deprecated and shouldn't
951 be used unless you know what you're doing.
953 @item Distribution
954 @cindex Distribution
955 This optional header is filled out according to the
956 @code{message-distribution-function} variable.  It is a deprecated and
957 much misunderstood header.
959 @item Path
960 @cindex path
961 This extremely optional header should probably never be used.
962 However, some @emph{very} old servers require that this header is
963 present.  @code{message-user-path} further controls how this
964 @code{Path} header is to look.  If it is @code{nil}, use the server name
965 as the leaf node.  If it is a string, use the string.  If it is neither
966 a string nor @code{nil}, use the user name only.  However, it is highly
967 unlikely that you should need to fiddle with this variable at all.
968 @end table
970 @findex yow
971 @cindex Mime-Version
972 In addition, you can enter conses into this list.  The car of this cons
973 should be a symbol.  This symbol's name is the name of the header, and
974 the cdr can either be a string to be entered verbatim as the value of
975 this header, or it can be a function to be called.  This function should
976 return a string to be inserted.  For instance, if you want to insert
977 @code{Mime-Version: 1.0}, you should enter @code{(Mime-Version . "1.0")}
978 into the list.  If you want to insert a funny quote, you could enter
979 something like @code{(X-Yow . yow)} into the list.  The function
980 @code{yow} will then be called without any arguments.
982 If the list contains a cons where the car of the cons is
983 @code{optional}, the cdr of this cons will only be inserted if it is
984 non-@code{nil}.
986 Other variables for customizing outgoing news articles:
988 @table @code
990 @item message-syntax-checks
991 @vindex message-syntax-checks
992 Controls what syntax checks should not be performed on outgoing posts.
993 To disable checking of long signatures, for instance, add
995 @lisp
996 (signature . disabled)
997 @end lisp
999 to this list.
1001 Valid checks are:
1003 @table @code
1004 @item subject-cmsg
1005 Check the subject for commands.
1006 @item sender
1007 @cindex Sender
1008 Insert a new @code{Sender} header if the @code{From} header looks odd.
1009 @item multiple-headers
1010 Check for the existence of multiple equal headers.
1011 @item sendsys
1012 @cindex sendsys
1013 Check for the existence of version and sendsys commands.
1014 @item message-id
1015 Check whether the @code{Message-ID} looks ok.
1016 @item from
1017 Check whether the @code{From} header seems nice.
1018 @item long-lines
1019 @cindex long lines
1020 Check for too long lines.
1021 @item control-chars
1022 Check for invalid characters.
1023 @item size
1024 Check for excessive size.
1025 @item new-text
1026 Check whether there is any new text in the messages.
1027 @item signature
1028 Check the length of the signature.
1029 @item approved
1030 @cindex approved
1031 Check whether the article has an @code{Approved} header, which is
1032 something only moderators should include.
1033 @item empty
1034 Check whether the article is empty.
1035 @item invisible-text
1036 Check whether there is any invisible text in the buffer.
1037 @item empty-headers
1038 Check whether any of the headers are empty.
1039 @item existing-newsgroups
1040 Check whether the newsgroups mentioned in the @code{Newsgroups} and
1041 @code{Followup-To} headers exist.
1042 @item valid-newsgroups
1043 Check whether the @code{Newsgroups} and @code{Followup-to} headers
1044 are valid syntactically.
1045 @item repeated-newsgroups
1046 Check whether the @code{Newsgroups} and @code{Followup-to} headers
1047 contains repeated group names.
1048 @item shorten-followup-to
1049 Check whether to add a @code{Followup-to} header to shorten the number
1050 of groups to post to.
1051 @end table
1053 All these conditions are checked by default.
1055 @item message-ignored-news-headers
1056 @vindex message-ignored-news-headers
1057 Regexp of headers to be removed before posting.  The default is@*
1058 @samp{^NNTP-Posting-Host:\\|^Xref:\\|^[BGF]cc:\\|^Resent-Fcc:}.
1060 @item message-default-news-headers
1061 @vindex message-default-news-headers
1062 This string is inserted at the end of the headers in all message
1063 buffers that are initialized as news.
1065 @end table
1068 @node News Variables
1069 @section News Variables
1071 @table @code
1072 @item message-send-news-function
1073 @vindex message-send-news-function
1074 Function used to send the current buffer as news.  The default is
1075 @code{message-send-news}.
1077 @item message-post-method
1078 @vindex message-post-method
1079 Gnusish @dfn{select method} (see the Gnus manual for details) used for
1080 posting a prepared news message.
1082 @end table
1085 @node Various Message Variables
1086 @section Various Message Variables
1088 @table @code
1089 @item message-default-charset
1090 @vindex message-default-charset
1091 @cindex charset
1092 Symbol naming a @sc{mime} charset.  Non-ASCII characters in messages are
1093 assumed to be encoded using this charset.  The default is @code{nil},
1094 which means ask the user.  (This variable is used only on non-@sc{mule}
1095 Emacsen.
1096 @xref{Charset Translation, , Charset Translation, emacs-mime,
1097       Emacs MIME Manual}, for details on the @sc{mule}-to-@sc{mime}
1098 translation process.
1100 @item message-signature-separator
1101 @vindex message-signature-separator
1102 Regexp matching the signature separator.  It is @samp{^-- *$} by
1103 default.
1105 @item mail-header-separator
1106 @vindex mail-header-separator
1107 String used to separate the headers from the body.  It is @samp{--text
1108 follows this line--} by default.
1110 @item message-directory
1111 @vindex message-directory
1112 Directory used by many mailey things.  The default is @file{~/Mail/}.
1114 @item message-signature-setup-hook
1115 @vindex message-signature-setup-hook
1116 Hook run when initializing the message buffer.  It is run after the
1117 headers have been inserted but before the signature has been inserted.
1119 @item message-setup-hook
1120 @vindex message-setup-hook
1121 Hook run as the last thing when the message buffer has been initialized,
1122 but before yanked text is inserted.
1124 @item message-header-setup-hook
1125 @vindex message-header-setup-hook
1126 Hook called narrowed to the headers after initializing the headers.
1128 For instance, if you're running Gnus and wish to insert a
1129 @samp{Mail-Copies-To} header in all your news articles and all messages
1130 you send to mailing lists, you could do something like the following:
1132 @lisp
1133 (defun my-message-header-setup-hook ()
1134   (let ((group (or gnus-newsgroup-name "")))
1135     (when (or (message-fetch-field "newsgroups")
1136               (gnus-group-find-parameter group 'to-address)
1137               (gnus-group-find-parameter group 'to-list))
1138       (insert "Mail-Copies-To: never\n"))))
1140 (add-hook 'message-header-setup-hook
1141           'my-message-header-setup-hook)
1142 @end lisp
1144 @item message-send-hook
1145 @vindex message-send-hook
1146 Hook run before sending messages.
1148 If you want to add certain headers before sending, you can use the
1149 @code{message-add-header} function in this hook.  For instance:
1150 @findex message-add-header
1152 @lisp
1153 (add-hook 'message-send-hook 'my-message-add-content)
1154 (defun my-message-add-content ()
1155   (message-add-header "X-In-No-Sense: Nonsense")
1156   (message-add-header "X-Whatever: no"))
1157 @end lisp
1159 This function won't add the header if the header is already present.
1161 @item message-send-mail-hook
1162 @vindex message-send-mail-hook
1163 Hook run before sending mail messages.
1165 @item message-send-news-hook
1166 @vindex message-send-news-hook
1167 Hook run before sending news messages.
1169 @item message-sent-hook
1170 @vindex message-sent-hook
1171 Hook run after sending messages.
1173 @item message-mode-syntax-table
1174 @vindex message-mode-syntax-table
1175 Syntax table used in message mode buffers.
1177 @item message-send-method-alist
1178 @vindex message-send-method-alist
1180 Alist of ways to send outgoing messages.  Each element has the form
1182 @lisp
1183 (TYPE PREDICATE FUNCTION)
1184 @end lisp
1186 @table @var
1187 @item type
1188 A symbol that names the method.
1190 @item predicate
1191 A function called without any parameters to determine whether the
1192 message is a message of type @var{type}.
1194 @item function
1195 A function to be called if @var{predicate} returns non-@code{nil}.
1196 @var{function} is called with one parameter -- the prefix.
1197 @end table
1199 @lisp
1200 ((news message-news-p message-send-via-news)
1201  (mail message-mail-p message-send-via-mail))
1202 @end lisp
1206 @end table
1210 @node Sending Variables
1211 @section Sending Variables
1213 @table @code
1215 @item message-fcc-handler-function
1216 @vindex message-fcc-handler-function
1217 A function called to save outgoing articles.  This function will be
1218 called with the name of the file to store the article in.  The default
1219 function is @code{message-output} which saves in inbox format.
1221 @item message-courtesy-message
1222 @vindex message-courtesy-message
1223 When sending combined messages, this string is inserted at the start of
1224 the mailed copy.  If the string contains the format spec @samp{%s}, the
1225 newsgroups the article has been posted to will be inserted there.  If
1226 this variable is @code{nil}, no such courtesy message will be added.
1227 The default value is @samp{"The following message is a courtesy copy of
1228 an article\nthat has been posted to %s as well.\n\n"}.
1230 @end table
1233 @node Message Buffers
1234 @section Message Buffers
1236 Message will generate new buffers with unique buffer names when you
1237 request a message buffer.  When you send the message, the buffer isn't
1238 normally killed off.  Its name is changed and a certain number of old
1239 message buffers are kept alive.
1241 @table @code
1242 @item message-generate-new-buffers
1243 @vindex message-generate-new-buffers
1244 If non-@code{nil}, generate new buffers.  The default is @code{t}.  If
1245 this is a function, call that function with three parameters: The type,
1246 the to address and the group name.  (Any of these may be @code{nil}.)
1247 The function should return the new buffer name.
1249 @item message-max-buffers
1250 @vindex message-max-buffers
1251 This variable says how many old message buffers to keep.  If there are
1252 more message buffers than this, the oldest buffer will be killed.  The
1253 default is 10.  If this variable is @code{nil}, no old message buffers
1254 will ever be killed.
1256 @item message-send-rename-function
1257 @vindex message-send-rename-function
1258 After sending a message, the buffer is renamed from, for instance,
1259 @samp{*reply to Lars*} to @samp{*sent reply to Lars*}.  If you don't
1260 like this, set this variable to a function that renames the buffer in a
1261 manner you like.  If you don't want to rename the buffer at all, you can
1262 say:
1264 @lisp
1265 (setq message-send-rename-function 'ignore)
1266 @end lisp
1268 @item message-kill-buffer-on-exit
1269 @findex message-kill-buffer-on-exit
1270 If non-@code{nil}, kill the buffer immediately on exit.
1272 @end table
1275 @node Message Actions
1276 @section Message Actions
1278 When Message is being used from a news/mail reader, the reader is likely
1279 to want to perform some task after the message has been sent.  Perhaps
1280 return to the previous window configuration or mark an article as
1281 replied.
1283 @vindex message-kill-actions
1284 @vindex message-postpone-actions
1285 @vindex message-exit-actions
1286 @vindex message-send-actions
1287 The user may exit from the message buffer in various ways.  The most
1288 common is @kbd{C-c C-c}, which sends the message and exits.  Other
1289 possibilities are @kbd{C-c C-s} which just sends the message, @kbd{C-c
1290 C-d} which postpones the message editing and buries the message buffer,
1291 and @kbd{C-c C-k} which kills the message buffer.  Each of these actions
1292 have lists associated with them that contains actions to be executed:
1293 @code{message-send-actions}, @code{message-exit-actions},
1294 @code{message-postpone-actions}, and @code{message-kill-actions}.
1296 Message provides a function to interface with these lists:
1297 @code{message-add-action}.  The first parameter is the action to be
1298 added, and the rest of the arguments are which lists to add this action
1299 to.  Here's an example from Gnus:
1301 @lisp
1302   (message-add-action
1303    `(set-window-configuration ,(current-window-configuration))
1304    'exit 'postpone 'kill)
1305 @end lisp
1307 This restores the Gnus window configuration when the message buffer is
1308 killed, postponed or exited.
1310 An @dfn{action} can be either: a normal function, or a list where the
1311 @code{car} is a function and the @code{cdr} is the list of arguments, or
1312 a form to be @code{eval}ed.
1315 @node Compatibility
1316 @chapter Compatibility
1317 @cindex compatibility
1319 Message uses virtually only its own variables---older @code{mail-}
1320 variables aren't consulted.  To force Message to take those variables
1321 into account, you can put the following in your @code{.emacs} file:
1323 @lisp
1324 (require 'messcompat)
1325 @end lisp
1327 This will initialize many Message variables from the values in the
1328 corresponding mail variables.
1331 @node Appendices
1332 @chapter Appendices
1334 @menu
1335 * Responses::          Standard rules for determining where responses go.
1336 @end menu
1339 @node Responses
1340 @section Responses
1342 To determine where a message is to go, the following algorithm is used
1343 by default.
1345 @table @dfn
1346 @item reply
1347 A @dfn{reply} is when you want to respond @emph{just} to the person who
1348 sent the message via mail.  There will only be one recipient.  To
1349 determine who the recipient will be, the following headers are
1350 consulted, in turn:
1352 @table @code
1353 @item Reply-To
1355 @item From
1356 @end table
1359 @item wide reply
1360 A @dfn{wide reply} is a mail response that includes @emph{all} entities
1361 mentioned in the message you are responded to.  All mailboxes from the
1362 following headers will be concatenated to form the outgoing
1363 @code{To}/@code{Cc} headers:
1365 @table @code
1366 @item From
1367 (unless there's a @code{Reply-To}, in which case that is used instead).
1369 @item Cc
1371 @item To
1372 @end table
1374 If a @code{Mail-Copies-To} header is present, it will also be included
1375 in the list of mailboxes.  If this header is @samp{never}, that means
1376 that the @code{From} (or @code{Reply-To}) mailbox will be suppressed.
1379 @item followup
1380 A @dfn{followup} is a response sent via news.  The following headers
1381 (listed in order of precedence) determine where the response is to be
1382 sent:
1384 @table @code
1386 @item Followup-To
1388 @item Newsgroups
1390 @end table
1392 If a @code{Mail-Copies-To} header is present, it will be used as the
1393 basis of the new @code{Cc} header, except if this header is
1394 @samp{never}.
1396 @end table
1400 @node Index
1401 @chapter Index
1402 @printindex cp
1404 @node Key Index
1405 @chapter Key Index
1406 @printindex ky
1408 @summarycontents
1409 @contents
1410 @bye
1412 @c End:
1414 @ignore
1415    arch-tag: 16ab76af-a281-4e34-aed6-5624569f7601
1416 @end ignore