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