5ea0daabde5d3bdbb09c04e2dd9108608e13a607
[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 @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}).  It will
1001 delete the message frame if it has been created exclusively for the
1002 message buffer.  If the option
1003 @code{message-kill-buffer-and-remove-file} is non-@code{nil} and the
1004 backup file has been created for the message buffer, it will also remove
1005 the file after prompting to the user.
1006
1007 @item C-x k
1008 @kindex C-x k
1009 @findex message-mimic-kill-buffer
1010 @vindex message-kill-buffer-and-remove-file
1011 This is an imitation for @code{kill-buffer}
1012 (@code{message-mimic-kill-buffer}).  It dynamically binds the variable
1013 @code{message-kill-buffer-and-remove-file} to @code{nil} and calls the
1014 function @code{message-kill-buffer}.
1015
1016 @end table
1017
1018
1019
1020 @node Mail Aliases
1021 @section Mail Aliases
1022 @cindex mail aliases
1023 @cindex aliases
1024
1025 @vindex message-mail-alias-type
1026 The @code{message-mail-alias-type} variable controls what type of mail
1027 alias expansion to use.  Currently only one form is supported---Message
1028 uses @code{mailabbrev} to handle mail aliases.  If this variable is
1029 @code{nil}, no mail alias expansion will be performed.
1030
1031 @code{mailabbrev} works by parsing the @file{/etc/mailrc} and
1032 @file{~/.mailrc} files.  These files look like:
1033
1034 @example
1035 alias lmi "Lars Magne Ingebrigtsen <larsi@@ifi.uio.no>"
1036 alias ding "ding@@ifi.uio.no (ding mailing list)"
1037 @end example
1038
1039 After adding lines like this to your @file{~/.mailrc} file, you should
1040 be able to just write @samp{lmi} in the @code{To} or @code{Cc} (and so
1041 on) headers and press @kbd{SPC} to expand the alias.
1042
1043 No expansion will be performed upon sending of the message---all
1044 expansions have to be done explicitly.
1045
1046
1047 @node Spelling
1048 @section Spelling
1049 @cindex spelling
1050 @findex ispell-message
1051
1052 There are two popular ways to have Emacs spell-check your messages:
1053 @code{ispell} and @code{flyspell}.  @code{ispell} is the older and
1054 probably more popular package.  You typically first write the message,
1055 and then run the entire thing through @code{ispell} and fix all the
1056 typos.  To have this happen automatically when you send a message, put
1057 something like the following in your @file{.emacs} file:
1058
1059 @lisp
1060 (add-hook 'message-send-hook 'ispell-message)
1061 @end lisp
1062
1063 @vindex ispell-message-dictionary-alist
1064 If you're in the habit of writing in different languages, this can be
1065 controlled by the @code{ispell-message-dictionary-alist} variable:
1066
1067 @lisp
1068 (setq ispell-message-dictionary-alist
1069       '(("^Newsgroups:.*\\bde\\." . "deutsch8")
1070         (".*" . "default")))
1071 @end lisp
1072
1073 @code{ispell} depends on having the external @samp{ispell} command
1074 installed.
1075
1076 The other popular method is using @code{flyspell}.  This package checks
1077 your spelling while you're writing, and marks any mis-spelled words in
1078 various ways.
1079
1080 To use @code{flyspell}, put something like the following in your
1081 @file{.emacs} file:
1082
1083 @lisp
1084 (defun my-message-setup-routine ()
1085   (flyspell-mode 1))
1086 (add-hook 'message-setup-hook 'my-message-setup-routine)
1087 @end lisp
1088
1089 @code{flyspell} depends on having the external @samp{ispell} command
1090 installed.
1091
1092
1093 @node Variables
1094 @chapter Variables
1095
1096 @menu
1097 * Message Headers::             General message header stuff.
1098 * Mail Headers::                Customizing mail headers.
1099 * Mail Variables::              Other mail variables.
1100 * News Headers::                Customizing news headers.
1101 * News Variables::              Other news variables.
1102 * Insertion Variables::         Customizing how things are inserted.
1103 * Various Message Variables::   Other message variables.
1104 * Sending Variables::           Variables for sending.
1105 * Message Buffers::             How Message names its buffers.
1106 * Message Actions::             Actions to be performed when exiting.
1107 @end menu
1108
1109
1110 @node Message Headers
1111 @section Message Headers
1112
1113 Message is quite aggressive on the message generation front.  It has to
1114 be -- it's a combined news and mail agent.  To be able to send combined
1115 messages, it has to generate all headers itself (instead of letting the
1116 mail/news system do it) to ensure that mail and news copies of messages
1117 look sufficiently similar.
1118
1119 @table @code
1120
1121 @item message-generate-headers-first
1122 @vindex message-generate-headers-first
1123 If non-@code{nil}, generate all required headers before starting to
1124 compose the message.
1125
1126 The variables @code{message-required-mail-headers} and
1127 @code{message-required-news-headers} specify which headers are required.
1128
1129 Note that some headers will be removed and re-generated before posting,
1130 because of the variable @code{message-deletable-headers} (see below).
1131
1132 @item message-from-style
1133 @vindex message-from-style
1134 Specifies how @code{From} headers should look.  There are four valid
1135 values:
1136
1137 @table @code
1138 @item nil
1139 Just the address -- @samp{king@@grassland.com}.
1140
1141 @item parens
1142 @samp{king@@grassland.com (Elvis Parsley)}.
1143
1144 @item angles
1145 @samp{Elvis Parsley <king@@grassland.com>}.
1146
1147 @item default
1148 Look like @code{angles} if that doesn't require quoting, and
1149 @code{parens} if it does.  If even @code{parens} requires quoting, use
1150 @code{angles} anyway.
1151
1152 @end table
1153
1154 @item message-deletable-headers
1155 @vindex message-deletable-headers
1156 Headers in this list that were previously generated by Message will be
1157 deleted before posting.  Let's say you post an article.  Then you decide
1158 to post it again to some other group, you naughty boy, so you jump back
1159 to the @code{*post-buf*} buffer, edit the @code{Newsgroups} line, and
1160 ship it off again.  By default, this variable makes sure that the old
1161 generated @code{Message-ID} is deleted, and a new one generated.  If
1162 this isn't done, the entire empire would probably crumble, anarchy would
1163 prevail, and cats would start walking on two legs and rule the world.
1164 Allegedly.
1165
1166 @item message-default-headers
1167 @vindex message-default-headers
1168 This string is inserted at the end of the headers in all message
1169 buffers.
1170
1171 @item message-subject-re-regexp
1172 @vindex message-subject-re-regexp
1173 @cindex Aw
1174 @cindex Sv
1175 @cindex Re
1176 Responses to messages have subjects that start with @samp{Re: }.  This
1177 is @emph{not} an abbreviation of the English word ``response'', but is
1178 Latin, and means ``in response to''.  Some illiterate nincompoops have
1179 failed to grasp this fact, and have ``internationalized'' their software
1180 to use abonimations like @samp{Aw: } (``antwort'') or @samp{Sv: }
1181 (``svar'') instead, which is meaningless and evil.  However, you may
1182 have to deal with users that use these evil tools, in which case you may
1183 set this variable to a regexp that matches these prefixes.  Myself, I
1184 just throw away non-compliant mail.
1185
1186 Here's an example of a value to deal with these headers when
1187 responding to a message:
1188
1189 @lisp
1190 (setq message-subject-re-regexp
1191      "^\\(\\(\\([Rr][Ee]\\|[Ss][Vv]\\|[Aa][Ww]\\): *\\)+\\)")
1192 @end lisp
1193
1194 @item message-alternative-emails
1195 @vindex message-alternative-emails
1196 A regexp to match the alternative email addresses.  The first matched
1197 address (not primary one) is used in the @code{From} field.
1198
1199 @end table
1200
1201
1202 @node Mail Headers
1203 @section Mail Headers
1204
1205 @table @code
1206 @item message-required-mail-headers
1207 @vindex message-required-mail-headers
1208 @xref{News Headers}, for the syntax of this variable.  It is
1209 @code{(From Date Subject (optional . In-Reply-To) Message-ID Lines
1210 (optional . User-Agent))} by default.
1211
1212 @item message-ignored-mail-headers
1213 @vindex message-ignored-mail-headers
1214 Regexp of headers to be removed before mailing.  The default is
1215 @samp{^[GF]cc:\\|^Resent-Fcc:\\|^Xref:\\|^X-Draft-From:}.
1216
1217 @item message-default-mail-headers
1218 @vindex message-default-mail-headers
1219 This string is inserted at the end of the headers in all message
1220 buffers that are initialized as mail.
1221
1222 @end table
1223
1224
1225 @node Mail Variables
1226 @section Mail Variables
1227
1228 @table @code
1229 @item message-send-mail-function
1230 @vindex message-send-mail-function
1231 @findex message-send-mail-with-sendmail
1232 @findex message-send-mail-with-mh
1233 @findex message-send-mail-with-qmail
1234 @findex message-smtpmail-send-it
1235 @findex smtpmail-send-it
1236 @findex feedmail-send-it
1237 Function used to send the current buffer as mail. The default is
1238 @code{message-send-mail-with-sendmail}. Other valid values include
1239 @code{message-send-mail-with-mh}, @code{message-send-mail-with-qmail},
1240 @code{message-smtpmail-send-it}, @code{smtpmail-send-it} and
1241 @code{feedmail-send-it}.
1242
1243 @item message-mh-deletable-headers
1244 @vindex message-mh-deletable-headers
1245 Most versions of MH doesn't like being fed messages that contain the
1246 headers in this variable.  If this variable is non-@code{nil} (which is
1247 the default), these headers will be removed before mailing when sending
1248 messages via MH.  Set it to @code{nil} if your MH can handle these
1249 headers.
1250
1251 @item message-qmail-inject-program
1252 @vindex message-qmail-inject-program
1253 @cindex qmail
1254 Location of the qmail-inject program.
1255
1256 @item message-qmail-inject-args
1257 @vindex message-qmail-inject-args
1258 Arguments passed to qmail-inject programs.
1259 This should be a list of strings, one string for each argument.  It
1260 may also be a function.
1261
1262 For e.g., if you wish to set the envelope sender address so that bounces
1263 go to the right place or to deal with listserv's usage of that address, you
1264 might set this variable to @code{'("-f" "you@@some.where")}.
1265
1266 @item message-sendmail-f-is-evil
1267 @vindex message-sendmail-f-is-evil
1268 @cindex sendmail
1269 Non-@code{nil} means don't add @samp{-f username} to the sendmail
1270 command line.  Doing so would be even more evil than leaving it out.
1271
1272 @item message-mailer-swallows-blank-line
1273 @vindex message-mailer-swallows-blank-line
1274 Set this to non-@code{nil} if the system's mailer runs the header and
1275 body together.  (This problem exists on Sunos 4 when sendmail is run
1276 in remote mode.)  The value should be an expression to test whether
1277 the problem will actually occur.
1278
1279 @item message-send-mail-partially-limit
1280 @vindex message-send-mail-partially-limit
1281 The limitation of messages sent as message/partial.
1282 The lower bound of message size in characters, beyond which the message
1283 should be sent in several parts. If it is nil, the size is unlimited.
1284
1285 @end table
1286
1287
1288 @node News Headers
1289 @section News Headers
1290
1291 @vindex message-required-news-headers
1292 @code{message-required-news-headers} a list of header symbols.  These
1293 headers will either be automatically generated, or, if that's
1294 impossible, they will be prompted for.  The following symbols are valid:
1295
1296 @table @code
1297
1298 @item From
1299 @cindex From
1300 @findex user-full-name
1301 @findex user-mail-address
1302 This required header will be filled out with the result of the
1303 @code{message-make-from} function, which depends on the
1304 @code{message-from-style}, @code{user-full-name},
1305 @code{user-mail-address} variables.
1306
1307 @item Subject
1308 @cindex Subject
1309 This required header will be prompted for if not present already.
1310
1311 @item Newsgroups
1312 @cindex Newsgroups
1313 This required header says which newsgroups the article is to be posted
1314 to.  If it isn't present already, it will be prompted for.
1315
1316 @item Organization
1317 @cindex organization
1318 @vindex message-user-organization
1319 @vindex message-user-organization-file
1320 This optional header will be filled out depending on the
1321 @code{message-user-organization} variable.
1322 @code{message-user-organization-file} will be used if this variable is
1323 @code{t}.  This variable can also be a string (in which case this string
1324 will be used), or it can be a function (which will be called with no
1325 parameters and should return a string to be used).
1326
1327 @item Lines
1328 @cindex Lines
1329 This optional header will be computed by Message.
1330
1331 @item Message-ID
1332 @cindex Message-ID
1333 @vindex mail-host-address
1334 @findex system-name
1335 @cindex Sun
1336 This required header will be generated by Message.  A unique ID will be
1337 created based on the date, time, user name and system name.  Message
1338 will use @code{system-name} to determine the name of the system.  If
1339 this isn't a fully qualified domain name (FQDN), Message will use
1340 @code{mail-host-address} as the FQDN of the machine.
1341
1342 @item User-Agent
1343 @cindex User-Agent
1344 This optional header will be filled out according to the
1345 @code{message-newsreader} local variable.
1346
1347 @item In-Reply-To
1348 This optional header is filled out using the @code{Date} and @code{From}
1349 header of the article being replied to.
1350
1351 @item Expires
1352 @cindex Expires
1353 @vindex message-expires
1354 This extremely optional header will be inserted according to the
1355 @code{message-expires} variable.  It is highly deprecated and shouldn't
1356 be used unless you know what you're doing.
1357
1358 @item Distribution
1359 @cindex Distribution
1360 @vindex message-distribution-function
1361 This optional header is filled out according to the
1362 @code{message-distribution-function} variable.  It is a deprecated and
1363 much misunderstood header.
1364
1365 @item Path
1366 @cindex path
1367 @vindex message-user-path
1368 This extremely optional header should probably never be used.
1369 However, some @emph{very} old servers require that this header is
1370 present.  @code{message-user-path} further controls how this
1371 @code{Path} header is to look.  If it is @code{nil}, use the server name
1372 as the leaf node.  If it is a string, use the string.  If it is neither
1373 a string nor @code{nil}, use the user name only.  However, it is highly
1374 unlikely that you should need to fiddle with this variable at all.
1375 @end table
1376
1377 @findex yow
1378 @cindex Mime-Version
1379 In addition, you can enter conses into this list.  The car of this cons
1380 should be a symbol.  This symbol's name is the name of the header, and
1381 the cdr can either be a string to be entered verbatim as the value of
1382 this header, or it can be a function to be called.  This function should
1383 return a string to be inserted.  For instance, if you want to insert
1384 @code{Mime-Version: 1.0}, you should enter @code{(Mime-Version . "1.0")}
1385 into the list.  If you want to insert a funny quote, you could enter
1386 something like @code{(X-Yow . yow)} into the list.  The function
1387 @code{yow} will then be called without any arguments.
1388
1389 If the list contains a cons where the car of the cons is
1390 @code{optional}, the cdr of this cons will only be inserted if it is
1391 non-@code{nil}.
1392
1393 If you want to delete an entry from this list, the following Lisp
1394 snippet might be useful.  Adjust accordingly if you want to remove
1395 another element.
1396
1397 @lisp
1398 (setq message-required-news-headers
1399       (delq 'Message-ID message-required-news-headers))
1400 @end lisp
1401
1402 Other variables for customizing outgoing news articles:
1403
1404 @table @code
1405
1406 @item message-syntax-checks
1407 @vindex message-syntax-checks
1408 Controls what syntax checks should not be performed on outgoing posts.
1409 To disable checking of long signatures, for instance, add
1410
1411 @lisp
1412 (signature . disabled)
1413 @end lisp
1414
1415 to this list.
1416
1417 Valid checks are:
1418
1419 @table @code
1420 @item subject-cmsg
1421 Check the subject for commands.
1422 @item sender
1423 @cindex Sender
1424 Insert a new @code{Sender} header if the @code{From} header looks odd.
1425 @item multiple-headers
1426 Check for the existence of multiple equal headers.
1427 @item sendsys
1428 @cindex sendsys
1429 Check for the existence of version and sendsys commands.
1430 @item message-id
1431 Check whether the @code{Message-ID} looks ok.
1432 @item from
1433 Check whether the @code{From} header seems nice.
1434 @item long-lines
1435 @cindex long lines
1436 Check for too long lines.
1437 @item control-chars
1438 Check for invalid characters.
1439 @item size
1440 Check for excessive size.
1441 @item new-text
1442 Check whether there is any new text in the messages.
1443 @item signature
1444 Check the length of the signature.
1445 @item approved
1446 @cindex approved
1447 Check whether the article has an @code{Approved} header, which is
1448 something only moderators should include.
1449 @item empty
1450 Check whether the article is empty.
1451 @item invisible-text
1452 Check whether there is any invisible text in the buffer.
1453 @item empty-headers
1454 Check whether any of the headers are empty.
1455 @item existing-newsgroups
1456 Check whether the newsgroups mentioned in the @code{Newsgroups} and
1457 @code{Followup-To} headers exist.
1458 @item valid-newsgroups
1459 Check whether the @code{Newsgroups} and @code{Followup-to} headers
1460 are valid syntactically.
1461 @item repeated-newsgroups
1462 Check whether the @code{Newsgroups} and @code{Followup-to} headers
1463 contains repeated group names.
1464 @item shorten-followup-to
1465 Check whether to add a @code{Followup-to} header to shorten the number
1466 of groups to post to.
1467 @end table
1468
1469 All these conditions are checked by default.
1470
1471 @item message-ignored-news-headers
1472 @vindex message-ignored-news-headers
1473 Regexp of headers to be removed before posting.  The default is@*
1474 @samp{^NNTP-Posting-Host:\\|^Xref:\\|^[BGF]cc:\\|^Resent-Fcc:\\|^X-Draft-From:}.
1475
1476 @item message-default-news-headers
1477 @vindex message-default-news-headers
1478 This string is inserted at the end of the headers in all message
1479 buffers that are initialized as news.
1480
1481 @end table
1482
1483
1484 @node News Variables
1485 @section News Variables
1486
1487 @table @code
1488 @item message-send-news-function
1489 @vindex message-send-news-function
1490 Function used to send the current buffer as news.  The default is
1491 @code{message-send-news}.
1492
1493 @item message-post-method
1494 @vindex message-post-method
1495 Gnusish @dfn{select method} (see the Gnus manual for details) used for
1496 posting a prepared news message.
1497
1498 @end table
1499
1500
1501 @node Insertion Variables
1502 @section Insertion Variables
1503
1504 @table @code
1505 @item message-ignored-cited-headers
1506 @vindex message-ignored-cited-headers
1507 All headers that match this regexp will be removed from yanked
1508 messages.  The default is @samp{.}, which means that all headers will be
1509 removed.
1510
1511 @item message-cite-prefix-regexp
1512 @vindex message-cite-prefix-regexp
1513 Regexp matching the longest possible citation prefix on a line.
1514
1515 @item message-citation-line-function
1516 @vindex message-citation-line-function
1517 @cindex attribution line
1518 Function called to insert the citation line.  The default is
1519 @code{message-insert-citation-line}, which will lead to citation lines
1520 that look like:
1521
1522 @example
1523 Hallvard B Furuseth <h.b.furuseth@@usit.uio.no> writes:
1524 @end example
1525
1526 Point will be at the beginning of the body of the message when this
1527 function is called.
1528
1529 Note that Gnus provides a feature where clicking on `writes:' hides the
1530 cited text.  If you change the citation line too much, readers of your
1531 messages will have to adjust their Gnus, too.  See the variable
1532 @code{gnus-cite-attribution-suffix}.  @xref{Article Highlighting, ,
1533 Article Highlighting, gnus}, for details.
1534
1535 @item message-yank-prefix
1536 @vindex message-yank-prefix
1537 @cindex yanking
1538 @cindex quoting
1539 When you are replying to or following up an article, you normally want
1540 to quote the person you are answering.  Inserting quoted text is done
1541 by @dfn{yanking}, and each line you yank will have
1542 @code{message-yank-prefix} prepended to it (except for quoted and
1543 empty lines which uses @code{message-yank-cited-prefix}). The default
1544 is @samp{> }.
1545
1546 @item message-yank-cited-prefix
1547 @vindex message-yank-cited-prefix
1548 @cindex yanking
1549 @cindex cited
1550 @cindex quoting
1551 When yanking text from a article which contains no text or already
1552 cited text, each line will be prefixed with the contents of this
1553 variable.  The default is @samp{>}.  See also
1554 @code{message-yank-prefix}.
1555
1556 @item message-yank-add-new-references
1557 @vindex message-yank-add-new-references
1558 @cindex yanking
1559 Non-@code{nil} means new IDs will be added to References field when an
1560 article is yanked by the command @code{message-yank-original}
1561 interactively.  If it is a symbol @code{message-id-only}, only an ID
1562 from Message-ID field is used, otherwise IDs extracted from References,
1563 In-Reply-To and Message-ID fields are used.
1564
1565 @item message-list-references-add-position
1566 @vindex message-list-references-add-position
1567 @cindex yanking
1568 Integer value means position for adding to References field when an
1569 article is yanked by the command @code{message-yank-original}
1570 interactively.
1571
1572 @item message-indentation-spaces
1573 @vindex message-indentation-spaces
1574 Number of spaces to indent yanked messages.
1575
1576 @item message-cite-function
1577 @vindex message-cite-function
1578 @findex message-cite-original
1579 @findex sc-cite-original
1580 @findex message-cite-original-without-signature
1581 @cindex Supercite
1582 Function for citing an original message.  The default is
1583 @code{message-cite-original}, which simply inserts the original message
1584 and prepends @samp{> } to each line.
1585 @code{message-cite-original-without-signature} does the same, but elides
1586 the signature.  You can also set it to @code{sc-cite-original} to use
1587 Supercite.
1588
1589 @item message-suspend-font-lock-when-citing
1590 @vindex message-suspend-font-lock-when-citing
1591 If non-@code{nil}, suspend font-lock'ing while citing an original
1592 message.  Some lazy demand-driven fontification tools (or Emacs itself)
1593 have a bug that they often miss a buffer to be fontified.  It will
1594 mostly occur when Emacs prompts user for any inputs in the minibuffer.
1595 Setting this option to non-@code{nil} may help you to avoid unpleasant
1596 errors even if it is an add-hoc expedient.
1597
1598 @item message-indent-citation-function
1599 @vindex message-indent-citation-function
1600 Function for modifying a citation just inserted in the mail buffer.
1601 This can also be a list of functions.  Each function can find the
1602 citation between @code{(point)} and @code{(mark t)}.  And each function
1603 should leave point and mark around the citation text as modified.
1604
1605 @item message-signature
1606 @vindex message-signature
1607 String to be inserted at the end of the message buffer.  If @code{t}
1608 (which is the default), the @code{message-signature-file} file will be
1609 inserted instead.  If a function, the result from the function will be
1610 used instead.  If a form, the result from the form will be used instead.
1611 If this variable is @code{nil}, no signature will be inserted at all.
1612
1613 @item message-signature-file
1614 @vindex message-signature-file
1615 File containing the signature to be inserted at the end of the buffer.
1616 The default is @file{~/.signature}.
1617
1618 @end table
1619
1620 Note that RFC1036bis says that a signature should be preceded by the three
1621 characters @samp{-- } on a line by themselves.  This is to make it
1622 easier for the recipient to automatically recognize and process the
1623 signature.  So don't remove those characters, even though you might feel
1624 that they ruin your beautiful design, like, totally.
1625
1626 Also note that no signature should be more than four lines long.
1627 Including ASCII graphics is an efficient way to get everybody to believe
1628 that you are silly and have nothing important to say.
1629
1630
1631 @node Various Message Variables
1632 @section Various Message Variables
1633
1634 @table @code
1635 @item message-default-charset
1636 @vindex message-default-charset
1637 @cindex charset
1638 Symbol naming a @sc{mime} charset.  Non-ASCII characters in messages are
1639 assumed to be encoded using this charset.  The default is @code{nil},
1640 which means ask the user.  (This variable is used only on non-@sc{mule}
1641 Emacsen.
1642 @xref{Charset Translation, , Charset Translation, emacs-mime,
1643       Emacs MIME Manual}, for details on the @sc{mule}-to-@sc{mime}
1644 translation process.
1645
1646 @item message-signature-separator
1647 @vindex message-signature-separator
1648 Regexp matching the signature separator.  It is @samp{^-- *$} by
1649 default.
1650
1651 @item mail-header-separator
1652 @vindex mail-header-separator
1653 String used to separate the headers from the body.  It is @samp{--text
1654 follows this line--} by default.
1655
1656 @item message-directory
1657 @vindex message-directory
1658 Directory used by many mailey things.  The default is @file{~/Mail/}.
1659
1660 @item message-auto-save-directory
1661 @vindex message-auto-save-directory
1662 Directory where Message auto-saves buffers if Gnus isn't running.  If
1663 @code{nil}, Message won't auto-save.  The default is @file{~/Mail/drafts/}.
1664
1665 @item message-signature-setup-hook
1666 @vindex message-signature-setup-hook
1667 Hook run when initializing the message buffer.  It is run after the
1668 headers have been inserted but before the signature has been inserted.
1669
1670 @item message-setup-hook
1671 @vindex message-setup-hook
1672 Hook run as the last thing when the message buffer has been initialized,
1673 but before yanked text is inserted.
1674
1675 @item message-header-setup-hook
1676 @vindex message-header-setup-hook
1677 Hook called narrowed to the headers after initializing the headers.
1678
1679 For instance, if you're running Gnus and wish to insert a
1680 @samp{Mail-Copies-To} header in all your news articles and all messages
1681 you send to mailing lists, you could do something like the following:
1682
1683 @lisp
1684 (defun my-message-header-setup-hook ()
1685   (let ((group (or gnus-newsgroup-name "")))
1686     (when (or (message-fetch-field "newsgroups")
1687               (gnus-group-find-parameter group 'to-address)
1688               (gnus-group-find-parameter group 'to-list))
1689       (insert "Mail-Copies-To: never\n"))))
1690
1691 (add-hook 'message-header-setup-hook
1692           'my-message-header-setup-hook)
1693 @end lisp
1694
1695 @item message-send-hook
1696 @vindex message-send-hook
1697 Hook run before sending messages.
1698
1699 If you want to add certain headers before sending, you can use the
1700 @code{message-add-header} function in this hook.  For instance:
1701 @findex message-add-header
1702
1703 @lisp
1704 (add-hook 'message-send-hook 'my-message-add-content)
1705 (defun my-message-add-content ()
1706   (message-add-header "X-In-No-Sense: Nonsense")
1707   (message-add-header "X-Whatever: no"))
1708 @end lisp
1709
1710 This function won't add the header if the header is already present.
1711
1712 @item message-send-mail-hook
1713 @vindex message-send-mail-hook
1714 Hook run before sending mail messages.
1715
1716 @item message-send-news-hook
1717 @vindex message-send-news-hook
1718 Hook run before sending news messages.
1719
1720 @item message-sent-hook
1721 @vindex message-sent-hook
1722 Hook run after sending messages.
1723
1724 @item message-cancel-hook
1725 @vindex message-cancel-hook
1726 Hook run when cancelling news articles.
1727
1728 @item message-mode-syntax-table
1729 @vindex message-mode-syntax-table
1730 Syntax table used in message mode buffers.
1731
1732 @item message-strip-special-text-properties
1733 @vindex message-strip-special-text-properties
1734 Emacs has a number of special text properties which can break message
1735 composing in various ways.  If this option is set, message will strip
1736 these properties from the message composition buffer.  However, some
1737 packages requires these properties to be present in order to work.  If
1738 you use one of these packages, turn this option off, and hope the
1739 message composition doesn't break too bad.
1740
1741 @item message-send-method-alist
1742 @vindex message-send-method-alist
1743
1744 Alist of ways to send outgoing messages.  Each element has the form
1745
1746 @lisp
1747 (TYPE PREDICATE FUNCTION)
1748 @end lisp
1749
1750 @table @var
1751 @item type
1752 A symbol that names the method.
1753
1754 @item predicate
1755 A function called without any parameters to determine whether the
1756 message is a message of type @var{type}.
1757
1758 @item function
1759 A function to be called if @var{predicate} returns non-@code{nil}.
1760 @var{function} is called with one parameter -- the prefix.
1761 @end table
1762
1763 @lisp
1764 ((news message-news-p message-send-via-news)
1765  (mail message-mail-p message-send-via-mail))
1766 @end lisp
1767
1768
1769
1770 @end table
1771
1772
1773
1774 @node Sending Variables
1775 @section Sending Variables
1776
1777 @table @code
1778
1779 @item message-fcc-handler-function
1780 @vindex message-fcc-handler-function
1781 A function called to save outgoing articles.  This function will be
1782 called with the name of the file to store the article in.  The default
1783 function is @code{message-output} which saves in Unix mailbox format.
1784
1785 @item message-courtesy-message
1786 @vindex message-courtesy-message
1787 When sending combined messages, this string is inserted at the start of
1788 the mailed copy.  If the string contains the format spec @samp{%s}, the
1789 newsgroups the article has been posted to will be inserted there.  If
1790 this variable is @code{nil}, no such courtesy message will be added.
1791 The default value is @samp{"The following message is a courtesy copy of
1792 an article\\nthat has been posted to %s as well.\\n\\n"}.
1793
1794 @item message-fcc-externalize-attachments
1795 @vindex message-fcc-externalize-attachments
1796 If @code{nil}, attach files as normal parts in Fcc copies; if it is
1797 non-@code{nil}, attach local files as external parts.
1798
1799 @item message-interactive
1800 @vindex message-interactive
1801 If non-@code{nil} wait for and display errors when sending a message;
1802 if @code{nil} let the mailer mail back a message to report errors.
1803
1804 @end table
1805
1806
1807 @node Message Buffers
1808 @section Message Buffers
1809
1810 Message will generate new buffers with unique buffer names when you
1811 request a message buffer.  When you send the message, the buffer isn't
1812 normally killed off.  Its name is changed and a certain number of old
1813 message buffers are kept alive.
1814
1815 @table @code
1816 @item message-generate-new-buffers
1817 @vindex message-generate-new-buffers
1818 If non-@code{nil}, generate new buffers.  The default is @code{t}.  If
1819 this is a function, call that function with three parameters: The type,
1820 the to address and the group name.  (Any of these may be @code{nil}.)
1821 The function should return the new buffer name.
1822
1823 @item message-use-multi-frames
1824 @vindex message-use-multi-frames
1825 If non-@code{nil}, generate new frames. The default is @code{nil}.
1826
1827 @item message-delete-frame-on-exit
1828 @vindex message-delete-frame-on-exit
1829 The @code{message-delete-frame-on-exit} variable says whether to delete
1830 the frame after sending the message or killing the message buffer. If it
1831 is @code{nil} (which is the default), don't delete the frame. If it is
1832 @code{ask}, ask wheter to delete the frame. If it is @code{t}, always
1833 delete the frame.
1834
1835 @item message-max-buffers
1836 @vindex message-max-buffers
1837 This variable says how many old message buffers to keep.  If there are
1838 more message buffers than this, the oldest buffer will be killed.  The
1839 default is 10.  If this variable is @code{nil}, no old message buffers
1840 will ever be killed.
1841
1842 @item message-send-rename-function
1843 @vindex message-send-rename-function
1844 After sending a message, the buffer is renamed from, for instance,
1845 @samp{*reply to Lars*} to @samp{*sent reply to Lars*}.  If you don't
1846 like this, set this variable to a function that renames the buffer in a
1847 manner you like.  If you don't want to rename the buffer at all, you can
1848 say:
1849
1850 @lisp
1851 (setq message-send-rename-function 'ignore)
1852 @end lisp
1853
1854 @item message-kill-buffer-on-exit
1855 @vindex message-kill-buffer-on-exit
1856 If non-@code{nil}, kill the buffer immediately on exit.
1857
1858 @item message-kill-buffer-query-function
1859 @vindex message-kill-buffer-query-function
1860 @findex message-kill-buffer
1861 @findex message-mimic-kill-buffer
1862 Function used to prompt user whether to kill the message buffer when the
1863 command @code{message-kill-buffer} or @code{message-mimic-kill-buffer}
1864 is used.  It defaults to @code{yes-or-no-p}.  You may alter the value to
1865 @code{y-or-n-p}, @code{nnheader-Y-or-n-p}, etc.  If it is @code{t}, the
1866 buffer will be killed without query.
1867
1868 @item message-kill-buffer-and-remove-file
1869 @vindex message-kill-buffer-and-remove-file
1870 @findex message-kill-buffer
1871 @findex message-mimic-kill-buffer
1872 If it is non-@code{nil}, remove the backup file if it exists with a
1873 query to the user, after the message buffer is killed.  Otherwise the
1874 file won't be removed.  It defaults to @code{t}.  However, it is treated
1875 as @code{nil} when the command `message-mimic-kill-buffer' is used.
1876
1877 @end table
1878
1879
1880 @node Message Actions
1881 @section Message Actions
1882
1883 When Message is being used from a news/mail reader, the reader is likely
1884 to want to perform some task after the message has been sent.  Perhaps
1885 return to the previous window configuration or mark an article as
1886 replied.
1887
1888 @vindex message-kill-actions
1889 @vindex message-postpone-actions
1890 @vindex message-exit-actions
1891 @vindex message-send-actions
1892 The user may exit from the message buffer in various ways.  The most
1893 common is @kbd{C-c C-c}, which sends the message and exits.  Other
1894 possibilities are @kbd{C-c C-s} which just sends the message, @kbd{C-c
1895 C-d} which postpones the message editing and buries the message buffer,
1896 and @kbd{C-c C-k} which kills the message buffer.  Each of these actions
1897 have lists associated with them that contains actions to be executed:
1898 @code{message-send-actions}, @code{message-exit-actions},
1899 @code{message-postpone-actions}, and @code{message-kill-actions}.
1900
1901 Message provides a function to interface with these lists:
1902 @code{message-add-action}.  The first parameter is the action to be
1903 added, and the rest of the arguments are which lists to add this action
1904 to.  Here's an example from Gnus:
1905
1906 @lisp
1907   (message-add-action
1908    `(set-window-configuration ,(current-window-configuration))
1909    'exit 'postpone 'kill)
1910 @end lisp
1911
1912 This restores the Gnus window configuration when the message buffer is
1913 killed, postponed or exited.
1914
1915 An @dfn{action} can be either: a normal function, or a list where the
1916 @code{car} is a function and the @code{cdr} is the list of arguments, or
1917 a form to be @code{eval}ed.
1918
1919
1920 @node Compatibility
1921 @chapter Compatibility
1922 @cindex compatibility
1923
1924 Message uses virtually only its own variables---older @code{mail-}
1925 variables aren't consulted.  To force Message to take those variables
1926 into account, you can put the following in your @file{.emacs} file:
1927
1928 @lisp
1929 (require 'messcompat)
1930 @end lisp
1931
1932 This will initialize many Message variables from the values in the
1933 corresponding mail variables.
1934
1935
1936 @node Appendices
1937 @chapter Appendices
1938
1939 @menu
1940 * Responses::          Standard rules for determining where responses go.
1941 @end menu
1942
1943
1944 @node Responses
1945 @section Responses
1946
1947 To determine where a message is to go, the following algorithm is used
1948 by default.
1949
1950 @table @dfn
1951 @item reply
1952 A @dfn{reply} is when you want to respond @emph{just} to the person who
1953 sent the message via mail.  There will only be one recipient.  To
1954 determine who the recipient will be, the following headers are
1955 consulted, in turn:
1956
1957 @table @code
1958 @item Reply-To
1959
1960 @item From
1961 @end table
1962
1963
1964 @item wide reply
1965 A @dfn{wide reply} is a mail response that includes @emph{all} entities
1966 mentioned in the message you are responded to.  All mailboxes from the
1967 following headers will be concatenated to form the outgoing
1968 @code{To}/@code{Cc} headers:
1969
1970 @table @code
1971 @item From
1972 (unless there's a @code{Reply-To}, in which case that is used instead).
1973
1974 @item Cc
1975
1976 @item To
1977 @end table
1978
1979 If a @code{Mail-Copies-To} header is present, it will also be included
1980 in the list of mailboxes.  If this header is @samp{never}, that means
1981 that the @code{From} (or @code{Reply-To}) mailbox will be suppressed.
1982
1983
1984 @item followup
1985 A @dfn{followup} is a response sent via news.  The following headers
1986 (listed in order of precedence) determine where the response is to be
1987 sent:
1988
1989 @table @code
1990
1991 @item Followup-To
1992
1993 @item Newsgroups
1994
1995 @end table
1996
1997 If a @code{Mail-Copies-To} header is present, it will be used as the
1998 basis of the new @code{Cc} header, except if this header is
1999 @samp{never}.
2000
2001 @end table
2002
2003
2004
2005 @node Index
2006 @chapter Index
2007 @printindex cp
2008
2009 @node Key Index
2010 @chapter Key Index
2011 @printindex ky
2012
2013 @summarycontents
2014 @contents
2015 @bye
2016
2017 @c End: