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 If at beginning of header value, go to beginning of line, else go to
629 beginning of header value.  (The header value comes after the header
630 name and the colon.)
631
632 @end table
633
634
635 @node Insertion
636 @section Insertion
637
638 @table @kbd
639
640 @item C-c C-y
641 @kindex C-c C-y
642 @findex message-yank-original
643 Yank the message in the buffer @code{gnus-article-copy} into the message
644 buffer.  Normally @code{gnus-article-copy} is what you are replying to
645 (@code{message-yank-original}).
646
647 @item C-c C-M-y
648 @kindex C-c C-M-y
649 @findex message-yank-buffer
650 Prompt for a buffer name and yank the contents of that buffer into the
651 message buffer (@code{message-yank-buffer}).
652
653 @item C-c C-q
654 @kindex C-c C-q
655 @findex message-fill-yanked-message
656 Fill the yanked message (@code{message-fill-yanked-message}).  Warning:
657 Can severely mess up the yanked text if its quoting conventions are
658 strange.  You'll quickly get a feel for when it's safe, though.  Anyway,
659 just remember that @kbd{C-x u} (@code{undo}) is available and you'll be
660 all right.
661
662 @item C-c C-w
663 @kindex C-c C-w
664 @findex message-insert-signature
665 Insert a signature at the end of the buffer
666 (@code{message-insert-signature}).
667
668 @item C-c M-h
669 @kindex C-c M-h
670 @findex message-insert-headers
671 Insert the message headers (@code{message-insert-headers}).
672
673 @item C-c M-n
674 @kindex C-c M-n
675 @findex message-insert-disposition-notification-to
676 Insert a request for a disposition
677 notification. (@code{message-insert-disposition-notification-to}).
678 This means that if the recipient support RFC 2298 she might send you a
679 notification that she received the message.
680
681 @end table
682
683
684 @node MIME
685 @section MIME
686 @cindex MML
687 @cindex MIME
688 @cindex multipart
689 @cindex attachment
690
691 Message is a @sc{mime}-compliant posting agent.  The user generally
692 doesn't have to do anything to make the @sc{mime} happen---Message will
693 automatically add the @code{Content-Type} and
694 @code{Content-Transfer-Encoding} headers.
695
696 The most typical thing users want to use the multipart things in
697 @sc{mime} for is to add ``attachments'' to mail they send out.  This can
698 be done with the @kbd{C-c C-a} command, which will prompt for a file
699 name and a @sc{mime} type.
700
701 You can also create arbitrarily complex multiparts using the MML
702 language (@pxref{Composing, , Composing, emacs-mime, The Emacs MIME
703 Manual}).
704
705 @node Security
706 @section Security
707 @cindex Security
708 @cindex S/MIME
709 @cindex PGP
710 @cindex PGP/MIME
711 @cindex sign
712 @cindex encrypt
713 @cindex secure
714
715 Using the MML language, Message is able to create digitally signed and
716 digitally encrypted messages.  Message (or rather MML) currently
717 support PGP (RFC 1991), @sc{pgp/mime} (RFC 2015/3156) and @sc{s/mime}.
718 Instructing MML to perform security operations on a @sc{mime} part is
719 done using the @kbd{C-c C-m s} key map for signing and the @kbd{C-c
720 C-m c} key map for encryption, as follows.
721
722 @table @kbd
723
724 @item C-c C-m s s
725 @kindex C-c C-m s s
726 @findex mml-secure-message-sign-smime
727
728 Digitally sign current message using @sc{s/mime}.
729
730 @item C-c C-m s o
731 @kindex C-c C-m s o
732 @findex mml-secure-message-sign-pgp
733
734 Digitally sign current message using PGP.
735
736 @item C-c C-m s p
737 @kindex C-c C-m s p
738 @findex mml-secure-message-sign-pgpmime
739
740 Digitally sign current message using @sc{pgp/mime}.
741
742 @item C-c C-m c s
743 @kindex C-c C-m c s
744 @findex mml-secure-message-encrypt-smime
745
746 Digitally encrypt current message using @sc{s/mime}.
747
748 @item C-c C-m c o
749 @kindex C-c C-m c o
750 @findex mml-secure-message-encrypt-pgp
751
752 Digitally encrypt current message using PGP.
753
754 @item C-c C-m c p
755 @kindex C-c C-m c p
756 @findex mml-secure-message-encrypt-pgpmime
757
758 Digitally encrypt current message using @sc{pgp/mime}.
759
760 @item C-c C-m C-n
761 @kindex C-c C-m C-n
762 @findex mml-unsecure-message
763 Remove security related MML tags from message.
764
765 @end table
766
767 These commands do not immediately sign or encrypt the message, they
768 merely insert the proper MML secure tag to instruct the MML engine to
769 perform that operation when the message is actually sent. They may
770 perform other operations too, such as locating and retrieving a
771 @sc{s/mime} certificate of the person you wish to send encrypted mail
772 to.  When the mml parsing engine converts your MML into a properly
773 encoded @sc{mime} message, the secure tag will be replaced with either
774 a part or a multipart tag.  If your message contains other mml parts,
775 a multipart tag will be used; if no other parts are present in your
776 message a single part tag will be used.  This way, message mode will
777 do the Right Thing (TM) with signed/encrypted multipart messages.
778
779 Since signing and especially encryption often is used when sensitive
780 information is sent, you may want to have some way to ensure that your
781 mail is actually signed or encrypted.  After invoking the above
782 sign/encrypt commands, it is possible to preview the raw article by
783 using @kbd{C-u C-c RET P} (@code{mml-preview}).  Then you can
784 verify that your long rant about what your ex-significant other or
785 whomever actually did with that funny looking person at that strange
786 party the other night, actually will be sent encrypted.
787
788 @emph{Note!}  Neither @sc{pgp/mime} nor @sc{s/mime} encrypt/signs
789 RFC822 headers.  They only operate on the @sc{mime} object.  Keep this
790 in mind before sending mail with a sensitive Subject line.
791
792 Actually using the security commands above is not very difficult.  At
793 least not compared with making sure all involved programs talk with each
794 other properly.  Thus, we now describe what external libraries or
795 programs are required to make things work, and some small general hints.
796
797 @subsection Using S/MIME
798
799 @emph{Note!}  This section assume you have a basic familiarity with
800 modern cryptography, @sc{s/mime}, various PKCS standards, OpenSSL and
801 so on.
802
803 The @sc{s/mime} support in Message (and MML) require OpenSSL.  OpenSSL
804 perform the actual @sc{s/mime} sign/encrypt operations.  OpenSSL can
805 be found at @uref{http://www.openssl.org/}.  OpenSSL 0.9.6 and later
806 should work.  Version 0.9.5a cannot extract mail addresses from
807 certificates, and it insert a spurious CR character into @sc{mime}
808 separators so you may wish to avoid it if you would like to avoid
809 being regarded as someone who send strange mail. (Although by sending
810 @sc{s/mime} messages you've probably already lost that contest.)
811
812 To be able to send encrypted mail, a personal certificate is not
813 required.  Message (MML) need a certificate for the person to whom you
814 wish to communicate with though.  You're asked for this when you type
815 @kbd{C-c C-m c s}.  Currently there are two ways to retrieve this
816 certificate, from a local file or from DNS.  If you chose a local
817 file, it need to contain a X.509 certificate in PEM format.  If you
818 chose DNS, you're asked for the domain name where the certificate is
819 stored, the default is a good guess.  To my belief, Message (MML) is
820 the first mail agent in the world to support retrieving @sc{s/mime}
821 certificates from DNS, so you're not likely to find very many
822 certificates out there.  At least there should be one, stored at the
823 domain @code{simon.josefsson.org}.  LDAP is a more popular method of
824 distributing certificates, support for it is planned.  (Meanwhile, you
825 can use @code{ldapsearch} from the command line to retrieve a
826 certificate into a file and use it.)
827
828 As for signing messages, OpenSSL can't perform signing operations
829 without some kind of configuration.  Especially, you need to tell it
830 where your private key and your certificate is stored.  MML uses an
831 Emacs interface to OpenSSL, aptly named @code{smime.el}, and it
832 contain a @code{custom} group used for this configuration.  So, try
833 @kbd{M-x customize-group RET smime RET} and look around.
834
835 Currently there is no support for talking to a CA (or RA) to create
836 your own certificate.  None is planned either.  You need to do this
837 manually with OpenSSL or using some other program.  I used Netscape
838 and got a free @sc{s/mime} certificate from one of the big CA's on the
839 net.  Netscape is able to export your private key and certificate in
840 PKCS #12 format.  Use OpenSSL to convert this into a plain X.509
841 certificate in PEM format as follows.
842
843 @example
844 $ openssl pkcs12 -in ns.p12 -clcerts -nodes > key+cert.pem
845 @end example
846
847 The @file{key+cert.pem} file should be pointed to from the
848 @code{smime-keys} variable.  You should now be able to send signed mail.
849
850 @emph{Note!}  Your private key is store unencrypted in the file, so take
851 care in handling it.
852
853 @subsection Using PGP/MIME
854
855 @sc{pgp/mime} requires an external OpenPGP implementation, such as GNU
856 Privacy Guard (@uref{http://www.gnupg.org/}).  It also requires an
857 Emacs interface to it, such as Mailcrypt (available from
858 @uref{http://www.nb.net/~lbudney/linux/software/mailcrypt.html}) or
859 Florian Weimer's @code{gpg.el}.
860
861 @vindex gpg-temp-directory
862 Note, if you are using the @code{gpg.el} you must make sure that the
863 path specified by @code{gpg-temp-directory} have permissions 0700.
864
865 Creating your own OpenPGP key is described in detail in the
866 documentation of your OpenPGP implementation, so we refer to it.
867
868 @node Various Commands
869 @section Various Commands
870
871 @table @kbd
872
873 @item C-c C-r
874 @kindex C-c C-r
875 @findex message-caesar-buffer-body
876 Caesar rotate (aka. rot13) the current message
877 (@code{message-caesar-buffer-body}).  If narrowing is in effect, just
878 rotate the visible portion of the buffer.  A numerical prefix says how
879 many places to rotate the text.  The default is 13.
880
881 @item C-c C-e
882 @kindex C-c C-e
883 @findex message-elide-region
884 @vindex message-elide-ellipsis
885 Elide the text between point and mark (@code{message-elide-region}).
886 The text is killed and replaced with the contents of the variable
887 @code{message-elide-ellipsis}. The default value is to use an ellipsis
888 (@samp{[...]}).
889
890 @item C-c C-z
891 @kindex C-c C-x
892 @findex message-kill-to-signature
893 Kill all the text up to the signature, or if that's missing, up to the
894 end of the message (@code{message-kill-to-signature}).
895
896 @item C-c C-v
897 @kindex C-c C-v
898 @findex message-delete-not-region
899 Delete all text in the body of the message that is outside the region
900 (@code{message-delete-not-region}).
901
902 @item M-RET
903 @kindex M-RET
904 @findex message-newline-and-reformat
905 Insert four newlines, and then reformat if inside quoted text.
906
907 Here's an example:
908
909 @example
910 > This is some quoted text.  And here's more quoted text.
911 @end example
912
913 If point is before @samp{And} and you press @kbd{M-RET}, you'll get:
914
915 @example
916 > This is some quoted text.
917
918 *
919
920 > And here's more quoted text.
921 @end example
922
923 @samp{*} says where point will be placed.
924
925 @item C-c C-t
926 @kindex C-c C-t
927 @findex message-insert-to
928 Insert a @code{To} header that contains the @code{Reply-To} or
929 @code{From} header of the message you're following up
930 (@code{message-insert-to}).
931
932 @item C-c C-n
933 @kindex C-c C-n
934 @findex message-insert-newsgroups
935 Insert a @code{Newsgroups} header that reflects the @code{Followup-To}
936 or @code{Newsgroups} header of the article you're replying to
937 (@code{message-insert-newsgroups}).
938
939 @item C-c C-o
940 @kindex C-c C-o
941 @findex message-sort-headers
942 @vindex message-header-format-alist
943 Sort headers according to @code{message-header-format-alist}
944 (@code{message-sort-headers}).
945
946 @item C-c M-r
947 @kindex C-c M-r
948 @findex message-rename-buffer
949 Rename the buffer (@code{message-rename-buffer}).  If given a prefix,
950 prompt for a new buffer name.
951
952 @end table
953
954
955 @node Sending
956 @section Sending
957
958 @table @kbd
959 @item C-c C-c
960 @kindex C-c C-c
961 @findex message-send-and-exit
962 Send the message and bury the current buffer
963 (@code{message-send-and-exit}).
964
965 @item C-c C-s
966 @kindex C-c C-s
967 @findex message-send
968 Send the message (@code{message-send}).
969
970 @item C-c C-d
971 @kindex C-c C-d
972 @findex message-dont-send
973 Bury the message buffer and exit (@code{message-dont-send}).
974
975 @item C-c C-k
976 @kindex C-c C-k
977 @findex message-kill-buffer
978 Kill the message buffer and exit (@code{message-kill-buffer}).  It will
979 delete the message frame if it has been created exclusively for the
980 message buffer.  If the option
981 @code{message-kill-buffer-and-remove-file} is non-@code{nil} and the
982 backup file has been created for the message buffer, it will also remove
983 the file after prompting to the user.
984
985 @item C-x k
986 @kindex C-x k
987 @findex message-mimic-kill-buffer
988 @vindex message-kill-buffer-and-remove-file
989 This is an imitation for @code{kill-buffer}
990 (@code{message-mimic-kill-buffer}).  It dynamically binds the variable
991 @code{message-kill-buffer-and-remove-file} to @code{nil} and calls the
992 function @code{message-kill-buffer}.
993
994 @end table
995
996
997
998 @node Mail Aliases
999 @section Mail Aliases
1000 @cindex mail aliases
1001 @cindex aliases
1002
1003 @vindex message-mail-alias-type
1004 The @code{message-mail-alias-type} variable controls what type of mail
1005 alias expansion to use.  Currently only one form is supported---Message
1006 uses @code{mailabbrev} to handle mail aliases.  If this variable is
1007 @code{nil}, no mail alias expansion will be performed.
1008
1009 @code{mailabbrev} works by parsing the @file{/etc/mailrc} and
1010 @file{~/.mailrc} files.  These files look like:
1011
1012 @example
1013 alias lmi "Lars Magne Ingebrigtsen <larsi@@ifi.uio.no>"
1014 alias ding "ding@@ifi.uio.no (ding mailing list)"
1015 @end example
1016
1017 After adding lines like this to your @file{~/.mailrc} file, you should
1018 be able to just write @samp{lmi} in the @code{To} or @code{Cc} (and so
1019 on) headers and press @kbd{SPC} to expand the alias.
1020
1021 No expansion will be performed upon sending of the message---all
1022 expansions have to be done explicitly.
1023
1024
1025 @node Spelling
1026 @section Spelling
1027 @cindex spelling
1028 @findex ispell-message
1029
1030 There are two popular ways to have Emacs spell-check your messages:
1031 @code{ispell} and @code{flyspell}.  @code{ispell} is the older and
1032 probably more popular package.  You typically first write the message,
1033 and then run the entire thing through @code{ispell} and fix all the
1034 typos.  To have this happen automatically when you send a message, put
1035 something like the following in your @file{.emacs} file:
1036
1037 @lisp
1038 (add-hook 'message-send-hook 'ispell-message)
1039 @end lisp
1040
1041 @vindex ispell-message-dictionary-alist
1042 If you're in the habit of writing in different languages, this can be
1043 controlled by the @code{ispell-message-dictionary-alist} variable:
1044
1045 @lisp
1046 (setq ispell-message-dictionary-alist
1047       '(("^Newsgroups:.*\\bde\\." . "deutsch8")
1048         (".*" . "default")))
1049 @end lisp
1050
1051 @code{ispell} depends on having the external @samp{ispell} command
1052 installed.
1053
1054 The other popular method is using @code{flyspell}.  This package checks
1055 your spelling while you're writing, and marks any mis-spelled words in
1056 various ways.
1057
1058 To use @code{flyspell}, put something like the following in your
1059 @file{.emacs} file:
1060
1061 @lisp
1062 (defun my-message-setup-routine ()
1063   (flyspell-mode 1))
1064 (add-hook 'message-setup-hook 'my-message-setup-routine)
1065 @end lisp
1066
1067 @code{flyspell} depends on having the external @samp{ispell} command
1068 installed.
1069
1070
1071 @node Variables
1072 @chapter Variables
1073
1074 @menu
1075 * Message Headers::             General message header stuff.
1076 * Mail Headers::                Customizing mail headers.
1077 * Mail Variables::              Other mail variables.
1078 * News Headers::                Customizing news headers.
1079 * News Variables::              Other news variables.
1080 * Insertion Variables::         Customizing how things are inserted.
1081 * Various Message Variables::   Other message variables.
1082 * Sending Variables::           Variables for sending.
1083 * Message Buffers::             How Message names its buffers.
1084 * Message Actions::             Actions to be performed when exiting.
1085 @end menu
1086
1087
1088 @node Message Headers
1089 @section Message Headers
1090
1091 Message is quite aggressive on the message generation front.  It has to
1092 be -- it's a combined news and mail agent.  To be able to send combined
1093 messages, it has to generate all headers itself (instead of letting the
1094 mail/news system do it) to ensure that mail and news copies of messages
1095 look sufficiently similar.
1096
1097 @table @code
1098
1099 @item message-generate-headers-first
1100 @vindex message-generate-headers-first
1101 If non-@code{nil}, generate all required headers before starting to
1102 compose the message.
1103
1104 The variables @code{message-required-mail-headers} and
1105 @code{message-required-news-headers} specify which headers are required.
1106
1107 Note that some headers will be removed and re-generated before posting,
1108 because of the variable @code{message-deletable-headers} (see below).
1109
1110 @item message-from-style
1111 @vindex message-from-style
1112 Specifies how @code{From} headers should look.  There are four valid
1113 values:
1114
1115 @table @code
1116 @item nil
1117 Just the address -- @samp{king@@grassland.com}.
1118
1119 @item parens
1120 @samp{king@@grassland.com (Elvis Parsley)}.
1121
1122 @item angles
1123 @samp{Elvis Parsley <king@@grassland.com>}.
1124
1125 @item default
1126 Look like @code{angles} if that doesn't require quoting, and
1127 @code{parens} if it does.  If even @code{parens} requires quoting, use
1128 @code{angles} anyway.
1129
1130 @end table
1131
1132 @item message-deletable-headers
1133 @vindex message-deletable-headers
1134 Headers in this list that were previously generated by Message will be
1135 deleted before posting.  Let's say you post an article.  Then you decide
1136 to post it again to some other group, you naughty boy, so you jump back
1137 to the @code{*post-buf*} buffer, edit the @code{Newsgroups} line, and
1138 ship it off again.  By default, this variable makes sure that the old
1139 generated @code{Message-ID} is deleted, and a new one generated.  If
1140 this isn't done, the entire empire would probably crumble, anarchy would
1141 prevail, and cats would start walking on two legs and rule the world.
1142 Allegedly.
1143
1144 @item message-default-headers
1145 @vindex message-default-headers
1146 This string is inserted at the end of the headers in all message
1147 buffers.
1148
1149 @item message-subject-re-regexp
1150 @vindex message-subject-re-regexp
1151 @cindex Aw:
1152 @cindex Sv:
1153 @cindex Re:
1154 Responses to messages have subjects that start with @samp{Re: }.  This
1155 is @emph{not} an abbreviation of the English word ``response'', but is
1156 Latin, and means ``in response to''.  Some illiterate nincompoops have
1157 failed to grasp this fact, and have ``internationalized'' their software
1158 to use abonimations like @samp{Aw: } (``antwort'') or @samp{Sv: }
1159 (``svar'') instead, which is meaningless and evil.  However, you may
1160 have to deal with users that use these evil tools, in which case you may
1161 set this variable to a regexp that matches these prefixes.  Myself, I
1162 just throw away non-compliant mail.
1163
1164 Here's an example of a value to deal with these headers when
1165 responding to a message:
1166
1167 @lisp
1168 (setq message-subject-re-regexp
1169      "^\\(\\(\\([Rr][Ee]\\|[Ss][Vv]\\|[Aa][Ww]\\): *\\)+\\))
1170 @end lisp
1171
1172 @item message-alternative-emails
1173 @vindex message-alternative-emails
1174 A regexp to match the alternative email addresses.  The first matched
1175 address (not primary one) is used in the @code{From} field.
1176
1177 @end table
1178
1179
1180 @node Mail Headers
1181 @section Mail Headers
1182
1183 @table @code
1184 @item message-required-mail-headers
1185 @vindex message-required-mail-headers
1186 @xref{News Headers}, for the syntax of this variable.  It is
1187 @code{(From Date Subject (optional . In-Reply-To) Message-ID Lines
1188 (optional . User-Agent))} by default.
1189
1190 @item message-ignored-mail-headers
1191 @vindex message-ignored-mail-headers
1192 Regexp of headers to be removed before mailing.  The default is
1193 @samp{^[GF]cc:\\|^Resent-Fcc:\\|^Xref:\\|^X-Draft-From:}.
1194
1195 @item message-default-mail-headers
1196 @vindex message-default-mail-headers
1197 This string is inserted at the end of the headers in all message
1198 buffers that are initialized as mail.
1199
1200 @end table
1201
1202
1203 @node Mail Variables
1204 @section Mail Variables
1205
1206 @table @code
1207 @item message-send-mail-function
1208 @vindex message-send-mail-function
1209 @findex message-send-mail-with-sendmail
1210 @findex message-send-mail-with-mh
1211 @findex message-send-mail-with-qmail
1212 @findex smtpmail-send-it
1213 @findex feedmail-send-it
1214 Function used to send the current buffer as mail. The default is
1215 @code{message-send-mail-with-sendmail}. Other valid values include
1216 @code{message-send-mail-with-mh}, @code{message-send-mail-with-qmail},
1217 @code{smtpmail-send-it} and @code{feedmail-send-it}.
1218
1219 @item message-mh-deletable-headers
1220 @vindex message-mh-deletable-headers
1221 Most versions of MH doesn't like being fed messages that contain the
1222 headers in this variable.  If this variable is non-@code{nil} (which is
1223 the default), these headers will be removed before mailing when sending
1224 messages via MH.  Set it to @code{nil} if your MH can handle these
1225 headers.
1226
1227 @item message-qmail-inject-program
1228 @vindex message-qmail-inject-program
1229 @cindex qmail
1230 Location of the qmail-inject program.
1231
1232 @item message-qmail-inject-args
1233 @vindex message-qmail-inject-args
1234 Arguments passed to qmail-inject programs.
1235 This should be a list of strings, one string for each argument.  It
1236 may also be a function.
1237
1238 For e.g., if you wish to set the envelope sender address so that bounces
1239 go to the right place or to deal with listserv's usage of that address, you
1240 might set this variable to @code{'("-f" "you@@some.where")}.
1241
1242 @item message-sendmail-f-is-evil
1243 @vindex message-sendmail-f-is-evil
1244 @cindex sendmail
1245 Non-@code{nil} means don't add @samp{-f username} to the sendmail
1246 command line.  Doing so would be even more evil than leaving it out.
1247
1248 @item message-mailer-swallows-blank-line
1249 @vindex message-mailer-swallows-blank-line
1250 Set this to non-@code{nil} if the system's mailer runs the header and
1251 body together.  (This problem exists on Sunos 4 when sendmail is run
1252 in remote mode.)  The value should be an expression to test whether
1253 the problem will actually occur.
1254
1255 @item message-send-mail-partially-limit
1256 @vindex message-send-mail-partially-limit
1257 The limitation of messages sent as message/partial.
1258 The lower bound of message size in characters, beyond which the message 
1259 should be sent in several parts. If it is nil, the size is unlimited.
1260
1261 @end table
1262
1263
1264 @node News Headers
1265 @section News Headers
1266
1267 @vindex message-required-news-headers
1268 @code{message-required-news-headers} a list of header symbols.  These
1269 headers will either be automatically generated, or, if that's
1270 impossible, they will be prompted for.  The following symbols are valid:
1271
1272 @table @code
1273
1274 @item From
1275 @cindex From
1276 @findex user-full-name
1277 @findex user-mail-address
1278 This required header will be filled out with the result of the
1279 @code{message-make-from} function, which depends on the
1280 @code{message-from-style}, @code{user-full-name},
1281 @code{user-mail-address} variables.
1282
1283 @item Subject
1284 @cindex Subject
1285 This required header will be prompted for if not present already.
1286
1287 @item Newsgroups
1288 @cindex Newsgroups
1289 This required header says which newsgroups the article is to be posted
1290 to.  If it isn't present already, it will be prompted for.
1291
1292 @item Organization
1293 @cindex organization
1294 @vindex message-user-organization
1295 @vindex message-user-organization-file
1296 This optional header will be filled out depending on the
1297 @code{message-user-organization} variable.
1298 @code{message-user-organization-file} will be used if this variable is
1299 @code{t}.  This variable can also be a string (in which case this string
1300 will be used), or it can be a function (which will be called with no
1301 parameters and should return a string to be used).
1302
1303 @item Lines
1304 @cindex Lines
1305 This optional header will be computed by Message.
1306
1307 @item Message-ID
1308 @cindex Message-ID
1309 @vindex mail-host-address
1310 @findex system-name
1311 @cindex Sun
1312 This required header will be generated by Message.  A unique ID will be
1313 created based on the date, time, user name and system name.  Message
1314 will use @code{system-name} to determine the name of the system.  If
1315 this isn't a fully qualified domain name (FQDN), Message will use
1316 @code{mail-host-address} as the FQDN of the machine.
1317
1318 @item User-Agent
1319 @cindex User-Agent
1320 This optional header will be filled out according to the
1321 @code{message-newsreader} local variable.
1322
1323 @item In-Reply-To
1324 This optional header is filled out using the @code{Date} and @code{From}
1325 header of the article being replied to.
1326
1327 @item Expires
1328 @cindex Expires
1329 @vindex message-expires
1330 This extremely optional header will be inserted according to the
1331 @code{message-expires} variable.  It is highly deprecated and shouldn't
1332 be used unless you know what you're doing.
1333
1334 @item Distribution
1335 @cindex Distribution
1336 @vindex message-distribution-function
1337 This optional header is filled out according to the
1338 @code{message-distribution-function} variable.  It is a deprecated and
1339 much misunderstood header.
1340
1341 @item Path
1342 @cindex path
1343 @vindex message-user-path
1344 This extremely optional header should probably never be used.
1345 However, some @emph{very} old servers require that this header is
1346 present.  @code{message-user-path} further controls how this
1347 @code{Path} header is to look.  If it is @code{nil}, use the server name
1348 as the leaf node.  If it is a string, use the string.  If it is neither
1349 a string nor @code{nil}, use the user name only.  However, it is highly
1350 unlikely that you should need to fiddle with this variable at all.
1351 @end table
1352
1353 @findex yow
1354 @cindex Mime-Version
1355 In addition, you can enter conses into this list.  The car of this cons
1356 should be a symbol.  This symbol's name is the name of the header, and
1357 the cdr can either be a string to be entered verbatim as the value of
1358 this header, or it can be a function to be called.  This function should
1359 return a string to be inserted.  For instance, if you want to insert
1360 @code{Mime-Version: 1.0}, you should enter @code{(Mime-Version . "1.0")}
1361 into the list.  If you want to insert a funny quote, you could enter
1362 something like @code{(X-Yow . yow)} into the list.  The function
1363 @code{yow} will then be called without any arguments.
1364
1365 If the list contains a cons where the car of the cons is
1366 @code{optional}, the cdr of this cons will only be inserted if it is
1367 non-@code{nil}.
1368
1369 Other variables for customizing outgoing news articles:
1370
1371 @table @code
1372
1373 @item message-syntax-checks
1374 @vindex message-syntax-checks
1375 Controls what syntax checks should not be performed on outgoing posts.
1376 To disable checking of long signatures, for instance, add
1377
1378 @lisp
1379 (signature . disabled)
1380 @end lisp
1381
1382 to this list.
1383
1384 Valid checks are:
1385
1386 @table @code
1387 @item subject-cmsg
1388 Check the subject for commands.
1389 @item sender
1390 @cindex Sender
1391 Insert a new @code{Sender} header if the @code{From} header looks odd.
1392 @item multiple-headers
1393 Check for the existence of multiple equal headers.
1394 @item sendsys
1395 @cindex sendsys
1396 Check for the existence of version and sendsys commands.
1397 @item message-id
1398 Check whether the @code{Message-ID} looks ok.
1399 @item from
1400 Check whether the @code{From} header seems nice.
1401 @item long-lines
1402 @cindex long lines
1403 Check for too long lines.
1404 @item control-chars
1405 Check for invalid characters.
1406 @item size
1407 Check for excessive size.
1408 @item new-text
1409 Check whether there is any new text in the messages.
1410 @item signature
1411 Check the length of the signature.
1412 @item approved
1413 @cindex approved
1414 Check whether the article has an @code{Approved} header, which is
1415 something only moderators should include.
1416 @item empty
1417 Check whether the article is empty.
1418 @item invisible-text
1419 Check whether there is any invisible text in the buffer.
1420 @item empty-headers
1421 Check whether any of the headers are empty.
1422 @item existing-newsgroups
1423 Check whether the newsgroups mentioned in the @code{Newsgroups} and
1424 @code{Followup-To} headers exist.
1425 @item valid-newsgroups
1426 Check whether the @code{Newsgroups} and @code{Followup-to} headers
1427 are valid syntactically.
1428 @item repeated-newsgroups
1429 Check whether the @code{Newsgroups} and @code{Followup-to} headers
1430 contains repeated group names.
1431 @item shorten-followup-to
1432 Check whether to add a @code{Followup-to} header to shorten the number
1433 of groups to post to.
1434 @end table
1435
1436 All these conditions are checked by default.
1437
1438 @item message-ignored-news-headers
1439 @vindex message-ignored-news-headers
1440 Regexp of headers to be removed before posting.  The default is@*
1441 @samp{^NNTP-Posting-Host:\\|^Xref:\\|^[BGF]cc:\\|^Resent-Fcc:\\|^X-Draft-From:}.
1442
1443 @item message-default-news-headers
1444 @vindex message-default-news-headers
1445 This string is inserted at the end of the headers in all message
1446 buffers that are initialized as news.
1447
1448 @end table
1449
1450
1451 @node News Variables
1452 @section News Variables
1453
1454 @table @code
1455 @item message-send-news-function
1456 @vindex message-send-news-function
1457 Function used to send the current buffer as news.  The default is
1458 @code{message-send-news}.
1459
1460 @item message-post-method
1461 @vindex message-post-method
1462 Gnusish @dfn{select method} (see the Gnus manual for details) used for
1463 posting a prepared news message.
1464
1465 @end table
1466
1467
1468 @node Insertion Variables
1469 @section Insertion Variables
1470
1471 @table @code
1472 @item message-ignored-cited-headers
1473 @vindex message-ignored-cited-headers
1474 All headers that match this regexp will be removed from yanked
1475 messages.  The default is @samp{.}, which means that all headers will be
1476 removed.
1477
1478 @item message-cite-prefix-regexp
1479 @vindex message-cite-prefix-regexp
1480 Regexp matching the longest possible citation prefix on a line.
1481
1482 @item message-citation-line-function
1483 @vindex message-citation-line-function
1484 @cindex attribution line
1485 Function called to insert the citation line.  The default is
1486 @code{message-insert-citation-line}, which will lead to citation lines
1487 that look like:
1488
1489 @example
1490 Hallvard B Furuseth <h.b.furuseth@@usit.uio.no> writes:
1491 @end example
1492
1493 Point will be at the beginning of the body of the message when this
1494 function is called.
1495
1496 Note that Gnus provides a feature where clicking on `writes:' hides the
1497 cited text.  If you change the citation line too much, readers of your
1498 messages will have to adjust their Gnus, too.  See the variable
1499 @code{gnus-cite-attribution-suffix}.  @xref{Article Highlighting, ,
1500 Article Highlighting, gnus}, for details.
1501
1502 @item message-yank-prefix
1503 @vindex message-yank-prefix
1504 @cindex yanking
1505 @cindex quoting
1506 When you are replying to or following up an article, you normally want
1507 to quote the person you are answering.  Inserting quoted text is done
1508 by @dfn{yanking}, and each line you yank will have
1509 @code{message-yank-prefix} prepended to it (except for quoted and
1510 empty lines which uses @code{message-yank-cited-prefix}). The default
1511 is @samp{> }.
1512
1513 @item message-yank-cited-prefix
1514 @vindex message-yank-cited-prefix
1515 @cindex yanking
1516 @cindex cited
1517 @cindex quoting
1518 When yanking text from a article which contains no text or already
1519 cited text, each line will be prefixed with the contents of this
1520 variable.  The default is @samp{>}.  See also
1521 @code{message-yank-prefix}.
1522
1523 @item message-yank-add-new-references
1524 @vindex message-yank-add-new-references
1525 @cindex yanking
1526 Non-@code{nil} means new IDs will be added to References field when an
1527 article is yanked by the command @code{message-yank-original}
1528 interactively.  If it is a symbol @code{message-id-only}, only an ID
1529 from Message-ID field is used, otherwise IDs extracted from References,
1530 In-Reply-To and Message-ID fields are used.
1531
1532 @item message-list-references-add-position
1533 @vindex message-list-references-add-position
1534 @cindex yanking
1535 Integer value means position for adding to References field when an
1536 article is yanked by the command @code{message-yank-original}
1537 interactively.
1538
1539 @item message-indentation-spaces
1540 @vindex message-indentation-spaces
1541 Number of spaces to indent yanked messages.
1542
1543 @item message-cite-function
1544 @vindex message-cite-function
1545 @findex message-cite-original
1546 @findex sc-cite-original
1547 @findex message-cite-original-without-signature
1548 @cindex Supercite
1549 Function for citing an original message.  The default is
1550 @code{message-cite-original}, which simply inserts the original message
1551 and prepends @samp{> } to each line.
1552 @code{message-cite-original-without-signature} does the same, but elides
1553 the signature.  You can also set it to @code{sc-cite-original} to use
1554 Supercite.
1555
1556 @item message-suspend-font-lock-when-citing
1557 @vindex message-suspend-font-lock-when-citing
1558 If non-@code{nil}, suspend font-lock'ing while citing an original
1559 message.  Some lazy demand-driven fontification tools (or Emacs itself)
1560 have a bug that they often miss a buffer to be fontified.  It will
1561 mostly occur when Emacs prompts user for any inputs in the minibuffer.
1562 Setting this option to non-@code{nil} may help you to avoid unpleasant
1563 errors even if it is an add-hoc expedient.
1564
1565 @item message-indent-citation-function
1566 @vindex message-indent-citation-function
1567 Function for modifying a citation just inserted in the mail buffer.
1568 This can also be a list of functions.  Each function can find the
1569 citation between @code{(point)} and @code{(mark t)}.  And each function
1570 should leave point and mark around the citation text as modified.
1571
1572 @item message-signature
1573 @vindex message-signature
1574 String to be inserted at the end of the message buffer.  If @code{t}
1575 (which is the default), the @code{message-signature-file} file will be
1576 inserted instead.  If a function, the result from the function will be
1577 used instead.  If a form, the result from the form will be used instead.
1578 If this variable is @code{nil}, no signature will be inserted at all.
1579
1580 @item message-signature-file
1581 @vindex message-signature-file
1582 File containing the signature to be inserted at the end of the buffer.
1583 The default is @file{~/.signature}.
1584
1585 @end table
1586
1587 Note that RFC1036bis says that a signature should be preceded by the three
1588 characters @samp{-- } on a line by themselves.  This is to make it
1589 easier for the recipient to automatically recognize and process the
1590 signature.  So don't remove those characters, even though you might feel
1591 that they ruin your beautiful design, like, totally.
1592
1593 Also note that no signature should be more than four lines long.
1594 Including ASCII graphics is an efficient way to get everybody to believe
1595 that you are silly and have nothing important to say.
1596
1597
1598 @node Various Message Variables
1599 @section Various Message Variables
1600
1601 @table @code
1602 @item message-default-charset
1603 @vindex message-default-charset
1604 @cindex charset
1605 Symbol naming a @sc{mime} charset.  Non-ASCII characters in messages are
1606 assumed to be encoded using this charset.  The default is @code{nil},
1607 which means ask the user.  (This variable is used only on non-@sc{mule}
1608 Emacsen.  
1609 @xref{Charset Translation, , Charset Translation, emacs-mime, 
1610       Emacs MIME Manual}, for details on the @sc{mule}-to-@sc{mime}
1611 translation process.
1612
1613 @item message-signature-separator
1614 @vindex message-signature-separator
1615 Regexp matching the signature separator.  It is @samp{^-- *$} by
1616 default.
1617
1618 @item mail-header-separator
1619 @vindex mail-header-separator
1620 String used to separate the headers from the body.  It is @samp{--text
1621 follows this line--} by default.
1622
1623 @item message-directory
1624 @vindex message-directory
1625 Directory used by many mailey things.  The default is @file{~/Mail/}.
1626
1627 @item message-auto-save-directory
1628 @vindex message-auto-save-directory
1629 Directory where Message auto-saves buffers if Gnus isn't running.  If
1630 @code{nil}, Message won't auto-save.  The default is @file{~/Mail/drafts/}.
1631
1632 @item message-signature-setup-hook
1633 @vindex message-signature-setup-hook
1634 Hook run when initializing the message buffer.  It is run after the
1635 headers have been inserted but before the signature has been inserted.
1636
1637 @item message-setup-hook
1638 @vindex message-setup-hook
1639 Hook run as the last thing when the message buffer has been initialized,
1640 but before yanked text is inserted.
1641
1642 @item message-header-setup-hook
1643 @vindex message-header-setup-hook
1644 Hook called narrowed to the headers after initializing the headers.
1645
1646 For instance, if you're running Gnus and wish to insert a
1647 @samp{Mail-Copies-To} header in all your news articles and all messages
1648 you send to mailing lists, you could do something like the following:
1649
1650 @lisp
1651 (defun my-message-header-setup-hook ()
1652   (let ((group (or gnus-newsgroup-name "")))
1653     (when (or (message-fetch-field "newsgroups")
1654               (gnus-group-find-parameter group 'to-address)
1655               (gnus-group-find-parameter group 'to-list))
1656       (insert "Mail-Copies-To: never\n"))))
1657
1658 (add-hook 'message-header-setup-hook
1659           'my-message-header-setup-hook)
1660 @end lisp
1661
1662 @item message-send-hook
1663 @vindex message-send-hook
1664 Hook run before sending messages.
1665
1666 If you want to add certain headers before sending, you can use the
1667 @code{message-add-header} function in this hook.  For instance:
1668 @findex message-add-header
1669
1670 @lisp
1671 (add-hook 'message-send-hook 'my-message-add-content)
1672 (defun my-message-add-content ()
1673   (message-add-header "X-In-No-Sense: Nonsense")
1674   (message-add-header "X-Whatever: no"))
1675 @end lisp
1676
1677 This function won't add the header if the header is already present.
1678
1679 @item message-send-mail-hook
1680 @vindex message-send-mail-hook
1681 Hook run before sending mail messages.
1682
1683 @item message-send-news-hook
1684 @vindex message-send-news-hook
1685 Hook run before sending news messages.
1686
1687 @item message-sent-hook
1688 @vindex message-sent-hook
1689 Hook run after sending messages.
1690
1691 @item message-cancel-hook
1692 @vindex message-cancel-hook
1693 Hook run when cancelling news articles.
1694
1695 @item message-mode-syntax-table
1696 @vindex message-mode-syntax-table
1697 Syntax table used in message mode buffers.
1698
1699 @item message-strip-special-text-properties
1700 @vindex message-strip-special-text-properties
1701 Emacs has a number of special text properties which can break message
1702 composing in various ways.  If this option is set, message will strip
1703 these properties from the message composition buffer.  However, some
1704 packages requires these properties to be present in order to work.  If
1705 you use one of these packages, turn this option off, and hope the
1706 message composition doesn't break too bad.
1707
1708 @item message-send-method-alist
1709 @vindex message-send-method-alist
1710
1711 Alist of ways to send outgoing messages.  Each element has the form
1712
1713 @lisp
1714 (TYPE PREDICATE FUNCTION)
1715 @end lisp
1716
1717 @table @var
1718 @item type
1719 A symbol that names the method.
1720
1721 @item predicate
1722 A function called without any parameters to determine whether the
1723 message is a message of type @var{type}.
1724
1725 @item function
1726 A function to be called if @var{predicate} returns non-@code{nil}.
1727 @var{function} is called with one parameter -- the prefix.
1728 @end table
1729
1730 @lisp
1731 ((news message-news-p message-send-via-news)
1732  (mail message-mail-p message-send-via-mail))
1733 @end lisp
1734
1735
1736
1737 @end table
1738
1739
1740
1741 @node Sending Variables
1742 @section Sending Variables
1743
1744 @table @code
1745
1746 @item message-fcc-handler-function
1747 @vindex message-fcc-handler-function
1748 A function called to save outgoing articles.  This function will be
1749 called with the name of the file to store the article in.  The default
1750 function is @code{message-output} which saves in Unix mailbox format.
1751
1752 @item message-courtesy-message
1753 @vindex message-courtesy-message
1754 When sending combined messages, this string is inserted at the start of
1755 the mailed copy.  If the string contains the format spec @samp{%s}, the
1756 newsgroups the article has been posted to will be inserted there.  If
1757 this variable is @code{nil}, no such courtesy message will be added.
1758 The default value is @samp{"The following message is a courtesy copy of
1759 an article\\nthat has been posted to %s as well.\\n\\n"}.
1760
1761 @item message-fcc-externalize-attachments
1762 @vindex message-fcc-externalize-attachments
1763 If @code{nil}, attach files as normal parts in Fcc copies; if it is
1764 non-@code{nil}, attach local files as external parts.
1765
1766 @item message-interactive
1767 @vindex message-interactive
1768 If non-@code{nil} wait for and display errors when sending a message;
1769 if @code{nil} let the mailer mail back a message to report errors.
1770
1771 @end table
1772
1773
1774 @node Message Buffers
1775 @section Message Buffers
1776
1777 Message will generate new buffers with unique buffer names when you
1778 request a message buffer.  When you send the message, the buffer isn't
1779 normally killed off.  Its name is changed and a certain number of old
1780 message buffers are kept alive.
1781
1782 @table @code
1783 @item message-generate-new-buffers
1784 @vindex message-generate-new-buffers
1785 If non-@code{nil}, generate new buffers.  The default is @code{t}.  If
1786 this is a function, call that function with three parameters: The type,
1787 the to address and the group name.  (Any of these may be @code{nil}.)
1788 The function should return the new buffer name.
1789
1790 @item message-use-multi-frames
1791 @vindex message-use-multi-frames
1792 If non-@code{nil}, generate new frames. The default is @code{nil}.
1793
1794 @item message-delete-frame-on-exit
1795 @vindex message-delete-frame-on-exit
1796 The @code{message-delete-frame-on-exit} variable says whether to delete
1797 the frame after sending the message or killing the message buffer. If it
1798 is @code{nil} (which is the default), don't delete the frame. If it is
1799 @code{ask}, ask wheter to delete the frame. If it is @code{t}, always
1800 delete the frame.
1801
1802 @item message-max-buffers
1803 @vindex message-max-buffers
1804 This variable says how many old message buffers to keep.  If there are
1805 more message buffers than this, the oldest buffer will be killed.  The
1806 default is 10.  If this variable is @code{nil}, no old message buffers
1807 will ever be killed.
1808
1809 @item message-send-rename-function
1810 @vindex message-send-rename-function
1811 After sending a message, the buffer is renamed from, for instance,
1812 @samp{*reply to Lars*} to @samp{*sent reply to Lars*}.  If you don't
1813 like this, set this variable to a function that renames the buffer in a
1814 manner you like.  If you don't want to rename the buffer at all, you can
1815 say:
1816
1817 @lisp
1818 (setq message-send-rename-function 'ignore)
1819 @end lisp
1820
1821 @item message-kill-buffer-on-exit
1822 @vindex message-kill-buffer-on-exit
1823 If non-@code{nil}, kill the buffer immediately on exit.
1824
1825 @item message-kill-buffer-query-function
1826 @vindex message-kill-buffer-query-function
1827 @findex message-kill-buffer
1828 @findex message-mimic-kill-buffer
1829 Function used to prompt user whether to kill the message buffer when the
1830 command @code{message-kill-buffer} or @code{message-mimic-kill-buffer}
1831 is used.  It defaults to @code{yes-or-no-p}.  You may alter the value to
1832 @code{y-or-n-p}, @code{nnheader-Y-or-n-p}, etc.  If it is @code{t}, the
1833 buffer will be killed without query.
1834
1835 @item message-kill-buffer-and-remove-file
1836 @vindex message-kill-buffer-and-remove-file
1837 @findex message-kill-buffer
1838 @findex message-mimic-kill-buffer
1839 If it is non-@code{nil}, remove the backup file if it exists with a
1840 query to the user, after the message buffer is killed.  Otherwise the
1841 file won't be removed.  It defaults to @code{t}.  However, it is treated
1842 as @code{nil} when the command `message-mimic-kill-buffer' is used.
1843
1844 @end table
1845
1846
1847 @node Message Actions
1848 @section Message Actions
1849
1850 When Message is being used from a news/mail reader, the reader is likely
1851 to want to perform some task after the message has been sent.  Perhaps
1852 return to the previous window configuration or mark an article as
1853 replied.
1854
1855 @vindex message-kill-actions
1856 @vindex message-postpone-actions
1857 @vindex message-exit-actions
1858 @vindex message-send-actions
1859 The user may exit from the message buffer in various ways.  The most
1860 common is @kbd{C-c C-c}, which sends the message and exits.  Other
1861 possibilities are @kbd{C-c C-s} which just sends the message, @kbd{C-c
1862 C-d} which postpones the message editing and buries the message buffer,
1863 and @kbd{C-c C-k} which kills the message buffer.  Each of these actions
1864 have lists associated with them that contains actions to be executed:
1865 @code{message-send-actions}, @code{message-exit-actions},
1866 @code{message-postpone-actions}, and @code{message-kill-actions}.
1867
1868 Message provides a function to interface with these lists:
1869 @code{message-add-action}.  The first parameter is the action to be
1870 added, and the rest of the arguments are which lists to add this action
1871 to.  Here's an example from Gnus:
1872
1873 @lisp
1874   (message-add-action
1875    `(set-window-configuration ,(current-window-configuration))
1876    'exit 'postpone 'kill)
1877 @end lisp
1878
1879 This restores the Gnus window configuration when the message buffer is
1880 killed, postponed or exited.
1881
1882 An @dfn{action} can be either: a normal function, or a list where the
1883 @code{car} is a function and the @code{cdr} is the list of arguments, or
1884 a form to be @code{eval}ed.
1885
1886
1887 @node Compatibility
1888 @chapter Compatibility
1889 @cindex compatibility
1890
1891 Message uses virtually only its own variables---older @code{mail-}
1892 variables aren't consulted.  To force Message to take those variables
1893 into account, you can put the following in your @file{.emacs} file:
1894
1895 @lisp
1896 (require 'messcompat)
1897 @end lisp
1898
1899 This will initialize many Message variables from the values in the
1900 corresponding mail variables.
1901
1902
1903 @node Appendices
1904 @chapter Appendices
1905
1906 @menu
1907 * Responses::          Standard rules for determining where responses go.
1908 @end menu
1909
1910
1911 @node Responses
1912 @section Responses
1913
1914 To determine where a message is to go, the following algorithm is used
1915 by default.
1916
1917 @table @dfn
1918 @item reply
1919 A @dfn{reply} is when you want to respond @emph{just} to the person who
1920 sent the message via mail.  There will only be one recipient.  To
1921 determine who the recipient will be, the following headers are
1922 consulted, in turn:
1923
1924 @table @code
1925 @item Reply-To
1926
1927 @item From
1928 @end table
1929
1930
1931 @item wide reply
1932 A @dfn{wide reply} is a mail response that includes @emph{all} entities
1933 mentioned in the message you are responded to.  All mailboxes from the
1934 following headers will be concatenated to form the outgoing
1935 @code{To}/@code{Cc} headers:
1936
1937 @table @code
1938 @item From
1939 (unless there's a @code{Reply-To}, in which case that is used instead).
1940
1941 @item Cc
1942
1943 @item To
1944 @end table
1945
1946 If a @code{Mail-Copies-To} header is present, it will also be included
1947 in the list of mailboxes.  If this header is @samp{never}, that means
1948 that the @code{From} (or @code{Reply-To}) mailbox will be suppressed.
1949
1950
1951 @item followup
1952 A @dfn{followup} is a response sent via news.  The following headers
1953 (listed in order of precedence) determine where the response is to be
1954 sent:
1955
1956 @table @code
1957
1958 @item Followup-To
1959
1960 @item Newsgroups
1961
1962 @end table
1963
1964 If a @code{Mail-Copies-To} header is present, it will be used as the
1965 basis of the new @code{Cc} header, except if this header is
1966 @samp{never}.
1967
1968 @end table
1969
1970
1971
1972 @node Index
1973 @chapter Index
1974 @printindex cp
1975
1976 @node Key Index
1977 @chapter Key Index
1978 @printindex ky
1979
1980 @summarycontents
1981 @contents
1982 @bye
1983
1984 @c End: