moved to international
[emacs.git] / man / message.texi
blob926b5837d1b5a290f485c0831635702b94d790ee
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 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 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 M-C-y
450 @kindex C-c M-C-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 File containing the signature to be inserted at the end of the buffer.
541 The default is @samp{~/.signature}.
543 @end table
545 Note that RFC1036bis says that a signature should be preceded by the three
546 characters @samp{-- } on a line by themselves.  This is to make it
547 easier for the recipient to automatically recognize and process the
548 signature.  So don't remove those characters, even though you might feel
549 that they ruin your beautiful design, like, totally.
551 Also note that no signature should be more than four lines long.
552 Including ASCII graphics is an efficient way to get everybody to believe
553 that you are silly and have nothing important to say.
556 @node MIME
557 @section MIME
558 @cindex MML
559 @cindex MIME
560 @cindex multipart
561 @cindex attachment
563 Message is a @sc{mime}-compliant posting agent.  The user generally
564 doesn't have to do anything to make the @sc{mime} happen---Message will
565 automatically add the @code{Content-Type} and
566 @code{Content-Transfer-Encoding} headers.
568 The most typical thing users want to use the multipart things in
569 @sc{mime} for is to add ``attachments'' to mail they send out.  This can
570 be done with the @code{C-c C-a} command, which will prompt for a file
571 name and a @sc{mime} type.
573 You can also create arbitrarily complex multiparts using the MML
574 language (@pxref{Composing, , Composing, emacs-mime, The Emacs MIME
575 Manual}).
578 @node Various Commands
579 @section Various Commands
581 @table @kbd
583 @item C-c C-r
584 @kindex C-c C-r
585 @findex message-caesar-buffer-body
586 Caesar rotate (aka. rot13) the current message
587 (@code{message-caesar-buffer-body}).  If narrowing is in effect, just
588 rotate the visible portion of the buffer.  A numerical prefix says how
589 many places to rotate the text.  The default is 13.
591 @item C-c C-e
592 @kindex C-c C-e
593 @findex message-elide-region
594 Elide the text between point and mark (@code{message-elide-region}).
595 The text is killed and replaced with the contents of the variable
596 @code{message-elide-ellipsis}. The default value is to use an ellipsis
597 (@samp{[...]}).
599 @item C-c C-z
600 @kindex C-c C-x
601 @findex message-kill-to-signature
602 Kill all the text up to the signature, or if that's missing, up to the
603 end of the message (@code{message-kill-to-signature}).
605 @item C-c C-v
606 @kindex C-c C-v
607 @findex message-delete-not-region
608 Delete all text in the body of the message that is outside the region
609 (@code{message-delete-not-region}).
611 @item M-RET
612 @kindex M-RET
613 @kindex message-newline-and-reformat
614 Insert four newlines, and then reformat if inside quoted text.
616 Here's an example:
618 @example
619 > This is some quoted text.  And here's more quoted text.
620 @end example
622 If point is before @samp{And} and you press @kbd{M-RET}, you'll get:
624 @example
625 > This is some quoted text.
629 > And here's more quoted text.
630 @end example
632 @samp{*} says where point will be placed.
634 @item C-c C-t
635 @kindex C-c C-t
636 @findex message-insert-to
637 Insert a @code{To} header that contains the @code{Reply-To} or
638 @code{From} header of the message you're following up
639 (@code{message-insert-to}).
641 @item C-c C-n
642 @kindex C-c C-n
643 @findex message-insert-newsgroups
644 Insert a @code{Newsgroups} header that reflects the @code{Followup-To}
645 or @code{Newsgroups} header of the article you're replying to
646 (@code{message-insert-newsgroups}).
648 @item C-c M-r
649 @kindex C-c M-r
650 @findex message-rename-buffer
651 Rename the buffer (@code{message-rename-buffer}).  If given a prefix,
652 prompt for a new buffer name.
654 @end table
657 @node Sending
658 @section Sending
660 @table @kbd
661 @item C-c C-c
662 @kindex C-c C-c
663 @findex message-send-and-exit
664 Send the message and bury the current buffer
665 (@code{message-send-and-exit}).
667 @item C-c C-s
668 @kindex C-c C-s
669 @findex message-send
670 Send the message (@code{message-send}).
672 @item C-c C-d
673 @kindex C-c C-d
674 @findex message-dont-send
675 Bury the message buffer and exit (@code{message-dont-send}).
677 @item C-c C-k
678 @kindex C-c C-k
679 @findex message-kill-buffer
680 Kill the message buffer and exit (@code{message-kill-buffer}).
682 @end table
686 @node Mail Aliases
687 @section Mail Aliases
688 @cindex mail aliases
689 @cindex aliases
691 @vindex message-mail-alias-type
692 The @code{message-mail-alias-type} variable controls what type of mail
693 alias expansion to use.  Currently only one form is supported---Message
694 uses @code{mailabbrev} to handle mail aliases.  If this variable is
695 @code{nil}, no mail alias expansion will be performed.
697 @code{mailabbrev} works by parsing the @file{/etc/mailrc} and
698 @file{~/.mailrc} files.  These files look like:
700 @example
701 alias lmi "Lars Magne Ingebrigtsen <larsi@@ifi.uio.no>"
702 alias ding "ding@@ifi.uio.no (ding mailing list)"
703 @end example
705 After adding lines like this to your @file{~/.mailrc} file, you should
706 be able to just write @samp{lmi} in the @code{To} or @code{Cc} (and so
707 on) headers and press @kbd{SPC} to expand the alias.
709 No expansion will be performed upon sending of the message---all
710 expansions have to be done explicitly.
713 @node Spelling
714 @section Spelling
715 @cindex spelling
716 @findex ispell-message
718 There are two popular ways to have Emacs spell-check your messages:
719 @code{ispell} and @code{flyspell}.  @code{ispell} is the older and
720 probably more popular package.  You typically first write the message,
721 and then run the entire thing through @code{ispell} and fix all the
722 typos.  To have this happen automatically when you send a message, put
723 something like the following in your @file{.emacs} file:
725 @lisp
726 (add-hook 'message-send-hook 'ispell-message)
727 @end lisp
729 @vindex ispell-message-dictionary-alist
730 If you're in the habit of writing in different languages, this can be
731 controlled by the @code{ispell-message-dictionary-alist} variable:
733 @lisp
734 (setq ispell-message-dictionary-alist
735       '(("^Newsgroups:.*\\bde\\." . "deutsch8")
736         (".*" . "default")))
737 @end lisp
739 @code{ispell} depends on having the external @samp{ispell} command
740 installed.
742 The other popular method is using @code{flyspell}.  This package checks
743 your spelling while you're writing, and marks any mis-spelled words in
744 various ways.
746 To use @code{flyspell}, put something like the following in your
747 @file{.emacs} file:
749 @lisp
750 (defun my-message-setup-routine ()
751   (flyspell-mode 1))
752 (add-hook 'message-setup-hook 'my-message-setup-routine)
753 @end lisp
755 @code{flyspell} depends on having the external @samp{ispell} command
756 installed.
759 @node Variables
760 @chapter Variables
762 @menu
763 * Message Headers::             General message header stuff.
764 * Mail Headers::                Customizing mail headers.
765 * Mail Variables::              Other mail variables.
766 * News Headers::                Customizing news headers.
767 * News Variables::              Other news variables.
768 * Various Message Variables::   Other message variables.
769 * Sending Variables::           Variables for sending.
770 * Message Buffers::             How Message names its buffers.
771 * Message Actions::             Actions to be performed when exiting.
772 @end menu
775 @node Message Headers
776 @section Message Headers
778 Message is quite aggressive on the message generation front.  It has to
779 be -- it's a combined news and mail agent.  To be able to send combined
780 messages, it has to generate all headers itself (instead of letting the
781 mail/news system do it) to ensure that mail and news copies of messages
782 look sufficiently similar.
784 @table @code
786 @item message-generate-headers-first
787 @vindex message-generate-headers-first
788 If non-@code{nil}, generate all headers before starting to compose the
789 message.
791 @item message-from-style
792 @vindex message-from-style
793 Specifies how @code{From} headers should look.  There are four valid
794 values:
796 @table @code
797 @item nil
798 Just the address -- @samp{king@@grassland.com}.
800 @item parens
801 @samp{king@@grassland.com (Elvis Parsley)}.
803 @item angles
804 @samp{Elvis Parsley <king@@grassland.com>}.
806 @item default
807 Look like @code{angles} if that doesn't require quoting, and
808 @code{parens} if it does.  If even @code{parens} requires quoting, use
809 @code{angles} anyway.
811 @end table
813 @item message-deletable-headers
814 @vindex message-deletable-headers
815 Headers in this list that were previously generated by Message will be
816 deleted before posting.  Let's say you post an article.  Then you decide
817 to post it again to some other group, you naughty boy, so you jump back
818 to the @code{*post-buf*} buffer, edit the @code{Newsgroups} line, and
819 ship it off again.  By default, this variable makes sure that the old
820 generated @code{Message-ID} is deleted, and a new one generated.  If
821 this isn't done, the entire empire would probably crumble, anarchy would
822 prevail, and cats would start walking on two legs and rule the world.
823 Allegedly.
825 @item message-default-headers
826 @vindex message-default-headers
827 This string is inserted at the end of the headers in all message
828 buffers.
830 @item message-subject-re-regexp
831 @vindex message-subject-re-regexp
832 Responses to messages have subjects that start with @samp{Re: }.  This
833 is @emph{not} an abbreviation of the English word ``response'', but is
834 Latin, and means ``in response to''.  Some illiterate nincompoops have
835 failed to grasp this fact, and have ``internationalized'' their software
836 to use abonimations like @samp{Aw: } (``antwort'') or @samp{Sv: }
837 (``svar'') instead, which is meaningless and evil.  However, you may
838 have to deal with users that use these evil tools, in which case you may
839 set this variable to a regexp that matches these prefixes.  Myself, I
840 just throw away non-compliant mail.
842 @item message-alternative-emails
843 @vindex message-alternative-emails
844 A regexp to match the alternative email addresses.  The first matched
845 address (not primary one) is used in the @code{From} field.
847 @end table
850 @node Mail Headers
851 @section Mail Headers
853 @table @code
854 @item message-required-mail-headers
855 @vindex message-required-mail-headers
856 @xref{News Headers}, for the syntax of this variable.  It is
857 @code{(From Date Subject (optional . In-Reply-To) Message-ID Lines
858 (optional . User-Agent))} by default.
860 @item message-ignored-mail-headers
861 @vindex message-ignored-mail-headers
862 Regexp of headers to be removed before mailing.  The default is
863 @samp{^[GF]cc:\\|^Resent-Fcc:}.
865 @item message-default-mail-headers
866 @vindex message-default-mail-headers
867 This string is inserted at the end of the headers in all message
868 buffers that are initialized as mail.
870 @end table
873 @node Mail Variables
874 @section Mail Variables
876 @table @code
877 @item message-send-mail-function
878 @vindex message-send-mail-function
879 Function used to send the current buffer as mail.  The default is
880 @code{message-send-mail-with-sendmail}.   If you prefer using MH
881 instead, set this variable to @code{message-send-mail-with-mh}.
883 @item message-mh-deletable-headers
884 @vindex message-mh-deletable-headers
885 Most versions of MH doesn't like being fed messages that contain the
886 headers in this variable.  If this variable is non-@code{nil} (which is
887 the default), these headers will be removed before mailing when sending
888 messages via MH.  Set it to @code{nil} if your MH can handle these
889 headers.
891 @item message-send-mail-partially-limit
892 @vindex message-send-mail-partially-limit
893 The limit on the size of messages sent as @samp{message/partial}.
894 This is the minimum message size in characters beyond which the
895 message should be sent in several parts.  If it is @code{nil}, the
896 size is unlimited.
898 @end table
901 @node News Headers
902 @section News Headers
904 @vindex message-required-news-headers
905 @code{message-required-news-headers} a list of header symbols.  These
906 headers will either be automatically generated, or, if that's
907 impossible, they will be prompted for.  The following symbols are valid:
909 @table @code
911 @item From
912 @cindex From
913 @findex user-full-name
914 @findex user-mail-address
915 This required header will be filled out with the result of the
916 @code{message-make-from} function, which depends on the
917 @code{message-from-style}, @code{user-full-name},
918 @code{user-mail-address} variables.
920 @item Subject
921 @cindex Subject
922 This required header will be prompted for if not present already.
924 @item Newsgroups
925 @cindex Newsgroups
926 This required header says which newsgroups the article is to be posted
927 to.  If it isn't present already, it will be prompted for.
929 @item Organization
930 @cindex organization
931 This optional header will be filled out depending on the
932 @code{message-user-organization} variable.
933 @code{message-user-organization-file} will be used if this variable is
934 @code{t}.  This variable can also be a string (in which case this string
935 will be used), or it can be a function (which will be called with no
936 parameters and should return a string to be used).
938 @item Lines
939 @cindex Lines
940 This optional header will be computed by Message.
942 @item Message-ID
943 @cindex Message-ID
944 @vindex mail-host-address
945 @findex system-name
946 @cindex Sun
947 This required header will be generated by Message.  A unique ID will be
948 created based on the date, time, user name and system name.  Message
949 will use @code{system-name} to determine the name of the system.  If
950 this isn't a fully qualified domain name (FQDN), Message will use
951 @code{mail-host-address} as the FQDN of the machine.
953 @item User-Agent
954 @cindex User-Agent
955 This optional header will be filled out according to the
956 @code{message-newsreader} local variable.
958 @item In-Reply-To
959 This optional header is filled out using the @code{Date} and @code{From}
960 header of the article being replied to.
962 @item Expires
963 @cindex Expires
964 This extremely optional header will be inserted according to the
965 @code{message-expires} variable.  It is highly deprecated and shouldn't
966 be used unless you know what you're doing.
968 @item Distribution
969 @cindex Distribution
970 This optional header is filled out according to the
971 @code{message-distribution-function} variable.  It is a deprecated and
972 much misunderstood header.
974 @item Path
975 @cindex path
976 This extremely optional header should probably never be used.
977 However, some @emph{very} old servers require that this header is
978 present.  @code{message-user-path} further controls how this
979 @code{Path} header is to look.  If it is @code{nil}, use the server name
980 as the leaf node.  If it is a string, use the string.  If it is neither
981 a string nor @code{nil}, use the user name only.  However, it is highly
982 unlikely that you should need to fiddle with this variable at all.
983 @end table
985 @findex yow
986 @cindex Mime-Version
987 In addition, you can enter conses into this list.  The car of this cons
988 should be a symbol.  This symbol's name is the name of the header, and
989 the cdr can either be a string to be entered verbatim as the value of
990 this header, or it can be a function to be called.  This function should
991 return a string to be inserted.  For instance, if you want to insert
992 @code{Mime-Version: 1.0}, you should enter @code{(Mime-Version . "1.0")}
993 into the list.  If you want to insert a funny quote, you could enter
994 something like @code{(X-Yow . yow)} into the list.  The function
995 @code{yow} will then be called without any arguments.
997 If the list contains a cons where the car of the cons is
998 @code{optional}, the cdr of this cons will only be inserted if it is
999 non-@code{nil}.
1001 Other variables for customizing outgoing news articles:
1003 @table @code
1005 @item message-syntax-checks
1006 @vindex message-syntax-checks
1007 Controls what syntax checks should not be performed on outgoing posts.
1008 To disable checking of long signatures, for instance, add
1010 @lisp
1011 (signature . disabled)
1012 @end lisp
1014 to this list.
1016 Valid checks are:
1018 @table @code
1019 @item subject-cmsg
1020 Check the subject for commands.
1021 @item sender
1022 @cindex Sender
1023 Insert a new @code{Sender} header if the @code{From} header looks odd.
1024 @item multiple-headers
1025 Check for the existence of multiple equal headers.
1026 @item sendsys
1027 @cindex sendsys
1028 Check for the existence of version and sendsys commands.
1029 @item message-id
1030 Check whether the @code{Message-ID} looks ok.
1031 @item from
1032 Check whether the @code{From} header seems nice.
1033 @item long-lines
1034 @cindex long lines
1035 Check for too long lines.
1036 @item control-chars
1037 Check for invalid characters.
1038 @item size
1039 Check for excessive size.
1040 @item new-text
1041 Check whether there is any new text in the messages.
1042 @item signature
1043 Check the length of the signature.
1044 @item approved
1045 @cindex approved
1046 Check whether the article has an @code{Approved} header, which is
1047 something only moderators should include.
1048 @item empty
1049 Check whether the article is empty.
1050 @item invisible-text
1051 Check whether there is any invisible text in the buffer.
1052 @item empty-headers
1053 Check whether any of the headers are empty.
1054 @item existing-newsgroups
1055 Check whether the newsgroups mentioned in the @code{Newsgroups} and
1056 @code{Followup-To} headers exist.
1057 @item valid-newsgroups
1058 Check whether the @code{Newsgroups} and @code{Followup-to} headers
1059 are valid syntactically.
1060 @item repeated-newsgroups
1061 Check whether the @code{Newsgroups} and @code{Followup-to} headers
1062 contains repeated group names.
1063 @item shorten-followup-to
1064 Check whether to add a @code{Followup-to} header to shorten the number
1065 of groups to post to.
1066 @end table
1068 All these conditions are checked by default.
1070 @item message-ignored-news-headers
1071 @vindex message-ignored-news-headers
1072 Regexp of headers to be removed before posting.  The default is@*
1073 @samp{^NNTP-Posting-Host:\\|^Xref:\\|^[BGF]cc:\\|^Resent-Fcc:}.
1075 @item message-default-news-headers
1076 @vindex message-default-news-headers
1077 This string is inserted at the end of the headers in all message
1078 buffers that are initialized as news.
1080 @end table
1083 @node News Variables
1084 @section News Variables
1086 @table @code
1087 @item message-send-news-function
1088 @vindex message-send-news-function
1089 Function used to send the current buffer as news.  The default is
1090 @code{message-send-news}.
1092 @item message-post-method
1093 @vindex message-post-method
1094 Gnusish @dfn{select method} (see the Gnus manual for details) used for
1095 posting a prepared news message.
1097 @end table
1100 @node Various Message Variables
1101 @section Various Message Variables
1103 @table @code
1104 @item message-default-charset
1105 @vindex message-default-charset
1106 @cindex charset
1107 Symbol naming a @sc{mime} charset.  Non-ASCII characters in messages are
1108 assumed to be encoded using this charset.  The default is @code{nil},
1109 which means ask the user.  (This variable is used only on non-@sc{mule}
1110 Emacsen.  
1111 @xref{Charset Translation, , Charset Translation, emacs-mime, 
1112       Emacs MIME Manual}, for details on the @sc{mule}-to-@sc{mime}
1113 translation process.
1115 @item message-signature-separator
1116 @vindex message-signature-separator
1117 Regexp matching the signature separator.  It is @samp{^-- *$} by
1118 default.
1120 @item mail-header-separator
1121 @vindex mail-header-separator
1122 String used to separate the headers from the body.  It is @samp{--text
1123 follows this line--} by default.
1125 @item message-directory
1126 @vindex message-directory
1127 Directory used by many mailey things.  The default is @file{~/Mail/}.
1129 @item message-signature-setup-hook
1130 @vindex message-signature-setup-hook
1131 Hook run when initializing the message buffer.  It is run after the
1132 headers have been inserted but before the signature has been inserted.
1134 @item message-setup-hook
1135 @vindex message-setup-hook
1136 Hook run as the last thing when the message buffer has been initialized,
1137 but before yanked text is inserted.
1139 @item message-header-setup-hook
1140 @vindex message-header-setup-hook
1141 Hook called narrowed to the headers after initializing the headers.
1143 For instance, if you're running Gnus and wish to insert a
1144 @samp{Mail-Copies-To} header in all your news articles and all messages
1145 you send to mailing lists, you could do something like the following:
1147 @lisp
1148 (defun my-message-header-setup-hook ()
1149   (let ((group (or gnus-newsgroup-name "")))
1150     (when (or (message-fetch-field "newsgroups")
1151               (gnus-group-find-parameter group 'to-address)
1152               (gnus-group-find-parameter group 'to-list))
1153       (insert "Mail-Copies-To: never\n"))))
1155 (add-hook 'message-header-setup-hook
1156           'my-message-header-setup-hook)
1157 @end lisp
1159 @item message-send-hook
1160 @vindex message-send-hook
1161 Hook run before sending messages.
1163 If you want to add certain headers before sending, you can use the
1164 @code{message-add-header} function in this hook.  For instance:
1165 @findex message-add-header
1167 @lisp
1168 (add-hook 'message-send-hook 'my-message-add-content)
1169 (defun my-message-add-content ()
1170   (message-add-header "X-In-No-Sense: Nonsense")
1171   (message-add-header "X-Whatever: no"))
1172 @end lisp
1174 This function won't add the header if the header is already present.
1176 @item message-send-mail-hook
1177 @vindex message-send-mail-hook
1178 Hook run before sending mail messages.
1180 @item message-send-news-hook
1181 @vindex message-send-news-hook
1182 Hook run before sending news messages.
1184 @item message-sent-hook
1185 @vindex message-sent-hook
1186 Hook run after sending messages.
1188 @item message-mode-syntax-table
1189 @vindex message-mode-syntax-table
1190 Syntax table used in message mode buffers.
1192 @item message-send-method-alist
1193 @vindex message-send-method-alist
1195 Alist of ways to send outgoing messages.  Each element has the form
1197 @lisp
1198 (TYPE PREDICATE FUNCTION)
1199 @end lisp
1201 @table @var
1202 @item type
1203 A symbol that names the method.
1205 @item predicate
1206 A function called without any parameters to determine whether the
1207 message is a message of type @var{type}.
1209 @item function
1210 A function to be called if @var{predicate} returns non-@code{nil}.
1211 @var{function} is called with one parameter -- the prefix.
1212 @end table
1214 @lisp
1215 ((news message-news-p message-send-via-news)
1216  (mail message-mail-p message-send-via-mail))
1217 @end lisp
1221 @end table
1225 @node Sending Variables
1226 @section Sending Variables
1228 @table @code
1230 @item message-fcc-handler-function
1231 @vindex message-fcc-handler-function
1232 A function called to save outgoing articles.  This function will be
1233 called with the name of the file to store the article in.  The default
1234 function is @code{message-output} which saves in Unix mailbox format.
1236 @item message-courtesy-message
1237 @vindex message-courtesy-message
1238 When sending combined messages, this string is inserted at the start of
1239 the mailed copy.  If the string contains the format spec @samp{%s}, the
1240 newsgroups the article has been posted to will be inserted there.  If
1241 this variable is @code{nil}, no such courtesy message will be added.
1242 The default value is @samp{"The following message is a courtesy copy of
1243 an article\nthat has been posted to %s as well.\n\n"}.
1245 @end table
1248 @node Message Buffers
1249 @section Message Buffers
1251 Message will generate new buffers with unique buffer names when you
1252 request a message buffer.  When you send the message, the buffer isn't
1253 normally killed off.  Its name is changed and a certain number of old
1254 message buffers are kept alive.
1256 @table @code
1257 @item message-generate-new-buffers
1258 @vindex message-generate-new-buffers
1259 If non-@code{nil}, generate new buffers.  The default is @code{t}.  If
1260 this is a function, call that function with three parameters: The type,
1261 the to address and the group name.  (Any of these may be @code{nil}.)
1262 The function should return the new buffer name.
1264 @item message-max-buffers
1265 @vindex message-max-buffers
1266 This variable says how many old message buffers to keep.  If there are
1267 more message buffers than this, the oldest buffer will be killed.  The
1268 default is 10.  If this variable is @code{nil}, no old message buffers
1269 will ever be killed.
1271 @item message-send-rename-function
1272 @vindex message-send-rename-function
1273 After sending a message, the buffer is renamed from, for instance,
1274 @samp{*reply to Lars*} to @samp{*sent reply to Lars*}.  If you don't
1275 like this, set this variable to a function that renames the buffer in a
1276 manner you like.  If you don't want to rename the buffer at all, you can
1277 say:
1279 @lisp
1280 (setq message-send-rename-function 'ignore)
1281 @end lisp
1283 @item message-kill-buffer-on-exit
1284 @findex message-kill-buffer-on-exit
1285 If non-@code{nil}, kill the buffer immediately on exit.
1287 @end table
1290 @node Message Actions
1291 @section Message Actions
1293 When Message is being used from a news/mail reader, the reader is likely
1294 to want to perform some task after the message has been sent.  Perhaps
1295 return to the previous window configuration or mark an article as
1296 replied.
1298 @vindex message-kill-actions
1299 @vindex message-postpone-actions
1300 @vindex message-exit-actions
1301 @vindex message-send-actions
1302 The user may exit from the message buffer in various ways.  The most
1303 common is @kbd{C-c C-c}, which sends the message and exits.  Other
1304 possibilities are @kbd{C-c C-s} which just sends the message, @kbd{C-c
1305 C-d} which postpones the message editing and buries the message buffer,
1306 and @kbd{C-c C-k} which kills the message buffer.  Each of these actions
1307 have lists associated with them that contains actions to be executed:
1308 @code{message-send-actions}, @code{message-exit-actions},
1309 @code{message-postpone-actions}, and @code{message-kill-actions}.
1311 Message provides a function to interface with these lists:
1312 @code{message-add-action}.  The first parameter is the action to be
1313 added, and the rest of the arguments are which lists to add this action
1314 to.  Here's an example from Gnus:
1316 @lisp
1317   (message-add-action
1318    `(set-window-configuration ,(current-window-configuration))
1319    'exit 'postpone 'kill)
1320 @end lisp
1322 This restores the Gnus window configuration when the message buffer is
1323 killed, postponed or exited.
1325 An @dfn{action} can be either: a normal function, or a list where the
1326 @code{car} is a function and the @code{cdr} is the list of arguments, or
1327 a form to be @code{eval}ed.
1330 @node Compatibility
1331 @chapter Compatibility
1332 @cindex compatibility
1334 Message uses virtually only its own variables---older @code{mail-}
1335 variables aren't consulted.  To force Message to take those variables
1336 into account, you can put the following in your @code{.emacs} file:
1338 @lisp
1339 (require 'messcompat)
1340 @end lisp
1342 This will initialize many Message variables from the values in the
1343 corresponding mail variables.
1346 @node Appendices
1347 @chapter Appendices
1349 @menu
1350 * Responses::          Standard rules for determining where responses go.
1351 @end menu
1354 @node Responses
1355 @section Responses
1357 To determine where a message is to go, the following algorithm is used
1358 by default.
1360 @table @dfn
1361 @item reply
1362 A @dfn{reply} is when you want to respond @emph{just} to the person who
1363 sent the message via mail.  There will only be one recipient.  To
1364 determine who the recipient will be, the following headers are
1365 consulted, in turn:
1367 @table @code
1368 @item Reply-To
1370 @item From
1371 @end table
1374 @item wide reply
1375 A @dfn{wide reply} is a mail response that includes @emph{all} entities
1376 mentioned in the message you are responded to.  All mailboxes from the
1377 following headers will be concatenated to form the outgoing
1378 @code{To}/@code{Cc} headers:
1380 @table @code
1381 @item From
1382 (unless there's a @code{Reply-To}, in which case that is used instead).
1384 @item Cc
1386 @item To
1387 @end table
1389 If a @code{Mail-Copies-To} header is present, it will also be included
1390 in the list of mailboxes.  If this header is @samp{never}, that means
1391 that the @code{From} (or @code{Reply-To}) mailbox will be suppressed.
1394 @item followup
1395 A @dfn{followup} is a response sent via news.  The following headers
1396 (listed in order of precedence) determine where the response is to be
1397 sent:
1399 @table @code
1401 @item Followup-To
1403 @item Newsgroups
1405 @end table
1407 If a @code{Mail-Copies-To} header is present, it will be used as the
1408 basis of the new @code{Cc} header, except if this header is
1409 @samp{never}.
1411 @end table
1415 @node Index
1416 @chapter Index
1417 @printindex cp
1419 @node Key Index
1420 @chapter Key Index
1421 @printindex ky
1423 @summarycontents
1424 @contents
1425 @bye
1427 @c End: