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