1 \input texinfo @c -*-texinfo-*-
4 @settitle T-gnus 6.14 Message 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,97,98,99,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 T-gnus 6.14 Message Manual
46 @author by Lars Magne Ingebrigtsen
49 @vskip 0pt plus 1filll
50 Copyright @copyright{} 1996,97,98,99,2000 Free Software Foundation, Inc.
52 Permission is granted to copy, distribute and/or modify this document
53 under the terms of the GNU Free Documentation License, Version 1.1 or
54 any later version published by the Free Software Foundation; with the
55 Invariant Sections being none, with the Front-Cover texts being ``A GNU
56 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
57 license is included in the section entitled ``GNU Free Documentation
58 License'' in the Emacs manual.
60 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
61 this GNU Manual, like GNU software. Copies published by the Free
62 Software Foundation raise funds for GNU development.''
64 This document is part of a collection distributed under the GNU Free
65 Documentation License. If you want to distribute this document
66 separately from the collection, you can do so by adding a copy of the
67 license to the document, as described in section 6 of the license.
76 All message composition from Gnus (both mail and news) takes place in
80 * Interface:: Setting up message buffers.
81 * Commands:: Commands you can execute in message mode buffers.
82 * Variables:: Customizing the message buffers.
83 * Compatibility:: Making Message backwards compatible.
84 * Appendices:: More technical things.
85 * Index:: Variable, function and concept index.
86 * Key Index:: List of Message mode keys.
89 This manual corresponds to T-gnus 6.14 Message. Message is
90 distributed with the Gnus distribution bearing the same version number
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 * Header Commands:: Commands for moving to headers.
324 * Movement:: Moving around in message buffers.
325 * Insertion:: Inserting things into message buffers.
326 * MIME:: @sc{mime} considerations.
327 * Security:: Signing and encrypting messages.
328 * Various Commands:: Various things.
329 * Sending:: Actually sending the message.
330 * Mail Aliases:: How to use mail aliases.
334 @node Header Commands
335 @section Header Commands
337 All these commands move to the header in question. If it doesn't exist,
344 @findex message-goto-to
345 Describe the message mode.
349 @findex message-goto-to
350 Go to the @code{To} header (@code{message-goto-to}).
354 @findex message-goto-bcc
355 Go to the @code{Bcc} header (@code{message-goto-bcc}).
359 @findex message-goto-fcc
360 Go to the @code{Fcc} header (@code{message-goto-fcc}).
364 @findex message-goto-cc
365 Go to the @code{Cc} header (@code{message-goto-cc}).
369 @findex message-goto-subject
370 Go to the @code{Subject} header (@code{message-goto-subject}).
374 @findex message-goto-reply-to
375 Go to the @code{Reply-To} header (@code{message-goto-reply-to}).
379 @findex message-goto-newsgroups
380 Go to the @code{Newsgroups} header (@code{message-goto-newsgroups}).
384 @findex message-goto-distribution
385 Go to the @code{Distribution} header (@code{message-goto-distribution}).
389 @findex message-goto-followup-to
390 Go to the @code{Followup-To} header (@code{message-goto-followup-to}).
394 @findex message-goto-keywords
395 Go to the @code{Keywords} header (@code{message-goto-keywords}).
399 @findex message-goto-summary
400 Go to the @code{Summary} header (@code{message-goto-summary}).
411 @findex message-goto-body
412 Move to the beginning of the body of the message
413 (@code{message-goto-body}).
417 @findex message-goto-signature
418 Move to the signature of the message (@code{message-goto-signature}).
430 @findex message-yank-original
431 Yank the message in the buffer @code{gnus-article-copy} into the message
432 buffer. Normally @code{gnus-article-copy} is what you are replying to
433 (@code{message-yank-original}).
437 @findex message-yank-buffer
438 Prompt for a buffer name and yank the contents of that buffer into the
439 message buffer (@code{message-yank-buffer}).
443 @findex message-fill-yanked-message
444 Fill the yanked message (@code{message-fill-yanked-message}). Warning:
445 Can severely mess up the yanked text if its quoting conventions are
446 strange. You'll quickly get a feel for when it's safe, though. Anyway,
447 just remember that @kbd{C-x u} (@code{undo}) is available and you'll be
452 @findex message-insert-signature
453 Insert a signature at the end of the buffer
454 (@code{message-insert-signature}).
458 @findex message-insert-headers
459 Insert the message headers (@code{message-insert-headers}).
464 @item message-ignored-cited-headers
465 @vindex message-ignored-cited-headers
466 All headers that match this regexp will be removed from yanked
467 messages. The default is @samp{.}, which means that all headers will be
470 @item message-cite-prefix-regexp
471 @vindex message-cite-prefix-regexp
472 Regexp matching the longest possible citation prefix on a line.
474 @item message-citation-line-function
475 @vindex message-citation-line-function
476 Function called to insert the citation line. The default is
477 @code{message-insert-citation-line}, which will lead to citation lines
481 Hallvard B Furuseth <h.b.furuseth@@usit.uio.no> writes:
484 Point will be at the beginning of the body of the message when this
487 @item message-yank-prefix
488 @vindex message-yank-prefix
491 When you are replying to or following up an article, you normally want
492 to quote the person you are answering. Inserting quoted text is done by
493 @dfn{yanking}, and each quoted line you yank will have
494 @code{message-yank-prefix} prepended to it. The default is @samp{> }.
496 @item message-yank-add-new-references
497 @vindex message-yank-add-new-references
499 Non-@code{nil} means new IDs will be added to References field when an
500 article is yanked by the command @code{message-yank-original}
501 interactively. If it is a symbol @code{message-id-only}, only an ID
502 from Message-ID field is used, otherwise IDs extracted from References,
503 In-Reply-To and Message-ID fields are used.
505 @item message-list-references-add-position
506 @vindex message-list-references-add-position
508 Integer value means position for adding to References field when an
509 article is yanked by the command @code{message-yank-original}
512 @item message-indentation-spaces
513 @vindex message-indentation-spaces
514 Number of spaces to indent yanked messages.
516 @item message-cite-function
517 @vindex message-cite-function
518 @findex message-cite-original
519 @findex sc-cite-original
520 @findex message-cite-original-without-signature
522 Function for citing an original message. The default is
523 @code{message-cite-original}, which simply inserts the original message
524 and prepends @samp{> } to each line.
525 @code{message-cite-original-without-signature} does the same, but elides
526 the signature. You can also set it to @code{sc-cite-original} to use
529 @item message-indent-citation-function
530 @vindex message-indent-citation-function
531 Function for modifying a citation just inserted in the mail buffer.
532 This can also be a list of functions. Each function can find the
533 citation between @code{(point)} and @code{(mark t)}. And each function
534 should leave point and mark around the citation text as modified.
536 @item message-signature
537 @vindex message-signature
538 String to be inserted at the end of the message buffer. If @code{t}
539 (which is the default), the @code{message-signature-file} file will be
540 inserted instead. If a function, the result from the function will be
541 used instead. If a form, the result from the form will be used instead.
542 If this variable is @code{nil}, no signature will be inserted at all.
544 @item message-signature-file
545 @vindex message-signature-file
546 File containing the signature to be inserted at the end of the buffer.
547 The default is @samp{~/.signature}.
551 Note that RFC1036bis says that a signature should be preceded by the three
552 characters @samp{-- } on a line by themselves. This is to make it
553 easier for the recipient to automatically recognize and process the
554 signature. So don't remove those characters, even though you might feel
555 that they ruin your beautiful design, like, totally.
557 Also note that no signature should be more than four lines long.
558 Including ASCII graphics is an efficient way to get everybody to believe
559 that you are silly and have nothing important to say.
569 Message is a @sc{mime}-compliant posting agent. The user generally
570 doesn't have to do anything to make the @sc{mime} happen---Message will
571 automatically add the @code{Content-Type} and
572 @code{Content-Transfer-Encoding} headers.
574 The most typical thing users want to use the multipart things in
575 @sc{mime} for is to add ``attachments'' to mail they send out. This can
576 be done with the @code{C-c C-a} command, which will prompt for a file
577 name and a @sc{mime} type.
579 You can also create arbitrarily complex multiparts using the MML
580 language (@pxref{Composing, , Composing, emacs-mime, The Emacs MIME
591 Using the MML language, Message is able to create digitally signed and
592 digitally encrypted messages. Message (or rather MML) currently support
593 PGP/MIME and S/MIME. Instructing MML to perform security operations on
594 a MIME part is done using the @code{M-m s} key map for signing and the
595 @code{M-m c} key map for encryption, as follows.
601 @findex mml-secure-sign-smime
603 Digitally sign current MIME part using S/MIME.
607 @findex mml-secure-sign-pgp
609 Digitally sign current MIME part using PGP/MIME.
613 @findex mml-secure-encrypt-smime
615 Digitally encrypt current MIME part using S/MIME.
619 @findex mml-secure-encrypt-pgpmime
621 Digitally encrypt current MIME part using PGP/MIME.
625 These commands do not immediately sign or encrypt the message, they
626 merely insert proper MML tags to instruct the MML engine to perform that
627 operation when the message is actually sent. They may perform other
628 operations too, such as locating and retrieving a S/MIME certificate of
629 the person you wish to send encrypted mail to.
631 Since signing and especially encryption often is used when sensitive
632 information is sent, you may want to have some way to ensure that your
633 mail is actually signed or encrypted. After invoking the above
634 sign/encrypt commands, it is possible to preview the raw article by
635 using @code{C-u M-m P} (@code{mml-preview}). Then you can verify that
636 your long rant about what your ex-significant other or whomever actually
637 did with that funny looking person at that strange party the other
638 night, actually will be sent encrypted.
640 @emph{Note!} Neither PGP/MIME nor S/MIME encrypt/signs RFC822 headers.
641 They only operate on the MIME object. Keep this in mind before sending
642 mail with a sensitive Subject line.
644 Actually using the security commands above is not very difficult. At
645 least not compared with making sure all involved programs talk with each
646 other properly. Thus, we now describe what external libraries or
647 programs are required to make things work, and some small general hints.
649 @subsection Using S/MIME
651 @emph{Note!} This section assume you have a basic familiarity with
652 modern cryptography, S/MIME, various PKCS standards, OpenSSL and so on.
654 The S/MIME support in Message (and MML) require OpenSSL. OpenSSL
655 perform the actual S/MIME sign/encrypt operations. OpenSSL can be found
656 at @code{http://www.openssl.org/}. OpenSSL 0.9.5a and later should
657 work. However, version 0.9.5a insert a spurious CR character into MIME
658 separators so you may wish to avoid it if you would like to avoid being
659 regarded as someone who send strange mail. (Although by sending S/MIME
660 messages you've probably already lost that contest.)
662 To be able to send encrypted mail, a personal certificate is not
663 required. Message (MML) need a certificate for the person to whom you
664 wish to communicate with though. You're asked for this when you type
665 @code{M-m c s}. Currently there are two ways to retrieve this
666 certificate, from a local file or from DNS. If you chose a local file,
667 it need to contain a X.509 certificate in PEM format. If you chose DNS,
668 you're asked for the domain name where the certificate is stored, the
669 default is a good guess. To my belief, Message (MML) is the first mail
670 agent in the world to support retrieving S/MIME certificates from DNS,
671 so you're not likely to find very many certificates out there. At least
672 there should be one, stored at the domain @code{simon.josefsson.org}.
673 LDAP is a more popular method of distributing certificates, support for
674 it is planned. (Meanwhile, you can use @code{ldapsearch} from the
675 command line to retrieve a certificate into a file and use it.)
677 As for signing messages, OpenSSL can't perform signing operations
678 without some kind of configuration. Especially, you need to tell it
679 where your private key and your certificate is stored. MML uses an
680 Emacs interface to OpenSSL, aptly named @code{smime.el}, and it contain
681 a @code{custom} group used for this configuration. So, try @code{M-x
682 customize-group RET smime RET} and look around.
684 Currently there is no support for talking to a CA (or RA) to create your
685 own certificate. None is planned either. You need to do this manually
686 with OpenSSL or using some other program. I used Netscape and got a
687 free S/MIME certificate from one of the big CA's on the net. Netscape
688 is able to export your private key and certificate in PKCS #12 format.
689 Use OpenSSL to convert this into a plain X.509 certificate in PEM format
693 $ openssl pkcs12 -in ns.p12 -clcerts -nodes > key+cert.pem
696 The @code{key+cert.pem} file should be pointed to from the
697 @code{smime-keys} variable. You should now be able to send signed mail.
699 @emph{Note!} Your private key is store unencrypted in the file, so take
702 @subsection Using PGP/MIME
704 PGP/MIME require an external OpenPGP implementation, such as GNU Privacy
705 Guard (@code{http://www.gnupg.org/}. It also require a Emacs interface
706 to it, such as Mailcrypt (available from
707 @code{http://www.nb.net/~lbudney/linux/software/mailcrypt.html}) or
708 Florian Weimer's @code{gpg.el}.
710 Creating your own OpenPGP key is described in detail in the
711 documentation of your OpenPGP implementation, so we refer to it.
713 @node Various Commands
714 @section Various Commands
720 @findex message-caesar-buffer-body
721 Caesar rotate (aka. rot13) the current message
722 (@code{message-caesar-buffer-body}). If narrowing is in effect, just
723 rotate the visible portion of the buffer. A numerical prefix says how
724 many places to rotate the text. The default is 13.
728 @findex message-elide-region
729 Elide the text between point and mark (@code{message-elide-region}).
730 The text is killed and replaced with the contents of the variable
731 @code{message-elide-ellipsis}. The default value is to use an ellipsis
736 @findex message-kill-to-signature
737 Kill all the text up to the signature, or if that's missing, up to the
738 end of the message (@code{message-kill-to-signature}).
742 @findex message-delete-not-region
743 Delete all text in the body of the message that is outside the region
744 (@code{message-delete-not-region}).
748 @kindex message-newline-and-reformat
749 Insert four newlines, and then reformat if inside quoted text.
754 > This is some quoted text. And here's more quoted text.
757 If point is before @samp{And} and you press @kbd{M-RET}, you'll get:
760 > This is some quoted text.
764 > And here's more quoted text.
767 @samp{*} says where point will be placed.
771 @findex message-insert-to
772 Insert a @code{To} header that contains the @code{Reply-To} or
773 @code{From} header of the message you're following up
774 (@code{message-insert-to}).
778 @findex message-insert-newsgroups
779 Insert a @code{Newsgroups} header that reflects the @code{Followup-To}
780 or @code{Newsgroups} header of the article you're replying to
781 (@code{message-insert-newsgroups}).
785 @findex message-rename-buffer
786 Rename the buffer (@code{message-rename-buffer}). If given a prefix,
787 prompt for a new buffer name.
798 @findex message-send-and-exit
799 Send the message and bury the current buffer
800 (@code{message-send-and-exit}).
805 Send the message (@code{message-send}).
809 @findex message-dont-send
810 Bury the message buffer and exit (@code{message-dont-send}).
814 @findex message-kill-buffer
815 Kill the message buffer and exit (@code{message-kill-buffer}).
822 @section Mail Aliases
826 @vindex message-mail-alias-type
827 The @code{message-mail-alias-type} variable controls what type of mail
828 alias expansion to use. Currently only one form is supported---Message
829 uses @code{mailabbrev} to handle mail aliases. If this variable is
830 @code{nil}, no mail alias expansion will be performed.
832 @code{mailabbrev} works by parsing the @file{/etc/mailrc} and
833 @file{~/.mailrc} files. These files look like:
836 alias lmi "Lars Magne Ingebrigtsen <larsi@@ifi.uio.no>"
837 alias ding "ding@@ifi.uio.no (ding mailing list)"
840 After adding lines like this to your @file{~/.mailrc} file, you should
841 be able to just write @samp{lmi} in the @code{To} or @code{Cc} (and so
842 on) headers and press @kbd{SPC} to expand the alias.
844 No expansion will be performed upon sending of the message---all
845 expansions have to be done explicitly.
853 * Message Headers:: General message header stuff.
854 * Mail Headers:: Customizing mail headers.
855 * Mail Variables:: Other mail variables.
856 * News Headers:: Customizing news headers.
857 * News Variables:: Other news variables.
858 * Various Message Variables:: Other message variables.
859 * Sending Variables:: Variables for sending.
860 * Message Buffers:: How Message names its buffers.
861 * Message Actions:: Actions to be performed when exiting.
865 @node Message Headers
866 @section Message Headers
868 Message is quite aggressive on the message generation front. It has to
869 be -- it's a combined news and mail agent. To be able to send combined
870 messages, it has to generate all headers itself (instead of letting the
871 mail/news system do it) to ensure that mail and news copies of messages
872 look sufficiently similar.
876 @item message-generate-headers-first
877 @vindex message-generate-headers-first
878 If non-@code{nil}, generate all headers before starting to compose the
881 @item message-from-style
882 @vindex message-from-style
883 Specifies how @code{From} headers should look. There are four valid
888 Just the address -- @samp{king@@grassland.com}.
891 @samp{king@@grassland.com (Elvis Parsley)}.
894 @samp{Elvis Parsley <king@@grassland.com>}.
897 Look like @code{angles} if that doesn't require quoting, and
898 @code{parens} if it does. If even @code{parens} requires quoting, use
899 @code{angles} anyway.
903 @item message-deletable-headers
904 @vindex message-deletable-headers
905 Headers in this list that were previously generated by Message will be
906 deleted before posting. Let's say you post an article. Then you decide
907 to post it again to some other group, you naughty boy, so you jump back
908 to the @code{*post-buf*} buffer, edit the @code{Newsgroups} line, and
909 ship it off again. By default, this variable makes sure that the old
910 generated @code{Message-ID} is deleted, and a new one generated. If
911 this isn't done, the entire empire would probably crumble, anarchy would
912 prevail, and cats would start walking on two legs and rule the world.
915 @item message-default-headers
916 @vindex message-default-headers
917 This string is inserted at the end of the headers in all message
920 @item message-subject-re-regexp
921 @vindex message-subject-re-regexp
922 Responses to messages have subjects that start with @samp{Re: }. This
923 is @emph{not} an abbreviation of the English word ``response'', but in
924 Latin, and means ``in response to''. Some illiterate nincompoops have
925 failed to grasp this fact, and have ``internationalized'' their software
926 to use abonimations like @samp{Aw: } (``antwort'') or @samp{Sv: }
927 (``svar'') instead, which is meaningless and evil. However, you may
928 have to deal with users that use these evil tools, in which case you may
929 set this variable to a regexp that matches these prefixes. Myself, I
930 just throw away non-compliant mail.
932 @item message-alternative-emails
933 @vindex message-alternative-emails
934 A regexp to match the alternative email addresses. The first matched
935 address (not primary one) is used in the @code{From} field.
941 @section Mail Headers
944 @item message-required-mail-headers
945 @vindex message-required-mail-headers
946 @xref{News Headers}, for the syntax of this variable. It is
947 @code{(From Date Subject (optional . In-Reply-To) Message-ID Lines
948 (optional . X-Mailer))} by default.
950 @item message-ignored-mail-headers
951 @vindex message-ignored-mail-headers
952 Regexp of headers to be removed before mailing. The default is
953 @samp{^[GF]cc:\\|^Resent-Fcc:}.
955 @item message-default-mail-headers
956 @vindex message-default-mail-headers
957 This string is inserted at the end of the headers in all message
958 buffers that are initialized as mail.
964 @section Mail Variables
967 @item message-send-mail-function
968 @vindex message-send-mail-function
969 Function used to send the current buffer as mail. The default is
970 @code{message-send-mail-with-sendmail}. If you prefer using MH
971 instead, set this variable to @code{message-send-mail-with-mh}.
973 @item message-mh-deletable-headers
974 @vindex message-mh-deletable-headers
975 Most versions of MH doesn't like being fed messages that contain the
976 headers in this variable. If this variable is non-@code{nil} (which is
977 the default), these headers will be removed before mailing when sending
978 messages via MH. Set it to @code{nil} if your MH can handle these
985 @section News Headers
987 @vindex message-required-news-headers
988 @code{message-required-news-headers} a list of header symbols. These
989 headers will either be automatically generated, or, if that's
990 impossible, they will be prompted for. The following symbols are valid:
996 @findex user-full-name
997 @findex user-mail-address
998 This required header will be filled out with the result of the
999 @code{message-make-from} function, which depends on the
1000 @code{message-from-style}, @code{user-full-name},
1001 @code{user-mail-address} variables.
1005 This required header will be prompted for if not present already.
1009 This required header says which newsgroups the article is to be posted
1010 to. If it isn't present already, it will be prompted for.
1013 @cindex organization
1014 This optional header will be filled out depending on the
1015 @code{message-user-organization} variable.
1016 @code{message-user-organization-file} will be used if this variable is
1017 @code{t}. This variable can also be a string (in which case this string
1018 will be used), or it can be a function (which will be called with no
1019 parameters and should return a string to be used).
1023 This optional header will be computed by Message.
1027 @vindex mail-host-address
1030 This required header will be generated by Message. A unique ID will be
1031 created based on the date, time, user name and system name. Message
1032 will use @code{system-name} to determine the name of the system. If
1033 this isn't a fully qualified domain name (FQDN), Message will use
1034 @code{mail-host-address} as the FQDN of the machine.
1037 @cindex X-Newsreader
1038 This optional header will be filled out according to the
1039 @code{message-newsreader} local variable.
1042 This optional header will be filled out according to the
1043 @code{message-mailer} local variable, unless there already is an
1044 @code{X-Newsreader} header present.
1047 This optional header is filled out using the @code{Date} and @code{From}
1048 header of the article being replied to.
1052 This extremely optional header will be inserted according to the
1053 @code{message-expires} variable. It is highly deprecated and shouldn't
1054 be used unless you know what you're doing.
1057 @cindex Distribution
1058 This optional header is filled out according to the
1059 @code{message-distribution-function} variable. It is a deprecated and
1060 much misunderstood header.
1064 This extremely optional header should probably never be used.
1065 However, some @emph{very} old servers require that this header is
1066 present. @code{message-user-path} further controls how this
1067 @code{Path} header is to look. If it is @code{nil}, use the server name
1068 as the leaf node. If it is a string, use the string. If it is neither
1069 a string nor @code{nil}, use the user name only. However, it is highly
1070 unlikely that you should need to fiddle with this variable at all.
1074 @cindex Mime-Version
1075 In addition, you can enter conses into this list. The car of this cons
1076 should be a symbol. This symbol's name is the name of the header, and
1077 the cdr can either be a string to be entered verbatim as the value of
1078 this header, or it can be a function to be called. This function should
1079 return a string to be inserted. For instance, if you want to insert
1080 @code{Mime-Version: 1.0}, you should enter @code{(Mime-Version . "1.0")}
1081 into the list. If you want to insert a funny quote, you could enter
1082 something like @code{(X-Yow . yow)} into the list. The function
1083 @code{yow} will then be called without any arguments.
1085 If the list contains a cons where the car of the cons is
1086 @code{optional}, the cdr of this cons will only be inserted if it is
1089 Other variables for customizing outgoing news articles:
1093 @item message-syntax-checks
1094 @vindex message-syntax-checks
1095 Controls what syntax checks should not be performed on outgoing posts.
1096 To disable checking of long signatures, for instance, add
1099 (signature . disabled)
1108 Check the subject for commands.
1111 Insert a new @code{Sender} header if the @code{From} header looks odd.
1112 @item multiple-headers
1113 Check for the existence of multiple equal headers.
1116 Check for the existence of version and sendsys commands.
1118 Check whether the @code{Message-ID} looks ok.
1120 Check whether the @code{From} header seems nice.
1123 Check for too long lines.
1125 Check for invalid characters.
1127 Check for excessive size.
1129 Check whether there is any new text in the messages.
1131 Check the length of the signature.
1134 Check whether the article has an @code{Approved} header, which is
1135 something only moderators should include.
1137 Check whether the article is empty.
1138 @item invisible-text
1139 Check whether there is any invisible text in the buffer.
1141 Check whether any of the headers are empty.
1142 @item existing-newsgroups
1143 Check whether the newsgroups mentioned in the @code{Newsgroups} and
1144 @code{Followup-To} headers exist.
1145 @item valid-newsgroups
1146 Check whether the @code{Newsgroups} and @code{Followup-to} headers
1147 are valid syntactically.
1148 @item repeated-newsgroups
1149 Check whether the @code{Newsgroups} and @code{Followup-to} headers
1150 contains repeated group names.
1151 @item shorten-followup-to
1152 Check whether to add a @code{Followup-to} header to shorten the number
1153 of groups to post to.
1156 All these conditions are checked by default.
1158 @item message-ignored-news-headers
1159 @vindex message-ignored-news-headers
1160 Regexp of headers to be removed before posting. The default is@*
1161 @samp{^NNTP-Posting-Host:\\|^Xref:\\|^[BGF]cc:\\|^Resent-Fcc:}.
1163 @item message-default-news-headers
1164 @vindex message-default-news-headers
1165 This string is inserted at the end of the headers in all message
1166 buffers that are initialized as news.
1171 @node News Variables
1172 @section News Variables
1175 @item message-send-news-function
1176 @vindex message-send-news-function
1177 Function used to send the current buffer as news. The default is
1178 @code{message-send-news}.
1180 @item message-post-method
1181 @vindex message-post-method
1182 Gnusish @dfn{select method} (see the Gnus manual for details) used for
1183 posting a prepared news message.
1188 @node Various Message Variables
1189 @section Various Message Variables
1192 @item message-default-charset
1193 @vindex message-default-charset
1195 Symbol naming a @sc{mime} charset. Non-ASCII characters in messages are
1196 assumed to be encoded using this charset. The default is @code{nil},
1197 which means ask the user. (This variable is used only on non-@sc{mule}
1199 @xref{Charset Translation, , Charset Translation, emacs-mime,
1200 Emacs MIME Manual}, for details on the @sc{mule}-to-@sc{mime}
1201 translation process.
1203 @item message-signature-separator
1204 @vindex message-signature-separator
1205 Regexp matching the signature separator. It is @samp{^-- *$} by
1208 @item mail-header-separator
1209 @vindex mail-header-separator
1210 String used to separate the headers from the body. It is @samp{--text
1211 follows this line--} by default.
1213 @item message-directory
1214 @vindex message-directory
1215 Directory used by many mailey things. The default is @file{~/Mail/}.
1217 @item message-signature-setup-hook
1218 @vindex message-signature-setup-hook
1219 Hook run when initializing the message buffer. It is run after the
1220 headers have been inserted but before the signature has been inserted.
1222 @item message-setup-hook
1223 @vindex message-setup-hook
1224 Hook run as the last thing when the message buffer has been initialized,
1225 but before yanked text is inserted.
1227 @item message-header-setup-hook
1228 @vindex message-header-setup-hook
1229 Hook called narrowed to the headers after initializing the headers.
1231 For instance, if you're running Gnus and wish to insert a
1232 @samp{Mail-Copies-To} header in all your news articles and all messages
1233 you send to mailing lists, you could do something like the following:
1236 (defun my-message-header-setup-hook ()
1237 (let ((group (or gnus-newsgroup-name "")))
1238 (when (or (message-fetch-field "newsgroups")
1239 (gnus-group-find-parameter group 'to-address)
1240 (gnus-group-find-parameter group 'to-list))
1241 (insert "Mail-Copies-To: never\n"))))
1243 (add-hook 'message-header-setup-hook
1244 'my-message-header-setup-hook)
1247 @item message-send-hook
1248 @vindex message-send-hook
1249 Hook run before sending messages.
1251 If you want to add certain headers before sending, you can use the
1252 @code{message-add-header} function in this hook. For instance:
1253 @findex message-add-header
1256 (add-hook 'message-send-hook 'my-message-add-content)
1257 (defun my-message-add-content ()
1259 "X-In-No-Sense: Nonsense"
1263 This function won't add the header if the header is already present.
1265 @item message-send-mail-hook
1266 @vindex message-send-mail-hook
1267 Hook run before sending mail messages.
1269 @item message-send-news-hook
1270 @vindex message-send-news-hook
1271 Hook run before sending news messages.
1273 @item message-sent-hook
1274 @vindex message-sent-hook
1275 Hook run after sending messages.
1277 @item message-mode-syntax-table
1278 @vindex message-mode-syntax-table
1279 Syntax table used in message mode buffers.
1281 @item message-send-method-alist
1282 @vindex message-send-method-alist
1284 Alist of ways to send outgoing messages. Each element has the form
1287 (TYPE PREDICATE FUNCTION)
1292 A symbol that names the method.
1295 A function called without any parameters to determine whether the
1296 message is a message of type @var{type}.
1299 A function to be called if @var{predicate} returns non-@code{nil}.
1300 @var{function} is called with one parameter -- the prefix.
1304 ((news message-news-p message-send-via-news)
1305 (mail message-mail-p message-send-via-mail))
1314 @node Sending Variables
1315 @section Sending Variables
1319 @item message-fcc-handler-function
1320 @vindex message-fcc-handler-function
1321 A function called to save outgoing articles. This function will be
1322 called with the name of the file to store the article in. The default
1323 function is @code{message-output} which saves in Unix mailbox format.
1325 @item message-courtesy-message
1326 @vindex message-courtesy-message
1327 When sending combined messages, this string is inserted at the start of
1328 the mailed copy. If the string contains the format spec @samp{%s}, the
1329 newsgroups the article has been posted to will be inserted there. If
1330 this variable is @code{nil}, no such courtesy message will be added.
1331 The default value is @samp{"The following message is a courtesy copy of
1332 an article\nthat has been posted to %s as well.\n\n"}.
1337 @node Message Buffers
1338 @section Message Buffers
1340 Message will generate new buffers with unique buffer names when you
1341 request a message buffer. When you send the message, the buffer isn't
1342 normally killed off. Its name is changed and a certain number of old
1343 message buffers are kept alive.
1346 @item message-generate-new-buffers
1347 @vindex message-generate-new-buffers
1348 If non-@code{nil}, generate new buffers. The default is @code{t}. If
1349 this is a function, call that function with three parameters: The type,
1350 the to address and the group name. (Any of these may be @code{nil}.)
1351 The function should return the new buffer name.
1353 @item message-use-multi-frames
1354 @vindex message-use-multi-frames
1355 If non-@code{nil}, generate new frames. The default is @code{nil}.
1357 @item message-delete-frame-on-exit
1358 @vindex message-delete-frame-on-exit
1359 The @code{message-delete-frame-on-exit} variable says whether to delete
1360 the frame after sending the message or killing the message buffer. If it
1361 is @code{nil} (which is the default), don't delete the frame. If it is
1362 @code{ask}, ask wheter to delete the frame. If it is @code{t}, always
1365 @item message-max-buffers
1366 @vindex message-max-buffers
1367 This variable says how many old message buffers to keep. If there are
1368 more message buffers than this, the oldest buffer will be killed. The
1369 default is 10. If this variable is @code{nil}, no old message buffers
1370 will ever be killed.
1372 @item message-send-rename-function
1373 @vindex message-send-rename-function
1374 After sending a message, the buffer is renamed from, for instance,
1375 @samp{*reply to Lars*} to @samp{*sent reply to Lars*}. If you don't
1376 like this, set this variable to a function that renames the buffer in a
1377 manner you like. If you don't want to rename the buffer at all, you can
1381 (setq message-send-rename-function 'ignore)
1384 @item message-kill-buffer-on-exit
1385 @findex message-kill-buffer-on-exit
1386 If non-@code{nil}, kill the buffer immediately on exit.
1391 @node Message Actions
1392 @section Message Actions
1394 When Message is being used from a news/mail reader, the reader is likely
1395 to want to perform some task after the message has been sent. Perhaps
1396 return to the previous window configuration or mark an article as
1399 @vindex message-kill-actions
1400 @vindex message-postpone-actions
1401 @vindex message-exit-actions
1402 @vindex message-send-actions
1403 The user may exit from the message buffer in various ways. The most
1404 common is @kbd{C-c C-c}, which sends the message and exits. Other
1405 possibilities are @kbd{C-c C-s} which just sends the message, @kbd{C-c
1406 C-d} which postpones the message editing and buries the message buffer,
1407 and @kbd{C-c C-k} which kills the message buffer. Each of these actions
1408 have lists associated with them that contains actions to be executed:
1409 @code{message-send-actions}, @code{message-exit-actions},
1410 @code{message-postpone-actions}, and @code{message-kill-actions}.
1412 Message provides a function to interface with these lists:
1413 @code{message-add-action}. The first parameter is the action to be
1414 added, and the rest of the arguments are which lists to add this action
1415 to. Here's an example from Gnus:
1419 `(set-window-configuration ,(current-window-configuration))
1420 'exit 'postpone 'kill)
1423 This restores the Gnus window configuration when the message buffer is
1424 killed, postponed or exited.
1426 An @dfn{action} can be either: a normal function, or a list where the
1427 @code{car} is a function and the @code{cdr} is the list of arguments, or
1428 a form to be @code{eval}ed.
1432 @chapter Compatibility
1433 @cindex compatibility
1435 Message uses virtually only its own variables---older @code{mail-}
1436 variables aren't consulted. To force Message to take those variables
1437 into account, you can put the following in your @code{.emacs} file:
1440 (require 'messcompat)
1443 This will initialize many Message variables from the values in the
1444 corresponding mail variables.
1451 * Responses:: Standard rules for determining where responses go.
1458 To determine where a message is to go, the following algorithm is used
1463 A @dfn{reply} is when you want to respond @emph{just} to the person who
1464 sent the message via mail. There will only be one recipient. To
1465 determine who the recipient will be, the following headers are
1476 A @dfn{wide reply} is a mail response that includes @emph{all} entities
1477 mentioned in the message you are responded to. All mailboxes from the
1478 following headers will be concatenated to form the outgoing
1479 @code{To}/@code{Cc} headers:
1483 (unless there's a @code{Reply-To}, in which case that is used instead).
1490 If a @code{Mail-Copies-To} header is present, it will also be included
1491 in the list of mailboxes. If this header is @samp{never}, that means
1492 that the @code{From} (or @code{Reply-To}) mailbox will be suppressed.
1496 A @dfn{followup} is a response sent via news. The following headers
1497 (listed in order of precedence) determine where the response is to be
1508 If a @code{Mail-Copies-To} header is present, it will be used as the
1509 basis of the new @code{Cc} header, except if this header is