*** empty log message ***
[gnus] / texi / message.texi
1 \input texinfo                  @c -*-texinfo-*-
2
3 @setfilename message
4 @settitle Message 0.18 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 Message, 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 0.18 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 from Gnus (both mail and news) takes place in
71 Message mode 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 * Compatibility::     Making Message backwards compatible.
78 * Appendices::        More technical things.
79 * Index::             Variable, function and concept index.
80 * Key Index::         List of Message mode keys.
81 @end menu
82
83 This manual corresponds to Message 0.18.  Message is distributed with
84 the Gnus distribution bearing the same version number as this manual
85 has. 
86
87
88 @node Interface
89 @chapter Interface
90
91 When a program (or a person) wants to respond to a message -- reply,
92 follow up, forward, cancel -- the program (or person) should just put
93 point in the buffer where the message is and call the required command.
94 @code{Message} will then pop up a new @code{message} mode buffer with
95 appropriate headers filled out, and the user can edit the message before
96 sending it.
97
98 @menu
99 * New Mail Message::     Editing a brand new mail message.
100 * New News Message::     Editing a brand new news message.
101 * Reply::                Replying via mail.
102 * Wide Reply::           Responding to all people via mail.
103 * Followup::             Following up via news.
104 * Canceling News::       Canceling a news article.
105 * Superseding::          Superseding a message.
106 * Forwarding::           Forwarding a message via news or mail.
107 * Resending::            Resending a mail message.
108 * Bouncing::             Bouncing a mail message.
109 @end menu
110
111
112 @node New Mail Message
113 @section New Mail Message
114
115 @findex message-mail
116 The @code{message-mail} command pops up a new message buffer.  
117
118 Two optional parameters are accepted: The first will be used as the
119 @code{To} header and the second as the @code{Subject} header.  If these
120 are @code{nil}, those two headers will be empty.
121
122
123 @node New News Message
124 @section New News Message
125
126 @findex message-news
127 The @code{message-news} command pops up a new message buffer.  
128
129 This function accepts two optional parameters.  The first will be used
130 as the @code{Newsgroups} header and the second as the @code{Subject}
131 header.  If these are @code{nil}, those two headers will be empty.
132
133
134 @node Reply
135 @section Reply
136
137 @findex message-reply
138 The @code{message-reply} function pops up a message buffer that's a
139 reply to the message in the current buffer.
140
141 @vindex message-reply-to-function
142 Message uses the normal methods to determine where replies are to go
143 (@pxref{Responses}), but you can change the behavior to suit your needs
144 by fiddling with the @code{message-reply-to-function} variable.
145
146 If you want the replies to go to the @code{Sender} instead of the
147 @code{From}, you could do something like this:
148
149 @lisp
150 (setq message-reply-to-function
151       (lambda ()
152        (cond ((equal (mail-fetch-field "from") "somebody")
153                (mail-fetch-field "sender"))     
154              (t 
155               nil))))
156 @end lisp
157
158 This function will be called narrowed to the head of the article that is
159 being replied to.
160
161 As you can see, this function should return a string if it has an
162 opinion as to what the To header should be.  If it does not, it should
163 just return @code{nil}, and the normal methods for determining the To
164 header will be used.
165
166 This function can also return a list.  In that case, each list element
167 should be a cons, where the car should be the name of an header
168 (eg. @code{Cc}) and the cdr should be the header value
169 (eg. @samp{larsi@@ifi.uio.no}).  All these headers will be inserted into
170 the head of the outgoing mail. 
171
172
173 @node Wide Reply
174 @section Wide Reply
175
176 @findex message-wide-reply
177 The @code{message-wide-reply} pops up a message buffer that's a wide
178 reply to the message in the current buffer.  A @dfn{wide reply} is a
179 reply that goes out to all people listed in the @code{To}, @code{From}
180 (or @code{Reply-to}) and @code{Cc} headers.
181
182 @vindex message-wide-reply-to-function
183 Message uses the normal methods to determine where wide replies are to go,
184 but you can change the behavior to suit your needs by fiddling with the
185 @code{message-wide-reply-to-function}.  It is used in the same way as
186 @code{message-reply-to-function} (@pxref{Reply}). 
187
188 @findex rmail-dont-reply-to-names
189 Addresses that match the @code{rmail-dont-reply-to-names} regular
190 expression will be removed from the @code{Cc} header.
191
192
193 @node Followup
194 @section Followup
195
196 @findex message-followup
197 The @code{message-followup} command pops up a message buffer that's a
198 followup to the message in the current buffer.
199
200 @vindex message-followup-to-function
201 Message uses the normal methods to determine where followups are to go,
202 but you can change the behavior to suit your needs by fiddling with the
203 @code{message-followup-to-function}.  It is used in the same way as
204 @code{message-reply-to-function} (@pxref{Reply}).
205
206 @vindex message-use-followup-to
207 The @code{message-use-followup-to} variable says what to do about
208 @code{Followup-To} headers.  If it is @code{use}, always use the value.
209 If it is @code{ask} (which is the default), ask whether to use the
210 value.  If it is @code{t}, use the value unless it is @samp{poster}.  If
211 it is @code{nil}, don't use the value.
212
213
214 @node Canceling News
215 @section Canceling News
216
217 @findex message-cancel-news
218 The @code{message-cancel-news} command cancels the article in the
219 current buffer.
220
221
222 @node Superseding
223 @section Superseding
224
225 @findex message-supersede
226 The @code{message-supersede} command pops up a message buffer that will
227 supersede the message in the current buffer.
228
229 @vindex message-ignored-supersedes-headers
230 Headers matching the @code{message-ignored-supersedes-headers} are
231 removed before popping up the new message buffer.  The default is@*
232 @samp{^Path:\\|^Date\\|^NNTP-Posting-Host:\\|^Xref:\\|^Lines:\\|@*
233 ^Received:\\|^X-From-Line:\\|Return-Path:\\|^Supersedes:}.
234
235
236
237 @node Forwarding
238 @section Forwarding
239
240 @findex message-forward
241 The @code{message-forward} command pops up a message buffer to forward
242 the message in the current buffer.  If given a prefix, forward using
243 news.
244
245 @table @code
246 @item message-forward-start-separator
247 @vindex message-forward-start-separator
248 Delimiter inserted before forwarded messages.  The default is@*
249 @samp{------- Start of forwarded message -------\n}. 
250
251 @vindex message-forward-end-separator
252 @item message-forward-end-separator
253 @vindex message-forward-end-separator
254 Delimiter inserted after forwarded messages.  The default is@*
255 @samp{------- End of forwarded message -------\n}. 
256
257 @item message-signature-before-forwarded-message
258 @vindex message-signature-before-forwarded-message
259 If this variable is @code{t}, which it is by default, your personal
260 signature will be inserted before the forwarded message.  If not, the
261 forwarded message will be inserted first in the new mail.
262
263 @item message-included-forward-headers
264 @vindex message-included-forward-headers
265 Regexp matching header lines to be included in forwarded messages.  
266
267 @end table
268
269
270 @node Resending
271 @section Resending
272
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.
276
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}. 
281
282
283 @node Bouncing
284 @section Bouncing
285
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. 
292
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\\):}.
297
298
299 @node Commands
300 @chapter Commands
301
302 @menu
303 * Header Commands::     Commands for moving to headers.
304 * Movement::            Moving around in message buffers.
305 * Insertion::           Inserting things into message buffers.
306 * Various Commands::    Various things.
307 * Sending::             Actually sending the message.
308 * Mail Aliases::        How to use mail aliases.
309 @end menu
310
311
312 @node Header Commands
313 @section Header Commands
314
315 All these commands move to the header in question.  If it doesn't exist,
316 it will be inserted.
317
318 @table @kbd
319
320 @item C-c ?
321 @kindex C-c ?
322 @findex message-goto-to
323 Describe the message mode.
324
325 @item C-c C-f C-t
326 @kindex C-c C-f C-t 
327 @findex message-goto-to
328 Go to the @code{To} header (@code{message-goto-to}).
329
330 @item C-c C-f C-b
331 @kindex C-c C-f C-b 
332 @findex message-goto-bcc
333 Go to the @code{Bcc} header (@code{message-goto-bcc}).
334
335 @item C-c C-f C-f
336 @kindex C-c C-f C-f 
337 @findex message-goto-fcc
338 Go to the @code{Fcc} header (@code{message-goto-fcc}).
339
340 @item C-c C-f C-c
341 @kindex C-c C-f C-c 
342 @findex message-goto-cc
343 Go to the @code{Cc} header (@code{message-goto-cc}).
344
345 @item C-c C-f C-s
346 @kindex C-c C-f C-s 
347 @findex message-goto-subject
348 Go to the @code{Subject} header (@code{message-goto-subject}).
349
350 @item C-c C-f C-r
351 @kindex C-c C-f C-r 
352 @findex message-goto-reply-to
353 Go to the @code{Reply-To} header (@code{message-goto-reply-to}).
354
355 @item C-c C-f C-n
356 @kindex C-c C-f C-n 
357 @findex message-goto-newsgroups
358 Go to the @code{Newsgroups} header (@code{message-goto-newsgroups}).
359
360 @item C-c C-f C-d
361 @kindex C-c C-f C-d 
362 @findex message-goto-distribution
363 Go to the @code{Distribution} header (@code{message-goto-distribution}).
364
365 @item C-c C-f C-o
366 @kindex C-c C-f C-o 
367 @findex message-goto-followup-to
368 Go to the @code{Followup-To} header (@code{message-goto-followup-to}).
369
370 @item C-c C-f C-k
371 @kindex C-c C-f C-k 
372 @findex message-goto-keywords
373 Go to the @code{Keywords} header (@code{message-goto-keywords}).
374
375 @item C-c C-f C-u
376 @kindex C-c C-f C-u 
377 @findex message-goto-summary
378 Go to the @code{Summary} header (@code{message-goto-summary}).
379
380 @end table
381
382
383 @node Movement
384 @section Movement
385
386 @table @kbd
387 @item C-c C-b
388 @kindex C-c C-b 
389 @findex message-goto-body
390 Move to the beginning of the body of the message
391 (@code{message-goto-body}). 
392
393 @item C-c C-i
394 @kindex C-c C-i 
395 @findex message-goto-signature
396 Move to the signature of the message (@code{message-goto-signature}).
397
398 @end table
399
400
401 @node Insertion
402 @section Insertion
403
404 @table @kbd
405
406 @item C-c C-y
407 @kindex C-c C-y 
408 @findex message-yank-original
409 Yank the message that's being replied to into the message buffer
410 (@code{message-yank-original}). 
411
412 @item C-c C-q
413 @kindex C-c C-q 
414 @findex message-fill-yanked-message
415 Fill the yanked message (@code{message-fill-yanked-message}).  Warning:
416 Can severely mess up the yanked text if its quoting conventions are
417 strange.  You'll quickly get a feel for when it's safe, though.  Anyway,
418 just remember that @kbd{C-x u} (@code{undo}) is available and you'll be
419 all right.
420
421
422 @item C-c C-w
423 @kindex C-c C-w 
424 @findex message-insert-signature
425 Insert a signature at the end of the buffer
426 (@code{message-insert-signature}).  
427
428 @end table
429
430 @table @code
431 @item message-ignored-cited-headers
432 @vindex message-ignored-cited-headers
433 All headers that match this regexp will be removed from yanked
434 messages.  The default is @samp{.}, which means that all headers will be
435 removed.
436
437 @item message-citation-line-function
438 @vindex message-citation-line-function
439 Function called to insert the citation line.  The default is
440 @code{message-insert-citation-line}, which will lead to citation lines
441 that look like:
442
443 @example
444 Hallvard B Furuseth <h.b.furuseth@@usit.uio.no> writes:
445 @end example
446
447 Point will be at the beginning of the body of the message when this
448 function is called.
449
450 @item message-yank-prefix
451 @vindex message-yank-prefix
452 @cindex yanking
453 @cindex quoting
454 When you are replying to or following up an article, you normally want
455 to quote the person you are answering.  Inserting quoted text is done by
456 @dfn{yanking}, and each quoted line you yank will have
457 @code{message-yank-prefix} prepended to it.  The default is @samp{> }.
458 If it is @code{nil}, just indent the message.
459
460 @item message-indentation-spaces
461 @vindex message-indentation-spaces
462 Number of spaces to indent yanked messages.
463
464 @item message-cite-function
465 @vindex message-cite-function
466 @findex message-cite-original
467 @findex sc-cite-original
468 @cindex Supercite
469 Function for citing an original message.  The default is
470 @code{message-cite-original}, which simply inserts the original message
471 and prepends @samp{> } to each line.  You can also set it to
472 @code{sc-cite-original} to use Supercite.
473
474 @item message-indent-citation-function
475 @vindex message-indent-citation-function
476 Function for modifying a citation just inserted in the mail buffer.
477 This can also be a list of functions.  Each function can find the
478 citation between @code{(point)} and @code{(mark t)}.  And each function
479 should leave point and mark around the citation text as modified.
480
481 @item message-signature
482 @vindex message-signature
483 String to be inserted at the end of the message buffer.  If @code{t}
484 (which is the default), the @code{message-signature-file} file will be
485 inserted instead.  If a function, the result from the function will be
486 used instead.  If a form, the result from the form will be used instead.
487 If this variable is @code{nil}, no signature will be inserted at all.
488
489 @item message-signature-file
490 @vindex message-signature-file
491 File containing the signature to be inserted at the end of the buffer.
492 The default is @samp{~/.signature}.
493
494 @end table
495
496 Note that RFC1036bis says that a signature should be preceded by the three
497 characters @samp{-- } on a line by themselves.  This is to make it
498 easier for the recipient to automatically recognize and process the
499 signature.  So don't remove those characters, even though you might feel
500 that they ruin your beautiful design, like, totally.
501
502 Also note that no signature should be more than four lines long.
503 Including ASCII graphics is an efficient way to get everybody to believe
504 that you are silly and have nothing important to say.
505
506
507
508 @node Various Commands
509 @section Various Commands
510
511 @table @kbd
512
513 @item C-c C-r
514 @kindex C-c C-r 
515 @findex message-caesar-buffer-body
516 Caesar rotate (aka. rot13) the current message
517 (@code{message-caesar-buffer-body}).  If narrowing is in effect, just
518 rotate the visible portion of the buffer.  A numerical prefix says how
519 many places to rotate the text.  The default is 13.
520
521 @item C-c C-e
522 @kindex C-c C-e
523 @findex message-elide-region
524 Elide the text between point and mark (@code{message-elide-region}).
525 The text is killed and an ellipsis (@samp{[...]}) will be inserted in
526 its place.
527
528 @item C-c C-v
529 @kindex C-c C-v
530 @findex message-delete-not-region
531 Delete all text in the body of the message that is outside the region
532 (@code{message-delete-not-region}).
533
534 @item M-RET
535 @kindex M-RET
536 @kindex message-newline-and-reformat
537 Insert four newlines, and then reformat if inside quoted text.
538
539 Here's an example:
540
541 @example
542 > This is some quoted text.  And here's more quoted text.
543 @end example
544
545 If point is before @samp{And} and you press @kbd{M-RET}, you'll get:
546
547 @example
548 > This is some quoted text.
549
550 *
551
552 > And here's more quoted text.
553 @end example
554
555 @samp{*} says where point will be placed.  
556
557 @item C-c C-t
558 @kindex C-c C-t 
559 @findex message-insert-to
560 Insert a @code{To} header that contains the @code{Reply-To} or
561 @code{From} header of the message you're following up
562 (@code{message-insert-to}). 
563
564 @item C-c C-n
565 @kindex C-c C-n 
566 @findex message-insert-newsgroups
567 Insert a @code{Newsgroups} header that reflects the @code{Followup-To}
568 or @code{Newsgroups} header of the article you're replying to
569 (@code{message-insert-newsgroups}).
570
571 @item C-c M-r
572 @kindex C-c M-r
573 @findex message-rename-buffer
574 Rename the buffer (@code{message-rename-buffer}).  If given a prefix,
575 prompt for a new buffer name.
576
577 @end table
578
579
580 @node Sending
581 @section Sending
582
583 @table @kbd
584 @item C-c C-c
585 @kindex C-c C-c 
586 @findex message-send-and-exit
587 Send the message and bury the current buffer
588 (@code{message-send-and-exit}). 
589
590 @item C-c C-s
591 @kindex C-c C-s 
592 @findex message-send
593 Send the message (@code{message-send}). 
594
595 @item C-c C-d
596 @kindex C-c C-d
597 @findex message-dont-send
598 Bury the message buffer and exit (@code{message-dont-send}).
599
600 @item C-c C-k
601 @kindex C-c C-k
602 @findex message-kill-buffer
603 Kill the message buffer and exit (@code{message-kill-buffer}).
604
605 @end table
606
607
608
609 @node Mail Aliases
610 @section Mail Aliases
611 @cindex mail aliases
612 @cindex aliases
613
614 @vindex message-mail-alias-type
615 The @code{message-mail-alias-type} variable controls what type of mail
616 alias expansion to use.  Currently only one form is supported---Message
617 uses @code{mailabbrev} to handle mail aliases.  If this variable is
618 @code{nil}, no mail alias expansion will be performed.
619
620 @code{mailabbrev} works by parsing the @file{/etc/mailrc} and
621 @file{~/.mailrc} files.  These files look like:
622
623 @example
624 alias lmi "Lars Magne Ingebrigtsen <larsi@@ifi.uio.no>"
625 alias ding "ding@@ifi.uio.no (ding mailing list)"
626 @end example
627
628 After adding lines like this to your @file{~/.mailrc} file, you should
629 be able to just write @samp{lmi} in the @code{To} or @code{Cc} (and so
630 on) headers and press @kbd{SPC} to expand the alias.
631
632 No expansion will be performed upon sending of the message---all
633 expansions have to be done explicitly.
634
635
636
637 @node Variables
638 @chapter Variables
639
640 @menu
641 * Message Headers::             General message header stuff.
642 * Mail Headers::                Customizing mail headers.
643 * Mail Variables::              Other mail variables.
644 * News Headers::                Customizing news headers.
645 * News Variables::              Other news variables.
646 * Various Message Variables::   Other message variables.
647 * Sending Variables::           Variables for sending.
648 * Message Buffers::             How Message names its buffers.
649 * Message Actions::             Actions to be performed when exiting.
650 @end menu
651
652
653 @node Message Headers
654 @section Message Headers
655
656 Message is quite aggressive on the message generation front.  It has to
657 be -- it's a combined news and mail agent.  To be able to send combined
658 messages, it has to generate all headers itself (instead of letting the
659 mail/news system do it) to ensure that mail and news copies of messages
660 look sufficiently similar.
661
662 @table @code
663
664 @item message-generate-headers-first
665 @vindex message-generate-headers-first
666 If non-@code{nil}, generate all headers before starting to compose the
667 message.  
668
669 @item message-from-style
670 @vindex message-from-style
671 Specifies how @code{From} headers should look.  There are four legal
672 values:
673
674 @table @code
675 @item nil
676 Just the address -- @samp{king@@grassland.com}.
677
678 @item parens
679 @samp{king@@grassland.com (Elvis Parsley)}.
680
681 @item angles
682 @samp{Elvis Parsley <king@@grassland.com>}.
683
684 @item default
685 Look like @code{angles} if that doesn't require quoting, and
686 @code{parens} if it does.  If even @code{parens} requires quoting, use
687 @code{angles} anyway.
688
689 @end table
690
691 @item message-deletable-headers
692 @vindex message-deletable-headers
693 Headers in this list that were previously generated by Message will be
694 deleted before posting.  Let's say you post an article.  Then you decide
695 to post it again to some other group, you naughty boy, so you jump back
696 to the @code{*post-buf*} buffer, edit the @code{Newsgroups} line, and
697 ship it off again.  By default, this variable makes sure that the old
698 generated @code{Message-ID} is deleted, and a new one generated.  If
699 this isn't done, the entire empire would probably crumble, anarchy would
700 prevail, and cats would start walking on two legs and rule the world.
701 Allegedly.  
702
703 @item message-default-headers
704 @vindex message-default-headers
705 This string is inserted at the end of the headers in all message
706 buffers.
707
708 @end table
709
710
711 @node Mail Headers
712 @section Mail Headers
713
714 @table @code
715 @item message-required-mail-headers
716 @vindex message-required-mail-headers
717 @xref{News Headers}, for the syntax of this variable.  It is
718 @code{(From Date Subject (optional . In-Reply-To) Message-ID Lines
719 (optional . X-Mailer))} by default.
720
721 @item message-ignored-mail-headers
722 @vindex message-ignored-mail-headers
723 Regexp of headers to be removed before mailing.  The default is
724 @samp{^[GF]cc:\\|^Resent-Fcc:}.
725
726 @item message-default-mail-headers
727 @vindex message-default-mail-headers
728 This string is inserted at the end of the headers in all message
729 buffers that are initialized as mail.
730
731 @end table
732
733
734 @node Mail Variables
735 @section Mail Variables 
736
737 @table @code
738 @item message-send-mail-function
739 @vindex message-send-mail-function
740 Function used to send the current buffer as mail.  The default is
741 @code{message-send-mail-with-sendmail}.   If you prefer using MH
742 instead, set this variable to @code{message-send-mail-with-mh}.
743
744 @item message-mh-deletable-headers
745 @vindex message-mh-deletable-headers
746 Most versions of MH doesn't like being fed messages that contain the
747 headers in this variable.  If this variable is non-@code{nil} (which is
748 the default), these headers will be removed before mailing when sending
749 messages via MH.  Set it to @code{nil} if your MH can handle these
750 headers.
751
752 @end table
753
754
755 @node News Headers
756 @section News Headers
757
758 @vindex message-required-news-headers
759 @code{message-required-news-headers} a list of header symbols.  These
760 headers will either be automatically generated, or, if that's
761 impossible, they will be prompted for.  The following symbols are legal:
762
763 @table @code
764
765 @item From
766 @cindex From
767 @findex user-full-name
768 @findex user-mail-address
769 This required header will be filled out with the result of the
770 @code{message-make-from} function, which depends on the
771 @code{message-from-style}, @code{user-full-name},
772 @code{user-mail-address} variables.
773
774 @item Subject
775 @cindex Subject
776 This required header will be prompted for if not present already. 
777
778 @item Newsgroups
779 @cindex Newsgroups
780 This required header says which newsgroups the article is to be posted
781 to.  If it isn't present already, it will be prompted for.
782
783 @item Organization
784 @cindex organization
785 This optional header will be filled out depending on the
786 @code{message-user-organization} variable.
787 @code{message-user-organization-file} will be used if this variable is
788 @code{t}.  This variable can also be a string (in which case this string
789 will be used), or it can be a function (which will be called with no
790 parameters and should return a string to be used).
791
792 @item Lines
793 @cindex Lines
794 This optional header will be computed by Message.
795
796 @item Message-ID
797 @cindex Message-ID
798 @vindex mail-host-address
799 @findex system-name
800 @cindex Sun
801 This required header will be generated by Message.  A unique ID will be
802 created based on the date, time, user name and system name.  Message will
803 use @code{mail-host-address} as the fully qualified domain name (FQDN)
804 of the machine if that variable is defined.  If not, it will use
805 @code{system-name}, which doesn't report a FQDN on some machines --
806 notably Suns.
807
808 @item X-Newsreader
809 @cindex X-Newsreader
810 This optional header will be filled out according to the
811 @code{message-newsreader} local variable.
812
813 @item X-Mailer
814 This optional header will be filled out according to the
815 @code{message-mailer} local variable, unless there already is an
816 @code{X-Newsreader} header present.
817
818 @item In-Reply-To
819 This optional header is filled out using the @code{Date} and @code{From}
820 header of the article being replied to.
821
822 @item Expires
823 @cindex Expires
824 This extremely optional header will be inserted according to the
825 @code{message-expires} variable.  It is highly deprecated and shouldn't
826 be used unless you know what you're doing.
827
828 @item Distribution
829 @cindex Distribution
830 This optional header is filled out according to the
831 @code{message-distribution-function} variable.  It is a deprecated and
832 much misunderstood header.
833
834 @item Path
835 @cindex path
836 This extremely optional header should probably never be used.
837 However, some @emph{very} old servers require that this header is
838 present.  @code{message-user-path} further controls how this
839 @code{Path} header is to look.  If it is @code{nil}, use the server name
840 as the leaf node.  If it is a string, use the string.  If it is neither
841 a string nor @code{nil}, use the user name only.  However, it is highly
842 unlikely that you should need to fiddle with this variable at all.
843 @end table
844
845 @findex yow
846 @cindex Mime-Version
847 In addition, you can enter conses into this list.  The car of this cons
848 should be a symbol.  This symbol's name is the name of the header, and
849 the cdr can either be a string to be entered verbatim as the value of
850 this header, or it can be a function to be called.  This function should
851 return a string to be inserted.  For instance, if you want to insert
852 @code{Mime-Version: 1.0}, you should enter @code{(Mime-Version . "1.0")}
853 into the list.  If you want to insert a funny quote, you could enter
854 something like @code{(X-Yow . yow)} into the list.  The function
855 @code{yow} will then be called without any arguments.
856
857 If the list contains a cons where the car of the cons is
858 @code{optional}, the cdr of this cons will only be inserted if it is
859 non-@code{nil}.
860
861 Other variables for customizing outgoing news articles:
862
863 @table @code
864
865 @item message-syntax-checks
866 @vindex message-syntax-checks
867 If non-@code{nil}, Message will attempt to check the legality of the
868 headers, as well as some other stuff, before posting.  You can control
869 the granularity of the check by adding or removing elements from this
870 list.  Legal elements are:
871
872 @table @code
873 @item subject-cmsg 
874 Check the subject for commands.
875 @item sender
876 @cindex Sender
877 Insert a new @code{Sender} header if the @code{From} header looks odd. 
878 @item multiple-headers 
879 Check for the existence of multiple equal headers.
880 @item sendsys 
881 @cindex sendsys
882 Check for the existence of version and sendsys commands.
883 @item message-id
884 Check whether the @code{Message-ID} looks ok.
885 @item from
886 Check whether the @code{From} header seems nice.
887 @item long-lines 
888 @cindex long lines
889 Check for too long lines.
890 @item control-chars
891 Check for illegal characters.
892 @item size
893 Check for excessive size.
894 @item new-text
895 Check whether there is any new text in the messages.
896 @item signature
897 Check the length of the signature.
898 @item approved
899 @cindex approved
900 Check whether the article has an @code{Approved} header, which is
901 something only moderators should include.
902 @item empty
903 Check whether the article is empty.
904 @item empty-headers
905 Check whether any of the headers are empty.
906 @item existing-newsgroups
907 Check whether the newsgroups mentioned in the @code{Newsgroups} and 
908 @code{Followup-To} headers exist.
909 @item valid-newsgroups
910 Check whether the @code{Newsgroups} and @code{Followup-to} headers
911 are valid syntactically.
912 @item repeated-newsgroups
913 Check whether the @code{Newsgroups} and @code{Followup-to} headers
914 contains repeated group names.
915 @item shorten-followup-to
916 Check whether to add a @code{Followup-to} header to shorten the number
917 of groups to post to.
918 @end table
919
920 All these conditions are checked by default.
921
922 @item message-ignored-news-headers
923 @vindex message-ignored-news-headers
924 Regexp of headers to be removed before posting.  The default is@*
925 @samp{^NNTP-Posting-Host:\\|^Xref:\\|^[BGF]cc:\\|^Resent-Fcc:}.
926
927 @item message-default-news-headers
928 @vindex message-default-news-headers
929 This string is inserted at the end of the headers in all message
930 buffers that are initialized as news.
931
932 @end table
933
934
935 @node News Variables
936 @section News Variables
937
938 @table @code
939 @item message-send-news-function
940 @vindex message-send-news-function
941 Function used to send the current buffer as news.  The default is
942 @code{message-send-news}. 
943
944 @item message-post-method
945 @vindex message-post-method
946 Gnusish @dfn{select method} (see the Gnus manual for details) used for
947 posting a prepared news message.
948
949 @end table
950
951
952 @node Various Message Variables
953 @section Various Message Variables
954
955 @table @code
956 @item message-signature-separator
957 @vindex message-signature-separator
958 Regexp matching the signature separator.  It is @samp{^-- *$} by
959 default. 
960
961 @item mail-header-separator
962 @vindex mail-header-separator
963 String used to separate the headers from the body.  It is @samp{--text
964 follows this line--} by default.
965
966 @item message-directory
967 @vindex message-directory
968 Directory used by many mailey things.  The default is @file{~/Mail/}. 
969
970 @item message-autosave-directory
971 @vindex message-autosave-directory
972 Directory where message buffers will be autosaved to.
973
974 @item message-signature-setup-hook
975 @vindex message-signature-setup-hook
976 Hook run when initializing the message buffer.  It is run after the
977 headers have been inserted but before the signature has been inserted. 
978
979 @item message-setup-hook
980 @vindex message-setup-hook
981 Hook run as the last thing when the message buffer has been initialized,
982 but before yanked text is inserted.
983
984 @item message-header-setup-hook
985 @vindex message-header-setup-hook
986 Hook called narrowed to the headers after initializing the headers. 
987
988 For instance, if you're running Gnus and wish to insert a
989 @samp{Mail-Copies-To} header in all your news articles and all messages
990 you send to mailing lists, you could do something like the following:
991
992 @lisp
993 (defun my-message-header-setup-hook ()
994   (let ((group (or gnus-newsgroup-name "")))
995     (when (or (message-fetch-field "newsgroups")
996               (gnus-group-find-parameter group 'to-address)
997               (gnus-group-find-parameter group 'to-list))
998       (insert "Mail-Copies-To: never\n"))))
999
1000 (add-hook 'message-header-setup-hook
1001           'my-message-header-setup-hook)
1002 @end lisp
1003
1004 @item message-send-hook
1005 @vindex message-send-hook
1006 Hook run before sending messages.
1007
1008 If you want to add certain headers before sending, you can use the
1009 @code{message-add-header} function in this hook.  For instance:
1010 @findex message-add-header
1011
1012 @lisp
1013 (add-hook 'message-send-hook 'my-message-add-content)
1014 (defun my-message-add-content ()
1015   (message-add-header
1016    "Mime-Version: 1.0"
1017    "Content-Type: text/plain"
1018    "Content-Transfer-Encoding: 7bit"))
1019 @end lisp
1020
1021 This function won't add the header if the header is already present.
1022
1023 @item message-send-mail-hook
1024 @vindex message-send-mail-hook
1025 Hook run before sending mail messages.
1026
1027 @item message-send-news-hook
1028 @vindex message-send-news-hook
1029 Hook run before sending news messages.
1030
1031 @item message-sent-hook
1032 @vindex message-sent-hook
1033 Hook run after sending messages.
1034
1035 @item message-mode-syntax-table
1036 @vindex message-mode-syntax-table
1037 Syntax table used in message mode buffers.
1038
1039 @item message-send-method-alist
1040 @vindex message-send-method-alist
1041
1042 Alist of ways to send outgoing messages.  Each element has the form
1043
1044 @lisp
1045 (TYPE PREDICATE FUNCTION)
1046 @end lisp
1047
1048 @table @var
1049 @item type
1050 A symbol that names the method.
1051
1052 @item predicate
1053 A function called without any parameters to determine whether the
1054 message is a message of type @var{type}.
1055
1056 @item function
1057 A function to be called if @var{predicate} returns non-@code{nil}.
1058 @var{function} is called with one parameter -- the prefix.
1059 @end table
1060
1061 @lisp
1062 ((news message-news-p message-send-via-news)
1063  (mail message-mail-p message-send-via-mail))
1064 @end lisp
1065
1066
1067
1068 @end table
1069
1070
1071
1072 @node Sending Variables
1073 @section Sending Variables
1074
1075 @table @code
1076
1077 @item message-fcc-handler-function 
1078 @vindex message-fcc-handler-function 
1079 A function called to save outgoing articles.  This function will be
1080 called with the name of the file to store the article in. The default
1081 function is @code{message-output} which saves in Unix mailbox format.
1082
1083 @item message-courtesy-message
1084 @vindex message-courtesy-message
1085 When sending combined messages, this string is inserted at the start of
1086 the mailed copy.  If the string contains the format spec @samp{%s}, the
1087 newsgroups the article has been posted to will be inserted there.  If
1088 this variable is @code{nil}, no such courtesy message will be added.
1089 The default value is @samp{"The following message is a courtesy copy of
1090 an article\nthat has been posted to %s as well.\n\n"}. 
1091
1092 @end table
1093
1094
1095 @node Message Buffers
1096 @section Message Buffers
1097
1098 Message will generate new buffers with unique buffer names when you
1099 request a message buffer.  When you send the message, the buffer isn't
1100 normally killed off.  Its name is changed and a certain number of old
1101 message buffers are kept alive.
1102
1103 @table @code
1104 @item message-generate-new-buffers
1105 @vindex message-generate-new-buffers
1106 If non-@code{nil}, generate new buffers.  The default is @code{t}.  If
1107 this is a function, call that function with three parameters: The type,
1108 the to address and the group name.  (Any of these may be @code{nil}.)
1109 The function should return the new buffer name.
1110
1111 @item message-max-buffers
1112 @vindex message-max-buffers
1113 This variable says how many old message buffers to keep.  If there are
1114 more message buffers than this, the oldest buffer will be killed.  The
1115 default is 10.  If this variable is @code{nil}, no old message buffers
1116 will ever be killed.
1117
1118 @item message-send-rename-function
1119 @vindex message-send-rename-function
1120 After sending a message, the buffer is renamed from, for instance,
1121 @samp{*reply to Lars*} to @samp{*sent reply to Lars*}.  If you don't
1122 like this, set this variable to a function that renames the buffer in a
1123 manner you like.  If you don't want to rename the buffer at all, you can
1124 say:
1125
1126 @lisp
1127 (setq message-send-rename-function 'ignore)
1128 @end lisp
1129
1130 @item message-kill-buffer-on-exit
1131 @findex message-kill-buffer-on-exit
1132 If non-@code{nil}, kill the buffer immediately on exit.
1133
1134 @end table
1135
1136
1137 @node Message Actions
1138 @section Message Actions
1139
1140 When Message is being used from a news/mail reader, the reader is likely
1141 to want to perform some task after the message has been sent.  Perhaps
1142 return to the previous window configuration or mark an article as
1143 replied.  
1144
1145 @vindex message-kill-actions
1146 @vindex message-postpone-actions
1147 @vindex message-exit-actions
1148 @vindex message-send-actions
1149 The user may exit from the message buffer in various ways.  The most
1150 common is @kbd{C-c C-c}, which sends the message and exits.  Other
1151 possibilities are @kbd{C-c C-s} which just sends the message, @kbd{C-c
1152 C-d} which postpones the message editing and buries the message buffer,
1153 and @kbd{C-c C-k} which kills the message buffer.  Each of these actions
1154 have lists associated with them that contains actions to be executed:
1155 @code{message-send-actions}, @code{message-exit-actions},
1156 @code{message-postpone-actions}, and @code{message-kill-actions}.  
1157
1158 Message provides a function to interface with these lists:
1159 @code{message-add-action}.  The first parameter is the action to be
1160 added, and the rest of the arguments are which lists to add this action
1161 to.  Here's an example from Gnus:
1162
1163 @lisp
1164   (message-add-action
1165    `(set-window-configuration ,(current-window-configuration))
1166    'exit 'postpone 'kill)
1167 @end lisp
1168
1169 This restores the Gnus window configuration when the message buffer is
1170 killed, postponed or exited.
1171
1172 An @dfn{action} can be either: a normal function, or a list where the
1173 @code{car} is a function and the @code{cdr} is the list of arguments, or
1174 a form to be @code{eval}ed.
1175
1176
1177 @node Compatibility
1178 @chapter Compatibility
1179 @cindex compatibility
1180
1181 Message uses virtually only its own variables---older @code{mail-}
1182 variables aren't consulted.  To force Message to take those variables
1183 into account, you can put the following in your @code{.emacs} file:
1184
1185 @lisp
1186 (require 'messcompat)
1187 @end lisp
1188
1189 This will initialize many Message variables from the values in the
1190 corresponding mail variables.
1191
1192
1193 @node Appendices
1194 @chapter Appendices
1195
1196 @menu
1197 * Responses::          Standard rules for determining where responses go.
1198 @end menu
1199
1200
1201 @node Responses
1202 @section Responses
1203
1204 To determine where a message is to go, the following algorithm is used
1205 by default.
1206
1207 @table @dfn
1208 @item reply
1209 A @dfn{reply} is when you want to respond @emph{just} to the person who
1210 sent the message via mail.  There will only be one recipient.  To
1211 determine who the recipient will be, the following headers are
1212 consulted, in turn:
1213
1214 @table @code
1215 @item Reply-To
1216
1217 @item From
1218 @end table
1219
1220
1221 @item wide reply
1222 A @dfn{wide reply} is a mail response that includes @emph{all} entities
1223 mentioned in the message you are responded to.  All mailboxes from the
1224 following headers will be concatenated to form the outgoing
1225 @code{To}/@code{Cc} headers:
1226
1227 @table @code
1228 @item From
1229 (unless there's a @code{Reply-To}, in which case that is used instead).
1230
1231 @item Cc
1232
1233 @item To
1234 @end table
1235
1236 If a @code{Mail-Copies-To} header is present, it will also be included
1237 in the list of mailboxes.  If this header is @samp{never}, that means
1238 that the @code{From} (or @code{Reply-To}) mailbox will be suppressed.
1239
1240
1241 @item followup
1242 A @dfn{followup} is a response sent via news.  The following headers
1243 (listed in order of precedence) determine where the response is to be
1244 sent:
1245
1246 @table @code
1247
1248 @item Followup-To
1249
1250 @item Newsgroups
1251
1252 @end table
1253
1254 If a @code{Mail-Copies-To} header is present, it will be used as the
1255 basis of the new @code{Cc} header, except if this header is
1256 @samp{never}.
1257
1258 @end table
1259
1260
1261
1262 @node Index
1263 @chapter Index
1264 @printindex cp
1265
1266 @node Key Index
1267 @chapter Key Index
1268 @printindex ky
1269
1270 @summarycontents
1271 @contents
1272 @bye
1273
1274 @c End: