* src/lread.c: Remove `read_pure' which makes no difference.
[emacs.git] / doc / misc / message.texi
blobac5811a0ce8ce8da0ad76d8d7ada1eb189fb2d8f
1 \input texinfo                  @c -*-texinfo-*-
3 @include gnus-overrides.texi
5 @setfilename ../../info/message
6 @settitle Message Manual
7 @synindex fn cp
8 @synindex vr cp
9 @synindex pg cp
10 @copying
11 This file documents Message, the Emacs message composition mode.
13 Copyright @copyright{} 1996-2012 Free Software Foundation, Inc.
15 @quotation
16 Permission is granted to copy, distribute and/or modify this document
17 under the terms of the GNU Free Documentation License, Version 1.3 or
18 any later version published by the Free Software Foundation; with no
19 Invariant Sections, with the Front-Cover texts being ``A GNU Manual'',
20 and with the Back-Cover Texts as in (a) below.  A copy of the license
21 is included in the section entitled ``GNU Free Documentation License''.
23 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
24 modify this GNU manual.  Buying copies from the FSF supports it in
25 developing GNU and promoting software freedom.''
26 @end quotation
27 @end copying
29 @dircategory Emacs network features
30 @direntry
31 * Message: (message).           Mail and news composition mode that
32                                   goes with Gnus.
33 @end direntry
34 @iftex
35 @finalout
36 @end iftex
38 @titlepage
39 @ifset WEBHACKDEVEL
40 @title Message Manual (DEVELOPMENT VERSION)
41 @end ifset
42 @ifclear WEBHACKDEVEL
43 @title Message Manual
44 @end ifclear
46 @author by Lars Magne Ingebrigtsen
47 @page
49 @vskip 0pt plus 1filll
50 @insertcopying
51 @end titlepage
53 @summarycontents
54 @contents
56 @node Top
57 @top Message
59 @ifnottex
60 @insertcopying
61 @end ifnottex
63 All message composition from Gnus (both mail and news) takes place in
64 Message mode buffers.
66 @menu
67 * Interface::         Setting up message buffers.
68 * Commands::          Commands you can execute in message mode buffers.
69 * Variables::         Customizing the message buffers.
70 * Compatibility::     Making Message backwards compatible.
71 * Appendices::        More technical things.
72 * GNU Free Documentation License:: The license for this documentation.
73 * Index::             Variable, function and concept index.
74 * Key Index::         List of Message mode keys.
75 @end menu
77 @c Adjust ../Makefile.in if you change the following lines:
78 Message is distributed with Gnus.  The Gnus distribution
80 corresponding to this manual is Gnus v5.13
83 @node Interface
84 @chapter Interface
86 When a program (or a person) wants to respond to a message---reply,
87 follow up, forward, cancel---the program (or person) should just put
88 point in the buffer where the message is and call the required command.
89 @code{Message} will then pop up a new @code{message} mode buffer with
90 appropriate headers filled out, and the user can edit the message before
91 sending it.
93 @menu
94 * New Mail Message::     Editing a brand new mail message.
95 * New News Message::     Editing a brand new news message.
96 * Reply::                Replying via mail.
97 * Wide Reply::           Responding to all people via mail.
98 * Followup::             Following up via news.
99 * Canceling News::       Canceling a news article.
100 * Superseding::          Superseding a message.
101 * Forwarding::           Forwarding a message via news or mail.
102 * Resending::            Resending a mail message.
103 * Bouncing::             Bouncing a mail message.
104 * Mailing Lists::        Send mail to mailing lists.
105 @end menu
107 You can customize the Message Mode tool bar, see @kbd{M-x
108 customize-apropos RET message-tool-bar}.  This feature is only available
109 in Emacs.
111 @node New Mail Message
112 @section New Mail Message
114 @findex message-mail
115 The @code{message-mail} command pops up a new message buffer.
117 Two optional parameters are accepted: The first will be used as the
118 @code{To} header and the second as the @code{Subject} header.  If these
119 are @code{nil}, those two headers will be empty.
122 @node New News Message
123 @section New News Message
125 @findex message-news
126 The @code{message-news} command pops up a new message buffer.
128 This function accepts two optional parameters.  The first will be used
129 as the @code{Newsgroups} header and the second as the @code{Subject}
130 header.  If these are @code{nil}, those two headers will be empty.
133 @node Reply
134 @section Reply
136 @findex message-reply
137 The @code{message-reply} function pops up a message buffer that's a
138 reply to the message in the current buffer.
140 @vindex message-reply-to-function
141 Message uses the normal methods to determine where replies are to go
142 (@pxref{Responses}), but you can change the behavior to suit your needs
143 by fiddling with the @code{message-reply-to-function} variable.
145 If you want the replies to go to the @code{Sender} instead of the
146 @code{From}, you could do something like this:
148 @lisp
149 (setq message-reply-to-function
150       (lambda ()
151        (cond ((equal (mail-fetch-field "from") "somebody")
152                (list (cons 'To (mail-fetch-field "sender"))))
153              (t
154               nil))))
155 @end lisp
157 This function will be called narrowed to the head of the article that is
158 being replied to.
160 As you can see, this function should return a list.  In this case, it
161 returns @code{((To . "Whom"))} if it has an opinion as to what the To
162 header should be.  If it does not, it should just return @code{nil}, and
163 the normal methods for determining the To header will be used.
165 Each list element should be a cons, where the @sc{car} should be the
166 name of a header (e.g. @code{Cc}) and the @sc{cdr} should be the header
167 value (e.g. @samp{larsi@@ifi.uio.no}).  All these headers will be
168 inserted into the head of the outgoing mail.
171 @node Wide Reply
172 @section Wide Reply
174 @findex message-wide-reply
175 The @code{message-wide-reply} pops up a message buffer that's a wide
176 reply to the message in the current buffer.  A @dfn{wide reply} is a
177 reply that goes out to all people listed in the @code{To}, @code{From}
178 (or @code{Reply-to}) and @code{Cc} headers.
180 @vindex message-wide-reply-to-function
181 Message uses the normal methods to determine where wide replies are to go,
182 but you can change the behavior to suit your needs by fiddling with the
183 @code{message-wide-reply-to-function}.  It is used in the same way as
184 @code{message-reply-to-function} (@pxref{Reply}).
186 @vindex message-dont-reply-to-names
187 Addresses that match the @code{message-dont-reply-to-names} regular
188 expression (or list of regular expressions) will be removed from the
189 @code{Cc} header. A value of @code{nil} means exclude your name only.
191 @vindex message-prune-recipient-rules
192 @code{message-prune-recipient-rules} is used to prune the addresses
193 used when doing a wide reply.  It's meant to be used to remove
194 duplicate addresses and the like.  It's a list of lists, where the
195 first element is a regexp to match the address to trigger the rule,
196 and the second is a regexp that will be expanded based on the first,
197 to match addresses to be pruned.
199 It's complicated to explain, but it's easy to use.
201 For instance, if you get an email from @samp{foo@@example.org}, but
202 @samp{foo@@zot.example.org} is also in the @code{Cc} list, then your
203 wide reply will go out to both these addresses, since they are unique.
205 To avoid this, do something like the following:
207 @lisp
208 (setq message-prune-recipient-rules
209       '(("^\\([^@@]+\\)@@\\(.*\\)" "\\1@@.*[.]\\2")))
210 @end lisp
212 If, for instance, you want all wide replies that involve messages from
213 @samp{cvs@@example.org} to go to that address, and nowhere else (i.e.,
214 remove all other recipients if @samp{cvs@@example.org} is in the
215 recipient list:
217 @lisp
218 (setq message-prune-recipient-rules
219       '(("cvs@@example.org" ".")))
220 @end lisp
222 @vindex message-wide-reply-confirm-recipients
223 If @code{message-wide-reply-confirm-recipients} is non-@code{nil} you
224 will be asked to confirm that you want to reply to multiple
225 recipients.  The default is @code{nil}.
227 @node Followup
228 @section Followup
230 @findex message-followup
231 The @code{message-followup} command pops up a message buffer that's a
232 followup to the message in the current buffer.
234 @vindex message-followup-to-function
235 Message uses the normal methods to determine where followups are to go,
236 but you can change the behavior to suit your needs by fiddling with the
237 @code{message-followup-to-function}.  It is used in the same way as
238 @code{message-reply-to-function} (@pxref{Reply}).
240 @vindex message-use-followup-to
241 The @code{message-use-followup-to} variable says what to do about
242 @code{Followup-To} headers.  If it is @code{use}, always use the value.
243 If it is @code{ask} (which is the default), ask whether to use the
244 value.  If it is @code{t}, use the value unless it is @samp{poster}.  If
245 it is @code{nil}, don't use the value.
248 @node Canceling News
249 @section Canceling News
251 @findex message-cancel-news
252 The @code{message-cancel-news} command cancels the article in the
253 current buffer.
255 @vindex message-cancel-message
256 The value of @code{message-cancel-message} is inserted in the body of
257 the cancel message.  The default is @samp{I am canceling my own
258 article.}.
260 @cindex Cancel Locks
261 @vindex message-insert-canlock
262 @cindex canlock
263 When Message posts news messages, it inserts @code{Cancel-Lock}
264 headers by default.  This is a cryptographic header that ensures that
265 only you can cancel your own messages, which is nice.  The downside
266 is that if you lose your @file{.emacs} file (which is where Gnus
267 stores the secret cancel lock password (which is generated
268 automatically the first time you use this feature)), you won't be
269 able to cancel your message.  If you want to manage a password yourself,
270 you can put something like the following in your @file{~/.gnus.el} file:
272 @lisp
273 (setq canlock-password "geheimnis"
274       canlock-password-for-verify canlock-password)
275 @end lisp
277 Whether to insert the header or not is controlled by the
278 @code{message-insert-canlock} variable.
280 Not many news servers respect the @code{Cancel-Lock} header yet, but
281 this is expected to change in the future.
284 @node Superseding
285 @section Superseding
287 @findex message-supersede
288 The @code{message-supersede} command pops up a message buffer that will
289 supersede the message in the current buffer.
291 @vindex message-ignored-supersedes-headers
292 Headers matching the @code{message-ignored-supersedes-headers} are
293 removed before popping up the new message buffer.  The default is@*
294 @samp{^Path:\\|^Date\\|^NNTP-Posting-Host:\\|^Xref:\\|^Lines:\\|@*
295 ^Received:\\|^X-From-Line:\\|^X-Trace:\\|^X-Complaints-To:\\|@*
296 Return-Path:\\|^Supersedes:\\|^NNTP-Posting-Date:\\|^X-Trace:\\|@*
297 ^X-Complaints-To:\\|^Cancel-Lock:\\|^Cancel-Key:\\|^X-Hashcash:\\|@*
298 ^X-Payment:\\|^Approved:}.
302 @node Forwarding
303 @section Forwarding
305 @findex message-forward
306 The @code{message-forward} command pops up a message buffer to forward
307 the message in the current buffer.  If given a prefix, forward using
308 news.
310 @table @code
311 @item message-forward-ignored-headers
312 @vindex message-forward-ignored-headers
313 All headers that match this regexp will be deleted when forwarding a message.
315 @item message-make-forward-subject-function
316 @vindex message-make-forward-subject-function
317 A list of functions that are called to generate a subject header for
318 forwarded messages.  The subject generated by the previous function is
319 passed into each successive function.
321 The provided functions are:
323 @table @code
324 @item message-forward-subject-author-subject
325 @findex message-forward-subject-author-subject
326 Source of article (author or newsgroup), in brackets followed by the
327 subject.
329 @item message-forward-subject-fwd
330 Subject of article with @samp{Fwd:} prepended to it.
331 @end table
333 @item message-wash-forwarded-subjects
334 @vindex message-wash-forwarded-subjects
335 If this variable is @code{t}, the subjects of forwarded messages have
336 the evidence of previous forwards (such as @samp{Fwd:}, @samp{Re:},
337 @samp{(fwd)}) removed before the new subject is
338 constructed.  The default value is @code{nil}.
340 @item message-forward-as-mime
341 @vindex message-forward-as-mime
342 If this variable is @code{t} (the default), forwarded messages are
343 included as inline @acronym{MIME} RFC822 parts.  If it's @code{nil}, forwarded
344 messages will just be copied inline to the new message, like previous,
345 non @acronym{MIME}-savvy versions of Gnus would do.
347 @item message-forward-before-signature
348 @vindex message-forward-before-signature
349 If non-@code{nil}, put forwarded message before signature, else after.
351 @end table
354 @node Resending
355 @section Resending
357 @findex message-resend
358 The @code{message-resend} command will prompt the user for an address
359 and resend the message in the current buffer to that address.
361 @vindex message-ignored-resent-headers
362 Headers that match the @code{message-ignored-resent-headers} regexp will
363 be removed before sending the message.
366 @node Bouncing
367 @section Bouncing
369 @findex message-bounce
370 The @code{message-bounce} command will, if the current buffer contains a
371 bounced mail message, pop up a message buffer stripped of the bounce
372 information.  A @dfn{bounced message} is typically a mail you've sent
373 out that has been returned by some @code{mailer-daemon} as
374 undeliverable.
376 @vindex message-ignored-bounced-headers
377 Headers that match the @code{message-ignored-bounced-headers} regexp
378 will be removed before popping up the buffer.  The default is
379 @samp{^\\(Received\\|Return-Path\\|Delivered-To\\):}.
382 @node Mailing Lists
383 @section Mailing Lists
385 @cindex Mail-Followup-To
386 Sometimes while posting to mailing lists, the poster needs to direct
387 followups to the post to specific places.  The Mail-Followup-To (MFT)
388 was created to enable just this.  Three example scenarios where this is
389 useful:
391 @itemize @bullet
392 @item
393 A mailing list poster can use MFT to express that responses should be
394 sent to just the list, and not the poster as well.  This will happen
395 if the poster is already subscribed to the list.
397 @item
398 A mailing list poster can use MFT to express that responses should be
399 sent to the list and the poster as well.  This will happen if the poster
400 is not subscribed to the list.
402 @item
403 If a message is posted to several mailing lists, MFT may also be used
404 to direct the following discussion to one list only, because
405 discussions that are spread over several lists tend to be fragmented
406 and very difficult to follow.
408 @end itemize
410 Gnus honors the MFT header in other's messages (i.e. while following
411 up to someone else's post) and also provides support for generating
412 sensible MFT headers for outgoing messages as well.
414 @c @menu
415 @c * Honoring an MFT post::        What to do when one already exists
416 @c * Composing with a MFT header:: Creating one from scratch.
417 @c @end menu
419 @c @node Composing with a MFT header
420 @subsection  Composing a correct MFT header automagically
422 The first step in getting Gnus to automagically generate a MFT header
423 in posts you make is to give Gnus a list of the mailing lists
424 addresses you are subscribed to.  You can do this in more than one
425 way.  The following variables would come in handy.
427 @table @code
429 @vindex message-subscribed-addresses
430 @item message-subscribed-addresses
431 This should be a list of addresses the user is subscribed to.  Its
432 default value is @code{nil}.  Example:
433 @lisp
434 (setq message-subscribed-addresses
435       '("ding@@gnus.org" "bing@@noose.org"))
436 @end lisp
438 @vindex message-subscribed-regexps
439 @item message-subscribed-regexps
440 This should be a list of regexps denoting the addresses of mailing
441 lists subscribed to.  Default value is @code{nil}.  Example: If you
442 want to achieve the same result as above:
443 @lisp
444 (setq message-subscribed-regexps
445       '("\\(ding@@gnus\\)\\|\\(bing@@noose\\)\\.org")
446 @end lisp
448 @vindex message-subscribed-address-functions
449 @item message-subscribed-address-functions
450 This can be a list of functions to be called (one at a time!!) to
451 determine the value of MFT headers.  It is advisable that these
452 functions not take any arguments.  Default value is @code{nil}.
454 There is a pre-defined function in Gnus that is a good candidate for
455 this variable.  @code{gnus-find-subscribed-addresses} is a function
456 that returns a list of addresses corresponding to the groups that have
457 the @code{subscribed} (@pxref{Group Parameters, ,Group Parameters,
458 gnus, The Gnus Manual}) group parameter set to a non-@code{nil} value.
459 This is how you would do it.
461 @lisp
462 (setq message-subscribed-address-functions
463       '(gnus-find-subscribed-addresses))
464 @end lisp
466 @vindex message-subscribed-address-file
467 @item message-subscribed-address-file
468 You might be one organized human freak and have a list of addresses of
469 all subscribed mailing lists in a separate file!  Then you can just
470 set this variable to the name of the file and life would be good.
472 @end table
474 You can use one or more of the above variables.  All their values are
475 ``added'' in some way that works :-)
477 Now you are all set.  Just start composing a message as you normally do.
478 And just send it; as always.  Just before the message is sent out, Gnus'
479 MFT generation thingy kicks in and checks if the message already has a
480 MFT field.  If there is one, it is left alone.  (Except if it's empty -
481 in that case, the field is removed and is not replaced with an
482 automatically generated one.  This lets you disable MFT generation on a
483 per-message basis.)  If there is none, then the list of recipient
484 addresses (in the To: and Cc: headers) is checked to see if one of them
485 is a list address you are subscribed to.  If none of them is a list
486 address, then no MFT is generated; otherwise, a MFT is added to the
487 other headers and set to the value of all addresses in To: and Cc:
489 @kindex C-c C-f C-a
490 @findex message-generate-unsubscribed-mail-followup-to
491 @kindex C-c C-f C-m
492 @findex message-goto-mail-followup-to
493 Hm.  ``So'', you ask, ``what if I send an email to a list I am not
494 subscribed to?  I want my MFT to say that I want an extra copy.''  (This
495 is supposed to be interpreted by others the same way as if there were no
496 MFT, but you can use an explicit MFT to override someone else's
497 to-address group parameter.)  The function
498 @code{message-generate-unsubscribed-mail-followup-to} might come in
499 handy.  It is bound to @kbd{C-c C-f C-a} by default.  In any case, you
500 can insert a MFT of your own choice; @kbd{C-c C-f C-m}
501 (@code{message-goto-mail-followup-to}) will help you get started.
503 @c @node Honoring an MFT post
504 @subsection Honoring an MFT post
506 @vindex message-use-mail-followup-to
507 When you followup to a post on a mailing list, and the post has a MFT
508 header, Gnus' action will depend on the value of the variable
509 @code{message-use-mail-followup-to}.  This variable can be one of:
511 @table @code
512 @item use
513  Always honor MFTs.  The To: and Cc: headers in your followup will be
514  derived from the MFT header of the original post.  This is the default.
516 @item nil
517  Always dishonor MFTs (just ignore the darned thing)
519 @item ask
520 Gnus will prompt you for an action.
522 @end table
524 It is considered good netiquette to honor MFT, as it is assumed the
525 fellow who posted a message knows where the followups need to go
526 better than you do.
528 @node Commands
529 @chapter Commands
531 @menu
532 * Buffer Entry::        Commands after entering a Message buffer.
533 * Header Commands::     Commands for moving headers or changing headers.
534 * Movement::            Moving around in message buffers.
535 * Insertion::           Inserting things into message buffers.
536 * MIME::                @acronym{MIME} considerations.
537 * IDNA::                Non-@acronym{ASCII} domain name considerations.
538 * Security::            Signing and encrypting messages.
539 * Various Commands::    Various things.
540 * Sending::             Actually sending the message.
541 * Mail Aliases::        How to use mail aliases.
542 * Spelling::            Having Emacs check your spelling.
543 @end menu
546 @node Buffer Entry
547 @section Buffer Entry
548 @cindex undo
549 @kindex C-_
551 You most often end up in a Message buffer when responding to some other
552 message of some sort.  Message does lots of handling of quoted text, and
553 may remove signatures, reformat the text, or the like---depending on
554 which used settings you're using.  Message usually gets things right,
555 but sometimes it stumbles.  To help the user unwind these stumblings,
556 Message sets the undo boundary before each major automatic action it
557 takes.  If you press the undo key (usually located at @kbd{C-_}) a few
558 times, you will get back the un-edited message you're responding to.
561 @node Header Commands
562 @section Header Commands
564 @subsection Commands for moving to headers
566 These following commands move to the header in question.  If it doesn't
567 exist, it will be inserted.
569 @table @kbd
571 @item C-c ?
572 @kindex C-c ?
573 @findex describe-mode
574 Describe the message mode.
576 @item C-c C-f C-t
577 @kindex C-c C-f C-t
578 @findex message-goto-to
579 Go to the @code{To} header (@code{message-goto-to}).
581 @item C-c C-f C-o
582 @kindex C-c C-f C-o
583 @findex message-goto-from
584 Go to the @code{From} header (@code{message-goto-from}).  (The ``o''
585 in the key binding is for Originator.)
587 @item C-c C-f C-b
588 @kindex C-c C-f C-b
589 @findex message-goto-bcc
590 Go to the @code{Bcc} header (@code{message-goto-bcc}).
592 @item C-c C-f C-w
593 @kindex C-c C-f C-w
594 @findex message-goto-fcc
595 Go to the @code{Fcc} header (@code{message-goto-fcc}).
597 @item C-c C-f C-c
598 @kindex C-c C-f C-c
599 @findex message-goto-cc
600 Go to the @code{Cc} header (@code{message-goto-cc}).
602 @item C-c C-f C-s
603 @kindex C-c C-f C-s
604 @findex message-goto-subject
605 Go to the @code{Subject} header (@code{message-goto-subject}).
607 @item C-c C-f C-r
608 @kindex C-c C-f C-r
609 @findex message-goto-reply-to
610 Go to the @code{Reply-To} header (@code{message-goto-reply-to}).
612 @item C-c C-f C-n
613 @kindex C-c C-f C-n
614 @findex message-goto-newsgroups
615 Go to the @code{Newsgroups} header (@code{message-goto-newsgroups}).
617 @item C-c C-f C-d
618 @kindex C-c C-f C-d
619 @findex message-goto-distribution
620 Go to the @code{Distribution} header (@code{message-goto-distribution}).
622 @item C-c C-f C-f
623 @kindex C-c C-f C-f
624 @findex message-goto-followup-to
625 Go to the @code{Followup-To} header (@code{message-goto-followup-to}).
627 @item C-c C-f C-k
628 @kindex C-c C-f C-k
629 @findex message-goto-keywords
630 Go to the @code{Keywords} header (@code{message-goto-keywords}).
632 @item C-c C-f C-u
633 @kindex C-c C-f C-u
634 @findex message-goto-summary
635 Go to the @code{Summary} header (@code{message-goto-summary}).
637 @item C-c C-f C-i
638 @kindex C-c C-f C-i
639 @findex message-insert-or-toggle-importance
640 This inserts the @samp{Importance:} header with a value of
641 @samp{high}.  This header is used to signal the importance of the
642 message to the receiver.  If the header is already present in the
643 buffer, it cycles between the three valid values according to RFC
644 1376: @samp{low}, @samp{normal} and @samp{high}.
646 @item C-c C-f C-a
647 @kindex C-c C-f C-a
648 @findex message-generate-unsubscribed-mail-followup-to
649 Insert a reasonable @samp{Mail-Followup-To:} header
650 (@pxref{Mailing Lists}) in a post to an
651 unsubscribed list.  When making original posts to a mailing list you are
652 not subscribed to, you have to type in a @samp{Mail-Followup-To:} header
653 by hand.  The contents, usually, are the addresses of the list and your
654 own address.  This function inserts such a header automatically.  It
655 fetches the contents of the @samp{To:} header in the current mail
656 buffer, and appends the current @code{user-mail-address}.
658 If the optional argument @code{include-cc} is non-@code{nil}, the
659 addresses in the @samp{Cc:} header are also put into the
660 @samp{Mail-Followup-To:} header.
662 @end table
664 @subsection  Commands to change headers
666 @table @kbd
668 @item C-c C-o
669 @kindex C-c C-o
670 @findex message-sort-headers
671 @vindex message-header-format-alist
672 Sort headers according to @code{message-header-format-alist}
673 (@code{message-sort-headers}).
675 @item C-c C-t
676 @kindex C-c C-t
677 @findex message-insert-to
678 Insert a @code{To} header that contains the @code{Reply-To} or
679 @code{From} header of the message you're following up
680 (@code{message-insert-to}).
682 @item C-c C-n
683 @kindex C-c C-n
684 @findex message-insert-newsgroups
685 Insert a @code{Newsgroups} header that reflects the @code{Followup-To}
686 or @code{Newsgroups} header of the article you're replying to
687 (@code{message-insert-newsgroups}).
689 @item C-c C-l
690 @kindex C-c C-l
691 @findex message-to-list-only
692 Send a message to the list only.  Remove all addresses but the list
693 address from @code{To:} and @code{Cc:} headers.
695 @item C-c M-n
696 @kindex C-c M-n
697 @findex message-insert-disposition-notification-to
698 Insert a request for a disposition
699 notification.  (@code{message-insert-disposition-notification-to}).
700 This means that if the recipient supports RFC 2298 she might send you a
701 notification that she received the message.
703 @item M-x message-insert-importance-high
704 @kindex M-x message-insert-importance-high
705 @findex message-insert-importance-high
706 @cindex Importance
707 Insert an @samp{Importance} header with a value of @samp{high},
708 deleting headers if necessary.
710 @item M-x message-insert-importance-low
711 @kindex M-x message-insert-importance-low
712 @findex message-insert-importance-low
713 @cindex Importance
714 Insert an @samp{Importance} header with a value of @samp{low}, deleting
715 headers if necessary.
717 @item C-c C-f s
718 @kindex C-c C-f s
719 @findex message-change-subject
720 @cindex Subject
721 Change the current @samp{Subject} header.  Ask for new @samp{Subject}
722 header and append @samp{(was: <Old Subject>)}.  The old subject can be
723 stripped on replying, see @code{message-subject-trailing-was-query}
724 (@pxref{Message Headers}).
726 @item C-c C-f x
727 @kindex C-c C-f x
728 @findex message-cross-post-followup-to
729 @vindex message-cross-post-default
730 @vindex message-cross-post-note-function
731 @cindex X-Post
732 @cindex cross-post
733 Set up the @samp{FollowUp-To} header with a target newsgroup for a
734 cross-post, add that target newsgroup to the @samp{Newsgroups} header if
735 it is not a member of @samp{Newsgroups}, and insert a note in the body.
736 If @code{message-cross-post-default} is @code{nil} or if this command is
737 called with a prefix-argument, only the @samp{FollowUp-To} header will
738 be set but the target newsgroup will not be added to the
739 @samp{Newsgroups} header.  The function to insert a note is controlled
740 by the @code{message-cross-post-note-function} variable.
742 @item C-c C-f t
743 @kindex C-c C-f t
744 @findex message-reduce-to-to-cc
745 Replace contents of @samp{To} header with contents of @samp{Cc} or
746 @samp{Bcc} header.  (Iff @samp{Cc} header is not present, @samp{Bcc}
747 header will be used instead.)
749 @item C-c C-f w
750 @kindex C-c C-f w
751 @findex message-insert-wide-reply
752 Insert @samp{To} and @samp{Cc} headers as if you were doing a wide
753 reply even if the message was not made for a wide reply first.
755 @item C-c C-f a
756 @kindex C-c C-f a
757 @findex message-add-archive-header
758 @vindex message-archive-header
759 @vindex message-archive-note
760 @cindex X-No-Archive
761 Insert @samp{X-No-Archive: Yes} in the header and a note in the body.
762 The header and the note can be customized using
763 @code{message-archive-header} and @code{message-archive-note}.  When
764 called with a prefix argument, ask for a text to insert.  If you don't
765 want the note in the body, set @code{message-archive-note} to
766 @code{nil}.
768 @end table
771 @node Movement
772 @section Movement
774 @table @kbd
775 @item C-c C-b
776 @kindex C-c C-b
777 @findex message-goto-body
778 Move to the beginning of the body of the message
779 (@code{message-goto-body}).
781 @item C-c C-i
782 @kindex C-c C-i
783 @findex message-goto-signature
784 Move to the signature of the message (@code{message-goto-signature}).
786 @item C-a
787 @kindex C-a
788 @findex message-beginning-of-line
789 @vindex message-beginning-of-line
790 If at beginning of header value, go to beginning of line, else go to
791 beginning of header value.  (The header value comes after the header
792 name and the colon.)  This behavior can be disabled by toggling
793 the variable @code{message-beginning-of-line}.
795 @end table
798 @node Insertion
799 @section Insertion
801 @table @kbd
803 @item C-c C-y
804 @kindex C-c C-y
805 @findex message-yank-original
806 Yank the message that's being replied to into the message buffer
807 (@code{message-yank-original}).
809 @item C-c C-M-y
810 @kindex C-c C-M-y
811 @findex message-yank-buffer
812 Prompt for a buffer name and yank the contents of that buffer into the
813 message buffer (@code{message-yank-buffer}).
815 @item C-c C-q
816 @kindex C-c C-q
817 @findex message-fill-yanked-message
818 Fill the yanked message (@code{message-fill-yanked-message}).  Warning:
819 Can severely mess up the yanked text if its quoting conventions are
820 strange.  You'll quickly get a feel for when it's safe, though.  Anyway,
821 just remember that @kbd{C-x u} (@code{undo}) is available and you'll be
822 all right.
824 @item C-c C-w
825 @kindex C-c C-w
826 @findex message-insert-signature
827 Insert a signature at the end of the buffer
828 (@code{message-insert-signature}).
830 @item C-c M-h
831 @kindex C-c M-h
832 @findex message-insert-headers
833 Insert the message headers (@code{message-insert-headers}).
835 @item C-c M-m
836 @kindex C-c M-m
837 @findex message-mark-inserted-region
838 Mark some region in the current article with enclosing tags.  See
839 @code{message-mark-insert-begin} and @code{message-mark-insert-end}.
840 When called with a prefix argument, use slrn style verbatim marks
841 (@samp{#v+} and @samp{#v-}).
843 @item C-c M-f
844 @kindex C-c M-f
845 @findex message-mark-insert-file
846 Insert a file in the current article with enclosing tags.
847 See @code{message-mark-insert-begin} and @code{message-mark-insert-end}.
848 When called with a prefix argument, use slrn style verbatim marks
849 (@samp{#v+} and @samp{#v-}).
851 @end table
854 @node MIME
855 @section MIME
856 @cindex MML
857 @cindex MIME
858 @cindex multipart
859 @cindex attachment
861 Message is a @acronym{MIME}-compliant posting agent.  The user generally
862 doesn't have to do anything to make the @acronym{MIME} happen---Message will
863 automatically add the @code{Content-Type} and
864 @code{Content-Transfer-Encoding} headers.
866 @findex mml-attach-file
867 @kindex C-c C-a
868 The most typical thing users want to use the multipart things in
869 @acronym{MIME} for is to add ``attachments'' to mail they send out.
870 This can be done with the @kbd{C-c C-a} command (@kbd{M-x mml-attach-file}),
871 which will prompt for a file name and a @acronym{MIME} type.
873 @vindex mml-dnd-protocol-alist
874 @vindex mml-dnd-attach-options
875 If your Emacs supports drag and drop, you can also drop the file in the
876 Message buffer.  The variable @code{mml-dnd-protocol-alist} specifies
877 what kind of action is done when you drop a file into the Message
878 buffer.  The variable @code{mml-dnd-attach-options} controls which
879 @acronym{MIME} options you want to specify when dropping a file.  If it
880 is a list, valid members are @code{type}, @code{description} and
881 @code{disposition}.  @code{disposition} implies @code{type}.  If it is
882 @code{nil}, don't ask for options.  If it is @code{t}, ask the user
883 whether or not to specify options.
885 You can also create arbitrarily complex multiparts using the @acronym{MML}
886 language (@pxref{Composing, , Composing, emacs-mime, The Emacs MIME
887 Manual}).
889 @node IDNA
890 @section IDNA
891 @cindex IDNA
892 @cindex internationalized domain names
893 @cindex non-ascii domain names
895 @acronym{IDNA} is a standard way to encode non-@acronym{ASCII} domain
896 names into a readable @acronym{ASCII} string.  The details can be
897 found in RFC 3490.
899 Message is a @acronym{IDNA}-compliant posting agent.  The user
900 generally doesn't have to do anything to make the @acronym{IDNA}
901 happen---Message will encode non-@acronym{ASCII} domain names in @code{From},
902 @code{To}, and @code{Cc} headers automatically.
904 Until @acronym{IDNA} becomes more well known, Message queries you
905 whether @acronym{IDNA} encoding of the domain name really should
906 occur.  Some users might not be aware that domain names can contain
907 non-@acronym{ASCII} now, so this gives them a safety net if they accidentally
908 typed a non-@acronym{ASCII} domain name.
910 @vindex message-use-idna
911 The @code{message-use-idna} variable control whether @acronym{IDNA} is
912 used.  If the variable is @code{nil} no @acronym{IDNA} encoding will
913 ever happen, if it is set to the symbol @code{ask} the user will be
914 queried, and if set to @code{t} (which is the default if @acronym{IDNA}
915 is fully available) @acronym{IDNA} encoding happens automatically.
917 @findex message-idna-to-ascii-rhs
918 If you want to experiment with the @acronym{IDNA} encoding, you can
919 invoke @kbd{M-x message-idna-to-ascii-rhs RET} in the message buffer
920 to have the non-@acronym{ASCII} domain names encoded while you edit
921 the message.
923 Note that you must have @uref{http://www.gnu.org/software/libidn/, GNU
924 Libidn} installed in order to use this functionality.
926 @node Security
927 @section Security
928 @cindex Security
929 @cindex S/MIME
930 @cindex PGP
931 @cindex PGP/MIME
932 @cindex sign
933 @cindex encrypt
934 @cindex secure
936 Using the @acronym{MML} language, Message is able to create digitally
937 signed and digitally encrypted messages.  Message (or rather
938 @acronym{MML}) currently support @acronym{PGP} (RFC 1991),
939 @acronym{PGP/MIME} (RFC 2015/3156) and @acronym{S/MIME}.
941 @menu
942 * Signing and encryption::      Signing and encrypting commands.
943 * Using S/MIME::                Using S/MIME
944 * Using PGP/MIME::              Using PGP/MIME
945 * PGP Compatibility::           Compatibility with older implementations
946 @end menu
948 @node Signing and encryption
949 @subsection Signing and encrypting commands
951 Instructing @acronym{MML} to perform security operations on a
952 @acronym{MIME} part is done using the @kbd{C-c C-m s} key map for
953 signing and the @kbd{C-c C-m c} key map for encryption, as follows.
954 @table @kbd
956 @item C-c C-m s s
957 @kindex C-c C-m s s
958 @findex mml-secure-message-sign-smime
960 Digitally sign current message using @acronym{S/MIME}.
962 @item C-c C-m s o
963 @kindex C-c C-m s o
964 @findex mml-secure-message-sign-pgp
966 Digitally sign current message using @acronym{PGP}.
968 @item C-c C-m s p
969 @kindex C-c C-m s p
970 @findex mml-secure-message-sign-pgpmime
972 Digitally sign current message using @acronym{PGP/MIME}.
974 @item C-c C-m c s
975 @kindex C-c C-m c s
976 @findex mml-secure-message-encrypt-smime
978 Digitally encrypt current message using @acronym{S/MIME}.
980 @item C-c C-m c o
981 @kindex C-c C-m c o
982 @findex mml-secure-message-encrypt-pgp
984 Digitally encrypt current message using @acronym{PGP}.
986 @item C-c C-m c p
987 @kindex C-c C-m c p
988 @findex mml-secure-message-encrypt-pgpmime
990 Digitally encrypt current message using @acronym{PGP/MIME}.
992 @item C-c C-m C-n
993 @kindex C-c C-m C-n
994 @findex mml-unsecure-message
995 Remove security related @acronym{MML} tags from message.
997 @end table
999 These commands do not immediately sign or encrypt the message, they
1000 merely insert the proper @acronym{MML} secure tag to instruct the
1001 @acronym{MML} engine to perform that operation when the message is
1002 actually sent.  They may perform other operations too, such as locating
1003 and retrieving a @acronym{S/MIME} certificate of the person you wish to
1004 send encrypted mail to.  When the mml parsing engine converts your
1005 @acronym{MML} into a properly encoded @acronym{MIME} message, the secure
1006 tag will be replaced with either a part or a multipart tag.  If your
1007 message contains other mml parts, a multipart tag will be used; if no
1008 other parts are present in your message a single part tag will be used.
1009 This way, message mode will do the Right Thing (TM) with
1010 signed/encrypted multipart messages.
1012 Since signing and especially encryption often is used when sensitive
1013 information is sent, you may want to have some way to ensure that your
1014 mail is actually signed or encrypted.  After invoking the above
1015 sign/encrypt commands, it is possible to preview the raw article by
1016 using @kbd{C-u C-c RET P} (@code{mml-preview}).  Then you can
1017 verify that your long rant about what your ex-significant other or
1018 whomever actually did with that funny looking person at that strange
1019 party the other night, actually will be sent encrypted.
1021 @emph{Note!}  Neither @acronym{PGP/MIME} nor @acronym{S/MIME} encrypt/signs
1022 RFC822 headers.  They only operate on the @acronym{MIME} object.  Keep this
1023 in mind before sending mail with a sensitive Subject line.
1025 By default, when encrypting a message, Gnus will use the
1026 ``signencrypt'' mode, which means the message is both signed and
1027 encrypted.  If you would like to disable this for a particular
1028 message, give the @code{mml-secure-message-encrypt-*} command a prefix
1029 argument, e.g., @kbd{C-u C-c C-m c p}.
1031 Actually using the security commands above is not very difficult.  At
1032 least not compared with making sure all involved programs talk with each
1033 other properly.  Thus, we now describe what external libraries or
1034 programs are required to make things work, and some small general hints.
1036 @node Using S/MIME
1037 @subsection Using S/MIME
1039 @emph{Note!}  This section assume you have a basic familiarity with
1040 modern cryptography, @acronym{S/MIME}, various PKCS standards, OpenSSL and
1041 so on.
1043 The @acronym{S/MIME} support in Message (and @acronym{MML}) require
1044 OpenSSL.  OpenSSL performs the actual @acronym{S/MIME} sign/encrypt
1045 operations.  OpenSSL can be found at @uref{http://www.openssl.org/}.
1046 OpenSSL 0.9.6 and later should work.  Version 0.9.5a cannot extract mail
1047 addresses from certificates, and it insert a spurious CR character into
1048 @acronym{MIME} separators so you may wish to avoid it if you would like
1049 to avoid being regarded as someone who send strange mail.  (Although by
1050 sending @acronym{S/MIME} messages you've probably already lost that
1051 contest.)
1053 To be able to send encrypted mail, a personal certificate is not
1054 required.  Message (@acronym{MML}) need a certificate for the person to whom you
1055 wish to communicate with though.  You're asked for this when you type
1056 @kbd{C-c C-m c s}.  Currently there are two ways to retrieve this
1057 certificate, from a local file or from DNS.  If you chose a local
1058 file, it need to contain a X.509 certificate in @acronym{PEM} format.
1059 If you chose DNS, you're asked for the domain name where the
1060 certificate is stored, the default is a good guess.  To my belief,
1061 Message (@acronym{MML}) is the first mail agent in the world to support
1062 retrieving @acronym{S/MIME} certificates from DNS, so you're not
1063 likely to find very many certificates out there.  At least there
1064 should be one, stored at the domain @code{simon.josefsson.org}.  LDAP
1065 is a more popular method of distributing certificates, support for it
1066 is planned.  (Meanwhile, you can use @code{ldapsearch} from the
1067 command line to retrieve a certificate into a file and use it.)
1069 As for signing messages, OpenSSL can't perform signing operations
1070 without some kind of configuration.  Especially, you need to tell it
1071 where your private key and your certificate is stored.  @acronym{MML}
1072 uses an Emacs interface to OpenSSL, aptly named @code{smime.el}, and it
1073 contain a @code{custom} group used for this configuration.  So, try
1074 @kbd{M-x customize-group RET smime RET} and look around.
1076 Currently there is no support for talking to a CA (or RA) to create
1077 your own certificate.  None is planned either.  You need to do this
1078 manually with OpenSSL or using some other program.  I used Netscape
1079 and got a free @acronym{S/MIME} certificate from one of the big CA's on the
1080 net.  Netscape is able to export your private key and certificate in
1081 PKCS #12 format.  Use OpenSSL to convert this into a plain X.509
1082 certificate in PEM format as follows.
1084 @example
1085 $ openssl pkcs12 -in ns.p12 -clcerts -nodes > key+cert.pem
1086 @end example
1088 The @file{key+cert.pem} file should be pointed to from the
1089 @code{smime-keys} variable.  You should now be able to send signed mail.
1091 @emph{Note!}  Your private key is now stored unencrypted in the file,
1092 so take care in handling it.  Storing encrypted keys on the disk are
1093 supported, and Gnus will ask you for a passphrase before invoking
1094 OpenSSL.  Read the OpenSSL documentation for how to achieve this.  If
1095 you use unencrypted keys (e.g., if they are on a secure storage, or if
1096 you are on a secure single user machine) simply press @code{RET} at
1097 the passphrase prompt.
1099 @node Using PGP/MIME
1100 @subsection Using PGP/MIME
1102 @acronym{PGP/MIME} requires an external OpenPGP implementation, such
1103 as @uref{http://www.gnupg.org/, GNU Privacy Guard}. Pre-OpenPGP
1104 implementations such as PGP 2.x and PGP 5.x are also supported.  The
1105 default Emacs interface to the PGP implementation is EasyPG
1106 (@pxref{Top,,EasyPG Assistant User's Manual, epa, EasyPG Assistant
1107 User's Manual}), but PGG (@pxref{Top, ,PGG, pgg, PGG Manual}) and
1108 Mailcrypt are also supported.  @xref{PGP Compatibility}.
1110 @cindex gpg-agent
1111 Message internally calls GnuPG (the @command{gpg} command) to perform
1112 data encryption, and in certain cases (decrypting or signing for
1113 example), @command{gpg} requires user's passphrase.  Currently the
1114 recommended way to supply your passphrase to @command{gpg} is to use the
1115 @command{gpg-agent} program.
1117 To use @command{gpg-agent} in Emacs, you need to run the following
1118 command from the shell before starting Emacs.
1120 @example
1121 eval `gpg-agent --daemon`
1122 @end example
1124 This will invoke @command{gpg-agent} and set the environment variable
1125 @code{GPG_AGENT_INFO} to allow @command{gpg} to communicate with it.
1126 It might be good idea to put this command in your @file{.xsession} or
1127 @file{.bash_profile}.  @xref{Invoking GPG-AGENT, , , gnupg, Using the
1128 GNU Privacy Guard}.
1130 Once your @command{gpg-agent} is set up, it will ask you for a
1131 passphrase as needed for @command{gpg}.  Under the X Window System,
1132 you will see a new passphrase input dialog appear.  The dialog is
1133 provided by PIN Entry (the @command{pinentry} command), and as of
1134 version 0.7.2, @command{pinentry} cannot cooperate with Emacs on a
1135 single tty.  So, if you are using a text console, you may need to put
1136 a passphrase into gpg-agent's cache beforehand.  The following command
1137 does the trick.
1139 @example
1140 gpg --use-agent --sign < /dev/null > /dev/null
1141 @end example
1143 @node PGP Compatibility
1144 @subsection Compatibility with older implementations
1146 @vindex gpg-temp-directory
1147 Note, if you are using the @code{gpg.el} you must make sure that the
1148 directory specified by @code{gpg-temp-directory} have permissions
1149 0700.
1151 Creating your own key is described in detail in the documentation of
1152 your PGP implementation, so we refer to it.
1154 If you have imported your old PGP 2.x key into GnuPG, and want to send
1155 signed and encrypted messages to your fellow PGP 2.x users, you'll
1156 discover that the receiver cannot understand what you send. One
1157 solution is to use PGP 2.x instead (e.g.@: if you use @code{pgg}, set
1158 @code{pgg-default-scheme} to @code{pgp}). You could also convince your
1159 fellow PGP 2.x users to convert to GnuPG.
1160 @vindex mml-signencrypt-style-alist
1161 As a final workaround, you can make the sign and encryption work in
1162 two steps; separately sign, then encrypt a message.  If you would like
1163 to change this behavior you can customize the
1164 @code{mml-signencrypt-style-alist} variable.  For example:
1166 @lisp
1167 (setq mml-signencrypt-style-alist '(("smime" separate)
1168                                     ("pgp" separate)
1169                                     ("pgpauto" separate)
1170                                     ("pgpmime" separate)))
1171 @end lisp
1173 This causes to sign and encrypt in two passes, thus generating a
1174 message that can be understood by PGP version 2.
1176 (Refer to @uref{http://www.gnupg.org/gph/en/pgp2x.html} for more
1177 information about the problem.)
1179 @node Various Commands
1180 @section Various Commands
1182 @table @kbd
1184 @item C-c C-r
1185 @kindex C-c C-r
1186 @findex message-caesar-buffer-body
1187 Caesar rotate (aka. rot13) the current message
1188 (@code{message-caesar-buffer-body}).  If narrowing is in effect, just
1189 rotate the visible portion of the buffer.  A numerical prefix says how
1190 many places to rotate the text.  The default is 13.
1192 @item C-c C-e
1193 @kindex C-c C-e
1194 @findex message-elide-region
1195 @vindex message-elide-ellipsis
1196 Elide the text between point and mark (@code{message-elide-region}).
1197 The text is killed and replaced with the contents of the variable
1198 @code{message-elide-ellipsis}.  The default value is to use an ellipsis
1199 (@samp{[...]}).
1201 This is a format-spec string, and you can use @samp{%l} to say how
1202 many lines were removed, and @samp{%c} to say how many characters were
1203 removed.
1205 @item C-c M-k
1206 @kindex C-c M-k
1207 @findex message-kill-address
1208 Kill the address under point.
1210 @item C-c C-z
1211 @kindex C-c C-z
1212 @findex message-kill-to-signature
1213 Kill all the text up to the signature, or if that's missing, up to the
1214 end of the message (@code{message-kill-to-signature}).
1216 @item C-c C-v
1217 @kindex C-c C-v
1218 @findex message-delete-not-region
1219 Delete all text in the body of the message that is outside the region
1220 (@code{message-delete-not-region}).
1222 @item M-RET
1223 @kindex M-RET
1224 @findex message-newline-and-reformat
1225 Insert four newlines, and then reformat if inside quoted text.
1227 Here's an example:
1229 @example
1230 > This is some quoted text.  And here's more quoted text.
1231 @end example
1233 If point is before @samp{And} and you press @kbd{M-RET}, you'll get:
1235 @example
1236 > This is some quoted text.
1240 > And here's more quoted text.
1241 @end example
1243 @samp{*} says where point will be placed.
1245 @item C-c M-r
1246 @kindex C-c M-r
1247 @findex message-rename-buffer
1248 Rename the buffer (@code{message-rename-buffer}).  If given a prefix,
1249 prompt for a new buffer name.
1251 @item TAB
1252 @kindex TAB
1253 @findex message-tab
1254 @vindex message-tab-body-function
1255 If @code{message-tab-body-function} is non-@code{nil}, execute the
1256 function it specifies.  Otherwise use the function bound to @kbd{TAB} in
1257 @code{text-mode-map} or @code{global-map}.
1259 @end table
1262 @node Sending
1263 @section Sending
1265 @table @kbd
1266 @item C-c C-c
1267 @kindex C-c C-c
1268 @findex message-send-and-exit
1269 Send the message and bury the current buffer
1270 (@code{message-send-and-exit}).
1272 @item C-c C-s
1273 @kindex C-c C-s
1274 @findex message-send
1275 Send the message (@code{message-send}).
1277 @item C-c C-d
1278 @kindex C-c C-d
1279 @findex message-dont-send
1280 Bury the message buffer and exit (@code{message-dont-send}).
1282 @item C-c C-k
1283 @kindex C-c C-k
1284 @findex message-kill-buffer
1285 Kill the message buffer and exit (@code{message-kill-buffer}).
1287 @end table
1291 @node Mail Aliases
1292 @section Mail Aliases
1293 @cindex mail aliases
1294 @cindex aliases
1295 @cindex completion
1296 @cindex ecomplete
1298 @vindex message-mail-alias-type
1299 The @code{message-mail-alias-type} variable controls what type of mail
1300 alias expansion to use.  Currently two forms are supported:
1301 @code{mailabbrev} and @code{ecomplete}.  If this variable is
1302 @code{nil}, no mail alias expansion will be performed.
1304 @code{mailabbrev} works by parsing the @file{/etc/mailrc} and
1305 @file{~/.mailrc} files.  These files look like:
1307 @example
1308 alias lmi "Lars Magne Ingebrigtsen <larsi@@ifi.uio.no>"
1309 alias ding "ding@@ifi.uio.no (ding mailing list)"
1310 @end example
1312 After adding lines like this to your @file{~/.mailrc} file, you should
1313 be able to just write @samp{lmi} in the @code{To} or @code{Cc} (and so
1314 on) headers and press @kbd{SPC} to expand the alias.
1316 No expansion will be performed upon sending of the message---all
1317 expansions have to be done explicitly.
1319 If you're using @code{ecomplete}, all addresses from @code{To} and
1320 @code{Cc} headers will automatically be put into the
1321 @file{~/.ecompleterc} file.  When you enter text in the @code{To} and
1322 @code{Cc} headers, @code{ecomplete} will check out the values stored
1323 there and ``electrically'' say what completions are possible.  To
1324 choose one of these completions, use the @kbd{M-n} command to move
1325 down to the list.  Use @kbd{M-n} and @kbd{M-p} to move down and up the
1326 list, and @kbd{RET} to choose a completion.
1328 @node Spelling
1329 @section Spelling
1330 @cindex spelling
1331 @findex ispell-message
1333 There are two popular ways to have Emacs spell-check your messages:
1334 @code{ispell} and @code{flyspell}.  @code{ispell} is the older and
1335 probably more popular package.  You typically first write the message,
1336 and then run the entire thing through @code{ispell} and fix all the
1337 typos.  To have this happen automatically when you send a message, put
1338 something like the following in your @file{.emacs} file:
1340 @lisp
1341 (add-hook 'message-send-hook 'ispell-message)
1342 @end lisp
1344 @vindex ispell-message-dictionary-alist
1345 If you're in the habit of writing in different languages, this can be
1346 controlled by the @code{ispell-message-dictionary-alist} variable:
1348 @lisp
1349 (setq ispell-message-dictionary-alist
1350       '(("^Newsgroups:.*\\bde\\." . "deutsch8")
1351         (".*" . "default")))
1352 @end lisp
1354 @code{ispell} depends on having the external @samp{ispell} command
1355 installed.
1357 The other popular method is using @code{flyspell}.  This package checks
1358 your spelling while you're writing, and marks any mis-spelled words in
1359 various ways.
1361 To use @code{flyspell}, put something like the following in your
1362 @file{.emacs} file:
1364 @lisp
1365 (defun my-message-setup-routine ()
1366   (flyspell-mode 1))
1367 (add-hook 'message-setup-hook 'my-message-setup-routine)
1368 @end lisp
1370 @code{flyspell} depends on having the external @samp{ispell} command
1371 installed.
1374 @node Variables
1375 @chapter Variables
1377 @menu
1378 * Message Headers::             General message header stuff.
1379 * Mail Headers::                Customizing mail headers.
1380 * Mail Variables::              Other mail variables.
1381 * News Headers::                Customizing news headers.
1382 * News Variables::              Other news variables.
1383 * Insertion Variables::         Customizing how things are inserted.
1384 * Various Message Variables::   Other message variables.
1385 * Sending Variables::           Variables for sending.
1386 * Message Buffers::             How Message names its buffers.
1387 * Message Actions::             Actions to be performed when exiting.
1388 @end menu
1391 @node Message Headers
1392 @section Message Headers
1394 Message is quite aggressive on the message generation front.  It has to
1395 be---it's a combined news and mail agent.  To be able to send combined
1396 messages, it has to generate all headers itself (instead of letting the
1397 mail/news system do it) to ensure that mail and news copies of messages
1398 look sufficiently similar.
1400 @table @code
1402 @item message-generate-headers-first
1403 @vindex message-generate-headers-first
1404 If @code{t}, generate all required headers before starting to
1405 compose the message.  This can also be a list of headers to generate:
1407 @lisp
1408 (setq message-generate-headers-first
1409       '(References))
1410 @end lisp
1412 @vindex message-required-headers
1413 The variables @code{message-required-headers},
1414 @code{message-required-mail-headers} and
1415 @code{message-required-news-headers} specify which headers are
1416 required.
1418 Note that some headers will be removed and re-generated before posting,
1419 because of the variable @code{message-deletable-headers} (see below).
1421 @item message-draft-headers
1422 @vindex message-draft-headers
1423 When running Message from Gnus, the message buffers are associated
1424 with a draft group.  @code{message-draft-headers} says which headers
1425 should be generated when a draft is written to the draft group.
1427 @item message-from-style
1428 @vindex message-from-style
1429 Specifies how @code{From} headers should look.  There are four valid
1430 values:
1432 @table @code
1433 @item nil
1434 Just the address---@samp{king@@grassland.com}.
1436 @item parens
1437 @samp{king@@grassland.com (Elvis Parsley)}.
1439 @item angles
1440 @samp{Elvis Parsley <king@@grassland.com>}.
1442 @item default
1443 Look like @code{angles} if that doesn't require quoting, and
1444 @code{parens} if it does.  If even @code{parens} requires quoting, use
1445 @code{angles} anyway.
1447 @end table
1449 @item message-deletable-headers
1450 @vindex message-deletable-headers
1451 Headers in this list that were previously generated by Message will be
1452 deleted before posting.  Let's say you post an article.  Then you decide
1453 to post it again to some other group, you naughty boy, so you jump back
1454 to the @code{*post-buf*} buffer, edit the @code{Newsgroups} line, and
1455 ship it off again.  By default, this variable makes sure that the old
1456 generated @code{Message-ID} is deleted, and a new one generated.  If
1457 this isn't done, the entire empire would probably crumble, anarchy would
1458 prevail, and cats would start walking on two legs and rule the world.
1459 Allegedly.
1461 @item message-default-headers
1462 @vindex message-default-headers
1463 Header lines to be inserted in outgoing messages before you edit the
1464 message, so you can edit or delete their lines. If set to a string, it
1465 is directly inserted. If set to a function, it is called and its
1466 result is inserted.
1468 @item message-subject-re-regexp
1469 @vindex message-subject-re-regexp
1470 @cindex Aw
1471 @cindex Sv
1472 @cindex Re
1473 Responses to messages have subjects that start with @samp{Re: }.  This
1474 is @emph{not} an abbreviation of the English word ``response'', but is
1475 Latin, and means ``in response to''.  Some illiterate nincompoops have
1476 failed to grasp this fact, and have ``internationalized'' their software
1477 to use abominations like @samp{Aw: } (``antwort'') or @samp{Sv: }
1478 (``svar'') instead, which is meaningless and evil.  However, you may
1479 have to deal with users that use these evil tools, in which case you may
1480 set this variable to a regexp that matches these prefixes.  Myself, I
1481 just throw away non-compliant mail.
1483 Here's an example of a value to deal with these headers when
1484 responding to a message:
1486 @lisp
1487 (setq message-subject-re-regexp
1488       (concat
1489        "^[ \t]*"
1490          "\\("
1491            "\\("
1492              "[Aa][Nn][Tt][Ww]\\.?\\|"     ; antw
1493              "[Aa][Ww]\\|"                 ; aw
1494              "[Ff][Ww][Dd]?\\|"            ; fwd
1495              "[Oo][Dd][Pp]\\|"             ; odp
1496              "[Rr][Ee]\\|"                 ; re
1497              "[Rr][\311\351][Ff]\\.?\\|"   ; ref
1498              "[Ss][Vv]"                    ; sv
1499            "\\)"
1500            "\\(\\[[0-9]*\\]\\)"
1501            "*:[ \t]*"
1502          "\\)"
1503        "*[ \t]*"
1504        ))
1505 @end lisp
1507 @item message-subject-trailing-was-query
1508 @vindex message-subject-trailing-was-query
1509 @vindex message-subject-trailing-was-ask-regexp
1510 @vindex message-subject-trailing-was-regexp
1511 Controls what to do with trailing @samp{(was: <old subject>)} in subject
1512 lines.  If @code{nil}, leave the subject unchanged.  If it is the symbol
1513 @code{ask}, query the user what to do.  In this case, the subject is
1514 matched against @code{message-subject-trailing-was-ask-regexp}.  If
1515 @code{message-subject-trailing-was-query} is @code{t}, always strip the
1516 trailing old subject.  In this case,
1517 @code{message-subject-trailing-was-regexp} is used.
1519 @item message-alternative-emails
1520 @vindex message-alternative-emails
1521 Regexp matching alternative email addresses.  The first address in the
1522 To, Cc or From headers of the original article matching this variable is
1523 used as the From field of outgoing messages, replacing the default From
1524 value.
1526 For example, if you have two secondary email addresses john@@home.net
1527 and john.doe@@work.com and want to use them in the From field when
1528 composing a reply to a message addressed to one of them, you could set
1529 this variable like this:
1531 @lisp
1532 (setq message-alternative-emails
1533       (regexp-opt '("john@@home.net" "john.doe@@work.com")))
1534 @end lisp
1536 This variable has precedence over posting styles and anything that runs
1537 off @code{message-setup-hook}.
1539 @item message-allow-no-recipients
1540 @vindex message-allow-no-recipients
1541 Specifies what to do when there are no recipients other than
1542 @code{Gcc} or @code{Fcc}.  If it is @code{always}, the posting is
1543 allowed.  If it is @code{never}, the posting is not allowed.  If it is
1544 @code{ask} (the default), you are prompted.
1546 @item message-hidden-headers
1547 @vindex message-hidden-headers
1548 A regexp, a list of regexps, or a list where the first element is
1549 @code{not} and the rest are regexps.  It says which headers to keep
1550 hidden when composing a message.
1552 @lisp
1553 (setq message-hidden-headers
1554       '(not "From" "Subject" "To" "Cc" "Newsgroups"))
1555 @end lisp
1557 Headers are hidden using narrowing, you can use @kbd{M-x widen} to
1558 expose them in the buffer.
1560 @item message-header-synonyms
1561 @vindex message-header-synonyms
1562 A list of lists of header synonyms.  E.g., if this list contains a
1563 member list with elements @code{Cc} and @code{To}, then
1564 @code{message-carefully-insert-headers} will not insert a @code{To}
1565 header when the message is already @code{Cc}ed to the recipient.
1567 @end table
1570 @node Mail Headers
1571 @section Mail Headers
1573 @table @code
1574 @item message-required-mail-headers
1575 @vindex message-required-mail-headers
1576 @xref{News Headers}, for the syntax of this variable.  It is
1577 @code{(From Subject Date (optional . In-Reply-To) Message-ID
1578 (optional . User-Agent))} by default.
1580 @item message-ignored-mail-headers
1581 @vindex message-ignored-mail-headers
1582 Regexp of headers to be removed before mailing.  The default is@*
1583 @samp{^[GF]cc:\\|^Resent-Fcc:\\|^Xref:\\|^X-Draft-From:\\|@*
1584 ^X-Gnus-Agent-Meta-Information:}.
1586 @item message-default-mail-headers
1587 @vindex message-default-mail-headers
1588 This string is inserted at the end of the headers in all message
1589 buffers that are initialized as mail.
1591 @item message-generate-hashcash
1592 @vindex message-generate-hashcash
1593 Variable that indicates whether @samp{X-Hashcash} headers
1594 should be computed for the message.  @xref{Hashcash, ,Hashcash,gnus,
1595 The Gnus Manual}.  If @code{opportunistic}, only generate the headers
1596 when it doesn't lead to the user having to wait.
1598 @end table
1601 @node Mail Variables
1602 @section Mail Variables
1604 @table @code
1605 @item message-send-mail-function
1606 @vindex message-send-mail-function
1607 @findex message-send-mail-function
1608 @findex message-send-mail-with-sendmail
1609 @findex message-send-mail-with-mh
1610 @findex message-send-mail-with-qmail
1611 @findex message-smtpmail-send-it
1612 @findex smtpmail-send-it
1613 @findex feedmail-send-it
1614 @findex message-send-mail-with-mailclient
1615 Function used to send the current buffer as mail.  The default is
1616 @code{message-send-mail-with-sendmail}, or @code{smtpmail-send-it}
1617 according to the system.  Other valid values include
1618 @code{message-send-mail-with-mailclient},
1619 @code{message-send-mail-with-mh}, @code{message-send-mail-with-qmail},
1620 @code{message-smtpmail-send-it} and @code{feedmail-send-it}.
1622 The function
1623 @code{message-send-mail-with-sendmail} pipes your article to the
1624 @code{sendmail} binary for further queuing and sending.  When your local
1625 system is not configured for sending mail using @code{sendmail}, and you
1626 have access to a remote @acronym{SMTP} server, you can set
1627 @code{message-send-mail-function} to @code{smtpmail-send-it} and make
1628 sure to setup the @code{smtpmail} package correctly.  An example:
1630 @lisp
1631 (setq message-send-mail-function 'smtpmail-send-it
1632       smtpmail-default-smtp-server "YOUR SMTP HOST")
1633 @end lisp
1635 To the thing similar to this, there is
1636 @code{message-smtpmail-send-it}.  It is useful if your @acronym{ISP}
1637 requires the @acronym{POP}-before-@acronym{SMTP} authentication.
1638 @xref{POP before SMTP, , POP before SMTP, gnus, The Gnus Manual}.
1640 @item message-mh-deletable-headers
1641 @vindex message-mh-deletable-headers
1642 Most versions of MH doesn't like being fed messages that contain the
1643 headers in this variable.  If this variable is non-@code{nil} (which is
1644 the default), these headers will be removed before mailing when sending
1645 messages via MH.  Set it to @code{nil} if your MH can handle these
1646 headers.
1648 @item message-qmail-inject-program
1649 @vindex message-qmail-inject-program
1650 @cindex qmail
1651 Location of the qmail-inject program.
1653 @item message-qmail-inject-args
1654 @vindex message-qmail-inject-args
1655 Arguments passed to qmail-inject programs.
1656 This should be a list of strings, one string for each argument.  It
1657 may also be a function.
1659 For e.g., if you wish to set the envelope sender address so that bounces
1660 go to the right place or to deal with listserv's usage of that address, you
1661 might set this variable to @code{'("-f" "you@@some.where")}.
1663 @item message-sendmail-f-is-evil
1664 @vindex message-sendmail-f-is-evil
1665 @cindex sendmail
1666 Non-@code{nil} means don't add @samp{-f username} to the sendmail
1667 command line.  Doing so would be even more evil than leaving it out.
1669 @item message-sendmail-envelope-from
1670 @vindex message-sendmail-envelope-from
1671 When @code{message-sendmail-f-is-evil} is @code{nil}, this specifies
1672 the address to use in the @acronym{SMTP} envelope.  If it is
1673 @code{nil}, use @code{user-mail-address}.  If it is the symbol
1674 @code{header}, use the @samp{From} header of the message.
1676 @item message-mailer-swallows-blank-line
1677 @vindex message-mailer-swallows-blank-line
1678 Set this to non-@code{nil} if the system's mailer runs the header and
1679 body together.  (This problem exists on SunOS 4 when sendmail is run
1680 in remote mode.)  The value should be an expression to test whether
1681 the problem will actually occur.
1683 @item message-send-mail-partially-limit
1684 @vindex message-send-mail-partially-limit
1685 @cindex split large message
1686 The limitation of messages sent as message/partial.  The lower bound
1687 of message size in characters, beyond which the message should be sent
1688 in several parts.  If it is @code{nil} (which is the default), the
1689 size is unlimited.
1691 @end table
1694 @node News Headers
1695 @section News Headers
1697 @vindex message-required-news-headers
1698 @code{message-required-news-headers} a list of header symbols.  These
1699 headers will either be automatically generated, or, if that's
1700 impossible, they will be prompted for.  The following symbols are valid:
1702 @table @code
1704 @item From
1705 @cindex From
1706 @findex user-full-name
1707 @findex user-mail-address
1708 This required header will be filled out with the result of the
1709 @code{message-make-from} function, which depends on the
1710 @code{message-from-style}, @code{user-full-name},
1711 @code{user-mail-address} variables.
1713 @item Subject
1714 @cindex Subject
1715 This required header will be prompted for if not present already.
1717 @item Newsgroups
1718 @cindex Newsgroups
1719 This required header says which newsgroups the article is to be posted
1720 to.  If it isn't present already, it will be prompted for.
1722 @item Organization
1723 @cindex organization
1724 @vindex message-user-organization
1725 @vindex message-user-organization-file
1726 This optional header will be filled out depending on the
1727 @code{message-user-organization} variable.
1728 @code{message-user-organization-file} will be used if this variable is
1729 @code{t}.  This variable can also be a string (in which case this string
1730 will be used), or it can be a function (which will be called with no
1731 parameters and should return a string to be used).
1733 @item Lines
1734 @cindex Lines
1735 This optional header will be computed by Message.
1737 @item Message-ID
1738 @cindex Message-ID
1739 @vindex message-user-fqdn
1740 @vindex mail-host-address
1741 @vindex user-mail-address
1742 @findex system-name
1743 @cindex Sun
1744 @cindex i-did-not-set--mail-host-address--so-tickle-me
1745 This required header will be generated by Message.  A unique ID will be
1746 created based on the date, time, user name (for the local part) and the
1747 domain part.  For the domain part, message will look (in this order) at
1748 @code{message-user-fqdn}, @code{system-name}, @code{mail-host-address}
1749 and @code{message-user-mail-address} (i.e. @code{user-mail-address})
1750 until a probably valid fully qualified domain name (FQDN) was found.
1752 @item User-Agent
1753 @cindex User-Agent
1754 This optional header will be filled out according to the
1755 @code{message-newsreader} local variable.
1757 @item In-Reply-To
1758 This optional header is filled out using the @code{Date} and @code{From}
1759 header of the article being replied to.
1761 @item Expires
1762 @cindex Expires
1763 @vindex message-expires
1764 This extremely optional header will be inserted according to the
1765 @code{message-expires} variable.  It is highly deprecated and shouldn't
1766 be used unless you know what you're doing.
1768 @item Distribution
1769 @cindex Distribution
1770 @vindex message-distribution-function
1771 This optional header is filled out according to the
1772 @code{message-distribution-function} variable.  It is a deprecated and
1773 much misunderstood header.
1775 @item Path
1776 @cindex path
1777 @vindex message-user-path
1778 This extremely optional header should probably never be used.
1779 However, some @emph{very} old servers require that this header is
1780 present.  @code{message-user-path} further controls how this
1781 @code{Path} header is to look.  If it is @code{nil}, use the server name
1782 as the leaf node.  If it is a string, use the string.  If it is neither
1783 a string nor @code{nil}, use the user name only.  However, it is highly
1784 unlikely that you should need to fiddle with this variable at all.
1785 @end table
1787 @findex yow
1788 @cindex Mime-Version
1789 In addition, you can enter conses into this list.  The @sc{car} of this cons
1790 should be a symbol.  This symbol's name is the name of the header, and
1791 the @sc{cdr} can either be a string to be entered verbatim as the value of
1792 this header, or it can be a function to be called.  This function should
1793 return a string to be inserted.  For instance, if you want to insert
1794 @code{Mime-Version: 1.0}, you should enter @code{(Mime-Version . "1.0")}
1795 into the list.  If you want to insert a funny quote, you could enter
1796 something like @code{(X-Yow . yow)} into the list.  The function
1797 @code{yow} will then be called without any arguments.
1799 If the list contains a cons where the @sc{car} of the cons is
1800 @code{optional}, the @sc{cdr} of this cons will only be inserted if it is
1801 non-@code{nil}.
1803 If you want to delete an entry from this list, the following Lisp
1804 snippet might be useful.  Adjust accordingly if you want to remove
1805 another element.
1807 @lisp
1808 (setq message-required-news-headers
1809       (delq 'Message-ID message-required-news-headers))
1810 @end lisp
1812 Other variables for customizing outgoing news articles:
1814 @table @code
1816 @item message-syntax-checks
1817 @vindex message-syntax-checks
1818 Controls what syntax checks should not be performed on outgoing posts.
1819 To disable checking of long signatures, for instance, add
1821 @lisp
1822 (signature . disabled)
1823 @end lisp
1825 to this list.
1827 Valid checks are:
1829 @table @code
1830 @item approved
1831 @cindex approved
1832 Check whether the article has an @code{Approved} header, which is
1833 something only moderators should include.
1834 @item continuation-headers
1835 Check whether there are continuation header lines that don't begin with
1836 whitespace.
1837 @item control-chars
1838 Check for invalid characters.
1839 @item empty
1840 Check whether the article is empty.
1841 @item existing-newsgroups
1842 Check whether the newsgroups mentioned in the @code{Newsgroups} and
1843 @code{Followup-To} headers exist.
1844 @item from
1845 Check whether the @code{From} header seems nice.
1846 @item illegible-text
1847 Check whether there is any non-printable character in the body.
1848 @item invisible-text
1849 Check whether there is any invisible text in the buffer.
1850 @item long-header-lines
1851 Check for too long header lines.
1852 @item long-lines
1853 @cindex long lines
1854 Check for too long lines in the body.
1855 @item message-id
1856 Check whether the @code{Message-ID} looks syntactically ok.
1857 @item multiple-headers
1858 Check for the existence of multiple equal headers.
1859 @item new-text
1860 Check whether there is any new text in the messages.
1861 @item newsgroups
1862 Check whether the @code{Newsgroups} header exists and is not empty.
1863 @item quoting-style
1864 Check whether text follows last quoted portion.
1865 @item repeated-newsgroups
1866 Check whether the @code{Newsgroups} and @code{Followup-to} headers
1867 contains repeated group names.
1868 @item reply-to
1869 Check whether the @code{Reply-To} header looks ok.
1870 @item sender
1871 @cindex Sender
1872 Insert a new @code{Sender} header if the @code{From} header looks odd.
1873 @item sendsys
1874 @cindex sendsys
1875 Check for the existence of version and sendsys commands.
1876 @item shoot
1877 Check whether the domain part of the @code{Message-ID} header looks ok.
1878 @item shorten-followup-to
1879 Check whether to add a @code{Followup-to} header to shorten the number
1880 of groups to post to.
1881 @item signature
1882 Check the length of the signature.
1883 @item size
1884 Check for excessive size.
1885 @item subject
1886 Check whether the @code{Subject} header exists and is not empty.
1887 @item subject-cmsg
1888 Check the subject for commands.
1889 @item valid-newsgroups
1890 Check whether the @code{Newsgroups} and @code{Followup-to} headers
1891 are valid syntactically.
1892 @end table
1894 All these conditions are checked by default, except for @code{sender}
1895 for which the check is disabled by default if
1896 @code{message-insert-canlock} is non-@code{nil} (@pxref{Canceling News}).
1898 @item message-ignored-news-headers
1899 @vindex message-ignored-news-headers
1900 Regexp of headers to be removed before posting.  The default is@*
1901 @samp{^NNTP-Posting-Host:\\|^Xref:\\|^[BGF]cc:\\|^Resent-Fcc:\\|@*
1902 ^X-Draft-From:\\|^X-Gnus-Agent-Meta-Information:}.
1904 @item message-default-news-headers
1905 @vindex message-default-news-headers
1906 This string is inserted at the end of the headers in all message
1907 buffers that are initialized as news.
1909 @end table
1912 @node News Variables
1913 @section News Variables
1915 @table @code
1916 @item message-send-news-function
1917 @vindex message-send-news-function
1918 Function used to send the current buffer as news.  The default is
1919 @code{message-send-news}.
1921 @item message-post-method
1922 @vindex message-post-method
1923 Gnusish @dfn{select method} (see the Gnus manual for details) used for
1924 posting a prepared news message.
1926 @end table
1929 @node Insertion Variables
1930 @section Insertion Variables
1932 @table @code
1933 @item message-cite-style
1934 @vindex message-cite-style
1935 The overall style to be used when replying to messages. This controls
1936 things like where the reply should be put relative to the original,
1937 how the citation is formatted, where the signature goes, etc.
1939 Value is either @code{nil} (no variable overrides) or a let-style list
1940 of pairs @code{(VARIABLE VALUE)} to override default values.
1942 See @code{gnus-posting-styles} to set this variable for specific
1943 groups. Presets to impersonate popular mail agents are available in the
1944 @code{message-cite-style-*} variables.
1946 @item message-cite-reply-position
1947 @vindex message-cite-reply-position
1948 Where the reply should be positioned. Available styles are
1949 @code{traditional} to reply inline, @code{above} for top-posting, and
1950 @code{below} for bottom-posting
1952 @item message-ignored-cited-headers
1953 @vindex message-ignored-cited-headers
1954 All headers that match this regexp will be removed from yanked
1955 messages.  The default is @samp{.}, which means that all headers will be
1956 removed.
1958 @item message-cite-prefix-regexp
1959 @vindex message-cite-prefix-regexp
1960 Regexp matching the longest possible citation prefix on a line.
1962 @item message-citation-line-function
1963 @vindex message-citation-line-function
1964 @cindex attribution line
1965 Function called to insert the citation line.  The default is
1966 @code{message-insert-citation-line}, which will lead to citation lines
1967 that look like:
1969 @example
1970 Hallvard B Furuseth <h.b.furuseth@@usit.uio.no> writes:
1971 @end example
1973 @c FIXME: Add `message-insert-formatted-citation-line' and
1974 @c `message-citation-line-format'
1976 Point will be at the beginning of the body of the message when this
1977 function is called.
1979 Note that Gnus provides a feature where clicking on `writes:' hides the
1980 cited text.  If you change the citation line too much, readers of your
1981 messages will have to adjust their Gnus, too.  See the variable
1982 @code{gnus-cite-attribution-suffix}.  @xref{Article Highlighting, ,
1983 Article Highlighting, gnus, The Gnus Manual}, for details.
1985 @item message-yank-prefix
1986 @vindex message-yank-prefix
1987 @cindex yanking
1988 @cindex quoting
1989 When you are replying to or following up an article, you normally want
1990 to quote the person you are answering.  Inserting quoted text is done by
1991 @dfn{yanking}, and each line you yank will have
1992 @code{message-yank-prefix} prepended to it (except for quoted lines
1993 which use @code{message-yank-cited-prefix} and empty lines which use
1994 @code{message-yank-empty-prefix}).  The default is @samp{> }.
1996 @item message-yank-cited-prefix
1997 @vindex message-yank-cited-prefix
1998 @cindex yanking
1999 @cindex cited
2000 @cindex quoting
2001 When yanking text from an article which contains already cited text,
2002 each line will be prefixed with the contents of this variable.  The
2003 default is @samp{>}.  See also @code{message-yank-prefix}.
2005 @item message-yank-empty-prefix
2006 @vindex message-yank-empty-prefix
2007 @cindex yanking
2008 @cindex quoting
2009 When yanking text from an article, each empty line will be prefixed with
2010 the contents of this variable.  The default is @samp{>}.  You can set
2011 this variable to an empty string to split the cited text into paragraphs
2012 automatically.  See also @code{message-yank-prefix}.
2014 @item message-indentation-spaces
2015 @vindex message-indentation-spaces
2016 Number of spaces to indent yanked messages.
2018 @item message-cite-function
2019 @vindex message-cite-function
2020 @findex message-cite-original
2021 @findex message-cite-original-without-signature
2022 Function for citing an original message.  The default is
2023 @code{message-cite-original}, which simply inserts the original message
2024 and prepends @samp{> } to each line.
2025 @code{message-cite-original-without-signature} does the same, but elides
2026 the signature.
2028 @item message-indent-citation-function
2029 @vindex message-indent-citation-function
2030 Function for modifying a citation just inserted in the mail buffer.
2031 This can also be a list of functions.  Each function can find the
2032 citation between @code{(point)} and @code{(mark t)}.  And each function
2033 should leave point and mark around the citation text as modified.
2035 @item message-mark-insert-begin
2036 @vindex message-mark-insert-begin
2037 String to mark the beginning of some inserted text.
2039 @item message-mark-insert-end
2040 @vindex message-mark-insert-end
2041 String to mark the end of some inserted text.
2043 @item message-signature
2044 @vindex message-signature
2045 String to be inserted at the end of the message buffer.  If @code{t}
2046 (which is the default), the @code{message-signature-file} file will be
2047 inserted instead.  If a function, the result from the function will be
2048 used instead.  If a form, the result from the form will be used instead.
2049 If this variable is @code{nil}, no signature will be inserted at all.
2051 @item message-signature-file
2052 @vindex message-signature-file
2053 File containing the signature to be inserted at the end of the buffer.
2054 If a path is specified, the value of
2055 @code{message-signature-directory} is ignored, even if set.
2056 The default is @file{~/.signature}.
2058 @item message-signature-directory
2059 @vindex message-signature-directory
2060 Name of directory containing signature files.  Comes in handy if you
2061 have many such files, handled via Gnus posting styles for instance.
2062 If @code{nil} (the default), @code{message-signature-file} is expected
2063 to specify the directory if needed.
2066 @item message-signature-insert-empty-line
2067 @vindex message-signature-insert-empty-line
2068 If @code{t} (the default value) an empty line is inserted before the
2069 signature separator.
2071 @end table
2073 Note that RFC1036bis says that a signature should be preceded by the three
2074 characters @samp{-- } on a line by themselves.  This is to make it
2075 easier for the recipient to automatically recognize and process the
2076 signature.  So don't remove those characters, even though you might feel
2077 that they ruin your beautiful design, like, totally.
2079 Also note that no signature should be more than four lines long.
2080 Including @acronym{ASCII} graphics is an efficient way to get
2081 everybody to believe that you are silly and have nothing important to
2082 say.
2085 @node Various Message Variables
2086 @section Various Message Variables
2088 @table @code
2089 @item message-default-charset
2090 @vindex message-default-charset
2091 @cindex charset
2092 Symbol naming a @acronym{MIME} charset.  Non-@acronym{ASCII} characters
2093 in messages are assumed to be encoded using this charset.  The default
2094 is @code{iso-8859-1} on non-@sc{mule} Emacsen; otherwise @code{nil},
2095 which means ask the user.  (This variable is used only on non-@sc{mule}
2096 Emacsen.)  @xref{Charset Translation, , Charset Translation, emacs-mime,
2097 Emacs MIME Manual}, for details on the @sc{mule}-to-@acronym{MIME}
2098 translation process.
2100 @item message-fill-column
2101 @vindex message-fill-column
2102 @cindex auto-fill
2103 Local value for the column beyond which automatic line-wrapping should
2104 happen for message buffers.  If non-nil (the default), also turn on
2105 auto-fill in message buffers.
2107 @item message-signature-separator
2108 @vindex message-signature-separator
2109 Regexp matching the signature separator.  It is @samp{^-- *$} by
2110 default.
2112 @item mail-header-separator
2113 @vindex mail-header-separator
2114 String used to separate the headers from the body.  It is @samp{--text
2115 follows this line--} by default.
2117 @item message-directory
2118 @vindex message-directory
2119 Directory used by many mailish things.  The default is @file{~/Mail/}.
2120 All other mail file variables are derived from @code{message-directory}.
2122 @item message-auto-save-directory
2123 @vindex message-auto-save-directory
2124 Directory where Message auto-saves buffers if Gnus isn't running.  If
2125 @code{nil}, Message won't auto-save.  The default is @file{~/Mail/drafts/}.
2127 @item message-signature-setup-hook
2128 @vindex message-signature-setup-hook
2129 Hook run when initializing the message buffer.  It is run after the
2130 headers have been inserted but before the signature has been inserted.
2132 @item message-setup-hook
2133 @vindex message-setup-hook
2134 Hook run as the last thing when the message buffer has been initialized,
2135 but before yanked text is inserted.
2137 @item message-header-setup-hook
2138 @vindex message-header-setup-hook
2139 Hook called narrowed to the headers after initializing the headers.
2141 For instance, if you're running Gnus and wish to insert a
2142 @samp{Mail-Copies-To} header in all your news articles and all messages
2143 you send to mailing lists, you could do something like the following:
2145 @lisp
2146 (defun my-message-header-setup-hook ()
2147   (let ((group (or gnus-newsgroup-name "")))
2148     (when (or (message-fetch-field "newsgroups")
2149               (gnus-group-find-parameter group 'to-address)
2150               (gnus-group-find-parameter group 'to-list))
2151       (insert "Mail-Copies-To: never\n"))))
2153 (add-hook 'message-header-setup-hook
2154           'my-message-header-setup-hook)
2155 @end lisp
2157 @item message-send-hook
2158 @vindex message-send-hook
2159 Hook run before sending messages.
2161 If you want to add certain headers before sending, you can use the
2162 @code{message-add-header} function in this hook.  For instance:
2163 @findex message-add-header
2165 @lisp
2166 (add-hook 'message-send-hook 'my-message-add-content)
2167 (defun my-message-add-content ()
2168   (message-add-header "X-In-No-Sense: Nonsense")
2169   (message-add-header "X-Whatever: no"))
2170 @end lisp
2172 This function won't add the header if the header is already present.
2174 @item message-send-mail-hook
2175 @vindex message-send-mail-hook
2176 Hook run before sending mail messages.  This hook is run very late --
2177 just before the message is actually sent as mail.
2179 @item message-send-news-hook
2180 @vindex message-send-news-hook
2181 Hook run before sending news messages.  This hook is run very late --
2182 just before the message is actually sent as news.
2184 @item message-sent-hook
2185 @vindex message-sent-hook
2186 Hook run after sending messages.
2188 @item message-cancel-hook
2189 @vindex message-cancel-hook
2190 Hook run when canceling news articles.
2192 @item message-mode-syntax-table
2193 @vindex message-mode-syntax-table
2194 Syntax table used in message mode buffers.
2196 @item message-cite-articles-with-x-no-archive
2197 @vindex message-cite-articles-with-x-no-archive
2198 If non-@code{nil}, don't strip quoted text from articles that have
2199 @samp{X-No-Archive} set.  Even if this variable isn't set, you can
2200 undo the stripping by hitting the @code{undo} keystroke.
2202 @item message-strip-special-text-properties
2203 @vindex message-strip-special-text-properties
2204 Emacs has a number of special text properties which can break message
2205 composing in various ways.  If this option is set, message will strip
2206 these properties from the message composition buffer.  However, some
2207 packages requires these properties to be present in order to work.  If
2208 you use one of these packages, turn this option off, and hope the
2209 message composition doesn't break too bad.
2211 @item message-send-method-alist
2212 @vindex message-send-method-alist
2213 @findex message-mail-p
2214 @findex message-news-p
2215 @findex message-send-via-mail
2216 @findex message-send-via-news
2217 Alist of ways to send outgoing messages.  Each element has the form:
2219 @lisp
2220 (@var{type} @var{predicate} @var{function})
2221 @end lisp
2223 @table @var
2224 @item type
2225 A symbol that names the method.
2227 @item predicate
2228 A function called without any parameters to determine whether the
2229 message is a message of type @var{type}.  The function will be called in
2230 the buffer where the message is.
2232 @item function
2233 A function to be called if @var{predicate} returns non-@code{nil}.
2234 @var{function} is called with one parameter---the prefix.
2235 @end table
2237 The default is:
2239 @lisp
2240 ((news message-news-p message-send-via-news)
2241  (mail message-mail-p message-send-via-mail))
2242 @end lisp
2244 The @code{message-news-p} function returns non-@code{nil} if the message
2245 looks like news, and the @code{message-send-via-news} function sends the
2246 message according to the @code{message-send-news-function} variable
2247 (@pxref{News Variables}).  The @code{message-mail-p} function returns
2248 non-@code{nil} if the message looks like mail, and the
2249 @code{message-send-via-mail} function sends the message according to the
2250 @code{message-send-mail-function} variable (@pxref{Mail Variables}).
2252 All the elements in this alist will be tried in order, so a message
2253 containing both a valid @samp{Newsgroups} header and a valid @samp{To}
2254 header, for example, will be sent as news, and then as mail.
2255 @end table
2259 @node Sending Variables
2260 @section Sending Variables
2262 @table @code
2264 @item message-fcc-handler-function
2265 @vindex message-fcc-handler-function
2266 A function called to save outgoing articles.  This function will be
2267 called with the name of the file to store the article in.  The default
2268 function is @code{message-output} which saves in Unix mailbox format.
2270 @item message-courtesy-message
2271 @vindex message-courtesy-message
2272 When sending combined messages, this string is inserted at the start of
2273 the mailed copy.  If the string contains the format spec @samp{%s}, the
2274 newsgroups the article has been posted to will be inserted there.  If
2275 this variable is @code{nil}, no such courtesy message will be added.
2276 The default value is @samp{"The following message is a courtesy copy of
2277 an article\\nthat has been posted to %s as well.\\n\\n"}.
2279 @item message-fcc-externalize-attachments
2280 @vindex message-fcc-externalize-attachments
2281 If @code{nil}, attach files as normal parts in Fcc copies; if it is
2282 non-@code{nil}, attach local files as external parts.
2284 @item message-interactive
2285 @vindex message-interactive
2286 If non-@code{nil} wait for and display errors when sending a message;
2287 if @code{nil} let the mailer mail back a message to report errors.
2289 @item message-confirm-send
2290 @vindex message-confirm-send
2291 When non-@code{nil}, Gnus will ask for confirmation when sending a
2292 message.
2294 @end table
2297 @node Message Buffers
2298 @section Message Buffers
2300 Message will generate new buffers with unique buffer names when you
2301 request a message buffer.  When you send the message, the buffer isn't
2302 normally killed off.  Its name is changed and a certain number of old
2303 message buffers are kept alive.
2305 @table @code
2306 @item message-generate-new-buffers
2307 @vindex message-generate-new-buffers
2308 Controls whether to create a new message buffer to compose a message.
2309 Valid values include:
2311 @table @code
2312 @item nil
2313 Generate the buffer name in the Message way (e.g., *mail*, *news*, *mail
2314 to whom*, *news on group*, etc.) and continue editing in the existing
2315 buffer of that name.  If there is no such buffer, it will be newly
2316 created.
2318 @item unique
2319 @item t
2320 Create the new buffer with the name generated in the Message way.
2322 @item unsent
2323 Similar to @code{unique} but the buffer name begins with "*unsent ".
2325 @item standard
2326 Similar to @code{nil} but the buffer name is simpler like *mail
2327 message*.
2328 @end table
2329 @table @var
2330 @item function
2331 If this is a function, call that function with three parameters: The
2332 type, the To address and the group name (any of these may be
2333 @code{nil}).  The function should return the new buffer name.
2334 @end table
2336 The default value is @code{unsent}.
2338 @item message-max-buffers
2339 @vindex message-max-buffers
2340 This variable says how many old message buffers to keep.  If there are
2341 more message buffers than this, the oldest buffer will be killed.  The
2342 default is 10.  If this variable is @code{nil}, no old message buffers
2343 will ever be killed.
2345 @item message-send-rename-function
2346 @vindex message-send-rename-function
2347 After sending a message, the buffer is renamed from, for instance,
2348 @samp{*reply to Lars*} to @samp{*sent reply to Lars*}.  If you don't
2349 like this, set this variable to a function that renames the buffer in a
2350 manner you like.  If you don't want to rename the buffer at all, you can
2351 say:
2353 @lisp
2354 (setq message-send-rename-function 'ignore)
2355 @end lisp
2357 @item message-kill-buffer-on-exit
2358 @findex message-kill-buffer-on-exit
2359 If non-@code{nil}, kill the buffer immediately on exit.
2361 @end table
2364 @node Message Actions
2365 @section Message Actions
2367 When Message is being used from a news/mail reader, the reader is likely
2368 to want to perform some task after the message has been sent.  Perhaps
2369 return to the previous window configuration or mark an article as
2370 replied.
2372 @vindex message-kill-actions
2373 @vindex message-postpone-actions
2374 @vindex message-exit-actions
2375 @vindex message-send-actions
2376 The user may exit from the message buffer in various ways.  The most
2377 common is @kbd{C-c C-c}, which sends the message and exits.  Other
2378 possibilities are @kbd{C-c C-s} which just sends the message, @kbd{C-c
2379 C-d} which postpones the message editing and buries the message buffer,
2380 and @kbd{C-c C-k} which kills the message buffer.  Each of these actions
2381 have lists associated with them that contains actions to be executed:
2382 @code{message-send-actions}, @code{message-exit-actions},
2383 @code{message-postpone-actions}, and @code{message-kill-actions}.
2385 Message provides a function to interface with these lists:
2386 @code{message-add-action}.  The first parameter is the action to be
2387 added, and the rest of the arguments are which lists to add this action
2388 to.  Here's an example from Gnus:
2390 @lisp
2391   (message-add-action
2392    `(set-window-configuration ,(current-window-configuration))
2393    'exit 'postpone 'kill)
2394 @end lisp
2396 This restores the Gnus window configuration when the message buffer is
2397 killed, postponed or exited.
2399 An @dfn{action} can be either: a normal function, or a list where the
2400 @sc{car} is a function and the @sc{cdr} is the list of arguments, or
2401 a form to be @code{eval}ed.
2404 @node Compatibility
2405 @chapter Compatibility
2406 @cindex compatibility
2408 Message uses virtually only its own variables---older @code{mail-}
2409 variables aren't consulted.  To force Message to take those variables
2410 into account, you can put the following in your @file{.emacs} file:
2412 @lisp
2413 (require 'messcompat)
2414 @end lisp
2416 This will initialize many Message variables from the values in the
2417 corresponding mail variables.
2420 @node Appendices
2421 @chapter Appendices
2423 @menu
2424 * Responses::          Standard rules for determining where responses go.
2425 @end menu
2428 @node Responses
2429 @section Responses
2431 To determine where a message is to go, the following algorithm is used
2432 by default.
2434 @table @dfn
2435 @item reply
2436 A @dfn{reply} is when you want to respond @emph{just} to the person who
2437 sent the message via mail.  There will only be one recipient.  To
2438 determine who the recipient will be, the following headers are
2439 consulted, in turn:
2441 @table @code
2442 @item Reply-To
2444 @item From
2445 @end table
2448 @item wide reply
2449 A @dfn{wide reply} is a mail response that includes @emph{all} entities
2450 mentioned in the message you are responding to.  All mailboxes from the
2451 following headers will be concatenated to form the outgoing
2452 @code{To}/@code{Cc} headers:
2454 @table @code
2455 @item From
2456 (unless there's a @code{Reply-To}, in which case that is used instead).
2458 @item Cc
2460 @item To
2461 @end table
2463 If a @code{Mail-Copies-To} header is present, it will also be included
2464 in the list of mailboxes.  If this header is @samp{never}, that means
2465 that the @code{From} (or @code{Reply-To}) mailbox will be suppressed.
2468 @item followup
2469 A @dfn{followup} is a response sent via news.  The following headers
2470 (listed in order of precedence) determine where the response is to be
2471 sent:
2473 @table @code
2475 @item Followup-To
2477 @item Newsgroups
2479 @end table
2481 If a @code{Mail-Copies-To} header is present, it will be used as the
2482 basis of the new @code{Cc} header, except if this header is
2483 @samp{never}.
2485 @end table
2488 @node GNU Free Documentation License
2489 @chapter GNU Free Documentation License
2490 @include doclicense.texi
2492 @node Index
2493 @chapter Index
2494 @printindex cp
2496 @node Key Index
2497 @chapter Key Index
2498 @printindex ky
2500 @bye
2502 @c End: