Fix non-ASCII characters in User and ELisp manuals.
[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
907non-@acronym{ASCII} now, so this gives them a safety net if they accidently
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
01c52d31
MB
1205@item C-c M-k
1206@kindex C-c M-k
1207@findex message-kill-address
1208Kill the address under point.
1209
4009494e
GM
1210@item C-c C-z
1211@kindex C-c C-z
1212@findex message-kill-to-signature
1213Kill all the text up to the signature, or if that's missing, up to the
1214end of the message (@code{message-kill-to-signature}).
1215
1216@item C-c C-v
1217@kindex C-c C-v
1218@findex message-delete-not-region
1219Delete all text in the body of the message that is outside the region
1220(@code{message-delete-not-region}).
1221
1222@item M-RET
1223@kindex M-RET
1224@findex message-newline-and-reformat
1225Insert four newlines, and then reformat if inside quoted text.
1226
1227Here's an example:
1228
1229@example
1230> This is some quoted text. And here's more quoted text.
1231@end example
1232
1233If point is before @samp{And} and you press @kbd{M-RET}, you'll get:
1234
1235@example
1236> This is some quoted text.
1237
1238*
1239
1240> And here's more quoted text.
1241@end example
1242
1243@samp{*} says where point will be placed.
1244
1245@item C-c M-r
1246@kindex C-c M-r
1247@findex message-rename-buffer
1248Rename the buffer (@code{message-rename-buffer}). If given a prefix,
1249prompt for a new buffer name.
1250
1251@item TAB
1252@kindex TAB
1253@findex message-tab
1254@vindex message-tab-body-function
1255If @code{message-tab-body-function} is non-@code{nil}, execute the
1256function it specifies. Otherwise use the function bound to @kbd{TAB} in
1257@code{text-mode-map} or @code{global-map}.
1258
1259@end table
1260
1261
1262@node Sending
1263@section Sending
1264
1265@table @kbd
1266@item C-c C-c
1267@kindex C-c C-c
1268@findex message-send-and-exit
1269Send the message and bury the current buffer
1270(@code{message-send-and-exit}).
1271
1272@item C-c C-s
1273@kindex C-c C-s
1274@findex message-send
1275Send the message (@code{message-send}).
1276
1277@item C-c C-d
1278@kindex C-c C-d
1279@findex message-dont-send
1280Bury the message buffer and exit (@code{message-dont-send}).
1281
1282@item C-c C-k
1283@kindex C-c C-k
1284@findex message-kill-buffer
1285Kill the message buffer and exit (@code{message-kill-buffer}).
1286
1287@end table
1288
1289
1290
1291@node Mail Aliases
1292@section Mail Aliases
1293@cindex mail aliases
1294@cindex aliases
01c52d31
MB
1295@cindex completion
1296@cindex ecomplete
4009494e
GM
1297
1298@vindex message-mail-alias-type
1299The @code{message-mail-alias-type} variable controls what type of mail
01c52d31
MB
1300alias expansion to use. Currently two forms are supported:
1301@code{mailabbrev} and @code{ecomplete}. If this variable is
4009494e
GM
1302@code{nil}, no mail alias expansion will be performed.
1303
1304@code{mailabbrev} works by parsing the @file{/etc/mailrc} and
1305@file{~/.mailrc} files. These files look like:
1306
1307@example
1308alias lmi "Lars Magne Ingebrigtsen <larsi@@ifi.uio.no>"
1309alias ding "ding@@ifi.uio.no (ding mailing list)"
1310@end example
1311
1312After adding lines like this to your @file{~/.mailrc} file, you should
1313be able to just write @samp{lmi} in the @code{To} or @code{Cc} (and so
1314on) headers and press @kbd{SPC} to expand the alias.
1315
1316No expansion will be performed upon sending of the message---all
1317expansions have to be done explicitly.
1318
01c52d31
MB
1319If you're using @code{ecomplete}, all addresses from @code{To} and
1320@code{Cc} headers will automatically be put into the
1321@file{~/.ecompleterc} file. When you enter text in the @code{To} and
1322@code{Cc} headers, @code{ecomplete} will check out the values stored
1323there and ``electrically'' say what completions are possible. To
1324choose one of these completions, use the @kbd{M-n} command to move
1325down to the list. Use @kbd{M-n} and @kbd{M-p} to move down and up the
1326list, and @kbd{RET} to choose a completion.
4009494e
GM
1327
1328@node Spelling
1329@section Spelling
1330@cindex spelling
1331@findex ispell-message
1332
1333There are two popular ways to have Emacs spell-check your messages:
1334@code{ispell} and @code{flyspell}. @code{ispell} is the older and
1335probably more popular package. You typically first write the message,
1336and then run the entire thing through @code{ispell} and fix all the
1337typos. To have this happen automatically when you send a message, put
1338something like the following in your @file{.emacs} file:
1339
1340@lisp
1341(add-hook 'message-send-hook 'ispell-message)
1342@end lisp
1343
1344@vindex ispell-message-dictionary-alist
1345If you're in the habit of writing in different languages, this can be
1346controlled by the @code{ispell-message-dictionary-alist} variable:
1347
1348@lisp
1349(setq ispell-message-dictionary-alist
1350 '(("^Newsgroups:.*\\bde\\." . "deutsch8")
1351 (".*" . "default")))
1352@end lisp
1353
1354@code{ispell} depends on having the external @samp{ispell} command
1355installed.
1356
1357The other popular method is using @code{flyspell}. This package checks
1358your spelling while you're writing, and marks any mis-spelled words in
1359various ways.
1360
1361To use @code{flyspell}, put something like the following in your
1362@file{.emacs} file:
1363
1364@lisp
1365(defun my-message-setup-routine ()
1366 (flyspell-mode 1))
1367(add-hook 'message-setup-hook 'my-message-setup-routine)
1368@end lisp
1369
1370@code{flyspell} depends on having the external @samp{ispell} command
1371installed.
1372
1373
1374@node Variables
1375@chapter Variables
1376
1377@menu
1378* Message Headers:: General message header stuff.
1379* Mail Headers:: Customizing mail headers.
1380* Mail Variables:: Other mail variables.
1381* News Headers:: Customizing news headers.
1382* News Variables:: Other news variables.
1383* Insertion Variables:: Customizing how things are inserted.
1384* Various Message Variables:: Other message variables.
1385* Sending Variables:: Variables for sending.
1386* Message Buffers:: How Message names its buffers.
1387* Message Actions:: Actions to be performed when exiting.
1388@end menu
1389
1390
1391@node Message Headers
1392@section Message Headers
1393
1394Message is quite aggressive on the message generation front. It has to
01c52d31 1395be---it's a combined news and mail agent. To be able to send combined
4009494e
GM
1396messages, it has to generate all headers itself (instead of letting the
1397mail/news system do it) to ensure that mail and news copies of messages
1398look sufficiently similar.
1399
1400@table @code
1401
1402@item message-generate-headers-first
1403@vindex message-generate-headers-first
1404If @code{t}, generate all required headers before starting to
1405compose the message. This can also be a list of headers to generate:
1406
1407@lisp
1408(setq message-generate-headers-first
1409 '(References))
1410@end lisp
1411
1412@vindex message-required-headers
1413The variables @code{message-required-headers},
1414@code{message-required-mail-headers} and
1415@code{message-required-news-headers} specify which headers are
1416required.
1417
1418Note that some headers will be removed and re-generated before posting,
1419because of the variable @code{message-deletable-headers} (see below).
1420
1421@item message-draft-headers
1422@vindex message-draft-headers
1423When running Message from Gnus, the message buffers are associated
1424with a draft group. @code{message-draft-headers} says which headers
1425should be generated when a draft is written to the draft group.
1426
1427@item message-from-style
1428@vindex message-from-style
1429Specifies how @code{From} headers should look. There are four valid
1430values:
1431
1432@table @code
1433@item nil
01c52d31 1434Just the address---@samp{king@@grassland.com}.
4009494e
GM
1435
1436@item parens
1437@samp{king@@grassland.com (Elvis Parsley)}.
1438
1439@item angles
1440@samp{Elvis Parsley <king@@grassland.com>}.
1441
1442@item default
1443Look like @code{angles} if that doesn't require quoting, and
1444@code{parens} if it does. If even @code{parens} requires quoting, use
1445@code{angles} anyway.
1446
1447@end table
1448
1449@item message-deletable-headers
1450@vindex message-deletable-headers
1451Headers in this list that were previously generated by Message will be
1452deleted before posting. Let's say you post an article. Then you decide
1453to post it again to some other group, you naughty boy, so you jump back
1454to the @code{*post-buf*} buffer, edit the @code{Newsgroups} line, and
1455ship it off again. By default, this variable makes sure that the old
1456generated @code{Message-ID} is deleted, and a new one generated. If
1457this isn't done, the entire empire would probably crumble, anarchy would
1458prevail, and cats would start walking on two legs and rule the world.
1459Allegedly.
1460
1461@item message-default-headers
1462@vindex message-default-headers
b5c575e6
G
1463Header lines to be inserted in outgoing messages before you edit the
1464message, so you can edit or delete their lines. If set to a string, it
1465is directly inserted. If set to a function, it is called and its
1466result is inserted.
4009494e
GM
1467
1468@item message-subject-re-regexp
1469@vindex message-subject-re-regexp
1470@cindex Aw
1471@cindex Sv
1472@cindex Re
1473Responses to messages have subjects that start with @samp{Re: }. This
1474is @emph{not} an abbreviation of the English word ``response'', but is
1475Latin, and means ``in response to''. Some illiterate nincompoops have
1476failed to grasp this fact, and have ``internationalized'' their software
1477to use abominations like @samp{Aw: } (``antwort'') or @samp{Sv: }
1478(``svar'') instead, which is meaningless and evil. However, you may
1479have to deal with users that use these evil tools, in which case you may
1480set this variable to a regexp that matches these prefixes. Myself, I
1481just throw away non-compliant mail.
1482
1483Here's an example of a value to deal with these headers when
1484responding to a message:
1485
1486@lisp
1487(setq message-subject-re-regexp
1488 (concat
1489 "^[ \t]*"
1490 "\\("
1491 "\\("
1492 "[Aa][Nn][Tt][Ww]\\.?\\|" ; antw
1493 "[Aa][Ww]\\|" ; aw
1494 "[Ff][Ww][Dd]?\\|" ; fwd
1495 "[Oo][Dd][Pp]\\|" ; odp
1496 "[Rr][Ee]\\|" ; re
1497 "[Rr][\311\351][Ff]\\.?\\|" ; ref
1498 "[Ss][Vv]" ; sv
1499 "\\)"
1500 "\\(\\[[0-9]*\\]\\)"
1501 "*:[ \t]*"
1502 "\\)"
1503 "*[ \t]*"
1504 ))
1505@end lisp
1506
1507@item message-subject-trailing-was-query
1508@vindex message-subject-trailing-was-query
1509@vindex message-subject-trailing-was-ask-regexp
1510@vindex message-subject-trailing-was-regexp
1511Controls what to do with trailing @samp{(was: <old subject>)} in subject
1512lines. If @code{nil}, leave the subject unchanged. If it is the symbol
1513@code{ask}, query the user what to do. In this case, the subject is
1514matched against @code{message-subject-trailing-was-ask-regexp}. If
1515@code{message-subject-trailing-was-query} is @code{t}, always strip the
1516trailing old subject. In this case,
1517@code{message-subject-trailing-was-regexp} is used.
1518
1519@item message-alternative-emails
1520@vindex message-alternative-emails
1521Regexp matching alternative email addresses. The first address in the
1522To, Cc or From headers of the original article matching this variable is
1523used as the From field of outgoing messages, replacing the default From
1524value.
1525
1526For example, if you have two secondary email addresses john@@home.net
1527and john.doe@@work.com and want to use them in the From field when
1528composing a reply to a message addressed to one of them, you could set
1529this variable like this:
1530
1531@lisp
1532(setq message-alternative-emails
1533 (regexp-opt '("john@@home.net" "john.doe@@work.com")))
1534@end lisp
1535
1536This variable has precedence over posting styles and anything that runs
1537off @code{message-setup-hook}.
1538
1539@item message-allow-no-recipients
1540@vindex message-allow-no-recipients
1541Specifies what to do when there are no recipients other than
1542@code{Gcc} or @code{Fcc}. If it is @code{always}, the posting is
1543allowed. If it is @code{never}, the posting is not allowed. If it is
1544@code{ask} (the default), you are prompted.
1545
1546@item message-hidden-headers
1547@vindex message-hidden-headers
1548A regexp, a list of regexps, or a list where the first element is
1549@code{not} and the rest are regexps. It says which headers to keep
1550hidden when composing a message.
1551
1552@lisp
1553(setq message-hidden-headers
1554 '(not "From" "Subject" "To" "Cc" "Newsgroups"))
1555@end lisp
1556
01c52d31
MB
1557Headers are hidden using narrowing, you can use @kbd{M-x widen} to
1558expose them in the buffer.
1559
4009494e
GM
1560@item message-header-synonyms
1561@vindex message-header-synonyms
1562A list of lists of header synonyms. E.g., if this list contains a
1563member list with elements @code{Cc} and @code{To}, then
1564@code{message-carefully-insert-headers} will not insert a @code{To}
1565header when the message is already @code{Cc}ed to the recipient.
1566
1567@end table
1568
1569
1570@node Mail Headers
1571@section Mail Headers
1572
1573@table @code
1574@item message-required-mail-headers
1575@vindex message-required-mail-headers
1576@xref{News Headers}, for the syntax of this variable. It is
1577@code{(From Subject Date (optional . In-Reply-To) Message-ID
1578(optional . User-Agent))} by default.
1579
1580@item message-ignored-mail-headers
1581@vindex message-ignored-mail-headers
1582Regexp of headers to be removed before mailing. The default is@*
1583@samp{^[GF]cc:\\|^Resent-Fcc:\\|^Xref:\\|^X-Draft-From:\\|@*
1584^X-Gnus-Agent-Meta-Information:}.
1585
1586@item message-default-mail-headers
1587@vindex message-default-mail-headers
1588This string is inserted at the end of the headers in all message
1589buffers that are initialized as mail.
1590
01c52d31
MB
1591@item message-generate-hashcash
1592@vindex message-generate-hashcash
1593Variable that indicates whether @samp{X-Hashcash} headers
1594should be computed for the message. @xref{Hashcash, ,Hashcash,gnus,
1595The Gnus Manual}. If @code{opportunistic}, only generate the headers
1596when it doesn't lead to the user having to wait.
1597
4009494e
GM
1598@end table
1599
1600
1601@node Mail Variables
1602@section Mail Variables
1603
1604@table @code
1605@item message-send-mail-function
1606@vindex message-send-mail-function
d82cf70b 1607@findex message-send-mail-function
4009494e
GM
1608@findex message-send-mail-with-sendmail
1609@findex message-send-mail-with-mh
1610@findex message-send-mail-with-qmail
1611@findex message-smtpmail-send-it
1612@findex smtpmail-send-it
1613@findex feedmail-send-it
d82cf70b 1614@findex message-send-mail-with-mailclient
4009494e 1615Function used to send the current buffer as mail. The default is
01c52d31
MB
1616@code{message-send-mail-with-sendmail}, or @code{smtpmail-send-it}
1617according to the system. Other valid values include
d82cf70b 1618@code{message-send-mail-with-mailclient},
4009494e 1619@code{message-send-mail-with-mh}, @code{message-send-mail-with-qmail},
01c52d31 1620@code{message-smtpmail-send-it} and @code{feedmail-send-it}.
4009494e 1621
d82cf70b
MB
1622The function
1623@code{message-send-mail-with-sendmail} pipes your article to the
1624@code{sendmail} binary for further queuing and sending. When your local
1625system is not configured for sending mail using @code{sendmail}, and you
1626have access to a remote @acronym{SMTP} server, you can set
1627@code{message-send-mail-function} to @code{smtpmail-send-it} and make
1628sure to setup the @code{smtpmail} package correctly. An example:
1629
1630@lisp
1631(setq message-send-mail-function 'smtpmail-send-it
1632 smtpmail-default-smtp-server "YOUR SMTP HOST")
1633@end lisp
1634
1635To the thing similar to this, there is
1636@code{message-smtpmail-send-it}. It is useful if your @acronym{ISP}
1637requires the @acronym{POP}-before-@acronym{SMTP} authentication.
1638@xref{POP before SMTP, , POP before SMTP, gnus, The Gnus Manual}.
1639
4009494e
GM
1640@item message-mh-deletable-headers
1641@vindex message-mh-deletable-headers
1642Most versions of MH doesn't like being fed messages that contain the
1643headers in this variable. If this variable is non-@code{nil} (which is
1644the default), these headers will be removed before mailing when sending
1645messages via MH. Set it to @code{nil} if your MH can handle these
1646headers.
1647
1648@item message-qmail-inject-program
1649@vindex message-qmail-inject-program
1650@cindex qmail
1651Location of the qmail-inject program.
1652
1653@item message-qmail-inject-args
1654@vindex message-qmail-inject-args
1655Arguments passed to qmail-inject programs.
1656This should be a list of strings, one string for each argument. It
1657may also be a function.
1658
1659For e.g., if you wish to set the envelope sender address so that bounces
1660go to the right place or to deal with listserv's usage of that address, you
1661might set this variable to @code{'("-f" "you@@some.where")}.
1662
1663@item message-sendmail-f-is-evil
1664@vindex message-sendmail-f-is-evil
1665@cindex sendmail
1666Non-@code{nil} means don't add @samp{-f username} to the sendmail
1667command line. Doing so would be even more evil than leaving it out.
1668
1669@item message-sendmail-envelope-from
1670@vindex message-sendmail-envelope-from
1671When @code{message-sendmail-f-is-evil} is @code{nil}, this specifies
1672the address to use in the @acronym{SMTP} envelope. If it is
1673@code{nil}, use @code{user-mail-address}. If it is the symbol
1674@code{header}, use the @samp{From} header of the message.
1675
1676@item message-mailer-swallows-blank-line
1677@vindex message-mailer-swallows-blank-line
1678Set this to non-@code{nil} if the system's mailer runs the header and
1679body together. (This problem exists on SunOS 4 when sendmail is run
1680in remote mode.) The value should be an expression to test whether
1681the problem will actually occur.
1682
1683@item message-send-mail-partially-limit
1684@vindex message-send-mail-partially-limit
1685@cindex split large message
1686The limitation of messages sent as message/partial. The lower bound
1687of message size in characters, beyond which the message should be sent
85115796
KY
1688in several parts. If it is @code{nil} (which is the default), the
1689size is unlimited.
4009494e
GM
1690
1691@end table
1692
1693
1694@node News Headers
1695@section News Headers
1696
1697@vindex message-required-news-headers
1698@code{message-required-news-headers} a list of header symbols. These
1699headers will either be automatically generated, or, if that's
1700impossible, they will be prompted for. The following symbols are valid:
1701
1702@table @code
1703
1704@item From
1705@cindex From
1706@findex user-full-name
1707@findex user-mail-address
1708This required header will be filled out with the result of the
1709@code{message-make-from} function, which depends on the
1710@code{message-from-style}, @code{user-full-name},
1711@code{user-mail-address} variables.
1712
1713@item Subject
1714@cindex Subject
1715This required header will be prompted for if not present already.
1716
1717@item Newsgroups
1718@cindex Newsgroups
1719This required header says which newsgroups the article is to be posted
1720to. If it isn't present already, it will be prompted for.
1721
1722@item Organization
1723@cindex organization
1724@vindex message-user-organization
1725@vindex message-user-organization-file
1726This optional header will be filled out depending on the
1727@code{message-user-organization} variable.
1728@code{message-user-organization-file} will be used if this variable is
1729@code{t}. This variable can also be a string (in which case this string
1730will be used), or it can be a function (which will be called with no
1731parameters and should return a string to be used).
1732
1733@item Lines
1734@cindex Lines
1735This optional header will be computed by Message.
1736
1737@item Message-ID
1738@cindex Message-ID
1739@vindex message-user-fqdn
1740@vindex mail-host-address
1741@vindex user-mail-address
1742@findex system-name
1743@cindex Sun
1744@cindex i-did-not-set--mail-host-address--so-tickle-me
1745This required header will be generated by Message. A unique ID will be
1746created based on the date, time, user name (for the local part) and the
1747domain part. For the domain part, message will look (in this order) at
1748@code{message-user-fqdn}, @code{system-name}, @code{mail-host-address}
1749and @code{message-user-mail-address} (i.e. @code{user-mail-address})
1750until a probably valid fully qualified domain name (FQDN) was found.
1751
1752@item User-Agent
1753@cindex User-Agent
1754This optional header will be filled out according to the
1755@code{message-newsreader} local variable.
1756
1757@item In-Reply-To
1758This optional header is filled out using the @code{Date} and @code{From}
1759header of the article being replied to.
1760
1761@item Expires
1762@cindex Expires
1763@vindex message-expires
1764This extremely optional header will be inserted according to the
1765@code{message-expires} variable. It is highly deprecated and shouldn't
1766be used unless you know what you're doing.
1767
1768@item Distribution
1769@cindex Distribution
1770@vindex message-distribution-function
1771This optional header is filled out according to the
1772@code{message-distribution-function} variable. It is a deprecated and
1773much misunderstood header.
1774
1775@item Path
1776@cindex path
1777@vindex message-user-path
1778This extremely optional header should probably never be used.
1779However, some @emph{very} old servers require that this header is
1780present. @code{message-user-path} further controls how this
1781@code{Path} header is to look. If it is @code{nil}, use the server name
1782as the leaf node. If it is a string, use the string. If it is neither
1783a string nor @code{nil}, use the user name only. However, it is highly
1784unlikely that you should need to fiddle with this variable at all.
1785@end table
1786
1787@findex yow
1788@cindex Mime-Version
1789In addition, you can enter conses into this list. The @sc{car} of this cons
1790should be a symbol. This symbol's name is the name of the header, and
1791the @sc{cdr} can either be a string to be entered verbatim as the value of
1792this header, or it can be a function to be called. This function should
1793return a string to be inserted. For instance, if you want to insert
1794@code{Mime-Version: 1.0}, you should enter @code{(Mime-Version . "1.0")}
1795into the list. If you want to insert a funny quote, you could enter
1796something like @code{(X-Yow . yow)} into the list. The function
1797@code{yow} will then be called without any arguments.
1798
1799If the list contains a cons where the @sc{car} of the cons is
1800@code{optional}, the @sc{cdr} of this cons will only be inserted if it is
1801non-@code{nil}.
1802
1803If you want to delete an entry from this list, the following Lisp
1804snippet might be useful. Adjust accordingly if you want to remove
1805another element.
1806
1807@lisp
1808(setq message-required-news-headers
1809 (delq 'Message-ID message-required-news-headers))
1810@end lisp
1811
1812Other variables for customizing outgoing news articles:
1813
1814@table @code
1815
1816@item message-syntax-checks
1817@vindex message-syntax-checks
1818Controls what syntax checks should not be performed on outgoing posts.
1819To disable checking of long signatures, for instance, add
1820
1821@lisp
1822(signature . disabled)
1823@end lisp
1824
1825to this list.
1826
1827Valid checks are:
1828
1829@table @code
1830@item approved
1831@cindex approved
1832Check whether the article has an @code{Approved} header, which is
1833something only moderators should include.
1834@item continuation-headers
1835Check whether there are continuation header lines that don't begin with
1836whitespace.
1837@item control-chars
1838Check for invalid characters.
1839@item empty
1840Check whether the article is empty.
1841@item existing-newsgroups
1842Check whether the newsgroups mentioned in the @code{Newsgroups} and
1843@code{Followup-To} headers exist.
1844@item from
1845Check whether the @code{From} header seems nice.
1846@item illegible-text
1847Check whether there is any non-printable character in the body.
1848@item invisible-text
1849Check whether there is any invisible text in the buffer.
1850@item long-header-lines
1851Check for too long header lines.
1852@item long-lines
1853@cindex long lines
1854Check for too long lines in the body.
1855@item message-id
1856Check whether the @code{Message-ID} looks syntactically ok.
1857@item multiple-headers
1858Check for the existence of multiple equal headers.
1859@item new-text
1860Check whether there is any new text in the messages.
1861@item newsgroups
1862Check whether the @code{Newsgroups} header exists and is not empty.
1863@item quoting-style
1864Check whether text follows last quoted portion.
1865@item repeated-newsgroups
1866Check whether the @code{Newsgroups} and @code{Followup-to} headers
1867contains repeated group names.
1868@item reply-to
1869Check whether the @code{Reply-To} header looks ok.
1870@item sender
1871@cindex Sender
1872Insert a new @code{Sender} header if the @code{From} header looks odd.
1873@item sendsys
1874@cindex sendsys
1875Check for the existence of version and sendsys commands.
1876@item shoot
1877Check whether the domain part of the @code{Message-ID} header looks ok.
1878@item shorten-followup-to
1879Check whether to add a @code{Followup-to} header to shorten the number
1880of groups to post to.
1881@item signature
1882Check the length of the signature.
1883@item size
1884Check for excessive size.
1885@item subject
1886Check whether the @code{Subject} header exists and is not empty.
1887@item subject-cmsg
1888Check the subject for commands.
1889@item valid-newsgroups
1890Check whether the @code{Newsgroups} and @code{Followup-to} headers
1891are valid syntactically.
1892@end table
1893
1894All these conditions are checked by default, except for @code{sender}
1895for which the check is disabled by default if
1896@code{message-insert-canlock} is non-@code{nil} (@pxref{Canceling News}).
1897
1898@item message-ignored-news-headers
1899@vindex message-ignored-news-headers
1900Regexp of headers to be removed before posting. The default is@*
1901@samp{^NNTP-Posting-Host:\\|^Xref:\\|^[BGF]cc:\\|^Resent-Fcc:\\|@*
1902^X-Draft-From:\\|^X-Gnus-Agent-Meta-Information:}.
1903
1904@item message-default-news-headers
1905@vindex message-default-news-headers
1906This string is inserted at the end of the headers in all message
1907buffers that are initialized as news.
1908
1909@end table
1910
1911
1912@node News Variables
1913@section News Variables
1914
1915@table @code
1916@item message-send-news-function
1917@vindex message-send-news-function
1918Function used to send the current buffer as news. The default is
1919@code{message-send-news}.
1920
1921@item message-post-method
1922@vindex message-post-method
1923Gnusish @dfn{select method} (see the Gnus manual for details) used for
1924posting a prepared news message.
1925
1926@end table
1927
1928
1929@node Insertion Variables
1930@section Insertion Variables
1931
1932@table @code
1933@item message-ignored-cited-headers
1934@vindex message-ignored-cited-headers
1935All headers that match this regexp will be removed from yanked
1936messages. The default is @samp{.}, which means that all headers will be
1937removed.
1938
1939@item message-cite-prefix-regexp
1940@vindex message-cite-prefix-regexp
1941Regexp matching the longest possible citation prefix on a line.
1942
1943@item message-citation-line-function
1944@vindex message-citation-line-function
1945@cindex attribution line
1946Function called to insert the citation line. The default is
1947@code{message-insert-citation-line}, which will lead to citation lines
1948that look like:
1949
1950@example
1951Hallvard B Furuseth <h.b.furuseth@@usit.uio.no> writes:
1952@end example
1953
01c52d31
MB
1954@c FIXME: Add `message-insert-formated-citation-line' and
1955@c `message-citation-line-format'
1956
4009494e
GM
1957Point will be at the beginning of the body of the message when this
1958function is called.
1959
1960Note that Gnus provides a feature where clicking on `writes:' hides the
1961cited text. If you change the citation line too much, readers of your
1962messages will have to adjust their Gnus, too. See the variable
1963@code{gnus-cite-attribution-suffix}. @xref{Article Highlighting, ,
1964Article Highlighting, gnus, The Gnus Manual}, for details.
1965
1966@item message-yank-prefix
1967@vindex message-yank-prefix
1968@cindex yanking
1969@cindex quoting
1970When you are replying to or following up an article, you normally want
01c52d31
MB
1971to quote the person you are answering. Inserting quoted text is done by
1972@dfn{yanking}, and each line you yank will have
1973@code{message-yank-prefix} prepended to it (except for quoted lines
1974which use @code{message-yank-cited-prefix} and empty lines which use
1975@code{message-yank-empty-prefix}). The default is @samp{> }.
4009494e
GM
1976
1977@item message-yank-cited-prefix
1978@vindex message-yank-cited-prefix
1979@cindex yanking
1980@cindex cited
1981@cindex quoting
01c52d31
MB
1982When yanking text from an article which contains already cited text,
1983each line will be prefixed with the contents of this variable. The
1984default is @samp{>}. See also @code{message-yank-prefix}.
1985
1986@item message-yank-empty-prefix
1987@vindex message-yank-empty-prefix
1988@cindex yanking
1989@cindex quoting
1990When yanking text from an article, each empty line will be prefixed with
1991the contents of this variable. The default is @samp{>}. You can set
1992this variable to an empty string to split the cited text into paragraphs
1993automatically. See also @code{message-yank-prefix}.
4009494e
GM
1994
1995@item message-indentation-spaces
1996@vindex message-indentation-spaces
1997Number of spaces to indent yanked messages.
1998
1999@item message-cite-function
2000@vindex message-cite-function
2001@findex message-cite-original
4009494e 2002@findex message-cite-original-without-signature
4009494e
GM
2003Function for citing an original message. The default is
2004@code{message-cite-original}, which simply inserts the original message
2005and prepends @samp{> } to each line.
2006@code{message-cite-original-without-signature} does the same, but elides
dae0a942 2007the signature.
4009494e
GM
2008
2009@item message-indent-citation-function
2010@vindex message-indent-citation-function
2011Function for modifying a citation just inserted in the mail buffer.
2012This can also be a list of functions. Each function can find the
2013citation between @code{(point)} and @code{(mark t)}. And each function
2014should leave point and mark around the citation text as modified.
2015
2016@item message-mark-insert-begin
2017@vindex message-mark-insert-begin
2018String to mark the beginning of some inserted text.
2019
2020@item message-mark-insert-end
2021@vindex message-mark-insert-end
2022String to mark the end of some inserted text.
2023
2024@item message-signature
2025@vindex message-signature
2026String to be inserted at the end of the message buffer. If @code{t}
2027(which is the default), the @code{message-signature-file} file will be
2028inserted instead. If a function, the result from the function will be
2029used instead. If a form, the result from the form will be used instead.
2030If this variable is @code{nil}, no signature will be inserted at all.
2031
2032@item message-signature-file
2033@vindex message-signature-file
2034File containing the signature to be inserted at the end of the buffer.
01c52d31
MB
2035If a path is specified, the value of
2036@code{message-signature-directory} is ignored, even if set.
4009494e
GM
2037The default is @file{~/.signature}.
2038
01c52d31
MB
2039@item message-signature-directory
2040@vindex message-signature-directory
2041Name of directory containing signature files. Comes in handy if you
2042have many such files, handled via Gnus posting styles for instance.
2043If @code{nil} (the default), @code{message-signature-file} is expected
2044to specify the directory if needed.
2045
2046
4009494e
GM
2047@item message-signature-insert-empty-line
2048@vindex message-signature-insert-empty-line
2049If @code{t} (the default value) an empty line is inserted before the
2050signature separator.
2051
2052@end table
2053
2054Note that RFC1036bis says that a signature should be preceded by the three
2055characters @samp{-- } on a line by themselves. This is to make it
2056easier for the recipient to automatically recognize and process the
2057signature. So don't remove those characters, even though you might feel
2058that they ruin your beautiful design, like, totally.
2059
2060Also note that no signature should be more than four lines long.
2061Including @acronym{ASCII} graphics is an efficient way to get
2062everybody to believe that you are silly and have nothing important to
2063say.
2064
2065
2066@node Various Message Variables
2067@section Various Message Variables
2068
2069@table @code
2070@item message-default-charset
2071@vindex message-default-charset
2072@cindex charset
2073Symbol naming a @acronym{MIME} charset. Non-@acronym{ASCII} characters
2074in messages are assumed to be encoded using this charset. The default
2075is @code{iso-8859-1} on non-@sc{mule} Emacsen; otherwise @code{nil},
2076which means ask the user. (This variable is used only on non-@sc{mule}
2077Emacsen.) @xref{Charset Translation, , Charset Translation, emacs-mime,
2078Emacs MIME Manual}, for details on the @sc{mule}-to-@acronym{MIME}
2079translation process.
2080
01c52d31
MB
2081@item message-fill-column
2082@vindex message-fill-column
2083@cindex auto-fill
2084Local value for the column beyond which automatic line-wrapping should
2085happen for message buffers. If non-nil (the default), also turn on
2086auto-fill in message buffers.
2087
4009494e
GM
2088@item message-signature-separator
2089@vindex message-signature-separator
2090Regexp matching the signature separator. It is @samp{^-- *$} by
2091default.
2092
2093@item mail-header-separator
2094@vindex mail-header-separator
2095String used to separate the headers from the body. It is @samp{--text
2096follows this line--} by default.
2097
2098@item message-directory
2099@vindex message-directory
2100Directory used by many mailey things. The default is @file{~/Mail/}.
2101All other mail file variables are derived from @code{message-directory}.
2102
2103@item message-auto-save-directory
2104@vindex message-auto-save-directory
2105Directory where Message auto-saves buffers if Gnus isn't running. If
2106@code{nil}, Message won't auto-save. The default is @file{~/Mail/drafts/}.
2107
2108@item message-signature-setup-hook
2109@vindex message-signature-setup-hook
2110Hook run when initializing the message buffer. It is run after the
2111headers have been inserted but before the signature has been inserted.
2112
2113@item message-setup-hook
2114@vindex message-setup-hook
2115Hook run as the last thing when the message buffer has been initialized,
2116but before yanked text is inserted.
2117
2118@item message-header-setup-hook
2119@vindex message-header-setup-hook
2120Hook called narrowed to the headers after initializing the headers.
2121
2122For instance, if you're running Gnus and wish to insert a
2123@samp{Mail-Copies-To} header in all your news articles and all messages
2124you send to mailing lists, you could do something like the following:
2125
2126@lisp
2127(defun my-message-header-setup-hook ()
2128 (let ((group (or gnus-newsgroup-name "")))
2129 (when (or (message-fetch-field "newsgroups")
2130 (gnus-group-find-parameter group 'to-address)
2131 (gnus-group-find-parameter group 'to-list))
2132 (insert "Mail-Copies-To: never\n"))))
2133
2134(add-hook 'message-header-setup-hook
2135 'my-message-header-setup-hook)
2136@end lisp
2137
2138@item message-send-hook
2139@vindex message-send-hook
2140Hook run before sending messages.
2141
2142If you want to add certain headers before sending, you can use the
2143@code{message-add-header} function in this hook. For instance:
2144@findex message-add-header
2145
2146@lisp
2147(add-hook 'message-send-hook 'my-message-add-content)
2148(defun my-message-add-content ()
2149 (message-add-header "X-In-No-Sense: Nonsense")
2150 (message-add-header "X-Whatever: no"))
2151@end lisp
2152
2153This function won't add the header if the header is already present.
2154
2155@item message-send-mail-hook
2156@vindex message-send-mail-hook
2157Hook run before sending mail messages. This hook is run very late --
2158just before the message is actually sent as mail.
2159
2160@item message-send-news-hook
2161@vindex message-send-news-hook
2162Hook run before sending news messages. This hook is run very late --
2163just before the message is actually sent as news.
2164
2165@item message-sent-hook
2166@vindex message-sent-hook
2167Hook run after sending messages.
2168
2169@item message-cancel-hook
2170@vindex message-cancel-hook
2171Hook run when canceling news articles.
2172
2173@item message-mode-syntax-table
2174@vindex message-mode-syntax-table
2175Syntax table used in message mode buffers.
2176
01c52d31
MB
2177@item message-cite-articles-with-x-no-archive
2178@vindex message-cite-articles-with-x-no-archive
2179If non-@code{nil}, don't strip quoted text from articles that have
2180@samp{X-No-Archive} set. Even if this variable isn't set, you can
2181undo the stripping by hitting the @code{undo} keystroke.
2182
4009494e
GM
2183@item message-strip-special-text-properties
2184@vindex message-strip-special-text-properties
2185Emacs has a number of special text properties which can break message
2186composing in various ways. If this option is set, message will strip
2187these properties from the message composition buffer. However, some
2188packages requires these properties to be present in order to work. If
2189you use one of these packages, turn this option off, and hope the
2190message composition doesn't break too bad.
2191
2192@item message-send-method-alist
2193@vindex message-send-method-alist
2194@findex message-mail-p
2195@findex message-news-p
2196@findex message-send-via-mail
2197@findex message-send-via-news
2198Alist of ways to send outgoing messages. Each element has the form:
2199
2200@lisp
2201(@var{type} @var{predicate} @var{function})
2202@end lisp
2203
2204@table @var
2205@item type
2206A symbol that names the method.
2207
2208@item predicate
2209A function called without any parameters to determine whether the
2210message is a message of type @var{type}. The function will be called in
2211the buffer where the message is.
2212
2213@item function
2214A function to be called if @var{predicate} returns non-@code{nil}.
01c52d31 2215@var{function} is called with one parameter---the prefix.
4009494e
GM
2216@end table
2217
2218The default is:
2219
2220@lisp
2221((news message-news-p message-send-via-news)
2222 (mail message-mail-p message-send-via-mail))
2223@end lisp
2224
2225The @code{message-news-p} function returns non-@code{nil} if the message
2226looks like news, and the @code{message-send-via-news} function sends the
2227message according to the @code{message-send-news-function} variable
2228(@pxref{News Variables}). The @code{message-mail-p} function returns
2229non-@code{nil} if the message looks like mail, and the
2230@code{message-send-via-mail} function sends the message according to the
2231@code{message-send-mail-function} variable (@pxref{Mail Variables}).
2232
2233All the elements in this alist will be tried in order, so a message
2234containing both a valid @samp{Newsgroups} header and a valid @samp{To}
2235header, for example, will be sent as news, and then as mail.
2236@end table
2237
2238
2239
2240@node Sending Variables
2241@section Sending Variables
2242
2243@table @code
2244
2245@item message-fcc-handler-function
2246@vindex message-fcc-handler-function
2247A function called to save outgoing articles. This function will be
2248called with the name of the file to store the article in. The default
2249function is @code{message-output} which saves in Unix mailbox format.
2250
2251@item message-courtesy-message
2252@vindex message-courtesy-message
2253When sending combined messages, this string is inserted at the start of
2254the mailed copy. If the string contains the format spec @samp{%s}, the
2255newsgroups the article has been posted to will be inserted there. If
2256this variable is @code{nil}, no such courtesy message will be added.
2257The default value is @samp{"The following message is a courtesy copy of
2258an article\\nthat has been posted to %s as well.\\n\\n"}.
2259
2260@item message-fcc-externalize-attachments
2261@vindex message-fcc-externalize-attachments
2262If @code{nil}, attach files as normal parts in Fcc copies; if it is
2263non-@code{nil}, attach local files as external parts.
2264
2265@item message-interactive
2266@vindex message-interactive
2267If non-@code{nil} wait for and display errors when sending a message;
2268if @code{nil} let the mailer mail back a message to report errors.
2269
e52cac88
MB
2270@item message-confirm-send
2271@vindex message-confirm-send
eef5ade7 2272When non-@code{nil}, Gnus will ask for confirmation when sending a
e52cac88
MB
2273message.
2274
4009494e
GM
2275@end table
2276
2277
2278@node Message Buffers
2279@section Message Buffers
2280
2281Message will generate new buffers with unique buffer names when you
2282request a message buffer. When you send the message, the buffer isn't
2283normally killed off. Its name is changed and a certain number of old
2284message buffers are kept alive.
2285
2286@table @code
2287@item message-generate-new-buffers
2288@vindex message-generate-new-buffers
2289Controls whether to create a new message buffer to compose a message.
2290Valid values include:
2291
2292@table @code
2293@item nil
2294Generate the buffer name in the Message way (e.g., *mail*, *news*, *mail
2295to whom*, *news on group*, etc.) and continue editing in the existing
2296buffer of that name. If there is no such buffer, it will be newly
2297created.
2298
2299@item unique
2300@item t
a5057546 2301Create the new buffer with the name generated in the Message way.
4009494e
GM
2302
2303@item unsent
2304Similar to @code{unique} but the buffer name begins with "*unsent ".
2305
2306@item standard
2307Similar to @code{nil} but the buffer name is simpler like *mail
2308message*.
2309@end table
2310@table @var
2311@item function
2312If this is a function, call that function with three parameters: The
2313type, the To address and the group name (any of these may be
2314@code{nil}). The function should return the new buffer name.
2315@end table
2316
a5057546 2317The default value is @code{unsent}.
4009494e
GM
2318
2319@item message-max-buffers
2320@vindex message-max-buffers
2321This variable says how many old message buffers to keep. If there are
2322more message buffers than this, the oldest buffer will be killed. The
2323default is 10. If this variable is @code{nil}, no old message buffers
2324will ever be killed.
2325
2326@item message-send-rename-function
2327@vindex message-send-rename-function
2328After sending a message, the buffer is renamed from, for instance,
2329@samp{*reply to Lars*} to @samp{*sent reply to Lars*}. If you don't
2330like this, set this variable to a function that renames the buffer in a
2331manner you like. If you don't want to rename the buffer at all, you can
2332say:
2333
2334@lisp
2335(setq message-send-rename-function 'ignore)
2336@end lisp
2337
2338@item message-kill-buffer-on-exit
2339@findex message-kill-buffer-on-exit
2340If non-@code{nil}, kill the buffer immediately on exit.
2341
2342@end table
2343
2344
2345@node Message Actions
2346@section Message Actions
2347
2348When Message is being used from a news/mail reader, the reader is likely
2349to want to perform some task after the message has been sent. Perhaps
2350return to the previous window configuration or mark an article as
2351replied.
2352
2353@vindex message-kill-actions
2354@vindex message-postpone-actions
2355@vindex message-exit-actions
2356@vindex message-send-actions
2357The user may exit from the message buffer in various ways. The most
2358common is @kbd{C-c C-c}, which sends the message and exits. Other
2359possibilities are @kbd{C-c C-s} which just sends the message, @kbd{C-c
2360C-d} which postpones the message editing and buries the message buffer,
2361and @kbd{C-c C-k} which kills the message buffer. Each of these actions
2362have lists associated with them that contains actions to be executed:
2363@code{message-send-actions}, @code{message-exit-actions},
2364@code{message-postpone-actions}, and @code{message-kill-actions}.
2365
2366Message provides a function to interface with these lists:
2367@code{message-add-action}. The first parameter is the action to be
2368added, and the rest of the arguments are which lists to add this action
2369to. Here's an example from Gnus:
2370
2371@lisp
2372 (message-add-action
2373 `(set-window-configuration ,(current-window-configuration))
2374 'exit 'postpone 'kill)
2375@end lisp
2376
2377This restores the Gnus window configuration when the message buffer is
2378killed, postponed or exited.
2379
2380An @dfn{action} can be either: a normal function, or a list where the
2381@sc{car} is a function and the @sc{cdr} is the list of arguments, or
2382a form to be @code{eval}ed.
2383
2384
2385@node Compatibility
2386@chapter Compatibility
2387@cindex compatibility
2388
2389Message uses virtually only its own variables---older @code{mail-}
2390variables aren't consulted. To force Message to take those variables
2391into account, you can put the following in your @file{.emacs} file:
2392
2393@lisp
2394(require 'messcompat)
2395@end lisp
2396
2397This will initialize many Message variables from the values in the
2398corresponding mail variables.
2399
2400
2401@node Appendices
2402@chapter Appendices
2403
2404@menu
2405* Responses:: Standard rules for determining where responses go.
2406@end menu
2407
2408
2409@node Responses
2410@section Responses
2411
2412To determine where a message is to go, the following algorithm is used
2413by default.
2414
2415@table @dfn
2416@item reply
2417A @dfn{reply} is when you want to respond @emph{just} to the person who
2418sent the message via mail. There will only be one recipient. To
2419determine who the recipient will be, the following headers are
2420consulted, in turn:
2421
2422@table @code
2423@item Reply-To
2424
2425@item From
2426@end table
2427
2428
2429@item wide reply
2430A @dfn{wide reply} is a mail response that includes @emph{all} entities
da0bbbc4 2431mentioned in the message you are responding to. All mailboxes from the
4009494e
GM
2432following headers will be concatenated to form the outgoing
2433@code{To}/@code{Cc} headers:
2434
2435@table @code
2436@item From
2437(unless there's a @code{Reply-To}, in which case that is used instead).
2438
2439@item Cc
2440
2441@item To
2442@end table
2443
2444If a @code{Mail-Copies-To} header is present, it will also be included
2445in the list of mailboxes. If this header is @samp{never}, that means
2446that the @code{From} (or @code{Reply-To}) mailbox will be suppressed.
2447
2448
2449@item followup
2450A @dfn{followup} is a response sent via news. The following headers
2451(listed in order of precedence) determine where the response is to be
2452sent:
2453
2454@table @code
2455
2456@item Followup-To
2457
2458@item Newsgroups
2459
2460@end table
2461
2462If a @code{Mail-Copies-To} header is present, it will be used as the
2463basis of the new @code{Cc} header, except if this header is
2464@samp{never}.
2465
2466@end table
2467
2468
2469@node GNU Free Documentation License
2470@chapter GNU Free Documentation License
2471@include doclicense.texi
2472
2473@node Index
2474@chapter Index
2475@printindex cp
2476
2477@node Key Index
2478@chapter Key Index
2479@printindex ky
2480
4009494e
GM
2481@bye
2482
2483@c End: