1 \input texinfo @c -*-texinfo-*-
4 @settitle Message Manual
9 This file documents Message, the Emacs message composition mode.
11 Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
12 Free Software Foundation, Inc.
15 Permission is granted to copy, distribute and/or modify this document
16 under the terms of the GNU Free Documentation License, Version 1.1 or
17 any later version published by the Free Software Foundation; with no
18 Invariant Sections, with the Front-Cover texts being ``A GNU
19 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
20 license is included in the section entitled ``GNU Free Documentation
21 License'' in the Emacs manual.
23 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
24 this GNU Manual, like GNU software. Copies published by the Free
25 Software Foundation raise funds for GNU development.''
27 This document is part of a collection distributed under the GNU Free
28 Documentation License. If you want to distribute this document
29 separately from the collection, you can do so by adding a copy of the
30 license to the document, as described in section 6 of the license.
36 * Message: (message). Mail and news composition mode that goes with Gnus.
41 @setchapternewpage odd
46 @author by Lars Magne Ingebrigtsen
49 @vskip 0pt plus 1filll
57 All message composition from Gnus (both mail and news) takes place in
61 * Interface:: Setting up message buffers.
62 * Commands:: Commands you can execute in message mode buffers.
63 * Variables:: Customizing the message buffers.
64 * Compatibility:: Making Message backwards compatible.
65 * Appendices:: More technical things.
66 * Index:: Variable, function and concept index.
67 * Key Index:: List of Message mode keys.
70 This manual corresponds to Message v5.10.6. Message is distributed
71 with the Gnus distribution bearing the same version number as this
78 When a program (or a person) wants to respond to a message---reply,
79 follow up, forward, cancel---the program (or person) should just put
80 point in the buffer where the message is and call the required command.
81 @code{Message} will then pop up a new @code{message} mode buffer with
82 appropriate headers filled out, and the user can edit the message before
86 * New Mail Message:: Editing a brand new mail message.
87 * New News Message:: Editing a brand new news message.
88 * Reply:: Replying via mail.
89 * Wide Reply:: Responding to all people via mail.
90 * Followup:: Following up via news.
91 * Canceling News:: Canceling a news article.
92 * Superseding:: Superseding a message.
93 * Forwarding:: Forwarding a message via news or mail.
94 * Resending:: Resending a mail message.
95 * Bouncing:: Bouncing a mail message.
96 * Mailing Lists:: Send mail to mailing lists.
100 @node New Mail Message
101 @section New Mail Message
104 The @code{message-mail} command pops up a new message buffer.
106 Two optional parameters are accepted: The first will be used as the
107 @code{To} header and the second as the @code{Subject} header. If these
108 are @code{nil}, those two headers will be empty.
111 @node New News Message
112 @section New News Message
115 The @code{message-news} command pops up a new message buffer.
117 This function accepts two optional parameters. The first will be used
118 as the @code{Newsgroups} header and the second as the @code{Subject}
119 header. If these are @code{nil}, those two headers will be empty.
125 @findex message-reply
126 The @code{message-reply} function pops up a message buffer that's a
127 reply to the message in the current buffer.
129 @vindex message-reply-to-function
130 Message uses the normal methods to determine where replies are to go
131 (@pxref{Responses}), but you can change the behavior to suit your needs
132 by fiddling with the @code{message-reply-to-function} variable.
134 If you want the replies to go to the @code{Sender} instead of the
135 @code{From}, you could do something like this:
138 (setq message-reply-to-function
140 (cond ((equal (mail-fetch-field "from") "somebody")
141 (list (cons 'To (mail-fetch-field "sender"))))
146 This function will be called narrowed to the head of the article that is
149 As you can see, this function should return a string if it has an
150 opinion as to what the To header should be. If it does not, it should
151 just return @code{nil}, and the normal methods for determining the To
154 This function can also return a list. In that case, each list element
155 should be a cons, where the @sc{car} should be the name of a header
156 (e.g. @code{Cc}) and the @sc{cdr} should be the header value
157 (e.g. @samp{larsi@@ifi.uio.no}). All these headers will be inserted into
158 the head of the outgoing mail.
164 @findex message-wide-reply
165 The @code{message-wide-reply} pops up a message buffer that's a wide
166 reply to the message in the current buffer. A @dfn{wide reply} is a
167 reply that goes out to all people listed in the @code{To}, @code{From}
168 (or @code{Reply-to}) and @code{Cc} headers.
170 @vindex message-wide-reply-to-function
171 Message uses the normal methods to determine where wide replies are to go,
172 but you can change the behavior to suit your needs by fiddling with the
173 @code{message-wide-reply-to-function}. It is used in the same way as
174 @code{message-reply-to-function} (@pxref{Reply}).
176 @vindex message-dont-reply-to-names
177 Addresses that match the @code{message-dont-reply-to-names} regular
178 expression will be removed from the @code{Cc} header.
180 @vindex message-wide-reply-confirm-recipients
181 If @code{message-wide-reply-confirm-recipients} is non-@code{nil} you
182 will be asked to confirm that you want to reply to multiple
183 recipients. The default is @code{nil}.
188 @findex message-followup
189 The @code{message-followup} command pops up a message buffer that's a
190 followup to the message in the current buffer.
192 @vindex message-followup-to-function
193 Message uses the normal methods to determine where followups are to go,
194 but you can change the behavior to suit your needs by fiddling with the
195 @code{message-followup-to-function}. It is used in the same way as
196 @code{message-reply-to-function} (@pxref{Reply}).
198 @vindex message-use-followup-to
199 The @code{message-use-followup-to} variable says what to do about
200 @code{Followup-To} headers. If it is @code{use}, always use the value.
201 If it is @code{ask} (which is the default), ask whether to use the
202 value. If it is @code{t}, use the value unless it is @samp{poster}. If
203 it is @code{nil}, don't use the value.
207 @section Canceling News
209 @findex message-cancel-news
210 The @code{message-cancel-news} command cancels the article in the
213 @vindex message-cancel-message
214 The value of @code{message-cancel-message} is inserted in the body of
215 the cancel message. The default is @samp{I am canceling my own
219 @vindex message-insert-canlock
221 When Message posts news messages, it inserts @code{Cancel-Lock}
222 headers by default. This is a cryptographic header that ensures that
223 only you can cancel your own messages, which is nice. The downside
224 is that if you lose your @file{.emacs} file (which is where Gnus
225 stores the secret cancel lock password (which is generated
226 automatically the first time you use this feature)), you won't be
227 able to cancel your message. If you yourself want to manage a password,
228 you can put something like the following in your @file{~/.gnus.el} file:
231 (setq canlock-password "Salam Shalom"
232 canlock-password-for-verify canlock-password)
235 Whether to insert the header or not is controlled by the
236 @code{message-insert-canlock} variable.
238 Not many news servers respect the @code{Cancel-Lock} header yet, but
239 this is expected to change in the future.
245 @findex message-supersede
246 The @code{message-supersede} command pops up a message buffer that will
247 supersede the message in the current buffer.
249 @vindex message-ignored-supersedes-headers
250 Headers matching the @code{message-ignored-supersedes-headers} are
251 removed before popping up the new message buffer. The default is@*
252 @samp{^Path:\\|^Date\\|^NNTP-Posting-Host:\\|^Xref:\\|^Lines:\\|@*
253 ^Received:\\|^X-From-Line:\\|Return-Path:\\|^Supersedes:}.
260 @findex message-forward
261 The @code{message-forward} command pops up a message buffer to forward
262 the message in the current buffer. If given a prefix, forward using
266 @item message-forward-ignored-headers
267 @vindex message-forward-ignored-headers
268 All headers that match this regexp will be deleted when forwarding a message.
270 @item message-make-forward-subject-function
271 @vindex message-make-forward-subject-function
272 A list of functions that are called to generate a subject header for
273 forwarded messages. The subject generated by the previous function is
274 passed into each successive function.
276 The provided functions are:
279 @item message-forward-subject-author-subject
280 @findex message-forward-subject-author-subject
281 Source of article (author or newsgroup), in brackets followed by the
284 @item message-forward-subject-fwd
285 Subject of article with @samp{Fwd:} prepended to it.
288 @item message-wash-forwarded-subjects
289 @vindex message-wash-forwarded-subjects
290 If this variable is @code{t}, the subjects of forwarded messages have
291 the evidence of previous forwards (such as @samp{Fwd:}, @samp{Re:},
292 @samp{(fwd)}) removed before the new subject is
293 constructed. The default value is @code{nil}.
295 @item message-forward-as-mime
296 @vindex message-forward-as-mime
297 If this variable is @code{t} (the default), forwarded messages are
298 included as inline @acronym{MIME} RFC822 parts. If it's @code{nil}, forwarded
299 messages will just be copied inline to the new message, like previous,
300 non @acronym{MIME}-savvy versions of Gnus would do.
302 @item message-forward-before-signature
303 @vindex message-forward-before-signature
304 If non-@code{nil}, put forwarded message before signature, else after.
312 @findex message-resend
313 The @code{message-resend} command will prompt the user for an address
314 and resend the message in the current buffer to that address.
316 @vindex message-ignored-resent-headers
317 Headers that match the @code{message-ignored-resent-headers} regexp will
318 be removed before sending the message. The default is
319 @samp{^Return-receipt}.
325 @findex message-bounce
326 The @code{message-bounce} command will, if the current buffer contains a
327 bounced mail message, pop up a message buffer stripped of the bounce
328 information. A @dfn{bounced message} is typically a mail you've sent
329 out that has been returned by some @code{mailer-daemon} as
332 @vindex message-ignored-bounced-headers
333 Headers that match the @code{message-ignored-bounced-headers} regexp
334 will be removed before popping up the buffer. The default is
335 @samp{^\\(Received\\|Return-Path\\):}.
339 @section Mailing Lists
341 @cindex Mail-Followup-To
342 Sometimes while posting to mailing lists, the poster needs to direct
343 followups to the post to specific places. The Mail-Followup-To (MFT)
344 was created to enable just this. Two example scenarios where this is
349 A mailing list poster can use MFT to express that responses should be
350 sent to just the list, and not the poster as well. This will happen
351 if the poster is already subscribed to the list.
354 A mailing list poster can use MFT to express that responses should be
355 sent to the list and the poster as well. This will happen if the poster
356 is not subscribed to the list.
359 If a message is posted to several mailing lists, MFT may also be used
360 to direct the following discussion to one list only, because
361 discussions that are spread over several lists tend to be fragmented
362 and very difficult to follow.
366 Gnus honors the MFT header in other's messages (i.e. while following
367 up to someone else's post) and also provides support for generating
368 sensible MFT headers for outgoing messages as well.
371 @c * Honoring an MFT post:: What to do when one already exists
372 @c * Composing with a MFT header:: Creating one from scratch.
375 @c @node Composing with a MFT header
376 @subsection Composing a correct MFT header automagically
378 The first step in getting Gnus to automagically generate a MFT header
379 in posts you make is to give Gnus a list of the mailing lists
380 addresses you are subscribed to. You can do this in more than one
381 way. The following variables would come in handy.
385 @vindex message-subscribed-addresses
386 @item message-subscribed-addresses
387 This should be a list of addresses the user is subscribed to. Its
388 default value is @code{nil}. Example:
390 (setq message-subscribed-addresses
391 '("ding@@gnus.org" "bing@@noose.org"))
394 @vindex message-subscribed-regexps
395 @item message-subscribed-regexps
396 This should be a list of regexps denoting the addresses of mailing
397 lists subscribed to. Default value is @code{nil}. Example: If you
398 want to achieve the same result as above:
400 (setq message-subscribed-regexps
401 '("\\(ding@@gnus\\)\\|\\(bing@@noose\\)\\.org")
404 @vindex message-subscribed-address-functions
405 @item message-subscribed-address-functions
406 This can be a list of functions to be called (one at a time!!) to
407 determine the value of MFT headers. It is advisable that these
408 functions not take any arguments. Default value is @code{nil}.
410 There is a pre-defined function in Gnus that is a good candidate for
411 this variable. @code{gnus-find-subscribed-addresses} is a function
412 that returns a list of addresses corresponding to the groups that have
413 the @code{subscribed} (@pxref{Group Parameters, ,Group Parameters,
414 gnus, The Gnus Manual}) group parameter set to a non-@code{nil} value.
415 This is how you would do it.
418 (setq message-subscribed-address-functions
419 '(gnus-find-subscribed-addresses))
422 @vindex message-subscribed-address-file
423 @item message-subscribed-address-file
424 You might be one organised human freak and have a list of addresses of
425 all subscribed mailing lists in a separate file! Then you can just
426 set this variable to the name of the file and life would be good.
430 You can use one or more of the above variables. All their values are
431 ``added'' in some way that works :-)
433 Now you are all set. Just start composing a message as you normally do.
434 And just send it; as always. Just before the message is sent out, Gnus'
435 MFT generation thingy kicks in and checks if the message already has a
436 MFT field. If there is one, it is left alone. (Except if it's empty -
437 in that case, the field is removed and is not replaced with an
438 automatically generated one. This lets you disable MFT generation on a
439 per-message basis.) If there is none, then the list of recipient
440 addresses (in the To: and Cc: headers) is checked to see if one of them
441 is a list address you are subscribed to. If none of them is a list
442 address, then no MFT is generated; otherwise, a MFT is added to the
443 other headers and set to the value of all addresses in To: and Cc:
446 @findex message-generate-unsubscribed-mail-followup-to
448 @findex message-goto-mail-followup-to
449 Hm. ``So'', you ask, ``what if I send an email to a list I am not
450 subscribed to? I want my MFT to say that I want an extra copy.'' (This
451 is supposed to be interpreted by others the same way as if there were no
452 MFT, but you can use an explicit MFT to override someone else's
453 to-address group parameter.) The function
454 @code{message-generate-unsubscribed-mail-followup-to} might come in
455 handy. It is bound to @kbd{C-c C-f C-a} by default. In any case, you
456 can insert a MFT of your own choice; @kbd{C-c C-f C-m}
457 (@code{message-goto-mail-followup-to}) will help you get started.
459 @c @node Honoring an MFT post
460 @subsection Honoring an MFT post
462 @vindex message-use-mail-followup-to
463 When you followup to a post on a mailing list, and the post has a MFT
464 header, Gnus' action will depend on the value of the variable
465 @code{message-use-mail-followup-to}. This variable can be one of:
469 Always honor MFTs. The To: and Cc: headers in your followup will be
470 derived from the MFT header of the original post. This is the default.
473 Always dishonor MFTs (just ignore the darned thing)
476 Gnus will prompt you for an action.
480 It is considered good netiquette to honor MFT, as it is assumed the
481 fellow who posted a message knows where the followups need to go
488 * Buffer Entry:: Commands after entering a Message buffer.
489 * Header Commands:: Commands for moving headers or changing headers.
490 * Movement:: Moving around in message buffers.
491 * Insertion:: Inserting things into message buffers.
492 * MIME:: @acronym{MIME} considerations.
493 * IDNA:: Non-@acronym{ASCII} domain name considerations.
494 * Security:: Signing and encrypting messages.
495 * Various Commands:: Various things.
496 * Sending:: Actually sending the message.
497 * Mail Aliases:: How to use mail aliases.
498 * Spelling:: Having Emacs check your spelling.
503 @section Buffer Entry
507 You most often end up in a Message buffer when responding to some other
508 message of some sort. Message does lots of handling of quoted text, and
509 may remove signatures, reformat the text, or the like---depending on
510 which used settings you're using. Message usually gets things right,
511 but sometimes it stumbles. To help the user unwind these stumblings,
512 Message sets the undo boundary before each major automatic action it
513 takes. If you press the undo key (usually located at @kbd{C-_}) a few
514 times, you will get back the un-edited message you're responding to.
517 @node Header Commands
518 @section Header Commands
520 @subsection Commands for moving to headers
522 These following commands move to the header in question. If it doesn't
523 exist, it will be inserted.
529 @findex describe-mode
530 Describe the message mode.
534 @findex message-goto-to
535 Go to the @code{To} header (@code{message-goto-to}).
539 @findex message-goto-from
540 Go to the @code{From} header (@code{message-goto-from}). (The ``o''
541 in the key binding is for Originator.)
545 @findex message-goto-bcc
546 Go to the @code{Bcc} header (@code{message-goto-bcc}).
550 @findex message-goto-fcc
551 Go to the @code{Fcc} header (@code{message-goto-fcc}).
555 @findex message-goto-cc
556 Go to the @code{Cc} header (@code{message-goto-cc}).
560 @findex message-goto-subject
561 Go to the @code{Subject} header (@code{message-goto-subject}).
565 @findex message-goto-reply-to
566 Go to the @code{Reply-To} header (@code{message-goto-reply-to}).
570 @findex message-goto-newsgroups
571 Go to the @code{Newsgroups} header (@code{message-goto-newsgroups}).
575 @findex message-goto-distribution
576 Go to the @code{Distribution} header (@code{message-goto-distribution}).
580 @findex message-goto-followup-to
581 Go to the @code{Followup-To} header (@code{message-goto-followup-to}).
585 @findex message-goto-keywords
586 Go to the @code{Keywords} header (@code{message-goto-keywords}).
590 @findex message-goto-summary
591 Go to the @code{Summary} header (@code{message-goto-summary}).
595 @findex message-insert-or-toggle-importance
596 This inserts the @samp{Importance:} header with a value of
597 @samp{high}. This header is used to signal the importance of the
598 message to the receiver. If the header is already present in the
599 buffer, it cycles between the three valid values according to RFC
600 1376: @samp{low}, @samp{normal} and @samp{high}.
604 @findex message-generate-unsubscribed-mail-followup-to
605 Insert a reasonable @samp{Mail-Followup-To:} header
606 (@pxref{Mailing Lists}) in a post to an
607 unsubscribed list. When making original posts to a mailing list you are
608 not subscribed to, you have to type in a @samp{Mail-Followup-To:} header
609 by hand. The contents, usually, are the addresses of the list and your
610 own address. This function inserts such a header automatically. It
611 fetches the contents of the @samp{To:} header in the current mail
612 buffer, and appends the current @code{user-mail-address}.
614 If the optional argument @code{include-cc} is non-@code{nil}, the
615 addresses in the @samp{Cc:} header are also put into the
616 @samp{Mail-Followup-To:} header.
620 @subsection Commands to change headers
626 @findex message-sort-headers
627 @vindex message-header-format-alist
628 Sort headers according to @code{message-header-format-alist}
629 (@code{message-sort-headers}).
633 @findex message-insert-to
634 Insert a @code{To} header that contains the @code{Reply-To} or
635 @code{From} header of the message you're following up
636 (@code{message-insert-to}).
640 @findex message-insert-newsgroups
641 Insert a @code{Newsgroups} header that reflects the @code{Followup-To}
642 or @code{Newsgroups} header of the article you're replying to
643 (@code{message-insert-newsgroups}).
647 @findex message-to-list-only
648 Send a message to the list only. Remove all addresses but the list
649 address from @code{To:} and @code{Cc:} headers.
653 @findex message-insert-disposition-notification-to
654 Insert a request for a disposition
655 notification. (@code{message-insert-disposition-notification-to}).
656 This means that if the recipient support RFC 2298 she might send you a
657 notification that she received the message.
659 @item M-x message-insert-importance-high
660 @kindex M-x message-insert-importance-high
661 @findex message-insert-importance-high
663 Insert an @samp{Importance} header with a value of @samp{high},
664 deleting headers if necessary.
666 @item M-x message-insert-importance-low
667 @kindex M-x message-insert-importance-low
668 @findex message-insert-importance-low
670 Insert an @samp{Importance} header with a value of @samp{low}, deleting
671 headers if necessary.
675 @findex message-change-subject
677 Change the current @samp{Subject} header. Ask for new @samp{Subject}
678 header and append @samp{(was: <Old Subject>)}. The old subject can be
679 stripped on replying, see @code{message-subject-trailing-was-query}
680 (@pxref{Message Headers}).
684 @findex message-cross-post-followup-to
685 @vindex message-cross-post-default
688 Ask for an additional @samp{Newsgroups} and @samp{FollowUp-To} for a
689 cross-post. @code{message-cross-post-followup-to} mangles
690 @samp{FollowUp-To} and @samp{Newsgroups} header to point to group.
691 If @code{message-cross-post-default} is @code{nil} or if called with a
692 prefix-argument @samp{Follow-Up} is set, but the message is not
697 @findex message-reduce-to-to-cc
698 Replace contents of @samp{To} header with contents of @samp{Cc} or
703 @findex message-insert-wide-reply
704 Insert @samp{To} and @samp{Cc} headers as if you were doing a wide
709 @findex message-add-archive-header
710 @vindex message-archive-header
711 @vindex message-archive-note
713 Insert @samp{X-No-Archive: Yes} in the header and a note in the body.
714 The header and the note can be customized using
715 @code{message-archive-header} and @code{message-archive-note}. When
716 called with a prefix argument, ask for a text to insert. If you don't
717 want the note in the body, set @code{message-archive-note} to
729 @findex message-goto-body
730 Move to the beginning of the body of the message
731 (@code{message-goto-body}).
735 @findex message-goto-signature
736 Move to the signature of the message (@code{message-goto-signature}).
740 @findex message-beginning-of-line
741 @vindex message-beginning-of-line
742 If at beginning of header value, go to beginning of line, else go to
743 beginning of header value. (The header value comes after the header
744 name and the colon.) This behaviour can be disabled by toggling
745 the variable @code{message-beginning-of-line}.
757 @findex message-yank-original
758 Yank the message that's being replied to into the message buffer
759 (@code{message-yank-original}).
763 @findex message-yank-buffer
764 Prompt for a buffer name and yank the contents of that buffer into the
765 message buffer (@code{message-yank-buffer}).
769 @findex message-fill-yanked-message
770 Fill the yanked message (@code{message-fill-yanked-message}). Warning:
771 Can severely mess up the yanked text if its quoting conventions are
772 strange. You'll quickly get a feel for when it's safe, though. Anyway,
773 just remember that @kbd{C-x u} (@code{undo}) is available and you'll be
778 @findex message-insert-signature
779 Insert a signature at the end of the buffer
780 (@code{message-insert-signature}).
784 @findex message-insert-headers
785 Insert the message headers (@code{message-insert-headers}).
789 @findex message-mark-inserted-region
790 Mark some region in the current article with enclosing tags.
791 See @code{message-mark-insert-begin} and @code{message-mark-insert-end}.
795 @findex message-mark-insert-file
796 Insert a file in the current article with enclosing tags.
797 See @code{message-mark-insert-begin} and @code{message-mark-insert-end}.
809 Message is a @acronym{MIME}-compliant posting agent. The user generally
810 doesn't have to do anything to make the @acronym{MIME} happen---Message will
811 automatically add the @code{Content-Type} and
812 @code{Content-Transfer-Encoding} headers.
814 The most typical thing users want to use the multipart things in
815 @acronym{MIME} for is to add ``attachments'' to mail they send out.
816 This can be done with the @kbd{C-c C-a} command, which will prompt for
817 a file name and a @acronym{MIME} type. If your Emacs supports drag
818 and drop, you can also drop the file in the Message buffer.
820 You can also create arbitrarily complex multiparts using the @acronym{MML}
821 language (@pxref{Composing, , Composing, emacs-mime, The Emacs MIME
827 @cindex internationalized domain names
828 @cindex non-ascii domain names
830 Message is a @acronym{IDNA}-compliant posting agent. The user
831 generally doesn't have to do anything to make the @acronym{IDNA}
832 happen---Message will encode non-@acronym{ASCII} domain names in @code{From},
833 @code{To}, and @code{Cc} headers automatically.
835 Until @acronym{IDNA} becomes more well known, Message queries you
836 whether @acronym{IDNA} encoding of the domain name really should
837 occur. Some users might not be aware that domain names can contain
838 non-@acronym{ASCII} now, so this gives them a safety net if they accidently
839 typed a non-@acronym{ASCII} domain name.
841 @vindex message-use-idna
842 The @code{message-use-idna} variable control whether @acronym{IDNA} is
843 used. If the variable is @code{nil} no @acronym{IDNA} encoding will
844 ever happen, if it is set to the symbol @code{ask} the user will be
845 queried (the default), and if set to @code{t} @acronym{IDNA} encoding
846 happens automatically.
848 @findex message-idna-to-ascii-rhs
849 If you want to experiment with the @acronym{IDNA} encoding, you can
850 invoke @kbd{M-x message-idna-to-ascii-rhs RET} in the message buffer
851 to have the non-@acronym{ASCII} domain names encoded while you edit the message.
853 Note that you must have @uref{http://www.gnu.org/software/libidn/, GNU
854 Libidn} installed in order to use this functionality.
866 Using the @acronym{MML} language, Message is able to create digitally
867 signed and digitally encrypted messages. Message (or rather
868 @acronym{MML}) currently support @acronym{PGP} (RFC 1991),
869 @acronym{PGP/MIME} (RFC 2015/3156) and @acronym{S/MIME}. Instructing
870 @acronym{MML} to perform security operations on a @acronym{MIME} part is
871 done using the @kbd{C-c C-m s} key map for signing and the @kbd{C-c C-m
872 c} key map for encryption, as follows.
878 @findex mml-secure-message-sign-smime
880 Digitally sign current message using @acronym{S/MIME}.
884 @findex mml-secure-message-sign-pgp
886 Digitally sign current message using @acronym{PGP}.
890 @findex mml-secure-message-sign-pgpmime
892 Digitally sign current message using @acronym{PGP/MIME}.
896 @findex mml-secure-message-encrypt-smime
898 Digitally encrypt current message using @acronym{S/MIME}.
902 @findex mml-secure-message-encrypt-pgp
904 Digitally encrypt current message using @acronym{PGP}.
908 @findex mml-secure-message-encrypt-pgpmime
910 Digitally encrypt current message using @acronym{PGP/MIME}.
914 @findex mml-unsecure-message
915 Remove security related @acronym{MML} tags from message.
919 These commands do not immediately sign or encrypt the message, they
920 merely insert the proper @acronym{MML} secure tag to instruct the
921 @acronym{MML} engine to perform that operation when the message is
922 actually sent. They may perform other operations too, such as locating
923 and retrieving a @acronym{S/MIME} certificate of the person you wish to
924 send encrypted mail to. When the mml parsing engine converts your
925 @acronym{MML} into a properly encoded @acronym{MIME} message, the secure
926 tag will be replaced with either a part or a multipart tag. If your
927 message contains other mml parts, a multipart tag will be used; if no
928 other parts are present in your message a single part tag will be used.
929 This way, message mode will do the Right Thing (TM) with
930 signed/encrypted multipart messages.
932 Since signing and especially encryption often is used when sensitive
933 information is sent, you may want to have some way to ensure that your
934 mail is actually signed or encrypted. After invoking the above
935 sign/encrypt commands, it is possible to preview the raw article by
936 using @kbd{C-u C-c RET P} (@code{mml-preview}). Then you can
937 verify that your long rant about what your ex-significant other or
938 whomever actually did with that funny looking person at that strange
939 party the other night, actually will be sent encrypted.
941 @emph{Note!} Neither @acronym{PGP/MIME} nor @acronym{S/MIME} encrypt/signs
942 RFC822 headers. They only operate on the @acronym{MIME} object. Keep this
943 in mind before sending mail with a sensitive Subject line.
945 By default, when encrypting a message, Gnus will use the
946 ``signencrypt'' mode, which means the message is both signed and
947 encrypted. If you would like to disable this for a particular
948 message, give the @code{mml-secure-message-encrypt-*} command a prefix
949 argument, e.g., @kbd{C-u C-c C-m c p}.
951 Actually using the security commands above is not very difficult. At
952 least not compared with making sure all involved programs talk with each
953 other properly. Thus, we now describe what external libraries or
954 programs are required to make things work, and some small general hints.
956 @subsection Using S/MIME
958 @emph{Note!} This section assume you have a basic familiarity with
959 modern cryptography, @acronym{S/MIME}, various PKCS standards, OpenSSL and
962 The @acronym{S/MIME} support in Message (and @acronym{MML}) require
963 OpenSSL. OpenSSL performs the actual @acronym{S/MIME} sign/encrypt
964 operations. OpenSSL can be found at @uref{http://www.openssl.org/}.
965 OpenSSL 0.9.6 and later should work. Version 0.9.5a cannot extract mail
966 addresses from certificates, and it insert a spurious CR character into
967 @acronym{MIME} separators so you may wish to avoid it if you would like
968 to avoid being regarded as someone who send strange mail. (Although by
969 sending @acronym{S/MIME} messages you've probably already lost that
972 To be able to send encrypted mail, a personal certificate is not
973 required. Message (@acronym{MML}) need a certificate for the person to whom you
974 wish to communicate with though. You're asked for this when you type
975 @kbd{C-c C-m c s}. Currently there are two ways to retrieve this
976 certificate, from a local file or from DNS. If you chose a local
977 file, it need to contain a X.509 certificate in @acronym{PEM} format.
978 If you chose DNS, you're asked for the domain name where the
979 certificate is stored, the default is a good guess. To my belief,
980 Message (@acronym{MML}) is the first mail agent in the world to support
981 retrieving @acronym{S/MIME} certificates from DNS, so you're not
982 likely to find very many certificates out there. At least there
983 should be one, stored at the domain @code{simon.josefsson.org}. LDAP
984 is a more popular method of distributing certificates, support for it
985 is planned. (Meanwhile, you can use @code{ldapsearch} from the
986 command line to retrieve a certificate into a file and use it.)
988 As for signing messages, OpenSSL can't perform signing operations
989 without some kind of configuration. Especially, you need to tell it
990 where your private key and your certificate is stored. @acronym{MML}
991 uses an Emacs interface to OpenSSL, aptly named @code{smime.el}, and it
992 contain a @code{custom} group used for this configuration. So, try
993 @kbd{M-x customize-group RET smime RET} and look around.
995 Currently there is no support for talking to a CA (or RA) to create
996 your own certificate. None is planned either. You need to do this
997 manually with OpenSSL or using some other program. I used Netscape
998 and got a free @acronym{S/MIME} certificate from one of the big CA's on the
999 net. Netscape is able to export your private key and certificate in
1000 PKCS #12 format. Use OpenSSL to convert this into a plain X.509
1001 certificate in PEM format as follows.
1004 $ openssl pkcs12 -in ns.p12 -clcerts -nodes > key+cert.pem
1007 The @file{key+cert.pem} file should be pointed to from the
1008 @code{smime-keys} variable. You should now be able to send signed mail.
1010 @emph{Note!} Your private key is now stored unencrypted in the file,
1011 so take care in handling it. Storing encrypted keys on the disk are
1012 supported, and Gnus will ask you for a passphrase before invoking
1013 OpenSSL. Read the OpenSSL documentation for how to achieve this. If
1014 you use unencrypted keys (e.g., if they are on a secure storage, or if
1015 you are on a secure single user machine) simply press @code{RET} at
1016 the passphrase prompt.
1018 @subsection Using PGP/MIME
1020 @acronym{PGP/MIME} requires an external OpenPGP implementation, such
1021 as @uref{http://www.gnupg.org/, GNU Privacy Guard}. Pre-OpenPGP
1022 implementations such as PGP 2.x and PGP 5.x are also supported. One
1023 Emacs interface to the PGP implementations, PGG (@pxref{Top, ,PGG,
1024 pgg, PGG Manual}), is included, but Mailcrypt and Florian Weimer's
1025 @code{gpg.el} are also supported.
1027 @vindex gpg-temp-directory
1028 Note, if you are using the @code{gpg.el} you must make sure that the
1029 directory specified by @code{gpg-temp-directory} have permissions
1032 Creating your own key is described in detail in the documentation of
1033 your PGP implementation, so we refer to it.
1035 If you have imported your old PGP 2.x key into GnuPG, and want to send
1036 signed and encrypted messages to your fellow PGP 2.x users, you'll
1037 discover that the receiver cannot understand what you send. One
1038 solution is to use PGP 2.x instead (i.e., if you use @code{pgg}, set
1039 @code{pgg-default-scheme} to @code{pgp}). If you do want to use
1040 GnuPG, you can use a compatibility script called @code{gpg-2comp}
1042 @uref{http://muppet.faveve.uni-stuttgart.de/~gero/gpg-2comp/}. You
1043 could also convince your fellow PGP 2.x users to convert to GnuPG.
1044 @vindex mml-signencrypt-style-alist
1045 As a final workaround, you can make the sign and encryption work in
1046 two steps; separately sign, then encrypt a message. If you would like
1047 to change this behavior you can customize the
1048 @code{mml-signencrypt-style-alist} variable. For example:
1051 (setq mml-signencrypt-style-alist '(("smime" separate)
1053 ("pgpauto" separate)
1054 ("pgpmime" separate)))
1057 This causes to sign and encrypt in two passes, thus generating a
1058 message that can be understood by PGP version 2.
1060 (Refer to @uref{http://www.gnupg.org/gph/en/pgp2x.html} for more
1061 information about the problem.)
1063 @node Various Commands
1064 @section Various Commands
1070 @findex message-caesar-buffer-body
1071 Caesar rotate (aka. rot13) the current message
1072 (@code{message-caesar-buffer-body}). If narrowing is in effect, just
1073 rotate the visible portion of the buffer. A numerical prefix says how
1074 many places to rotate the text. The default is 13.
1078 @findex message-elide-region
1079 @vindex message-elide-ellipsis
1080 Elide the text between point and mark (@code{message-elide-region}).
1081 The text is killed and replaced with the contents of the variable
1082 @code{message-elide-ellipsis}. The default value is to use an ellipsis
1087 @findex message-kill-address
1088 Kill the address under point.
1092 @findex message-kill-to-signature
1093 Kill all the text up to the signature, or if that's missing, up to the
1094 end of the message (@code{message-kill-to-signature}).
1098 @findex message-delete-not-region
1099 Delete all text in the body of the message that is outside the region
1100 (@code{message-delete-not-region}).
1104 @findex message-newline-and-reformat
1105 Insert four newlines, and then reformat if inside quoted text.
1110 > This is some quoted text. And here's more quoted text.
1113 If point is before @samp{And} and you press @kbd{M-RET}, you'll get:
1116 > This is some quoted text.
1120 > And here's more quoted text.
1123 @samp{*} says where point will be placed.
1127 @findex message-rename-buffer
1128 Rename the buffer (@code{message-rename-buffer}). If given a prefix,
1129 prompt for a new buffer name.
1134 @vindex message-tab-body-function
1135 If non-@code{nil} execute the function specified in
1136 @code{message-tab-body-function}. Otherwise use the function bound to
1137 @kbd{TAB} in @code{text-mode-map} or @code{global-map}.
1148 @findex message-send-and-exit
1149 Send the message and bury the current buffer
1150 (@code{message-send-and-exit}).
1154 @findex message-send
1155 Send the message (@code{message-send}).
1159 @findex message-dont-send
1160 Bury the message buffer and exit (@code{message-dont-send}).
1164 @findex message-kill-buffer
1165 Kill the message buffer and exit (@code{message-kill-buffer}).
1172 @section Mail Aliases
1173 @cindex mail aliases
1176 @vindex message-mail-alias-type
1177 The @code{message-mail-alias-type} variable controls what type of mail
1178 alias expansion to use. Currently only one form is supported---Message
1179 uses @code{mailabbrev} to handle mail aliases. If this variable is
1180 @code{nil}, no mail alias expansion will be performed.
1182 @code{mailabbrev} works by parsing the @file{/etc/mailrc} and
1183 @file{~/.mailrc} files. These files look like:
1186 alias lmi "Lars Magne Ingebrigtsen <larsi@@ifi.uio.no>"
1187 alias ding "ding@@ifi.uio.no (ding mailing list)"
1190 After adding lines like this to your @file{~/.mailrc} file, you should
1191 be able to just write @samp{lmi} in the @code{To} or @code{Cc} (and so
1192 on) headers and press @kbd{SPC} to expand the alias.
1194 No expansion will be performed upon sending of the message---all
1195 expansions have to be done explicitly.
1201 @findex ispell-message
1203 There are two popular ways to have Emacs spell-check your messages:
1204 @code{ispell} and @code{flyspell}. @code{ispell} is the older and
1205 probably more popular package. You typically first write the message,
1206 and then run the entire thing through @code{ispell} and fix all the
1207 typos. To have this happen automatically when you send a message, put
1208 something like the following in your @file{.emacs} file:
1211 (add-hook 'message-send-hook 'ispell-message)
1214 @vindex ispell-message-dictionary-alist
1215 If you're in the habit of writing in different languages, this can be
1216 controlled by the @code{ispell-message-dictionary-alist} variable:
1219 (setq ispell-message-dictionary-alist
1220 '(("^Newsgroups:.*\\bde\\." . "deutsch8")
1221 (".*" . "default")))
1224 @code{ispell} depends on having the external @samp{ispell} command
1227 The other popular method is using @code{flyspell}. This package checks
1228 your spelling while you're writing, and marks any mis-spelled words in
1231 To use @code{flyspell}, put something like the following in your
1235 (defun my-message-setup-routine ()
1237 (add-hook 'message-setup-hook 'my-message-setup-routine)
1240 @code{flyspell} depends on having the external @samp{ispell} command
1248 * Message Headers:: General message header stuff.
1249 * Mail Headers:: Customizing mail headers.
1250 * Mail Variables:: Other mail variables.
1251 * News Headers:: Customizing news headers.
1252 * News Variables:: Other news variables.
1253 * Insertion Variables:: Customizing how things are inserted.
1254 * Various Message Variables:: Other message variables.
1255 * Sending Variables:: Variables for sending.
1256 * Message Buffers:: How Message names its buffers.
1257 * Message Actions:: Actions to be performed when exiting.
1261 @node Message Headers
1262 @section Message Headers
1264 Message is quite aggressive on the message generation front. It has to
1265 be---it's a combined news and mail agent. To be able to send combined
1266 messages, it has to generate all headers itself (instead of letting the
1267 mail/news system do it) to ensure that mail and news copies of messages
1268 look sufficiently similar.
1272 @item message-generate-headers-first
1273 @vindex message-generate-headers-first
1274 If @code{t}, generate all required headers before starting to
1275 compose the message. This can also be a list of headers to generate:
1278 (setq message-generate-headers-first
1282 @vindex message-required-headers
1283 The variables @code{message-required-headers},
1284 @code{message-required-mail-headers} and
1285 @code{message-required-news-headers} specify which headers are
1288 Note that some headers will be removed and re-generated before posting,
1289 because of the variable @code{message-deletable-headers} (see below).
1291 @item message-draft-headers
1292 @vindex message-draft-headers
1293 When running Message from Gnus, the message buffers are associated
1294 with a draft group. @code{message-draft-headers} says which headers
1295 should be generated when a draft is written to the draft group.
1297 @item message-from-style
1298 @vindex message-from-style
1299 Specifies how @code{From} headers should look. There are four valid
1304 Just the address---@samp{king@@grassland.com}.
1307 @samp{king@@grassland.com (Elvis Parsley)}.
1310 @samp{Elvis Parsley <king@@grassland.com>}.
1313 Look like @code{angles} if that doesn't require quoting, and
1314 @code{parens} if it does. If even @code{parens} requires quoting, use
1315 @code{angles} anyway.
1319 @item message-deletable-headers
1320 @vindex message-deletable-headers
1321 Headers in this list that were previously generated by Message will be
1322 deleted before posting. Let's say you post an article. Then you decide
1323 to post it again to some other group, you naughty boy, so you jump back
1324 to the @code{*post-buf*} buffer, edit the @code{Newsgroups} line, and
1325 ship it off again. By default, this variable makes sure that the old
1326 generated @code{Message-ID} is deleted, and a new one generated. If
1327 this isn't done, the entire empire would probably crumble, anarchy would
1328 prevail, and cats would start walking on two legs and rule the world.
1331 @item message-default-headers
1332 @vindex message-default-headers
1333 This string is inserted at the end of the headers in all message
1336 @item message-subject-re-regexp
1337 @vindex message-subject-re-regexp
1341 Responses to messages have subjects that start with @samp{Re: }. This
1342 is @emph{not} an abbreviation of the English word ``response'', but is
1343 Latin, and means ``in response to''. Some illiterate nincompoops have
1344 failed to grasp this fact, and have ``internationalized'' their software
1345 to use abominations like @samp{Aw: } (``antwort'') or @samp{Sv: }
1346 (``svar'') instead, which is meaningless and evil. However, you may
1347 have to deal with users that use these evil tools, in which case you may
1348 set this variable to a regexp that matches these prefixes. Myself, I
1349 just throw away non-compliant mail.
1351 Here's an example of a value to deal with these headers when
1352 responding to a message:
1355 (setq message-subject-re-regexp
1360 "[Aa][Nn][Tt][Ww]\\.?\\|" ; antw
1362 "[Ff][Ww][Dd]?\\|" ; fwd
1363 "[Oo][Dd][Pp]\\|" ; odp
1365 "[Rr][\311\351][Ff]\\.?\\|" ; ref
1368 "\\(\\[[0-9]*\\]\\)"
1375 @item message-subject-trailing-was-query
1376 @vindex message-subject-trailing-was-query
1377 @vindex message-subject-trailing-was-ask-regexp
1378 @vindex message-subject-trailing-was-regexp
1379 Controls what to do with trailing @samp{(was: <old subject>)} in subject
1380 lines. If @code{nil}, leave the subject unchanged. If it is the symbol
1381 @code{ask}, query the user what do do. In this case, the subject is
1382 matched against @code{message-subject-trailing-was-ask-regexp}. If
1383 @code{message-subject-trailing-was-query} is t, always strip the
1384 trailing old subject. In this case,
1385 @code{message-subject-trailing-was-regexp} is used.
1387 @item message-alternative-emails
1388 @vindex message-alternative-emails
1389 A regexp to match the alternative email addresses. The first matched
1390 address (not primary one) is used in the @code{From} field.
1392 @item message-allow-no-recipients
1393 @vindex message-allow-no-recipients
1394 Specifies what to do when there are no recipients other than
1395 @code{Gcc} or @code{Fcc}. If it is @code{always}, the posting is
1396 allowed. If it is @code{never}, the posting is not allowed. If it is
1397 @code{ask} (the default), you are prompted.
1399 @item message-hidden-headers
1400 @vindex message-hidden-headers
1401 A regexp, a list of regexps, or a list where the first element is
1402 @code{not} and the rest are regexps. It says which headers to keep
1403 hidden when composing a message.
1406 (setq message-hidden-headers
1407 '(not "From" "Subject" "To" "Cc" "Newsgroups"))
1410 @item message-header-synonyms
1411 @vindex message-header-synonyms
1412 A list of lists of header synonyms. E.g., if this list contains a
1413 member list with elements @code{Cc} and @code{To}, then
1414 @code{message-carefully-insert-headers} will not insert a @code{To}
1415 header when the message is already @code{Cc}ed to the recipient.
1421 @section Mail Headers
1424 @item message-required-mail-headers
1425 @vindex message-required-mail-headers
1426 @xref{News Headers}, for the syntax of this variable. It is
1427 @code{(From Date Subject (optional . In-Reply-To) Message-ID Lines
1428 (optional . User-Agent))} by default.
1430 @item message-ignored-mail-headers
1431 @vindex message-ignored-mail-headers
1432 Regexp of headers to be removed before mailing. The default is
1433 @samp{^[GF]cc:\\|^Resent-Fcc:\\|^Xref:\\|^X-Draft-From:}.
1435 @item message-default-mail-headers
1436 @vindex message-default-mail-headers
1437 This string is inserted at the end of the headers in all message
1438 buffers that are initialized as mail.
1440 @item message-generate-hashcash
1441 @vindex message-generate-hashcash
1442 Boolean variable that indicate whether @samp{X-Hashcash} headers
1443 should be computed for the message. @xref{Hashcash, ,Hashcash,gnus,
1449 @node Mail Variables
1450 @section Mail Variables
1453 @item message-send-mail-function
1454 @vindex message-send-mail-function
1455 @findex message-send-mail-with-sendmail
1456 @findex message-send-mail-with-mh
1457 @findex message-send-mail-with-qmail
1458 @findex message-smtpmail-send-it
1459 @findex smtpmail-send-it
1460 @findex feedmail-send-it
1461 Function used to send the current buffer as mail. The default is
1462 @code{message-send-mail-with-sendmail}. Other valid values include
1463 @code{message-send-mail-with-mh}, @code{message-send-mail-with-qmail},
1464 @code{message-smtpmail-send-it}, @code{smtpmail-send-it} and
1465 @code{feedmail-send-it}.
1467 @item message-mh-deletable-headers
1468 @vindex message-mh-deletable-headers
1469 Most versions of MH doesn't like being fed messages that contain the
1470 headers in this variable. If this variable is non-@code{nil} (which is
1471 the default), these headers will be removed before mailing when sending
1472 messages via MH. Set it to @code{nil} if your MH can handle these
1475 @item message-qmail-inject-program
1476 @vindex message-qmail-inject-program
1478 Location of the qmail-inject program.
1480 @item message-qmail-inject-args
1481 @vindex message-qmail-inject-args
1482 Arguments passed to qmail-inject programs.
1483 This should be a list of strings, one string for each argument. It
1484 may also be a function.
1486 For e.g., if you wish to set the envelope sender address so that bounces
1487 go to the right place or to deal with listserv's usage of that address, you
1488 might set this variable to @code{'("-f" "you@@some.where")}.
1490 @item message-sendmail-f-is-evil
1491 @vindex message-sendmail-f-is-evil
1493 Non-@code{nil} means don't add @samp{-f username} to the sendmail
1494 command line. Doing so would be even more evil than leaving it out.
1496 @item message-sendmail-envelope-from
1497 @vindex message-sendmail-envelope-from
1498 When @code{message-sendmail-f-is-evil} is @code{nil}, this specifies
1499 the address to use in the @acronym{SMTP} envelope. If it is
1500 @code{nil}, use @code{user-mail-address}. If it is the symbol
1501 @code{header}, use the @samp{From} header of the message.
1503 @item message-mailer-swallows-blank-line
1504 @vindex message-mailer-swallows-blank-line
1505 Set this to non-@code{nil} if the system's mailer runs the header and
1506 body together. (This problem exists on SunOS 4 when sendmail is run
1507 in remote mode.) The value should be an expression to test whether
1508 the problem will actually occur.
1510 @item message-send-mail-partially-limit
1511 @vindex message-send-mail-partially-limit
1512 @cindex split large message
1513 The limitation of messages sent as message/partial. The lower bound
1514 of message size in characters, beyond which the message should be sent
1515 in several parts. If it is @code{nil}, the size is unlimited.
1521 @section News Headers
1523 @vindex message-required-news-headers
1524 @code{message-required-news-headers} a list of header symbols. These
1525 headers will either be automatically generated, or, if that's
1526 impossible, they will be prompted for. The following symbols are valid:
1532 @findex user-full-name
1533 @findex user-mail-address
1534 This required header will be filled out with the result of the
1535 @code{message-make-from} function, which depends on the
1536 @code{message-from-style}, @code{user-full-name},
1537 @code{user-mail-address} variables.
1541 This required header will be prompted for if not present already.
1545 This required header says which newsgroups the article is to be posted
1546 to. If it isn't present already, it will be prompted for.
1549 @cindex organization
1550 @vindex message-user-organization
1551 @vindex message-user-organization-file
1552 This optional header will be filled out depending on the
1553 @code{message-user-organization} variable.
1554 @code{message-user-organization-file} will be used if this variable is
1555 @code{t}. This variable can also be a string (in which case this string
1556 will be used), or it can be a function (which will be called with no
1557 parameters and should return a string to be used).
1561 This optional header will be computed by Message.
1565 @vindex message-user-fqdn
1566 @vindex mail-host-address
1567 @vindex user-mail-address
1570 @cindex i-did-not-set--mail-host-address--so-tickle-me
1571 This required header will be generated by Message. A unique ID will be
1572 created based on the date, time, user name (for the local part) and the
1573 domain part. For the domain part, message will look (in this order) at
1574 @code{message-user-fqdn}, @code{system-name}, @code{mail-host-address}
1575 and @code{message-user-mail-address} (i.e. @code{user-mail-address})
1576 until a probably valid fully qualified domain name (FQDN) was found.
1580 This optional header will be filled out according to the
1581 @code{message-newsreader} local variable.
1584 This optional header is filled out using the @code{Date} and @code{From}
1585 header of the article being replied to.
1589 @vindex message-expires
1590 This extremely optional header will be inserted according to the
1591 @code{message-expires} variable. It is highly deprecated and shouldn't
1592 be used unless you know what you're doing.
1595 @cindex Distribution
1596 @vindex message-distribution-function
1597 This optional header is filled out according to the
1598 @code{message-distribution-function} variable. It is a deprecated and
1599 much misunderstood header.
1603 @vindex message-user-path
1604 This extremely optional header should probably never be used.
1605 However, some @emph{very} old servers require that this header is
1606 present. @code{message-user-path} further controls how this
1607 @code{Path} header is to look. If it is @code{nil}, use the server name
1608 as the leaf node. If it is a string, use the string. If it is neither
1609 a string nor @code{nil}, use the user name only. However, it is highly
1610 unlikely that you should need to fiddle with this variable at all.
1614 @cindex Mime-Version
1615 In addition, you can enter conses into this list. The @sc{car} of this cons
1616 should be a symbol. This symbol's name is the name of the header, and
1617 the @sc{cdr} can either be a string to be entered verbatim as the value of
1618 this header, or it can be a function to be called. This function should
1619 return a string to be inserted. For instance, if you want to insert
1620 @code{Mime-Version: 1.0}, you should enter @code{(Mime-Version . "1.0")}
1621 into the list. If you want to insert a funny quote, you could enter
1622 something like @code{(X-Yow . yow)} into the list. The function
1623 @code{yow} will then be called without any arguments.
1625 If the list contains a cons where the @sc{car} of the cons is
1626 @code{optional}, the @sc{cdr} of this cons will only be inserted if it is
1629 If you want to delete an entry from this list, the following Lisp
1630 snippet might be useful. Adjust accordingly if you want to remove
1634 (setq message-required-news-headers
1635 (delq 'Message-ID message-required-news-headers))
1638 Other variables for customizing outgoing news articles:
1642 @item message-syntax-checks
1643 @vindex message-syntax-checks
1644 Controls what syntax checks should not be performed on outgoing posts.
1645 To disable checking of long signatures, for instance, add
1648 (signature . disabled)
1657 Check the subject for commands.
1660 Insert a new @code{Sender} header if the @code{From} header looks odd.
1661 @item multiple-headers
1662 Check for the existence of multiple equal headers.
1665 Check for the existence of version and sendsys commands.
1667 Check whether the @code{Message-ID} looks ok.
1669 Check whether the @code{From} header seems nice.
1672 Check for too long lines.
1674 Check for invalid characters.
1676 Check for excessive size.
1678 Check whether there is any new text in the messages.
1680 Check the length of the signature.
1683 Check whether the article has an @code{Approved} header, which is
1684 something only moderators should include.
1686 Check whether the article is empty.
1687 @item invisible-text
1688 Check whether there is any invisible text in the buffer.
1690 Check whether any of the headers are empty.
1691 @item existing-newsgroups
1692 Check whether the newsgroups mentioned in the @code{Newsgroups} and
1693 @code{Followup-To} headers exist.
1694 @item valid-newsgroups
1695 Check whether the @code{Newsgroups} and @code{Followup-to} headers
1696 are valid syntactically.
1697 @item repeated-newsgroups
1698 Check whether the @code{Newsgroups} and @code{Followup-to} headers
1699 contains repeated group names.
1700 @item shorten-followup-to
1701 Check whether to add a @code{Followup-to} header to shorten the number
1702 of groups to post to.
1705 All these conditions are checked by default.
1707 @item message-ignored-news-headers
1708 @vindex message-ignored-news-headers
1709 Regexp of headers to be removed before posting. The default is@*
1710 @samp{^NNTP-Posting-Host:\\|^Xref:\\|^[BGF]cc:\\|^Resent-Fcc:\\|^X-Draft-From:}.
1712 @item message-default-news-headers
1713 @vindex message-default-news-headers
1714 This string is inserted at the end of the headers in all message
1715 buffers that are initialized as news.
1720 @node News Variables
1721 @section News Variables
1724 @item message-send-news-function
1725 @vindex message-send-news-function
1726 Function used to send the current buffer as news. The default is
1727 @code{message-send-news}.
1729 @item message-post-method
1730 @vindex message-post-method
1731 Gnusish @dfn{select method} (see the Gnus manual for details) used for
1732 posting a prepared news message.
1737 @node Insertion Variables
1738 @section Insertion Variables
1741 @item message-ignored-cited-headers
1742 @vindex message-ignored-cited-headers
1743 All headers that match this regexp will be removed from yanked
1744 messages. The default is @samp{.}, which means that all headers will be
1747 @item message-cite-prefix-regexp
1748 @vindex message-cite-prefix-regexp
1749 Regexp matching the longest possible citation prefix on a line.
1751 @item message-citation-line-function
1752 @vindex message-citation-line-function
1753 @cindex attribution line
1754 Function called to insert the citation line. The default is
1755 @code{message-insert-citation-line}, which will lead to citation lines
1759 Hallvard B Furuseth <h.b.furuseth@@usit.uio.no> writes:
1762 Point will be at the beginning of the body of the message when this
1765 Note that Gnus provides a feature where clicking on `writes:' hides the
1766 cited text. If you change the citation line too much, readers of your
1767 messages will have to adjust their Gnus, too. See the variable
1768 @code{gnus-cite-attribution-suffix}. @xref{Article Highlighting, ,
1769 Article Highlighting, gnus, The Gnus Manual}, for details.
1771 @item message-yank-prefix
1772 @vindex message-yank-prefix
1775 When you are replying to or following up an article, you normally want
1776 to quote the person you are answering. Inserting quoted text is done
1777 by @dfn{yanking}, and each line you yank will have
1778 @code{message-yank-prefix} prepended to it (except for quoted and
1779 empty lines which uses @code{message-yank-cited-prefix}). The default
1782 @item message-yank-cited-prefix
1783 @vindex message-yank-cited-prefix
1787 When yanking text from an article which contains no text or already
1788 cited text, each line will be prefixed with the contents of this
1789 variable. The default is @samp{>}. See also
1790 @code{message-yank-prefix}.
1792 @item message-indentation-spaces
1793 @vindex message-indentation-spaces
1794 Number of spaces to indent yanked messages.
1796 @item message-cite-function
1797 @vindex message-cite-function
1798 @findex message-cite-original
1799 @findex sc-cite-original
1800 @findex message-cite-original-without-signature
1802 Function for citing an original message. The default is
1803 @code{message-cite-original}, which simply inserts the original message
1804 and prepends @samp{> } to each line.
1805 @code{message-cite-original-without-signature} does the same, but elides
1806 the signature. You can also set it to @code{sc-cite-original} to use
1809 @item message-indent-citation-function
1810 @vindex message-indent-citation-function
1811 Function for modifying a citation just inserted in the mail buffer.
1812 This can also be a list of functions. Each function can find the
1813 citation between @code{(point)} and @code{(mark t)}. And each function
1814 should leave point and mark around the citation text as modified.
1816 @item message-mark-insert-begin
1817 @vindex message-mark-insert-begin
1818 String to mark the beginning of some inserted text.
1820 @item message-mark-insert-end
1821 @vindex message-mark-insert-end
1822 String to mark the end of some inserted text.
1824 @item message-signature
1825 @vindex message-signature
1826 String to be inserted at the end of the message buffer. If @code{t}
1827 (which is the default), the @code{message-signature-file} file will be
1828 inserted instead. If a function, the result from the function will be
1829 used instead. If a form, the result from the form will be used instead.
1830 If this variable is @code{nil}, no signature will be inserted at all.
1832 @item message-signature-file
1833 @vindex message-signature-file
1834 File containing the signature to be inserted at the end of the buffer.
1835 The default is @file{~/.signature}.
1837 @item message-signature-insert-empty-line
1838 @vindex message-signature-insert-empty-line
1839 If @code{t} (the default value) an empty line is inserted before the
1840 signature separator.
1844 Note that RFC1036bis says that a signature should be preceded by the three
1845 characters @samp{-- } on a line by themselves. This is to make it
1846 easier for the recipient to automatically recognize and process the
1847 signature. So don't remove those characters, even though you might feel
1848 that they ruin your beautiful design, like, totally.
1850 Also note that no signature should be more than four lines long.
1851 Including @acronym{ASCII} graphics is an efficient way to get
1852 everybody to believe that you are silly and have nothing important to
1856 @node Various Message Variables
1857 @section Various Message Variables
1860 @item message-default-charset
1861 @vindex message-default-charset
1863 Symbol naming a @acronym{MIME} charset. Non-@acronym{ASCII}
1864 characters in messages are assumed to be encoded using this charset.
1865 The default is @code{nil}, which means ask the user. (This variable
1866 is used only on non-@sc{mule} Emacsen. @xref{Charset Translation, ,
1867 Charset Translation, emacs-mime, Emacs MIME Manual}, for details on
1868 the @sc{mule}-to-@acronym{MIME} translation process.
1870 @item message-signature-separator
1871 @vindex message-signature-separator
1872 Regexp matching the signature separator. It is @samp{^-- *$} by
1875 @item mail-header-separator
1876 @vindex mail-header-separator
1877 String used to separate the headers from the body. It is @samp{--text
1878 follows this line--} by default.
1880 @item message-directory
1881 @vindex message-directory
1882 Directory used by many mailey things. The default is @file{~/Mail/}.
1884 @item message-auto-save-directory
1885 @vindex message-auto-save-directory
1886 Directory where Message auto-saves buffers if Gnus isn't running. If
1887 @code{nil}, Message won't auto-save. The default is @file{~/Mail/drafts/}.
1889 @item message-signature-setup-hook
1890 @vindex message-signature-setup-hook
1891 Hook run when initializing the message buffer. It is run after the
1892 headers have been inserted but before the signature has been inserted.
1894 @item message-setup-hook
1895 @vindex message-setup-hook
1896 Hook run as the last thing when the message buffer has been initialized,
1897 but before yanked text is inserted.
1899 @item message-header-setup-hook
1900 @vindex message-header-setup-hook
1901 Hook called narrowed to the headers after initializing the headers.
1903 For instance, if you're running Gnus and wish to insert a
1904 @samp{Mail-Copies-To} header in all your news articles and all messages
1905 you send to mailing lists, you could do something like the following:
1908 (defun my-message-header-setup-hook ()
1909 (let ((group (or gnus-newsgroup-name "")))
1910 (when (or (message-fetch-field "newsgroups")
1911 (gnus-group-find-parameter group 'to-address)
1912 (gnus-group-find-parameter group 'to-list))
1913 (insert "Mail-Copies-To: never\n"))))
1915 (add-hook 'message-header-setup-hook
1916 'my-message-header-setup-hook)
1919 @item message-send-hook
1920 @vindex message-send-hook
1921 Hook run before sending messages.
1923 If you want to add certain headers before sending, you can use the
1924 @code{message-add-header} function in this hook. For instance:
1925 @findex message-add-header
1928 (add-hook 'message-send-hook 'my-message-add-content)
1929 (defun my-message-add-content ()
1930 (message-add-header "X-In-No-Sense: Nonsense")
1931 (message-add-header "X-Whatever: no"))
1934 This function won't add the header if the header is already present.
1936 @item message-send-mail-hook
1937 @vindex message-send-mail-hook
1938 Hook run before sending mail messages. This hook is run very late --
1939 just before the message is actually sent as mail.
1941 @item message-send-news-hook
1942 @vindex message-send-news-hook
1943 Hook run before sending news messages. This hook is run very late --
1944 just before the message is actually sent as news.
1946 @item message-sent-hook
1947 @vindex message-sent-hook
1948 Hook run after sending messages.
1950 @item message-cancel-hook
1951 @vindex message-cancel-hook
1952 Hook run when canceling news articles.
1954 @item message-mode-syntax-table
1955 @vindex message-mode-syntax-table
1956 Syntax table used in message mode buffers.
1958 @item message-cite-articles-with-x-no-archive
1959 @vindex message-cite-articles-with-x-no-archive
1960 If non-@code{nil}, don't strip quoted text from articles that have
1961 @samp{X-No-Archive} set. Even if this variable isn't set, you can
1962 undo the stripping by hitting the @code{undo} keystroke.
1964 @item message-strip-special-text-properties
1965 @vindex message-strip-special-text-properties
1966 Emacs has a number of special text properties which can break message
1967 composing in various ways. If this option is set, message will strip
1968 these properties from the message composition buffer. However, some
1969 packages requires these properties to be present in order to work. If
1970 you use one of these packages, turn this option off, and hope the
1971 message composition doesn't break too bad.
1973 @item message-send-method-alist
1974 @vindex message-send-method-alist
1976 Alist of ways to send outgoing messages. Each element has the form
1979 (@var{type} @var{predicate} @var{function})
1984 A symbol that names the method.
1987 A function called without any parameters to determine whether the
1988 message is a message of type @var{type}.
1991 A function to be called if @var{predicate} returns non-@code{nil}.
1992 @var{function} is called with one parameter---the prefix.
1996 ((news message-news-p message-send-via-news)
1997 (mail message-mail-p message-send-via-mail))
2005 @node Sending Variables
2006 @section Sending Variables
2010 @item message-fcc-handler-function
2011 @vindex message-fcc-handler-function
2012 A function called to save outgoing articles. This function will be
2013 called with the name of the file to store the article in. The default
2014 function is @code{message-output} which saves in Unix mailbox format.
2016 @item message-courtesy-message
2017 @vindex message-courtesy-message
2018 When sending combined messages, this string is inserted at the start of
2019 the mailed copy. If the string contains the format spec @samp{%s}, the
2020 newsgroups the article has been posted to will be inserted there. If
2021 this variable is @code{nil}, no such courtesy message will be added.
2022 The default value is @samp{"The following message is a courtesy copy of
2023 an article\\nthat has been posted to %s as well.\\n\\n"}.
2025 @item message-fcc-externalize-attachments
2026 @vindex message-fcc-externalize-attachments
2027 If @code{nil}, attach files as normal parts in Fcc copies; if it is
2028 non-@code{nil}, attach local files as external parts.
2030 @item message-interactive
2031 @vindex message-interactive
2032 If non-@code{nil} wait for and display errors when sending a message;
2033 if @code{nil} let the mailer mail back a message to report errors.
2038 @node Message Buffers
2039 @section Message Buffers
2041 Message will generate new buffers with unique buffer names when you
2042 request a message buffer. When you send the message, the buffer isn't
2043 normally killed off. Its name is changed and a certain number of old
2044 message buffers are kept alive.
2047 @item message-generate-new-buffers
2048 @vindex message-generate-new-buffers
2049 If non-@code{nil}, generate new buffers. The default is @code{t}. If
2050 this is a function, call that function with three parameters: The type,
2051 the to address and the group name. (Any of these may be @code{nil}.)
2052 The function should return the new buffer name.
2054 @item message-max-buffers
2055 @vindex message-max-buffers
2056 This variable says how many old message buffers to keep. If there are
2057 more message buffers than this, the oldest buffer will be killed. The
2058 default is 10. If this variable is @code{nil}, no old message buffers
2059 will ever be killed.
2061 @item message-send-rename-function
2062 @vindex message-send-rename-function
2063 After sending a message, the buffer is renamed from, for instance,
2064 @samp{*reply to Lars*} to @samp{*sent reply to Lars*}. If you don't
2065 like this, set this variable to a function that renames the buffer in a
2066 manner you like. If you don't want to rename the buffer at all, you can
2070 (setq message-send-rename-function 'ignore)
2073 @item message-kill-buffer-on-exit
2074 @findex message-kill-buffer-on-exit
2075 If non-@code{nil}, kill the buffer immediately on exit.
2080 @node Message Actions
2081 @section Message Actions
2083 When Message is being used from a news/mail reader, the reader is likely
2084 to want to perform some task after the message has been sent. Perhaps
2085 return to the previous window configuration or mark an article as
2088 @vindex message-kill-actions
2089 @vindex message-postpone-actions
2090 @vindex message-exit-actions
2091 @vindex message-send-actions
2092 The user may exit from the message buffer in various ways. The most
2093 common is @kbd{C-c C-c}, which sends the message and exits. Other
2094 possibilities are @kbd{C-c C-s} which just sends the message, @kbd{C-c
2095 C-d} which postpones the message editing and buries the message buffer,
2096 and @kbd{C-c C-k} which kills the message buffer. Each of these actions
2097 have lists associated with them that contains actions to be executed:
2098 @code{message-send-actions}, @code{message-exit-actions},
2099 @code{message-postpone-actions}, and @code{message-kill-actions}.
2101 Message provides a function to interface with these lists:
2102 @code{message-add-action}. The first parameter is the action to be
2103 added, and the rest of the arguments are which lists to add this action
2104 to. Here's an example from Gnus:
2108 `(set-window-configuration ,(current-window-configuration))
2109 'exit 'postpone 'kill)
2112 This restores the Gnus window configuration when the message buffer is
2113 killed, postponed or exited.
2115 An @dfn{action} can be either: a normal function, or a list where the
2116 @sc{car} is a function and the @sc{cdr} is the list of arguments, or
2117 a form to be @code{eval}ed.
2121 @chapter Compatibility
2122 @cindex compatibility
2124 Message uses virtually only its own variables---older @code{mail-}
2125 variables aren't consulted. To force Message to take those variables
2126 into account, you can put the following in your @file{.emacs} file:
2129 (require 'messcompat)
2132 This will initialize many Message variables from the values in the
2133 corresponding mail variables.
2140 * Responses:: Standard rules for determining where responses go.
2147 To determine where a message is to go, the following algorithm is used
2152 A @dfn{reply} is when you want to respond @emph{just} to the person who
2153 sent the message via mail. There will only be one recipient. To
2154 determine who the recipient will be, the following headers are
2165 A @dfn{wide reply} is a mail response that includes @emph{all} entities
2166 mentioned in the message you are responded to. All mailboxes from the
2167 following headers will be concatenated to form the outgoing
2168 @code{To}/@code{Cc} headers:
2172 (unless there's a @code{Reply-To}, in which case that is used instead).
2179 If a @code{Mail-Copies-To} header is present, it will also be included
2180 in the list of mailboxes. If this header is @samp{never}, that means
2181 that the @code{From} (or @code{Reply-To}) mailbox will be suppressed.
2185 A @dfn{followup} is a response sent via news. The following headers
2186 (listed in order of precedence) determine where the response is to be
2197 If a @code{Mail-Copies-To} header is present, it will be used as the
2198 basis of the new @code{Cc} header, except if this header is
2220 arch-tag: 16ab76af-a281-4e34-aed6-5624569f7601