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