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