1 \input texinfo @c -*-texinfo-*-
4 @settitle Message (Oort) Manual
10 * Message: (message). Mail and news composition mode that goes with Gnus.
15 @setchapternewpage odd
19 This file documents Message, the Emacs message composition mode.
21 Copyright (C) 1996, 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
23 Permission is granted to copy, distribute and/or modify this document
24 under the terms of the GNU Free Documentation License, Version 1.1 or
25 any later version published by the Free Software Foundation; with no
26 Invariant Sections, with the Front-Cover texts being ``A GNU
27 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
28 license is included in the section entitled ``GNU Free Documentation
29 License'' in the Emacs manual.
31 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
32 this GNU Manual, like GNU software. Copies published by the Free
33 Software Foundation raise funds for GNU development.''
35 This document is part of a collection distributed under the GNU Free
36 Documentation License. If you want to distribute this document
37 separately from the collection, you can do so by adding a copy of the
38 license to the document, as described in section 6 of the license.
44 @title Message (Oort) Manual
46 @author by Lars Magne Ingebrigtsen
49 @vskip 0pt plus 1filll
50 Copyright @copyright{} 1996, 1997, 1998, 1999, 2000
51 Free Software Foundation, Inc.
53 Permission is granted to copy, distribute and/or modify this document
54 under the terms of the GNU Free Documentation License, Version 1.1 or
55 any later version published by the Free Software Foundation; with the
56 Invariant Sections being none, with the Front-Cover texts being ``A GNU
57 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
58 license is included in the section entitled ``GNU Free Documentation
59 License'' in the Emacs manual.
61 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
62 this GNU Manual, like GNU software. Copies published by the Free
63 Software Foundation raise funds for GNU development.''
65 This document is part of a collection distributed under the GNU Free
66 Documentation License. If you want to distribute this document
67 separately from the collection, you can do so by adding a copy of the
68 license to the document, as described in section 6 of the license.
77 All message composition from Gnus (both mail and news) takes place in
81 * Interface:: Setting up message buffers.
82 * Commands:: Commands you can execute in message mode buffers.
83 * Variables:: Customizing the message buffers.
84 * Compatibility:: Making Message backwards compatible.
85 * Appendices:: More technical things.
86 * Index:: Variable, function and concept index.
87 * Key Index:: List of Message mode keys.
90 This manual corresponds to Oort Message. Message is distributed with
91 the Gnus distribution bearing the same version number as this manual.
97 When a program (or a person) wants to respond to a message -- reply,
98 follow up, forward, cancel -- the program (or person) should just put
99 point in the buffer where the message is and call the required command.
100 @code{Message} will then pop up a new @code{message} mode buffer with
101 appropriate headers filled out, and the user can edit the message before
105 * New Mail Message:: Editing a brand new mail message.
106 * New News Message:: Editing a brand new news message.
107 * Reply:: Replying via mail.
108 * Wide Reply:: Responding to all people via mail.
109 * Followup:: Following up via news.
110 * Canceling News:: Canceling a news article.
111 * Superseding:: Superseding a message.
112 * Forwarding:: Forwarding a message via news or mail.
113 * Resending:: Resending a mail message.
114 * Bouncing:: Bouncing a mail message.
118 @node New Mail Message
119 @section New Mail Message
122 The @code{message-mail} command pops up a new message buffer.
124 Two optional parameters are accepted: The first will be used as the
125 @code{To} header and the second as the @code{Subject} header. If these
126 are @code{nil}, those two headers will be empty.
129 @node New News Message
130 @section New News Message
133 The @code{message-news} command pops up a new message buffer.
135 This function accepts two optional parameters. The first will be used
136 as the @code{Newsgroups} header and the second as the @code{Subject}
137 header. If these are @code{nil}, those two headers will be empty.
143 @findex message-reply
144 The @code{message-reply} function pops up a message buffer that's a
145 reply to the message in the current buffer.
147 @vindex message-reply-to-function
148 Message uses the normal methods to determine where replies are to go
149 (@pxref{Responses}), but you can change the behavior to suit your needs
150 by fiddling with the @code{message-reply-to-function} variable.
152 If you want the replies to go to the @code{Sender} instead of the
153 @code{From}, you could do something like this:
156 (setq message-reply-to-function
158 (cond ((equal (mail-fetch-field "from") "somebody")
159 (list (cons 'To (mail-fetch-field "sender"))))
164 This function will be called narrowed to the head of the article that is
167 As you can see, this function should return a string if it has an
168 opinion as to what the To header should be. If it does not, it should
169 just return @code{nil}, and the normal methods for determining the To
172 This function can also return a list. In that case, each list element
173 should be a cons, where the car should be the name of an header
174 (eg. @code{Cc}) and the cdr should be the header value
175 (eg. @samp{larsi@@ifi.uio.no}). All these headers will be inserted into
176 the head of the outgoing mail.
182 @findex message-wide-reply
183 The @code{message-wide-reply} pops up a message buffer that's a wide
184 reply to the message in the current buffer. A @dfn{wide reply} is a
185 reply that goes out to all people listed in the @code{To}, @code{From}
186 (or @code{Reply-to}) and @code{Cc} headers.
188 @vindex message-wide-reply-to-function
189 Message uses the normal methods to determine where wide replies are to go,
190 but you can change the behavior to suit your needs by fiddling with the
191 @code{message-wide-reply-to-function}. It is used in the same way as
192 @code{message-reply-to-function} (@pxref{Reply}).
194 @findex message-dont-reply-to-names
195 Addresses that match the @code{message-dont-reply-to-names} regular
196 expression will be removed from the @code{Cc} header.
202 @findex message-followup
203 The @code{message-followup} command pops up a message buffer that's a
204 followup to the message in the current buffer.
206 @vindex message-followup-to-function
207 Message uses the normal methods to determine where followups are to go,
208 but you can change the behavior to suit your needs by fiddling with the
209 @code{message-followup-to-function}. It is used in the same way as
210 @code{message-reply-to-function} (@pxref{Reply}).
212 @vindex message-use-followup-to
213 The @code{message-use-followup-to} variable says what to do about
214 @code{Followup-To} headers. If it is @code{use}, always use the value.
215 If it is @code{ask} (which is the default), ask whether to use the
216 value. If it is @code{t}, use the value unless it is @samp{poster}. If
217 it is @code{nil}, don't use the value.
221 @section Canceling News
223 @findex message-cancel-news
224 The @code{message-cancel-news} command cancels the article in the
231 @findex message-supersede
232 The @code{message-supersede} command pops up a message buffer that will
233 supersede the message in the current buffer.
235 @vindex message-ignored-supersedes-headers
236 Headers matching the @code{message-ignored-supersedes-headers} are
237 removed before popping up the new message buffer. The default is@*
238 @samp{^Path:\\|^Date\\|^NNTP-Posting-Host:\\|^Xref:\\|^Lines:\\|@*
239 ^Received:\\|^X-From-Line:\\|Return-Path:\\|^Supersedes:}.
246 @findex message-forward
247 The @code{message-forward} command pops up a message buffer to forward
248 the message in the current buffer. If given a prefix, forward using
252 @item message-forward-ignored-headers
253 @vindex message-forward-ignored-headers
254 All headers that match this regexp will be deleted when forwarding a message.
256 @item message-make-forward-subject-function
257 @vindex message-make-forward-subject-function
258 A list of functions that are called to generate a subject header for
259 forwarded messages. The subject generated by the previous function is
260 passed into each successive function.
262 The provided functions are:
265 @item message-forward-subject-author-subject
266 @findex message-forward-subject-author-subject
267 Source of article (author or newsgroup), in brackets followed by the
270 @item message-forward-subject-fwd
271 Subject of article with @samp{Fwd:} prepended to it.
274 @item message-wash-forwarded-subjects
275 @vindex message-wash-forwarded-subjects
276 If this variable is @code{t}, the subjects of forwarded messages have
277 the evidence of previous forwards (such as @samp{Fwd:}, @samp{Re:},
278 @samp{(fwd)}) removed before the new subject is
279 constructed. The default value is @code{nil}.
281 @item message-forward-as-mime
282 @vindex message-forward-as-mime
283 If this variable is @code{t} (the default), forwarded messages are
284 included as inline MIME RFC822 parts. If it's @code{nil}, forwarded
285 messages will just be copied inline to the new message, like previous,
286 non MIME-savvy versions of gnus would do.
293 @findex message-resend
294 The @code{message-resend} command will prompt the user for an address
295 and resend the message in the current buffer to that address.
297 @vindex message-ignored-resent-headers
298 Headers that match the @code{message-ignored-resent-headers} regexp will
299 be removed before sending the message. The default is
300 @samp{^Return-receipt}.
306 @findex message-bounce
307 The @code{message-bounce} command will, if the current buffer contains a
308 bounced mail message, pop up a message buffer stripped of the bounce
309 information. A @dfn{bounced message} is typically a mail you've sent
310 out that has been returned by some @code{mailer-daemon} as
313 @vindex message-ignored-bounced-headers
314 Headers that match the @code{message-ignored-bounced-headers} regexp
315 will be removed before popping up the buffer. The default is
316 @samp{^\\(Received\\|Return-Path\\):}.
323 * Buffer Entry:: Commands after entering a Message buffer.
324 * Header Commands:: Commands for moving to headers.
325 * Movement:: Moving around in message buffers.
326 * Insertion:: Inserting things into message buffers.
327 * MIME:: @sc{mime} considerations.
328 * Security:: Signing and encrypting messages.
329 * Various Commands:: Various things.
330 * Sending:: Actually sending the message.
331 * Mail Aliases:: How to use mail aliases.
332 * Spelling:: Having Emacs check your spelling.
337 @section Buffer Entry
341 You most often end up in a Message buffer when responding to some other
342 message of some sort. Message does lots of handling of quoted text, and
343 may remove signatures, reformat the text, or the like---depending on
344 which used settings you're using. Message usually gets things right,
345 but sometimes it stumbles. To help the user unwind these stumblings,
346 Message sets the undo boundary before each major automatic action it
347 takes. If you press the undo key (usually located at @kbd{C-_}) a few
348 times, you will get back the un-edited message you're responding to.
351 @node Header Commands
352 @section Header Commands
354 All these commands move to the header in question. If it doesn't exist,
361 @findex message-goto-to
362 Describe the message mode.
366 @findex message-goto-to
367 Go to the @code{To} header (@code{message-goto-to}).
371 @findex message-goto-bcc
372 Go to the @code{Bcc} header (@code{message-goto-bcc}).
376 @findex message-goto-fcc
377 Go to the @code{Fcc} header (@code{message-goto-fcc}).
381 @findex message-goto-cc
382 Go to the @code{Cc} header (@code{message-goto-cc}).
386 @findex message-goto-subject
387 Go to the @code{Subject} header (@code{message-goto-subject}).
391 @findex message-goto-reply-to
392 Go to the @code{Reply-To} header (@code{message-goto-reply-to}).
396 @findex message-goto-newsgroups
397 Go to the @code{Newsgroups} header (@code{message-goto-newsgroups}).
401 @findex message-goto-distribution
402 Go to the @code{Distribution} header (@code{message-goto-distribution}).
406 @findex message-goto-followup-to
407 Go to the @code{Followup-To} header (@code{message-goto-followup-to}).
411 @findex message-goto-keywords
412 Go to the @code{Keywords} header (@code{message-goto-keywords}).
416 @findex message-goto-summary
417 Go to the @code{Summary} header (@code{message-goto-summary}).
428 @findex message-goto-body
429 Move to the beginning of the body of the message
430 (@code{message-goto-body}).
434 @findex message-goto-signature
435 Move to the signature of the message (@code{message-goto-signature}).
447 @findex message-yank-original
448 Yank the message that's being replied to into the message buffer
449 (@code{message-yank-original}).
453 @findex message-yank-buffer
454 Prompt for a buffer name and yank the contents of that buffer into the
455 message buffer (@code{message-yank-buffer}).
459 @findex message-fill-yanked-message
460 Fill the yanked message (@code{message-fill-yanked-message}). Warning:
461 Can severely mess up the yanked text if its quoting conventions are
462 strange. You'll quickly get a feel for when it's safe, though. Anyway,
463 just remember that @kbd{C-x u} (@code{undo}) is available and you'll be
468 @findex message-insert-signature
469 Insert a signature at the end of the buffer
470 (@code{message-insert-signature}).
474 @findex message-insert-headers
475 Insert the message headers (@code{message-insert-headers}).
480 @item message-ignored-cited-headers
481 @vindex message-ignored-cited-headers
482 All headers that match this regexp will be removed from yanked
483 messages. The default is @samp{.}, which means that all headers will be
486 @item message-cite-prefix-regexp
487 @vindex message-cite-prefix-regexp
488 Regexp matching the longest possible citation prefix on a line.
490 @item message-citation-line-function
491 @vindex message-citation-line-function
492 Function called to insert the citation line. The default is
493 @code{message-insert-citation-line}, which will lead to citation lines
497 Hallvard B Furuseth <h.b.furuseth@@usit.uio.no> writes:
500 Point will be at the beginning of the body of the message when this
503 Note that Gnus provides a feature where clicking on `writes:' hides the
504 cited text. If you change the citation line too much, readers of your
505 messages will have to adjust their Gnus, too. See the variable
506 @code{gnus-cite-attribution-suffix}. @xref{Article Highlighting, ,
507 Article Highlighting, gnus}, for details.
509 @item message-yank-prefix
510 @vindex message-yank-prefix
513 When you are replying to or following up an article, you normally want
514 to quote the person you are answering. Inserting quoted text is done
515 by @dfn{yanking}, and each quoted line you yank (except earlier
516 quotes, see @code{message-yank-cited-prefix}) will have
517 @code{message-yank-prefix} prepended to it. The default is @samp{> }.
519 @item message-yank-cited-prefix
520 @vindex message-yank-cited-prefix
524 The @code{message-yank-prefix} prefix is not used on already cited
525 lines, instead the contents of this variable is used as yank prefix.
526 The default is @samp{>}.
528 @item message-indentation-spaces
529 @vindex message-indentation-spaces
530 Number of spaces to indent yanked messages.
532 @item message-cite-function
533 @vindex message-cite-function
534 @findex message-cite-original
535 @findex sc-cite-original
536 @findex message-cite-original-without-signature
538 Function for citing an original message. The default is
539 @code{message-cite-original}, which simply inserts the original message
540 and prepends @samp{> } to each line.
541 @code{message-cite-original-without-signature} does the same, but elides
542 the signature. You can also set it to @code{sc-cite-original} to use
545 @item message-indent-citation-function
546 @vindex message-indent-citation-function
547 Function for modifying a citation just inserted in the mail buffer.
548 This can also be a list of functions. Each function can find the
549 citation between @code{(point)} and @code{(mark t)}. And each function
550 should leave point and mark around the citation text as modified.
552 @item message-signature
553 @vindex message-signature
554 String to be inserted at the end of the message buffer. If @code{t}
555 (which is the default), the @code{message-signature-file} file will be
556 inserted instead. If a function, the result from the function will be
557 used instead. If a form, the result from the form will be used instead.
558 If this variable is @code{nil}, no signature will be inserted at all.
560 @item message-signature-file
561 @vindex message-signature-file
562 File containing the signature to be inserted at the end of the buffer.
563 The default is @samp{~/.signature}.
567 Note that RFC1036bis says that a signature should be preceded by the three
568 characters @samp{-- } on a line by themselves. This is to make it
569 easier for the recipient to automatically recognize and process the
570 signature. So don't remove those characters, even though you might feel
571 that they ruin your beautiful design, like, totally.
573 Also note that no signature should be more than four lines long.
574 Including ASCII graphics is an efficient way to get everybody to believe
575 that you are silly and have nothing important to say.
585 Message is a @sc{mime}-compliant posting agent. The user generally
586 doesn't have to do anything to make the @sc{mime} happen---Message will
587 automatically add the @code{Content-Type} and
588 @code{Content-Transfer-Encoding} headers.
590 The most typical thing users want to use the multipart things in
591 @sc{mime} for is to add ``attachments'' to mail they send out. This can
592 be done with the @code{C-c C-a} command, which will prompt for a file
593 name and a @sc{mime} type.
595 You can also create arbitrarily complex multiparts using the MML
596 language (@pxref{Composing, , Composing, emacs-mime, The Emacs MIME
607 Using the MML language, Message is able to create digitally signed and
608 digitally encrypted messages. Message (or rather MML) currently support
609 PGP/MIME and S/MIME. Instructing MML to perform security operations on
610 a MIME part is done using the @code{C-c C-m s} key map for signing and the
611 @code{C-c C-m c} key map for encryption, as follows.
617 @findex mml-secure-sign-smime
619 Digitally sign current MIME part using S/MIME.
623 @findex mml-secure-sign-pgp
625 Digitally sign current MIME part using PGP/MIME.
629 @findex mml-secure-encrypt-smime
631 Digitally encrypt current MIME part using S/MIME.
635 @findex mml-secure-encrypt-pgpmime
637 Digitally encrypt current MIME part using PGP/MIME.
641 These commands do not immediately sign or encrypt the message, they
642 merely insert proper MML tags to instruct the MML engine to perform that
643 operation when the message is actually sent. They may perform other
644 operations too, such as locating and retrieving a S/MIME certificate of
645 the person you wish to send encrypted mail to.
647 Since signing and especially encryption often is used when sensitive
648 information is sent, you may want to have some way to ensure that your
649 mail is actually signed or encrypted. After invoking the above
650 sign/encrypt commands, it is possible to preview the raw article by
651 using @code{C-u C-m P} (@code{mml-preview}). Then you can verify that
652 your long rant about what your ex-significant other or whomever actually
653 did with that funny looking person at that strange party the other
654 night, actually will be sent encrypted.
656 @emph{Note!} Neither PGP/MIME nor S/MIME encrypt/signs RFC822 headers.
657 They only operate on the MIME object. Keep this in mind before sending
658 mail with a sensitive Subject line.
660 Actually using the security commands above is not very difficult. At
661 least not compared with making sure all involved programs talk with each
662 other properly. Thus, we now describe what external libraries or
663 programs are required to make things work, and some small general hints.
665 @subsection Using S/MIME
667 @emph{Note!} This section assume you have a basic familiarity with
668 modern cryptography, S/MIME, various PKCS standards, OpenSSL and so on.
670 The S/MIME support in Message (and MML) require OpenSSL. OpenSSL
671 perform the actual S/MIME sign/encrypt operations. OpenSSL can be found
672 at @code{http://www.openssl.org/}. OpenSSL 0.9.6 and later should work.
673 Version 0.9.5a cannot extract mail addresses from certificates, and it
674 insert a spurious CR character into MIME separators so you may wish to
675 avoid it if you would like to avoid being regarded as someone who send
676 strange mail. (Although by sending S/MIME messages you've probably
677 already lost that contest.)
679 To be able to send encrypted mail, a personal certificate is not
680 required. Message (MML) need a certificate for the person to whom you
681 wish to communicate with though. You're asked for this when you type
682 @code{C-c C-m c s}. Currently there are two ways to retrieve this
683 certificate, from a local file or from DNS. If you chose a local file,
684 it need to contain a X.509 certificate in PEM format. If you chose DNS,
685 you're asked for the domain name where the certificate is stored, the
686 default is a good guess. To my belief, Message (MML) is the first mail
687 agent in the world to support retrieving S/MIME certificates from DNS,
688 so you're not likely to find very many certificates out there. At least
689 there should be one, stored at the domain @code{simon.josefsson.org}.
690 LDAP is a more popular method of distributing certificates, support for
691 it is planned. (Meanwhile, you can use @code{ldapsearch} from the
692 command line to retrieve a certificate into a file and use it.)
694 As for signing messages, OpenSSL can't perform signing operations
695 without some kind of configuration. Especially, you need to tell it
696 where your private key and your certificate is stored. MML uses an
697 Emacs interface to OpenSSL, aptly named @code{smime.el}, and it contain
698 a @code{custom} group used for this configuration. So, try @code{M-x
699 customize-group RET smime RET} and look around.
701 Currently there is no support for talking to a CA (or RA) to create your
702 own certificate. None is planned either. You need to do this manually
703 with OpenSSL or using some other program. I used Netscape and got a
704 free S/MIME certificate from one of the big CA's on the net. Netscape
705 is able to export your private key and certificate in PKCS #12 format.
706 Use OpenSSL to convert this into a plain X.509 certificate in PEM format
710 $ openssl pkcs12 -in ns.p12 -clcerts -nodes > key+cert.pem
713 The @code{key+cert.pem} file should be pointed to from the
714 @code{smime-keys} variable. You should now be able to send signed mail.
716 @emph{Note!} Your private key is store unencrypted in the file, so take
719 @subsection Using PGP/MIME
721 PGP/MIME requires an external OpenPGP implementation, such as GNU
722 Privacy Guard (@code{http://www.gnupg.org/}). It also requires an Emacs
723 interface to it, such as Mailcrypt (available from
724 @code{http://www.nb.net/~lbudney/linux/software/mailcrypt.html}) or
725 Florian Weimer's @code{gpg.el}.
727 Creating your own OpenPGP key is described in detail in the
728 documentation of your OpenPGP implementation, so we refer to it.
730 @node Various Commands
731 @section Various Commands
737 @findex message-caesar-buffer-body
738 Caesar rotate (aka. rot13) the current message
739 (@code{message-caesar-buffer-body}). If narrowing is in effect, just
740 rotate the visible portion of the buffer. A numerical prefix says how
741 many places to rotate the text. The default is 13.
745 @findex message-elide-region
746 Elide the text between point and mark (@code{message-elide-region}).
747 The text is killed and replaced with the contents of the variable
748 @code{message-elide-ellipsis}. The default value is to use an ellipsis
753 @findex message-kill-to-signature
754 Kill all the text up to the signature, or if that's missing, up to the
755 end of the message (@code{message-kill-to-signature}).
759 @findex message-delete-not-region
760 Delete all text in the body of the message that is outside the region
761 (@code{message-delete-not-region}).
765 @kindex message-newline-and-reformat
766 Insert four newlines, and then reformat if inside quoted text.
771 > This is some quoted text. And here's more quoted text.
774 If point is before @samp{And} and you press @kbd{M-RET}, you'll get:
777 > This is some quoted text.
781 > And here's more quoted text.
784 @samp{*} says where point will be placed.
788 @findex message-insert-to
789 Insert a @code{To} header that contains the @code{Reply-To} or
790 @code{From} header of the message you're following up
791 (@code{message-insert-to}).
795 @findex message-insert-newsgroups
796 Insert a @code{Newsgroups} header that reflects the @code{Followup-To}
797 or @code{Newsgroups} header of the article you're replying to
798 (@code{message-insert-newsgroups}).
802 @findex message-rename-buffer
803 Rename the buffer (@code{message-rename-buffer}). If given a prefix,
804 prompt for a new buffer name.
815 @findex message-send-and-exit
816 Send the message and bury the current buffer
817 (@code{message-send-and-exit}).
822 Send the message (@code{message-send}).
826 @findex message-dont-send
827 Bury the message buffer and exit (@code{message-dont-send}).
831 @findex message-kill-buffer
832 Kill the message buffer and exit (@code{message-kill-buffer}).
839 @section Mail Aliases
843 @vindex message-mail-alias-type
844 The @code{message-mail-alias-type} variable controls what type of mail
845 alias expansion to use. Currently only one form is supported---Message
846 uses @code{mailabbrev} to handle mail aliases. If this variable is
847 @code{nil}, no mail alias expansion will be performed.
849 @code{mailabbrev} works by parsing the @file{/etc/mailrc} and
850 @file{~/.mailrc} files. These files look like:
853 alias lmi "Lars Magne Ingebrigtsen <larsi@@ifi.uio.no>"
854 alias ding "ding@@ifi.uio.no (ding mailing list)"
857 After adding lines like this to your @file{~/.mailrc} file, you should
858 be able to just write @samp{lmi} in the @code{To} or @code{Cc} (and so
859 on) headers and press @kbd{SPC} to expand the alias.
861 No expansion will be performed upon sending of the message---all
862 expansions have to be done explicitly.
868 @findex ispell-message
870 There are two popular ways to have Emacs spell-check your messages:
871 @code{ispell} and @code{flyspell}. @code{ispell} is the older and
872 probably more popular package. You typically first write the message,
873 and then run the entire thing through @code{ispell} and fix all the
874 typos. To have this happen automatically when you send a message, put
875 something like the following in your @file{.emacs} file:
878 (add-hook 'message-send-hook 'ispell-message)
881 @vindex ispell-message-dictionary-alist
882 If you're in the habit of writing in different languages, this can be
883 controlled by the @code{ispell-message-dictionary-alist} variable:
886 (setq ispell-message-dictionary-alist
887 '(("^Newsgroups:.*\\bde\\." . "deutsch8")
891 @code{ispell} depends on having the external @samp{ispell} command
894 The other popular method is using @code{flyspell}. This package checks
895 your spelling while you're writing, and marks any mis-spelled words in
898 To use @code{flyspell}, put something like the following in your
902 (defun my-message-setup-routine ()
904 (add-hook 'message-setup-hook 'my-message-setup-routine)
907 @code{flyspell} depends on having the external @samp{ispell} command
915 * Message Headers:: General message header stuff.
916 * Mail Headers:: Customizing mail headers.
917 * Mail Variables:: Other mail variables.
918 * News Headers:: Customizing news headers.
919 * News Variables:: Other news variables.
920 * Various Message Variables:: Other message variables.
921 * Sending Variables:: Variables for sending.
922 * Message Buffers:: How Message names its buffers.
923 * Message Actions:: Actions to be performed when exiting.
927 @node Message Headers
928 @section Message Headers
930 Message is quite aggressive on the message generation front. It has to
931 be -- it's a combined news and mail agent. To be able to send combined
932 messages, it has to generate all headers itself (instead of letting the
933 mail/news system do it) to ensure that mail and news copies of messages
934 look sufficiently similar.
938 @item message-generate-headers-first
939 @vindex message-generate-headers-first
940 If non-@code{nil}, generate all required headers before starting to
943 The variables @code{message-required-mail-headers} and
944 @code{message-required-news-headers} specify which headers are required.
946 Note that some headers will be removed and re-generated before posting,
947 because of the variable @code{message-deletable-headers} (see below).
949 @item message-from-style
950 @vindex message-from-style
951 Specifies how @code{From} headers should look. There are four valid
956 Just the address -- @samp{king@@grassland.com}.
959 @samp{king@@grassland.com (Elvis Parsley)}.
962 @samp{Elvis Parsley <king@@grassland.com>}.
965 Look like @code{angles} if that doesn't require quoting, and
966 @code{parens} if it does. If even @code{parens} requires quoting, use
967 @code{angles} anyway.
971 @item message-deletable-headers
972 @vindex message-deletable-headers
973 Headers in this list that were previously generated by Message will be
974 deleted before posting. Let's say you post an article. Then you decide
975 to post it again to some other group, you naughty boy, so you jump back
976 to the @code{*post-buf*} buffer, edit the @code{Newsgroups} line, and
977 ship it off again. By default, this variable makes sure that the old
978 generated @code{Message-ID} is deleted, and a new one generated. If
979 this isn't done, the entire empire would probably crumble, anarchy would
980 prevail, and cats would start walking on two legs and rule the world.
983 @item message-default-headers
984 @vindex message-default-headers
985 This string is inserted at the end of the headers in all message
988 @item message-subject-re-regexp
989 @vindex message-subject-re-regexp
990 Responses to messages have subjects that start with @samp{Re: }. This
991 is @emph{not} an abbreviation of the English word ``response'', but is
992 Latin, and means ``in response to''. Some illiterate nincompoops have
993 failed to grasp this fact, and have ``internationalized'' their software
994 to use abonimations like @samp{Aw: } (``antwort'') or @samp{Sv: }
995 (``svar'') instead, which is meaningless and evil. However, you may
996 have to deal with users that use these evil tools, in which case you may
997 set this variable to a regexp that matches these prefixes. Myself, I
998 just throw away non-compliant mail.
1000 @item message-alternative-emails
1001 @vindex message-alternative-emails
1002 A regexp to match the alternative email addresses. The first matched
1003 address (not primary one) is used in the @code{From} field.
1009 @section Mail Headers
1012 @item message-required-mail-headers
1013 @vindex message-required-mail-headers
1014 @xref{News Headers}, for the syntax of this variable. It is
1015 @code{(From Date Subject (optional . In-Reply-To) Message-ID Lines
1016 (optional . User-Agent))} by default.
1018 @item message-ignored-mail-headers
1019 @vindex message-ignored-mail-headers
1020 Regexp of headers to be removed before mailing. The default is
1021 @samp{^[GF]cc:\\|^Resent-Fcc:\\|^Xref:\\|^X-Draft-From:}.
1023 @item message-default-mail-headers
1024 @vindex message-default-mail-headers
1025 This string is inserted at the end of the headers in all message
1026 buffers that are initialized as mail.
1031 @node Mail Variables
1032 @section Mail Variables
1035 @item message-send-mail-function
1036 @vindex message-send-mail-function
1037 Function used to send the current buffer as mail. The default is
1038 @code{message-send-mail-with-sendmail}. If you prefer using MH
1039 instead, set this variable to @code{message-send-mail-with-mh}.
1041 @item message-mh-deletable-headers
1042 @vindex message-mh-deletable-headers
1043 Most versions of MH doesn't like being fed messages that contain the
1044 headers in this variable. If this variable is non-@code{nil} (which is
1045 the default), these headers will be removed before mailing when sending
1046 messages via MH. Set it to @code{nil} if your MH can handle these
1049 @item message-send-mail-partially-limit
1050 @vindex message-send-mail-partially-limit
1051 The limitation of messages sent as message/partial.
1052 The lower bound of message size in characters, beyond which the message
1053 should be sent in several parts. If it is nil, the size is unlimited.
1059 @section News Headers
1061 @vindex message-required-news-headers
1062 @code{message-required-news-headers} a list of header symbols. These
1063 headers will either be automatically generated, or, if that's
1064 impossible, they will be prompted for. The following symbols are valid:
1070 @findex user-full-name
1071 @findex user-mail-address
1072 This required header will be filled out with the result of the
1073 @code{message-make-from} function, which depends on the
1074 @code{message-from-style}, @code{user-full-name},
1075 @code{user-mail-address} variables.
1079 This required header will be prompted for if not present already.
1083 This required header says which newsgroups the article is to be posted
1084 to. If it isn't present already, it will be prompted for.
1087 @cindex organization
1088 This optional header will be filled out depending on the
1089 @code{message-user-organization} variable.
1090 @code{message-user-organization-file} will be used if this variable is
1091 @code{t}. This variable can also be a string (in which case this string
1092 will be used), or it can be a function (which will be called with no
1093 parameters and should return a string to be used).
1097 This optional header will be computed by Message.
1101 @vindex mail-host-address
1104 This required header will be generated by Message. A unique ID will be
1105 created based on the date, time, user name and system name. Message
1106 will use @code{system-name} to determine the name of the system. If
1107 this isn't a fully qualified domain name (FQDN), Message will use
1108 @code{mail-host-address} as the FQDN of the machine.
1112 This optional header will be filled out according to the
1113 @code{message-newsreader} local variable.
1116 This optional header is filled out using the @code{Date} and @code{From}
1117 header of the article being replied to.
1121 This extremely optional header will be inserted according to the
1122 @code{message-expires} variable. It is highly deprecated and shouldn't
1123 be used unless you know what you're doing.
1126 @cindex Distribution
1127 This optional header is filled out according to the
1128 @code{message-distribution-function} variable. It is a deprecated and
1129 much misunderstood header.
1133 This extremely optional header should probably never be used.
1134 However, some @emph{very} old servers require that this header is
1135 present. @code{message-user-path} further controls how this
1136 @code{Path} header is to look. If it is @code{nil}, use the server name
1137 as the leaf node. If it is a string, use the string. If it is neither
1138 a string nor @code{nil}, use the user name only. However, it is highly
1139 unlikely that you should need to fiddle with this variable at all.
1143 @cindex Mime-Version
1144 In addition, you can enter conses into this list. The car of this cons
1145 should be a symbol. This symbol's name is the name of the header, and
1146 the cdr can either be a string to be entered verbatim as the value of
1147 this header, or it can be a function to be called. This function should
1148 return a string to be inserted. For instance, if you want to insert
1149 @code{Mime-Version: 1.0}, you should enter @code{(Mime-Version . "1.0")}
1150 into the list. If you want to insert a funny quote, you could enter
1151 something like @code{(X-Yow . yow)} into the list. The function
1152 @code{yow} will then be called without any arguments.
1154 If the list contains a cons where the car of the cons is
1155 @code{optional}, the cdr of this cons will only be inserted if it is
1158 Other variables for customizing outgoing news articles:
1162 @item message-syntax-checks
1163 @vindex message-syntax-checks
1164 Controls what syntax checks should not be performed on outgoing posts.
1165 To disable checking of long signatures, for instance, add
1168 (signature . disabled)
1177 Check the subject for commands.
1180 Insert a new @code{Sender} header if the @code{From} header looks odd.
1181 @item multiple-headers
1182 Check for the existence of multiple equal headers.
1185 Check for the existence of version and sendsys commands.
1187 Check whether the @code{Message-ID} looks ok.
1189 Check whether the @code{From} header seems nice.
1192 Check for too long lines.
1194 Check for invalid characters.
1196 Check for excessive size.
1198 Check whether there is any new text in the messages.
1200 Check the length of the signature.
1203 Check whether the article has an @code{Approved} header, which is
1204 something only moderators should include.
1206 Check whether the article is empty.
1207 @item invisible-text
1208 Check whether there is any invisible text in the buffer.
1210 Check whether any of the headers are empty.
1211 @item existing-newsgroups
1212 Check whether the newsgroups mentioned in the @code{Newsgroups} and
1213 @code{Followup-To} headers exist.
1214 @item valid-newsgroups
1215 Check whether the @code{Newsgroups} and @code{Followup-to} headers
1216 are valid syntactically.
1217 @item repeated-newsgroups
1218 Check whether the @code{Newsgroups} and @code{Followup-to} headers
1219 contains repeated group names.
1220 @item shorten-followup-to
1221 Check whether to add a @code{Followup-to} header to shorten the number
1222 of groups to post to.
1225 All these conditions are checked by default.
1227 @item message-ignored-news-headers
1228 @vindex message-ignored-news-headers
1229 Regexp of headers to be removed before posting. The default is@*
1230 @samp{^NNTP-Posting-Host:\\|^Xref:\\|^[BGF]cc:\\|^Resent-Fcc:\\|^X-Draft-From:}.
1232 @item message-default-news-headers
1233 @vindex message-default-news-headers
1234 This string is inserted at the end of the headers in all message
1235 buffers that are initialized as news.
1240 @node News Variables
1241 @section News Variables
1244 @item message-send-news-function
1245 @vindex message-send-news-function
1246 Function used to send the current buffer as news. The default is
1247 @code{message-send-news}.
1249 @item message-post-method
1250 @vindex message-post-method
1251 Gnusish @dfn{select method} (see the Gnus manual for details) used for
1252 posting a prepared news message.
1257 @node Various Message Variables
1258 @section Various Message Variables
1261 @item message-default-charset
1262 @vindex message-default-charset
1264 Symbol naming a @sc{mime} charset. Non-ASCII characters in messages are
1265 assumed to be encoded using this charset. The default is @code{nil},
1266 which means ask the user. (This variable is used only on non-@sc{mule}
1268 @xref{Charset Translation, , Charset Translation, emacs-mime,
1269 Emacs MIME Manual}, for details on the @sc{mule}-to-@sc{mime}
1270 translation process.
1272 @item message-signature-separator
1273 @vindex message-signature-separator
1274 Regexp matching the signature separator. It is @samp{^-- *$} by
1277 @item mail-header-separator
1278 @vindex mail-header-separator
1279 String used to separate the headers from the body. It is @samp{--text
1280 follows this line--} by default.
1282 @item message-directory
1283 @vindex message-directory
1284 Directory used by many mailey things. The default is @file{~/Mail/}.
1286 @item message-signature-setup-hook
1287 @vindex message-signature-setup-hook
1288 Hook run when initializing the message buffer. It is run after the
1289 headers have been inserted but before the signature has been inserted.
1291 @item message-setup-hook
1292 @vindex message-setup-hook
1293 Hook run as the last thing when the message buffer has been initialized,
1294 but before yanked text is inserted.
1296 @item message-header-setup-hook
1297 @vindex message-header-setup-hook
1298 Hook called narrowed to the headers after initializing the headers.
1300 For instance, if you're running Gnus and wish to insert a
1301 @samp{Mail-Copies-To} header in all your news articles and all messages
1302 you send to mailing lists, you could do something like the following:
1305 (defun my-message-header-setup-hook ()
1306 (let ((group (or gnus-newsgroup-name "")))
1307 (when (or (message-fetch-field "newsgroups")
1308 (gnus-group-find-parameter group 'to-address)
1309 (gnus-group-find-parameter group 'to-list))
1310 (insert "Mail-Copies-To: never\n"))))
1312 (add-hook 'message-header-setup-hook
1313 'my-message-header-setup-hook)
1316 @item message-send-hook
1317 @vindex message-send-hook
1318 Hook run before sending messages.
1320 If you want to add certain headers before sending, you can use the
1321 @code{message-add-header} function in this hook. For instance:
1322 @findex message-add-header
1325 (add-hook 'message-send-hook 'my-message-add-content)
1326 (defun my-message-add-content ()
1327 (message-add-header "X-In-No-Sense: Nonsense")
1328 (message-add-header "X-Whatever: no"))
1331 This function won't add the header if the header is already present.
1333 @item message-send-mail-hook
1334 @vindex message-send-mail-hook
1335 Hook run before sending mail messages.
1337 @item message-send-news-hook
1338 @vindex message-send-news-hook
1339 Hook run before sending news messages.
1341 @item message-sent-hook
1342 @vindex message-sent-hook
1343 Hook run after sending messages.
1345 @item message-mode-syntax-table
1346 @vindex message-mode-syntax-table
1347 Syntax table used in message mode buffers.
1349 @item message-send-method-alist
1350 @vindex message-send-method-alist
1352 Alist of ways to send outgoing messages. Each element has the form
1355 (TYPE PREDICATE FUNCTION)
1360 A symbol that names the method.
1363 A function called without any parameters to determine whether the
1364 message is a message of type @var{type}.
1367 A function to be called if @var{predicate} returns non-@code{nil}.
1368 @var{function} is called with one parameter -- the prefix.
1372 ((news message-news-p message-send-via-news)
1373 (mail message-mail-p message-send-via-mail))
1382 @node Sending Variables
1383 @section Sending Variables
1387 @item message-fcc-handler-function
1388 @vindex message-fcc-handler-function
1389 A function called to save outgoing articles. This function will be
1390 called with the name of the file to store the article in. The default
1391 function is @code{message-output} which saves in Unix mailbox format.
1393 @item message-courtesy-message
1394 @vindex message-courtesy-message
1395 When sending combined messages, this string is inserted at the start of
1396 the mailed copy. If the string contains the format spec @samp{%s}, the
1397 newsgroups the article has been posted to will be inserted there. If
1398 this variable is @code{nil}, no such courtesy message will be added.
1399 The default value is @samp{"The following message is a courtesy copy of
1400 an article\nthat has been posted to %s as well.\n\n"}.
1405 @node Message Buffers
1406 @section Message Buffers
1408 Message will generate new buffers with unique buffer names when you
1409 request a message buffer. When you send the message, the buffer isn't
1410 normally killed off. Its name is changed and a certain number of old
1411 message buffers are kept alive.
1414 @item message-generate-new-buffers
1415 @vindex message-generate-new-buffers
1416 If non-@code{nil}, generate new buffers. The default is @code{t}. If
1417 this is a function, call that function with three parameters: The type,
1418 the to address and the group name. (Any of these may be @code{nil}.)
1419 The function should return the new buffer name.
1421 @item message-max-buffers
1422 @vindex message-max-buffers
1423 This variable says how many old message buffers to keep. If there are
1424 more message buffers than this, the oldest buffer will be killed. The
1425 default is 10. If this variable is @code{nil}, no old message buffers
1426 will ever be killed.
1428 @item message-send-rename-function
1429 @vindex message-send-rename-function
1430 After sending a message, the buffer is renamed from, for instance,
1431 @samp{*reply to Lars*} to @samp{*sent reply to Lars*}. If you don't
1432 like this, set this variable to a function that renames the buffer in a
1433 manner you like. If you don't want to rename the buffer at all, you can
1437 (setq message-send-rename-function 'ignore)
1440 @item message-kill-buffer-on-exit
1441 @findex message-kill-buffer-on-exit
1442 If non-@code{nil}, kill the buffer immediately on exit.
1447 @node Message Actions
1448 @section Message Actions
1450 When Message is being used from a news/mail reader, the reader is likely
1451 to want to perform some task after the message has been sent. Perhaps
1452 return to the previous window configuration or mark an article as
1455 @vindex message-kill-actions
1456 @vindex message-postpone-actions
1457 @vindex message-exit-actions
1458 @vindex message-send-actions
1459 The user may exit from the message buffer in various ways. The most
1460 common is @kbd{C-c C-c}, which sends the message and exits. Other
1461 possibilities are @kbd{C-c C-s} which just sends the message, @kbd{C-c
1462 C-d} which postpones the message editing and buries the message buffer,
1463 and @kbd{C-c C-k} which kills the message buffer. Each of these actions
1464 have lists associated with them that contains actions to be executed:
1465 @code{message-send-actions}, @code{message-exit-actions},
1466 @code{message-postpone-actions}, and @code{message-kill-actions}.
1468 Message provides a function to interface with these lists:
1469 @code{message-add-action}. The first parameter is the action to be
1470 added, and the rest of the arguments are which lists to add this action
1471 to. Here's an example from Gnus:
1475 `(set-window-configuration ,(current-window-configuration))
1476 'exit 'postpone 'kill)
1479 This restores the Gnus window configuration when the message buffer is
1480 killed, postponed or exited.
1482 An @dfn{action} can be either: a normal function, or a list where the
1483 @code{car} is a function and the @code{cdr} is the list of arguments, or
1484 a form to be @code{eval}ed.
1488 @chapter Compatibility
1489 @cindex compatibility
1491 Message uses virtually only its own variables---older @code{mail-}
1492 variables aren't consulted. To force Message to take those variables
1493 into account, you can put the following in your @code{.emacs} file:
1496 (require 'messcompat)
1499 This will initialize many Message variables from the values in the
1500 corresponding mail variables.
1507 * Responses:: Standard rules for determining where responses go.
1514 To determine where a message is to go, the following algorithm is used
1519 A @dfn{reply} is when you want to respond @emph{just} to the person who
1520 sent the message via mail. There will only be one recipient. To
1521 determine who the recipient will be, the following headers are
1532 A @dfn{wide reply} is a mail response that includes @emph{all} entities
1533 mentioned in the message you are responded to. All mailboxes from the
1534 following headers will be concatenated to form the outgoing
1535 @code{To}/@code{Cc} headers:
1539 (unless there's a @code{Reply-To}, in which case that is used instead).
1546 If a @code{Mail-Copies-To} header is present, it will also be included
1547 in the list of mailboxes. If this header is @samp{never}, that means
1548 that the @code{From} (or @code{Reply-To}) mailbox will be suppressed.
1552 A @dfn{followup} is a response sent via news. The following headers
1553 (listed in order of precedence) determine where the response is to be
1564 If a @code{Mail-Copies-To} header is present, it will be used as the
1565 basis of the new @code{Cc} header, except if this header is