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