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