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