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