Ma Gnus v0.11 is released
[gnus.git] / texi / message.texi
blobd56c05a365c926ea05043e81bf857ef7e943412d
1 \input texinfo                  @c -*-texinfo-*-
3 @include gnus-overrides.texi
5 @setfilename message
6 @settitle Message Manual
7 @documentencoding UTF-8
8 @synindex fn cp
9 @synindex vr cp
10 @synindex pg cp
11 @copying
12 This file documents Message, the Emacs message composition mode.
14 Copyright @copyright{} 1996--2014 Free Software Foundation, Inc.
16 @quotation
17 Permission is granted to copy, distribute and/or modify this document
18 under the terms of the GNU Free Documentation License, Version 1.3 or
19 any later version published by the Free Software Foundation; with no
20 Invariant Sections, with the Front-Cover texts being ``A GNU Manual'',
21 and with the Back-Cover Texts as in (a) below.  A copy of the license
22 is included in the section entitled ``GNU Free Documentation License''.
24 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
25 modify this GNU manual.''
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 Ma Gnus v0.11
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 In non-@code{nil}, all headers that match this regexp will be deleted
314 when forwarding a message.
316 @item message-forward-included-headers
317 @vindex message-forward-included-headers
318 In non-@code{nil}, only headers that match this regexp will be kept
319 when forwarding a message.
321 @item message-make-forward-subject-function
322 @vindex message-make-forward-subject-function
323 A list of functions that are called to generate a subject header for
324 forwarded messages.  The subject generated by the previous function is
325 passed into each successive function.
327 The provided functions are:
329 @table @code
330 @item message-forward-subject-author-subject
331 @findex message-forward-subject-author-subject
332 Source of article (author or newsgroup), in brackets followed by the
333 subject.
335 @item message-forward-subject-fwd
336 Subject of article with @samp{Fwd:} prepended to it.
337 @end table
339 @item message-wash-forwarded-subjects
340 @vindex message-wash-forwarded-subjects
341 If this variable is @code{t}, the subjects of forwarded messages have
342 the evidence of previous forwards (such as @samp{Fwd:}, @samp{Re:},
343 @samp{(fwd)}) removed before the new subject is
344 constructed.  The default value is @code{nil}.
346 @item message-forward-as-mime
347 @vindex message-forward-as-mime
348 If this variable is @code{t} (the default), forwarded messages are
349 included as inline @acronym{MIME} RFC822 parts.  If it's @code{nil}, forwarded
350 messages will just be copied inline to the new message, like previous,
351 non @acronym{MIME}-savvy versions of Gnus would do.
353 @item message-forward-before-signature
354 @vindex message-forward-before-signature
355 If non-@code{nil}, put forwarded message before signature, else after.
357 @end table
360 @node Resending
361 @section Resending
363 @findex message-resend
364 The @code{message-resend} command will prompt the user for an address
365 and resend the message in the current buffer to that address.
367 @vindex message-ignored-resent-headers
368 Headers that match the @code{message-ignored-resent-headers} regexp will
369 be removed before sending the message.
372 @node Bouncing
373 @section Bouncing
375 @findex message-bounce
376 The @code{message-bounce} command will, if the current buffer contains a
377 bounced mail message, pop up a message buffer stripped of the bounce
378 information.  A @dfn{bounced message} is typically a mail you've sent
379 out that has been returned by some @code{mailer-daemon} as
380 undeliverable.
382 @vindex message-ignored-bounced-headers
383 Headers that match the @code{message-ignored-bounced-headers} regexp
384 will be removed before popping up the buffer.  The default is
385 @samp{^\\(Received\\|Return-Path\\|Delivered-To\\):}.
388 @node Mailing Lists
389 @section Mailing Lists
391 @cindex Mail-Followup-To
392 Sometimes while posting to mailing lists, the poster needs to direct
393 followups to the post to specific places.  The Mail-Followup-To (MFT)
394 was created to enable just this.  Three example scenarios where this is
395 useful:
397 @itemize @bullet
398 @item
399 A mailing list poster can use MFT to express that responses should be
400 sent to just the list, and not the poster as well.  This will happen
401 if the poster is already subscribed to the list.
403 @item
404 A mailing list poster can use MFT to express that responses should be
405 sent to the list and the poster as well.  This will happen if the poster
406 is not subscribed to the list.
408 @item
409 If a message is posted to several mailing lists, MFT may also be used
410 to direct the following discussion to one list only, because
411 discussions that are spread over several lists tend to be fragmented
412 and very difficult to follow.
414 @end itemize
416 Gnus honors the MFT header in other's messages (i.e., while following
417 up to someone else's post) and also provides support for generating
418 sensible MFT headers for outgoing messages as well.
420 @c @menu
421 @c * Honoring an MFT post::        What to do when one already exists
422 @c * Composing with a MFT header:: Creating one from scratch.
423 @c @end menu
425 @c @node Composing with a MFT header
426 @subsection  Composing a correct MFT header automagically
428 The first step in getting Gnus to automagically generate a MFT header
429 in posts you make is to give Gnus a list of the mailing lists
430 addresses you are subscribed to.  You can do this in more than one
431 way.  The following variables would come in handy.
433 @table @code
435 @vindex message-subscribed-addresses
436 @item message-subscribed-addresses
437 This should be a list of addresses the user is subscribed to.  Its
438 default value is @code{nil}.  Example:
439 @lisp
440 (setq message-subscribed-addresses
441       '("ding@@gnus.org" "bing@@noose.org"))
442 @end lisp
444 @vindex message-subscribed-regexps
445 @item message-subscribed-regexps
446 This should be a list of regexps denoting the addresses of mailing
447 lists subscribed to.  Default value is @code{nil}.  Example: If you
448 want to achieve the same result as above:
449 @lisp
450 (setq message-subscribed-regexps
451       '("\\(ding@@gnus\\)\\|\\(bing@@noose\\)\\.org")
452 @end lisp
454 @vindex message-subscribed-address-functions
455 @item message-subscribed-address-functions
456 This can be a list of functions to be called (one at a time!!) to
457 determine the value of MFT headers.  It is advisable that these
458 functions not take any arguments.  Default value is @code{nil}.
460 There is a pre-defined function in Gnus that is a good candidate for
461 this variable.  @code{gnus-find-subscribed-addresses} is a function
462 that returns a list of addresses corresponding to the groups that have
463 the @code{subscribed} (@pxref{Group Parameters, ,Group Parameters,
464 gnus, The Gnus Manual}) group parameter set to a non-@code{nil} value.
465 This is how you would do it.
467 @lisp
468 (setq message-subscribed-address-functions
469       '(gnus-find-subscribed-addresses))
470 @end lisp
472 @vindex message-subscribed-address-file
473 @item message-subscribed-address-file
474 You might be one organized human freak and have a list of addresses of
475 all subscribed mailing lists in a separate file!  Then you can just
476 set this variable to the name of the file and life would be good.
478 @end table
480 You can use one or more of the above variables.  All their values are
481 ``added'' in some way that works :-)
483 Now you are all set.  Just start composing a message as you normally do.
484 And just send it; as always.  Just before the message is sent out, Gnus'
485 MFT generation thingy kicks in and checks if the message already has a
486 MFT field.  If there is one, it is left alone.  (Except if it's empty;
487 in that case, the field is removed and is not replaced with an
488 automatically generated one.  This lets you disable MFT generation on a
489 per-message basis.)  If there is none, then the list of recipient
490 addresses (in the To: and Cc: headers) is checked to see if one of them
491 is a list address you are subscribed to.  If none of them is a list
492 address, then no MFT is generated; otherwise, a MFT is added to the
493 other headers and set to the value of all addresses in To: and Cc:
495 @kindex C-c C-f C-a
496 @findex message-generate-unsubscribed-mail-followup-to
497 @kindex C-c C-f C-m
498 @findex message-goto-mail-followup-to
499 Hm.  ``So'', you ask, ``what if I send an email to a list I am not
500 subscribed to?  I want my MFT to say that I want an extra copy.''  (This
501 is supposed to be interpreted by others the same way as if there were no
502 MFT, but you can use an explicit MFT to override someone else's
503 to-address group parameter.)  The function
504 @code{message-generate-unsubscribed-mail-followup-to} might come in
505 handy.  It is bound to @kbd{C-c C-f C-a} by default.  In any case, you
506 can insert a MFT of your own choice; @kbd{C-c C-f C-m}
507 (@code{message-goto-mail-followup-to}) will help you get started.
509 @c @node Honoring an MFT post
510 @subsection Honoring an MFT post
512 @vindex message-use-mail-followup-to
513 When you followup to a post on a mailing list, and the post has a MFT
514 header, Gnus' action will depend on the value of the variable
515 @code{message-use-mail-followup-to}.  This variable can be one of:
517 @table @code
518 @item use
519  Always honor MFTs.  The To: and Cc: headers in your followup will be
520  derived from the MFT header of the original post.  This is the default.
522 @item nil
523  Always dishonor MFTs (just ignore the darned thing)
525 @item ask
526 Gnus will prompt you for an action.
528 @end table
530 It is considered good netiquette to honor MFT, as it is assumed the
531 fellow who posted a message knows where the followups need to go
532 better than you do.
534 @node Commands
535 @chapter Commands
537 @menu
538 * Buffer Entry::        Commands after entering a Message buffer.
539 * Header Commands::     Commands for moving headers or changing headers.
540 * Movement::            Moving around in message buffers.
541 * Insertion::           Inserting things into message buffers.
542 * MIME::                @acronym{MIME} considerations.
543 * IDNA::                Non-@acronym{ASCII} domain name considerations.
544 * Security::            Signing and encrypting messages.
545 * Various Commands::    Various things.
546 * Sending::             Actually sending the message.
547 * Mail Aliases::        How to use mail aliases.
548 * Spelling::            Having Emacs check your spelling.
549 @end menu
552 @node Buffer Entry
553 @section Buffer Entry
554 @cindex undo
555 @kindex C-_
557 You most often end up in a Message buffer when responding to some other
558 message of some sort.  Message does lots of handling of quoted text, and
559 may remove signatures, reformat the text, or the like---depending on
560 which used settings you're using.  Message usually gets things right,
561 but sometimes it stumbles.  To help the user unwind these stumblings,
562 Message sets the undo boundary before each major automatic action it
563 takes.  If you press the undo key (usually located at @kbd{C-_}) a few
564 times, you will get back the un-edited message you're responding to.
567 @node Header Commands
568 @section Header Commands
570 @subsection Commands for moving to headers
572 These following commands move to the header in question.  If it doesn't
573 exist, it will be inserted.
575 @table @kbd
577 @item C-c ?
578 @kindex C-c ?
579 @findex describe-mode
580 Describe the message mode.
582 @item C-c C-f C-t
583 @kindex C-c C-f C-t
584 @findex message-goto-to
585 Go to the @code{To} header (@code{message-goto-to}).
587 @item C-c C-f C-o
588 @kindex C-c C-f C-o
589 @findex message-goto-from
590 Go to the @code{From} header (@code{message-goto-from}).  (The ``o''
591 in the key binding is for Originator.)
593 @item C-c C-f C-b
594 @kindex C-c C-f C-b
595 @findex message-goto-bcc
596 Go to the @code{Bcc} header (@code{message-goto-bcc}).
598 @item C-c C-f C-w
599 @kindex C-c C-f C-w
600 @findex message-goto-fcc
601 Go to the @code{Fcc} header (@code{message-goto-fcc}).
603 @item C-c C-f C-c
604 @kindex C-c C-f C-c
605 @findex message-goto-cc
606 Go to the @code{Cc} header (@code{message-goto-cc}).
608 @item C-c C-f C-s
609 @kindex C-c C-f C-s
610 @findex message-goto-subject
611 Go to the @code{Subject} header (@code{message-goto-subject}).
613 @item C-c C-f C-r
614 @kindex C-c C-f C-r
615 @findex message-goto-reply-to
616 Go to the @code{Reply-To} header (@code{message-goto-reply-to}).
618 @item C-c C-f C-n
619 @kindex C-c C-f C-n
620 @findex message-goto-newsgroups
621 Go to the @code{Newsgroups} header (@code{message-goto-newsgroups}).
623 @item C-c C-f C-d
624 @kindex C-c C-f C-d
625 @findex message-goto-distribution
626 Go to the @code{Distribution} header (@code{message-goto-distribution}).
628 @item C-c C-f C-f
629 @kindex C-c C-f C-f
630 @findex message-goto-followup-to
631 Go to the @code{Followup-To} header (@code{message-goto-followup-to}).
633 @item C-c C-f C-k
634 @kindex C-c C-f C-k
635 @findex message-goto-keywords
636 Go to the @code{Keywords} header (@code{message-goto-keywords}).
638 @item C-c C-f C-u
639 @kindex C-c C-f C-u
640 @findex message-goto-summary
641 Go to the @code{Summary} header (@code{message-goto-summary}).
643 @item C-c C-f C-i
644 @kindex C-c C-f C-i
645 @findex message-insert-or-toggle-importance
646 This inserts the @samp{Importance:} header with a value of
647 @samp{high}.  This header is used to signal the importance of the
648 message to the receiver.  If the header is already present in the
649 buffer, it cycles between the three valid values according to RFC
650 1376: @samp{low}, @samp{normal} and @samp{high}.
652 @item C-c C-f C-a
653 @kindex C-c C-f C-a
654 @findex message-generate-unsubscribed-mail-followup-to
655 Insert a reasonable @samp{Mail-Followup-To:} header
656 (@pxref{Mailing Lists}) in a post to an
657 unsubscribed list.  When making original posts to a mailing list you are
658 not subscribed to, you have to type in a @samp{Mail-Followup-To:} header
659 by hand.  The contents, usually, are the addresses of the list and your
660 own address.  This function inserts such a header automatically.  It
661 fetches the contents of the @samp{To:} header in the current mail
662 buffer, and appends the current @code{user-mail-address}.
664 If the optional argument @code{include-cc} is non-@code{nil}, the
665 addresses in the @samp{Cc:} header are also put into the
666 @samp{Mail-Followup-To:} header.
668 @end table
670 @subsection  Commands to change headers
672 @table @kbd
674 @item C-c C-o
675 @kindex C-c C-o
676 @findex message-sort-headers
677 @vindex message-header-format-alist
678 Sort headers according to @code{message-header-format-alist}
679 (@code{message-sort-headers}).
681 @item C-c C-t
682 @kindex C-c C-t
683 @findex message-insert-to
684 Insert a @code{To} header that contains the @code{Reply-To} or
685 @code{From} header of the message you're following up
686 (@code{message-insert-to}).
688 @item C-c C-n
689 @kindex C-c C-n
690 @findex message-insert-newsgroups
691 Insert a @code{Newsgroups} header that reflects the @code{Followup-To}
692 or @code{Newsgroups} header of the article you're replying to
693 (@code{message-insert-newsgroups}).
695 @item C-c C-l
696 @kindex C-c C-l
697 @findex message-to-list-only
698 Send a message to the list only.  Remove all addresses but the list
699 address from @code{To:} and @code{Cc:} headers.
701 @item C-c M-n
702 @kindex C-c M-n
703 @findex message-insert-disposition-notification-to
704 Insert a request for a disposition
705 notification.  (@code{message-insert-disposition-notification-to}).
706 This means that if the recipient supports RFC 2298 she might send you a
707 notification that she received the message.
709 @item M-x message-insert-importance-high
710 @kindex M-x message-insert-importance-high
711 @findex message-insert-importance-high
712 @cindex Importance
713 Insert an @samp{Importance} header with a value of @samp{high},
714 deleting headers if necessary.
716 @item M-x message-insert-importance-low
717 @kindex M-x message-insert-importance-low
718 @findex message-insert-importance-low
719 @cindex Importance
720 Insert an @samp{Importance} header with a value of @samp{low}, deleting
721 headers if necessary.
723 @item C-c C-f s
724 @kindex C-c C-f s
725 @findex message-change-subject
726 @cindex Subject
727 Change the current @samp{Subject} header.  Ask for new @samp{Subject}
728 header and append @samp{(was: <Old Subject>)}.  The old subject can be
729 stripped on replying, see @code{message-subject-trailing-was-query}
730 (@pxref{Message Headers}).
732 @item C-c C-f x
733 @kindex C-c C-f x
734 @findex message-cross-post-followup-to
735 @vindex message-cross-post-default
736 @vindex message-cross-post-note-function
737 @cindex X-Post
738 @cindex cross-post
739 Set up the @samp{FollowUp-To} header with a target newsgroup for a
740 cross-post, add that target newsgroup to the @samp{Newsgroups} header if
741 it is not a member of @samp{Newsgroups}, and insert a note in the body.
742 If @code{message-cross-post-default} is @code{nil} or if this command is
743 called with a prefix-argument, only the @samp{FollowUp-To} header will
744 be set but the target newsgroup will not be added to the
745 @samp{Newsgroups} header.  The function to insert a note is controlled
746 by the @code{message-cross-post-note-function} variable.
748 @item C-c C-f t
749 @kindex C-c C-f t
750 @findex message-reduce-to-to-cc
751 Replace contents of @samp{To} header with contents of @samp{Cc} or
752 @samp{Bcc} header.  (Iff @samp{Cc} header is not present, @samp{Bcc}
753 header will be used instead.)
755 @item C-c C-f w
756 @kindex C-c C-f w
757 @findex message-insert-wide-reply
758 Insert @samp{To} and @samp{Cc} headers as if you were doing a wide
759 reply even if the message was not made for a wide reply first.
761 @item C-c C-f a
762 @kindex C-c C-f a
763 @findex message-add-archive-header
764 @vindex message-archive-header
765 @vindex message-archive-note
766 @cindex X-No-Archive
767 Insert @samp{X-No-Archive: Yes} in the header and a note in the body.
768 The header and the note can be customized using
769 @code{message-archive-header} and @code{message-archive-note}.  When
770 called with a prefix argument, ask for a text to insert.  If you don't
771 want the note in the body, set @code{message-archive-note} to
772 @code{nil}.
774 @end table
777 @node Movement
778 @section Movement
780 @table @kbd
781 @item C-c C-b
782 @kindex C-c C-b
783 @findex message-goto-body
784 Move to the beginning of the body of the message
785 (@code{message-goto-body}).
787 @item C-c C-i
788 @kindex C-c C-i
789 @findex message-goto-signature
790 Move to the signature of the message (@code{message-goto-signature}).
792 @item C-a
793 @kindex C-a
794 @findex message-beginning-of-line
795 @vindex message-beginning-of-line
796 If at beginning of header value, go to beginning of line, else go to
797 beginning of header value.  (The header value comes after the header
798 name and the colon.)  This behavior can be disabled by toggling
799 the variable @code{message-beginning-of-line}.
801 @end table
804 @node Insertion
805 @section Insertion
807 @table @kbd
809 @item C-c C-y
810 @kindex C-c C-y
811 @findex message-yank-original
812 Yank the message that's being replied to into the message buffer
813 (@code{message-yank-original}).
815 @item C-c C-M-y
816 @kindex C-c C-M-y
817 @findex message-yank-buffer
818 Prompt for a buffer name and yank the contents of that buffer into the
819 message buffer (@code{message-yank-buffer}).
821 @item C-c C-q
822 @kindex C-c C-q
823 @findex message-fill-yanked-message
824 Fill the yanked message (@code{message-fill-yanked-message}).  Warning:
825 Can severely mess up the yanked text if its quoting conventions are
826 strange.  You'll quickly get a feel for when it's safe, though.  Anyway,
827 just remember that @kbd{C-x u} (@code{undo}) is available and you'll be
828 all right.
830 @item C-c C-w
831 @kindex C-c C-w
832 @findex message-insert-signature
833 Insert a signature at the end of the buffer
834 (@code{message-insert-signature}).
836 @item C-c M-h
837 @kindex C-c M-h
838 @findex message-insert-headers
839 Insert the message headers (@code{message-insert-headers}).
841 @item C-c M-m
842 @kindex C-c M-m
843 @findex message-mark-inserted-region
844 Mark some region in the current article with enclosing tags.  See
845 @code{message-mark-insert-begin} and @code{message-mark-insert-end}.
846 When called with a prefix argument, use slrn style verbatim marks
847 (@samp{#v+} and @samp{#v-}).
849 @item C-c M-f
850 @kindex C-c M-f
851 @findex message-mark-insert-file
852 Insert a file in the current article with enclosing tags.
853 See @code{message-mark-insert-begin} and @code{message-mark-insert-end}.
854 When called with a prefix argument, use slrn style verbatim marks
855 (@samp{#v+} and @samp{#v-}).
857 @end table
860 @node MIME
861 @section MIME
862 @cindex MML
863 @cindex MIME
864 @cindex multipart
865 @cindex attachment
867 Message is a @acronym{MIME}-compliant posting agent.  The user generally
868 doesn't have to do anything to make the @acronym{MIME} happen---Message will
869 automatically add the @code{Content-Type} and
870 @code{Content-Transfer-Encoding} headers.
872 @findex mml-attach-file
873 @kindex C-c C-a
874 The most typical thing users want to use the multipart things in
875 @acronym{MIME} for is to add ``attachments'' to mail they send out.
876 This can be done with the @kbd{C-c C-a} command (@kbd{M-x mml-attach-file}),
877 which will prompt for a file name and a @acronym{MIME} type.
879 @vindex mml-dnd-protocol-alist
880 @vindex mml-dnd-attach-options
881 If your Emacs supports drag and drop, you can also drop the file in the
882 Message buffer.  The variable @code{mml-dnd-protocol-alist} specifies
883 what kind of action is done when you drop a file into the Message
884 buffer.  The variable @code{mml-dnd-attach-options} controls which
885 @acronym{MIME} options you want to specify when dropping a file.  If it
886 is a list, valid members are @code{type}, @code{description} and
887 @code{disposition}.  @code{disposition} implies @code{type}.  If it is
888 @code{nil}, don't ask for options.  If it is @code{t}, ask the user
889 whether or not to specify options.
891 You can also create arbitrarily complex multiparts using the @acronym{MML}
892 language (@pxref{Composing, , Composing, emacs-mime, The Emacs MIME
893 Manual}).
895 @node IDNA
896 @section IDNA
897 @cindex IDNA
898 @cindex internationalized domain names
899 @cindex non-ascii domain names
901 @acronym{IDNA} is a standard way to encode non-@acronym{ASCII} domain
902 names into a readable @acronym{ASCII} string.  The details can be
903 found in RFC 3490.
905 Message is a @acronym{IDNA}-compliant posting agent.  The user
906 generally doesn't have to do anything to make the @acronym{IDNA}
907 happen---Message will encode non-@acronym{ASCII} domain names in @code{From},
908 @code{To}, and @code{Cc} headers automatically.
910 Until @acronym{IDNA} becomes more well known, Message queries you
911 whether @acronym{IDNA} encoding of the domain name really should
912 occur.  Some users might not be aware that domain names can contain
913 non-@acronym{ASCII} now, so this gives them a safety net if they accidentally
914 typed a non-@acronym{ASCII} domain name.
916 @vindex message-use-idna
917 The @code{message-use-idna} variable control whether @acronym{IDNA} is
918 used.  If the variable is @code{nil} no @acronym{IDNA} encoding will
919 ever happen, if it is set to the symbol @code{ask} the user will be
920 queried, and if set to @code{t} (which is the default if @acronym{IDNA}
921 is fully available) @acronym{IDNA} encoding happens automatically.
923 @findex message-idna-to-ascii-rhs
924 If you want to experiment with the @acronym{IDNA} encoding, you can
925 invoke @kbd{M-x message-idna-to-ascii-rhs RET} in the message buffer
926 to have the non-@acronym{ASCII} domain names encoded while you edit
927 the message.
929 Note that you must have @uref{http://www.gnu.org/software/libidn/, GNU
930 Libidn} installed in order to use this functionality.
932 @node Security
933 @section Security
934 @cindex Security
935 @cindex S/MIME
936 @cindex PGP
937 @cindex PGP/MIME
938 @cindex sign
939 @cindex encrypt
940 @cindex secure
942 Using the @acronym{MML} language, Message is able to create digitally
943 signed and digitally encrypted messages.  Message (or rather
944 @acronym{MML}) currently support @acronym{PGP} (RFC 1991),
945 @acronym{PGP/MIME} (RFC 2015/3156) and @acronym{S/MIME}.
947 @menu
948 * Signing and encryption::      Signing and encrypting commands.
949 * Using S/MIME::                Using S/MIME
950 * Using PGP/MIME::              Using PGP/MIME
951 * PGP Compatibility::           Compatibility with older implementations
952 @end menu
954 @node Signing and encryption
955 @subsection Signing and encrypting commands
957 Instructing @acronym{MML} to perform security operations on a
958 @acronym{MIME} part is done using the @kbd{C-c C-m s} key map for
959 signing and the @kbd{C-c C-m c} key map for encryption, as follows.
960 @table @kbd
962 @item C-c C-m s s
963 @kindex C-c C-m s s
964 @findex mml-secure-message-sign-smime
966 Digitally sign current message using @acronym{S/MIME}.
968 @item C-c C-m s o
969 @kindex C-c C-m s o
970 @findex mml-secure-message-sign-pgp
972 Digitally sign current message using @acronym{PGP}.
974 @item C-c C-m s p
975 @kindex C-c C-m s p
976 @findex mml-secure-message-sign-pgpmime
978 Digitally sign current message using @acronym{PGP/MIME}.
980 @item C-c C-m c s
981 @kindex C-c C-m c s
982 @findex mml-secure-message-encrypt-smime
984 Digitally encrypt current message using @acronym{S/MIME}.
986 @item C-c C-m c o
987 @kindex C-c C-m c o
988 @findex mml-secure-message-encrypt-pgp
990 Digitally encrypt current message using @acronym{PGP}.
992 @item C-c C-m c p
993 @kindex C-c C-m c p
994 @findex mml-secure-message-encrypt-pgpmime
996 Digitally encrypt current message using @acronym{PGP/MIME}.
998 @item C-c C-m C-n
999 @kindex C-c C-m C-n
1000 @findex mml-unsecure-message
1001 Remove security related @acronym{MML} tags from message.
1003 @end table
1005 These commands do not immediately sign or encrypt the message, they
1006 merely insert the proper @acronym{MML} secure tag to instruct the
1007 @acronym{MML} engine to perform that operation when the message is
1008 actually sent.  They may perform other operations too, such as locating
1009 and retrieving a @acronym{S/MIME} certificate of the person you wish to
1010 send encrypted mail to.  When the mml parsing engine converts your
1011 @acronym{MML} into a properly encoded @acronym{MIME} message, the secure
1012 tag will be replaced with either a part or a multipart tag.  If your
1013 message contains other mml parts, a multipart tag will be used; if no
1014 other parts are present in your message a single part tag will be used.
1015 This way, message mode will do the Right Thing (TM) with
1016 signed/encrypted multipart messages.
1018 Since signing and especially encryption often is used when sensitive
1019 information is sent, you may want to have some way to ensure that your
1020 mail is actually signed or encrypted.  After invoking the above
1021 sign/encrypt commands, it is possible to preview the raw article by
1022 using @kbd{C-u C-c RET P} (@code{mml-preview}).  Then you can
1023 verify that your long rant about what your ex-significant other or
1024 whomever actually did with that funny looking person at that strange
1025 party the other night, actually will be sent encrypted.
1027 @emph{Note!}  Neither @acronym{PGP/MIME} nor @acronym{S/MIME} encrypt/signs
1028 RFC822 headers.  They only operate on the @acronym{MIME} object.  Keep this
1029 in mind before sending mail with a sensitive Subject line.
1031 By default, when encrypting a message, Gnus will use the
1032 ``signencrypt'' mode, which means the message is both signed and
1033 encrypted.  If you would like to disable this for a particular
1034 message, give the @code{mml-secure-message-encrypt-*} command a prefix
1035 argument, e.g., @kbd{C-u C-c C-m c p}.
1037 Actually using the security commands above is not very difficult.  At
1038 least not compared with making sure all involved programs talk with each
1039 other properly.  Thus, we now describe what external libraries or
1040 programs are required to make things work, and some small general hints.
1042 @node Using S/MIME
1043 @subsection Using S/MIME
1045 @emph{Note!}  This section assume you have a basic familiarity with
1046 modern cryptography, @acronym{S/MIME}, various PKCS standards, OpenSSL and
1047 so on.
1049 The @acronym{S/MIME} support in Message (and @acronym{MML}) require
1050 OpenSSL@.  OpenSSL performs the actual @acronym{S/MIME} sign/encrypt
1051 operations.  OpenSSL can be found at @uref{http://www.openssl.org/}.
1052 OpenSSL 0.9.6 and later should work.  Version 0.9.5a cannot extract mail
1053 addresses from certificates, and it insert a spurious CR character into
1054 @acronym{MIME} separators so you may wish to avoid it if you would like
1055 to avoid being regarded as someone who send strange mail.  (Although by
1056 sending @acronym{S/MIME} messages you've probably already lost that
1057 contest.)
1059 To be able to send encrypted mail, a personal certificate is not
1060 required.  Message (@acronym{MML}) need a certificate for the person to whom you
1061 wish to communicate with though.  You're asked for this when you type
1062 @kbd{C-c C-m c s}.  Currently there are two ways to retrieve this
1063 certificate, from a local file or from DNS@.  If you chose a local
1064 file, it need to contain a X.509 certificate in @acronym{PEM} format.
1065 If you chose DNS, you're asked for the domain name where the
1066 certificate is stored, the default is a good guess.  To my belief,
1067 Message (@acronym{MML}) is the first mail agent in the world to support
1068 retrieving @acronym{S/MIME} certificates from DNS, so you're not
1069 likely to find very many certificates out there.  At least there
1070 should be one, stored at the domain @code{simon.josefsson.org}.  LDAP
1071 is a more popular method of distributing certificates, support for it
1072 is planned.  (Meanwhile, you can use @code{ldapsearch} from the
1073 command line to retrieve a certificate into a file and use it.)
1075 As for signing messages, OpenSSL can't perform signing operations
1076 without some kind of configuration.  Especially, you need to tell it
1077 where your private key and your certificate is stored.  @acronym{MML}
1078 uses an Emacs interface to OpenSSL, aptly named @code{smime.el}, and it
1079 contain a @code{custom} group used for this configuration.  So, try
1080 @kbd{M-x customize-group RET smime RET} and look around.
1082 Currently there is no support for talking to a CA (or RA) to create
1083 your own certificate.  None is planned either.  You need to do this
1084 manually with OpenSSL or using some other program.  I used Netscape
1085 and got a free @acronym{S/MIME} certificate from one of the big CA's on the
1086 net.  Netscape is able to export your private key and certificate in
1087 PKCS #12 format.  Use OpenSSL to convert this into a plain X.509
1088 certificate in PEM format as follows.
1090 @example
1091 $ openssl pkcs12 -in ns.p12 -clcerts -nodes > key+cert.pem
1092 @end example
1094 The @file{key+cert.pem} file should be pointed to from the
1095 @code{smime-keys} variable.  You should now be able to send signed mail.
1097 @emph{Note!}  Your private key is now stored unencrypted in the file,
1098 so take care in handling it.  Storing encrypted keys on the disk are
1099 supported, and Gnus will ask you for a passphrase before invoking
1100 OpenSSL@.  Read the OpenSSL documentation for how to achieve this.  If
1101 you use unencrypted keys (e.g., if they are on a secure storage, or if
1102 you are on a secure single user machine) simply press @code{RET} at
1103 the passphrase prompt.
1105 @node Using PGP/MIME
1106 @subsection Using PGP/MIME
1108 @acronym{PGP/MIME} requires an external OpenPGP implementation, such
1109 as @uref{http://www.gnupg.org/, GNU Privacy Guard}. Pre-OpenPGP
1110 implementations such as PGP 2.x and PGP 5.x are also supported.  The
1111 default Emacs interface to the PGP implementation is EasyPG
1112 (@pxref{Top,,EasyPG Assistant User's Manual, epa, EasyPG Assistant
1113 User's Manual}), but PGG (@pxref{Top, ,PGG, pgg, PGG Manual}) and
1114 Mailcrypt are also supported.  @xref{PGP Compatibility}.
1116 @cindex gpg-agent
1117 Message internally calls GnuPG (the @command{gpg} command) to perform
1118 data encryption, and in certain cases (decrypting or signing for
1119 example), @command{gpg} requires user's passphrase.  Currently the
1120 recommended way to supply your passphrase to @command{gpg} is to use the
1121 @command{gpg-agent} program.
1123 To use @command{gpg-agent} in Emacs, you need to run the following
1124 command from the shell before starting Emacs.
1126 @example
1127 eval `gpg-agent --daemon`
1128 @end example
1130 This will invoke @command{gpg-agent} and set the environment variable
1131 @code{GPG_AGENT_INFO} to allow @command{gpg} to communicate with it.
1132 It might be good idea to put this command in your @file{.xsession} or
1133 @file{.bash_profile}.  @xref{Invoking GPG-AGENT, , , gnupg, Using the
1134 GNU Privacy Guard}.
1136 Once your @command{gpg-agent} is set up, it will ask you for a
1137 passphrase as needed for @command{gpg}.  Under the X Window System,
1138 you will see a new passphrase input dialog appear.  The dialog is
1139 provided by PIN Entry (the @command{pinentry} command), and as of
1140 version 0.7.2, @command{pinentry} cannot cooperate with Emacs on a
1141 single tty.  So, if you are using a text console, you may need to put
1142 a passphrase into gpg-agent's cache beforehand.  The following command
1143 does the trick.
1145 @example
1146 gpg --use-agent --sign < /dev/null > /dev/null
1147 @end example
1149 @node PGP Compatibility
1150 @subsection Compatibility with older implementations
1152 @vindex gpg-temp-directory
1153 Note, if you are using the @code{gpg.el} you must make sure that the
1154 directory specified by @code{gpg-temp-directory} have permissions
1155 0700.
1157 Creating your own key is described in detail in the documentation of
1158 your PGP implementation, so we refer to it.
1160 If you have imported your old PGP 2.x key into GnuPG, and want to send
1161 signed and encrypted messages to your fellow PGP 2.x users, you'll
1162 discover that the receiver cannot understand what you send. One
1163 solution is to use PGP 2.x instead (e.g., if you use @code{pgg}, set
1164 @code{pgg-default-scheme} to @code{pgp}). You could also convince your
1165 fellow PGP 2.x users to convert to GnuPG@.
1166 @vindex mml-signencrypt-style-alist
1167 As a final workaround, you can make the sign and encryption work in
1168 two steps; separately sign, then encrypt a message.  If you would like
1169 to change this behavior you can customize the
1170 @code{mml-signencrypt-style-alist} variable.  For example:
1172 @lisp
1173 (setq mml-signencrypt-style-alist '(("smime" separate)
1174                                     ("pgp" separate)
1175                                     ("pgpauto" separate)
1176                                     ("pgpmime" separate)))
1177 @end lisp
1179 This causes to sign and encrypt in two passes, thus generating a
1180 message that can be understood by PGP version 2.
1182 (Refer to @uref{http://www.gnupg.org/gph/en/pgp2x.html} for more
1183 information about the problem.)
1185 @node Various Commands
1186 @section Various Commands
1188 @table @kbd
1190 @item C-c C-r
1191 @kindex C-c C-r
1192 @findex message-caesar-buffer-body
1193 Caesar rotate (aka. rot13) the current message
1194 (@code{message-caesar-buffer-body}).  If narrowing is in effect, just
1195 rotate the visible portion of the buffer.  A numerical prefix says how
1196 many places to rotate the text.  The default is 13.
1198 @item C-c C-e
1199 @kindex C-c C-e
1200 @findex message-elide-region
1201 @vindex message-elide-ellipsis
1202 Elide the text between point and mark (@code{message-elide-region}).
1203 The text is killed and replaced with the contents of the variable
1204 @code{message-elide-ellipsis}.  The default value is to use an ellipsis
1205 (@samp{[...]}).
1207 This is a format-spec string, and you can use @samp{%l} to say how
1208 many lines were removed, and @samp{%c} to say how many characters were
1209 removed.
1211 @item C-c M-k
1212 @kindex C-c M-k
1213 @findex message-kill-address
1214 Kill the address under point.
1216 @item C-c C-z
1217 @kindex C-c C-z
1218 @findex message-kill-to-signature
1219 Kill all the text up to the signature, or if that's missing, up to the
1220 end of the message (@code{message-kill-to-signature}).
1222 @item C-c C-v
1223 @kindex C-c C-v
1224 @findex message-delete-not-region
1225 Delete all text in the body of the message that is outside the region
1226 (@code{message-delete-not-region}).
1228 @item M-RET
1229 @kindex M-RET
1230 @findex message-newline-and-reformat
1231 Insert four newlines, and then reformat if inside quoted text.
1233 Here's an example:
1235 @example
1236 > This is some quoted text.  And here's more quoted text.
1237 @end example
1239 If point is before @samp{And} and you press @kbd{M-RET}, you'll get:
1241 @example
1242 > This is some quoted text.
1246 > And here's more quoted text.
1247 @end example
1249 @samp{*} says where point will be placed.
1251 @item C-c M-r
1252 @kindex C-c M-r
1253 @findex message-rename-buffer
1254 Rename the buffer (@code{message-rename-buffer}).  If given a prefix,
1255 prompt for a new buffer name.
1257 @item TAB
1258 @kindex TAB
1259 @findex message-tab
1260 @vindex message-tab-body-function
1261 If @code{message-tab-body-function} is non-@code{nil}, execute the
1262 function it specifies.  Otherwise use the function bound to @kbd{TAB} in
1263 @code{text-mode-map} or @code{global-map}.
1265 @end table
1268 @node Sending
1269 @section Sending
1271 @table @kbd
1272 @item C-c C-c
1273 @kindex C-c C-c
1274 @findex message-send-and-exit
1275 Send the message and bury the current buffer
1276 (@code{message-send-and-exit}).
1278 @item C-c C-s
1279 @kindex C-c C-s
1280 @findex message-send
1281 Send the message (@code{message-send}).
1283 @item C-c C-d
1284 @kindex C-c C-d
1285 @findex message-dont-send
1286 Bury the message buffer and exit (@code{message-dont-send}).
1288 @item C-c C-k
1289 @kindex C-c C-k
1290 @findex message-kill-buffer
1291 Kill the message buffer and exit (@code{message-kill-buffer}).
1293 @end table
1297 @node Mail Aliases
1298 @section Mail Aliases
1299 @cindex mail aliases
1300 @cindex aliases
1301 @cindex completion
1302 @cindex ecomplete
1304 @vindex message-mail-alias-type
1305 The @code{message-mail-alias-type} variable controls what type of mail
1306 alias expansion to use.  Currently two forms are supported:
1307 @code{mailabbrev} and @code{ecomplete}.  If this variable is
1308 @code{nil}, no mail alias expansion will be performed.
1310 @code{mailabbrev} works by parsing the @file{/etc/mailrc} and
1311 @file{~/.mailrc} files.  These files look like:
1313 @example
1314 alias lmi "Lars Magne Ingebrigtsen <larsi@@ifi.uio.no>"
1315 alias ding "ding@@ifi.uio.no (ding mailing list)"
1316 @end example
1318 After adding lines like this to your @file{~/.mailrc} file, you should
1319 be able to just write @samp{lmi} in the @code{To} or @code{Cc} (and so
1320 on) headers and press @kbd{SPC} to expand the alias.
1322 No expansion will be performed upon sending of the message---all
1323 expansions have to be done explicitly.
1325 If you're using @code{ecomplete}, all addresses from @code{To} and
1326 @code{Cc} headers will automatically be put into the
1327 @file{~/.ecompleterc} file.  When you enter text in the @code{To} and
1328 @code{Cc} headers, @code{ecomplete} will check out the values stored
1329 there and ``electrically'' say what completions are possible.  To
1330 choose one of these completions, use the @kbd{M-n} command to move
1331 down to the list.  Use @kbd{M-n} and @kbd{M-p} to move down and up the
1332 list, and @kbd{RET} to choose a completion.
1334 @node Spelling
1335 @section Spelling
1336 @cindex spelling
1337 @findex ispell-message
1339 There are two popular ways to have Emacs spell-check your messages:
1340 @code{ispell} and @code{flyspell}.  @code{ispell} is the older and
1341 probably more popular package.  You typically first write the message,
1342 and then run the entire thing through @code{ispell} and fix all the
1343 typos.  To have this happen automatically when you send a message, put
1344 something like the following in your @file{.emacs} file:
1346 @lisp
1347 (add-hook 'message-send-hook 'ispell-message)
1348 @end lisp
1350 @vindex ispell-message-dictionary-alist
1351 If you're in the habit of writing in different languages, this can be
1352 controlled by the @code{ispell-message-dictionary-alist} variable:
1354 @lisp
1355 (setq ispell-message-dictionary-alist
1356       '(("^Newsgroups:.*\\bde\\." . "deutsch8")
1357         (".*" . "default")))
1358 @end lisp
1360 @code{ispell} depends on having the external @samp{ispell} command
1361 installed.
1363 The other popular method is using @code{flyspell}.  This package checks
1364 your spelling while you're writing, and marks any mis-spelled words in
1365 various ways.
1367 To use @code{flyspell}, put something like the following in your
1368 @file{.emacs} file:
1370 @lisp
1371 (defun my-message-setup-routine ()
1372   (flyspell-mode 1))
1373 (add-hook 'message-setup-hook 'my-message-setup-routine)
1374 @end lisp
1376 @code{flyspell} depends on having the external @samp{ispell} command
1377 installed.
1380 @node Variables
1381 @chapter Variables
1383 @menu
1384 * Message Headers::             General message header stuff.
1385 * Mail Headers::                Customizing mail headers.
1386 * Mail Variables::              Other mail variables.
1387 * News Headers::                Customizing news headers.
1388 * News Variables::              Other news variables.
1389 * Insertion Variables::         Customizing how things are inserted.
1390 * Various Message Variables::   Other message variables.
1391 * Sending Variables::           Variables for sending.
1392 * Message Buffers::             How Message names its buffers.
1393 * Message Actions::             Actions to be performed when exiting.
1394 @end menu
1397 @node Message Headers
1398 @section Message Headers
1400 Message is quite aggressive on the message generation front.  It has to
1401 be---it's a combined news and mail agent.  To be able to send combined
1402 messages, it has to generate all headers itself (instead of letting the
1403 mail/news system do it) to ensure that mail and news copies of messages
1404 look sufficiently similar.
1406 @table @code
1408 @item message-generate-headers-first
1409 @vindex message-generate-headers-first
1410 If @code{t}, generate all required headers before starting to
1411 compose the message.  This can also be a list of headers to generate:
1413 @lisp
1414 (setq message-generate-headers-first
1415       '(References))
1416 @end lisp
1418 @vindex message-required-headers
1419 The variables @code{message-required-headers},
1420 @code{message-required-mail-headers} and
1421 @code{message-required-news-headers} specify which headers are
1422 required.
1424 Note that some headers will be removed and re-generated before posting,
1425 because of the variable @code{message-deletable-headers} (see below).
1427 @item message-draft-headers
1428 @vindex message-draft-headers
1429 When running Message from Gnus, the message buffers are associated
1430 with a draft group.  @code{message-draft-headers} says which headers
1431 should be generated when a draft is written to the draft group.
1433 @item message-from-style
1434 @vindex message-from-style
1435 Specifies how @code{From} headers should look.  There are four valid
1436 values:
1438 @table @code
1439 @item nil
1440 Just the address---@samp{king@@grassland.com}.
1442 @item parens
1443 @samp{king@@grassland.com (Elvis Parsley)}.
1445 @item angles
1446 @samp{Elvis Parsley <king@@grassland.com>}.
1448 @item default
1449 Look like @code{angles} if that doesn't require quoting, and
1450 @code{parens} if it does.  If even @code{parens} requires quoting, use
1451 @code{angles} anyway.
1453 @end table
1455 @item message-deletable-headers
1456 @vindex message-deletable-headers
1457 Headers in this list that were previously generated by Message will be
1458 deleted before posting.  Let's say you post an article.  Then you decide
1459 to post it again to some other group, you naughty boy, so you jump back
1460 to the @file{*post-buf*} buffer, edit the @code{Newsgroups} line, and
1461 ship it off again.  By default, this variable makes sure that the old
1462 generated @code{Message-ID} is deleted, and a new one generated.  If
1463 this isn't done, the entire empire would probably crumble, anarchy would
1464 prevail, and cats would start walking on two legs and rule the world.
1465 Allegedly.
1467 @item message-default-headers
1468 @vindex message-default-headers
1469 Header lines to be inserted in outgoing messages before you edit the
1470 message, so you can edit or delete their lines. If set to a string, it
1471 is directly inserted. If set to a function, it is called and its
1472 result is inserted.
1474 @item message-subject-re-regexp
1475 @vindex message-subject-re-regexp
1476 @cindex Aw
1477 @cindex Sv
1478 @cindex Re
1479 Responses to messages have subjects that start with @samp{Re: }.  This
1480 is @emph{not} an abbreviation of the English word ``response'', but is
1481 Latin, and means ``in response to''.  Some illiterate nincompoops have
1482 failed to grasp this fact, and have ``internationalized'' their software
1483 to use abominations like @samp{Aw: } (``antwort'') or @samp{Sv: }
1484 (``svar'') instead, which is meaningless and evil.  However, you may
1485 have to deal with users that use these evil tools, in which case you may
1486 set this variable to a regexp that matches these prefixes.  Myself, I
1487 just throw away non-compliant mail.
1489 Here's an example of a value to deal with these headers when
1490 responding to a message:
1492 @lisp
1493 (setq message-subject-re-regexp
1494       (concat
1495        "^[ \t]*"
1496          "\\("
1497            "\\("
1498              "[Aa][Nn][Tt][Ww]\\.?\\|"     ; antw
1499              "[Aa][Ww]\\|"                 ; aw
1500              "[Ff][Ww][Dd]?\\|"            ; fwd
1501              "[Oo][Dd][Pp]\\|"             ; odp
1502              "[Rr][Ee]\\|"                 ; re
1503              "[Rr][\311\351][Ff]\\.?\\|"   ; ref
1504              "[Ss][Vv]"                    ; sv
1505            "\\)"
1506            "\\(\\[[0-9]*\\]\\)"
1507            "*:[ \t]*"
1508          "\\)"
1509        "*[ \t]*"
1510        ))
1511 @end lisp
1513 @item message-subject-trailing-was-query
1514 @vindex message-subject-trailing-was-query
1515 @vindex message-subject-trailing-was-ask-regexp
1516 @vindex message-subject-trailing-was-regexp
1517 Controls what to do with trailing @samp{(was: <old subject>)} in subject
1518 lines.  If @code{nil}, leave the subject unchanged.  If it is the symbol
1519 @code{ask}, query the user what to do.  In this case, the subject is
1520 matched against @code{message-subject-trailing-was-ask-regexp}.  If
1521 @code{message-subject-trailing-was-query} is @code{t}, always strip the
1522 trailing old subject.  In this case,
1523 @code{message-subject-trailing-was-regexp} is used.
1525 @item message-alternative-emails
1526 @vindex message-alternative-emails
1527 Regexp matching alternative email addresses.  The first address in the
1528 To, Cc or From headers of the original article matching this variable is
1529 used as the From field of outgoing messages, replacing the default From
1530 value.
1532 For example, if you have two secondary email addresses john@@home.net
1533 and john.doe@@work.com and want to use them in the From field when
1534 composing a reply to a message addressed to one of them, you could set
1535 this variable like this:
1537 @lisp
1538 (setq message-alternative-emails
1539       (regexp-opt '("john@@home.net" "john.doe@@work.com")))
1540 @end lisp
1542 This variable has precedence over posting styles and anything that runs
1543 off @code{message-setup-hook}.
1545 @item message-allow-no-recipients
1546 @vindex message-allow-no-recipients
1547 Specifies what to do when there are no recipients other than
1548 @code{Gcc} or @code{Fcc}.  If it is @code{always}, the posting is
1549 allowed.  If it is @code{never}, the posting is not allowed.  If it is
1550 @code{ask} (the default), you are prompted.
1552 @item message-hidden-headers
1553 @vindex message-hidden-headers
1554 A regexp, a list of regexps, or a list where the first element is
1555 @code{not} and the rest are regexps.  It says which headers to keep
1556 hidden when composing a message.
1558 @lisp
1559 (setq message-hidden-headers
1560       '(not "From" "Subject" "To" "Cc" "Newsgroups"))
1561 @end lisp
1563 Headers are hidden using narrowing, you can use @kbd{M-x widen} to
1564 expose them in the buffer.
1566 @item message-header-synonyms
1567 @vindex message-header-synonyms
1568 A list of lists of header synonyms.  E.g., if this list contains a
1569 member list with elements @code{Cc} and @code{To}, then
1570 @code{message-carefully-insert-headers} will not insert a @code{To}
1571 header when the message is already @code{Cc}ed to the recipient.
1573 @end table
1576 @node Mail Headers
1577 @section Mail Headers
1579 @table @code
1580 @item message-required-mail-headers
1581 @vindex message-required-mail-headers
1582 @xref{News Headers}, for the syntax of this variable.  It is
1583 @code{(From Subject Date (optional . In-Reply-To) Message-ID
1584 (optional . User-Agent))} by default.
1586 @item message-ignored-mail-headers
1587 @vindex message-ignored-mail-headers
1588 Regexp of headers to be removed before mailing.  The default is@*
1589 @samp{^[GF]cc:\\|^Resent-Fcc:\\|^Xref:\\|^X-Draft-From:\\|@*
1590 ^X-Gnus-Agent-Meta-Information:}.
1592 @item message-default-mail-headers
1593 @vindex message-default-mail-headers
1594 This string is inserted at the end of the headers in all message
1595 buffers that are initialized as mail.
1597 @item message-generate-hashcash
1598 @vindex message-generate-hashcash
1599 Variable that indicates whether @samp{X-Hashcash} headers
1600 should be computed for the message.  @xref{Hashcash, ,Hashcash,gnus,
1601 The Gnus Manual}.  If @code{opportunistic}, only generate the headers
1602 when it doesn't lead to the user having to wait.
1604 @end table
1607 @node Mail Variables
1608 @section Mail Variables
1610 @table @code
1611 @item message-send-mail-function
1612 @vindex message-send-mail-function
1613 @findex message-send-mail-function
1614 @findex message-send-mail-with-sendmail
1615 @findex message-send-mail-with-mh
1616 @findex message-send-mail-with-qmail
1617 @findex message-smtpmail-send-it
1618 @findex smtpmail-send-it
1619 @findex feedmail-send-it
1620 @findex message-send-mail-with-mailclient
1621 Function used to send the current buffer as mail.  The default is
1622 @code{message-send-mail-with-sendmail}, or @code{smtpmail-send-it}
1623 according to the system.  Other valid values include
1624 @code{message-send-mail-with-mailclient},
1625 @code{message-send-mail-with-mh}, @code{message-send-mail-with-qmail},
1626 @code{message-smtpmail-send-it} and @code{feedmail-send-it}.
1628 The function
1629 @code{message-send-mail-with-sendmail} pipes your article to the
1630 @code{sendmail} binary for further queuing and sending.  When your local
1631 system is not configured for sending mail using @code{sendmail}, and you
1632 have access to a remote @acronym{SMTP} server, you can set
1633 @code{message-send-mail-function} to @code{smtpmail-send-it} and make
1634 sure to setup the @code{smtpmail} package correctly.  An example:
1636 @lisp
1637 (setq message-send-mail-function 'smtpmail-send-it
1638       smtpmail-default-smtp-server "YOUR SMTP HOST")
1639 @end lisp
1641 To the thing similar to this, there is
1642 @code{message-smtpmail-send-it}.  It is useful if your @acronym{ISP}
1643 requires the @acronym{POP}-before-@acronym{SMTP} authentication.
1644 @xref{POP before SMTP, , POP before SMTP, gnus, The Gnus Manual}.
1646 @cindex X-Message-SMTP-Method
1647 If you have a complex @acronym{SMTP} setup, and want some messages to
1648 go via one mail server, and other messages to go through another, you
1649 can use the @samp{X-Message-SMTP-Method} header.  These are the
1650 supported values:
1652 @table @samp
1653 @item smtpmail
1655 @example
1656 X-Message-SMTP-Method: smtp smtp.fsf.org 587
1657 @end example
1659 This will send the message via @samp{smtp.fsf.org}, using port 587.
1661 @example
1662 X-Message-SMTP-Method: smtp smtp.fsf.org 587 other-user
1663 @end example
1665 This is the same as the above, but uses @samp{other-user} as the user
1666 name when authenticating.  This is handy if you have several
1667 @acronym{SMTP} accounts on the same server.
1669 @item sendmail
1671 @example
1672 X-Message-SMTP-Method: sendmail
1673 @end example
1675 This will send the message via the locally installed sendmail/exim/etc
1676 installation.
1678 @end table
1680 @item message-mh-deletable-headers
1681 @vindex message-mh-deletable-headers
1682 Most versions of MH doesn't like being fed messages that contain the
1683 headers in this variable.  If this variable is non-@code{nil} (which is
1684 the default), these headers will be removed before mailing when sending
1685 messages via MH@.  Set it to @code{nil} if your MH can handle these
1686 headers.
1688 @item message-qmail-inject-program
1689 @vindex message-qmail-inject-program
1690 @cindex qmail
1691 Location of the qmail-inject program.
1693 @item message-qmail-inject-args
1694 @vindex message-qmail-inject-args
1695 Arguments passed to qmail-inject programs.
1696 This should be a list of strings, one string for each argument.  It
1697 may also be a function.
1699 E.g., if you wish to set the envelope sender address so that bounces
1700 go to the right place or to deal with listserv's usage of that address, you
1701 might set this variable to @code{'("-f" "you@@some.where")}.
1703 @item message-sendmail-f-is-evil
1704 @vindex message-sendmail-f-is-evil
1705 @cindex sendmail
1706 Non-@code{nil} means don't add @samp{-f username} to the sendmail
1707 command line.  Doing so would be even more evil than leaving it out.
1709 @item message-sendmail-envelope-from
1710 @vindex message-sendmail-envelope-from
1711 When @code{message-sendmail-f-is-evil} is @code{nil}, this specifies
1712 the address to use in the @acronym{SMTP} envelope.  If it is
1713 @code{nil}, use @code{user-mail-address}.  If it is the symbol
1714 @code{header}, use the @samp{From} header of the message.
1716 @item message-mailer-swallows-blank-line
1717 @vindex message-mailer-swallows-blank-line
1718 Set this to non-@code{nil} if the system's mailer runs the header and
1719 body together.  (This problem exists on SunOS 4 when sendmail is run
1720 in remote mode.)  The value should be an expression to test whether
1721 the problem will actually occur.
1723 @item message-send-mail-partially-limit
1724 @vindex message-send-mail-partially-limit
1725 @cindex split large message
1726 The limitation of messages sent as message/partial.  The lower bound
1727 of message size in characters, beyond which the message should be sent
1728 in several parts.  If it is @code{nil} (which is the default), the
1729 size is unlimited.
1731 @end table
1734 @node News Headers
1735 @section News Headers
1737 @vindex message-required-news-headers
1738 @code{message-required-news-headers} a list of header symbols.  These
1739 headers will either be automatically generated, or, if that's
1740 impossible, they will be prompted for.  The following symbols are valid:
1742 @table @code
1744 @item From
1745 @cindex From
1746 @findex user-full-name
1747 @findex user-mail-address
1748 This required header will be filled out with the result of the
1749 @code{message-make-from} function, which depends on the
1750 @code{message-from-style}, @code{user-full-name},
1751 @code{user-mail-address} variables.
1753 @item Subject
1754 @cindex Subject
1755 This required header will be prompted for if not present already.
1757 @item Newsgroups
1758 @cindex Newsgroups
1759 This required header says which newsgroups the article is to be posted
1760 to.  If it isn't present already, it will be prompted for.
1762 @item Organization
1763 @cindex organization
1764 @vindex message-user-organization
1765 @vindex message-user-organization-file
1766 This optional header will be filled out depending on the
1767 @code{message-user-organization} variable.
1768 @code{message-user-organization-file} will be used if this variable is
1769 @code{t}.  This variable can also be a string (in which case this string
1770 will be used), or it can be a function (which will be called with no
1771 parameters and should return a string to be used).
1773 @item Lines
1774 @cindex Lines
1775 This optional header will be computed by Message.
1777 @item Message-ID
1778 @cindex Message-ID
1779 @vindex message-user-fqdn
1780 @vindex mail-host-address
1781 @vindex user-mail-address
1782 @findex system-name
1783 @cindex Sun
1784 @cindex i-did-not-set--mail-host-address--so-tickle-me
1785 This required header will be generated by Message.  A unique ID will be
1786 created based on the date, time, user name (for the local part) and the
1787 domain part.  For the domain part, message will look (in this order) at
1788 @code{message-user-fqdn}, @code{system-name}, @code{mail-host-address}
1789 and @code{message-user-mail-address} (i.e., @code{user-mail-address})
1790 until a probably valid fully qualified domain name (FQDN) was found.
1792 @item User-Agent
1793 @cindex User-Agent
1794 This optional header will be filled out according to the
1795 @code{message-newsreader} local variable.
1797 @item In-Reply-To
1798 This optional header is filled out using the @code{Date} and @code{From}
1799 header of the article being replied to.
1801 @item Expires
1802 @cindex Expires
1803 @vindex message-expires
1804 This extremely optional header will be inserted according to the
1805 @code{message-expires} variable.  It is highly deprecated and shouldn't
1806 be used unless you know what you're doing.
1808 @item Distribution
1809 @cindex Distribution
1810 @vindex message-distribution-function
1811 This optional header is filled out according to the
1812 @code{message-distribution-function} variable.  It is a deprecated and
1813 much misunderstood header.
1815 @item Path
1816 @cindex path
1817 @vindex message-user-path
1818 This extremely optional header should probably never be used.
1819 However, some @emph{very} old servers require that this header is
1820 present.  @code{message-user-path} further controls how this
1821 @code{Path} header is to look.  If it is @code{nil}, use the server name
1822 as the leaf node.  If it is a string, use the string.  If it is neither
1823 a string nor @code{nil}, use the user name only.  However, it is highly
1824 unlikely that you should need to fiddle with this variable at all.
1825 @end table
1827 @cindex Mime-Version
1828 In addition, you can enter conses into this list.  The @sc{car} of this cons
1829 should be a symbol.  This symbol's name is the name of the header, and
1830 the @sc{cdr} can either be a string to be entered verbatim as the value of
1831 this header, or it can be a function to be called.  This function should
1832 take no arguments, and return a string to be inserted.  For
1833 instance, if you want to insert @code{Mime-Version: 1.0}, you should
1834 enter @code{(Mime-Version . "1.0")} into the list.
1836 If the list contains a cons where the @sc{car} of the cons is
1837 @code{optional}, the @sc{cdr} of this cons will only be inserted if it is
1838 non-@code{nil}.
1840 If you want to delete an entry from this list, the following Lisp
1841 snippet might be useful.  Adjust accordingly if you want to remove
1842 another element.
1844 @lisp
1845 (setq message-required-news-headers
1846       (delq 'Message-ID message-required-news-headers))
1847 @end lisp
1849 Other variables for customizing outgoing news articles:
1851 @table @code
1853 @item message-syntax-checks
1854 @vindex message-syntax-checks
1855 Controls what syntax checks should not be performed on outgoing posts.
1856 To disable checking of long signatures, for instance, add
1858 @lisp
1859 (signature . disabled)
1860 @end lisp
1862 to this list.
1864 Valid checks are:
1866 @table @code
1867 @item approved
1868 @cindex approved
1869 Check whether the article has an @code{Approved} header, which is
1870 something only moderators should include.
1871 @item continuation-headers
1872 Check whether there are continuation header lines that don't begin with
1873 whitespace.
1874 @item control-chars
1875 Check for invalid characters.
1876 @item empty
1877 Check whether the article is empty.
1878 @item existing-newsgroups
1879 Check whether the newsgroups mentioned in the @code{Newsgroups} and
1880 @code{Followup-To} headers exist.
1881 @item from
1882 Check whether the @code{From} header seems nice.
1883 @item illegible-text
1884 Check whether there is any non-printable character in the body.
1885 @item invisible-text
1886 Check whether there is any invisible text in the buffer.
1887 @item long-header-lines
1888 Check for too long header lines.
1889 @item long-lines
1890 @cindex long lines
1891 Check for too long lines in the body.
1892 @item message-id
1893 Check whether the @code{Message-ID} looks syntactically ok.
1894 @item multiple-headers
1895 Check for the existence of multiple equal headers.
1896 @item new-text
1897 Check whether there is any new text in the messages.
1898 @item newsgroups
1899 Check whether the @code{Newsgroups} header exists and is not empty.
1900 @item quoting-style
1901 Check whether text follows last quoted portion.
1902 @item repeated-newsgroups
1903 Check whether the @code{Newsgroups} and @code{Followup-to} headers
1904 contains repeated group names.
1905 @item reply-to
1906 Check whether the @code{Reply-To} header looks ok.
1907 @item sender
1908 @cindex Sender
1909 Insert a new @code{Sender} header if the @code{From} header looks odd.
1910 @item sendsys
1911 @cindex sendsys
1912 Check for the existence of version and sendsys commands.
1913 @item shoot
1914 Check whether the domain part of the @code{Message-ID} header looks ok.
1915 @item shorten-followup-to
1916 Check whether to add a @code{Followup-to} header to shorten the number
1917 of groups to post to.
1918 @item signature
1919 Check the length of the signature.
1920 @item size
1921 Check for excessive size.
1922 @item subject
1923 Check whether the @code{Subject} header exists and is not empty.
1924 @item subject-cmsg
1925 Check the subject for commands.
1926 @item valid-newsgroups
1927 Check whether the @code{Newsgroups} and @code{Followup-to} headers
1928 are valid syntactically.
1929 @end table
1931 All these conditions are checked by default, except for @code{sender}
1932 for which the check is disabled by default if
1933 @code{message-insert-canlock} is non-@code{nil} (@pxref{Canceling News}).
1935 @item message-ignored-news-headers
1936 @vindex message-ignored-news-headers
1937 Regexp of headers to be removed before posting.  The default is@*
1938 @samp{^NNTP-Posting-Host:\\|^Xref:\\|^[BGF]cc:\\|^Resent-Fcc:\\|@*
1939 ^X-Draft-From:\\|^X-Gnus-Agent-Meta-Information:}.
1941 @item message-default-news-headers
1942 @vindex message-default-news-headers
1943 This string is inserted at the end of the headers in all message
1944 buffers that are initialized as news.
1946 @end table
1949 @node News Variables
1950 @section News Variables
1952 @table @code
1953 @item message-send-news-function
1954 @vindex message-send-news-function
1955 Function used to send the current buffer as news.  The default is
1956 @code{message-send-news}.
1958 @item message-post-method
1959 @vindex message-post-method
1960 Gnusish @dfn{select method} (see the Gnus manual for details) used for
1961 posting a prepared news message.
1963 @end table
1966 @node Insertion Variables
1967 @section Insertion Variables
1969 @table @code
1970 @item message-cite-style
1971 @vindex message-cite-style
1972 The overall style to be used when replying to messages. This controls
1973 things like where the reply should be put relative to the original,
1974 how the citation is formatted, where the signature goes, etc.
1976 Value is either @code{nil} (no variable overrides) or a let-style list
1977 of pairs @code{(VARIABLE VALUE)} to override default values.
1979 See @code{gnus-posting-styles} to set this variable for specific
1980 groups. Presets to impersonate popular mail agents are available in the
1981 @code{message-cite-style-*} variables.
1983 @item message-cite-reply-position
1984 @vindex message-cite-reply-position
1985 Where the reply should be positioned. Available styles are
1986 @code{traditional} to reply inline, @code{above} for top-posting, and
1987 @code{below} for bottom-posting
1989 @item message-ignored-cited-headers
1990 @vindex message-ignored-cited-headers
1991 All headers that match this regexp will be removed from yanked
1992 messages.  The default is @samp{.}, which means that all headers will be
1993 removed.
1995 @item message-cite-prefix-regexp
1996 @vindex message-cite-prefix-regexp
1997 Regexp matching the longest possible citation prefix on a line.
1999 @item message-citation-line-function
2000 @vindex message-citation-line-function
2001 @cindex attribution line
2002 Function called to insert the citation line.  The default is
2003 @code{message-insert-citation-line}, which will lead to citation lines
2004 that look like:
2006 @example
2007 Hallvard B Furuseth <h.b.furuseth@@usit.uio.no> writes:
2008 @end example
2010 @c FIXME: Add `message-insert-formatted-citation-line' and
2011 @c `message-citation-line-format'
2013 Point will be at the beginning of the body of the message when this
2014 function is called.
2016 Note that Gnus provides a feature where clicking on `writes:' hides the
2017 cited text.  If you change the citation line too much, readers of your
2018 messages will have to adjust their Gnus, too.  See the variable
2019 @code{gnus-cite-attribution-suffix}.  @xref{Article Highlighting, ,
2020 Article Highlighting, gnus, The Gnus Manual}, for details.
2022 @item message-yank-prefix
2023 @vindex message-yank-prefix
2024 @cindex yanking
2025 @cindex quoting
2026 When you are replying to or following up an article, you normally want
2027 to quote the person you are answering.  Inserting quoted text is done by
2028 @dfn{yanking}, and each line you yank will have
2029 @code{message-yank-prefix} prepended to it (except for quoted lines
2030 which use @code{message-yank-cited-prefix} and empty lines which use
2031 @code{message-yank-empty-prefix}).  The default is @samp{> }.
2033 @item message-yank-cited-prefix
2034 @vindex message-yank-cited-prefix
2035 @cindex yanking
2036 @cindex cited
2037 @cindex quoting
2038 When yanking text from an article which contains already cited text,
2039 each line will be prefixed with the contents of this variable.  The
2040 default is @samp{>}.  See also @code{message-yank-prefix}.
2042 @item message-yank-empty-prefix
2043 @vindex message-yank-empty-prefix
2044 @cindex yanking
2045 @cindex quoting
2046 When yanking text from an article, each empty line will be prefixed with
2047 the contents of this variable.  The default is @samp{>}.  You can set
2048 this variable to an empty string to split the cited text into paragraphs
2049 automatically.  See also @code{message-yank-prefix}.
2051 @item message-indentation-spaces
2052 @vindex message-indentation-spaces
2053 Number of spaces to indent yanked messages.
2055 @item message-cite-function
2056 @vindex message-cite-function
2057 @findex message-cite-original
2058 @findex message-cite-original-without-signature
2059 Function for citing an original message.  The default is
2060 @code{message-cite-original}, which simply inserts the original message
2061 and prepends @samp{> } to each line.
2062 @code{message-cite-original-without-signature} does the same, but elides
2063 the signature.
2065 @item message-indent-citation-function
2066 @vindex message-indent-citation-function
2067 Function for modifying a citation just inserted in the mail buffer.
2068 This can also be a list of functions.  Each function can find the
2069 citation between @code{(point)} and @code{(mark t)}.  And each function
2070 should leave point and mark around the citation text as modified.
2072 @item message-mark-insert-begin
2073 @vindex message-mark-insert-begin
2074 String to mark the beginning of some inserted text.
2076 @item message-mark-insert-end
2077 @vindex message-mark-insert-end
2078 String to mark the end of some inserted text.
2080 @item message-signature
2081 @vindex message-signature
2082 String to be inserted at the end of the message buffer.  If @code{t}
2083 (which is the default), the @code{message-signature-file} file will be
2084 inserted instead.  If a function, the result from the function will be
2085 used instead.  If a form, the result from the form will be used instead.
2086 If this variable is @code{nil}, no signature will be inserted at all.
2088 @item message-signature-file
2089 @vindex message-signature-file
2090 File containing the signature to be inserted at the end of the buffer.
2091 If a path is specified, the value of
2092 @code{message-signature-directory} is ignored, even if set.
2093 The default is @file{~/.signature}.
2095 @item message-signature-directory
2096 @vindex message-signature-directory
2097 Name of directory containing signature files.  Comes in handy if you
2098 have many such files, handled via Gnus posting styles for instance.
2099 If @code{nil} (the default), @code{message-signature-file} is expected
2100 to specify the directory if needed.
2103 @item message-signature-insert-empty-line
2104 @vindex message-signature-insert-empty-line
2105 If @code{t} (the default value) an empty line is inserted before the
2106 signature separator.
2108 @end table
2110 Note that RFC1036bis says that a signature should be preceded by the three
2111 characters @samp{-- } on a line by themselves.  This is to make it
2112 easier for the recipient to automatically recognize and process the
2113 signature.  So don't remove those characters, even though you might feel
2114 that they ruin your beautiful design, like, totally.
2116 Also note that no signature should be more than four lines long.
2117 Including @acronym{ASCII} graphics is an efficient way to get
2118 everybody to believe that you are silly and have nothing important to
2119 say.
2122 @node Various Message Variables
2123 @section Various Message Variables
2125 @table @code
2126 @item message-default-charset
2127 @vindex message-default-charset
2128 @cindex charset
2129 Symbol naming a @acronym{MIME} charset.  Non-@acronym{ASCII} characters
2130 in messages are assumed to be encoded using this charset.  The default
2131 is @code{iso-8859-1} on non-@sc{mule} Emacsen; otherwise @code{nil},
2132 which means ask the user.  (This variable is used only on non-@sc{mule}
2133 Emacsen.)  @xref{Charset Translation, , Charset Translation, emacs-mime,
2134 Emacs MIME Manual}, for details on the @sc{mule}-to-@acronym{MIME}
2135 translation process.
2137 @item message-fill-column
2138 @vindex message-fill-column
2139 @cindex auto-fill
2140 Local value for the column beyond which automatic line-wrapping should
2141 happen for message buffers.  If non-nil (the default), also turn on
2142 auto-fill in message buffers.
2144 @item message-signature-separator
2145 @vindex message-signature-separator
2146 Regexp matching the signature separator.  It is @samp{^-- *$} by
2147 default.
2149 @item mail-header-separator
2150 @vindex mail-header-separator
2151 String used to separate the headers from the body.  It is @samp{--text
2152 follows this line--} by default.
2154 @item message-directory
2155 @vindex message-directory
2156 Directory used by many mailish things.  The default is @file{~/Mail/}.
2157 All other mail file variables are derived from @code{message-directory}.
2159 @item message-auto-save-directory
2160 @vindex message-auto-save-directory
2161 Directory where Message auto-saves buffers if Gnus isn't running.  If
2162 @code{nil}, Message won't auto-save.  The default is @file{~/Mail/drafts/}.
2164 @item message-signature-setup-hook
2165 @vindex message-signature-setup-hook
2166 Hook run when initializing the message buffer.  It is run after the
2167 headers have been inserted but before the signature has been inserted.
2169 @item message-setup-hook
2170 @vindex message-setup-hook
2171 Hook run as the last thing when the message buffer has been initialized,
2172 but before yanked text is inserted.
2174 @item message-header-setup-hook
2175 @vindex message-header-setup-hook
2176 Hook called narrowed to the headers after initializing the headers.
2178 For instance, if you're running Gnus and wish to insert a
2179 @samp{Mail-Copies-To} header in all your news articles and all messages
2180 you send to mailing lists, you could do something like the following:
2182 @lisp
2183 (defun my-message-header-setup-hook ()
2184   (let ((group (or gnus-newsgroup-name "")))
2185     (when (or (message-fetch-field "newsgroups")
2186               (gnus-group-find-parameter group 'to-address)
2187               (gnus-group-find-parameter group 'to-list))
2188       (insert "Mail-Copies-To: never\n"))))
2190 (add-hook 'message-header-setup-hook
2191           'my-message-header-setup-hook)
2192 @end lisp
2194 @item message-send-hook
2195 @vindex message-send-hook
2196 Hook run before sending messages.
2198 If you want to add certain headers before sending, you can use the
2199 @code{message-add-header} function in this hook.  For instance:
2200 @findex message-add-header
2202 @lisp
2203 (add-hook 'message-send-hook 'my-message-add-content)
2204 (defun my-message-add-content ()
2205   (message-add-header "X-In-No-Sense: Nonsense")
2206   (message-add-header "X-Whatever: no"))
2207 @end lisp
2209 This function won't add the header if the header is already present.
2211 @item message-send-mail-hook
2212 @vindex message-send-mail-hook
2213 Hook run before sending mail messages.  This hook is run very late:
2214 just before the message is actually sent as mail.
2216 @item message-send-news-hook
2217 @vindex message-send-news-hook
2218 Hook run before sending news messages.  This hook is run very late:
2219 just before the message is actually sent as news.
2221 @item message-sent-hook
2222 @vindex message-sent-hook
2223 Hook run after sending messages.
2225 @item message-cancel-hook
2226 @vindex message-cancel-hook
2227 Hook run when canceling news articles.
2229 @item message-mode-syntax-table
2230 @vindex message-mode-syntax-table
2231 Syntax table used in message mode buffers.
2233 @item message-cite-articles-with-x-no-archive
2234 @vindex message-cite-articles-with-x-no-archive
2235 If non-@code{nil}, don't strip quoted text from articles that have
2236 @samp{X-No-Archive} set.  Even if this variable isn't set, you can
2237 undo the stripping by hitting the @code{undo} keystroke.
2239 @item message-strip-special-text-properties
2240 @vindex message-strip-special-text-properties
2241 Emacs has a number of special text properties which can break message
2242 composing in various ways.  If this option is set, message will strip
2243 these properties from the message composition buffer.  However, some
2244 packages requires these properties to be present in order to work.  If
2245 you use one of these packages, turn this option off, and hope the
2246 message composition doesn't break too bad.
2248 @item message-send-method-alist
2249 @vindex message-send-method-alist
2250 @findex message-mail-p
2251 @findex message-news-p
2252 @findex message-send-via-mail
2253 @findex message-send-via-news
2254 Alist of ways to send outgoing messages.  Each element has the form:
2256 @lisp
2257 (@var{type} @var{predicate} @var{function})
2258 @end lisp
2260 @table @var
2261 @item type
2262 A symbol that names the method.
2264 @item predicate
2265 A function called without any parameters to determine whether the
2266 message is a message of type @var{type}.  The function will be called in
2267 the buffer where the message is.
2269 @item function
2270 A function to be called if @var{predicate} returns non-@code{nil}.
2271 @var{function} is called with one parameter---the prefix.
2272 @end table
2274 The default is:
2276 @lisp
2277 ((news message-news-p message-send-via-news)
2278  (mail message-mail-p message-send-via-mail))
2279 @end lisp
2281 The @code{message-news-p} function returns non-@code{nil} if the message
2282 looks like news, and the @code{message-send-via-news} function sends the
2283 message according to the @code{message-send-news-function} variable
2284 (@pxref{News Variables}).  The @code{message-mail-p} function returns
2285 non-@code{nil} if the message looks like mail, and the
2286 @code{message-send-via-mail} function sends the message according to the
2287 @code{message-send-mail-function} variable (@pxref{Mail Variables}).
2289 All the elements in this alist will be tried in order, so a message
2290 containing both a valid @samp{Newsgroups} header and a valid @samp{To}
2291 header, for example, will be sent as news, and then as mail.
2292 @end table
2296 @node Sending Variables
2297 @section Sending Variables
2299 @table @code
2301 @item message-fcc-handler-function
2302 @vindex message-fcc-handler-function
2303 A function called to save outgoing articles.  This function will be
2304 called with the name of the file to store the article in.  The default
2305 function is @code{message-output} which saves in Unix mailbox format.
2307 @item message-courtesy-message
2308 @vindex message-courtesy-message
2309 When sending combined messages, this string is inserted at the start of
2310 the mailed copy.  If the string contains the format spec @samp{%s}, the
2311 newsgroups the article has been posted to will be inserted there.  If
2312 this variable is @code{nil}, no such courtesy message will be added.
2313 The default value is @samp{"The following message is a courtesy copy of
2314 an article\\nthat has been posted to %s as well.\\n\\n"}.
2316 @item message-fcc-externalize-attachments
2317 @vindex message-fcc-externalize-attachments
2318 If @code{nil}, attach files as normal parts in Fcc copies; if it is
2319 non-@code{nil}, attach local files as external parts.
2321 @item message-interactive
2322 @vindex message-interactive
2323 If non-@code{nil} wait for and display errors when sending a message;
2324 if @code{nil} let the mailer mail back a message to report errors.
2326 @item message-confirm-send
2327 @vindex message-confirm-send
2328 When non-@code{nil}, Gnus will ask for confirmation when sending a
2329 message.
2331 @end table
2334 @node Message Buffers
2335 @section Message Buffers
2337 Message will generate new buffers with unique buffer names when you
2338 request a message buffer.  When you send the message, the buffer isn't
2339 normally killed off.  Its name is changed and a certain number of old
2340 message buffers are kept alive.
2342 @table @code
2343 @item message-generate-new-buffers
2344 @vindex message-generate-new-buffers
2345 Controls whether to create a new message buffer to compose a message.
2346 Valid values include:
2348 @table @code
2349 @item nil
2350 Generate the buffer name in the Message way (e.g., *mail*, *news*, *mail
2351 to whom*, *news on group*, etc.)@: and continue editing in the existing
2352 buffer of that name.  If there is no such buffer, it will be newly
2353 created.
2355 @item unique
2356 @item t
2357 Create the new buffer with the name generated in the Message way.
2359 @item unsent
2360 Similar to @code{unique} but the buffer name begins with "*unsent ".
2362 @item standard
2363 Similar to @code{nil} but the buffer name is simpler like *mail
2364 message*.
2365 @end table
2366 @table @var
2367 @item function
2368 If this is a function, call that function with three parameters: The
2369 type, the To address and the group name (any of these may be
2370 @code{nil}).  The function should return the new buffer name.
2371 @end table
2373 The default value is @code{unsent}.
2375 @item message-max-buffers
2376 @vindex message-max-buffers
2377 This variable says how many old message buffers to keep.  If there are
2378 more message buffers than this, the oldest buffer will be killed.  The
2379 default is 10.  If this variable is @code{nil}, no old message buffers
2380 will ever be killed.
2382 @item message-send-rename-function
2383 @vindex message-send-rename-function
2384 After sending a message, the buffer is renamed from, for instance,
2385 @samp{*reply to Lars*} to @samp{*sent reply to Lars*}.  If you don't
2386 like this, set this variable to a function that renames the buffer in a
2387 manner you like.  If you don't want to rename the buffer at all, you can
2388 say:
2390 @lisp
2391 (setq message-send-rename-function 'ignore)
2392 @end lisp
2394 @item message-kill-buffer-on-exit
2395 @findex message-kill-buffer-on-exit
2396 If non-@code{nil}, kill the buffer immediately on exit.
2398 @end table
2401 @node Message Actions
2402 @section Message Actions
2404 When Message is being used from a news/mail reader, the reader is likely
2405 to want to perform some task after the message has been sent.  Perhaps
2406 return to the previous window configuration or mark an article as
2407 replied.
2409 @vindex message-kill-actions
2410 @vindex message-postpone-actions
2411 @vindex message-exit-actions
2412 @vindex message-send-actions
2413 The user may exit from the message buffer in various ways.  The most
2414 common is @kbd{C-c C-c}, which sends the message and exits.  Other
2415 possibilities are @kbd{C-c C-s} which just sends the message, @kbd{C-c
2416 C-d} which postpones the message editing and buries the message buffer,
2417 and @kbd{C-c C-k} which kills the message buffer.  Each of these actions
2418 have lists associated with them that contains actions to be executed:
2419 @code{message-send-actions}, @code{message-exit-actions},
2420 @code{message-postpone-actions}, and @code{message-kill-actions}.
2422 Message provides a function to interface with these lists:
2423 @code{message-add-action}.  The first parameter is the action to be
2424 added, and the rest of the arguments are which lists to add this action
2425 to.  Here's an example from Gnus:
2427 @lisp
2428   (message-add-action
2429    `(set-window-configuration ,(current-window-configuration))
2430    'exit 'postpone 'kill)
2431 @end lisp
2433 This restores the Gnus window configuration when the message buffer is
2434 killed, postponed or exited.
2436 An @dfn{action} can be either: a normal function, or a list where the
2437 @sc{car} is a function and the @sc{cdr} is the list of arguments, or
2438 a form to be @code{eval}ed.
2441 @node Compatibility
2442 @chapter Compatibility
2443 @cindex compatibility
2445 Message uses virtually only its own variables---older @code{mail-}
2446 variables aren't consulted.  To force Message to take those variables
2447 into account, you can put the following in your @file{.emacs} file:
2449 @lisp
2450 (require 'messcompat)
2451 @end lisp
2453 This will initialize many Message variables from the values in the
2454 corresponding mail variables.
2457 @node Appendices
2458 @chapter Appendices
2460 @menu
2461 * Responses::          Standard rules for determining where responses go.
2462 @end menu
2465 @node Responses
2466 @section Responses
2468 To determine where a message is to go, the following algorithm is used
2469 by default.
2471 @table @dfn
2472 @item reply
2473 A @dfn{reply} is when you want to respond @emph{just} to the person who
2474 sent the message via mail.  There will only be one recipient.  To
2475 determine who the recipient will be, the following headers are
2476 consulted, in turn:
2478 @table @code
2479 @item Reply-To
2481 @item From
2482 @end table
2485 @item wide reply
2486 A @dfn{wide reply} is a mail response that includes @emph{all} entities
2487 mentioned in the message you are responding to.  All mailboxes from the
2488 following headers will be concatenated to form the outgoing
2489 @code{To}/@code{Cc} headers:
2491 @table @code
2492 @item From
2493 (unless there's a @code{Reply-To}, in which case that is used instead).
2495 @item Cc
2497 @item To
2498 @end table
2500 If a @code{Mail-Copies-To} header is present, it will also be included
2501 in the list of mailboxes.  If this header is @samp{never}, that means
2502 that the @code{From} (or @code{Reply-To}) mailbox will be suppressed.
2505 @item followup
2506 A @dfn{followup} is a response sent via news.  The following headers
2507 (listed in order of precedence) determine where the response is to be
2508 sent:
2510 @table @code
2512 @item Followup-To
2514 @item Newsgroups
2516 @end table
2518 If a @code{Mail-Copies-To} header is present, it will be used as the
2519 basis of the new @code{Cc} header, except if this header is
2520 @samp{never}.
2522 @end table
2525 @node GNU Free Documentation License
2526 @chapter GNU Free Documentation License
2527 @include doclicense.texi
2529 @node Index
2530 @chapter Index
2531 @printindex cp
2533 @node Key Index
2534 @chapter Key Index
2535 @printindex ky
2537 @bye
2539 @c End: