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