388f34f455445b67db7437605b6d180bc259eba6
[gnus] / texi / message.texi
1 \input texinfo                  @c -*-texinfo-*-
2
3 @setfilename message
4 @settitle Message 5.6.8 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 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 Message 5.6.8 Manual
46
47 @author by Lars Magne Ingebrigtsen
48 @page
49
50 @vskip 0pt plus 1filll
51 Copyright @copyright{} 1996 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 Message 5.6.8.  Message is distributed with
87 the Gnus distribution bearing the same version number as this manual
88 has. 
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 @end table
271
272
273 @node Resending
274 @section Resending
275
276 @findex message-resend
277 The @code{message-resend} command will prompt the user for an address
278 and resend the message in the current buffer to that address.
279
280 @vindex message-ignored-resent-headers
281 Headers that match the @code{message-ignored-resent-headers} regexp will
282 be removed before sending the message.  The default is
283 @samp{^Return-receipt}. 
284
285
286 @node Bouncing
287 @section Bouncing
288
289 @findex message-bounce
290 The @code{message-bounce} command will, if the current buffer contains a
291 bounced mail message, pop up a message buffer stripped of the bounce
292 information.  A @dfn{bounced message} is typically a mail you've sent
293 out that has been returned by some @code{mailer-daemon} as
294 undeliverable. 
295
296 @vindex message-ignored-bounced-headers
297 Headers that match the @code{message-ignored-bounced-headers} regexp
298 will be removed before popping up the buffer.  The default is
299 @samp{^\\(Received\\|Return-Path\\):}.
300
301
302 @node Commands
303 @chapter Commands
304
305 @menu
306 * Header Commands::     Commands for moving to headers.
307 * Movement::            Moving around in message buffers.
308 * Insertion::           Inserting things into message buffers.
309 * Various Commands::    Various things.
310 * Sending::             Actually sending the message.
311 * Mail Aliases::        How to use mail aliases.
312 @end menu
313
314
315 @node Header Commands
316 @section Header Commands
317
318 All these commands move to the header in question.  If it doesn't exist,
319 it will be inserted.
320
321 @table @kbd
322
323 @item C-c ?
324 @kindex C-c ?
325 @findex message-goto-to
326 Describe the message mode.
327
328 @item C-c C-f C-t
329 @kindex C-c C-f C-t 
330 @findex message-goto-to
331 Go to the @code{To} header (@code{message-goto-to}).
332
333 @item C-c C-f C-b
334 @kindex C-c C-f C-b 
335 @findex message-goto-bcc
336 Go to the @code{Bcc} header (@code{message-goto-bcc}).
337
338 @item C-c C-f C-f
339 @kindex C-c C-f C-f 
340 @findex message-goto-fcc
341 Go to the @code{Fcc} header (@code{message-goto-fcc}).
342
343 @item C-c C-f C-c
344 @kindex C-c C-f C-c 
345 @findex message-goto-cc
346 Go to the @code{Cc} header (@code{message-goto-cc}).
347
348 @item C-c C-f C-s
349 @kindex C-c C-f C-s 
350 @findex message-goto-subject
351 Go to the @code{Subject} header (@code{message-goto-subject}).
352
353 @item C-c C-f C-r
354 @kindex C-c C-f C-r 
355 @findex message-goto-reply-to
356 Go to the @code{Reply-To} header (@code{message-goto-reply-to}).
357
358 @item C-c C-f C-n
359 @kindex C-c C-f C-n 
360 @findex message-goto-newsgroups
361 Go to the @code{Newsgroups} header (@code{message-goto-newsgroups}).
362
363 @item C-c C-f C-d
364 @kindex C-c C-f C-d 
365 @findex message-goto-distribution
366 Go to the @code{Distribution} header (@code{message-goto-distribution}).
367
368 @item C-c C-f C-o
369 @kindex C-c C-f C-o 
370 @findex message-goto-followup-to
371 Go to the @code{Followup-To} header (@code{message-goto-followup-to}).
372
373 @item C-c C-f C-k
374 @kindex C-c C-f C-k 
375 @findex message-goto-keywords
376 Go to the @code{Keywords} header (@code{message-goto-keywords}).
377
378 @item C-c C-f C-u
379 @kindex C-c C-f C-u 
380 @findex message-goto-summary
381 Go to the @code{Summary} header (@code{message-goto-summary}).
382
383 @end table
384
385
386 @node Movement
387 @section Movement
388
389 @table @kbd
390 @item C-c C-b
391 @kindex C-c C-b 
392 @findex message-goto-body
393 Move to the beginning of the body of the message
394 (@code{message-goto-body}). 
395
396 @item C-c C-i
397 @kindex C-c C-i 
398 @findex message-goto-signature
399 Move to the signature of the message (@code{message-goto-signature}).
400
401 @end table
402
403
404 @node Insertion
405 @section Insertion
406
407 @table @kbd
408
409 @item C-c C-y
410 @kindex C-c C-y 
411 @findex message-yank-original
412 Yank the message that's being replied to into the message buffer
413 (@code{message-yank-original}). 
414
415 @item C-c C-q
416 @kindex C-c C-q 
417 @findex message-fill-yanked-message
418 Fill the yanked message (@code{message-fill-yanked-message}).  Warning:
419 Can severely mess up the yanked text if its quoting conventions are
420 strange.  You'll quickly get a feel for when it's safe, though.  Anyway,
421 just remember that @kbd{C-x u} (@code{undo}) is available and you'll be
422 all right.
423
424
425 @item C-c C-w
426 @kindex C-c C-w 
427 @findex message-insert-signature
428 Insert a signature at the end of the buffer
429 (@code{message-insert-signature}).  
430
431 @end table
432
433 @table @code
434 @item message-ignored-cited-headers
435 @vindex message-ignored-cited-headers
436 All headers that match this regexp will be removed from yanked
437 messages.  The default is @samp{.}, which means that all headers will be
438 removed.
439
440 @item message-citation-line-function
441 @vindex message-citation-line-function
442 Function called to insert the citation line.  The default is
443 @code{message-insert-citation-line}, which will lead to citation lines
444 that look like:
445
446 @example
447 Hallvard B Furuseth <h.b.furuseth@@usit.uio.no> writes:
448 @end example
449
450 Point will be at the beginning of the body of the message when this
451 function is called.
452
453 @item message-yank-prefix
454 @vindex message-yank-prefix
455 @cindex yanking
456 @cindex quoting
457 When you are replying to or following up an article, you normally want
458 to quote the person you are answering.  Inserting quoted text is done by
459 @dfn{yanking}, and each quoted line you yank will have
460 @code{message-yank-prefix} prepended to it.  The default is @samp{> }.
461 If it is @code{nil}, just indent the message.
462
463 @item message-indentation-spaces
464 @vindex message-indentation-spaces
465 Number of spaces to indent yanked messages.
466
467 @item message-cite-function
468 @vindex message-cite-function
469 @findex message-cite-original
470 @findex sc-cite-original
471 @findex message-cite-original-without-signature
472 @cindex Supercite
473 Function for citing an original message.  The default is
474 @code{message-cite-original}, which simply inserts the original message
475 and prepends @samp{> } to each line.
476 @code{message-cite-original-without-signature} does the same, but elides
477 the signature.  You can also set it to @code{sc-cite-original} to use
478 Supercite.
479
480 @item message-indent-citation-function
481 @vindex message-indent-citation-function
482 Function for modifying a citation just inserted in the mail buffer.
483 This can also be a list of functions.  Each function can find the
484 citation between @code{(point)} and @code{(mark t)}.  And each function
485 should leave point and mark around the citation text as modified.
486
487 @item message-signature
488 @vindex message-signature
489 String to be inserted at the end of the message buffer.  If @code{t}
490 (which is the default), the @code{message-signature-file} file will be
491 inserted instead.  If a function, the result from the function will be
492 used instead.  If a form, the result from the form will be used instead.
493 If this variable is @code{nil}, no signature will be inserted at all.
494
495 @item message-signature-file
496 @vindex message-signature-file
497 File containing the signature to be inserted at the end of the buffer.
498 The default is @samp{~/.signature}.
499
500 @end table
501
502 Note that RFC1036bis says that a signature should be preceded by the three
503 characters @samp{-- } on a line by themselves.  This is to make it
504 easier for the recipient to automatically recognize and process the
505 signature.  So don't remove those characters, even though you might feel
506 that they ruin your beautiful design, like, totally.
507
508 Also note that no signature should be more than four lines long.
509 Including ASCII graphics is an efficient way to get everybody to believe
510 that you are silly and have nothing important to say.
511
512
513
514 @node Various Commands
515 @section Various Commands
516
517 @table @kbd
518
519 @item C-c C-r
520 @kindex C-c C-r 
521 @findex message-caesar-buffer-body
522 Caesar rotate (aka. rot13) the current message
523 (@code{message-caesar-buffer-body}).  If narrowing is in effect, just
524 rotate the visible portion of the buffer.  A numerical prefix says how
525 many places to rotate the text.  The default is 13.
526
527 @item C-c C-e
528 @kindex C-c C-e
529 @findex message-elide-region
530 Elide the text between point and mark (@code{message-elide-region}).
531 The text is killed and an ellipsis (@samp{[...]}) will be inserted in
532 its place.
533
534 @item C-c C-z
535 @kindex C-c C-x
536 @findex message-kill-to-signature
537 Kill all the text up to the signature, or if that's missing, up to the
538 end of the message (@code{message-kill-to-signature}).
539
540 @item C-c C-v
541 @kindex C-c C-v
542 @findex message-delete-not-region
543 Delete all text in the body of the message that is outside the region
544 (@code{message-delete-not-region}).
545
546 @item M-RET
547 @kindex M-RET
548 @kindex message-newline-and-reformat
549 Insert four newlines, and then reformat if inside quoted text.
550
551 Here's an example:
552
553 @example
554 > This is some quoted text.  And here's more quoted text.
555 @end example
556
557 If point is before @samp{And} and you press @kbd{M-RET}, you'll get:
558
559 @example
560 > This is some quoted text.
561
562 *
563
564 > And here's more quoted text.
565 @end example
566
567 @samp{*} says where point will be placed.  
568
569 @item C-c C-t
570 @kindex C-c C-t 
571 @findex message-insert-to
572 Insert a @code{To} header that contains the @code{Reply-To} or
573 @code{From} header of the message you're following up
574 (@code{message-insert-to}). 
575
576 @item C-c C-n
577 @kindex C-c C-n 
578 @findex message-insert-newsgroups
579 Insert a @code{Newsgroups} header that reflects the @code{Followup-To}
580 or @code{Newsgroups} header of the article you're replying to
581 (@code{message-insert-newsgroups}).
582
583 @item C-c M-r
584 @kindex C-c M-r
585 @findex message-rename-buffer
586 Rename the buffer (@code{message-rename-buffer}).  If given a prefix,
587 prompt for a new buffer name.
588
589 @end table
590
591
592 @node Sending
593 @section Sending
594
595 @table @kbd
596 @item C-c C-c
597 @kindex C-c C-c 
598 @findex message-send-and-exit
599 Send the message and bury the current buffer
600 (@code{message-send-and-exit}). 
601
602 @item C-c C-s
603 @kindex C-c C-s 
604 @findex message-send
605 Send the message (@code{message-send}). 
606
607 @item C-c C-d
608 @kindex C-c C-d
609 @findex message-dont-send
610 Bury the message buffer and exit (@code{message-dont-send}).
611
612 @item C-c C-k
613 @kindex C-c C-k
614 @findex message-kill-buffer
615 Kill the message buffer and exit (@code{message-kill-buffer}).
616
617 @end table
618
619
620
621 @node Mail Aliases
622 @section Mail Aliases
623 @cindex mail aliases
624 @cindex aliases
625
626 @vindex message-mail-alias-type
627 The @code{message-mail-alias-type} variable controls what type of mail
628 alias expansion to use.  Currently only one form is supported---Message
629 uses @code{mailabbrev} to handle mail aliases.  If this variable is
630 @code{nil}, no mail alias expansion will be performed.
631
632 @code{mailabbrev} works by parsing the @file{/etc/mailrc} and
633 @file{~/.mailrc} files.  These files look like:
634
635 @example
636 alias lmi "Lars Magne Ingebrigtsen <larsi@@ifi.uio.no>"
637 alias ding "ding@@ifi.uio.no (ding mailing list)"
638 @end example
639
640 After adding lines like this to your @file{~/.mailrc} file, you should
641 be able to just write @samp{lmi} in the @code{To} or @code{Cc} (and so
642 on) headers and press @kbd{SPC} to expand the alias.
643
644 No expansion will be performed upon sending of the message---all
645 expansions have to be done explicitly.
646
647
648
649 @node Variables
650 @chapter Variables
651
652 @menu
653 * Message Headers::             General message header stuff.
654 * Mail Headers::                Customizing mail headers.
655 * Mail Variables::              Other mail variables.
656 * News Headers::                Customizing news headers.
657 * News Variables::              Other news variables.
658 * Various Message Variables::   Other message variables.
659 * Sending Variables::           Variables for sending.
660 * Message Buffers::             How Message names its buffers.
661 * Message Actions::             Actions to be performed when exiting.
662 @end menu
663
664