Synch with Oort Gnus.
[elisp/gnus.git-] / texi / message.texi
1 \input texinfo                  @c -*-texinfo-*-
2
3 @setfilename message
4 @settitle T-gnus 6.15 Message 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
16
17 @ifnottex
18
19 This file documents Message, the Emacs message composition mode.
20
21 Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
22
23 Permission is granted to copy, distribute and/or modify this document
24 under the terms of the GNU Free Documentation License, Version 1.1 or
25 any later version published by the Free Software Foundation; with 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.
30
31 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
32 this GNU Manual, like GNU software.  Copies published by the Free
33 Software Foundation raise funds for GNU development.''
34
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
40
41 @tex
42
43 @titlepage
44 @title T-gnus 6.15 Message Manual
45
46 @author by Lars Magne Ingebrigtsen
47 @page
48
49 @vskip 0pt plus 1filll
50 Copyright @copyright{} 1996, 1997, 1998, 1999, 2000, 2001, 2002
51      Free Software Foundation, Inc.
52
53 Permission is granted to copy, distribute and/or modify this document
54 under the terms of the GNU Free Documentation License, Version 1.1 or
55 any later version published by the Free Software Foundation; with the
56 Invariant Sections being none, with the Front-Cover texts being ``A GNU
57 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
58 license is included in the section entitled ``GNU Free Documentation
59 License'' in the Emacs manual.
60
61 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
62 this GNU Manual, like GNU software.  Copies published by the Free
63 Software Foundation raise funds for GNU development.''
64
65 This document is part of a collection distributed under the GNU Free
66 Documentation License.  If you want to distribute this document
67 separately from the collection, you can do so by adding a copy of the
68 license to the document, as described in section 6 of the license.
69 @end titlepage
70 @page
71
72 @end tex
73
74 @node Top
75 @top Message
76
77 All message composition from Gnus (both mail and news) takes place in
78 Message mode buffers.
79
80 @menu
81 * Interface::         Setting up message buffers.
82 * Commands::          Commands you can execute in message mode buffers.
83 * Variables::         Customizing the message buffers.
84 * Compatibility::     Making Message backwards compatible.
85 * Appendices::        More technical things.
86 * Index::             Variable, function and concept index.
87 * Key Index::         List of Message mode keys.
88 @end menu
89
90 This manual corresponds to T-gnus 6.15 Message.  Message is distributed
91 with the Gnus distribution bearing the same version number as this
92 manual.
93
94
95 @node Interface
96 @chapter Interface
97
98 When a program (or a person) wants to respond to a message -- reply,
99 follow up, forward, cancel -- the program (or person) should just put
100 point in the buffer where the message is and call the required command.
101 @code{Message} will then pop up a new @code{message} mode buffer with
102 appropriate headers filled out, and the user can edit the message before
103 sending it.
104
105 @menu
106 * New Mail Message::     Editing a brand new mail message.
107 * New News Message::     Editing a brand new news message.
108 * Reply::                Replying via mail.
109 * Wide Reply::           Responding to all people via mail.
110 * Followup::             Following up via news.
111 * Canceling News::       Canceling a news article.
112 * Superseding::          Superseding a message.
113 * Forwarding::           Forwarding a message via news or mail.
114 * Resending::            Resending a mail message.
115 * Bouncing::             Bouncing a mail message.
116 * Mailing Lists::        Send mail to mailing lists.
117 @end menu
118
119
120 @node New Mail Message
121 @section New Mail Message
122
123 @findex message-mail
124 The @code{message-mail} command pops up a new message buffer.
125
126 Two optional parameters are accepted: The first will be used as the
127 @code{To} header and the second as the @code{Subject} header.  If these
128 are @code{nil}, those two headers will be empty.
129
130
131 @node New News Message
132 @section New News Message
133
134 @findex message-news
135 The @code{message-news} command pops up a new message buffer.
136
137 This function accepts two optional parameters.  The first will be used
138 as the @code{Newsgroups} header and the second as the @code{Subject}
139 header.  If these are @code{nil}, those two headers will be empty.
140
141
142 @node Reply
143 @section Reply
144
145 @findex message-reply
146 The @code{message-reply} function pops up a message buffer that's a
147 reply to the message in the current buffer.
148
149 @vindex message-reply-to-function
150 Message uses the normal methods to determine where replies are to go
151 (@pxref{Responses}), but you can change the behavior to suit your needs
152 by fiddling with the @code{message-reply-to-function} variable.
153
154 If you want the replies to go to the @code{Sender} instead of the
155 @code{From}, you could do something like this:
156
157 @lisp
158 (setq message-reply-to-function
159       (lambda ()
160        (cond ((equal (mail-fetch-field "from") "somebody")
161                (list (cons 'To (mail-fetch-field "sender"))))
162              (t
163               nil))))
164 @end lisp
165
166 This function will be called narrowed to the head of the article that is
167 being replied to.
168
169 As you can see, this function should return a string if it has an
170 opinion as to what the To header should be.  If it does not, it should
171 just return @code{nil}, and the normal methods for determining the To
172 header will be used.
173
174 This function can also return a list.  In that case, each list element
175 should be a cons, where the car should be the name of an header
176 (eg. @code{Cc}) and the cdr should be the header value
177 (eg. @samp{larsi@@ifi.uio.no}).  All these headers will be inserted into
178 the head of the outgoing mail.
179
180
181 @node Wide Reply
182 @section Wide Reply
183
184 @findex message-wide-reply
185 The @code{message-wide-reply} pops up a message buffer that's a wide
186 reply to the message in the current buffer.  A @dfn{wide reply} is a
187 reply that goes out to all people listed in the @code{To}, @code{From}
188 (or @code{Reply-to}) and @code{Cc} headers.
189
190 @vindex message-wide-reply-to-function
191 Message uses the normal methods to determine where wide replies are to go,
192 but you can change the behavior to suit your needs by fiddling with the
193 @code{message-wide-reply-to-function}.  It is used in the same way as
194 @code{message-reply-to-function} (@pxref{Reply}).
195
196 @vindex message-dont-reply-to-names
197 Addresses that match the @code{message-dont-reply-to-names} regular
198 expression will be removed from the @code{Cc} header.
199
200 @vindex message-wide-reply-confirm-recipients
201 If @code{message-wide-reply-confirm-recipients} is non-@code{nil} you
202 will be asked to confirm that you want to reply to multiple
203 recipients.  The default is @code{nil}.
204
205 @node Followup
206 @section Followup
207
208 @findex message-followup
209 The @code{message-followup} command pops up a message buffer that's a
210 followup to the message in the current buffer.
211
212 @vindex message-followup-to-function
213 Message uses the normal methods to determine where followups are to go,
214 but you can change the behavior to suit your needs by fiddling with the
215 @code{message-followup-to-function}.  It is used in the same way as
216 @code{message-reply-to-function} (@pxref{Reply}).
217
218 @vindex message-use-followup-to
219 The @code{message-use-followup-to} variable says what to do about
220 @code{Followup-To} headers.  If it is @code{use}, always use the value.
221 If it is @code{ask} (which is the default), ask whether to use the
222 value.  If it is @code{t}, use the value unless it is @samp{poster}.  If
223 it is @code{nil}, don't use the value.
224
225
226 @node Canceling News
227 @section Canceling News
228
229 @findex message-cancel-news
230 The @code{message-cancel-news} command cancels the article in the
231 current buffer.
232
233 @vindex message-cancel-message
234 The value of @code{message-cancel-message} is inserted in the body of
235 the cancel message.  The default is @samp{I am canceling my own
236 article.}.
237
238
239 @node Superseding
240 @section Superseding
241
242 @findex message-supersede
243 The @code{message-supersede} command pops up a message buffer that will
244 supersede the message in the current buffer.
245
246 @vindex message-ignored-supersedes-headers
247 Headers matching the @code{message-ignored-supersedes-headers} are
248 removed before popping up the new message buffer.  The default is@*
249 @samp{^Path:\\|^Date\\|^NNTP-Posting-Host:\\|^Xref:\\|^Lines:\\|@*
250 ^Received:\\|^X-From-Line:\\|Return-Path:\\|^Supersedes:}.
251
252
253
254 @node Forwarding
255 @section Forwarding
256
257 @findex message-forward
258 The @code{message-forward} command pops up a message buffer to forward
259 the message in the current buffer.  If given a prefix, forward using
260 news.
261
262 @table @code
263 @item message-forward-ignored-headers
264 @vindex message-forward-ignored-headers
265 All headers that match this regexp will be deleted when forwarding a message.
266
267 @item message-make-forward-subject-function
268 @vindex message-make-forward-subject-function
269 A list of functions that are called to generate a subject header for
270 forwarded messages.  The subject generated by the previous function is
271 passed into each successive function.
272
273 The provided functions are:
274
275 @table @code
276 @item message-forward-subject-author-subject
277 @findex message-forward-subject-author-subject
278 Source of article (author or newsgroup), in brackets followed by the
279 subject.
280
281 @item message-forward-subject-fwd
282 Subject of article with @samp{Fwd:} prepended to it.
283 @end table
284
285 @item message-wash-forwarded-subjects
286 @vindex message-wash-forwarded-subjects
287 If this variable is @code{t}, the subjects of forwarded messages have
288 the evidence of previous forwards (such as @samp{Fwd:}, @samp{Re:},
289 @samp{(fwd)}) removed before the new subject is
290 constructed.  The default value is @code{nil}.
291
292 @item message-forward-as-mime
293 @vindex message-forward-as-mime
294 If this variable is @code{t} (the default), forwarded messages are
295 included as inline @sc{mime} RFC822 parts.  If it's @code{nil}, forwarded
296 messages will just be copied inline to the new message, like previous,
297 non @sc{mime}-savvy versions of gnus would do.
298
299 @item message-forward-before-signature
300 @vindex message-forward-before-signature
301 If non-@code{nil}, put forwarded message before signature, else after.
302
303 @end table
304
305
306 @node Resending
307 @section Resending
308
309 @findex message-resend
310 The @code{message-resend} command will prompt the user for an address
311 and resend the message in the current buffer to that address.
312
313 @vindex message-ignored-resent-headers
314 Headers that match the @code{message-ignored-resent-headers} regexp will
315 be removed before sending the message.  The default is
316 @samp{^Return-receipt}.
317
318
319 @node Bouncing
320 @section Bouncing
321
322 @findex message-bounce
323 The @code{message-bounce} command will, if the current buffer contains a
324 bounced mail message, pop up a message buffer stripped of the bounce
325 information.  A @dfn{bounced message} is typically a mail you've sent
326 out that has been returned by some @code{mailer-daemon} as
327 undeliverable.
328
329 @vindex message-ignored-bounced-headers
330 Headers that match the @code{message-ignored-bounced-headers} regexp
331 will be removed before popping up the buffer.  The default is
332 @samp{^\\(Received\\|Return-Path\\):}.
333
334
335 @node Mailing Lists
336 @section Mailing Lists
337
338 Sometimes while posting to mailing lists, the poster needs to direct
339 followups to the post to specific places.  The Mail-Followup-To (MFT)
340 was created to enable just this.  Two example scenarios where this is
341 useful:
342
343 @itemize @bullet
344 @item
345 A mailing list poster can use MFT to express that responses should be
346 sent to just the list, and not the poster as well.  This will happen
347 if the poster is already subscribed to the list.
348
349 @item
350 A mailing list poster can use MFT to express that responses should be
351 sent to the list and the poster as well.  This will happen if the poster
352 is not subscribed to the list.
353
354 @item
355 If a message is posted to several mailing lists, MFT may also be used
356 to direct the following discussion to one list only, because
357 discussions that are spread over several lists tend to be fragmented
358 and very difficult to follow.
359
360 @end itemize
361
362 Gnus honors the MFT header in other's messages (i.e. while following
363 up to someone else's post) and also provides support for generating
364 sensible MFT headers for outgoing messages as well.
365
366 @c @menu
367 @c * Honoring an MFT post::        What to do when one already exists
368 @c * Composing with a MFT header:: Creating one from scratch.
369 @c @end menu
370
371 @c @node Composing with a MFT header
372 @subsection  Composing a correct MFT header automagically
373
374 The first step in getting Gnus to automagically generate a MFT header
375 in posts you make is to give Gnus a list of the mailing lists
376 addresses you are subscribed to.  You can do this in more than one
377 way.  The following variables would come in handy.
378
379 @table @code
380
381 @vindex message-subscribed-addresses
382 @item message-subscribed-addresses
383 This should be a list of addresses the user is subscribed to.  Its
384 default value is @code{nil}.   Example:
385 @lisp
386 (setq message-subscribed-addresses
387       '("ding@@gnus.org" "bing@@noose.org"))
388 @end lisp
389
390 @vindex message-subscribed-regexps
391 @item message-subscribed-regexps
392 This should be a list of regexps denoting the addresses of mailing
393 lists subscribed to.  Default value is @code{nil}.  Example: If you
394 want to achieve the same result as above:
395 @lisp
396 (setq message-subscribed-regexps
397       '("\\(ding@@gnus\\)\\|\\(bing@@noose\\)\\.org")
398 @end lisp
399
400 @vindex message-subscribed-address-functions
401 @item message-subscribed-address-functions
402 This can be a list of functions to be called (one at a time!!) to
403 determine the value of MFT headers.  It is advisable that these
404 functions not take any arguments.  Default value is @code{nil}.
405
406 There is a pre-defined function in Gnus that is a good candidate for
407 this variable.  @code{gnus-find-subscribed-addresses} is a function
408 that returns a list of addresses corresponding to the groups that have
409 the @code{subscribed} (@pxref{(gnus)subscribed})
410 group parameter set to a non-nil value.  This is how you would do it.
411
412 @lisp
413 (setq message-subscribed-address-functions
414       '(gnus-find-subscribed-addresses))
415 @end lisp
416
417 @vindex message-subscribed-address-file
418 @item message-subscribed-address-file
419 You might be one organised human freak and have a list of addresses of
420 all subscribed mailing lists in a separate file!  Then you can just
421 set this variable to the name of the file and life would be good.
422
423 @end table
424
425 You can use one or more of the above variables.  All their values are
426 ``added'' in some way that works :-)
427
428 Now you are all set.  Just start composing a message as you normally do.
429 And just send it; as always.  Just before the message is sent out, Gnus'
430 MFT generation thingy kicks in and checks if the message already has a
431 MFT field.  If there is one, it is left alone.  (Except if it's empty -
432 in that case, the field is removed and is not replaced with an
433 automatically generated one.  This lets you disable MFT generation on a
434 per-message basis.)  If there is none, then the list of recipient
435 addresses (in the To: and Cc: headers) is checked to see if one of them
436 is a list address you are subscribed to.  If none of them is a list
437 address, then no MFT is generated; otherwise, a MFT is added to the
438 other headers and set to the value of all addresses in To: and Cc:
439
440 @kindex C-c C-f C-a
441 @findex message-gen-unsubscribed-mft
442 @kindex C-c C-f C-m
443 @findex message-goto-mail-followup-to
444 Hm. ``So'', you ask, ``what if I send an email to a list I am not
445 subscribed to?  I want my MFT to say that I want an extra copy.''
446 (This is supposed to be interpreted by others the same way as if there
447 were no MFT, but you can use an explicit MFT to override someone
448 else's to-address group parameter.)  The function
449 @code{message-gen-unsubscribed-mft} might come in handy.  It is bound
450 to @kbd{C-c C-f C-a} by default.  In any case, you can insert a MFT of
451 your own choice; @kbd{C-c C-f C-m}
452 (@code{message-goto-mail-followup-to}) will help you get started.
453
454 @c @node Honoring an MFT post
455 @subsection Honoring an MFT post
456
457 @vindex message-use-mail-followup-to
458 When you followup to a post on a mailing list, and the post has a MFT
459 header, Gnus' action will depend on the value of the variable
460 @code{message-use-mail-followup-to}.  This variable can be one of:
461
462 @table @code
463 @item use
464  Always honor MFTs.  The To: and Cc: headers in your followup will be
465  derived from the MFT header of the original post.  This is the default.
466
467 @item nil
468  Always dishonor MFTs (just ignore the darned thing)
469
470 @item ask
471 Gnus will prompt you for an action.
472
473 @end table
474
475 It is considered good nettiquette to honor MFT, as it is assumed the
476 fellow who posted a message knows where the followups need to go
477 better than you do.
478
479 @node Commands
480 @chapter Commands
481
482 @menu
483 * Buffer Entry::        Commands after entering a Message buffer.
484 * Header Commands::     Commands for moving to headers.
485 * Movement::            Moving around in message buffers.
486 * Insertion::           Inserting things into message buffers.
487 * MIME::                @sc{mime} considerations.
488 * Security::            Signing and encrypting messages.
489 * Various Commands::    Various things.
490 * Sending::             Actually sending the message.
491 * Mail Aliases::        How to use mail aliases.
492 * Spelling::            Having Emacs check your spelling.
493 @end menu
494
495
496 @node Buffer Entry
497 @section Buffer Entry
498 @cindex undo
499 @kindex C-_
500
501 You most often end up in a Message buffer when responding to some other
502 message of some sort.  Message does lots of handling of quoted text, and
503 may remove signatures, reformat the text, or the like---depending on
504 which used settings you're using.  Message usually gets things right,
505 but sometimes it stumbles.  To help the user unwind these stumblings,
506 Message sets the undo boundary before each major automatic action it
507 takes.  If you press the undo key (usually located at @kbd{C-_}) a few
508 times, you will get back the un-edited message you're responding to.
509
510
511 @node Header Commands
512 @section Header Commands
513
514 All these commands move to the header in question (except for the
515 @samp{Importance:} related commands).  If it doesn't exist, it will be
516 inserted.
517
518 @table @kbd
519
520 @item C-c ?
521 @kindex C-c ?
522 @findex describe-mode
523 Describe the message mode.
524
525 @item C-c C-f C-t
526 @kindex C-c C-f C-t
527 @findex message-goto-to
528 Go to the @code{To} header (@code{message-goto-to}).
529
530 @item C-c C-f C-o
531 @kindex C-c C-f C-o
532 @findex message-goto-from
533 Go to the @code{From} header (@code{message-goto-from}).  (The ``o''
534 in the key binding is for Originator.)
535
536 @item C-c C-f C-b
537 @kindex C-c C-f C-b
538 @findex message-goto-bcc
539 Go to the @code{Bcc} header (@code{message-goto-bcc}).
540
541 @item C-c C-f C-f
542 @kindex C-c C-f C-f
543 @findex message-goto-fcc
544 Go to the @code{Fcc} header (@code{message-goto-fcc}).
545
546 @item C-c C-f C-c
547 @kindex C-c C-f C-c
548 @findex message-goto-cc
549 Go to the @code{Cc} header (@code{message-goto-cc}).
550
551 @item C-c C-f C-s
552 @kindex C-c C-f C-s
553 @findex message-goto-subject
554 Go to the @code{Subject} header (@code{message-goto-subject}).
555
556 @item C-c C-f C-r
557 @kindex C-c C-f C-r
558 @findex message-goto-reply-to
559 Go to the @code{Reply-To} header (@code{message-goto-reply-to}).
560
561 @item C-c C-f C-n
562 @kindex C-c C-f C-n
563 @findex message-goto-newsgroups
564 Go to the @code{Newsgroups} header (@code{message-goto-newsgroups}).
565
566 @item C-c C-f C-d
567 @kindex C-c C-f C-d
568 @findex message-goto-distribution
569 Go to the @code{Distribution} header (@code{message-goto-distribution}).
570
571 @item C-c C-f C-o
572 @kindex C-c C-f C-o
573 @findex message-goto-followup-to
574 Go to the @code{Followup-To} header (@code{message-goto-followup-to}).
575
576 @item C-c C-f C-k
577 @kindex C-c C-f C-k
578 @findex message-goto-keywords
579 Go to the @code{Keywords} header (@code{message-goto-keywords}).
580
581 @item C-c C-f C-u
582 @kindex C-c C-f C-u
583 @findex message-goto-summary
584 Go to the @code{Summary} header (@code{message-goto-summary}).
585
586 @item C-c C-f C-i
587 @kindex C-c C-f C-i
588 @findex message-insert-or-toggle-importance
589 This inserts the @samp{Importance:} header with a value of
590 @samp{high}.  This header is used to signal the importance of the
591 message to the receiver.  If the header is already present in the
592 buffer, it cycles between the three valid values according to RFC
593 1376: @samp{low}, @samp{normal} and @samp{high}.
594
595 @item M-x message-insert-importance-high
596 @kindex M-x message-insert-importance-high
597 @findex message-insert-importance-high
598 Insert a @samp{Importance:} header with a value of @samp{high},
599 deleting headers if necessary.
600
601 @item M-x message-insert-importance-low
602 @kindex M-x message-insert-importance-low
603 @findex message-insert-importance-low
604 Insert a @samp{Importance:} header with a value of @samp{low},
605 deleting headers if necessary.
606
607 @end table
608
609
610 @node Movement
611 @section Movement
612
613 @table @kbd
614 @item C-c C-b
615 @kindex C-c C-b
616 @findex message-goto-body
617 Move to the beginning of the body of the message
618 (@code{message-goto-body}).
619
620 @item C-c C-i
621 @kindex C-c C-i
622 @findex message-goto-signature
623 Move to the signature of the message (@code{message-goto-signature}).
624
625 @item C-a
626 @kindex C-a
627 @findex message-beginning-of-line
628 @vindex message-beginning-of-line
629 If at beginning of header value, go to beginning of line, else go to
630 beginning of header value.  (The header value comes after the header
631 name and the colon.)  This behaviour can be disabled by toggling
632 the variable @code{message-beginning-of-line}.
633
634 @end table
635
636
637 @node Insertion
638 @section Insertion
639
640 @table @kbd
641
642 @item C-c C-y
643 @kindex C-c C-y
644 @findex message-yank-original
645 Yank the message in the buffer @code{gnus-article-copy} into the message
646 buffer.  Normally @code{gnus-article-copy} is what you are replying to
647 (@code{message-yank-original}).
648
649 @item C-c C-M-y
650 @kindex C-c C-M-y
651 @findex message-yank-buffer
652 Prompt for a buffer name and yank the contents of that buffer into the
653 message buffer (@code{message-yank-buffer}).
654
655 @item C-c C-q
656 @kindex C-c C-q
657 @findex message-fill-yanked-message
658 Fill the yanked message (@code{message-fill-yanked-message}).  Warning:
659 Can severely mess up the yanked text if its quoting conventions are
660 strange.  You'll quickly get a feel for when it's safe, though.  Anyway,
661 just remember that @kbd{C-x u} (@code{undo}) is available and you'll be
662 all right.
663
664 @item C-c C-w
665 @kindex C-c C-w
666 @findex message-insert-signature
667 Insert a signature at the end of the buffer
668 (@code{message-insert-signature}).
669
670 @item C-c M-h
671 @kindex C-c M-h
672 @findex message-insert-headers
673 Insert the message headers (@code{message-insert-headers}).
674
675 @item C-c M-n
676 @kindex C-c M-n
677 @findex message-insert-disposition-notification-to
678 Insert a request for a disposition
679 notification. (@code{message-insert-disposition-notification-to}).
680 This means that if the recipient support RFC 2298 she might send you a
681 notification that she received the message.
682
683 @end table
684
685
686 @node MIME
687 @section MIME
688 @cindex MML
689 @cindex MIME
690 @cindex multipart
691 @cindex attachment
692
693 Message is a @sc{mime}-compliant posting agent.  The user generally
694 doesn't have to do anything to make the @sc{mime} happen---Message will
695 automatically add the @code{Content-Type} and
696 @code{Content-Transfer-Encoding} headers.
697
698 The most typical thing users want to use the multipart things in
699 @sc{mime} for is to add ``attachments'' to mail they send out.  This can
700 be done with the @kbd{C-c C-a} command, which will prompt for a file
701 name and a @sc{mime} type.
702
703 You can also create arbitrarily complex multiparts using the MML
704 language (@pxref{Composing, , Composing, emacs-mime, The Emacs MIME
705 Manual}).
706
707 @node Security
708 @section Security
709 @cindex Security
710 @cindex S/MIME
711 @cindex PGP
712 @cindex PGP/MIME
713 @cindex sign
714 @cindex encrypt
715 @cindex secure
716
717 Using the MML language, Message is able to create digitally signed and
718 digitally encrypted messages.  Message (or rather MML) currently
719 support PGP (RFC 1991), @sc{pgp/mime} (RFC 2015/3156) and @sc{s/mime}.
720 Instructing MML to perform security operations on a @sc{mime} part is
721 done using the @kbd{C-c C-m s} key map for signing and the @kbd{C-c
722 C-m c} key map for encryption, as follows.
723
724 @table @kbd
725
726 @item C-c C-m s s
727 @kindex C-c C-m s s
728 @findex mml-secure-message-sign-smime
729
730 Digitally sign current message using @sc{s/mime}.
731
732 @item C-c C-m s o
733 @kindex C-c C-m s o
734 @findex mml-secure-message-sign-pgp
735
736 Digitally sign current message using PGP.
737
738 @item C-c C-m s p
739 @kindex C-c C-m s p
740 @findex mml-secure-message-sign-pgpmime
741
742 Digitally sign current message using @sc{pgp/mime}.
743
744 @item C-c C-m c s
745 @kindex C-c C-m c s
746 @findex mml-secure-message-encrypt-smime
747
748 Digitally encrypt current message using @sc{s/mime}.
749
750 @item C-c C-m c o
751 @kindex C-c C-m c o
752 @findex mml-secure-message-encrypt-pgp
753
754 Digitally encrypt current message using PGP.
755
756 @item C-c C-m c p
757 @kindex C-c C-m c p
758 @findex mml-secure-message-encrypt-pgpmime
759
760 Digitally encrypt current message using @sc{pgp/mime}.
761
762 @item C-c C-m C-n
763 @kindex C-c C-m C-n
764 @findex mml-unsecure-message
765 Remove security related MML tags from message.
766
767 @end table
768
769 These commands do not immediately sign or encrypt the message, they
770 merely insert the proper MML secure tag to instruct the MML engine to
771 perform that operation when the message is actually sent. They may
772 perform other operations too, such as locating and retrieving a
773 @sc{s/mime} certificate of the person you wish to send encrypted mail
774 to.  When the mml parsing engine converts your MML into a properly
775 encoded @sc{mime} message, the secure tag will be replaced with either
776 a part or a multipart tag.  If your message contains other mml parts,
777 a multipart tag will be used; if no other parts are present in your
778 message a single part tag will be used.  This way, message mode will
779 do the Right Thing (TM) with signed/encrypted multipart messages.
780
781 @vindex mml-signencrypt-style-alist
782 By default, when encrypting a message, Gnus will use the "signencrypt"
783 mode.  If you would like to disable this for a particular message,
784 give the mml-secure-message-encrypt-* command a prefix argument. (for
785 example, C-u C-c C-m c p).  Additionally, by default Gnus will
786 separately sign, then encrypt a message which has the mode
787 signencrypt.  If you would like to change this behavior you can
788 customize the @code{mml-signencrypt-style-alist} variable.  For
789 example:
790
791
792 @lisp
793 (setq mml-signencrypt-style-alist '(("smime" combined)
794                                     ("pgp" combined)
795                                     ("pgpmime" combined)))
796 @end lisp
797
798 Will cause Gnus to sign and encrypt in one pass, thus generating a
799 single signed and encrypted part.  Note that combined sign and encrypt
800 does not work with all supported OpenPGP implementations (in
801 particular, PGP version 2 do not support this).
802
803 Since signing and especially encryption often is used when sensitive
804 information is sent, you may want to have some way to ensure that your
805 mail is actually signed or encrypted.  After invoking the above
806 sign/encrypt commands, it is possible to preview the raw article by
807 using @kbd{C-u C-c RET P} (@code{mml-preview}).  Then you can
808 verify that your long rant about what your ex-significant other or
809 whomever actually did with that funny looking person at that strange
810 party the other night, actually will be sent encrypted.
811
812 @emph{Note!}  Neither @sc{pgp/mime} nor @sc{s/mime} encrypt/signs
813 RFC822 headers.  They only operate on the @sc{mime} object.  Keep this
814 in mind before sending mail with a sensitive Subject line.
815
816 Actually using the security commands above is not very difficult.  At
817 least not compared with making sure all involved programs talk with each
818 other properly.  Thus, we now describe what external libraries or
819 programs are required to make things work, and some small general hints.
820
821 @subsection Using S/MIME
822
823 @emph{Note!}  This section assume you have a basic familiarity with
824 modern cryptography, @sc{s/mime}, various PKCS standards, OpenSSL and
825 so on.
826
827 The @sc{s/mime} support in Message (and MML) require OpenSSL.  OpenSSL
828 perform the actual @sc{s/mime} sign/encrypt operations.  OpenSSL can
829 be found at @uref{http://www.openssl.org/}.  OpenSSL 0.9.6 and later
830 should work.  Version 0.9.5a cannot extract mail addresses from
831 certificates, and it insert a spurious CR character into @sc{mime}
832 separators so you may wish to avoid it if you would like to avoid
833 being regarded as someone who send strange mail. (Although by sending
834 @sc{s/mime} messages you've probably already lost that contest.)
835
836 To be able to send encrypted mail, a personal certificate is not
837 required.  Message (MML) need a certificate for the person to whom you
838 wish to communicate with though.  You're asked for this when you type
839 @kbd{C-c C-m c s}.  Currently there are two ways to retrieve this
840 certificate, from a local file or from DNS.  If you chose a local
841 file, it need to contain a X.509 certificate in PEM format.  If you
842 chose DNS, you're asked for the domain name where the certificate is
843 stored, the default is a good guess.  To my belief, Message (MML) is
844 the first mail agent in the world to support retrieving @sc{s/mime}
845 certificates from DNS, so you're not likely to find very many
846 certificates out there.  At least there should be one, stored at the
847 domain @code{simon.josefsson.org}.  LDAP is a more popular method of
848 distributing certificates, support for it is planned.  (Meanwhile, you
849 can use @code{ldapsearch} from the command line to retrieve a
850 certificate into a file and use it.)
851
852 As for signing messages, OpenSSL can't perform signing operations
853 without some kind of configuration.  Especially, you need to tell it
854 where your private key and your certificate is stored.  MML uses an
855 Emacs interface to OpenSSL, aptly named @code{smime.el}, and it
856 contain a @code{custom} group used for this configuration.  So, try
857 @kbd{M-x customize-group RET smime RET} and look around.
858
859 Currently there is no support for talking to a CA (or RA) to create
860 your own certificate.  None is planned either.  You need to do this
861 manually with OpenSSL or using some other program.  I used Netscape
862 and got a free @sc{s/mime} certificate from one of the big CA's on the
863 net.  Netscape is able to export your private key and certificate in
864 PKCS #12 format.  Use OpenSSL to convert this into a plain X.509
865 certificate in PEM format as follows.
866
867 @example
868 $ openssl pkcs12 -in ns.p12 -clcerts -nodes > key+cert.pem
869 @end example
870
871 The @file{key+cert.pem} file should be pointed to from the
872 @code{smime-keys} variable.  You should now be able to send signed mail.
873
874 @emph{Note!}  Your private key is store unencrypted in the file, so take
875 care in handling it.
876
877 @subsection Using PGP/MIME
878
879 @sc{pgp/mime} requires an external OpenPGP implementation, such as GNU
880 Privacy Guard (@uref{http://www.gnupg.org/}).  It also requires an
881 Emacs interface to it, such as Mailcrypt (available from
882 @uref{http://www.nb.net/~lbudney/linux/software/mailcrypt.html}) or
883 Florian Weimer's @code{gpg.el}.
884
885 @vindex gpg-temp-directory
886 Note, if you are using the @code{gpg.el} you must make sure that the
887 path specified by @code{gpg-temp-directory} have permissions 0700.
888
889 Creating your own OpenPGP key is described in detail in the
890 documentation of your OpenPGP implementation, so we refer to it.
891
892 @node Various Commands
893 @section Various Commands
894
895 @table @kbd
896
897 @item C-c C-r
898 @kindex C-c C-r
899 @findex message-caesar-buffer-body
900 Caesar rotate (aka. rot13) the current message
901 (@code{message-caesar-buffer-body}).  If narrowing is in effect, just
902 rotate the visible portion of the buffer.  A numerical prefix says how
903 many places to rotate the text.  The default is 13.
904
905 @item C-c C-e
906 @kindex C-c C-e
907 @findex message-elide-region
908 @vindex message-elide-ellipsis
909 Elide the text between point and mark (@code{message-elide-region}).
910 The text is killed and replaced with the contents of the variable
911 @code{message-elide-ellipsis}. The default value is to use an ellipsis
912 (@samp{[...]}).
913
914 @item C-c C-z
915 @kindex C-c C-x
916 @findex message-kill-to-signature
917 Kill all the text up to the signature, or if that's missing, up to the
918 end of the message (@code{message-kill-to-signature}).
919
920 @item C-c C-v
921 @kindex C-c C-v
922 @findex message-delete-not-region
923 Delete all text in the body of the message that is outside the region
924 (@code{message-delete-not-region}).
925
926 @item M-RET
927 @kindex M-RET
928 @findex message-newline-and-reformat
929 Insert four newlines, and then reformat if inside quoted text.
930
931 Here's an example:
932
933 @example
934 > This is some quoted text.  And here's more quoted text.
935 @end example
936
937 If point is before @samp{And} and you press @kbd{M-RET}, you'll get:
938
939 @example
940 > This is some quoted text.
941
942 *
943
944 > And here's more quoted text.
945 @end example
946
947 @samp{*} says where point will be placed.
948
949 @item C-c C-t
950 @kindex C-c C-t
951 @findex message-insert-to
952 Insert a @code{To} header that contains the @code{Reply-To} or
953 @code{From} header of the message you're following up
954 (@code{message-insert-to}).
955
956 @item C-c C-n
957 @kindex C-c C-n
958 @findex message-insert-newsgroups
959 Insert a @code{Newsgroups} header that reflects the @code{Followup-To}
960 or @code{Newsgroups} header of the article you're replying to
961 (@code{message-insert-newsgroups}).
962
963 @item C-c C-o
964 @kindex C-c C-o
965 @findex message-sort-headers
966 @vindex message-header-format-alist
967 Sort headers according to @code{message-header-format-alist}
968 (@code{message-sort-headers}).
969
970 @item C-c M-r
971 @kindex C-c M-r
972 @findex message-rename-buffer
973 Rename the buffer (@code{message-rename-buffer}).  If given a prefix,
974 prompt for a new buffer name.
975
976 @end table
977
978
979 @node Sending
980 @section Sending
981
982 @table @kbd
983 @item C-c C-c
984 @kindex C-c C-c
985 @findex message-send-and-exit
986 Send the message and bury the current buffer
987 (@code{message-send-and-exit}).
988
989 @item C-c C-s
990 @kindex C-c C-s
991 @findex message-send
992 Send the message (@code{message-send}).
993
994 @item C-c C-d
995 @kindex C-c C-d
996 @findex message-dont-send
997 Bury the message buffer and exit (@code{message-dont-send}).
998
999 @item C-c C-k
1000 @kindex C-c C-k
1001 @findex message-kill-buffer
1002 Kill the message buffer and exit (@code{message-kill-buffer}).  It will
1003 delete the message frame if it has been created exclusively for the
1004 message buffer.  If the option
1005 @code{message-kill-buffer-and-remove-file} is non-@code{nil} and the
1006 backup file has been created for the message buffer, it will also remove
1007 the file after prompting to the user.
1008
1009 @item C-x k
1010 @kindex C-x k
1011 @findex message-mimic-kill-buffer
1012 @vindex message-kill-buffer-and-remove-file
1013 This is an imitation for @code{kill-buffer}
1014 (@code{message-mimic-kill-buffer}).  It dynamically binds the variable
1015 @code{message-kill-buffer-and-remove-file} to @code{nil} and calls the
1016 function @code{message-kill-buffer}.
1017
1018 @end table
1019
1020
1021
1022 @node Mail Aliases
1023 @section Mail Aliases
1024 @cindex mail aliases
1025 @cindex aliases
1026
1027 @vindex message-mail-alias-type
1028 The @code{message-mail-alias-type} variable controls what type of mail
1029 alias expansion to use.  Currently only one form is supported---Message
1030 uses @code{mailabbrev} to handle mail aliases.  If this variable is
1031 @code{nil}, no mail alias expansion will be performed.
1032
1033 @code{mailabbrev} works by parsing the @file{/etc/mailrc} and
1034 @file{~/.mailrc} files.  These files look like:
1035
1036 @example
1037 alias lmi "Lars Magne Ingebrigtsen <larsi@@ifi.uio.no>"
1038 alias ding "ding@@ifi.uio.no (ding mailing list)"
1039 @end example
1040
1041 After adding lines like this to your @file{~/.mailrc} file, you should
1042 be able to just write @samp{lmi} in the @code{To} or @code{Cc} (and so
1043 on) headers and press @kbd{SPC} to expand the alias.
1044
1045 No expansion will be performed upon sending of the message---all
1046 expansions have to be done explicitly.
1047
1048
1049 @node Spelling
1050 @section Spelling
1051 @cindex spelling
1052 @findex ispell-message
1053
1054 There are two popular ways to have Emacs spell-check your messages:
1055 @code{ispell} and @code{flyspell}.  @code{ispell} is the older and
1056 probably more popular package.  You typically first write the message,
1057 and then run the entire thing through @code{ispell} and fix all the
1058 typos.  To have this happen automatically when you send a message, put
1059 something like the following in your @file{.emacs} file:
1060
1061 @lisp
1062 (add-hook 'message-send-hook 'ispell-message)
1063 @end lisp
1064
1065 @vindex ispell-message-dictionary-alist
1066 If you're in the habit of writing in different languages, this can be
1067 controlled by the @code{ispell-message-dictionary-alist} variable:
1068
1069 @lisp
1070 (setq ispell-message-dictionary-alist
1071       '(("^Newsgroups:.*\\bde\\." . "deutsch8")
1072         (".*" . "default")))
1073 @end lisp
1074
1075 @code{ispell} depends on having the external @samp{ispell} command
1076 installed.
1077
1078 The other popular method is using @code{flyspell}.  This package checks
1079 your spelling while you're writing, and marks any mis-spelled words in
1080 various ways.
1081
1082 To use @code{flyspell}, put something like the following in your
1083 @file{.emacs} file:
1084
1085 @lisp
1086 (defun my-message-setup-routine ()
1087   (flyspell-mode 1))
1088 (add-hook 'message-setup-hook 'my-message-setup-routine)
1089 @end lisp
1090
1091 @code{flyspell} depends on having the external @samp{ispell} command
1092 installed.
1093
1094
1095 @node Variables
1096 @chapter Variables
1097
1098 @menu
1099 * Message Headers::             General message header stuff.
1100 * Mail Headers::                Customizing mail headers.
1101 * Mail Variables::              Other mail variables.
1102 * News Headers::                Customizing news headers.
1103 * News Variables::              Other news variables.
1104 * Insertion Variables::         Customizing how things are inserted.
1105 * Various Message Variables::   Other message variables.
1106 * Sending Variables::           Variables for sending.
1107 * Message Buffers::             How Message names its buffers.
1108 * Message Actions::             Actions to be performed when exiting.
1109 @end menu
1110
1111
1112 @node Message Headers
1113 @section Message Headers
1114
1115 Message is quite aggressive on the message generation front.  It has to
1116 be -- it's a combined news and mail agent.  To be able to send combined
1117 messages, it has to generate all headers itself (instead of letting the
1118 mail/news system do it) to ensure that mail and news copies of messages
1119 look sufficiently similar.
1120
1121 @table @code
1122
1123 @item message-generate-headers-first
1124 @vindex message-generate-headers-first
1125 If non-@code{nil}, generate all required headers before starting to
1126 compose the message.
1127
1128 The variables @code{message-required-mail-headers} and
1129 @code{message-required-news-headers} specify which headers are required.
1130
1131 Note that some headers will be removed and re-generated before posting,
1132 because of the variable @code{message-deletable-headers} (see below).
1133
1134 @item message-from-style
1135 @vindex message-from-style
1136 Specifies how @code{From} headers should look.  There are four valid
1137 values:
1138
1139 @table @code
1140 @item nil
1141 Just the address -- @samp{king@@grassland.com}.
1142
1143 @item parens
1144 @samp{king@@grassland.com (Elvis Parsley)}.
1145
1146 @item angles
1147 @samp{Elvis Parsley <king@@grassland.com>}.
1148
1149 @item default
1150 Look like @code{angles} if that doesn't require quoting, and
1151 @code{parens} if it does.  If even @code{parens} requires quoting, use
1152 @code{angles} anyway.
1153
1154 @end table
1155
1156 @item message-deletable-headers
1157 @vindex message-deletable-headers
1158 Headers in this list that were previously generated by Message will be
1159 deleted before posting.  Let's say you post an article.  Then you decide
1160 to post it again to some other group, you naughty boy, so you jump back
1161 to the @code{*post-buf*} buffer, edit the @code{Newsgroups} line, and
1162 ship it off again.  By default, this variable makes sure that the old
1163 generated @code{Message-ID} is deleted, and a new one generated.  If
1164 this isn't done, the entire empire would probably crumble, anarchy would
1165 prevail, and cats would start walking on two legs and rule the world.
1166 Allegedly.
1167
1168 @item message-default-headers
1169 @vindex message-default-headers
1170 This string is inserted at the end of the headers in all message
1171 buffers.
1172
1173 @item message-subject-re-regexp
1174 @vindex message-subject-re-regexp
1175 @cindex Aw
1176 @cindex Sv
1177 @cindex Re
1178 Responses to messages have subjects that start with @samp{Re: }.  This
1179 is @emph{not} an abbreviation of the English word ``response'', but is
1180 Latin, and means ``in response to''.  Some illiterate nincompoops have
1181 failed to grasp this fact, and have ``internationalized'' their software
1182 to use abonimations like @samp{Aw: } (``antwort'') or @samp{Sv: }
1183 (``svar'') instead, which is meaningless and evil.  However, you may
1184 have to deal with users that use these evil tools, in which case you may
1185 set this variable to a regexp that matches these prefixes.  Myself, I
1186 just throw away non-compliant mail.
1187
1188 Here's an example of a value to deal with these headers when
1189 responding to a message:
1190
1191 @lisp
1192 (setq message-subject-re-regexp
1193      "^\\(\\(\\([Rr][Ee]\\|[Ss][Vv]\\|[Aa][Ww]\\): *\\)+\\)")
1194 @end lisp
1195
1196 @item message-alternative-emails
1197 @vindex message-alternative-emails
1198 A regexp to match the alternative email addresses.  The first matched
1199 address (not primary one) is used in the @code{From} field.
1200
1201 @end table
1202
1203
1204 @node Mail Headers
1205 @section Mail Headers
1206
1207 @table @code
1208 @item message-required-mail-headers
1209 @vindex message-required-mail-headers
1210 @xref{News Headers}, for the syntax of this variable.  It is
1211 @code{(From Date Subject (optional . In-Reply-To) Message-ID Lines
1212 (optional . User-Agent))} by default.
1213
1214 @item message-ignored-mail-headers
1215 @vindex message-ignored-mail-headers
1216 Regexp of headers to be removed before mailing.  The default is
1217 @samp{^[GF]cc:\\|^Resent-Fcc:\\|^Xref:\\|^X-Draft-From:}.
1218
1219 @item message-default-mail-headers
1220 @vindex message-default-mail-headers
1221 This string is inserted at the end of the headers in all message
1222 buffers that are initialized as mail.
1223
1224 @end table
1225
1226
1227 @node Mail Variables
1228 @section Mail Variables
1229
1230 @table @code
1231 @item message-send-mail-function
1232 @vindex message-send-mail-function
1233 @findex message-send-mail-with-sendmail
1234 @findex message-send-mail-with-mh
1235 @findex message-send-mail-with-qmail
1236 @findex message-smtpmail-send-it
1237 @findex smtpmail-send-it
1238 @findex feedmail-send-it
1239 Function used to send the current buffer as mail. The default is
1240 @code{message-send-mail-with-sendmail}. Other valid values include
1241 @code{message-send-mail-with-mh}, @code{message-send-mail-with-qmail},
1242 @code{message-smtpmail-send-it}, @code{smtpmail-send-it} and
1243 @code{feedmail-send-it}.
1244
1245 @item message-mh-deletable-headers
1246 @vindex message-mh-deletable-headers
1247 Most versions of MH doesn't like being fed messages that contain the
1248 headers in this variable.  If this variable is non-@code{nil} (which is
1249 the default), these headers will be removed before mailing when sending
1250 messages via MH.  Set it to @code{nil} if your MH can handle these
1251 headers.
1252
1253 @item message-qmail-inject-program
1254 @vindex message-qmail-inject-program
1255 @cindex qmail
1256 Location of the qmail-inject program.
1257
1258 @item message-qmail-inject-args
1259 @vindex message-qmail-inject-args
1260 Arguments passed to qmail-inject programs.
1261 This should be a list of strings, one string for each argument.  It
1262 may also be a function.
1263
1264 For e.g., if you wish to set the envelope sender address so that bounces
1265 go to the right place or to deal with listserv's usage of that address, you
1266 might set this variable to @code{'("-f" "you@@some.where")}.
1267
1268 @item message-sendmail-f-is-evil
1269 @vindex message-sendmail-f-is-evil
1270 @cindex sendmail
1271 Non-@code{nil} means don't add @samp{-f username} to the sendmail
1272 command line.  Doing so would be even more evil than leaving it out.
1273
1274 @item message-mailer-swallows-blank-line
1275 @vindex message-mailer-swallows-blank-line
1276 Set this to non-@code{nil} if the system's mailer runs the header and
1277 body together.  (This problem exists on Sunos 4 when sendmail is run
1278 in remote mode.)  The value should be an expression to test whether
1279 the problem will actually occur.
1280
1281 @item message-send-mail-partially-limit
1282 @vindex message-send-mail-partially-limit
1283 The limitation of messages sent as message/partial.
1284 The lower bound of message size in characters, beyond which the message
1285 should be sent in several parts. If it is nil, the size is unlimited.
1286
1287 @end table
1288
1289
1290 @node News Headers
1291 @section News Headers
1292
1293 @vindex message-required-news-headers
1294 @code{message-required-news-headers} a list of header symbols.  These
1295 headers will either be automatically generated, or, if that's
1296 impossible, they will be prompted for.  The following symbols are valid:
1297
1298 @table @code
1299
1300 @item From
1301 @cindex From
1302 @findex user-full-name
1303 @findex user-mail-address
1304 This required header will be filled out with the result of the
1305 @code{message-make-from} function, which depends on the
1306 @code{message-from-style}, @code{user-full-name},
1307 @code{user-mail-address} variables.
1308
1309 @item Subject
1310 @cindex Subject
1311 This required header will be prompted for if not present already.
1312
1313 @item Newsgroups
1314 @cindex Newsgroups
1315 This required header says which newsgroups the article is to be posted
1316 to.  If it isn't present already, it will be prompted for.
1317
1318 @item Organization
1319 @cindex organization
1320 @vindex message-user-organization
1321 @vindex message-user-organization-file
1322 This optional header will be filled out depending on the
1323 @code{message-user-organization} variable.
1324 @code{message-user-organization-file} will be used if this variable is
1325 @code{t}.  This variable can also be a string (in which case this string
1326 will be used), or it can be a function (which will be called with no
1327 parameters and should return a string to be used).
1328
1329 @item Lines
1330 @cindex Lines
1331 This optional header will be computed by Message.
1332
1333 @item Message-ID
1334 @cindex Message-ID
1335 @vindex mail-host-address
1336 @findex system-name
1337 @cindex Sun
1338 This required header will be generated by Message.  A unique ID will be
1339 created based on the date, time, user name and system name.  Message
1340 will use @code{system-name} to determine the name of the system.  If
1341 this isn't a fully qualified domain name (FQDN), Message will use
1342 @code{mail-host-address} as the FQDN of the machine.
1343
1344 @item User-Agent
1345 @cindex User-Agent
1346 This optional header will be filled out according to the
1347 @code{message-newsreader} local variable.
1348
1349 @item In-Reply-To
1350 This optional header is filled out using the @code{Date} and @code{From}
1351 header of the article being replied to.
1352
1353 @item Expires
1354 @cindex Expires
1355 @vindex message-expires
1356 This extremely optional header will be inserted according to the
1357 @code{message-expires} variable.  It is highly deprecated and shouldn't
1358 be used unless you know what you're doing.
1359
1360 @item Distribution
1361 @cindex Distribution
1362 @vindex message-distribution-function
1363 This optional header is filled out according to the
1364 @code{message-distribution-function} variable.  It is a deprecated and
1365 much misunderstood header.
1366
1367 @item Path
1368 @cindex path
1369 @vindex message-user-path
1370 This extremely optional header should probably never be used.
1371 However, some @emph{very} old servers require that this header is
1372 present.  @code{message-user-path} further controls how this
1373 @code{Path} header is to look.  If it is @code{nil}, use the server name
1374 as the leaf node.  If it is a string, use the string.  If it is neither
1375 a string nor @code{nil}, use the user name only.  However, it is highly
1376 unlikely that you should need to fiddle with this variable at all.
1377 @end table
1378
1379 @findex yow
1380 @cindex Mime-Version
1381 In addition, you can enter conses into this list.  The car of this cons
1382 should be a symbol.  This symbol's name is the name of the header, and
1383 the cdr can either be a string to be entered verbatim as the value of
1384 this header, or it can be a function to be called.  This function should
1385 return a string to be inserted.  For instance, if you want to insert
1386 @code{Mime-Version: 1.0}, you should enter @code{(Mime-Version . "1.0")}
1387 into the list.  If you want to insert a funny quote, you could enter
1388 something like @code{(X-Yow . yow)} into the list.  The function
1389 @code{yow} will then be called without any arguments.
1390
1391 If the list contains a cons where the car of the cons is
1392 @code{optional}, the cdr of this cons will only be inserted if it is
1393 non-@code{nil}.
1394
1395 If you want to delete an entry from this list, the following Lisp
1396 snippet might be useful.  Adjust accordingly if you want to remove
1397 another element.
1398
1399 @lisp
1400 (setq message-required-news-headers
1401       (delq 'Message-ID message-required-news-headers))
1402 @end lisp
1403
1404 Other variables for customizing outgoing news articles:
1405
1406 @table @code
1407
1408 @item message-syntax-checks
1409 @vindex message-syntax-checks
1410 Controls what syntax checks should not be performed on outgoing posts.
1411 To disable checking of long signatures, for instance, add
1412
1413 @lisp
1414 (signature . disabled)
1415 @end lisp
1416
1417 to this list.
1418
1419 Valid checks are:
1420
1421 @table @code
1422 @item subject-cmsg
1423 Check the subject for commands.
1424 @item sender
1425 @cindex Sender
1426 Insert a new @code{Sender} header if the @code{From} header looks odd.
1427 @item multiple-headers
1428 Check for the existence of multiple equal headers.
1429 @item sendsys
1430 @cindex sendsys
1431 Check for the existence of version and sendsys commands.
1432 @item message-id
1433 Check whether the @code{Message-ID} looks ok.
1434 @item from
1435 Check whether the @code{From} header seems nice.
1436 @item long-lines
1437 @cindex long lines
1438 Check for too long lines.
1439 @item control-chars
1440 Check for invalid characters.
1441 @item size
1442 Check for excessive size.
1443 @item new-text
1444 Check whether there is any new text in the messages.
1445 @item signature
1446 Check the length of the signature.
1447 @item approved
1448 @cindex approved
1449 Check whether the article has an @code{Approved} header, which is
1450 something only moderators should include.
1451 @item empty
1452 Check whether the article is empty.
1453 @item invisible-text
1454 Check whether there is any invisible text in the buffer.
1455 @item empty-headers
1456 Check whether any of the headers are empty.
1457 @item existing-newsgroups
1458 Check whether the newsgroups mentioned in the @code{Newsgroups} and
1459 @code{Followup-To} headers exist.
1460 @item valid-newsgroups
1461 Check whether the @code{Newsgroups} and @code{Followup-to} headers
1462 are valid syntactically.
1463 @item repeated-newsgroups
1464 Check whether the @code{Newsgroups} and @code{Followup-to} headers
1465 contains repeated group names.
1466 @item shorten-followup-to
1467 Check whether to add a @code{Followup-to} header to shorten the number
1468 of groups to post to.
1469 @end table
1470
1471 All these conditions are checked by default.
1472
1473 @item message-ignored-news-headers
1474 @vindex message-ignored-news-headers
1475 Regexp of headers to be removed before posting.  The default is@*
1476 @samp{^NNTP-Posting-Host:\\|^Xref:\\|^[BGF]cc:\\|^Resent-Fcc:\\|^X-Draft-From:}.
1477
1478 @item message-default-news-headers
1479 @vindex message-default-news-headers
1480 This string is inserted at the end of the headers in all message
1481 buffers that are initialized as news.
1482
1483 @end table
1484
1485
1486 @node News Variables
1487 @section News Variables
1488
1489 @table @code
1490 @item message-send-news-function
1491 @vindex message-send-news-function
1492 Function used to send the current buffer as news.  The default is
1493 @code{message-send-news}.
1494
1495 @item message-post-method
1496 @vindex message-post-method
1497 Gnusish @dfn{select method} (see the Gnus manual for details) used for
1498 posting a prepared news message.
1499
1500 @end table
1501
1502
1503 @node Insertion Variables
1504 @section Insertion Variables
1505
1506 @table @code
1507 @item message-ignored-cited-headers
1508 @vindex message-ignored-cited-headers
1509 All headers that match this regexp will be removed from yanked
1510 messages.  The default is @samp{.}, which means that all headers will be
1511 removed.
1512
1513 @item message-cite-prefix-regexp
1514 @vindex message-cite-prefix-regexp
1515 Regexp matching the longest possible citation prefix on a line.
1516
1517 @item message-citation-line-function
1518 @vindex message-citation-line-function
1519 @cindex attribution line
1520 Function called to insert the citation line.  The default is
1521 @code{message-insert-citation-line}, which will lead to citation lines
1522 that look like:
1523
1524 @example
1525 Hallvard B Furuseth <h.b.furuseth@@usit.uio.no> writes:
1526 @end example
1527
1528 Point will be at the beginning of the body of the message when this
1529 function is called.
1530
1531 Note that Gnus provides a feature where clicking on `writes:' hides the
1532 cited text.  If you change the citation line too much, readers of your
1533 messages will have to adjust their Gnus, too.  See the variable
1534 @code{gnus-cite-attribution-suffix}.  @xref{Article Highlighting, ,
1535 Article Highlighting, gnus}, for details.
1536
1537 @item message-yank-prefix
1538 @vindex message-yank-prefix
1539 @cindex yanking
1540 @cindex quoting
1541 When you are replying to or following up an article, you normally want
1542 to quote the person you are answering.  Inserting quoted text is done
1543 by @dfn{yanking}, and each line you yank will have
1544 @code{message-yank-prefix} prepended to it (except for quoted and
1545 empty lines which uses @code{message-yank-cited-prefix}). The default
1546 is @samp{> }.
1547
1548 @item message-yank-cited-prefix
1549 @vindex message-yank-cited-prefix
1550 @cindex yanking
1551 @cindex cited
1552 @cindex quoting
1553 When yanking text from a article which contains no text or already
1554 cited text, each line will be prefixed with the contents of this
1555 variable.  The default is @samp{>}.  See also
1556 @code{message-yank-prefix}.
1557
1558 @item message-yank-add-new-references
1559 @vindex message-yank-add-new-references
1560 @cindex yanking
1561 Non-@code{nil} means new IDs will be added to References field when an
1562 article is yanked by the command @code{message-yank-original}
1563 interactively.  If it is a symbol @code{message-id-only}, only an ID
1564 from Message-ID field is used, otherwise IDs extracted from References,
1565 In-Reply-To and Message-ID fields are used.
1566
1567 @item message-list-references-add-position
1568 @vindex message-list-references-add-position
1569 @cindex yanking
1570 Integer value means position for adding to References field when an
1571 article is yanked by the command @code{message-yank-original}
1572 interactively.
1573
1574 @item message-indentation-spaces
1575 @vindex message-indentation-spaces
1576 Number of spaces to indent yanked messages.
1577
1578 @item message-cite-function
1579 @vindex message-cite-function
1580 @findex message-cite-original
1581 @findex sc-cite-original
1582 @findex message-cite-original-without-signature
1583 @cindex Supercite
1584 Function for citing an original message.  The default is
1585 @code{message-cite-original}, which simply inserts the original message
1586 and prepends @samp{> } to each line.
1587 @code{message-cite-original-without-signature} does the same, but elides
1588 the signature.  You can also set it to @code{sc-cite-original} to use
1589 Supercite.
1590
1591 @item message-suspend-font-lock-when-citing
1592 @vindex message-suspend-font-lock-when-citing
1593 If non-@code{nil}, suspend font-lock'ing while citing an original
1594 message.  Some lazy demand-driven fontification tools (or Emacs itself)
1595 have a bug that they often miss a buffer to be fontified.  It will
1596 mostly occur when Emacs prompts user for any inputs in the minibuffer.
1597 Setting this option to non-@code{nil} may help you to avoid unpleasant
1598 errors even if it is an add-hoc expedient.
1599
1600 @item message-indent-citation-function
1601 @vindex message-indent-citation-function
1602 Function for modifying a citation just inserted in the mail buffer.
1603 This can also be a list of functions.  Each function can find the
1604 citation between @code{(point)} and @code{(mark t)}.  And each function
1605 should leave point and mark around the citation text as modified.
1606
1607 @item message-signature
1608 @vindex message-signature
1609 String to be inserted at the end of the message buffer.  If @code{t}
1610 (which is the default), the @code{message-signature-file} file will be
1611 inserted instead.  If a function, the result from the function will be
1612 used instead.  If a form, the result from the form will be used instead.
1613 If this variable is @code{nil}, no signature will be inserted at all.
1614
1615 @item message-signature-file
1616 @vindex message-signature-file
1617 File containing the signature to be inserted at the end of the buffer.
1618 The default is @file{~/.signature}.
1619
1620 @end table
1621
1622 Note that RFC1036bis says that a signature should be preceded by the three
1623 characters @samp{-- } on a line by themselves.  This is to make it
1624 easier for the recipient to automatically recognize and process the
1625 signature.  So don't remove those characters, even though you might feel
1626 that they ruin your beautiful design, like, totally.
1627
1628 Also note that no signature should be more than four lines long.
1629 Including ASCII graphics is an efficient way to get everybody to believe
1630 that you are silly and have nothing important to say.
1631
1632
1633 @node Various Message Variables
1634 @section Various Message Variables
1635
1636 @table @code
1637 @item message-default-charset
1638 @vindex message-default-charset
1639 @cindex charset
1640 Symbol naming a @sc{mime} charset.  Non-ASCII characters in messages are
1641 assumed to be encoded using this charset.  The default is @code{nil},
1642 which means ask the user.  (This variable is used only on non-@sc{mule}
1643 Emacsen.
1644 @xref{Charset Translation, , Charset Translation, emacs-mime,
1645       Emacs MIME Manual}, for details on the @sc{mule}-to-@sc{mime}
1646 translation process.
1647
1648 @item message-signature-separator
1649 @vindex message-signature-separator
1650 Regexp matching the signature separator.  It is @samp{^-- *$} by
1651 default.
1652
1653 @item mail-header-separator
1654 @vindex mail-header-separator
1655 String used to separate the headers from the body.  It is @samp{--text
1656 follows this line--} by default.
1657
1658 @item message-directory
1659 @vindex message-directory
1660 Directory used by many mailey things.  The default is @file{~/Mail/}.
1661
1662 @item message-auto-save-directory
1663 @vindex message-auto-save-directory
1664 Directory where Message auto-saves buffers if Gnus isn't running.  If
1665 @code{nil}, Message won't auto-save.  The default is @file{~/Mail/drafts/}.
1666
1667 @item message-signature-setup-hook
1668 @vindex message-signature-setup-hook
1669 Hook run when initializing the message buffer.  It is run after the
1670 headers have been inserted but before the signature has been inserted.
1671
1672 @item message-setup-hook
1673 @vindex message-setup-hook
1674 Hook run as the last thing when the message buffer has been initialized,
1675 but before yanked text is inserted.
1676
1677 @item message-header-setup-hook
1678 @vindex message-header-setup-hook
1679 Hook called narrowed to the headers after initializing the headers.
1680
1681 For instance, if you're running Gnus and wish to insert a
1682 @samp{Mail-Copies-To} header in all your news articles and all messages
1683 you send to mailing lists, you could do something like the following:
1684
1685 @lisp
1686 (defun my-message-header-setup-hook ()
1687   (let ((group (or gnus-newsgroup-name "")))
1688     (when (or (message-fetch-field "newsgroups")
1689               (gnus-group-find-parameter group 'to-address)
1690               (gnus-group-find-parameter group 'to-list))
1691       (insert "Mail-Copies-To: never\n"))))
1692
1693 (add-hook 'message-header-setup-hook
1694           'my-message-header-setup-hook)
1695 @end lisp
1696
1697 @item message-send-hook
1698 @vindex message-send-hook
1699 Hook run before sending messages.
1700
1701 If you want to add certain headers before sending, you can use the
1702 @code{message-add-header} function in this hook.  For instance:
1703 @findex message-add-header
1704
1705 @lisp
1706 (add-hook 'message-send-hook 'my-message-add-content)
1707 (defun my-message-add-content ()
1708   (message-add-header "X-In-No-Sense: Nonsense")
1709   (message-add-header "X-Whatever: no"))
1710 @end lisp
1711
1712 This function won't add the header if the header is already present.
1713
1714 @item message-send-mail-hook
1715 @vindex message-send-mail-hook
1716 Hook run before sending mail messages.
1717
1718 @item message-send-news-hook
1719 @vindex message-send-news-hook
1720 Hook run before sending news messages.
1721
1722 @item message-sent-hook
1723 @vindex message-sent-hook
1724 Hook run after sending messages.
1725
1726 @item message-cancel-hook
1727 @vindex message-cancel-hook
1728 Hook run when cancelling news articles.
1729
1730 @item message-mode-syntax-table
1731 @vindex message-mode-syntax-table
1732 Syntax table used in message mode buffers.
1733
1734 @item message-strip-special-text-properties
1735 @vindex message-strip-special-text-properties
1736 Emacs has a number of special text properties which can break message
1737 composing in various ways.  If this option is set, message will strip
1738 these properties from the message composition buffer.  However, some
1739 packages requires these properties to be present in order to work.  If
1740 you use one of these packages, turn this option off, and hope the
1741 message composition doesn't break too bad.
1742
1743 @item message-send-method-alist
1744 @vindex message-send-method-alist
1745
1746 Alist of ways to send outgoing messages.  Each element has the form
1747
1748 @lisp
1749 (TYPE PREDICATE FUNCTION)
1750 @end lisp
1751
1752 @table @var
1753 @item type
1754 A symbol that names the method.
1755
1756 @item predicate
1757 A function called without any parameters to determine whether the
1758 message is a message of type @var{type}.
1759
1760 @item function
1761 A function to be called if @var{predicate} returns non-@code{nil}.
1762 @var{function} is called with one parameter -- the prefix.
1763 @end table
1764
1765 @lisp
1766 ((news message-news-p message-send-via-news)
1767  (mail message-mail-p message-send-via-mail))
1768 @end lisp
1769
1770
1771
1772 @end table
1773
1774
1775
1776 @node Sending Variables
1777 @section Sending Variables
1778
1779 @table @code
1780
1781 @item message-fcc-handler-function
1782 @vindex message-fcc-handler-function
1783 A function called to save outgoing articles.  This function will be
1784 called with the name of the file to store the article in.  The default
1785 function is @code{message-output} which saves in Unix mailbox format.
1786
1787 @item message-courtesy-message
1788 @vindex message-courtesy-message
1789 When sending combined messages, this string is inserted at the start of
1790 the mailed copy.  If the string contains the format spec @samp{%s}, the
1791 newsgroups the article has been posted to will be inserted there.  If
1792 this variable is @code{nil}, no such courtesy message will be added.
1793 The default value is @samp{"The following message is a courtesy copy of
1794 an article\\nthat has been posted to %s as well.\\n\\n"}.
1795
1796 @item message-fcc-externalize-attachments
1797 @vindex message-fcc-externalize-attachments
1798 If @code{nil}, attach files as normal parts in Fcc copies; if it is
1799 non-@code{nil}, attach local files as external parts.
1800
1801 @item message-interactive
1802 @vindex message-interactive
1803 If non-@code{nil} wait for and display errors when sending a message;
1804 if @code{nil} let the mailer mail back a message to report errors.
1805
1806 @end table
1807
1808
1809 @node Message Buffers
1810 @section Message Buffers
1811
1812 Message will generate new buffers with unique buffer names when you
1813 request a message buffer.  When you send the message, the buffer isn't
1814 normally killed off.  Its name is changed and a certain number of old
1815 message buffers are kept alive.
1816
1817 @table @code
1818 @item message-generate-new-buffers
1819 @vindex message-generate-new-buffers
1820 If non-@code{nil}, generate new buffers.  The default is @code{t}.  If
1821 this is a function, call that function with three parameters: The type,
1822 the to address and the group name.  (Any of these may be @code{nil}.)
1823 The function should return the new buffer name.
1824
1825 @item message-use-multi-frames
1826 @vindex message-use-multi-frames
1827 If non-@code{nil}, generate new frames. The default is @code{nil}.
1828
1829 @item message-delete-frame-on-exit
1830 @vindex message-delete-frame-on-exit
1831 The @code{message-delete-frame-on-exit} variable says whether to delete
1832 the frame after sending the message or killing the message buffer. If it
1833 is @code{nil} (which is the default), don't delete the frame. If it is
1834 @code{ask}, ask wheter to delete the frame. If it is @code{t}, always
1835 delete the frame.
1836
1837 @item message-max-buffers
1838 @vindex message-max-buffers
1839 This variable says how many old message buffers to keep.  If there are
1840 more message buffers than this, the oldest buffer will be killed.  The
1841 default is 10.  If this variable is @code{nil}, no old message buffers
1842 will ever be killed.
1843
1844 @item message-send-rename-function
1845 @vindex message-send-rename-function
1846 After sending a message, the buffer is renamed from, for instance,
1847 @samp{*reply to Lars*} to @samp{*sent reply to Lars*}.  If you don't
1848 like this, set this variable to a function that renames the buffer in a
1849 manner you like.  If you don't want to rename the buffer at all, you can
1850 say:
1851
1852 @lisp
1853 (setq message-send-rename-function 'ignore)
1854 @end lisp
1855
1856 @item message-kill-buffer-on-exit
1857 @vindex message-kill-buffer-on-exit
1858 If non-@code{nil}, kill the buffer immediately on exit.
1859
1860 @item message-kill-buffer-query-function
1861 @vindex message-kill-buffer-query-function
1862 @findex message-kill-buffer
1863 @findex message-mimic-kill-buffer
1864 Function used to prompt user whether to kill the message buffer when the
1865 command @code{message-kill-buffer} or @code{message-mimic-kill-buffer}
1866 is used.  It defaults to @code{yes-or-no-p}.  You may alter the value to
1867 @code{y-or-n-p}, @code{nnheader-Y-or-n-p}, etc.  If it is @code{t}, the
1868 buffer will be killed without query.
1869
1870 @item message-kill-buffer-and-remove-file
1871 @vindex message-kill-buffer-and-remove-file
1872 @findex message-kill-buffer
1873 @findex message-mimic-kill-buffer
1874 If it is non-@code{nil}, remove the backup file if it exists with a
1875 query to the user, after the message buffer is killed.  Otherwise the
1876 file won't be removed.  It defaults to @code{t}.  However, it is treated
1877 as @code{nil} when the command `message-mimic-kill-buffer' is used.
1878
1879 @end table
1880
1881
1882 @node Message Actions
1883 @section Message Actions
1884
1885 When Message is being used from a news/mail reader, the reader is likely
1886 to want to perform some task after the message has been sent.  Perhaps
1887 return to the previous window configuration or mark an article as
1888 replied.
1889
1890 @vindex message-kill-actions
1891 @vindex message-postpone-actions
1892 @vindex message-exit-actions
1893 @vindex message-send-actions
1894 The user may exit from the message buffer in various ways.  The most
1895 common is @kbd{C-c C-c}, which sends the message and exits.  Other
1896 possibilities are @kbd{C-c C-s} which just sends the message, @kbd{C-c
1897 C-d} which postpones the message editing and buries the message buffer,
1898 and @kbd{C-c C-k} which kills the message buffer.  Each of these actions
1899 have lists associated with them that contains actions to be executed:
1900 @code{message-send-actions}, @code{message-exit-actions},
1901 @code{message-postpone-actions}, and @code{message-kill-actions}.
1902
1903 Message provides a function to interface with these lists:
1904 @code{message-add-action}.  The first parameter is the action to be
1905 added, and the rest of the arguments are which lists to add this action
1906 to.  Here's an example from Gnus:
1907
1908 @lisp
1909   (message-add-action
1910    `(set-window-configuration ,(current-window-configuration))
1911    'exit 'postpone 'kill)
1912 @end lisp
1913
1914 This restores the Gnus window configuration when the message buffer is
1915 killed, postponed or exited.
1916
1917 An @dfn{action} can be either: a normal function, or a list where the
1918 @code{car} is a function and the @code{cdr} is the list of arguments, or
1919 a form to be @code{eval}ed.
1920
1921
1922 @node Compatibility
1923 @chapter Compatibility
1924 @cindex compatibility
1925
1926 Message uses virtually only its own variables---older @code{mail-}
1927 variables aren't consulted.  To force Message to take those variables
1928 into account, you can put the following in your @file{.emacs} file:
1929
1930 @lisp
1931 (require 'messcompat)
1932 @end lisp
1933
1934 This will initialize many Message variables from the values in the
1935 corresponding mail variables.
1936
1937
1938 @node Appendices
1939 @chapter Appendices
1940
1941 @menu
1942 * Responses::          Standard rules for determining where responses go.
1943 @end menu
1944
1945
1946 @node Responses
1947 @section Responses
1948
1949 To determine where a message is to go, the following algorithm is used
1950 by default.
1951
1952 @table @dfn
1953 @item reply
1954 A @dfn{reply} is when you want to respond @emph{just} to the person who
1955 sent the message via mail.  There will only be one recipient.  To
1956 determine who the recipient will be, the following headers are
1957 consulted, in turn:
1958
1959 @table @code
1960 @item Reply-To
1961
1962 @item From
1963 @end table
1964
1965
1966 @item wide reply
1967 A @dfn{wide reply} is a mail response that includes @emph{all} entities
1968 mentioned in the message you are responded to.  All mailboxes from the
1969 following headers will be concatenated to form the outgoing
1970 @code{To}/@code{Cc} headers:
1971
1972 @table @code
1973 @item From
1974 (unless there's a @code{Reply-To}, in which case that is used instead).
1975
1976 @item Cc
1977
1978 @item To
1979 @end table
1980
1981 If a @code{Mail-Copies-To} header is present, it will also be included
1982 in the list of mailboxes.  If this header is @samp{never}, that means
1983 that the @code{From} (or @code{Reply-To}) mailbox will be suppressed.
1984
1985
1986 @item followup
1987 A @dfn{followup} is a response sent via news.  The following headers
1988 (listed in order of precedence) determine where the response is to be
1989 sent:
1990
1991 @table @code
1992
1993 @item Followup-To
1994
1995 @item Newsgroups
1996
1997 @end table
1998
1999 If a @code{Mail-Copies-To} header is present, it will be used as the
2000 basis of the new @code{Cc} header, except if this header is
2001 @samp{never}.
2002
2003 @end table
2004
2005
2006
2007 @node Index
2008 @chapter Index
2009 @printindex cp
2010
2011 @node Key Index
2012 @chapter Key Index
2013 @printindex ky
2014
2015 @summarycontents
2016 @contents
2017 @bye
2018
2019 @c End: