(message-strip-forbidden-properties): Only display on
[gnus.git] / texi / message.texi
blob5e8e140796efb86062f24bc7cd7c36f6d9865ce6
1 \input texinfo                  @c -*-texinfo-*-
3 @setfilename message
4 @settitle Message Manual
5 @synindex fn cp
6 @synindex vr cp
7 @synindex pg cp
8 @copying
9 This file documents Message, the Emacs message composition mode.
11 Copyright @copyright{} 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
12 2004, 2005, 2006 Free Software Foundation, Inc.
14 @quotation
15 Permission is granted to copy, distribute and/or modify this document
16 under the terms of the GNU Free Documentation License, Version 1.2 or
17 any later version published by the Free Software Foundation; with no
18 Invariant Sections, with the Front-Cover texts being ``A GNU
19 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
20 license is included in the section entitled ``GNU Free Documentation
21 License'' in the Emacs manual.
23 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
24 this GNU Manual, like GNU software.  Copies published by the Free
25 Software Foundation raise funds for GNU development.''
27 This document is part of a collection distributed under the GNU Free
28 Documentation License.  If you want to distribute this document
29 separately from the collection, you can do so by adding a copy of the
30 license to the document, as described in section 6 of the license.
31 @end quotation
32 @end copying
34 @dircategory Emacs
35 @direntry
36 * Message: (message).   Mail and news composition mode that goes with Gnus.
37 @end direntry
38 @iftex
39 @finalout
40 @end iftex
41 @setchapternewpage odd
43 @titlepage
44 @title Message Manual
46 @author by Lars Magne Ingebrigtsen
47 @page
49 @vskip 0pt plus 1filll
50 @insertcopying
51 @end titlepage
52 @page
54 @node Top
55 @top Message
57 All message composition from Gnus (both mail and news) takes place in
58 Message mode buffers.
60 @menu
61 * Interface::         Setting up message buffers.
62 * Commands::          Commands you can execute in message mode buffers.
63 * Variables::         Customizing the message buffers.
64 * Compatibility::     Making Message backwards compatible.
65 * Appendices::        More technical things.
66 * Index::             Variable, function and concept index.
67 * Key Index::         List of Message mode keys.
68 @end menu
70 @c Adjust ../Makefile.in if you change the following lines:
71 Message is distributed with Gnus.  The Gnus distribution
73 corresponding to this manual is No Gnus v0.4.
76 @node Interface
77 @chapter Interface
79 When a program (or a person) wants to respond to a message---reply,
80 follow up, forward, cancel---the program (or person) should just put
81 point in the buffer where the message is and call the required command.
82 @code{Message} will then pop up a new @code{message} mode buffer with
83 appropriate headers filled out, and the user can edit the message before
84 sending it.
86 @menu
87 * New Mail Message::     Editing a brand new mail message.
88 * New News Message::     Editing a brand new news message.
89 * Reply::                Replying via mail.
90 * Wide Reply::           Responding to all people via mail.
91 * Followup::             Following up via news.
92 * Canceling News::       Canceling a news article.
93 * Superseding::          Superseding a message.
94 * Forwarding::           Forwarding a message via news or mail.
95 * Resending::            Resending a mail message.
96 * Bouncing::             Bouncing a mail message.
97 * Mailing Lists::        Send mail to mailing lists.
98 @end menu
101 @node New Mail Message
102 @section New Mail Message
104 @findex message-mail
105 The @code{message-mail} command pops up a new message buffer.
107 Two optional parameters are accepted: The first will be used as the
108 @code{To} header and the second as the @code{Subject} header.  If these
109 are @code{nil}, those two headers will be empty.
112 @node New News Message
113 @section New News Message
115 @findex message-news
116 The @code{message-news} command pops up a new message buffer.
118 This function accepts two optional parameters.  The first will be used
119 as the @code{Newsgroups} header and the second as the @code{Subject}
120 header.  If these are @code{nil}, those two headers will be empty.
123 @node Reply
124 @section Reply
126 @findex message-reply
127 The @code{message-reply} function pops up a message buffer that's a
128 reply to the message in the current buffer.
130 @vindex message-reply-to-function
131 Message uses the normal methods to determine where replies are to go
132 (@pxref{Responses}), but you can change the behavior to suit your needs
133 by fiddling with the @code{message-reply-to-function} variable.
135 If you want the replies to go to the @code{Sender} instead of the
136 @code{From}, you could do something like this:
138 @lisp
139 (setq message-reply-to-function
140       (lambda ()
141        (cond ((equal (mail-fetch-field "from") "somebody")
142                (list (cons 'To (mail-fetch-field "sender"))))
143              (t
144               nil))))
145 @end lisp
147 This function will be called narrowed to the head of the article that is
148 being replied to.
150 As you can see, this function should return a list.  In this case, it
151 returns @code{((To . "Whom"))} if it has an opinion as to what the To
152 header should be.  If it does not, it should just return @code{nil}, and
153 the normal methods for determining the To header will be used.
155 Each list element should be a cons, where the @sc{car} should be the
156 name of a header (e.g. @code{Cc}) and the @sc{cdr} should be the header
157 value (e.g. @samp{larsi@@ifi.uio.no}).  All these headers will be
158 inserted into the head of the outgoing mail.
161 @node Wide Reply
162 @section Wide Reply
164 @findex message-wide-reply
165 The @code{message-wide-reply} pops up a message buffer that's a wide
166 reply to the message in the current buffer.  A @dfn{wide reply} is a
167 reply that goes out to all people listed in the @code{To}, @code{From}
168 (or @code{Reply-to}) and @code{Cc} headers.
170 @vindex message-wide-reply-to-function
171 Message uses the normal methods to determine where wide replies are to go,
172 but you can change the behavior to suit your needs by fiddling with the
173 @code{message-wide-reply-to-function}.  It is used in the same way as
174 @code{message-reply-to-function} (@pxref{Reply}).
176 @vindex message-dont-reply-to-names
177 Addresses that match the @code{message-dont-reply-to-names} regular
178 expression will be removed from the @code{Cc} header.
180 @vindex message-wide-reply-confirm-recipients
181 If @code{message-wide-reply-confirm-recipients} is non-@code{nil} you
182 will be asked to confirm that you want to reply to multiple
183 recipients.  The default is @code{nil}.
185 @node Followup
186 @section Followup
188 @findex message-followup
189 The @code{message-followup} command pops up a message buffer that's a
190 followup to the message in the current buffer.
192 @vindex message-followup-to-function
193 Message uses the normal methods to determine where followups are to go,
194 but you can change the behavior to suit your needs by fiddling with the
195 @code{message-followup-to-function}.  It is used in the same way as
196 @code{message-reply-to-function} (@pxref{Reply}).
198 @vindex message-use-followup-to
199 The @code{message-use-followup-to} variable says what to do about
200 @code{Followup-To} headers.  If it is @code{use}, always use the value.
201 If it is @code{ask} (which is the default), ask whether to use the
202 value.  If it is @code{t}, use the value unless it is @samp{poster}.  If
203 it is @code{nil}, don't use the value.
206 @node Canceling News
207 @section Canceling News
209 @findex message-cancel-news
210 The @code{message-cancel-news} command cancels the article in the
211 current buffer.
213 @vindex message-cancel-message
214 The value of @code{message-cancel-message} is inserted in the body of
215 the cancel message.  The default is @samp{I am canceling my own
216 article.}.
218 @cindex Cancel Locks
219 @vindex message-insert-canlock
220 @cindex canlock
221 When Message posts news messages, it inserts @code{Cancel-Lock}
222 headers by default.  This is a cryptographic header that ensures that
223 only you can cancel your own messages, which is nice.  The downside
224 is that if you lose your @file{.emacs} file (which is where Gnus
225 stores the secret cancel lock password (which is generated
226 automatically the first time you use this feature)), you won't be
227 able to cancel your message.  If you want to manage a password yourself,
228 you can put something like the following in your @file{~/.gnus.el} file:
230 @lisp
231 (setq canlock-password "geheimnis"
232       canlock-password-for-verify canlock-password)
233 @end lisp
235 Whether to insert the header or not is controlled by the
236 @code{message-insert-canlock} variable.
238 Not many news servers respect the @code{Cancel-Lock} header yet, but
239 this is expected to change in the future.
242 @node Superseding
243 @section Superseding
245 @findex message-supersede
246 The @code{message-supersede} command pops up a message buffer that will
247 supersede the message in the current buffer.
249 @vindex message-ignored-supersedes-headers
250 Headers matching the @code{message-ignored-supersedes-headers} are
251 removed before popping up the new message buffer.  The default is@*
252 @samp{^Path:\\|^Date\\|^NNTP-Posting-Host:\\|^Xref:\\|^Lines:\\|@*
253 ^Received:\\|^X-From-Line:\\|^X-Trace:\\|^X-Complaints-To:\\|@*
254 Return-Path:\\|^Supersedes:\\|^NNTP-Posting-Date:\\|^X-Trace:\\|@*
255 ^X-Complaints-To:\\|^Cancel-Lock:\\|^Cancel-Key:\\|^X-Hashcash:\\|@*
256 ^X-Payment:\\|^Approved:}.
260 @node Forwarding
261 @section Forwarding
263 @findex message-forward
264 The @code{message-forward} command pops up a message buffer to forward
265 the message in the current buffer.  If given a prefix, forward using
266 news.
268 @table @code
269 @item message-forward-ignored-headers
270 @vindex message-forward-ignored-headers
271 All headers that match this regexp will be deleted when forwarding a message.
273 @item message-make-forward-subject-function
274 @vindex message-make-forward-subject-function
275 A list of functions that are called to generate a subject header for
276 forwarded messages.  The subject generated by the previous function is
277 passed into each successive function.
279 The provided functions are:
281 @table @code
282 @item message-forward-subject-author-subject
283 @findex message-forward-subject-author-subject
284 Source of article (author or newsgroup), in brackets followed by the
285 subject.
287 @item message-forward-subject-fwd
288 Subject of article with @samp{Fwd:} prepended to it.
289 @end table
291 @item message-wash-forwarded-subjects
292 @vindex message-wash-forwarded-subjects
293 If this variable is @code{t}, the subjects of forwarded messages have
294 the evidence of previous forwards (such as @samp{Fwd:}, @samp{Re:},
295 @samp{(fwd)}) removed before the new subject is
296 constructed.  The default value is @code{nil}.
298 @item message-forward-as-mime
299 @vindex message-forward-as-mime
300 If this variable is @code{t} (the default), forwarded messages are
301 included as inline @acronym{MIME} RFC822 parts.  If it's @code{nil}, forwarded
302 messages will just be copied inline to the new message, like previous,
303 non @acronym{MIME}-savvy versions of Gnus would do.
305 @item message-forward-before-signature
306 @vindex message-forward-before-signature
307 If non-@code{nil}, put forwarded message before signature, else after.
309 @end table
312 @node Resending
313 @section Resending
315 @findex message-resend
316 The @code{message-resend} command will prompt the user for an address
317 and resend the message in the current buffer to that address.
319 @vindex message-ignored-resent-headers
320 Headers that match the @code{message-ignored-resent-headers} regexp will
321 be removed before sending the message.
324 @node Bouncing
325 @section Bouncing
327 @findex message-bounce
328 The @code{message-bounce} command will, if the current buffer contains a
329 bounced mail message, pop up a message buffer stripped of the bounce
330 information.  A @dfn{bounced message} is typically a mail you've sent
331 out that has been returned by some @code{mailer-daemon} as
332 undeliverable.
334 @vindex message-ignored-bounced-headers
335 Headers that match the @code{message-ignored-bounced-headers} regexp
336 will be removed before popping up the buffer.  The default is
337 @samp{^\\(Received\\|Return-Path\\|Delivered-To\\):}.
340 @node Mailing Lists
341 @section Mailing Lists
343 @cindex Mail-Followup-To
344 Sometimes while posting to mailing lists, the poster needs to direct
345 followups to the post to specific places.  The Mail-Followup-To (MFT)
346 was created to enable just this.  Three example scenarios where this is
347 useful:
349 @itemize @bullet
350 @item
351 A mailing list poster can use MFT to express that responses should be
352 sent to just the list, and not the poster as well.  This will happen
353 if the poster is already subscribed to the list.
355 @item
356 A mailing list poster can use MFT to express that responses should be
357 sent to the list and the poster as well.  This will happen if the poster
358 is not subscribed to the list.
360 @item
361 If a message is posted to several mailing lists, MFT may also be used
362 to direct the following discussion to one list only, because
363 discussions that are spread over several lists tend to be fragmented
364 and very difficult to follow.
366 @end itemize
368 Gnus honors the MFT header in other's messages (i.e. while following
369 up to someone else's post) and also provides support for generating
370 sensible MFT headers for outgoing messages as well.
372 @c @menu
373 @c * Honoring an MFT post::        What to do when one already exists
374 @c * Composing with a MFT header:: Creating one from scratch.
375 @c @end menu
377 @c @node Composing with a MFT header
378 @subsection  Composing a correct MFT header automagically
380 The first step in getting Gnus to automagically generate a MFT header
381 in posts you make is to give Gnus a list of the mailing lists
382 addresses you are subscribed to.  You can do this in more than one
383 way.  The following variables would come in handy.
385 @table @code
387 @vindex message-subscribed-addresses
388 @item message-subscribed-addresses
389 This should be a list of addresses the user is subscribed to.  Its
390 default value is @code{nil}.  Example:
391 @lisp
392 (setq message-subscribed-addresses
393       '("ding@@gnus.org" "bing@@noose.org"))
394 @end lisp
396 @vindex message-subscribed-regexps
397 @item message-subscribed-regexps
398 This should be a list of regexps denoting the addresses of mailing
399 lists subscribed to.  Default value is @code{nil}.  Example: If you
400 want to achieve the same result as above:
401 @lisp
402 (setq message-subscribed-regexps
403       '("\\(ding@@gnus\\)\\|\\(bing@@noose\\)\\.org")
404 @end lisp
406 @vindex message-subscribed-address-functions
407 @item message-subscribed-address-functions
408 This can be a list of functions to be called (one at a time!!) to
409 determine the value of MFT headers.  It is advisable that these
410 functions not take any arguments.  Default value is @code{nil}.
412 There is a pre-defined function in Gnus that is a good candidate for
413 this variable.  @code{gnus-find-subscribed-addresses} is a function
414 that returns a list of addresses corresponding to the groups that have
415 the @code{subscribed} (@pxref{Group Parameters, ,Group Parameters,
416 gnus, The Gnus Manual}) group parameter set to a non-@code{nil} value.
417 This is how you would do it.
419 @lisp
420 (setq message-subscribed-address-functions
421       '(gnus-find-subscribed-addresses))
422 @end lisp
424 @vindex message-subscribed-address-file
425 @item message-subscribed-address-file
426 You might be one organized human freak and have a list of addresses of
427 all subscribed mailing lists in a separate file!  Then you can just
428 set this variable to the name of the file and life would be good.
430 @end table
432 You can use one or more of the above variables.  All their values are
433 ``added'' in some way that works :-)
435 Now you are all set.  Just start composing a message as you normally do.
436 And just send it; as always.  Just before the message is sent out, Gnus'
437 MFT generation thingy kicks in and checks if the message already has a
438 MFT field.  If there is one, it is left alone.  (Except if it's empty -
439 in that case, the field is removed and is not replaced with an
440 automatically generated one.  This lets you disable MFT generation on a
441 per-message basis.)  If there is none, then the list of recipient
442 addresses (in the To: and Cc: headers) is checked to see if one of them
443 is a list address you are subscribed to.  If none of them is a list
444 address, then no MFT is generated; otherwise, a MFT is added to the
445 other headers and set to the value of all addresses in To: and Cc:
447 @kindex C-c C-f C-a
448 @findex message-generate-unsubscribed-mail-followup-to
449 @kindex C-c C-f C-m
450 @findex message-goto-mail-followup-to
451 Hm.  ``So'', you ask, ``what if I send an email to a list I am not
452 subscribed to?  I want my MFT to say that I want an extra copy.''  (This
453 is supposed to be interpreted by others the same way as if there were no
454 MFT, but you can use an explicit MFT to override someone else's
455 to-address group parameter.)  The function
456 @code{message-generate-unsubscribed-mail-followup-to} might come in
457 handy.  It is bound to @kbd{C-c C-f C-a} by default.  In any case, you
458 can insert a MFT of your own choice; @kbd{C-c C-f C-m}
459 (@code{message-goto-mail-followup-to}) will help you get started.
461 @c @node Honoring an MFT post
462 @subsection Honoring an MFT post
464 @vindex message-use-mail-followup-to
465 When you followup to a post on a mailing list, and the post has a MFT
466 header, Gnus' action will depend on the value of the variable
467 @code{message-use-mail-followup-to}.  This variable can be one of:
469 @table @code
470 @item use
471  Always honor MFTs.  The To: and Cc: headers in your followup will be
472  derived from the MFT header of the original post.  This is the default.
474 @item nil
475  Always dishonor MFTs (just ignore the darned thing)
477 @item ask
478 Gnus will prompt you for an action.
480 @end table
482 It is considered good netiquette to honor MFT, as it is assumed the
483 fellow who posted a message knows where the followups need to go
484 better than you do.
486 @node Commands
487 @chapter Commands
489 @menu
490 * Buffer Entry::        Commands after entering a Message buffer.
491 * Header Commands::     Commands for moving headers or changing headers.
492 * Movement::            Moving around in message buffers.
493 * Insertion::           Inserting things into message buffers.
494 * MIME::                @acronym{MIME} considerations.
495 * IDNA::                Non-@acronym{ASCII} domain name considerations.
496 * Security::            Signing and encrypting messages.
497 * Various Commands::    Various things.
498 * Sending::             Actually sending the message.
499 * Mail Aliases::        How to use mail aliases.
500 * Spelling::            Having Emacs check your spelling.
501 @end menu
504 @node Buffer Entry
505 @section Buffer Entry
506 @cindex undo
507 @kindex C-_
509 You most often end up in a Message buffer when responding to some other
510 message of some sort.  Message does lots of handling of quoted text, and
511 may remove signatures, reformat the text, or the like---depending on
512 which used settings you're using.  Message usually gets things right,
513 but sometimes it stumbles.  To help the user unwind these stumblings,
514 Message sets the undo boundary before each major automatic action it
515 takes.  If you press the undo key (usually located at @kbd{C-_}) a few
516 times, you will get back the un-edited message you're responding to.
519 @node Header Commands
520 @section Header Commands
522 @subsection Commands for moving to headers
524 These following commands move to the header in question.  If it doesn't
525 exist, it will be inserted.
527 @table @kbd
529 @item C-c ?
530 @kindex C-c ?
531 @findex describe-mode
532 Describe the message mode.
534 @item C-c C-f C-t
535 @kindex C-c C-f C-t
536 @findex message-goto-to
537 Go to the @code{To} header (@code{message-goto-to}).
539 @item C-c C-f C-o
540 @kindex C-c C-f C-o
541 @findex message-goto-from
542 Go to the @code{From} header (@code{message-goto-from}).  (The ``o''
543 in the key binding is for Originator.)
545 @item C-c C-f C-b
546 @kindex C-c C-f C-b
547 @findex message-goto-bcc
548 Go to the @code{Bcc} header (@code{message-goto-bcc}).
550 @item C-c C-f C-f
551 @kindex C-c C-f C-f
552 @findex message-goto-fcc
553 Go to the @code{Fcc} header (@code{message-goto-fcc}).
555 @item C-c C-f C-c
556 @kindex C-c C-f C-c
557 @findex message-goto-cc
558 Go to the @code{Cc} header (@code{message-goto-cc}).
560 @item C-c C-f C-s
561 @kindex C-c C-f C-s
562 @findex message-goto-subject
563 Go to the @code{Subject} header (@code{message-goto-subject}).
565 @item C-c C-f C-r
566 @kindex C-c C-f C-r
567 @findex message-goto-reply-to
568 Go to the @code{Reply-To} header (@code{message-goto-reply-to}).
570 @item C-c C-f C-n
571 @kindex C-c C-f C-n
572 @findex message-goto-newsgroups
573 Go to the @code{Newsgroups} header (@code{message-goto-newsgroups}).
575 @item C-c C-f C-d
576 @kindex C-c C-f C-d
577 @findex message-goto-distribution
578 Go to the @code{Distribution} header (@code{message-goto-distribution}).
580 @item C-c C-f C-o
581 @kindex C-c C-f C-o
582 @findex message-goto-followup-to
583 Go to the @code{Followup-To} header (@code{message-goto-followup-to}).
585 @item C-c C-f C-k
586 @kindex C-c C-f C-k
587 @findex message-goto-keywords
588 Go to the @code{Keywords} header (@code{message-goto-keywords}).
590 @item C-c C-f C-u
591 @kindex C-c C-f C-u
592 @findex message-goto-summary
593 Go to the @code{Summary} header (@code{message-goto-summary}).
595 @item C-c C-f C-i
596 @kindex C-c C-f C-i
597 @findex message-insert-or-toggle-importance
598 This inserts the @samp{Importance:} header with a value of
599 @samp{high}.  This header is used to signal the importance of the
600 message to the receiver.  If the header is already present in the
601 buffer, it cycles between the three valid values according to RFC
602 1376: @samp{low}, @samp{normal} and @samp{high}.
604 @item C-c C-f C-a
605 @kindex C-c C-f C-a
606 @findex message-generate-unsubscribed-mail-followup-to
607 Insert a reasonable @samp{Mail-Followup-To:} header
608 (@pxref{Mailing Lists}) in a post to an
609 unsubscribed list.  When making original posts to a mailing list you are
610 not subscribed to, you have to type in a @samp{Mail-Followup-To:} header
611 by hand.  The contents, usually, are the addresses of the list and your
612 own address.  This function inserts such a header automatically.  It
613 fetches the contents of the @samp{To:} header in the current mail
614 buffer, and appends the current @code{user-mail-address}.
616 If the optional argument @code{include-cc} is non-@code{nil}, the
617 addresses in the @samp{Cc:} header are also put into the
618 @samp{Mail-Followup-To:} header.
620 @end table
622 @subsection  Commands to change headers
624 @table @kbd
626 @item C-c C-o
627 @kindex C-c C-o
628 @findex message-sort-headers
629 @vindex message-header-format-alist
630 Sort headers according to @code{message-header-format-alist}
631 (@code{message-sort-headers}).
633 @item C-c C-t
634 @kindex C-c C-t
635 @findex message-insert-to
636 Insert a @code{To} header that contains the @code{Reply-To} or
637 @code{From} header of the message you're following up
638 (@code{message-insert-to}).
640 @item C-c C-n
641 @kindex C-c C-n
642 @findex message-insert-newsgroups
643 Insert a @code{Newsgroups} header that reflects the @code{Followup-To}
644 or @code{Newsgroups} header of the article you're replying to
645 (@code{message-insert-newsgroups}).
647 @item C-c C-l
648 @kindex C-c C-l
649 @findex message-to-list-only
650 Send a message to the list only.  Remove all addresses but the list
651 address from @code{To:} and @code{Cc:} headers.
653 @item C-c M-n
654 @kindex C-c M-n
655 @findex message-insert-disposition-notification-to
656 Insert a request for a disposition
657 notification.  (@code{message-insert-disposition-notification-to}).
658 This means that if the recipient support RFC 2298 she might send you a
659 notification that she received the message.
661 @item M-x message-insert-importance-high
662 @kindex M-x message-insert-importance-high
663 @findex message-insert-importance-high
664 @cindex Importance
665 Insert an @samp{Importance} header with a value of @samp{high},
666 deleting headers if necessary.
668 @item M-x message-insert-importance-low
669 @kindex M-x message-insert-importance-low
670 @findex message-insert-importance-low
671 @cindex Importance
672 Insert an @samp{Importance} header with a value of @samp{low}, deleting
673 headers if necessary.
675 @item C-c C-f s
676 @kindex C-c C-f s
677 @findex message-change-subject
678 @cindex Subject
679 Change the current @samp{Subject} header.  Ask for new @samp{Subject}
680 header and append @samp{(was: <Old Subject>)}.  The old subject can be
681 stripped on replying, see @code{message-subject-trailing-was-query}
682 (@pxref{Message Headers}).
684 @item C-c C-f x
685 @kindex C-c C-f x
686 @findex message-cross-post-followup-to
687 @vindex message-cross-post-default
688 @vindex message-cross-post-note-function
689 @cindex X-Post
690 @cindex cross-post
691 Set up the @samp{FollowUp-To} header with a target newsgroup for a
692 cross-post, add that target newsgroup to the @samp{Newsgroups} header if
693 it is not a member of @samp{Newsgroups}, and insert a note in the body.
694 If @code{message-cross-post-default} is @code{nil} or if this command is
695 called with a prefix-argument, only the @samp{FollowUp-To} header will
696 be set but the the target newsgroup will not be added to the
697 @samp{Newsgroups} header.  The function to insert a note is controlled
698 by the @code{message-cross-post-note-function} variable.
700 @item C-c C-f t
701 @kindex C-c C-f t
702 @findex message-reduce-to-to-cc
703 Replace contents of @samp{To} header with contents of @samp{Cc} or
704 @samp{Bcc} header.  (Iff @samp{Cc} header is not present, @samp{Bcc}
705 header will be used instead.)
707 @item C-c C-f w
708 @kindex C-c C-f w
709 @findex message-insert-wide-reply
710 Insert @samp{To} and @samp{Cc} headers as if you were doing a wide
711 reply even if the message was not made for a wide reply first.
713 @item C-c C-f a
714 @kindex C-c C-f a
715 @findex message-add-archive-header
716 @vindex message-archive-header
717 @vindex message-archive-note
718 @cindex X-No-Archive
719 Insert @samp{X-No-Archive: Yes} in the header and a note in the body.
720 The header and the note can be customized using
721 @code{message-archive-header} and @code{message-archive-note}.  When
722 called with a prefix argument, ask for a text to insert.  If you don't
723 want the note in the body, set @code{message-archive-note} to
724 @code{nil}.
726 @end table
729 @node Movement
730 @section Movement
732 @table @kbd
733 @item C-c C-b
734 @kindex C-c C-b
735 @findex message-goto-body
736 Move to the beginning of the body of the message
737 (@code{message-goto-body}).
739 @item C-c C-i
740 @kindex C-c C-i
741 @findex message-goto-signature
742 Move to the signature of the message (@code{message-goto-signature}).
744 @item C-a
745 @kindex C-a
746 @findex message-beginning-of-line
747 @vindex message-beginning-of-line
748 If at beginning of header value, go to beginning of line, else go to
749 beginning of header value.  (The header value comes after the header
750 name and the colon.)  This behavior can be disabled by toggling
751 the variable @code{message-beginning-of-line}.
753 @end table
756 @node Insertion
757 @section Insertion
759 @table @kbd
761 @item C-c C-y
762 @kindex C-c C-y
763 @findex message-yank-original
764 Yank the message that's being replied to into the message buffer
765 (@code{message-yank-original}).
767 @item C-c C-M-y
768 @kindex C-c C-M-y
769 @findex message-yank-buffer
770 Prompt for a buffer name and yank the contents of that buffer into the
771 message buffer (@code{message-yank-buffer}).
773 @item C-c C-q
774 @kindex C-c C-q
775 @findex message-fill-yanked-message
776 Fill the yanked message (@code{message-fill-yanked-message}).  Warning:
777 Can severely mess up the yanked text if its quoting conventions are
778 strange.  You'll quickly get a feel for when it's safe, though.  Anyway,
779 just remember that @kbd{C-x u} (@code{undo}) is available and you'll be
780 all right.
782 @item C-c C-w
783 @kindex C-c C-w
784 @findex message-insert-signature
785 Insert a signature at the end of the buffer
786 (@code{message-insert-signature}).
788 @item C-c M-h
789 @kindex C-c M-h
790 @findex message-insert-headers
791 Insert the message headers (@code{message-insert-headers}).
793 @item C-c M-m
794 @kindex C-c M-m
795 @findex message-mark-inserted-region
796 Mark some region in the current article with enclosing tags.  See
797 @code{message-mark-insert-begin} and @code{message-mark-insert-end}.
798 When called with a prefix argument, use slrn style verbatim marks
799 (@samp{#v+} and @samp{#v-}).
801 @item C-c M-f
802 @kindex C-c M-f
803 @findex message-mark-insert-file
804 Insert a file in the current article with enclosing tags.
805 See @code{message-mark-insert-begin} and @code{message-mark-insert-end}.
806 When called with a prefix argument, use slrn style verbatim marks
807 (@samp{#v+} and @samp{#v-}).
809 @end table
812 @node MIME
813 @section MIME
814 @cindex MML
815 @cindex MIME
816 @cindex multipart
817 @cindex attachment
819 Message is a @acronym{MIME}-compliant posting agent.  The user generally
820 doesn't have to do anything to make the @acronym{MIME} happen---Message will
821 automatically add the @code{Content-Type} and
822 @code{Content-Transfer-Encoding} headers.
824 The most typical thing users want to use the multipart things in
825 @acronym{MIME} for is to add ``attachments'' to mail they send out.
826 This can be done with the @kbd{C-c C-a} command, which will prompt for
827 a file name and a @acronym{MIME} type.
829 @vindex mml-dnd-protocol-alist
830 @vindex mml-dnd-attach-options
831 If your Emacs supports drag and drop, you can also drop the file in the
832 Message buffer.  The variable @code{mml-dnd-protocol-alist} specifies
833 what kind of action is done when you drop a file into the Message
834 buffer.  The variable @code{mml-dnd-attach-options} controls which
835 @acronym{MIME} options you want to specify when dropping a file.  If it
836 is a list, valid members are @code{type}, @code{description} and
837 @code{disposition}.  @code{disposition} implies @code{type}.  If it is
838 @code{nil}, don't ask for options.  If it is @code{t}, ask the user
839 whether or not to specify options.
841 You can also create arbitrarily complex multiparts using the @acronym{MML}
842 language (@pxref{Composing, , Composing, emacs-mime, The Emacs MIME
843 Manual}).
845 @node IDNA
846 @section IDNA
847 @cindex IDNA
848 @cindex internationalized domain names
849 @cindex non-ascii domain names
851 Message is a @acronym{IDNA}-compliant posting agent.  The user
852 generally doesn't have to do anything to make the @acronym{IDNA}
853 happen---Message will encode non-@acronym{ASCII} domain names in @code{From},
854 @code{To}, and @code{Cc} headers automatically.
856 Until @acronym{IDNA} becomes more well known, Message queries you
857 whether @acronym{IDNA} encoding of the domain name really should
858 occur.  Some users might not be aware that domain names can contain
859 non-@acronym{ASCII} now, so this gives them a safety net if they accidently
860 typed a non-@acronym{ASCII} domain name.
862 @vindex message-use-idna
863 The @code{message-use-idna} variable control whether @acronym{IDNA} is
864 used.  If the variable is @code{nil} no @acronym{IDNA} encoding will
865 ever happen, if it is set to the symbol @code{ask} the user will be
866 queried, and if set to @code{t} (which is the default if @acronym{IDNA}
867 is fully available) @acronym{IDNA} encoding happens automatically.
869 @findex message-idna-to-ascii-rhs
870 If you want to experiment with the @acronym{IDNA} encoding, you can
871 invoke @kbd{M-x message-idna-to-ascii-rhs RET} in the message buffer
872 to have the non-@acronym{ASCII} domain names encoded while you edit
873 the message.
875 Note that you must have @uref{http://www.gnu.org/software/libidn/, GNU
876 Libidn} installed in order to use this functionality.
878 @node Security
879 @section Security
880 @cindex Security
881 @cindex S/MIME
882 @cindex PGP
883 @cindex PGP/MIME
884 @cindex sign
885 @cindex encrypt
886 @cindex secure
888 Using the @acronym{MML} language, Message is able to create digitally
889 signed and digitally encrypted messages.  Message (or rather
890 @acronym{MML}) currently support @acronym{PGP} (RFC 1991),
891 @acronym{PGP/MIME} (RFC 2015/3156) and @acronym{S/MIME}.  Instructing
892 @acronym{MML} to perform security operations on a @acronym{MIME} part is
893 done using the @kbd{C-c C-m s} key map for signing and the @kbd{C-c C-m
894 c} key map for encryption, as follows.
896 @table @kbd
898 @item C-c C-m s s
899 @kindex C-c C-m s s
900 @findex mml-secure-message-sign-smime
902 Digitally sign current message using @acronym{S/MIME}.
904 @item C-c C-m s o
905 @kindex C-c C-m s o
906 @findex mml-secure-message-sign-pgp
908 Digitally sign current message using @acronym{PGP}.
910 @item C-c C-m s p
911 @kindex C-c C-m s p
912 @findex mml-secure-message-sign-pgpmime
914 Digitally sign current message using @acronym{PGP/MIME}.
916 @item C-c C-m c s
917 @kindex C-c C-m c s
918 @findex mml-secure-message-encrypt-smime
920 Digitally encrypt current message using @acronym{S/MIME}.
922 @item C-c C-m c o
923 @kindex C-c C-m c o
924 @findex mml-secure-message-encrypt-pgp
926 Digitally encrypt current message using @acronym{PGP}.
928 @item C-c C-m c p
929 @kindex C-c C-m c p
930 @findex mml-secure-message-encrypt-pgpmime
932 Digitally encrypt current message using @acronym{PGP/MIME}.
934 @item C-c C-m C-n
935 @kindex C-c C-m C-n
936 @findex mml-unsecure-message
937 Remove security related @acronym{MML} tags from message.
939 @end table
941 These commands do not immediately sign or encrypt the message, they
942 merely insert the proper @acronym{MML} secure tag to instruct the
943 @acronym{MML} engine to perform that operation when the message is
944 actually sent.  They may perform other operations too, such as locating
945 and retrieving a @acronym{S/MIME} certificate of the person you wish to
946 send encrypted mail to.  When the mml parsing engine converts your
947 @acronym{MML} into a properly encoded @acronym{MIME} message, the secure
948 tag will be replaced with either a part or a multipart tag.  If your
949 message contains other mml parts, a multipart tag will be used; if no
950 other parts are present in your message a single part tag will be used.
951 This way, message mode will do the Right Thing (TM) with
952 signed/encrypted multipart messages.
954 Since signing and especially encryption often is used when sensitive
955 information is sent, you may want to have some way to ensure that your
956 mail is actually signed or encrypted.  After invoking the above
957 sign/encrypt commands, it is possible to preview the raw article by
958 using @kbd{C-u C-c RET P} (@code{mml-preview}).  Then you can
959 verify that your long rant about what your ex-significant other or
960 whomever actually did with that funny looking person at that strange
961 party the other night, actually will be sent encrypted.
963 @emph{Note!}  Neither @acronym{PGP/MIME} nor @acronym{S/MIME} encrypt/signs
964 RFC822 headers.  They only operate on the @acronym{MIME} object.  Keep this
965 in mind before sending mail with a sensitive Subject line.
967 By default, when encrypting a message, Gnus will use the
968 ``signencrypt'' mode, which means the message is both signed and
969 encrypted.  If you would like to disable this for a particular
970 message, give the @code{mml-secure-message-encrypt-*} command a prefix
971 argument, e.g., @kbd{C-u C-c C-m c p}.
973 Actually using the security commands above is not very difficult.  At
974 least not compared with making sure all involved programs talk with each
975 other properly.  Thus, we now describe what external libraries or
976 programs are required to make things work, and some small general hints.
978 @subsection Using S/MIME
980 @emph{Note!}  This section assume you have a basic familiarity with
981 modern cryptography, @acronym{S/MIME}, various PKCS standards, OpenSSL and
982 so on.
984 The @acronym{S/MIME} support in Message (and @acronym{MML}) require
985 OpenSSL.  OpenSSL performs the actual @acronym{S/MIME} sign/encrypt
986 operations.  OpenSSL can be found at @uref{http://www.openssl.org/}.
987 OpenSSL 0.9.6 and later should work.  Version 0.9.5a cannot extract mail
988 addresses from certificates, and it insert a spurious CR character into
989 @acronym{MIME} separators so you may wish to avoid it if you would like
990 to avoid being regarded as someone who send strange mail.  (Although by
991 sending @acronym{S/MIME} messages you've probably already lost that
992 contest.)
994 To be able to send encrypted mail, a personal certificate is not
995 required.  Message (@acronym{MML}) need a certificate for the person to whom you
996 wish to communicate with though.  You're asked for this when you type
997 @kbd{C-c C-m c s}.  Currently there are two ways to retrieve this
998 certificate, from a local file or from DNS.  If you chose a local
999 file, it need to contain a X.509 certificate in @acronym{PEM} format.
1000 If you chose DNS, you're asked for the domain name where the
1001 certificate is stored, the default is a good guess.  To my belief,
1002 Message (@acronym{MML}) is the first mail agent in the world to support
1003 retrieving @acronym{S/MIME} certificates from DNS, so you're not
1004 likely to find very many certificates out there.  At least there
1005 should be one, stored at the domain @code{simon.josefsson.org}.  LDAP
1006 is a more popular method of distributing certificates, support for it
1007 is planned.  (Meanwhile, you can use @code{ldapsearch} from the
1008 command line to retrieve a certificate into a file and use it.)
1010 As for signing messages, OpenSSL can't perform signing operations
1011 without some kind of configuration.  Especially, you need to tell it
1012 where your private key and your certificate is stored.  @acronym{MML}
1013 uses an Emacs interface to OpenSSL, aptly named @code{smime.el}, and it
1014 contain a @code{custom} group used for this configuration.  So, try
1015 @kbd{M-x customize-group RET smime RET} and look around.
1017 Currently there is no support for talking to a CA (or RA) to create
1018 your own certificate.  None is planned either.  You need to do this
1019 manually with OpenSSL or using some other program.  I used Netscape
1020 and got a free @acronym{S/MIME} certificate from one of the big CA's on the
1021 net.  Netscape is able to export your private key and certificate in
1022 PKCS #12 format.  Use OpenSSL to convert this into a plain X.509
1023 certificate in PEM format as follows.
1025 @example
1026 $ openssl pkcs12 -in ns.p12 -clcerts -nodes > key+cert.pem
1027 @end example
1029 The @file{key+cert.pem} file should be pointed to from the
1030 @code{smime-keys} variable.  You should now be able to send signed mail.
1032 @emph{Note!}  Your private key is now stored unencrypted in the file,
1033 so take care in handling it.  Storing encrypted keys on the disk are
1034 supported, and Gnus will ask you for a passphrase before invoking
1035 OpenSSL.  Read the OpenSSL documentation for how to achieve this.  If
1036 you use unencrypted keys (e.g., if they are on a secure storage, or if
1037 you are on a secure single user machine) simply press @code{RET} at
1038 the passphrase prompt.
1040 @subsection Using PGP/MIME
1042 @acronym{PGP/MIME} requires an external OpenPGP implementation, such
1043 as @uref{http://www.gnupg.org/, GNU Privacy Guard}.  Pre-OpenPGP
1044 implementations such as PGP 2.x and PGP 5.x are also supported.  One
1045 Emacs interface to the PGP implementations, PGG (@pxref{Top, ,PGG,
1046 pgg, PGG Manual}), is included, but Mailcrypt and Florian Weimer's
1047 @code{gpg.el} are also supported.
1049 @vindex gpg-temp-directory
1050 Note, if you are using the @code{gpg.el} you must make sure that the
1051 directory specified by @code{gpg-temp-directory} have permissions
1052 0700.
1054 Creating your own key is described in detail in the documentation of
1055 your PGP implementation, so we refer to it.
1057 If you have imported your old PGP 2.x key into GnuPG, and want to send
1058 signed and encrypted messages to your fellow PGP 2.x users, you'll
1059 discover that the receiver cannot understand what you send. One
1060 solution is to use PGP 2.x instead (i.e., if you use @code{pgg}, set
1061 @code{pgg-default-scheme} to @code{pgp}).  If you do want to use
1062 GnuPG, you can use a compatibility script called @code{gpg-2comp}
1063 available from
1064 @uref{http://muppet.faveve.uni-stuttgart.de/~gero/gpg-2comp/}.  You
1065 could also convince your fellow PGP 2.x users to convert to GnuPG.
1066 @vindex mml-signencrypt-style-alist
1067 As a final workaround, you can make the sign and encryption work in
1068 two steps; separately sign, then encrypt a message.  If you would like
1069 to change this behavior you can customize the
1070 @code{mml-signencrypt-style-alist} variable.  For example:
1072 @lisp
1073 (setq mml-signencrypt-style-alist '(("smime" separate)
1074                                     ("pgp" separate)
1075                                     ("pgpauto" separate)
1076                                     ("pgpmime" separate)))
1077 @end lisp
1079 This causes to sign and encrypt in two passes, thus generating a
1080 message that can be understood by PGP version 2.
1082 (Refer to @uref{http://www.gnupg.org/gph/en/pgp2x.html} for more
1083 information about the problem.)
1085 @node Various Commands
1086 @section Various Commands
1088 @table @kbd
1090 @item C-c C-r
1091 @kindex C-c C-r
1092 @findex message-caesar-buffer-body
1093 Caesar rotate (aka. rot13) the current message
1094 (@code{message-caesar-buffer-body}).  If narrowing is in effect, just
1095 rotate the visible portion of the buffer.  A numerical prefix says how
1096 many places to rotate the text.  The default is 13.
1098 @item C-c C-e
1099 @kindex C-c C-e
1100 @findex message-elide-region
1101 @vindex message-elide-ellipsis
1102 Elide the text between point and mark (@code{message-elide-region}).
1103 The text is killed and replaced with the contents of the variable
1104 @code{message-elide-ellipsis}.  The default value is to use an ellipsis
1105 (@samp{[...]}).
1107 @item C-c M-k
1108 @kindex C-c M-k
1109 @findex message-kill-address
1110 Kill the address under point.
1112 @item C-c C-z
1113 @kindex C-c C-z
1114 @findex message-kill-to-signature
1115 Kill all the text up to the signature, or if that's missing, up to the
1116 end of the message (@code{message-kill-to-signature}).
1118 @item C-c C-v
1119 @kindex C-c C-v
1120 @findex message-delete-not-region
1121 Delete all text in the body of the message that is outside the region
1122 (@code{message-delete-not-region}).
1124 @item M-RET
1125 @kindex M-RET
1126 @findex message-newline-and-reformat
1127 Insert four newlines, and then reformat if inside quoted text.
1129 Here's an example:
1131 @example
1132 > This is some quoted text.  And here's more quoted text.
1133 @end example
1135 If point is before @samp{And} and you press @kbd{M-RET}, you'll get:
1137 @example
1138 > This is some quoted text.
1142 > And here's more quoted text.
1143 @end example
1145 @samp{*} says where point will be placed.
1147 @item C-c M-r
1148 @kindex C-c M-r
1149 @findex message-rename-buffer
1150 Rename the buffer (@code{message-rename-buffer}).  If given a prefix,
1151 prompt for a new buffer name.
1153 @item TAB
1154 @kindex TAB
1155 @findex message-tab
1156 @vindex message-tab-body-function
1157 If @code{message-tab-body-function} is non-@code{nil}, execute the
1158 function it specifies.  Otherwise use the function bound to @kbd{TAB} in
1159 @code{text-mode-map} or @code{global-map}.
1161 @end table
1164 @node Sending
1165 @section Sending
1167 @table @kbd
1168 @item C-c C-c
1169 @kindex C-c C-c
1170 @findex message-send-and-exit
1171 Send the message and bury the current buffer
1172 (@code{message-send-and-exit}).
1174 @item C-c C-s
1175 @kindex C-c C-s
1176 @findex message-send
1177 Send the message (@code{message-send}).
1179 @item C-c C-d
1180 @kindex C-c C-d
1181 @findex message-dont-send
1182 Bury the message buffer and exit (@code{message-dont-send}).
1184 @item C-c C-k
1185 @kindex C-c C-k
1186 @findex message-kill-buffer
1187 Kill the message buffer and exit (@code{message-kill-buffer}).
1189 @end table
1193 @node Mail Aliases
1194 @section Mail Aliases
1195 @cindex mail aliases
1196 @cindex aliases
1197 @cindex completion
1198 @cindex ecomplete
1200 @vindex message-mail-alias-type
1201 The @code{message-mail-alias-type} variable controls what type of mail
1202 alias expansion to use.  Currently two forms are supported:
1203 @code{mailabbrev} and @code{ecomplete}.  If this variable is
1204 @code{nil}, no mail alias expansion will be performed.
1206 @code{mailabbrev} works by parsing the @file{/etc/mailrc} and
1207 @file{~/.mailrc} files.  These files look like:
1209 @example
1210 alias lmi "Lars Magne Ingebrigtsen <larsi@@ifi.uio.no>"
1211 alias ding "ding@@ifi.uio.no (ding mailing list)"
1212 @end example
1214 After adding lines like this to your @file{~/.mailrc} file, you should
1215 be able to just write @samp{lmi} in the @code{To} or @code{Cc} (and so
1216 on) headers and press @kbd{SPC} to expand the alias.
1218 No expansion will be performed upon sending of the message---all
1219 expansions have to be done explicitly.
1221 If you're using @code{ecomplete}, all addresses from @code{To} and
1222 @code{Cc} headers will automatically be put into the
1223 @file{~/.ecompleterc} file.  When you enter text in the @code{To} and
1224 @code{Cc} headers, @code{ecomplete} will check out the values stored
1225 there and ``electrically'' say what completions are possible.  To
1226 choose one of these completions, use the @kbd{M-n} command to move
1227 down to the list.  Use @kbd{M-n} and @kbd{M-p} to move down and up the
1228 list, and @kbd{RET} to choose a completion.
1230 @node Spelling
1231 @section Spelling
1232 @cindex spelling
1233 @findex ispell-message
1235 There are two popular ways to have Emacs spell-check your messages:
1236 @code{ispell} and @code{flyspell}.  @code{ispell} is the older and
1237 probably more popular package.  You typically first write the message,
1238 and then run the entire thing through @code{ispell} and fix all the
1239 typos.  To have this happen automatically when you send a message, put
1240 something like the following in your @file{.emacs} file:
1242 @lisp
1243 (add-hook 'message-send-hook 'ispell-message)
1244 @end lisp
1246 @vindex ispell-message-dictionary-alist
1247 If you're in the habit of writing in different languages, this can be
1248 controlled by the @code{ispell-message-dictionary-alist} variable:
1250 @lisp
1251 (setq ispell-message-dictionary-alist
1252       '(("^Newsgroups:.*\\bde\\." . "deutsch8")
1253         (".*" . "default")))
1254 @end lisp
1256 @code{ispell} depends on having the external @samp{ispell} command
1257 installed.
1259 The other popular method is using @code{flyspell}.  This package checks
1260 your spelling while you're writing, and marks any mis-spelled words in
1261 various ways.
1263 To use @code{flyspell}, put something like the following in your
1264 @file{.emacs} file:
1266 @lisp
1267 (defun my-message-setup-routine ()
1268   (flyspell-mode 1))
1269 (add-hook 'message-setup-hook 'my-message-setup-routine)
1270 @end lisp
1272 @code{flyspell} depends on having the external @samp{ispell} command
1273 installed.
1276 @node Variables
1277 @chapter Variables
1279 @menu
1280 * Message Headers::             General message header stuff.
1281 * Mail Headers::                Customizing mail headers.
1282 * Mail Variables::              Other mail variables.
1283 * News Headers::                Customizing news headers.
1284 * News Variables::              Other news variables.
1285 * Insertion Variables::         Customizing how things are inserted.
1286 * Various Message Variables::   Other message variables.
1287 * Sending Variables::           Variables for sending.
1288 * Message Buffers::             How Message names its buffers.
1289 * Message Actions::             Actions to be performed when exiting.
1290 @end menu
1293 @node Message Headers
1294 @section Message Headers
1296 Message is quite aggressive on the message generation front.  It has to
1297 be---it's a combined news and mail agent.  To be able to send combined
1298 messages, it has to generate all headers itself (instead of letting the
1299 mail/news system do it) to ensure that mail and news copies of messages
1300 look sufficiently similar.
1302 @table @code
1304 @item message-generate-headers-first
1305 @vindex message-generate-headers-first
1306 If @code{t}, generate all required headers before starting to
1307 compose the message.  This can also be a list of headers to generate:
1309 @lisp
1310 (setq message-generate-headers-first
1311       '(References))
1312 @end lisp
1314 @vindex message-required-headers
1315 The variables @code{message-required-headers},
1316 @code{message-required-mail-headers} and
1317 @code{message-required-news-headers} specify which headers are
1318 required.
1320 Note that some headers will be removed and re-generated before posting,
1321 because of the variable @code{message-deletable-headers} (see below).
1323 @item message-draft-headers
1324 @vindex message-draft-headers
1325 When running Message from Gnus, the message buffers are associated
1326 with a draft group.  @code{message-draft-headers} says which headers
1327 should be generated when a draft is written to the draft group.
1329 @item message-from-style
1330 @vindex message-from-style
1331 Specifies how @code{From} headers should look.  There are four valid
1332 values:
1334 @table @code
1335 @item nil
1336 Just the address---@samp{king@@grassland.com}.
1338 @item parens
1339 @samp{king@@grassland.com (Elvis Parsley)}.
1341 @item angles
1342 @samp{Elvis Parsley <king@@grassland.com>}.
1344 @item default
1345 Look like @code{angles} if that doesn't require quoting, and
1346 @code{parens} if it does.  If even @code{parens} requires quoting, use
1347 @code{angles} anyway.
1349 @end table
1351 @item message-deletable-headers
1352 @vindex message-deletable-headers
1353 Headers in this list that were previously generated by Message will be
1354 deleted before posting.  Let's say you post an article.  Then you decide
1355 to post it again to some other group, you naughty boy, so you jump back
1356 to the @code{*post-buf*} buffer, edit the @code{Newsgroups} line, and
1357 ship it off again.  By default, this variable makes sure that the old
1358 generated @code{Message-ID} is deleted, and a new one generated.  If
1359 this isn't done, the entire empire would probably crumble, anarchy would
1360 prevail, and cats would start walking on two legs and rule the world.
1361 Allegedly.
1363 @item message-default-headers
1364 @vindex message-default-headers
1365 This string is inserted at the end of the headers in all message
1366 buffers.
1368 @item message-subject-re-regexp
1369 @vindex message-subject-re-regexp
1370 @cindex Aw
1371 @cindex Sv
1372 @cindex Re
1373 Responses to messages have subjects that start with @samp{Re: }.  This
1374 is @emph{not} an abbreviation of the English word ``response'', but is
1375 Latin, and means ``in response to''.  Some illiterate nincompoops have
1376 failed to grasp this fact, and have ``internationalized'' their software
1377 to use abominations like @samp{Aw: } (``antwort'') or @samp{Sv: }
1378 (``svar'') instead, which is meaningless and evil.  However, you may
1379 have to deal with users that use these evil tools, in which case you may
1380 set this variable to a regexp that matches these prefixes.  Myself, I
1381 just throw away non-compliant mail.
1383 Here's an example of a value to deal with these headers when
1384 responding to a message:
1386 @lisp
1387 (setq message-subject-re-regexp
1388       (concat
1389        "^[ \t]*"
1390          "\\("
1391            "\\("
1392              "[Aa][Nn][Tt][Ww]\\.?\\|"     ; antw
1393              "[Aa][Ww]\\|"                 ; aw
1394              "[Ff][Ww][Dd]?\\|"            ; fwd
1395              "[Oo][Dd][Pp]\\|"             ; odp
1396              "[Rr][Ee]\\|"                 ; re
1397              "[Rr][\311\351][Ff]\\.?\\|"   ; ref
1398              "[Ss][Vv]"                    ; sv
1399            "\\)"
1400            "\\(\\[[0-9]*\\]\\)"
1401            "*:[ \t]*"
1402          "\\)"
1403        "*[ \t]*"
1404        ))
1405 @end lisp
1407 @item message-subject-trailing-was-query
1408 @vindex message-subject-trailing-was-query
1409 @vindex message-subject-trailing-was-ask-regexp
1410 @vindex message-subject-trailing-was-regexp
1411 Controls what to do with trailing @samp{(was: <old subject>)} in subject
1412 lines.  If @code{nil}, leave the subject unchanged.  If it is the symbol
1413 @code{ask}, query the user what do do.  In this case, the subject is
1414 matched against @code{message-subject-trailing-was-ask-regexp}.  If
1415 @code{message-subject-trailing-was-query} is @code{t}, always strip the
1416 trailing old subject.  In this case,
1417 @code{message-subject-trailing-was-regexp} is used.
1419 @item message-alternative-emails
1420 @vindex message-alternative-emails
1421 Regexp matching alternative email addresses.  The first address in the
1422 To, Cc or From headers of the original article matching this variable is
1423 used as the From field of outgoing messages, replacing the default From
1424 value.
1426 For example, if you have two secondary email addresses john@@home.net
1427 and john.doe@@work.com and want to use them in the From field when
1428 composing a reply to a message addressed to one of them, you could set
1429 this variable like this:
1431 @lisp
1432 (setq message-alternative-emails
1433       (regexp-opt '("john@@home.net" "john.doe@@work.com")))
1434 @end lisp
1436 This variable has precedence over posting styles and anything that runs
1437 off @code{message-setup-hook}.
1439 @item message-allow-no-recipients
1440 @vindex message-allow-no-recipients
1441 Specifies what to do when there are no recipients other than
1442 @code{Gcc} or @code{Fcc}.  If it is @code{always}, the posting is
1443 allowed.  If it is @code{never}, the posting is not allowed.  If it is
1444 @code{ask} (the default), you are prompted.
1446 @item message-hidden-headers
1447 @vindex message-hidden-headers
1448 A regexp, a list of regexps, or a list where the first element is
1449 @code{not} and the rest are regexps.  It says which headers to keep
1450 hidden when composing a message.
1452 @lisp
1453 (setq message-hidden-headers
1454       '(not "From" "Subject" "To" "Cc" "Newsgroups"))
1455 @end lisp
1457 Headers are hidden using narrowing, you can use @kbd{M-x widen} to
1458 expose them in the buffer.
1460 @item message-header-synonyms
1461 @vindex message-header-synonyms
1462 A list of lists of header synonyms.  E.g., if this list contains a
1463 member list with elements @code{Cc} and @code{To}, then
1464 @code{message-carefully-insert-headers} will not insert a @code{To}
1465 header when the message is already @code{Cc}ed to the recipient.
1467 @end table
1470 @node Mail Headers
1471 @section Mail Headers
1473 @table @code
1474 @item message-required-mail-headers
1475 @vindex message-required-mail-headers
1476 @xref{News Headers}, for the syntax of this variable.  It is
1477 @code{(From Subject Date (optional . In-Reply-To) Message-ID
1478 (optional . User-Agent))} by default.
1480 @item message-ignored-mail-headers
1481 @vindex message-ignored-mail-headers
1482 Regexp of headers to be removed before mailing.  The default is@*
1483 @samp{^[GF]cc:\\|^Resent-Fcc:\\|^Xref:\\|^X-Draft-From:\\|@*
1484 ^X-Gnus-Agent-Meta-Information:}.
1486 @item message-default-mail-headers
1487 @vindex message-default-mail-headers
1488 This string is inserted at the end of the headers in all message
1489 buffers that are initialized as mail.
1491 @item message-generate-hashcash
1492 @vindex message-generate-hashcash
1493 Boolean variable that indicate whether @samp{X-Hashcash} headers
1494 should be computed for the message.  @xref{Hashcash, ,Hashcash,gnus,
1495 The Gnus Manual}.
1497 @end table
1500 @node Mail Variables
1501 @section Mail Variables
1503 @table @code
1504 @item message-send-mail-function
1505 @vindex message-send-mail-function
1506 @findex message-send-mail-with-sendmail
1507 @findex message-send-mail-with-mh
1508 @findex message-send-mail-with-qmail
1509 @findex message-smtpmail-send-it
1510 @findex smtpmail-send-it
1511 @findex feedmail-send-it
1512 Function used to send the current buffer as mail.  The default is
1513 @code{message-send-mail-with-sendmail}, or @code{smtpmail-send-it}
1514 according to the system.  Other valid values include
1515 @code{message-send-mail-with-mh}, @code{message-send-mail-with-qmail},
1516 @code{message-smtpmail-send-it} and @code{feedmail-send-it}.
1518 @item message-mh-deletable-headers
1519 @vindex message-mh-deletable-headers
1520 Most versions of MH doesn't like being fed messages that contain the
1521 headers in this variable.  If this variable is non-@code{nil} (which is
1522 the default), these headers will be removed before mailing when sending
1523 messages via MH.  Set it to @code{nil} if your MH can handle these
1524 headers.
1526 @item message-qmail-inject-program
1527 @vindex message-qmail-inject-program
1528 @cindex qmail
1529 Location of the qmail-inject program.
1531 @item message-qmail-inject-args
1532 @vindex message-qmail-inject-args
1533 Arguments passed to qmail-inject programs.
1534 This should be a list of strings, one string for each argument.  It
1535 may also be a function.
1537 For e.g., if you wish to set the envelope sender address so that bounces
1538 go to the right place or to deal with listserv's usage of that address, you
1539 might set this variable to @code{'("-f" "you@@some.where")}.
1541 @item message-sendmail-f-is-evil
1542 @vindex message-sendmail-f-is-evil
1543 @cindex sendmail
1544 Non-@code{nil} means don't add @samp{-f username} to the sendmail
1545 command line.  Doing so would be even more evil than leaving it out.
1547 @item message-sendmail-envelope-from
1548 @vindex message-sendmail-envelope-from
1549 When @code{message-sendmail-f-is-evil} is @code{nil}, this specifies
1550 the address to use in the @acronym{SMTP} envelope.  If it is
1551 @code{nil}, use @code{user-mail-address}.  If it is the symbol
1552 @code{header}, use the @samp{From} header of the message.
1554 @item message-mailer-swallows-blank-line
1555 @vindex message-mailer-swallows-blank-line
1556 Set this to non-@code{nil} if the system's mailer runs the header and
1557 body together.  (This problem exists on SunOS 4 when sendmail is run
1558 in remote mode.)  The value should be an expression to test whether
1559 the problem will actually occur.
1561 @item message-send-mail-partially-limit
1562 @vindex message-send-mail-partially-limit
1563 @cindex split large message
1564 The limitation of messages sent as message/partial.  The lower bound
1565 of message size in characters, beyond which the message should be sent
1566 in several parts.  If it is @code{nil}, the size is unlimited.
1568 @end table
1571 @node News Headers
1572 @section News Headers
1574 @vindex message-required-news-headers
1575 @code{message-required-news-headers} a list of header symbols.  These
1576 headers will either be automatically generated, or, if that's
1577 impossible, they will be prompted for.  The following symbols are valid:
1579 @table @code
1581 @item From
1582 @cindex From
1583 @findex user-full-name
1584 @findex user-mail-address
1585 This required header will be filled out with the result of the
1586 @code{message-make-from} function, which depends on the
1587 @code{message-from-style}, @code{user-full-name},
1588 @code{user-mail-address} variables.
1590 @item Subject
1591 @cindex Subject
1592 This required header will be prompted for if not present already.
1594 @item Newsgroups
1595 @cindex Newsgroups
1596 This required header says which newsgroups the article is to be posted
1597 to.  If it isn't present already, it will be prompted for.
1599 @item Organization
1600 @cindex organization
1601 @vindex message-user-organization
1602 @vindex message-user-organization-file
1603 This optional header will be filled out depending on the
1604 @code{message-user-organization} variable.
1605 @code{message-user-organization-file} will be used if this variable is
1606 @code{t}.  This variable can also be a string (in which case this string
1607 will be used), or it can be a function (which will be called with no
1608 parameters and should return a string to be used).
1610 @item Lines
1611 @cindex Lines
1612 This optional header will be computed by Message.
1614 @item Message-ID
1615 @cindex Message-ID
1616 @vindex message-user-fqdn
1617 @vindex mail-host-address
1618 @vindex user-mail-address
1619 @findex system-name
1620 @cindex Sun
1621 @cindex i-did-not-set--mail-host-address--so-tickle-me
1622 This required header will be generated by Message.  A unique ID will be
1623 created based on the date, time, user name (for the local part) and the
1624 domain part.  For the domain part, message will look (in this order) at
1625 @code{message-user-fqdn}, @code{system-name}, @code{mail-host-address}
1626 and @code{message-user-mail-address} (i.e. @code{user-mail-address})
1627 until a probably valid fully qualified domain name (FQDN) was found.
1629 @item User-Agent
1630 @cindex User-Agent
1631 This optional header will be filled out according to the
1632 @code{message-newsreader} local variable.
1634 @item In-Reply-To
1635 This optional header is filled out using the @code{Date} and @code{From}
1636 header of the article being replied to.
1638 @item Expires
1639 @cindex Expires
1640 @vindex message-expires
1641 This extremely optional header will be inserted according to the
1642 @code{message-expires} variable.  It is highly deprecated and shouldn't
1643 be used unless you know what you're doing.
1645 @item Distribution
1646 @cindex Distribution
1647 @vindex message-distribution-function
1648 This optional header is filled out according to the
1649 @code{message-distribution-function} variable.  It is a deprecated and
1650 much misunderstood header.
1652 @item Path
1653 @cindex path
1654 @vindex message-user-path
1655 This extremely optional header should probably never be used.
1656 However, some @emph{very} old servers require that this header is
1657 present.  @code{message-user-path} further controls how this
1658 @code{Path} header is to look.  If it is @code{nil}, use the server name
1659 as the leaf node.  If it is a string, use the string.  If it is neither
1660 a string nor @code{nil}, use the user name only.  However, it is highly
1661 unlikely that you should need to fiddle with this variable at all.
1662 @end table
1664 @findex yow
1665 @cindex Mime-Version
1666 In addition, you can enter conses into this list.  The @sc{car} of this cons
1667 should be a symbol.  This symbol's name is the name of the header, and
1668 the @sc{cdr} can either be a string to be entered verbatim as the value of
1669 this header, or it can be a function to be called.  This function should
1670 return a string to be inserted.  For instance, if you want to insert
1671 @code{Mime-Version: 1.0}, you should enter @code{(Mime-Version . "1.0")}
1672 into the list.  If you want to insert a funny quote, you could enter
1673 something like @code{(X-Yow . yow)} into the list.  The function
1674 @code{yow} will then be called without any arguments.
1676 If the list contains a cons where the @sc{car} of the cons is
1677 @code{optional}, the @sc{cdr} of this cons will only be inserted if it is
1678 non-@code{nil}.
1680 If you want to delete an entry from this list, the following Lisp
1681 snippet might be useful.  Adjust accordingly if you want to remove
1682 another element.
1684 @lisp
1685 (setq message-required-news-headers
1686       (delq 'Message-ID message-required-news-headers))
1687 @end lisp
1689 Other variables for customizing outgoing news articles:
1691 @table @code
1693 @item message-syntax-checks
1694 @vindex message-syntax-checks
1695 Controls what syntax checks should not be performed on outgoing posts.
1696 To disable checking of long signatures, for instance, add
1698 @lisp
1699 (signature . disabled)
1700 @end lisp
1702 to this list.
1704 Valid checks are:
1706 @table @code
1707 @item subject-cmsg
1708 Check the subject for commands.
1709 @item sender
1710 @cindex Sender
1711 Insert a new @code{Sender} header if the @code{From} header looks odd.
1712 @item multiple-headers
1713 Check for the existence of multiple equal headers.
1714 @item sendsys
1715 @cindex sendsys
1716 Check for the existence of version and sendsys commands.
1717 @item message-id
1718 Check whether the @code{Message-ID} looks ok.
1719 @item from
1720 Check whether the @code{From} header seems nice.
1721 @item long-lines
1722 @cindex long lines
1723 Check for too long lines.
1724 @item control-chars
1725 Check for invalid characters.
1726 @item size
1727 Check for excessive size.
1728 @item new-text
1729 Check whether there is any new text in the messages.
1730 @item signature
1731 Check the length of the signature.
1732 @item approved
1733 @cindex approved
1734 Check whether the article has an @code{Approved} header, which is
1735 something only moderators should include.
1736 @item empty
1737 Check whether the article is empty.
1738 @item invisible-text
1739 Check whether there is any invisible text in the buffer.
1740 @item empty-headers
1741 Check whether any of the headers are empty.
1742 @item existing-newsgroups
1743 Check whether the newsgroups mentioned in the @code{Newsgroups} and
1744 @code{Followup-To} headers exist.
1745 @item valid-newsgroups
1746 Check whether the @code{Newsgroups} and @code{Followup-to} headers
1747 are valid syntactically.
1748 @item repeated-newsgroups
1749 Check whether the @code{Newsgroups} and @code{Followup-to} headers
1750 contains repeated group names.
1751 @item shorten-followup-to
1752 Check whether to add a @code{Followup-to} header to shorten the number
1753 of groups to post to.
1754 @end table
1756 All these conditions are checked by default.
1758 @item message-ignored-news-headers
1759 @vindex message-ignored-news-headers
1760 Regexp of headers to be removed before posting.  The default is@*
1761 @samp{^NNTP-Posting-Host:\\|^Xref:\\|^[BGF]cc:\\|^Resent-Fcc:\\|@*
1762 ^X-Draft-From:\\|^X-Gnus-Agent-Meta-Information:}.
1764 @item message-default-news-headers
1765 @vindex message-default-news-headers
1766 This string is inserted at the end of the headers in all message
1767 buffers that are initialized as news.
1769 @end table
1772 @node News Variables
1773 @section News Variables
1775 @table @code
1776 @item message-send-news-function
1777 @vindex message-send-news-function
1778 Function used to send the current buffer as news.  The default is
1779 @code{message-send-news}.
1781 @item message-post-method
1782 @vindex message-post-method
1783 Gnusish @dfn{select method} (see the Gnus manual for details) used for
1784 posting a prepared news message.
1786 @end table
1789 @node Insertion Variables
1790 @section Insertion Variables
1792 @table @code
1793 @item message-ignored-cited-headers
1794 @vindex message-ignored-cited-headers
1795 All headers that match this regexp will be removed from yanked
1796 messages.  The default is @samp{.}, which means that all headers will be
1797 removed.
1799 @item message-cite-prefix-regexp
1800 @vindex message-cite-prefix-regexp
1801 Regexp matching the longest possible citation prefix on a line.
1803 @item message-citation-line-function
1804 @vindex message-citation-line-function
1805 @cindex attribution line
1806 Function called to insert the citation line.  The default is
1807 @code{message-insert-citation-line}, which will lead to citation lines
1808 that look like:
1810 @example
1811 Hallvard B Furuseth <h.b.furuseth@@usit.uio.no> writes:
1812 @end example
1814 Point will be at the beginning of the body of the message when this
1815 function is called.
1817 Note that Gnus provides a feature where clicking on `writes:' hides the
1818 cited text.  If you change the citation line too much, readers of your
1819 messages will have to adjust their Gnus, too.  See the variable
1820 @code{gnus-cite-attribution-suffix}.  @xref{Article Highlighting, ,
1821 Article Highlighting, gnus, The Gnus Manual}, for details.
1823 @item message-yank-prefix
1824 @vindex message-yank-prefix
1825 @cindex yanking
1826 @cindex quoting
1827 When you are replying to or following up an article, you normally want
1828 to quote the person you are answering.  Inserting quoted text is done by
1829 @dfn{yanking}, and each line you yank will have
1830 @code{message-yank-prefix} prepended to it (except for quoted lines
1831 which use @code{message-yank-cited-prefix} and empty lines which use
1832 @code{message-yank-empty-prefix}).  The default is @samp{> }.
1834 @item message-yank-cited-prefix
1835 @vindex message-yank-cited-prefix
1836 @cindex yanking
1837 @cindex cited
1838 @cindex quoting
1839 When yanking text from an article which contains already cited text,
1840 each line will be prefixed with the contents of this variable.  The
1841 default is @samp{>}.  See also @code{message-yank-prefix}.
1843 @item message-yank-empty-prefix
1844 @vindex message-yank-empty-prefix
1845 @cindex yanking
1846 @cindex quoting
1847 When yanking text from an article, each empty line will be prefixed with
1848 the contents of this variable.  The default is @samp{>}.  You can set
1849 this variable to an empty string to split the cited text into paragraphs
1850 automatically.  See also @code{message-yank-prefix}.
1852 @item message-indentation-spaces
1853 @vindex message-indentation-spaces
1854 Number of spaces to indent yanked messages.
1856 @item message-cite-function
1857 @vindex message-cite-function
1858 @findex message-cite-original
1859 @findex sc-cite-original
1860 @findex message-cite-original-without-signature
1861 @cindex Supercite
1862 Function for citing an original message.  The default is
1863 @code{message-cite-original}, which simply inserts the original message
1864 and prepends @samp{> } to each line.
1865 @code{message-cite-original-without-signature} does the same, but elides
1866 the signature.  You can also set it to @code{sc-cite-original} to use
1867 Supercite.
1869 @item message-indent-citation-function
1870 @vindex message-indent-citation-function
1871 Function for modifying a citation just inserted in the mail buffer.
1872 This can also be a list of functions.  Each function can find the
1873 citation between @code{(point)} and @code{(mark t)}.  And each function
1874 should leave point and mark around the citation text as modified.
1876 @item message-mark-insert-begin
1877 @vindex message-mark-insert-begin
1878 String to mark the beginning of some inserted text.
1880 @item message-mark-insert-end
1881 @vindex message-mark-insert-end
1882 String to mark the end of some inserted text.
1884 @item message-signature
1885 @vindex message-signature
1886 String to be inserted at the end of the message buffer.  If @code{t}
1887 (which is the default), the @code{message-signature-file} file will be
1888 inserted instead.  If a function, the result from the function will be
1889 used instead.  If a form, the result from the form will be used instead.
1890 If this variable is @code{nil}, no signature will be inserted at all.
1892 @item message-signature-file
1893 @vindex message-signature-file
1894 File containing the signature to be inserted at the end of the buffer.
1895 The default is @file{~/.signature}.
1897 @item message-signature-insert-empty-line
1898 @vindex message-signature-insert-empty-line
1899 If @code{t} (the default value) an empty line is inserted before the
1900 signature separator.
1902 @end table
1904 Note that RFC1036bis says that a signature should be preceded by the three
1905 characters @samp{-- } on a line by themselves.  This is to make it
1906 easier for the recipient to automatically recognize and process the
1907 signature.  So don't remove those characters, even though you might feel
1908 that they ruin your beautiful design, like, totally.
1910 Also note that no signature should be more than four lines long.
1911 Including @acronym{ASCII} graphics is an efficient way to get
1912 everybody to believe that you are silly and have nothing important to
1913 say.
1916 @node Various Message Variables
1917 @section Various Message Variables
1919 @table @code
1920 @item message-default-charset
1921 @vindex message-default-charset
1922 @cindex charset
1923 Symbol naming a @acronym{MIME} charset.  Non-@acronym{ASCII} characters
1924 in messages are assumed to be encoded using this charset.  The default
1925 is @code{iso-8859-1} on non-@sc{mule} Emacsen; otherwise @code{nil},
1926 which means ask the user.  (This variable is used only on non-@sc{mule}
1927 Emacsen.)  @xref{Charset Translation, , Charset Translation, emacs-mime,
1928 Emacs MIME Manual}, for details on the @sc{mule}-to-@acronym{MIME}
1929 translation process.
1931 @item message-signature-separator
1932 @vindex message-signature-separator
1933 Regexp matching the signature separator.  It is @samp{^-- *$} by
1934 default.
1936 @item mail-header-separator
1937 @vindex mail-header-separator
1938 String used to separate the headers from the body.  It is @samp{--text
1939 follows this line--} by default.
1941 @item message-directory
1942 @vindex message-directory
1943 Directory used by many mailey things.  The default is @file{~/Mail/}.
1944 All other mail file variables are derived from @code{message-directory}.
1946 @item message-auto-save-directory
1947 @vindex message-auto-save-directory
1948 Directory where Message auto-saves buffers if Gnus isn't running.  If
1949 @code{nil}, Message won't auto-save.  The default is @file{~/Mail/drafts/}.
1951 @item message-signature-setup-hook
1952 @vindex message-signature-setup-hook
1953 Hook run when initializing the message buffer.  It is run after the
1954 headers have been inserted but before the signature has been inserted.
1956 @item message-setup-hook
1957 @vindex message-setup-hook
1958 Hook run as the last thing when the message buffer has been initialized,
1959 but before yanked text is inserted.
1961 @item message-header-setup-hook
1962 @vindex message-header-setup-hook
1963 Hook called narrowed to the headers after initializing the headers.
1965 For instance, if you're running Gnus and wish to insert a
1966 @samp{Mail-Copies-To} header in all your news articles and all messages
1967 you send to mailing lists, you could do something like the following:
1969 @lisp
1970 (defun my-message-header-setup-hook ()
1971   (let ((group (or gnus-newsgroup-name "")))
1972     (when (or (message-fetch-field "newsgroups")
1973               (gnus-group-find-parameter group 'to-address)
1974               (gnus-group-find-parameter group 'to-list))
1975       (insert "Mail-Copies-To: never\n"))))
1977 (add-hook 'message-header-setup-hook
1978           'my-message-header-setup-hook)
1979 @end lisp
1981 @item message-send-hook
1982 @vindex message-send-hook
1983 Hook run before sending messages.
1985 If you want to add certain headers before sending, you can use the
1986 @code{message-add-header} function in this hook.  For instance:
1987 @findex message-add-header
1989 @lisp
1990 (add-hook 'message-send-hook 'my-message-add-content)
1991 (defun my-message-add-content ()
1992   (message-add-header "X-In-No-Sense: Nonsense")
1993   (message-add-header "X-Whatever: no"))
1994 @end lisp
1996 This function won't add the header if the header is already present.
1998 @item message-send-mail-hook
1999 @vindex message-send-mail-hook
2000 Hook run before sending mail messages.  This hook is run very late --
2001 just before the message is actually sent as mail.
2003 @item message-send-news-hook
2004 @vindex message-send-news-hook
2005 Hook run before sending news messages.  This hook is run very late --
2006 just before the message is actually sent as news.
2008 @item message-sent-hook
2009 @vindex message-sent-hook
2010 Hook run after sending messages.
2012 @item message-cancel-hook
2013 @vindex message-cancel-hook
2014 Hook run when canceling news articles.
2016 @item message-mode-syntax-table
2017 @vindex message-mode-syntax-table
2018 Syntax table used in message mode buffers.
2020 @item message-cite-articles-with-x-no-archive
2021 @vindex message-cite-articles-with-x-no-archive
2022 If non-@code{nil}, don't strip quoted text from articles that have
2023 @samp{X-No-Archive} set.  Even if this variable isn't set, you can
2024 undo the stripping by hitting the @code{undo} keystroke.
2026 @item message-strip-special-text-properties
2027 @vindex message-strip-special-text-properties
2028 Emacs has a number of special text properties which can break message
2029 composing in various ways.  If this option is set, message will strip
2030 these properties from the message composition buffer.  However, some
2031 packages requires these properties to be present in order to work.  If
2032 you use one of these packages, turn this option off, and hope the
2033 message composition doesn't break too bad.
2035 @item message-send-method-alist
2036 @vindex message-send-method-alist
2037 @findex message-mail-p
2038 @findex message-news-p
2039 @findex message-send-via-mail
2040 @findex message-send-via-news
2041 Alist of ways to send outgoing messages.  Each element has the form:
2043 @lisp
2044 (@var{type} @var{predicate} @var{function})
2045 @end lisp
2047 @table @var
2048 @item type
2049 A symbol that names the method.
2051 @item predicate
2052 A function called without any parameters to determine whether the
2053 message is a message of type @var{type}.  The function will be called in
2054 the buffer where the message is.
2056 @item function
2057 A function to be called if @var{predicate} returns non-@code{nil}.
2058 @var{function} is called with one parameter---the prefix.
2059 @end table
2061 The default is:
2063 @lisp
2064 ((news message-news-p message-send-via-news)
2065  (mail message-mail-p message-send-via-mail))
2066 @end lisp
2068 The @code{message-news-p} function returns non-@code{nil} if the message
2069 looks like news, and the @code{message-send-via-news} function sends the
2070 message according to the @code{message-send-news-function} variable
2071 (@pxref{News Variables}).  The @code{message-mail-p} function returns
2072 non-@code{nil} if the message looks like mail, and the
2073 @code{message-send-via-mail} function sends the message according to the
2074 @code{message-send-mail-function} variable (@pxref{Mail Variables}).
2076 All the elements in this alist will be tried in order, so a message
2077 containing both a valid @samp{Newsgroups} header and a valid @samp{To}
2078 header, for example, will be sent as news, and then as mail.
2079 @end table
2083 @node Sending Variables
2084 @section Sending Variables
2086 @table @code
2088 @item message-fcc-handler-function
2089 @vindex message-fcc-handler-function
2090 A function called to save outgoing articles.  This function will be
2091 called with the name of the file to store the article in.  The default
2092 function is @code{message-output} which saves in Unix mailbox format.
2094 @item message-courtesy-message
2095 @vindex message-courtesy-message
2096 When sending combined messages, this string is inserted at the start of
2097 the mailed copy.  If the string contains the format spec @samp{%s}, the
2098 newsgroups the article has been posted to will be inserted there.  If
2099 this variable is @code{nil}, no such courtesy message will be added.
2100 The default value is @samp{"The following message is a courtesy copy of
2101 an article\\nthat has been posted to %s as well.\\n\\n"}.
2103 @item message-fcc-externalize-attachments
2104 @vindex message-fcc-externalize-attachments
2105 If @code{nil}, attach files as normal parts in Fcc copies; if it is
2106 non-@code{nil}, attach local files as external parts.
2108 @item message-interactive
2109 @vindex message-interactive
2110 If non-@code{nil} wait for and display errors when sending a message;
2111 if @code{nil} let the mailer mail back a message to report errors.
2113 @end table
2116 @node Message Buffers
2117 @section Message Buffers
2119 Message will generate new buffers with unique buffer names when you
2120 request a message buffer.  When you send the message, the buffer isn't
2121 normally killed off.  Its name is changed and a certain number of old
2122 message buffers are kept alive.
2124 @table @code
2125 @item message-generate-new-buffers
2126 @vindex message-generate-new-buffers
2127 If non-@code{nil}, generate new buffers.  The default is @code{t}.  If
2128 this is a function, call that function with three parameters: The type,
2129 the to address and the group name.  (Any of these may be @code{nil}.)
2130 The function should return the new buffer name.
2132 @item message-max-buffers
2133 @vindex message-max-buffers
2134 This variable says how many old message buffers to keep.  If there are
2135 more message buffers than this, the oldest buffer will be killed.  The
2136 default is 10.  If this variable is @code{nil}, no old message buffers
2137 will ever be killed.
2139 @item message-send-rename-function
2140 @vindex message-send-rename-function
2141 After sending a message, the buffer is renamed from, for instance,
2142 @samp{*reply to Lars*} to @samp{*sent reply to Lars*}.  If you don't
2143 like this, set this variable to a function that renames the buffer in a
2144 manner you like.  If you don't want to rename the buffer at all, you can
2145 say:
2147 @lisp
2148 (setq message-send-rename-function 'ignore)
2149 @end lisp
2151 @item message-kill-buffer-on-exit
2152 @findex message-kill-buffer-on-exit
2153 If non-@code{nil}, kill the buffer immediately on exit.
2155 @end table
2158 @node Message Actions
2159 @section Message Actions
2161 When Message is being used from a news/mail reader, the reader is likely
2162 to want to perform some task after the message has been sent.  Perhaps
2163 return to the previous window configuration or mark an article as
2164 replied.
2166 @vindex message-kill-actions
2167 @vindex message-postpone-actions
2168 @vindex message-exit-actions
2169 @vindex message-send-actions
2170 The user may exit from the message buffer in various ways.  The most
2171 common is @kbd{C-c C-c}, which sends the message and exits.  Other
2172 possibilities are @kbd{C-c C-s} which just sends the message, @kbd{C-c
2173 C-d} which postpones the message editing and buries the message buffer,
2174 and @kbd{C-c C-k} which kills the message buffer.  Each of these actions
2175 have lists associated with them that contains actions to be executed:
2176 @code{message-send-actions}, @code{message-exit-actions},
2177 @code{message-postpone-actions}, and @code{message-kill-actions}.
2179 Message provides a function to interface with these lists:
2180 @code{message-add-action}.  The first parameter is the action to be
2181 added, and the rest of the arguments are which lists to add this action
2182 to.  Here's an example from Gnus:
2184 @lisp
2185   (message-add-action
2186    `(set-window-configuration ,(current-window-configuration))
2187    'exit 'postpone 'kill)
2188 @end lisp
2190 This restores the Gnus window configuration when the message buffer is
2191 killed, postponed or exited.
2193 An @dfn{action} can be either: a normal function, or a list where the
2194 @sc{car} is a function and the @sc{cdr} is the list of arguments, or
2195 a form to be @code{eval}ed.
2198 @node Compatibility
2199 @chapter Compatibility
2200 @cindex compatibility
2202 Message uses virtually only its own variables---older @code{mail-}
2203 variables aren't consulted.  To force Message to take those variables
2204 into account, you can put the following in your @file{.emacs} file:
2206 @lisp
2207 (require 'messcompat)
2208 @end lisp
2210 This will initialize many Message variables from the values in the
2211 corresponding mail variables.
2214 @node Appendices
2215 @chapter Appendices
2217 @menu
2218 * Responses::          Standard rules for determining where responses go.
2219 @end menu
2222 @node Responses
2223 @section Responses
2225 To determine where a message is to go, the following algorithm is used
2226 by default.
2228 @table @dfn
2229 @item reply
2230 A @dfn{reply} is when you want to respond @emph{just} to the person who
2231 sent the message via mail.  There will only be one recipient.  To
2232 determine who the recipient will be, the following headers are
2233 consulted, in turn:
2235 @table @code
2236 @item Reply-To
2238 @item From
2239 @end table
2242 @item wide reply
2243 A @dfn{wide reply} is a mail response that includes @emph{all} entities
2244 mentioned in the message you are responded to.  All mailboxes from the
2245 following headers will be concatenated to form the outgoing
2246 @code{To}/@code{Cc} headers:
2248 @table @code
2249 @item From
2250 (unless there's a @code{Reply-To}, in which case that is used instead).
2252 @item Cc
2254 @item To
2255 @end table
2257 If a @code{Mail-Copies-To} header is present, it will also be included
2258 in the list of mailboxes.  If this header is @samp{never}, that means
2259 that the @code{From} (or @code{Reply-To}) mailbox will be suppressed.
2262 @item followup
2263 A @dfn{followup} is a response sent via news.  The following headers
2264 (listed in order of precedence) determine where the response is to be
2265 sent:
2267 @table @code
2269 @item Followup-To
2271 @item Newsgroups
2273 @end table
2275 If a @code{Mail-Copies-To} header is present, it will be used as the
2276 basis of the new @code{Cc} header, except if this header is
2277 @samp{never}.
2279 @end table
2283 @node Index
2284 @chapter Index
2285 @printindex cp
2287 @node Key Index
2288 @chapter Key Index
2289 @printindex ky
2291 @summarycontents
2292 @contents
2293 @bye
2295 @c End:
2297 @ignore
2298    arch-tag: 16ab76af-a281-4e34-aed6-5624569f7601
2299 @end ignore