*** empty log message ***
[gnus] / texi / message.texi
1 \input texinfo                  @c -*-texinfo-*-
2
3 @setfilename message
4 @settitle Message Manual
5 @synindex fn cp
6 @synindex vr cp
7 @synindex pg cp
8 @iftex
9 @finalout
10 @end iftex
11 @setchapternewpage odd
12
13 @ifinfo
14
15 This file documents Messa, the Emacs message composition mode.
16
17 Copyright (C) 1996 Free Software Foundation, Inc.
18
19 Permission is granted to make and distribute verbatim copies of
20 this manual provided the copyright notice and this permission notice
21 are preserved on all copies.
22
23 @ignore
24 Permission is granted to process this file through Tex and print the
25 results, provided the printed document carries copying permission
26 notice identical to this one except for the removal of this paragraph
27 (this paragraph not being relevant to the printed manual).
28
29 @end ignore
30 Permission is granted to copy and distribute modified versions of this
31 manual under the conditions for verbatim copying, provided also that the
32 entire resulting derived work is distributed under the terms of a
33 permission notice identical to this one.
34
35 Permission is granted to copy and distribute translations of this manual
36 into another language, under the above conditions for modified versions.
37 @end ifinfo
38
39 @tex
40
41 @titlepage
42 @title Message Manual
43
44 @author by Lars Magne Ingebrigtsen
45 @page
46
47 @vskip 0pt plus 1filll
48 Copyright @copyright{} 1996 Free Software Foundation, Inc. 
49
50 Permission is granted to make and distribute verbatim copies of
51 this manual provided the copyright notice and this permission notice
52 are preserved on all copies.
53
54 Permission is granted to copy and distribute modified versions of this
55 manual under the conditions for verbatim copying, provided that the
56 entire resulting derived work is distributed under the terms of a
57 permission notice identical to this one.
58
59 Permission is granted to copy and distribute translations of this manual
60 into another language, under the above conditions for modified versions.
61
62 @end titlepage
63 @page
64
65 @end tex
66
67 @node Top
68 @top Message
69
70 All message composition (both mail and news) takes place in Message mode
71 buffers.
72
73 @menu
74 * Interface::         Setting up message buffers.
75 * Commands::          Commands you can execute in message mode buffers.
76 * Variables::         Customizing the message buffers.
77 * Index::             Variable, function and concept index.
78 * Key Index::         List of Message mode keys.
79 @end menu
80
81
82 @node Interface
83 @chapter Interface
84
85 When a program (or a person) wants to respond to a message -- reply,
86 follow up, forward, cancel -- the program (or person) should just put
87 point in the buffer where the message is and call the required command.
88 @code{Message} will then pop up a new @code{message} mode buffer with
89 appropriate headers filled out, and the user can edit the message before
90 sending it.
91
92 @menu
93 * New Mail Message::     Editing a brand new mail message.
94 * New News Message::     Editing a brand new news message.
95 * Reply::                Replying via mail.
96 * Wide Reply::           Responding to all people via mail.
97 * Followup::             Following up via news.
98 * Canceling News::       Canceling a news article.
99 * Superseding::          Superseding a message.
100 * Forwarding::           Forwarding a message via news or mail.
101 * Resending::            Resending a mail message.
102 * Bouncing::             Bouncing a mail message.
103 @end menu
104
105
106 @node New Mail Message
107 @section New Mail Message
108
109 @findex message-mail
110 The @code{message-mail} command pops up a new message buffer.  
111
112 Two optional parameters are accepted: The first will be used as the
113 @code{To} header and the second as the @code{Subject} header.  If these
114 aren't present, those two headers will be empty.
115
116
117 @node New News Message
118 @section New News Message
119
120 @findex message-news
121 The @code{message-news} command pops up a new message buffer.  
122
123 This function accepts two optional parameters.  The first will be used
124 as the @code{Newsgroups} header and the second as the @code{Subject}
125 header.  If these aren't present, those two headers will be empty.
126
127
128 @node Reply
129 @section Reply
130
131 @findex message-reply
132 The @code{message-reply} function pops up a message buffer that's a
133 reply to the message in the current buffer.
134
135 @vindex message-reply-to-function
136 Message uses the normal methods to determine where replies are to go,
137 but you can change the behavior to suit your needs by fiddling with the
138 @code{message-reply-to-function} variable.
139
140 If you want the replies to go to the @code{Sender} instead of the
141 @code{From}, you could do something like this:
142
143 @lisp
144 (setq message-reply-to-function
145       (lambda ()
146        (cond ((equal (mail-fetch-field "from") "somebody")
147                (mail-fetch-field "sender"))     
148              (t 
149               nil))))
150 @end lisp
151
152 This function will be called narrowed to the head of the article that is
153 being replied to.
154
155 As you can see, this function should return a string if it has an
156 opinion as to what the To header should be.  If it does not, it should
157 just return @code{nil}, and the normal methods for determining the To
158 header will be used.
159
160 This function can also return a list.  In that case, each list element
161 should be a cons, where the car should be the name of an header
162 (eg. @code{Cc}) and the cdr should be the header value
163 (eg. @samp{larsi@@ifi.uio.no}).  All these headers will be inserted into
164 the head of the outgoing mail. 
165
166
167 @node Wide Reply
168 @section Wide Reply
169
170 @findex message-wide-reply
171 The @code{message-wide-reply} pops up a message buffer that's a wide
172 reply to the message in the current buffer.  A @dfn{wide reply} is a
173 reply that goes out to all people listed in the @code{To}, @code{From}
174 and @code{Cc} headers.
175
176 @vindex message-wide-reply-to-function
177 Message uses the normal methods to determine where wide replies are to go,
178 but you can change the behavior to suit your needs by fiddling with the
179 @code{message-wide-reply-to-function}.  It is used in the same way as
180 @code{message-reply-to-function} (@pxref{Reply}). 
181
182 @findex rmail-dont-reply-to-names
183 Addresses that match the @code{rmail-dont-reply-to-names} regular
184 expression will be removed from the @code{Cc} header.
185
186
187 @node Followup
188 @section Followup
189
190 @findex message-followup
191 The @code{message-followup} command pops up a message buffer that's a
192 followup to the message in the current buffer.
193
194 @vindex message-followup-to-function
195 Message uses the normal methods to determine where followups are to go,
196 but you can change the behavior to suit your needs by fiddling with the
197 @code{message-followup-to-function}.  It is used in the same way as
198 @code{message-reply-to-function} (@pxref{Reply}).
199
200 @vindex message-use-followup-to
201 The @code{message-use-followup-to} variable says what to do about
202 @code{Followup-To} headers.  If it is @code{use}, always use the value.
203 If it is @code{ask} (which is the default), ask whether to use the
204 value.  If it is @code{t}, use the value unless it is @samp{poster}.  If
205 it is @code{nil}, don't use the value.
206
207
208 @node Canceling News
209 @section Canceling News
210
211 @findex message-cancel-news
212 The @code{message-cancel-news} command cancels the article in the
213 current buffer.
214
215
216 @node Superseding
217 @section Superseding
218
219 @findex message-supersede
220 The @code{message-supersede} command pops up a message buffer that will
221 supersede the message in the current buffer.
222
223 @vindex message-ignored-supersedes-headers
224 Headers matching the @code{message-ignored-supersedes-headers} are
225 removed before popping up the new message buffer.  The default is@*
226 @samp{^Path:\\|^Date\\|^NNTP-Posting-Host:\\|^Xref:\\|^Lines:\\|@*
227 ^Received:\\|^X-From-Line:\\|Return-Path:}.
228
229
230
231 @node Forwarding
232 @section Forwarding
233
234 @findex message-forward
235 The @code{message-forward} command pops up a message buffer to forward
236 the message in the current buffer.  If given a prefix, forward using
237 news.
238
239 @table @code
240 @item message-forward-start-separator
241 @vindex message-forward-start-separator
242 Delimiter inserted before forwarded messages.  The default is@*
243 @samp{------- Start of forwarded message -------\n}. 
244
245 @vindex message-forward-end-separator
246 @item message-forward-end-separator
247 @vindex message-forward-end-separator
248 Delimiter inserted after forwarded messages.  The default is@*
249 @samp{------- End of forwarded message -------\n}. 
250
251 @item message-signature-before-forwarded-message
252 @vindex message-signature-before-forwarded-message
253 If this variable is @code{t}, which it is by default, your personal
254 signature will be inserted before the forwarded message.  If not, the
255 forwarded message will be inserted first in the new mail.
256
257 @item message-included-forward-headers
258 @vindex message-included-forward-headers
259 Regexp matching header lines to be included in forwarded messages.  
260
261 @end table
262
263
264 @node Resending
265 @section Resending
266
267 @findex message-resend
268 The @code{message-resend} command will prompt the user for an address
269 and resend the message in the current buffer to that address.
270
271 @vindex message-ignored-resent-headers
272 Headers that match the @code{message-ignored-resent-headers} regexp will
273 be removed before sending the message.  The default is
274 @samp{^Return-receipt}. 
275
276
277 @node Bouncing
278 @section Bouncing
279
280 @findex message-bounce
281 The @code{message-bounce} command will, if the current buffer contains a
282 bounced mail message, pop up a message buffer stripped of the bounce
283 information.  A @dfn{bounced message} is typically a mail you've sent
284 out that has been returned by some @code{mailer-daemon} as
285 undeliverable. 
286
287 @vindex message-ignored-bounced-headers
288 Headers that match the @code{message-ignored-bounced-headers} regexp
289 will be removed before popping up the buffer.  The default is
290 @samp{^Received:}. 
291
292
293 @node Commands
294 @chapter Commands
295
296 @menu
297 * Header Commands::     Commands for moving to headers.
298 * Movement::            Moving around in message buffers.
299 * Insertion::           Inserting things into message buffers.
300 * Various Commands::    Various things.
301 * Sending::             Actually sending the message.
302 * Mail Aliases::        How to use mail aliases.
303 @end menu
304
305
306 @node Header Commands
307 @section Header Commands
308
309 All these commands move to the header in question.  If it doesn't exist,
310 it will be inserted.
311
312 @table @kbd
313
314 @item C-c ?
315 @kindex C-c ?
316 @findex message-goto-to
317 Describe the message mode.
318
319 @item C-c C-f C-t
320 @kindex C-c C-f C-t 
321 @findex message-goto-to
322 Go to the @code{To} header (@code{message-goto-to}).
323
324 @item C-c C-f C-b
325 @kindex C-c C-f C-b 
326 @findex message-goto-bcc
327 Go to the @code{Bcc} header (@code{message-goto-bcc}).
328
329 @item C-c C-f C-f
330 @kindex C-c C-f C-f 
331 @findex message-goto-fcc
332 Go to the @code{Fcc} header (@code{message-goto-fcc}).
333
334 @item C-c C-f C-c
335 @kindex C-c C-f C-c 
336 @findex message-goto-cc
337 Go to the @code{Cc} header (@code{message-goto-cc}).
338
339 @item C-c C-f C-s
340 @kindex C-c C-f C-s 
341 @findex message-goto-subject
342 Go to the @code{Subject} header (@code{message-goto-subject}).
343
344 @item C-c C-f C-r
345 @kindex C-c C-f C-r 
346 @findex message-goto-reply-to
347 Go to the @code{Reply-To} header (@code{message-goto-reply-to}).
348
349 @item C-c C-f C-n
350 @kindex C-c C-f C-n 
351 @findex message-goto-newsgroups
352 Go to the @code{Newsgroups} header (@code{message-goto-newsgroups}).
353
354 @item C-c C-f C-d
355 @kindex C-c C-f C-d 
356 @findex message-goto-distribution
357 Go to the @code{Distribution} header (@code{message-goto-distribution}).
358
359 @item C-c C-f C-o
360 @kindex C-c C-f C-o 
361 @findex message-goto-followup-to
362 Go to the @code{Followup-To} header (@code{message-goto-followup-to}).
363
364 @item C-c C-f C-k
365 @kindex C-c C-f C-k 
366 @findex message-goto-keywords
367 Go to the @code{Keywords} header (@code{message-goto-keywords}).
368
369 @item C-c C-f C-u
370 @kindex C-c C-f C-u 
371 @findex message-goto-summary
372 Go to the @code{Summary} header (@code{message-goto-summary}).
373
374 @end table
375
376
377 @node Movement
378 @section Movement
379
380 @table @kbd
381 @item C-c C-b
382 @kindex C-c C-b 
383 @findex message-goto-body
384 Move to the beginning of the body of the message
385 (@code{message-goto-body}). 
386
387 @item C-c C-i
388 @kindex C-c C-i 
389 @findex message-goto-signature
390 Move to the signature of the message (@code{message-goto-signature}).
391
392 @end table
393
394
395 @node Insertion
396 @section Insertion
397
398 @table @kbd
399
400 @item C-c C-y
401 @kindex C-c C-y 
402 @findex message-yank-original
403 Yank the message that's being replied to into the message buffer
404 (@code{message-yank-original}). 
405
406 @item C-c C-q
407 @kindex C-c C-q 
408 @findex message-fill-yanked-message
409 Fill the yanked message (@code{message-fill-yanked-message}). 
410
411 @item C-c C-w
412 @kindex C-c C-w 
413 @findex message-insert-signature
414 Insert a signature at the end of the buffer
415 (@code{message-insert-signature}).  
416
417 @end table
418
419 @table @code
420 @item message-ignored-cited-headers
421 @vindex message-ignored-cited-headers
422 All headers that match this regexp will be removed from yanked
423 messages.  The default is @samp{.}, which means that all headers will be
424 removed.
425
426 @item message-citation-line-function
427 @vindex message-citation-line-function
428 Function called to insert the citation line.  The default is
429 @code{message-insert-citation-line}. 
430
431 @item message-yank-prefix
432 @vindex message-yank-prefix
433 @cindex yanking
434 @cindex quoting
435 When you are replying to or following up an article, you normally want
436 to quote the person you are answering.  Inserting quoted text is done by
437 @dfn{yanking}, and each quoted line you yank will have
438 @code{message-yank-prefix} prepended to it.  The default is @samp{> }.
439 If it is @code{nil}, just indent the message.
440
441 @item message-indentation-spaces
442 @vindex message-indentation-spaces
443 Number of spaces to indent yanked messages.
444
445 @item message-cite-function
446 @vindex message-cite-function
447 @findex message-cite-original
448 @findex sc-cite-original
449 @cindex Supercite
450 Function for citing an original message.  The default is
451 @code{message-cite-original}.  You can also set it to
452 @code{sc-cite-original} to use Supercite.
453
454 @item message-indent-citation-function
455 @vindex message-indent-citation-function
456 Function for modifying a citation just inserted in the mail buffer.
457 This can also be a list of functions.  Each function can find the
458 citation between @code{(point)} and @code{(mark t)}.  And each function
459 should leave point and mark around the citation text as modified.
460
461 @item message-signature
462 @vindex message-signature
463 String to be inserted at the end of the message buffer.  If @code{t}
464 (which is the default), the @code{message-signature-file} file will be
465 inserted instead.  If a function, the result from the function will be
466 used instead.  If a form, the result from the form will be used instead.
467 If this variable is @code{nil}, no signature will be inserted at all.
468
469 @item message-signature-file
470 @vindex message-signature-file
471 File containing the signature to be inserted at the end of the buffer.
472 The default is @samp{~/.signature}.
473
474 @end table
475
476 Note that RFC1036 says that a signature should be preceded by the three
477 characters @samp{-- } on a line by themselves.  This is to make it
478 easier for the recipient to automatically recognize and process the
479 signature.  So don't remove those characters, even though you might feel
480 that they ruin your beautiful design, like, totally.
481
482 Also note that no signature should be more than four lines long.
483 Including ASCII graphics is an efficient way to get everybody to believe
484 that you are silly and have nothing important to say.
485
486
487
488 @node Various Commands
489 @section Various Commands
490
491 @table @kbd
492
493 @item C-c C-r
494 @kindex C-c C-r 
495 @findex message-caesar-buffer-body
496 Caesar rotate (aka. rot13) the current message
497 (@code{message-caesar-buffer-body}).  If narrowing is in effect, just
498 rotate the visible portion of the buffer.  A numerical prefix says how
499 many places to rotate the text.  The default is 13.
500
501 @item C-c C-e
502 @kindex C-c C-e
503 @findex message-elide-region
504 Elide the text between point and mark (@code{message-elide-region}).
505 The text is killed and an ellipsis (@samp{[...]}) will be inserted in
506 its place.
507
508 @item C-c C-t
509 @kindex C-c C-t 
510 @findex message-insert-to
511 Insert a @code{To} header that contains the @code{Reply-To} or
512 @code{From} header of the message you're following up
513 (@code{message-insert-to}). 
514
515 @item C-c C-n
516 @kindex C-c C-n 
517 @findex message-insert-newsgroups
518 Insert a @code{Newsgroups} header that reflects the @code{Followup-To}
519 or @code{Newsgroups} header of the article you're replying to
520 (@code{message-insert-newsgroups}).
521
522 @item C-c M-r
523 @kindex C-c M-r
524 @findex message-rename-buffer
525 Rename the buffer (@code{message-rename-buffer}).  If given a prefix,
526 prompt for a new buffer name.
527
528 @end table
529
530
531 @node Sending
532 @section Sending
533
534 @table @kbd
535 @item C-c C-c
536 @kindex C-c C-c 
537 @findex message-send-and-exit
538 Send the message and bury the current buffer
539 (@code{message-send-and-exit}). 
540
541 @item C-c C-s
542 @kindex C-c C-s 
543 @findex message-send
544 Send the message (@code{message-send}). 
545
546 @item C-c C-d
547 @kindex C-c C-d
548 @findex message-dont-send
549 Bury the message buffer and exit (@code{message-dont-send}).
550
551 @item C-c C-k
552 @kindex C-c C-k
553 @findex message-kill-buffer
554 Kill the message buffer and exit (@code{message-kill-buffer}).
555
556 @end table
557
558
559
560 @node Mail Aliases
561 @section Mail Aliases
562 @cindex mail aliases
563 @cindex aliases
564
565 Message uses @code{mailabbrev} to handle mail aliases.  
566 @code{mailabbrev} works by parsing the @file{/etc/mailrc} and
567 @file{~/.mailrc} files.  These files look like:
568
569 @example
570 alias lmi "Lars Magne Ingebrigtsen <larsi@@ifi.uio.no>"
571 alias ding "ding@@ifi.uio.no (ding mailing list)"
572 @end example
573
574 After adding lines like this to your @file{~/.mailrc} file, you should
575 be able to just write @samp{lmi} in the @code{To} or @code{Cc} (and so
576 on) headers and press @kbd{SPC} to expand the alias.
577
578 No expansion will be performed upon sending of the message---all
579 expansions have to be done explicitly.
580
581
582
583 @node Variables
584 @chapter Variables
585
586 @menu
587 * Message Headers::             General message header stuff.
588 * Mail Headers::                Customizing mail headers.
589 * Mail Variables::              Other mail variables.
590 * News Headers::                Customizing news headers.
591 * News Variables::              Other news variables.
592 * Various Message Variables::   Other message variables.
593 * Sending Variables::           Variables for sending.
594 * Message Buffers::             How Message names its buffers.
595 * Message Actions::             Actions to be performed when exiting.
596 @end menu
597
598
599 @node Message Headers
600 @section Message Headers
601
602 Message is quite aggressive on the message generation front.  It has
603 to be -- it's a combined news and mail agent.  To be able to send
604 combined messages, it has to generate all headers itself to ensure that
605 mail and news copies of messages look sufficiently similar.
606
607 @table @code
608
609 @item message-generate-headers-first
610 @vindex message-generate-headers-first
611 If non-@code{nil}, generate all headers before starting to compose the
612 message.  
613
614 @item message-from-style
615 @vindex message-from-style
616 Specifies how @code{From} headers should look.  There are four legal
617 values:
618
619 @table @code
620 @item nil
621 Just the address -- @samp{king@@grassland.com}.
622
623 @item parens
624 @samp{king@@grassland.com (Elvis Parsley)}.
625
626 @item angles
627 @samp{Elvis Parsley <king@@grassland.com>}.
628
629 @item default
630 Look like @code{angles} if that doesn't require quoting, and
631 @code{parens} if it does.  If even @code{parens} requires quoting, use
632 @code{angles} anyway.
633
634 @end table
635
636 @item message-deletable-headers
637 @vindex message-deletable-headers
638 Headers in this list that were previously generated by Message will be
639 deleted before posting.  Let's say you post an article.  Then you decide
640 to post it again to some other group, you naughty boy, so you jump back
641 to the @code{*post-buf*} buffer, edit the @code{Newsgroups} line, and
642 ship it off again.  By default, this variable makes sure that the old
643 generated @code{Message-ID} is deleted, and a new one generated.  If
644 this isn't done, the entire empire would probably crumble, anarchy would
645 prevail, and cats would start walking on two legs and rule the world.
646 Allegedly.  
647
648 @item message-default-headers
649 @vindex message-default-headers
650 This string is inserted at the end of the headers in all message
651 buffers.
652
653 @end table
654
655
656 @node Mail Headers
657 @section Mail Headers
658
659 @table @code
660 @item message-required-mail-headers
661 @vindex message-required-mail-headers
662 @xref{News Headers}, for the syntax of this variable.  It is
663 @code{(From Date Subject (optional . In-Reply-To) Message-ID Lines
664 (optional . X-Mailer))} by default.
665
666 @item message-ignored-mail-headers
667 @vindex message-ignored-mail-headers
668 Regexp of headers to be removed before mailing.  The default is
669 @samp{^Gcc:\\|^Fcc:}. 
670
671 @item message-default-mail-headers
672 @vindex message-default-mail-headers
673 This string is inserted at the end of the headers in all message
674 buffers that are initialized as mail.
675
676 @end table
677
678
679 @node Mail Variables
680 @section Mail Variables 
681
682 @table @code
683 @item message-send-mail-function
684 @vindex message-send-mail-function
685 Function used to send the current buffer as mail.  The default is
686 @code{message-send-mail-with-sendmail}.   If you prefer using MH
687 instead, set this variable to @code{message-send-mail-with-mh}.
688
689 @end table
690
691
692 @node News Headers
693 @section News Headers
694
695 @vindex message-required-news-headers
696 @code{message-required-news-headers} a list of header symbols.  These
697 headers will either be automatically generated, or, if that's
698 impossible, they will be prompted for.  The following symbols are legal:
699
700 @table @code
701
702 @item From
703 @cindex From
704 @findex user-full-name
705 @findex user-mail-address
706 This required header will be filled out with the result of the
707 @code{message-make-from} function, which depends on the
708 @code{message-from-style}, @code{user-full-name},
709 @code{user-mail-address} variables.
710
711 @item Subject
712 @cindex Subject
713 This required header will be prompted for if not present already. 
714
715 @item Newsgroups
716 @cindex Newsgroups
717 This required header says which newsgroups the article is to be posted
718 to.  If it isn't present already, it will be prompted for.
719
720 @item Organization
721 @cindex organization
722 This optional header will be filled out depending on the
723 @code{message-user-organization} variable.
724 @code{message-user-organization-file} will be used if this variable is
725 @code{t}.  This variable can also be a string (in which case this string
726 will be used), or it can be a function (which will be called with no
727 parameters and should return a string to be used).
728
729 @item Lines
730 @cindex Lines
731 This optional header will be computed by Message.
732
733 @item Message-ID
734 @cindex Message-ID
735 @vindex mail-host-address
736 @findex system-name
737 @cindex Sun
738 This required header will be generated by Message.  A unique ID will be
739 created based on the date, time, user name and system name.  Message will
740 use @code{mail-host-address} as the fully qualified domain name (FQDN)
741 of the machine if that variable is defined.  If not, it will use
742 @code{system-name}, which doesn't report a FQDN on some machines --
743 notably Suns.
744
745 @item X-Newsreader
746 @cindex X-Newsreader
747 This optional header will be filled out according to the
748 @code{message-newsreader} local variable.
749
750 @item X-Mailer
751 This optional header will be filled out according to the
752 @code{message-mailer} local variable, unless there already is an
753 @code{X-Newsreader} header present.
754
755 @item In-Reply-To
756 This optional header is filled out using the @code{Date} and @code{From}
757 header of the article being replied to.
758
759 @item Expires
760 @cindex Expires
761 This extremely optional header will be inserted according to the
762 @code{message-expires} variable.  It is highly deprecated and shouldn't
763 be used unless you know what you're doing.
764
765 @item Distribution
766 @cindex Distribution
767 This optional header is filled out according to the
768 @code{message-distribution-function} variable.  It is a deprecated and
769 much misunderstood header.
770
771 @item Path
772 @cindex path
773 This extremely optional header should probably never be used.
774 However, some @emph{very} old servers require that this header is
775 present.  @code{message-user-path} further controls how this
776 @code{Path} header is to look.  If it is @code{nil}, use the server name
777 as the leaf node.  If it is a string, use the string.  If it is neither
778 a string nor @code{nil}, use the user name only.  However, it is highly
779 unlikely that you should need to fiddle with this variable at all.
780 @end table
781
782 @findex yow
783 @cindex Mime-Version
784 In addition, you can enter conses into this list.  The car of this cons
785 should be a symbol.  This symbol's name is the name of the header, and
786 the cdr can either be a string to be entered verbatim as the value of
787 this header, or it can be a function to be called.  This function should
788 return a string to be inserted.  For instance, if you want to insert
789 @code{Mime-Version: 1.0}, you should enter @code{(Mime-Version . "1.0")}
790 into the list.  If you want to insert a funny quote, you could enter
791 something like @code{(X-Yow . yow)} into the list.  The function
792 @code{yow} will then be called without any arguments.
793
794 If the list contains a cons where the car of the cons is
795 @code{optional}, the cdr of this cons will only be inserted if it is
796 non-@code{nil}.
797
798 Other variables for customizing outgoing news articles:
799
800 @table @code
801
802 @item message-syntax-checks
803 @vindex message-syntax-checks
804 If non-@code{nil}, Message will attempt to check the legality of the
805 headers, as well as some other stuff, before posting.  You can control
806 the granularity of the check by adding or removing elements from this
807 list.  Legal elements are:
808
809 @table @code
810 @item subject-cmsg 
811 Check the subject for commands.
812 @item sender
813 @cindex Sender
814 Insert a new @code{Sender} header if the @code{From} header looks odd. 
815 @item multiple-headers 
816 Check for the existence of multiple equal headers.
817 @item sendsys 
818 @cindex sendsys
819 Check for the existence of version and sendsys commands.
820 @item message-id
821 Check whether the @code{Message-ID} looks ok.
822 @item from
823 Check whether the @code{From} header seems nice.
824 @item long-lines 
825 @cindex long lines
826 Check for too long lines.
827 @item control-chars
828 Check for illegal characters.
829 @item size
830 Check for excessive size.
831 @item new-text
832 Check whether there is any new text in the messages.
833 @item signature
834 Check the length of the signature.
835 @item approved
836 @cindex approved
837 Check whether the article has an @code{Approved} header, which is
838 something only moderators should include.
839 @item empty
840 Check whether the article is empty.
841 @item empty-headers
842 Check whether any of the headers are empty.
843 @item existing-newsgroups
844 Check whether the newsgroups mentioned in the @code{Newsgroups} and 
845 @code{Followup-To} headers exist.
846 @item valid-newsgroups
847 Check whether the @code{Newsgroups} and @code{Followup-to} headers
848 are valid syntactically.
849 @item shorten-followup-to
850 Check whether to add a @code{Followup-to} header to shorten the number
851 of groups to post to.
852 @end table
853
854 All these conditions are checked by default.
855
856 @item message-ignored-news-headers
857 @vindex message-ignored-news-headers
858 Regexp of headers to be removed before posting.  The default is@*
859 @samp{^NNTP-Posting-Host:\\|^Xref:\\|^Bcc:\\|^Gcc:\\|^Fcc:}.
860
861 @item message-default-news-headers
862 @vindex message-default-news-headers
863 This string is inserted at the end of the headers in all message
864 buffers that are initialized as news.
865
866 @end table
867
868
869 @node News Variables
870 @section News Variables
871
872 @table @code
873 @item message-send-news-function
874 @vindex message-send-news-function
875 Function used to send the current buffer as news.  The default is
876 @code{message-send-news}. 
877
878 @item message-post-method
879 @vindex message-post-method
880 Method used for posting a prepared news message.
881
882 @end table
883
884
885 @node Various Message Variables
886 @section Various Message Variables
887
888 @table @code
889 @item message-signature-separator
890 @vindex message-signature-separator
891 Regexp matching the signature separator.  It is @samp{^-- *$} by
892 default. 
893
894 @item mail-header-separator
895 @vindex mail-header-separator
896 String used to separate the headers from the body.  It is @samp{--text
897 follows this line--} by default.
898
899 @item message-directory
900 @vindex message-directory
901 Directory used by many mailey things.  The default is @file{~/Mail/}. 
902
903 @item message-autosave-directory
904 @vindex message-autosave-directory
905 Directory where message buffers will be autosaved to.
906
907 @item message-signature-setup-hook
908 @vindex message-signature-setup-hook
909 Hook run when initializing the message buffer.  It is run after the
910 headers have been inserted but before the signature has been inserted. 
911
912 @item message-setup-hook
913 @vindex message-setup-hook
914 Hook run as the last thing when the message buffer has been initialized.
915
916 @item message-header-setup-hook
917 @vindex message-header-setup-hook
918 Hook called narrowed to the headers after initializing the headers. 
919
920 @item message-send-hook
921 @vindex message-send-hook
922 Hook run before sending messages.
923
924 @item message-send-mail-hook
925 @vindex message-send-mail-hook
926 Hook run before sending mail messages.
927
928 @item message-send-news-hook
929 @vindex message-send-news-hook
930 Hook run before sending news messages.
931
932 @item message-sent-hook
933 @vindex message-sent-hook
934 Hook run after sending messages.
935
936 @item message-mode-syntax-table
937 @vindex message-mode-syntax-table
938 Syntax table used in message mode buffers.
939
940 @end table
941
942
943
944 @node Sending Variables
945 @section Sending Variables
946
947 @table @code
948
949 @item message-fcc-handler-function 
950 @vindex message-fcc-handler-function 
951 A function called to save outgoing articles.  This function will be
952 called with the name of the file to store the article in. The default
953 function is @code{rmail-output} which saves in Unix mailbox format.
954
955 @item message-courtesy-message
956 @vindex message-courtesy-message
957 When sending combined messages, this string is inserted at the start of
958 the mailed copy.  If the string contains the format spec @samp{%s}, the
959 newsgroups the article has been posted to will be inserted there.  If
960 this variable is @code{nil}, no such courtesy message will be added.
961 The default value is @samp{"The following message is a courtesy copy of
962 an article\nthat has been posted to %s as well.\n\n"}. 
963
964 @end table
965
966
967 @node Message Buffers
968 @section Message Buffers
969
970 Message will generate new buffers with unique buffer names when you
971 request a message buffer.  When you send the message, the buffer isn't
972 normally killed off.  Its name is changed and a certain number of old
973 message buffers are kept alive.
974
975 @table @code
976 @item message-generate-new-buffers
977 @vindex message-generate-new-buffers
978 If non-@code{nil}, generate new buffers.  The default is @code{t}.  If
979 this is a function, call that function with three parameters: The type,
980 the to address and the group name.  (Any of these may be @code{nil}.)
981 The function should return the new buffer name.
982
983 @item message-max-buffers
984 @vindex message-max-buffers
985 This variable says how many old message buffers to keep.  If there are
986 more message buffers than this, the oldest buffer will be killed.  The
987 default is 10.  If this variable is @code{nil}, no old message buffers
988 will ever be killed.
989
990 @item message-send-rename-function
991 @vindex message-send-rename-function
992 After sending a message, the buffer is renamed from, for instance,
993 @samp{*reply to Lars*} to @samp{*sent reply to Lars*}.  If you don't
994 like this, set this variable to a function that renames the buffer in a
995 manner you like.  If you don't want to rename the buffer at all, you can
996 say:
997
998 @lisp
999 (setq message-send-rename-function 'ignore)
1000 @end lisp
1001
1002 @item message-kill-buffer-on-exit
1003 @findex message-kill-buffer-on-exit
1004 If non-@code{nil}, kill the buffer immediately on exit.
1005
1006 @end table
1007
1008
1009 @node Message Actions
1010 @section Message Actions
1011
1012 When Message is being used from a news/mail reader, the reader is likely
1013 to want to perform some task after the message has been sent.  Perhaps
1014 return to the previous window configuration or mark an article as
1015 replied.  
1016
1017 @vindex message-kill-actions
1018 @vindex message-postpone-actions
1019 @vindex message-exit-actions
1020 @vindex message-send-actions
1021 The user may exit from the message buffer in various ways.  The most
1022 common is @kbd{C-c C-c}, which sends the message and exits.  Other
1023 possibilities are @kbd{C-c C-s} which just sends the message, @kbd{C-c
1024 C-d} which postpones the message editing and buries the message buffer,
1025 and @kbd{C-c C-k} which kills the message buffer.  Each of these actions
1026 have lists associated with them that contains actions to be executed:
1027 @code{message-send-actions}, @code{message-exit-actions},
1028 @code{message-postpone-actions}, and @code{message-kill-actions}.  
1029
1030 Message provides a function to interface with these lists:
1031 @code{message-add-action}.  The first parameter is the action to be
1032 added, and the rest of the arguments are which lists to add this action
1033 to.  Here's an example from Gnus:
1034
1035 @lisp
1036   (message-add-action
1037    `(set-window-configuration ,(current-window-configuration))
1038    'exit 'postpone 'kill)
1039 @end lisp
1040
1041 This restores the Gnus window configuration when the message buffer is
1042 killed, postponed or exited.
1043
1044 An @dfn{action} can be either: a normal function, or a list where the
1045 @code{car} is a function and the @code{cdr} is the list of arguments, or
1046 a form to be @code{eval}ed.
1047
1048 @node Index
1049 @chapter Index
1050 @printindex cp
1051
1052 @node Key Index
1053 @chapter Key Index
1054 @printindex ky
1055
1056 @summarycontents
1057 @contents
1058 @bye
1059
1060 @c End: