Fix XEmacs compilation
[gnus] / lisp / message.el
1 ;;; message.el --- composing mail and news messages
2
3 ;; Copyright (C) 1996-2014 Free Software Foundation, Inc.
4
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: mail, news
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
22
23 ;;; Commentary:
24
25 ;; This mode provides mail-sending facilities from within Emacs.  It
26 ;; consists mainly of large chunks of code from the sendmail.el,
27 ;; gnus-msg.el and rnewspost.el files.
28
29 ;;; Code:
30
31 (eval-when-compile
32   (require 'cl))
33
34 (require 'mailheader)
35 (require 'gmm-utils)
36 (require 'mail-utils)
37 ;; Only for the trivial macros mail-header-from, mail-header-date
38 ;; mail-header-references, mail-header-subject, mail-header-id
39 (eval-when-compile (require 'nnheader))
40 ;; This is apparently necessary even though things are autoloaded.
41 ;; Because we dynamically bind mail-abbrev-mode-regexp, we'd better
42 ;; require mailabbrev here.
43 (if (featurep 'xemacs)
44     (require 'mail-abbrevs)
45   (require 'mailabbrev))
46 (require 'mail-parse)
47 (require 'mml)
48 (require 'rfc822)
49 (require 'format-spec)
50 (require 'dired)
51
52 (autoload 'mailclient-send-it "mailclient") ;; Emacs 22 or contrib/
53
54 (defvar gnus-message-group-art)
55 (defvar gnus-list-identifiers) ; gnus-sum is required where necessary
56 (defvar rmail-enable-mime-composing)
57
58 (defgroup message '((user-mail-address custom-variable)
59                     (user-full-name custom-variable))
60   "Mail and news message composing."
61   :link '(custom-manual "(message)Top")
62   :group 'mail
63   :group 'news)
64
65 (put 'user-mail-address 'custom-type 'string)
66 (put 'user-full-name 'custom-type 'string)
67
68 (defgroup message-various nil
69   "Various Message Variables."
70   :link '(custom-manual "(message)Various Message Variables")
71   :group 'message)
72
73 (defgroup message-buffers nil
74   "Message Buffers."
75   :link '(custom-manual "(message)Message Buffers")
76   :group 'message)
77
78 (defgroup message-sending nil
79   "Message Sending."
80   :link '(custom-manual "(message)Sending Variables")
81   :group 'message)
82
83 (defgroup message-interface nil
84   "Message Interface."
85   :link '(custom-manual "(message)Interface")
86   :group 'message)
87
88 (defgroup message-forwarding nil
89   "Message Forwarding."
90   :link '(custom-manual "(message)Forwarding")
91   :group 'message-interface)
92
93 (defgroup message-insertion nil
94   "Message Insertion."
95   :link '(custom-manual "(message)Insertion")
96   :group 'message)
97
98 (defgroup message-headers nil
99   "Message Headers."
100   :link '(custom-manual "(message)Message Headers")
101   :group 'message)
102
103 (defgroup message-news nil
104   "Composing News Messages."
105   :group 'message)
106
107 (defgroup message-mail nil
108   "Composing Mail Messages."
109   :group 'message)
110
111 (defgroup message-faces nil
112   "Faces used for message composing."
113   :group 'message
114   :group 'faces)
115
116 (defcustom message-directory "~/Mail/"
117   "*Directory from which all other mail file variables are derived."
118   :group 'message-various
119   :type 'directory)
120
121 (defcustom message-max-buffers 10
122   "*How many buffers to keep before starting to kill them off."
123   :group 'message-buffers
124   :type 'integer)
125
126 (defcustom message-send-rename-function nil
127   "Function called to rename the buffer after sending it."
128   :group 'message-buffers
129   :type '(choice function (const nil)))
130
131 (defcustom message-fcc-handler-function 'message-output
132   "*A function called to save outgoing articles.
133 This function will be called with the name of the file to store the
134 article in.  The default function is `message-output' which saves in Unix
135 mailbox format."
136   :type '(radio (function-item message-output)
137                 (function :tag "Other"))
138   :group 'message-sending)
139
140 (defcustom message-fcc-externalize-attachments nil
141   "If non-nil, attachments are included as external parts in Fcc copies."
142   :version "22.1"
143   :type 'boolean
144   :group 'message-sending)
145
146 (defcustom message-courtesy-message
147   "The following message is a courtesy copy of an article\nthat has been posted to %s as well.\n\n"
148   "*This is inserted at the start of a mailed copy of a posted message.
149 If the string contains the format spec \"%s\", the Newsgroups
150 the article has been posted to will be inserted there.
151 If this variable is nil, no such courtesy message will be added."
152   :group 'message-sending
153   :type '(radio string (const nil)))
154
155 (defcustom message-ignored-bounced-headers
156   "^\\(Received\\|Return-Path\\|Delivered-To\\):"
157   "*Regexp that matches headers to be removed in resent bounced mail."
158   :group 'message-interface
159   :type 'regexp)
160
161 (defcustom message-from-style 'default
162   ;; In Emacs 24.1 this defaults to the value of `mail-from-style'
163   ;; that defaults to:
164   ;; `angles' in Emacs 22.1~23.1, XEmacs 21.4, 21.5, and SXEmacs 22.1;
165   ;; `system-default' in Emacs 23.2, and 24.1
166   "Specifies how \"From\" headers look.
167
168 If nil, they contain just the return address like:
169         king@grassland.com
170 If `parens', they look like:
171         king@grassland.com (Elvis Parsley)
172 If `angles', they look like:
173         Elvis Parsley <king@grassland.com>
174
175 Otherwise, most addresses look like `angles', but they look like
176 `parens' if `angles' would need quoting and `parens' would not."
177   :version "23.2"
178   :type '(choice (const :tag "simple" nil)
179                  (const parens)
180                  (const angles)
181                  (const default))
182   :group 'message-headers)
183
184 (defcustom message-insert-canlock t
185   "Whether to insert a Cancel-Lock header in news postings."
186   :version "22.1"
187   :group 'message-headers
188   :type 'boolean)
189
190 (defcustom message-syntax-checks
191   (if message-insert-canlock '((sender . disabled)) nil)
192   ;; Guess this one shouldn't be easy to customize...
193   "*Controls what syntax checks should not be performed on outgoing posts.
194 To disable checking of long signatures, for instance, add
195  `(signature . disabled)' to this list.
196
197 Don't touch this variable unless you really know what you're doing.
198
199 Checks include `approved', `bogus-recipient', `continuation-headers',
200 `control-chars', `empty', `existing-newsgroups', `from', `illegible-text',
201 `invisible-text', `long-header-lines', `long-lines', `message-id',
202 `multiple-headers', `new-text', `newsgroups', `quoting-style',
203 `repeated-newsgroups', `reply-to', `sender', `sendsys', `shoot',
204 `shorten-followup-to', `signature', `size', `subject', `subject-cmsg'
205 and `valid-newsgroups'."
206   :group 'message-news
207   :type '(repeat sexp))                 ; Fixme: improve this
208
209 (defcustom message-required-headers '((optional . References)
210                                       From)
211   "*Headers to be generated or prompted for when sending a message.
212 Also see `message-required-news-headers' and
213 `message-required-mail-headers'."
214   :version "22.1"
215   :group 'message-news
216   :group 'message-headers
217   :link '(custom-manual "(message)Message Headers")
218   :type '(repeat sexp))
219
220 (defcustom message-draft-headers '(References From Date)
221   "*Headers to be generated when saving a draft message."
222   :version "22.1"
223   :group 'message-news
224   :group 'message-headers
225   :link '(custom-manual "(message)Message Headers")
226   :type '(repeat sexp))
227
228 (defcustom message-required-news-headers
229   '(From Newsgroups Subject Date Message-ID
230          (optional . Organization)
231          (optional . User-Agent))
232   "*Headers to be generated or prompted for when posting an article.
233 RFC977 and RFC1036 require From, Date, Newsgroups, Subject,
234 Message-ID.  Organization, Lines, In-Reply-To, Expires, and
235 User-Agent are optional.  If you don't want message to insert some
236 header, remove it from this list."
237   :group 'message-news
238   :group 'message-headers
239   :link '(custom-manual "(message)Message Headers")
240   :type '(repeat sexp))
241
242 (defcustom message-required-mail-headers
243   '(From Subject Date (optional . In-Reply-To) Message-ID
244          (optional . User-Agent))
245   "*Headers to be generated or prompted for when mailing a message.
246 It is recommended that From, Date, To, Subject and Message-ID be
247 included.  Organization and User-Agent are optional."
248   :group 'message-mail
249   :group 'message-headers
250   :link '(custom-manual "(message)Message Headers")
251   :type '(repeat sexp))
252
253 (defcustom message-prune-recipient-rules nil
254   "Rules for how to prune the list of recipients when doing wide replies.
255 This is a list of regexps and regexp matches."
256   :version "24.1"
257   :group 'message-mail
258   :group 'message-headers
259   :link '(custom-manual "(message)Wide Reply")
260   :type '(repeat regexp))
261
262 (defcustom message-deletable-headers '(Message-ID Date Lines)
263   "Headers to be deleted if they already exist and were generated by message previously."
264   :group 'message-headers
265   :link '(custom-manual "(message)Message Headers")
266   :type 'sexp)
267
268 (defcustom message-ignored-news-headers
269   "^NNTP-Posting-Host:\\|^Xref:\\|^[BGF]cc:\\|^Resent-Fcc:\\|^X-Draft-From:\\|^X-Gnus-Agent-Meta-Information:\\|^X-Message-SMTP-Method:\\|^X-Gnus-Delayed:"
270   "*Regexp of headers to be removed unconditionally before posting."
271   :group 'message-news
272   :group 'message-headers
273   :link '(custom-manual "(message)Message Headers")
274   :type '(repeat :value-to-internal (lambda (widget value)
275                                       (custom-split-regexp-maybe value))
276                  :match (lambda (widget value)
277                           (or (stringp value)
278                               (widget-editable-list-match widget value)))
279                  regexp))
280
281 (defcustom message-ignored-mail-headers
282   "^\\([GF]cc\\|Resent-Fcc\\|Xref\\|X-Draft-From\\|X-Gnus-Agent-Meta-Information\\):"
283   "*Regexp of headers to be removed unconditionally before mailing."
284   :group 'message-mail
285   :group 'message-headers
286   :link '(custom-manual "(message)Mail Headers")
287   :type 'regexp)
288
289 (defcustom message-ignored-supersedes-headers "^Path:\\|^Date\\|^NNTP-Posting-Host:\\|^Xref:\\|^Lines:\\|^Received:\\|^X-From-Line:\\|^X-Trace:\\|^X-ID:\\|^X-Complaints-To:\\|Return-Path:\\|^Supersedes:\\|^NNTP-Posting-Date:\\|^X-Trace:\\|^X-Complaints-To:\\|^Cancel-Lock:\\|^Cancel-Key:\\|^X-Hashcash:\\|^X-Payment:\\|^Approved:\\|^Injection-Date:\\|^Injection-Info:"
290   "*Header lines matching this regexp will be deleted before posting.
291 It's best to delete old Path and Date headers before posting to avoid
292 any confusion."
293   :group 'message-interface
294   :link '(custom-manual "(message)Superseding")
295   :type '(repeat :value-to-internal (lambda (widget value)
296                                       (custom-split-regexp-maybe value))
297                  :match (lambda (widget value)
298                           (or (stringp value)
299                               (widget-editable-list-match widget value)))
300                  regexp))
301
302 (defcustom message-subject-re-regexp
303   "^[ \t]*\\([Rr][Ee]\\(\\[[0-9]*\\]\\)*:[ \t]*\\)*[ \t]*"
304   "*Regexp matching \"Re: \" in the subject line."
305   :group 'message-various
306   :link '(custom-manual "(message)Message Headers")
307   :type 'regexp)
308
309 ;;; Start of variables adopted from `message-utils.el'.
310
311 (defcustom message-subject-trailing-was-query t
312   "*What to do with trailing \"(was: <old subject>)\" in subject lines.
313 If nil, leave the subject unchanged.  If it is the symbol `ask', query
314 the user what do do.  In this case, the subject is matched against
315 `message-subject-trailing-was-ask-regexp'.  If
316 `message-subject-trailing-was-query' is t, always strip the trailing
317 old subject.  In this case, `message-subject-trailing-was-regexp' is
318 used."
319   :version "24.1"
320   :type '(choice (const :tag "never" nil)
321                  (const :tag "always strip" t)
322                  (const ask))
323   :link '(custom-manual "(message)Message Headers")
324   :group 'message-various)
325
326 (defcustom message-subject-trailing-was-ask-regexp
327   "[ \t]*\\([[(]+[Ww][Aa][Ss]:?[ \t]*.*[])]+\\)"
328   "*Regexp matching \"(was: <old subject>)\" in the subject line.
329
330 The function `message-strip-subject-trailing-was' uses this regexp if
331 `message-subject-trailing-was-query' is set to the symbol `ask'.  If
332 the variable is t instead of `ask', use
333 `message-subject-trailing-was-regexp' instead.
334
335 It is okay to create some false positives here, as the user is asked."
336   :version "22.1"
337   :group 'message-various
338   :link '(custom-manual "(message)Message Headers")
339   :type 'regexp)
340
341 (defcustom message-subject-trailing-was-regexp
342   "[ \t]*\\((*[Ww][Aa][Ss]:[ \t]*.*)\\)"
343   "*Regexp matching \"(was: <old subject>)\" in the subject line.
344
345 If `message-subject-trailing-was-query' is set to t, the subject is
346 matched against `message-subject-trailing-was-regexp' in
347 `message-strip-subject-trailing-was'.  You should use a regexp creating very
348 few false positives here."
349   :version "22.1"
350   :group 'message-various
351   :link '(custom-manual "(message)Message Headers")
352   :type 'regexp)
353
354 ;;; marking inserted text
355
356 (defcustom message-mark-insert-begin
357   "--8<---------------cut here---------------start------------->8---\n"
358   "How to mark the beginning of some inserted text."
359   :version "22.1"
360   :type 'string
361   :link '(custom-manual "(message)Insertion Variables")
362   :group 'message-various)
363
364 (defcustom message-mark-insert-end
365   "--8<---------------cut here---------------end--------------->8---\n"
366   "How to mark the end of some inserted text."
367   :version "22.1"
368   :type 'string
369   :link '(custom-manual "(message)Insertion Variables")
370   :group 'message-various)
371
372 (defcustom message-archive-header "X-No-Archive: Yes\n"
373   "Header to insert when you don't want your article to be archived.
374 Archives \(such as groups.google.com\) respect this header."
375   :version "22.1"
376   :type 'string
377   :link '(custom-manual "(message)Header Commands")
378   :group 'message-various)
379
380 (defcustom message-archive-note
381   "X-No-Archive: Yes - save http://groups.google.com/"
382   "Note to insert why you wouldn't want this posting archived.
383 If nil, don't insert any text in the body."
384   :version "22.1"
385   :type '(radio string (const nil))
386   :link '(custom-manual "(message)Header Commands")
387   :group 'message-various)
388
389 ;;; Crossposts and Followups
390 ;; inspired by JoH-followup-to by Jochem Huhman <joh  at gmx.de>
391 ;; new suggestions by R. Weikusat <rw at another.de>
392
393 (defvar message-cross-post-old-target nil
394   "Old target for cross-posts or follow-ups.")
395 (make-variable-buffer-local 'message-cross-post-old-target)
396
397 (defcustom message-cross-post-default t
398   "When non-nil `message-cross-post-followup-to' will perform a crosspost.
399 If nil, `message-cross-post-followup-to' will only do a followup.  Note that
400 you can explicitly override this setting by calling
401 `message-cross-post-followup-to' with a prefix."
402   :version "22.1"
403   :type 'boolean
404   :group 'message-various)
405
406 (defcustom message-cross-post-note "Crosspost & Followup-To: "
407   "Note to insert before signature to notify of cross-post and follow-up."
408   :version "22.1"
409   :type 'string
410   :group 'message-various)
411
412 (defcustom message-followup-to-note "Followup-To: "
413   "Note to insert before signature to notify of follow-up only."
414   :version "22.1"
415   :type 'string
416   :group 'message-various)
417
418 (defcustom message-cross-post-note-function 'message-cross-post-insert-note
419   "Function to use to insert note about Crosspost or Followup-To.
420 The function will be called with four arguments.  The function should not only
421 insert a note, but also ensure old notes are deleted.  See the documentation
422 for `message-cross-post-insert-note'."
423   :version "22.1"
424   :type 'function
425   :group 'message-various)
426
427 ;;; End of variables adopted from `message-utils.el'.
428
429 (defcustom message-signature-separator "^-- $"
430   "Regexp matching the signature separator.
431 This variable is used to strip off the signature from quoted text
432 when `message-cite-function' is
433 `message-cite-original-without-signature'.  Most useful values
434 are \"^-- $\" (strict) and \"^-- *$\" (loose; allow missing
435 whitespace)."
436   :type '(choice (const :tag "strict" "^-- $")
437                  (const :tag "loose" "^-- *$")
438                  regexp)
439   :version "22.3" ;; Gnus 5.10.12 (changed default)
440   :link '(custom-manual "(message)Various Message Variables")
441   :group 'message-various)
442
443 (defcustom message-elide-ellipsis "\n[...]\n\n"
444   "*The string which is inserted for elided text.
445 This is a format-spec string, and you can use %l to say how many
446 lines were removed, and %c to say how many characters were
447 removed."
448   :type 'string
449   :link '(custom-manual "(message)Various Commands")
450   :group 'message-various)
451
452 (defcustom message-interactive t
453   ;; In Emacs 24.1 this defaults to the value of `mail-interactive'
454   ;; that defaults to:
455   ;; `nil' in Emacs 22.1~22.3, XEmacs 21.4, 21.5, and SXEmacs 22.1;
456   ;; `t' in Emacs 23.1~24.1
457   "Non-nil means when sending a message wait for and display errors.
458 A value of nil means let mailer mail back a message to report errors."
459   :version "23.2"
460   :group 'message-sending
461   :group 'message-mail
462   :link '(custom-manual "(message)Sending Variables")
463   :type 'boolean)
464
465 (defcustom message-confirm-send nil
466   "When non-nil, ask for confirmation when sending a message."
467   :group 'message-sending
468   :group 'message-mail
469   :version "23.1" ;; No Gnus
470   :link '(custom-manual "(message)Sending Variables")
471   :type 'boolean)
472
473 (defcustom message-generate-new-buffers 'unsent
474   "*Say whether to create a new message buffer to compose a message.
475 Valid values include:
476
477 nil
478   Generate the buffer name in the Message way (e.g., *mail*, *news*,
479   *mail to whom*, *news on group*, etc.) and continue editing in the
480   existing buffer of that name.  If there is no such buffer, it will
481   be newly created.
482
483 `unique' or t
484   Create the new buffer with the name generated in the Message way.
485
486 `unsent'
487   Similar to `unique' but the buffer name begins with \"*unsent \".
488
489 `standard'
490   Similar to nil but the buffer name is simpler like *mail message*.
491
492 function
493   If this is a function, call that function with three parameters:
494   The type, the To address and the group name (any of these may be nil).
495   The function should return the new buffer name."
496   :version "24.1"
497   :group 'message-buffers
498   :link '(custom-manual "(message)Message Buffers")
499   :type '(choice (const nil)
500                  (sexp :tag "unique" :format "unique\n" :value unique
501                        :match (lambda (widget value) (memq value '(unique t))))
502                  (const unsent)
503                  (const standard)
504                  (function :format "\n    %{%t%}: %v")))
505
506 (defcustom message-kill-buffer-on-exit nil
507   "*Non-nil means that the message buffer will be killed after sending a message."
508   :group 'message-buffers
509   :link '(custom-manual "(message)Message Buffers")
510   :type 'boolean)
511
512 (defcustom message-kill-buffer-query t
513   "*Non-nil means that killing a modified message buffer has to be confirmed.
514 This is used by `message-kill-buffer'."
515   :version "23.1" ;; No Gnus
516   :group 'message-buffers
517   :type 'boolean)
518
519 (defcustom message-user-organization
520   (or (getenv "ORGANIZATION") t)
521   "String to be used as an Organization header.
522 If t, use `message-user-organization-file'."
523   :group 'message-headers
524   :type '(choice string
525                  (const :tag "consult file" t)))
526
527 (defcustom message-user-organization-file
528   (let (orgfile)
529     (dolist (f (list "/etc/organization"
530                      "/etc/news/organization"
531                      "/usr/lib/news/organization"))
532       (when (file-readable-p f)
533         (setq orgfile f)))
534     orgfile)
535   "*Local news organization file."
536   :type '(choice (const nil) file)
537   :link '(custom-manual "(message)News Headers")
538   :group 'message-headers)
539
540 (defcustom message-make-forward-subject-function
541   #'message-forward-subject-name-subject
542   "*List of functions called to generate subject headers for forwarded messages.
543 The subject generated by the previous function is passed into each
544 successive function.
545
546 The provided functions are:
547
548 * `message-forward-subject-author-subject' Source of article (author or
549       newsgroup), in brackets followed by the subject
550 * `message-forward-subject-name-subject' Source of article (name of author
551       or newsgroup), in brackets followed by the subject
552 * `message-forward-subject-fwd' Subject of article with 'Fwd:' prepended
553       to it."
554   :group 'message-forwarding
555   :link '(custom-manual "(message)Forwarding")
556   :type '(radio (function-item message-forward-subject-author-subject)
557                 (function-item message-forward-subject-fwd)
558                 (function-item message-forward-subject-name-subject)
559                 (repeat :tag "List of functions" function)))
560
561 (defcustom message-forward-as-mime t
562   "*Non-nil means forward messages as an inline/rfc822 MIME section.
563 Otherwise, directly inline the old message in the forwarded message."
564   :version "21.1"
565   :group 'message-forwarding
566   :link '(custom-manual "(message)Forwarding")
567   :type 'boolean)
568
569 (defcustom message-forward-show-mml 'best
570   "*Non-nil means show forwarded messages as MML (decoded from MIME).
571 Otherwise, forwarded messages are unchanged.
572 Can also be the symbol `best' to indicate that MML should be
573 used, except when it is a bad idea to use MML.  One example where
574 it is a bad idea is when forwarding a signed or encrypted
575 message, because converting MIME to MML would invalidate the
576 digital signature."
577   :version "21.1"
578   :group 'message-forwarding
579   :type '(choice (const :tag "use MML" t)
580                  (const :tag "don't use MML " nil)
581                  (const :tag "use MML when appropriate" best)))
582
583 (defcustom message-forward-before-signature t
584   "*Non-nil means put forwarded message before signature, else after."
585   :group 'message-forwarding
586   :type 'boolean)
587
588 (defcustom message-wash-forwarded-subjects nil
589   "*Non-nil means try to remove as much cruft as possible from the subject.
590 Done before generating the new subject of a forward."
591   :group 'message-forwarding
592   :link '(custom-manual "(message)Forwarding")
593   :type 'boolean)
594
595 (defcustom message-ignored-resent-headers
596   ;; `Delivered-To' needs to be removed because some mailers use it to
597   ;; detect loops, so if you resend a message to an address that ultimately
598   ;; comes back to you (e.g. a mailing-list to which you subscribe, in which
599   ;; case you may be removed from the list on the grounds that mail to you
600   ;; bounced with a "mailing loop" error).
601   "^Return-receipt\\|^X-Gnus\\|^Gnus-Warning:\\|^>?From \\|^Delivered-To:\
602 \\|^X-Content-Length:\\|^X-UIDL:"
603   "*All headers that match this regexp will be deleted when resending a message."
604   :version "24.4"
605   :group 'message-interface
606   :link '(custom-manual "(message)Resending")
607   :type '(repeat :value-to-internal (lambda (widget value)
608                                       (custom-split-regexp-maybe value))
609                  :match (lambda (widget value)
610                           (or (stringp value)
611                               (widget-editable-list-match widget value)))
612                  regexp))
613
614 (defcustom message-forward-ignored-headers "^Content-Transfer-Encoding:\\|^X-Gnus"
615   "*All headers that match this regexp will be deleted when forwarding a message.
616 This may also be a list of regexps."
617   :version "21.1"
618   :group 'message-forwarding
619   :type '(repeat :value-to-internal (lambda (widget value)
620                                       (custom-split-regexp-maybe value))
621                  :match (lambda (widget value)
622                           (or (stringp value)
623                               (widget-editable-list-match widget value)))
624                  regexp))
625
626 (defcustom message-forward-included-headers nil
627   "If non-nil, delete non-matching headers when forwarding a message.
628 Only headers that match this regexp will be included.  This
629 variable should be a regexp or a list of regexps."
630   :version "25.1"
631   :group 'message-forwarding
632   :type '(repeat :value-to-internal (lambda (widget value)
633                                       (custom-split-regexp-maybe value))
634                  :match (lambda (widget value)
635                           (or (stringp value)
636                               (widget-editable-list-match widget value)))
637                  regexp))
638
639 (defcustom message-ignored-cited-headers "."
640   "*Delete these headers from the messages you yank."
641   :group 'message-insertion
642   :link '(custom-manual "(message)Insertion Variables")
643   :type 'regexp)
644
645 (defcustom message-cite-prefix-regexp
646   ;; In Emacs 24.1 this defaults to the value of
647   ;; `mail-citation-prefix-regexp'; the default value varies according
648   ;; to the Emacs version.  In XEmacs 21.4 and 21.5, sendmail.el
649   ;; provides it.
650   (if (string-match "[[:digit:]]" "1")
651       ;; Support POSIX?  XEmacs 21.5.27 doesn't.
652       "\\([ \t]*[_.[:word:]]+>+\\|[ \t]*[]>|]\\)+"
653     ;; ?-, ?_ or ?. MUST NOT be in syntax entry w.
654     (let (non-word-constituents)
655       (with-syntax-table text-mode-syntax-table
656         (setq non-word-constituents
657               (concat
658                (if (string-match "\\w" "_")  "" "_")
659                (if (string-match "\\w" ".")  "" "."))))
660       (if (equal non-word-constituents "")
661           "\\([ \t]*\\(\\w\\)+>+\\|[ \t]*[]>|]\\)+"
662         (concat "\\([ \t]*\\(\\w\\|["
663                 non-word-constituents
664                 "]\\)+>+\\|[ \t]*[]>|]\\)+"))))
665   "*Regexp matching the longest possible citation prefix on a line."
666   :version "24.1"
667   :group 'message-insertion
668   :link '(custom-manual "(message)Insertion Variables")
669   :type 'regexp
670   :set (lambda (symbol value)
671          (prog1
672              (custom-set-default symbol value)
673            (if (boundp 'gnus-message-cite-prefix-regexp)
674                (setq gnus-message-cite-prefix-regexp
675                      (concat "^\\(?:" value "\\)"))))))
676
677 (defcustom message-cancel-message "I am canceling my own article.\n"
678   "Message to be inserted in the cancel message."
679   :group 'message-interface
680   :link '(custom-manual "(message)Canceling News")
681   :type 'string)
682
683 (defun message-send-mail-function ()
684   "Return suitable value for the variable `message-send-mail-function'."
685   (cond ((and (require 'sendmail)
686               (boundp 'sendmail-program)
687               sendmail-program
688               (executable-find sendmail-program))
689          'message-send-mail-with-sendmail)
690         ((and (locate-library "smtpmail")
691               (boundp 'smtpmail-default-smtp-server)
692               smtpmail-default-smtp-server)
693          'message-smtpmail-send-it)
694         ((locate-library "mailclient")
695          'message-send-mail-with-mailclient)
696         (t
697          (error "Don't know how to send mail.  Please customize `message-send-mail-function'"))))
698
699 (defun message-default-send-mail-function ()
700   (cond ((eq send-mail-function 'smtpmail-send-it) 'message-smtpmail-send-it)
701         ((eq send-mail-function 'feedmail-send-it) 'feedmail-send-it)
702         ((eq send-mail-function 'sendmail-query-once) 'sendmail-query-once)
703         ((eq send-mail-function 'mailclient-send-it)
704          'message-send-mail-with-mailclient)
705         (t (message-send-mail-function))))
706
707 ;; Useful to set in site-init.el
708 (defcustom message-send-mail-function (message-default-send-mail-function)
709   "Function to call to send the current buffer as mail.
710 The headers should be delimited by a line whose contents match the
711 variable `mail-header-separator'.
712
713 Valid values include `message-send-mail-with-sendmail'
714 `message-send-mail-with-mh', `message-send-mail-with-qmail',
715 `message-smtpmail-send-it', `smtpmail-send-it',
716 `feedmail-send-it' and `message-send-mail-with-mailclient'.  The
717 default is system dependent and determined by the function
718 `message-send-mail-function'.
719
720 See also `send-mail-function'."
721   :type '(radio (function-item message-send-mail-with-sendmail)
722                 (function-item message-send-mail-with-mh)
723                 (function-item message-send-mail-with-qmail)
724                 (function-item message-smtpmail-send-it)
725                 (function-item smtpmail-send-it)
726                 (function-item feedmail-send-it)
727                 (function-item message-send-mail-with-mailclient
728                                :tag "Use Mailclient package")
729                 (function :tag "Other"))
730   :group 'message-sending
731   :version "23.2"
732   :initialize 'custom-initialize-default
733   :link '(custom-manual "(message)Mail Variables")
734   :group 'message-mail)
735
736 (defcustom message-send-news-function 'message-send-news
737   "Function to call to send the current buffer as news.
738 The headers should be delimited by a line whose contents match the
739 variable `mail-header-separator'."
740   :group 'message-sending
741   :group 'message-news
742   :link '(custom-manual "(message)News Variables")
743   :type 'function)
744
745 (defcustom message-reply-to-function nil
746   "If non-nil, function that should return a list of headers.
747 This function should pick out addresses from the To, Cc, and From headers
748 and respond with new To and Cc headers."
749   :group 'message-interface
750   :link '(custom-manual "(message)Reply")
751   :type '(choice function (const nil)))
752
753 (defcustom message-wide-reply-to-function nil
754   "If non-nil, function that should return a list of headers.
755 This function should pick out addresses from the To, Cc, and From headers
756 and respond with new To and Cc headers."
757   :group 'message-interface
758   :link '(custom-manual "(message)Wide Reply")
759   :type '(choice function (const nil)))
760
761 (defcustom message-followup-to-function nil
762   "If non-nil, function that should return a list of headers.
763 This function should pick out addresses from the To, Cc, and From headers
764 and respond with new To and Cc headers."
765   :group 'message-interface
766   :link '(custom-manual "(message)Followup")
767   :type '(choice function (const nil)))
768
769 (defcustom message-extra-wide-headers nil
770   "If non-nil, a list of additional address headers.
771 These are used when composing a wide reply."
772   :group 'message-sending
773   :type '(repeat string))
774
775 (defcustom message-use-followup-to 'ask
776   "*Specifies what to do with Followup-To header.
777 If nil, always ignore the header.  If it is t, use its value, but
778 query before using the \"poster\" value.  If it is the symbol `ask',
779 always query the user whether to use the value.  If it is the symbol
780 `use', always use the value."
781   :group 'message-interface
782   :link '(custom-manual "(message)Followup")
783   :type '(choice (const :tag "ignore" nil)
784                  (const :tag "use & query" t)
785                  (const use)
786                  (const ask)))
787
788 (defcustom message-use-mail-followup-to 'use
789   "*Specifies what to do with Mail-Followup-To header.
790 If nil, always ignore the header.  If it is the symbol `ask', always
791 query the user whether to use the value.  If it is the symbol `use',
792 always use the value."
793   :version "22.1"
794   :group 'message-interface
795   :link '(custom-manual "(message)Mailing Lists")
796   :type '(choice (const :tag "ignore" nil)
797                  (const use)
798                  (const ask)))
799
800 (defcustom message-subscribed-address-functions nil
801   "*Specifies functions for determining list subscription.
802 If nil, do not attempt to determine list subscription with functions.
803 If non-nil, this variable contains a list of functions which return
804 regular expressions to match lists.  These functions can be used in
805 conjunction with `message-subscribed-regexps' and
806 `message-subscribed-addresses'."
807   :version "22.1"
808   :group 'message-interface
809   :link '(custom-manual "(message)Mailing Lists")
810   :type '(repeat sexp))
811
812 (defcustom message-subscribed-address-file nil
813   "*A file containing addresses the user is subscribed to.
814 If nil, do not look at any files to determine list subscriptions.  If
815 non-nil, each line of this file should be a mailing list address."
816   :version "22.1"
817   :group 'message-interface
818   :link '(custom-manual "(message)Mailing Lists")
819   :type '(radio file (const nil)))
820
821 (defcustom message-subscribed-addresses nil
822   "*Specifies a list of addresses the user is subscribed to.
823 If nil, do not use any predefined list subscriptions.  This list of
824 addresses can be used in conjunction with
825 `message-subscribed-address-functions' and `message-subscribed-regexps'."
826   :version "22.1"
827   :group 'message-interface
828   :link '(custom-manual "(message)Mailing Lists")
829   :type '(repeat string))
830
831 (defcustom message-subscribed-regexps nil
832   "*Specifies a list of addresses the user is subscribed to.
833 If nil, do not use any predefined list subscriptions.  This list of
834 regular expressions can be used in conjunction with
835 `message-subscribed-address-functions' and `message-subscribed-addresses'."
836   :version "22.1"
837   :group 'message-interface
838   :link '(custom-manual "(message)Mailing Lists")
839   :type '(repeat regexp))
840
841 (defcustom message-allow-no-recipients 'ask
842   "Specifies what to do when there are no recipients other than Gcc/Fcc.
843 If it is the symbol `always', the posting is allowed.  If it is the
844 symbol `never', the posting is not allowed.  If it is the symbol
845 `ask', you are prompted."
846   :version "22.1"
847   :group 'message-interface
848   :link '(custom-manual "(message)Message Headers")
849   :type '(choice (const always)
850                  (const never)
851                  (const ask)))
852
853 (defcustom message-sendmail-f-is-evil nil
854   "*Non-nil means don't add \"-f username\" to the sendmail command line.
855 Doing so would be even more evil than leaving it out."
856   :group 'message-sending
857   :link '(custom-manual "(message)Mail Variables")
858   :type 'boolean)
859
860 (defcustom message-sendmail-envelope-from nil
861   ;; In Emacs 24.1 this defaults to the value of `mail-envelope-from'
862   ;; if it is available, or defaults to nil.  sendmail.el provides it;
863   ;; the default value is nil in all (X)Emacsen that Gnus supports.
864   "*Envelope-from when sending mail with sendmail.
865 If this is nil, use `user-mail-address'.  If it is the symbol
866 `header', use the From: header of the message."
867   :version "23.2"
868   :type '(choice (string :tag "From name")
869                  (const :tag "Use From: header from message" header)
870                  (const :tag "Use `user-mail-address'" nil))
871   :link '(custom-manual "(message)Mail Variables")
872   :group 'message-sending)
873
874 (defcustom message-sendmail-extra-arguments nil
875   "Additional arguments to `sendmail-program'."
876   ;; E.g. '("-a" "account") for msmtp
877   :version "23.1" ;; No Gnus
878   :type '(repeat string)
879   ;; :link '(custom-manual "(message)Mail Variables")
880   :group 'message-sending)
881
882 ;; qmail-related stuff
883 (defcustom message-qmail-inject-program "/var/qmail/bin/qmail-inject"
884   "Location of the qmail-inject program."
885   :group 'message-sending
886   :link '(custom-manual "(message)Mail Variables")
887   :type 'file)
888
889 (defcustom message-qmail-inject-args nil
890   "Arguments passed to qmail-inject programs.
891 This should be a list of strings, one string for each argument.
892 It may also be a function.
893
894 For e.g., if you wish to set the envelope sender address so that bounces
895 go to the right place or to deal with listserv's usage of that address, you
896 might set this variable to '(\"-f\" \"you@some.where\")."
897   :group 'message-sending
898   :link '(custom-manual "(message)Mail Variables")
899   :type '(choice (function)
900                  (repeat string)))
901
902 (defvar gnus-post-method)
903 (defvar gnus-select-method)
904 (defcustom message-post-method
905   (cond ((and (boundp 'gnus-post-method)
906               (listp gnus-post-method)
907               gnus-post-method)
908          gnus-post-method)
909         ((boundp 'gnus-select-method)
910          gnus-select-method)
911         (t '(nnspool "")))
912   "*Method used to post news.
913 Note that when posting from inside Gnus, for instance, this
914 variable isn't used."
915   :group 'message-news
916   :group 'message-sending
917   ;; This should be the `gnus-select-method' widget, but that might
918   ;; create a dependence to `gnus.el'.
919   :type 'sexp)
920
921 (defcustom message-generate-headers-first nil
922   "Which headers should be generated before starting to compose a message.
923 If t, generate all required headers.  This can also be a list of headers to
924 generate.  The variables `message-required-news-headers' and
925 `message-required-mail-headers' specify which headers to generate.
926
927 Note that the variable `message-deletable-headers' specifies headers which
928 are to be deleted and then re-generated before sending, so this variable
929 will not have a visible effect for those headers."
930   :group 'message-headers
931   :link '(custom-manual "(message)Message Headers")
932   :type '(choice (const :tag "None" nil)
933                  (const :tag "All" t)
934                  (repeat (sexp :tag "Header"))))
935
936 (defcustom message-fill-column 72
937   "Column beyond which automatic line-wrapping should happen.
938 Local value for message buffers.  If non-nil, also turn on
939 auto-fill in message buffers."
940   :group 'message-various
941   ;; :link '(custom-manual "(message)Message Headers")
942   :type '(choice (const :tag "Don't turn on auto fill" nil)
943                  (integer)))
944
945 (defcustom message-setup-hook nil
946   "Normal hook, run each time a new outgoing message is initialized.
947 The function `message-setup' runs this hook."
948   :group 'message-various
949   :link '(custom-manual "(message)Various Message Variables")
950   :type 'hook)
951
952 (defcustom message-cancel-hook nil
953   "Hook run when canceling articles."
954   :group 'message-various
955   :link '(custom-manual "(message)Various Message Variables")
956   :type 'hook)
957
958 (defcustom message-signature-setup-hook nil
959   "Normal hook, run each time a new outgoing message is initialized.
960 It is run after the headers have been inserted and before
961 the signature is inserted."
962   :group 'message-various
963   :link '(custom-manual "(message)Various Message Variables")
964   :type 'hook)
965
966 (defcustom message-mode-hook nil
967   "Hook run in message mode buffers."
968   :group 'message-various
969   :type 'hook)
970
971 (defcustom message-header-hook nil
972   "Hook run in a message mode buffer narrowed to the headers."
973   :group 'message-various
974   :type 'hook)
975
976 (defcustom message-header-setup-hook nil
977   "Hook called narrowed to the headers when setting up a message buffer."
978   :group 'message-various
979   :link '(custom-manual "(message)Various Message Variables")
980   :type 'hook)
981
982 (defcustom message-minibuffer-local-map
983   (let ((map (make-sparse-keymap 'message-minibuffer-local-map)))
984     (set-keymap-parent map minibuffer-local-map)
985     map)
986   "Keymap for `message-read-from-minibuffer'."
987   ;; FIXME improve type.
988   :type '(restricted-sexp :match-alternatives (symbolp keymapp))
989   :version "22.1"
990   :group 'message-various)
991
992 (defcustom message-citation-line-function 'message-insert-citation-line
993   "*Function called to insert the \"Whomever writes:\" line.
994
995 Predefined functions include `message-insert-citation-line' and
996 `message-insert-formatted-citation-line' (see the variable
997 `message-citation-line-format').
998
999 Note that Gnus provides a feature where the reader can click on
1000 `writes:' to hide the cited text.  If you change this line too much,
1001 people who read your message will have to change their Gnus
1002 configuration.  See the variable `gnus-cite-attribution-suffix'."
1003   :type '(choice
1004           (function-item :tag "plain" message-insert-citation-line)
1005           (function-item :tag "formatted" message-insert-formatted-citation-line)
1006           (function :tag "Other"))
1007   :link '(custom-manual "(message)Insertion Variables")
1008   :group 'message-insertion)
1009
1010 (defcustom message-citation-line-format "On %a, %b %d %Y, %N wrote:\n"
1011   "Format of the \"Whomever writes:\" line.
1012
1013 The string is formatted using `format-spec'.  The following constructs
1014 are replaced:
1015
1016   %f   The full From, e.g. \"John Doe <john.doe@example.invalid>\".
1017   %n   The mail address, e.g. \"john.doe@example.invalid\".
1018   %N   The real name if present, e.g.: \"John Doe\", else fall
1019        back to the mail address.
1020   %F   The first name if present, e.g.: \"John\".
1021   %L   The last name if present, e.g.: \"Doe\".
1022   %Z, %z   The time zone in the numeric form, e.g.:\"+0000\".
1023
1024 All other format specifiers are passed to `format-time-string'
1025 which is called using the date from the article your replying to, but
1026 the date in the formatted string will be expressed in the author's
1027 time zone as much as possible.
1028 Extracting the first (%F) and last name (%L) is done heuristically,
1029 so you should always check it yourself.
1030
1031 Please also read the note in the documentation of
1032 `message-citation-line-function'."
1033   :type '(choice (const :tag "Plain" "%f writes:")
1034                  (const :tag "Include date" "On %a, %b %d %Y, %n wrote:")
1035                  string)
1036   :link '(custom-manual "(message)Insertion Variables")
1037   :version "23.1" ;; No Gnus
1038   :group 'message-insertion)
1039
1040 (defcustom message-yank-prefix "> "
1041   ;; In Emacs 24.1 this defaults to the value of `mail-yank-prefix'
1042   ;; that defaults to:
1043   ;; `nil' in Emacs 22.1~23.1;
1044   ;; "> " in Emacs 23.2, 24.1, XEmacs 21.4, 21.5, and SXEmacs 22.1
1045   "*Prefix inserted on the lines of yanked messages.
1046 Fix `message-cite-prefix-regexp' if it is set to an abnormal value.
1047 See also `message-yank-cited-prefix' and `message-yank-empty-prefix'."
1048   :version "23.2"
1049   :type 'string
1050   :link '(custom-manual "(message)Insertion Variables")
1051   :group 'message-insertion)
1052
1053 (defcustom message-yank-cited-prefix ">"
1054   "*Prefix inserted on cited lines of yanked messages.
1055 Fix `message-cite-prefix-regexp' if it is set to an abnormal value.
1056 See also `message-yank-prefix' and `message-yank-empty-prefix'."
1057   :version "22.1"
1058   :type 'string
1059   :link '(custom-manual "(message)Insertion Variables")
1060   :group 'message-insertion)
1061
1062 (defcustom message-yank-empty-prefix ">"
1063   "*Prefix inserted on empty lines of yanked messages.
1064 See also `message-yank-prefix' and `message-yank-cited-prefix'."
1065   :version "22.1"
1066   :type 'string
1067   :link '(custom-manual "(message)Insertion Variables")
1068   :group 'message-insertion)
1069
1070 (defcustom message-indentation-spaces 3
1071   ;; In Emacs 24.1 this defaults to the value of
1072   ;; `mail-indentation-spaces' that defaults to `3' in Emacs 22.1~24.1,
1073   ;; and SXEmacs 22.1.  In XEmacs 21.4 and 21.5, sendmail.el provides
1074   ;; it; the defalut value is `3'.
1075   "*Number of spaces to insert at the beginning of each cited line.
1076 Used by `message-yank-original' via `message-yank-cite'."
1077   :version "23.2"
1078   :group 'message-insertion
1079   :link '(custom-manual "(message)Insertion Variables")
1080   :type 'integer)
1081
1082 (defcustom message-cite-function 'message-cite-original-without-signature
1083   "*Function for citing an original message.
1084 Predefined functions include `message-cite-original' and
1085 `message-cite-original-without-signature'.
1086 Note that these functions use `mail-citation-hook' if that is non-nil."
1087   :type '(radio (function-item message-cite-original)
1088                 (function-item message-cite-original-without-signature)
1089                 (function-item sc-cite-original)
1090                 (function :tag "Other"))
1091   :link '(custom-manual "(message)Insertion Variables")
1092   :version "22.3" ;; Gnus 5.10.12 (changed default)
1093   :group 'message-insertion)
1094
1095 (defcustom message-indent-citation-function 'message-indent-citation
1096   "*Function for modifying a citation just inserted in the mail buffer.
1097 This can also be a list of functions.  Each function can find the
1098 citation between (point) and (mark t).  And each function should leave
1099 point and mark around the citation text as modified."
1100   :type 'function
1101   :link '(custom-manual "(message)Insertion Variables")
1102   :group 'message-insertion)
1103
1104 (defcustom message-signature t
1105   ;; In Emacs 24.1 this defaults to the value of `mail-signature' that
1106   ;; defaults to:
1107   ;; `nil' in Emacs 22.1~23.1, XEmacs 21.4, 21.5, and SXEmacs 22.1;
1108   ;; `t' in Emacs 23.2, and 24.1
1109   "*String to be inserted at the end of the message buffer.
1110 If t, the `message-signature-file' file will be inserted instead.
1111 If a function, the result from the function will be used instead.
1112 If a form, the result from the form will be used instead."
1113   :version "23.2"
1114   :type 'sexp
1115   :link '(custom-manual "(message)Insertion Variables")
1116   :group 'message-insertion)
1117
1118 (defcustom message-signature-file "~/.signature"
1119   ;; In Emacs 24.1 this defaults to the value of `mail-signature-file'
1120   ;; that defaults to "~/.signature" in Emacs 22.1~24.1, and SXEmacs
1121   ;; 22.1.  In XEmacs 21.4 and 21.5, sendmail.el provides it;
1122   ;; the defalut value is "~/.signature".
1123   "*Name of file containing the text inserted at end of message buffer.
1124 Ignored if the named file doesn't exist.
1125 If nil, don't insert a signature.
1126 If a path is specified, the value of `message-signature-directory' is ignored,
1127 even if set."
1128   :version "23.2"
1129   :type '(choice file (const :tags "None" nil))
1130   :link '(custom-manual "(message)Insertion Variables")
1131   :group 'message-insertion)
1132
1133 (defcustom message-signature-directory nil
1134   "*Name of directory containing signature files.
1135 Comes in handy if you have many such files, handled via posting styles for
1136 instance.
1137 If nil, `message-signature-file' is expected to specify the directory if
1138 needed."
1139   :type '(choice string (const :tags "None" nil))
1140   :link '(custom-manual "(message)Insertion Variables")
1141   :group 'message-insertion)
1142
1143 (defcustom message-signature-insert-empty-line t
1144   "*If non-nil, insert an empty line before the signature separator."
1145   :version "22.1"
1146   :type 'boolean
1147   :link '(custom-manual "(message)Insertion Variables")
1148   :group 'message-insertion)
1149
1150 (defcustom message-cite-reply-position 'traditional
1151   "*Where the reply should be positioned.
1152 If `traditional', reply inline.
1153 If `above', reply above quoted text.
1154 If `below', reply below quoted text.
1155
1156 Note: Many newsgroups frown upon nontraditional reply styles. You
1157 probably want to set this variable only for specific groups,
1158 e.g. using `gnus-posting-styles':
1159
1160   (eval (set (make-local-variable 'message-cite-reply-position) 'above))"
1161   :version "24.1"
1162   :type '(choice (const :tag "Reply inline" traditional)
1163                  (const :tag "Reply above" above)
1164                  (const :tag "Reply below" below))
1165   :group 'message-insertion)
1166
1167 (defcustom message-cite-style nil
1168   "*The overall style to be used when yanking cited text.
1169 Value is either `nil' (no variable overrides) or a let-style list
1170 of pairs (VARIABLE VALUE) that will be bound in
1171 `message-yank-original' to do the quoting.
1172
1173 Presets to impersonate popular mail agents are found in the
1174 message-cite-style-* variables.  This variable is intended for
1175 use in `gnus-posting-styles', such as:
1176
1177   ((posting-from-work-p) (eval (set (make-local-variable 'message-cite-style) message-cite-style-outlook)))"
1178   :version "24.1"
1179   :group 'message-insertion
1180   :type '(choice (const :tag "Do not override variables" :value nil)
1181                  (const :tag "MS Outlook" :value message-cite-style-outlook)
1182                  (const :tag "Mozilla Thunderbird" :value message-cite-style-thunderbird)
1183                  (const :tag "Gmail" :value message-cite-style-gmail)
1184                  (variable :tag "User-specified")))
1185
1186 (defconst message-cite-style-outlook
1187   '((message-cite-function  'message-cite-original)
1188     (message-citation-line-function  'message-insert-formatted-citation-line)
1189     (message-cite-reply-position 'above)
1190     (message-yank-prefix  "")
1191     (message-yank-cited-prefix  "")
1192     (message-yank-empty-prefix  "")
1193     (message-citation-line-format  "\n\n-----------------------\nOn %a, %b %d %Y, %N wrote:\n"))
1194   "Message citation style used by MS Outlook. Use with message-cite-style.")
1195
1196 (defconst message-cite-style-thunderbird
1197   '((message-cite-function  'message-cite-original)
1198     (message-citation-line-function  'message-insert-formatted-citation-line)
1199     (message-cite-reply-position 'above)
1200     (message-yank-prefix  "> ")
1201     (message-yank-cited-prefix  ">")
1202     (message-yank-empty-prefix  ">")
1203     (message-citation-line-format "On %D %R %p, %N wrote:"))
1204   "Message citation style used by Mozilla Thunderbird. Use with message-cite-style.")
1205
1206 (defconst message-cite-style-gmail
1207   '((message-cite-function  'message-cite-original)
1208     (message-citation-line-function  'message-insert-formatted-citation-line)
1209     (message-cite-reply-position 'above)
1210     (message-yank-prefix  "    ")
1211     (message-yank-cited-prefix  "    ")
1212     (message-yank-empty-prefix  "    ")
1213     (message-citation-line-format "On %e %B %Y %R, %f wrote:\n"))
1214   "Message citation style used by Gmail. Use with message-cite-style.")
1215
1216 (defcustom message-distribution-function nil
1217   "*Function called to return a Distribution header."
1218   :group 'message-news
1219   :group 'message-headers
1220   :link '(custom-manual "(message)News Headers")
1221   :type '(choice function (const nil)))
1222
1223 (defcustom message-expires 14
1224   "Number of days before your article expires."
1225   :group 'message-news
1226   :group 'message-headers
1227   :link '(custom-manual "(message)News Headers")
1228   :type 'integer)
1229
1230 (defcustom message-user-path nil
1231   "If nil, use the NNTP server name in the Path header.
1232 If stringp, use this; if non-nil, use no host name (user name only)."
1233   :group 'message-news
1234   :group 'message-headers
1235   :link '(custom-manual "(message)News Headers")
1236   :type '(choice (const :tag "nntp" nil)
1237                  (string :tag "name")
1238                  (sexp :tag "none" :format "%t" t)))
1239
1240 ;; This can be the name of a buffer, or a cons cell (FUNCTION . ARGS)
1241 ;; for yanking the original buffer.
1242 (defvar message-reply-buffer nil)
1243 (defvar message-reply-headers nil
1244   "The headers of the current replied article.
1245 It is a vector of the following headers:
1246 \[number subject from date id references chars lines xref extra].")
1247 (defvar message-newsreader nil)
1248 (defvar message-mailer nil)
1249 (defvar message-sent-message-via nil)
1250 (defvar message-checksum nil)
1251 (defvar message-send-actions nil
1252   "A list of actions to be performed upon successful sending of a message.")
1253 (defvar message-return-action nil
1254   "Action to return to the caller after sending or postponing a message.")
1255 (defvar message-exit-actions nil
1256   "A list of actions to be performed upon exiting after sending a message.")
1257 (defvar message-kill-actions nil
1258   "A list of actions to be performed before killing a message buffer.")
1259 (defvar message-postpone-actions nil
1260   "A list of actions to be performed after postponing a message.")
1261
1262 (define-widget 'message-header-lines 'text
1263   "All header lines must be LFD terminated."
1264   :format "%{%t%}:%n%v"
1265   :valid-regexp "^\\'"
1266   :error "All header lines must be newline terminated")
1267
1268 (defcustom message-default-headers ""
1269   "Header lines to be inserted in outgoing messages.
1270 This can be set to a string containing or a function returning
1271 header lines to be inserted before you edit the message, so you
1272 can edit or delete these lines.  If set to a function, it is
1273 called and its result is inserted."
1274   :version "23.2"
1275   :group 'message-headers
1276   :link '(custom-manual "(message)Message Headers")
1277   :type '(choice
1278           (message-header-lines :tag "String")
1279           (function :tag "Function")))
1280
1281 (defcustom message-default-mail-headers
1282   ;; Ease the transition from mail-mode to message-mode.  See bugs#4431, 5555.
1283   (concat (if (and (boundp 'mail-default-reply-to)
1284                    (stringp mail-default-reply-to))
1285               (format "Reply-to: %s\n" mail-default-reply-to))
1286           (if (and (boundp 'mail-self-blind)
1287                    mail-self-blind)
1288               (format "BCC: %s\n" user-mail-address))
1289           (if (and (boundp 'mail-archive-file-name)
1290                    (stringp mail-archive-file-name))
1291               (format "FCC: %s\n" mail-archive-file-name))
1292           ;; Use the value of `mail-default-headers' if available.
1293           ;; Note: as for XEmacs 21.4 and 21.5, it is unavailable
1294           ;; unless sendmail.el is loaded.
1295           (if (boundp 'mail-default-headers)
1296               mail-default-headers))
1297   "*A string of header lines to be inserted in outgoing mails."
1298   :version "23.2"
1299   :group 'message-headers
1300   :group 'message-mail
1301   :link '(custom-manual "(message)Mail Headers")
1302   :type 'message-header-lines)
1303
1304 (defcustom message-default-news-headers ""
1305   "*A string of header lines to be inserted in outgoing news articles."
1306   :group 'message-headers
1307   :group 'message-news
1308   :link '(custom-manual "(message)News Headers")
1309   :type 'message-header-lines)
1310
1311 ;; Note: could use /usr/ucb/mail instead of sendmail;
1312 ;; options -t, and -v if not interactive.
1313 (defcustom message-mailer-swallows-blank-line
1314   (if (and (string-match "sparc-sun-sunos\\(\\'\\|[^5]\\)"
1315                          system-configuration)
1316            (file-readable-p "/etc/sendmail.cf")
1317            (with-temp-buffer
1318              (insert-file-contents "/etc/sendmail.cf")
1319              (goto-char (point-min))
1320              (let ((case-fold-search nil))
1321                (re-search-forward "^OR\\>" nil t))))
1322       ;; According to RFC822, "The field-name must be composed of printable
1323       ;; ASCII characters (i. e., characters that have decimal values between
1324       ;; 33 and 126, except colon)", i. e., any chars except ctl chars,
1325       ;; space, or colon.
1326       '(looking-at "[ \t]\\|[][!\"#$%&'()*+,-./0-9;<=>?@A-Z\\\\^_`a-z{|}~]+:"))
1327   "*Set this non-nil if the system's mailer runs the header and body together.
1328 \(This problem exists on Sunos 4 when sendmail is run in remote mode.)
1329 The value should be an expression to test whether the problem will
1330 actually occur."
1331   :group 'message-sending
1332   :link '(custom-manual "(message)Mail Variables")
1333   :type 'sexp)
1334
1335 ;;;###autoload
1336 (define-mail-user-agent 'message-user-agent
1337   'message-mail 'message-send-and-exit
1338   'message-kill-buffer 'message-send-hook)
1339
1340 (defvar message-mh-deletable-headers '(Message-ID Date Lines Sender)
1341   "If non-nil, delete the deletable headers before feeding to mh.")
1342
1343 (defvar message-send-method-alist
1344   '((news message-news-p message-send-via-news)
1345     (mail message-mail-p message-send-via-mail))
1346   "Alist of ways to send outgoing messages.
1347 Each element has the form
1348
1349   \(TYPE PREDICATE FUNCTION)
1350
1351 where TYPE is a symbol that names the method; PREDICATE is a function
1352 called without any parameters to determine whether the message is
1353 a message of type TYPE; and FUNCTION is a function to be called if
1354 PREDICATE returns non-nil.  FUNCTION is called with one parameter --
1355 the prefix.")
1356
1357 (defcustom message-mail-alias-type 'abbrev
1358   "*What alias expansion type to use in Message buffers.
1359 The default is `abbrev', which uses mailabbrev.  `ecomplete' uses
1360 an electric completion mode.  nil switches mail aliases off.
1361 This can also be a list of values."
1362   :group 'message
1363   :link '(custom-manual "(message)Mail Aliases")
1364   :type '(choice (const :tag "Use Mailabbrev" abbrev)
1365                  (const :tag "Use ecomplete" ecomplete)
1366                  (const :tag "No expansion" nil)))
1367
1368 (defcustom message-self-insert-commands '(self-insert-command)
1369   "List of `self-insert-command's used to trigger ecomplete.
1370 When one of those commands is invoked to enter a character in To or Cc
1371 header, ecomplete will suggest the candidates of recipients (see also
1372 `message-mail-alias-type').  If you use some tool to enter non-ASCII
1373 text and it replaces `self-insert-command' with the other command, e.g.
1374 `egg-self-insert-command', you may want to add it to this list."
1375   :group 'message-various
1376   :type '(repeat function))
1377
1378 (defcustom message-auto-save-directory
1379   (if (file-writable-p message-directory)
1380       (file-name-as-directory (expand-file-name "drafts" message-directory))
1381     "~/")
1382   "*Directory where Message auto-saves buffers if Gnus isn't running.
1383 If nil, Message won't auto-save."
1384   :group 'message-buffers
1385   :link '(custom-manual "(message)Various Message Variables")
1386   :type '(choice directory (const :tag "Don't auto-save" nil)))
1387
1388 (defcustom message-default-charset
1389   (and (not (mm-multibyte-p)) 'iso-8859-1)
1390   "Default charset used in non-MULE Emacsen.
1391 If nil, you might be asked to input the charset."
1392   :version "21.1"
1393   :group 'message
1394   :link '(custom-manual "(message)Various Message Variables")
1395   :type 'symbol)
1396
1397 (defcustom message-dont-reply-to-names
1398   (and (boundp 'mail-dont-reply-to-names) mail-dont-reply-to-names)
1399   "*Addresses to prune when doing wide replies.
1400 This can be a regexp or a list of regexps.  Also, a value of nil means
1401 exclude your own user name only."
1402   :version "24.3"
1403   :group 'message
1404   :link '(custom-manual "(message)Wide Reply")
1405   :type '(choice (const :tag "Yourself" nil)
1406                  regexp
1407                  (repeat :tag "Regexp List" regexp)))
1408
1409 (defsubst message-dont-reply-to-names ()
1410   (gmm-regexp-concat message-dont-reply-to-names))
1411
1412 (defvar message-shoot-gnksa-feet nil
1413   "*A list of GNKSA feet you are allowed to shoot.
1414 Gnus gives you all the opportunity you could possibly want for
1415 shooting yourself in the foot.  Also, Gnus allows you to shoot the
1416 feet of Good Net-Keeping Seal of Approval.  The following are foot
1417 candidates:
1418 `empty-article'     Allow you to post an empty article;
1419 `quoted-text-only'  Allow you to post quoted text only;
1420 `multiple-copies'   Allow you to post multiple copies;
1421 `cancel-messages'   Allow you to cancel or supersede messages from
1422                     your other email addresses;
1423 `canlock-verify'    Allow you to cancel messages without verifying canlock.")
1424
1425 (defsubst message-gnksa-enable-p (feature)
1426   (or (not (listp message-shoot-gnksa-feet))
1427       (memq feature message-shoot-gnksa-feet)))
1428
1429 (defcustom message-hidden-headers '("^References:" "^Face:" "^X-Face:"
1430                                     "^X-Draft-From:")
1431   "Regexp of headers to be hidden when composing new messages.
1432 This can also be a list of regexps to match headers.  Or a list
1433 starting with `not' and followed by regexps."
1434   :version "22.1"
1435   :group 'message
1436   :link '(custom-manual "(message)Message Headers")
1437   :type '(choice
1438           :format "%{%t%}: %[Value Type%] %v"
1439           (regexp :menu-tag "regexp" :format "regexp\n%t: %v")
1440           (repeat :menu-tag "(regexp ...)" :format "(regexp ...)\n%v%i"
1441                   (regexp :format "%t: %v"))
1442           (cons :menu-tag "(not regexp ...)" :format "(not regexp ...)\n%v"
1443                 (const not)
1444                 (repeat :format "%v%i"
1445                         (regexp :format "%t: %v")))))
1446
1447 (defcustom message-cite-articles-with-x-no-archive t
1448   "If non-nil, cite text from articles that has X-No-Archive set."
1449   :group 'message
1450   :type 'boolean)
1451
1452 ;;; Internal variables.
1453 ;;; Well, not really internal.
1454
1455 (defvar message-mode-syntax-table
1456   (let ((table (copy-syntax-table text-mode-syntax-table)))
1457     (modify-syntax-entry ?% ". " table)
1458     (modify-syntax-entry ?> ". " table)
1459     (modify-syntax-entry ?< ". " table)
1460     table)
1461   "Syntax table used while in Message mode.")
1462
1463 (defface message-header-to
1464   '((((class color)
1465       (background dark))
1466      (:foreground "DarkOliveGreen1" :bold t))
1467     (((class color)
1468       (background light))
1469      (:foreground "MidnightBlue" :bold t))
1470     (t
1471      (:bold t :italic t)))
1472   "Face used for displaying From headers."
1473   :group 'message-faces)
1474 ;; backward-compatibility alias
1475 (put 'message-header-to-face 'face-alias 'message-header-to)
1476 (put 'message-header-to-face 'obsolete-face "22.1")
1477
1478 (defface message-header-cc
1479   '((((class color)
1480       (background dark))
1481      (:foreground "chartreuse1" :bold t))
1482     (((class color)
1483       (background light))
1484      (:foreground "MidnightBlue"))
1485     (t
1486      (:bold t)))
1487   "Face used for displaying Cc headers."
1488   :group 'message-faces)
1489 ;; backward-compatibility alias
1490 (put 'message-header-cc-face 'face-alias 'message-header-cc)
1491 (put 'message-header-cc-face 'obsolete-face "22.1")
1492
1493 (defface message-header-subject
1494   '((((class color)
1495       (background dark))
1496      (:foreground "OliveDrab1"))
1497     (((class color)
1498       (background light))
1499      (:foreground "navy blue" :bold t))
1500     (t
1501      (:bold t)))
1502   "Face used for displaying subject headers."
1503   :group 'message-faces)
1504 ;; backward-compatibility alias
1505 (put 'message-header-subject-face 'face-alias 'message-header-subject)
1506 (put 'message-header-subject-face 'obsolete-face "22.1")
1507
1508 (defface message-header-newsgroups
1509   '((((class color)
1510       (background dark))
1511      (:foreground "yellow" :bold t :italic t))
1512     (((class color)
1513       (background light))
1514      (:foreground "blue4" :bold t :italic t))
1515     (t
1516      (:bold t :italic t)))
1517   "Face used for displaying newsgroups headers."
1518   :group 'message-faces)
1519 ;; backward-compatibility alias
1520 (put 'message-header-newsgroups-face 'face-alias 'message-header-newsgroups)
1521 (put 'message-header-newsgroups-face 'obsolete-face "22.1")
1522
1523 (defface message-header-other
1524   '((((class color)
1525       (background dark))
1526      (:foreground "VioletRed1"))
1527     (((class color)
1528       (background light))
1529      (:foreground "steel blue"))
1530     (t
1531      (:bold t :italic t)))
1532   "Face used for displaying newsgroups headers."
1533   :group 'message-faces)
1534 ;; backward-compatibility alias
1535 (put 'message-header-other-face 'face-alias 'message-header-other)
1536 (put 'message-header-other-face 'obsolete-face "22.1")
1537
1538 (defface message-header-name
1539   '((((class color)
1540       (background dark))
1541      (:foreground "green"))
1542     (((class color)
1543       (background light))
1544      (:foreground "cornflower blue"))
1545     (t
1546      (:bold t)))
1547   "Face used for displaying header names."
1548   :group 'message-faces)
1549 ;; backward-compatibility alias
1550 (put 'message-header-name-face 'face-alias 'message-header-name)
1551 (put 'message-header-name-face 'obsolete-face "22.1")
1552
1553 (defface message-header-xheader
1554   '((((class color)
1555       (background dark))
1556      (:foreground "DeepSkyBlue1"))
1557     (((class color)
1558       (background light))
1559      (:foreground "blue"))
1560     (t
1561      (:bold t)))
1562   "Face used for displaying X-Header headers."
1563   :group 'message-faces)
1564 ;; backward-compatibility alias
1565 (put 'message-header-xheader-face 'face-alias 'message-header-xheader)
1566 (put 'message-header-xheader-face 'obsolete-face "22.1")
1567
1568 (defface message-separator
1569   '((((class color)
1570       (background dark))
1571      (:foreground "LightSkyBlue1"))
1572     (((class color)
1573       (background light))
1574      (:foreground "brown"))
1575     (t
1576      (:bold t)))
1577   "Face used for displaying the separator."
1578   :group 'message-faces)
1579 ;; backward-compatibility alias
1580 (put 'message-separator-face 'face-alias 'message-separator)
1581 (put 'message-separator-face 'obsolete-face "22.1")
1582
1583 (defface message-cited-text
1584   '((((class color)
1585       (background dark))
1586      (:foreground "LightPink1"))
1587     (((class color)
1588       (background light))
1589      (:foreground "red"))
1590     (t
1591      (:bold t)))
1592   "Face used for displaying cited text names."
1593   :group 'message-faces)
1594 ;; backward-compatibility alias
1595 (put 'message-cited-text-face 'face-alias 'message-cited-text)
1596 (put 'message-cited-text-face 'obsolete-face "22.1")
1597
1598 (defface message-mml
1599   '((((class color)
1600       (background dark))
1601      (:foreground "MediumSpringGreen"))
1602     (((class color)
1603       (background light))
1604      (:foreground "ForestGreen"))
1605     (t
1606      (:bold t)))
1607   "Face used for displaying MML."
1608   :group 'message-faces)
1609 ;; backward-compatibility alias
1610 (put 'message-mml-face 'face-alias 'message-mml)
1611 (put 'message-mml-face 'obsolete-face "22.1")
1612
1613 (defun message-font-lock-make-header-matcher (regexp)
1614   (let ((form
1615          `(lambda (limit)
1616             (let ((start (point)))
1617               (save-restriction
1618                 (widen)
1619                 (goto-char (point-min))
1620                 (if (re-search-forward
1621                      (concat "^" (regexp-quote mail-header-separator) "$")
1622                      nil t)
1623                     (setq limit (min limit (match-beginning 0))))
1624                 (goto-char start))
1625               (and (< start limit)
1626                    (re-search-forward ,regexp limit t))))))
1627     (if (featurep 'bytecomp)
1628         (byte-compile form)
1629       form)))
1630
1631 (defvar message-font-lock-keywords
1632   (let ((content "[ \t]*\\(.+\\(\n[ \t].*\\)*\\)\n?"))
1633     `((,(message-font-lock-make-header-matcher
1634          (concat "^\\([Tt]o:\\)" content))
1635        (1 'message-header-name)
1636        (2 'message-header-to nil t))
1637       (,(message-font-lock-make-header-matcher
1638          (concat "^\\(^[GBF]?[Cc][Cc]:\\|^[Rr]eply-[Tt]o:\\)" content))
1639        (1 'message-header-name)
1640        (2 'message-header-cc nil t))
1641       (,(message-font-lock-make-header-matcher
1642          (concat "^\\([Ss]ubject:\\)" content))
1643        (1 'message-header-name)
1644        (2 'message-header-subject nil t))
1645       (,(message-font-lock-make-header-matcher
1646          (concat "^\\([Nn]ewsgroups:\\|Followup-[Tt]o:\\)" content))
1647        (1 'message-header-name)
1648        (2 'message-header-newsgroups nil t))
1649       (,(message-font-lock-make-header-matcher
1650          (concat "^\\(X-[A-Za-z0-9-]+:\\|In-Reply-To:\\)" content))
1651        (1 'message-header-name)
1652        (2 'message-header-xheader))
1653       (,(message-font-lock-make-header-matcher
1654          (concat "^\\([A-Z][^: \n\t]+:\\)" content))
1655        (1 'message-header-name)
1656        (2 'message-header-other nil t))
1657       ,@(if (and mail-header-separator
1658                  (not (equal mail-header-separator "")))
1659             `((,(concat "^\\(" (regexp-quote mail-header-separator) "\\)$")
1660                1 'message-separator))
1661           nil)
1662       ((lambda (limit)
1663          (re-search-forward (concat "^\\("
1664                                     message-cite-prefix-regexp
1665                                     "\\).*")
1666                             limit t))
1667        (0 'message-cited-text))
1668       ("<#/?\\(multipart\\|part\\|external\\|mml\\|secure\\)[^>]*>"
1669        (0 'message-mml))))
1670   "Additional expressions to highlight in Message mode.")
1671
1672
1673 ;; XEmacs does it like this.  For Emacs, we have to set the
1674 ;; `font-lock-defaults' buffer-local variable.
1675 (put 'message-mode 'font-lock-defaults '(message-font-lock-keywords t))
1676
1677 (defvar message-face-alist
1678   '((bold . message-bold-region)
1679     (underline . underline-region)
1680     (default . (lambda (b e)
1681                  (message-unbold-region b e)
1682                  (ununderline-region b e))))
1683   "Alist of mail and news faces for facemenu.
1684 The cdr of each entry is a function for applying the face to a region.")
1685
1686 (defcustom message-send-hook nil
1687   "Hook run before sending messages.
1688 This hook is run quite early when sending."
1689   :group 'message-various
1690   :options '(ispell-message)
1691   :link '(custom-manual "(message)Various Message Variables")
1692   :type 'hook)
1693
1694 (defcustom message-send-mail-hook nil
1695   "Hook run before sending mail messages.
1696 This hook is run very late -- just before the message is sent as
1697 mail."
1698   :group 'message-various
1699   :link '(custom-manual "(message)Various Message Variables")
1700   :type 'hook)
1701
1702 (defcustom message-send-news-hook nil
1703   "Hook run before sending news messages.
1704 This hook is run very late -- just before the message is sent as
1705 news."
1706   :group 'message-various
1707   :link '(custom-manual "(message)Various Message Variables")
1708   :type 'hook)
1709
1710 (defcustom message-sent-hook nil
1711   "Hook run after sending messages."
1712   :group 'message-various
1713   :type 'hook)
1714
1715 (defvar message-send-coding-system 'binary
1716   "Coding system to encode outgoing mail.")
1717
1718 (defvar message-draft-coding-system
1719   mm-auto-save-coding-system
1720   "*Coding system to compose mail.
1721 If you'd like to make it possible to share draft files between XEmacs
1722 and Emacs, you may use `iso-2022-7bit' for this value at your own risk.
1723 Note that the coding-system `iso-2022-7bit' isn't suitable to all data.")
1724
1725 (defcustom message-send-mail-partially-limit nil
1726   "The limitation of messages sent as message/partial.
1727 The lower bound of message size in characters, beyond which the message
1728 should be sent in several parts.  If it is nil, the size is unlimited."
1729   :version "24.1"
1730   :group 'message-buffers
1731   :link '(custom-manual "(message)Mail Variables")
1732   :type '(choice (const :tag "unlimited" nil)
1733                  (integer 1000000)))
1734
1735 (defcustom message-alternative-emails nil
1736   "*Regexp matching alternative email addresses.
1737 The first address in the To, Cc or From headers of the original
1738 article matching this variable is used as the From field of
1739 outgoing messages.
1740
1741 This variable has precedence over posting styles and anything that runs
1742 off `message-setup-hook'."
1743   :group 'message-headers
1744   :link '(custom-manual "(message)Message Headers")
1745   :type '(choice (const :tag "Always use primary" nil)
1746                  regexp))
1747
1748 (defcustom message-hierarchical-addresses nil
1749   "A list of hierarchical mail address definitions.
1750
1751 Inside each entry, the first address is the \"top\" address, and
1752 subsequent addresses are subaddresses; this is used to indicate that
1753 mail sent to the first address will automatically be delivered to the
1754 subaddresses.  So if the first address appears in the recipient list
1755 for a message, the subaddresses will be removed (if present) before
1756 the mail is sent.  All addresses in this structure should be
1757 downcased."
1758   :version "22.1"
1759   :group 'message-headers
1760   :type '(repeat (repeat string)))
1761
1762 (defcustom message-mail-user-agent nil
1763   "Like `mail-user-agent'.
1764 Except if it is nil, use Gnus native MUA; if it is t, use
1765 `mail-user-agent'."
1766   :version "22.1"
1767   :type '(radio (const :tag "Gnus native"
1768                        :format "%t\n"
1769                        nil)
1770                 (const :tag "`mail-user-agent'"
1771                        :format "%t\n"
1772                        t)
1773                 (function-item :tag "Default Emacs mail"
1774                                :format "%t\n"
1775                                sendmail-user-agent)
1776                 (function-item :tag "Emacs interface to MH"
1777                                :format "%t\n"
1778                                mh-e-user-agent)
1779                 (function :tag "Other"))
1780   :version "21.1"
1781   :group 'message)
1782
1783 (defcustom message-wide-reply-confirm-recipients nil
1784   "Whether to confirm a wide reply to multiple email recipients.
1785 If this variable is nil, don't ask whether to reply to all recipients.
1786 If this variable is non-nil, pose the question \"Reply to all
1787 recipients?\" before a wide reply to multiple recipients.  If the user
1788 answers yes, reply to all recipients as usual.  If the user answers
1789 no, only reply back to the author."
1790   :version "22.1"
1791   :group 'message-headers
1792   :link '(custom-manual "(message)Wide Reply")
1793   :type 'boolean)
1794
1795 (defcustom message-user-fqdn nil
1796   "*Domain part of Message-Ids."
1797   :version "22.1"
1798   :group 'message-headers
1799   :link '(custom-manual "(message)News Headers")
1800   :type '(radio (const :format "%v  " nil)
1801                 (string :format "FQDN: %v")))
1802
1803 (defcustom message-use-idna
1804   (and (or (mm-coding-system-p 'utf-8)
1805            (condition-case nil
1806                (let (mucs-ignore-version-incompatibilities)
1807                  (require 'un-define))
1808              (error)))
1809        (condition-case nil (require 'idna) (file-error))
1810        idna-program
1811        (executable-find idna-program)
1812        (string= (idna-to-ascii "räksmörgås") "xn--rksmrgs-5wao1o")
1813        t)
1814   "Whether to encode non-ASCII in domain names into ASCII according to IDNA.
1815 GNU Libidn, and in particular the elisp package \"idna.el\" and
1816 the external program \"idn\", must be installed for this
1817 functionality to work."
1818   :version "22.1"
1819   :group 'message-headers
1820   :link '(custom-manual "(message)IDNA")
1821   :type '(choice (const :tag "Ask" ask)
1822                  (const :tag "Never" nil)
1823                  (const :tag "Always" t)))
1824
1825 (defcustom message-generate-hashcash (if (executable-find "hashcash") 'opportunistic)
1826   "*Whether to generate X-Hashcash: headers.
1827 If t, always generate hashcash headers.  If `opportunistic',
1828 only generate hashcash headers if it can be done without the user
1829 waiting (i.e., only asynchronously).
1830
1831 You must have the \"hashcash\" binary installed, see `hashcash-path'."
1832   :version "24.1"
1833   :group 'message-headers
1834   :link '(custom-manual "(message)Mail Headers")
1835   :type '(choice (const :tag "Always" t)
1836                  (const :tag "Never" nil)
1837                  (const :tag "Opportunistic" opportunistic)))
1838
1839 ;;; Internal variables.
1840
1841 (defvar message-sending-message "Sending...")
1842 (defvar message-buffer-list nil)
1843 (defvar message-this-is-news nil)
1844 (defvar message-this-is-mail nil)
1845 (defvar message-draft-article nil)
1846 (defvar message-mime-part nil)
1847 (defvar message-posting-charset nil)
1848 (defvar message-inserted-headers nil)
1849 (defvar message-inhibit-ecomplete nil)
1850
1851 ;; Byte-compiler warning
1852 (defvar gnus-active-hashtb)
1853 (defvar gnus-read-active-file)
1854
1855 ;;; Regexp matching the delimiter of messages in UNIX mail format
1856 ;;; (UNIX From lines), minus the initial ^.  It should be a copy
1857 ;;; of rmail.el's rmail-unix-mail-delimiter.
1858 (defvar message-unix-mail-delimiter
1859   (let ((time-zone-regexp
1860          (concat "\\([A-Z]?[A-Z]?[A-Z][A-Z]\\( DST\\)?"
1861                  "\\|[-+]?[0-9][0-9][0-9][0-9]"
1862                  "\\|"
1863                  "\\) *")))
1864     (concat
1865      "From "
1866
1867      ;; Many things can happen to an RFC 822 mailbox before it is put into
1868      ;; a `From' line.  The leading phrase can be stripped, e.g.
1869      ;; `Joe <@w.x:joe@y.z>' -> `<@w.x:joe@y.z>'.  The <> can be stripped, e.g.
1870      ;; `<@x.y:joe@y.z>' -> `@x.y:joe@y.z'.  Everything starting with a CRLF
1871      ;; can be removed, e.g.
1872      ;;         From: joe@y.z (Joe      K
1873      ;;                 User)
1874      ;; can yield `From joe@y.z (Joe    K Fri Mar 22 08:11:15 1996', and
1875      ;;         From: Joe User
1876      ;;                 <joe@y.z>
1877      ;; can yield `From Joe User Fri Mar 22 08:11:15 1996'.
1878      ;; The mailbox can be removed or be replaced by white space, e.g.
1879      ;;         From: "Joe User"{space}{tab}
1880      ;;                 <joe@y.z>
1881      ;; can yield `From {space}{tab} Fri Mar 22 08:11:15 1996',
1882      ;; where {space} and {tab} represent the Ascii space and tab characters.
1883      ;; We want to match the results of any of these manglings.
1884      ;; The following regexp rejects names whose first characters are
1885      ;; obviously bogus, but after that anything goes.
1886      "\\([^\0-\b\n-\r\^?].*\\)?"
1887
1888      ;; The time the message was sent.
1889      "\\([^\0-\r \^?]+\\) +"            ; day of the week
1890      "\\([^\0-\r \^?]+\\) +"            ; month
1891      "\\([0-3]?[0-9]\\) +"              ; day of month
1892      "\\([0-2][0-9]:[0-5][0-9]\\(:[0-6][0-9]\\)?\\) *" ; time of day
1893
1894      ;; Perhaps a time zone, specified by an abbreviation, or by a
1895      ;; numeric offset.
1896      time-zone-regexp
1897
1898      ;; The year.
1899      " \\([0-9][0-9]+\\) *"
1900
1901      ;; On some systems the time zone can appear after the year, too.
1902      time-zone-regexp
1903
1904      ;; Old uucp cruft.
1905      "\\(remote from .*\\)?"
1906
1907      "\n"))
1908   "Regexp matching the delimiter of messages in UNIX mail format.")
1909
1910 (defvar message-unsent-separator
1911   (concat "^ *---+ +Unsent message follows +---+ *$\\|"
1912           "^ *---+ +Returned message +---+ *$\\|"
1913           "^Start of returned message$\\|"
1914           "^ *---+ +Original message +---+ *$\\|"
1915           "^ *--+ +begin message +--+ *$\\|"
1916           "^ *---+ +Original message follows +---+ *$\\|"
1917           "^ *---+ +Undelivered message follows +---+ *$\\|"
1918           "^------ This is a copy of the message, including all the headers. ------ *$\\|"
1919           "^|? *---+ +Message text follows: +---+ *|?$")
1920   "A regexp that matches the separator before the text of a failed message.")
1921
1922 (defvar message-field-fillers
1923   '((To message-fill-field-address)
1924     (Cc message-fill-field-address)
1925     (From message-fill-field-address))
1926   "Alist of header names/filler functions.")
1927
1928 (defvar message-header-format-alist
1929   `((From)
1930     (Newsgroups)
1931     (To)
1932     (Cc)
1933     (Subject)
1934     (In-Reply-To)
1935     (Fcc)
1936     (Bcc)
1937     (Date)
1938     (Organization)
1939     (Distribution)
1940     (Lines)
1941     (Expires)
1942     (Message-ID)
1943     (References . message-shorten-references)
1944     (User-Agent))
1945   "Alist used for formatting headers.")
1946
1947 (defvar message-options nil
1948   "Some saved answers when sending message.")
1949 ;; FIXME: On XEmacs this causes problems since let-binding like:
1950 ;; (let ((message-options message-options)) ...)
1951 ;; as in `message-send' and `mml-preview' loses to buffer-local
1952 ;; variable initialization.
1953 (unless (featurep 'xemacs)
1954   (make-variable-buffer-local 'message-options))
1955
1956 (defvar message-send-mail-real-function nil
1957   "Internal send mail function.")
1958
1959 (defvar message-bogus-system-names "\\`localhost\\.\\|\\.local\\'"
1960   "The regexp of bogus system names.")
1961
1962 (defcustom message-valid-fqdn-regexp
1963   (concat "[a-z0-9][-.a-z0-9]+\\." ;; [hostname.subdomain.]domain.
1964           ;; valid TLDs:
1965           "\\([a-z][a-z]\\|" ;; two letter country TDLs
1966           "aero\\|arpa\\|asia\\|bitnet\\|biz\\|bofh\\|"
1967           "cat\\|com\\|coop\\|edu\\|gov\\|"
1968           "info\\|int\\|jobs\\|"
1969           "mil\\|mobi\\|museum\\|name\\|net\\|"
1970           "org\\|pro\\|tel\\|travel\\|uucp\\|"
1971           ;; ICANN-era generic top-level domains
1972           "academy\\|actor\\|agency\\|airforce\\|archi\\|associates\\|axa\\|"
1973           "bar\\|bargains\\|bayern\\|beer\\|berlin\\|best\\|bid\\|bike\\|"
1974           "biz\\|black\\|blackfriday\\|blue\\|boutique\\|build\\|builders\\|"
1975           "buzz\\|cab\\|camera\\|camp\\|capital\\|cards\\|care\\|career\\|"
1976           "careers\\|cash\\|catering\\|center\\|ceo\\|cheap\\|christmas\\|"
1977           "church\\|citic\\|cleaning\\|clinic\\|clothing\\|club\\|codes\\|"
1978           "coffee\\|college\\|cologne\\|com\\|community\\|company\\|computer\\|"
1979           "construction\\|contractors\\|cooking\\|cool\\|country\\|creditcard\\|"
1980           "cruises\\|dance\\|dating\\|democrat\\|dental\\|desi\\|design\\|"
1981           "diamonds\\|directory\\|discount\\|domains\\|education\\|email\\|"
1982           "engineering\\|enterprises\\|equipment\\|estate\\|eus\\|events\\|"
1983           "exchange\\|expert\\|exposed\\|fail\\|farm\\|feedback\\|finance\\|"
1984           "financial\\|fish\\|fishing\\|fitness\\|flights\\|florist\\|foo\\|"
1985           "foundation\\|frogans\\|fund\\|furniture\\|futbol\\|gal\\|"
1986           "gallery\\|gift\\|glass\\|globo\\|gmo\\|gop\\|graphics\\|gratis\\|"
1987           "gripe\\|guide\\|guitars\\|guru\\|hamburg\\|haus\\|hiphop\\|"
1988           "holdings\\|holiday\\|homes\\|horse\\|house\\|immobilien\\|"
1989           "industries\\|info\\|ink\\|institute\\|insure\\|international\\|"
1990           "investments\\|jetzt\\|juegos\\|kaufen\\|kim\\|kitchen\\|kiwi\\|"
1991           "koeln\\|kred\\|land\\|lat\\|latino\\|lease\\|life\\|lighting\\|"
1992           "limited\\|limo\\|link\\|loans\\|london\\|luxe\\|luxury\\|"
1993           "management\\|mango\\|marketing\\|media\\|meet\\|menu\\|miami\\|"
1994           "moda\\|moe\\|monash\\|moscow\\|motorcycles\\|nagoya\\|name\\|"
1995           "net\\|neustar\\|ninja\\|nyc\\|okinawa\\|onl\\|org\\|paris\\|"
1996           "partners\\|parts\\|photo\\|photography\\|photos\\|pics\\|"
1997           "pictures\\|pink\\|plumbing\\|pro\\|productions\\|properties\\|"
1998           "pub\\|qpon\\|quebec\\|recipes\\|red\\|reisen\\|ren\\|rentals\\|"
1999           "repair\\|report\\|rest\\|reviews\\|rich\\|rocks\\|rodeo\\|"
2000           "ruhr\\|ryukyu\\|saarland\\|schule\\|scot\\|services\\|sexy\\|"
2001           "shiksha\\|shoes\\|singles\\|social\\|sohu\\|solar\\|solutions\\|"
2002           "soy\\|supplies\\|supply\\|support\\|surgery\\|systems\\|tattoo\\|"
2003           "tax\\|technology\\|tienda\\|tips\\|today\\|tokyo\\|tools\\|"
2004           "town\\|toys\\|trade\\|training\\|university\\|uno\\|vacations\\|"
2005           "vegas\\|ventures\\|viajes\\|villas\\|vision\\|vodka\\|vote\\|"
2006           "voting\\|voto\\|voyage\\|wang\\|watch\\|webcam\\|wed\\|wien\\|"
2007           "wiki\\|works\\|wtc\\|wtf\\|xyz\\|yachts\\|yokohama\\|you\\|"
2008           "zone\\)")
2009   ;; http://en.wikipedia.org/wiki/List_of_Internet_top-level_domains
2010   ;; http://en.wikipedia.org/wiki/GTLD
2011   ;; `approved, but not yet in operation': .xxx
2012   ;; "dead" nato bitnet uucp
2013   "Regular expression that matches a valid FQDN."
2014   ;; see also: gnus-button-valid-fqdn-regexp
2015   :version "22.1"
2016   :group 'message-headers
2017   :type 'regexp)
2018
2019 (autoload 'gnus-alive-p "gnus-util")
2020 (autoload 'gnus-delay-article "gnus-delay")
2021 (autoload 'gnus-extract-address-components "gnus-util")
2022 (autoload 'gnus-find-method-for-group "gnus")
2023 (autoload 'gnus-group-decoded-name "gnus-group")
2024 (autoload 'gnus-group-name-charset "gnus-group")
2025 (autoload 'gnus-group-name-decode "gnus-group")
2026 (autoload 'gnus-groups-from-server "gnus")
2027 (autoload 'gnus-make-local-hook "gnus-util")
2028 (autoload 'gnus-open-server "gnus-int")
2029 (autoload 'gnus-output-to-mail "gnus-util")
2030 (autoload 'gnus-output-to-rmail "gnus-util")
2031 (autoload 'gnus-request-post "gnus-int")
2032 (autoload 'gnus-select-frame-set-input-focus "gnus-util")
2033 (autoload 'gnus-server-string "gnus")
2034 (autoload 'idna-to-ascii "idna")
2035 (autoload 'message-setup-toolbar "messagexmas")
2036 (autoload 'mh-new-draft-name "mh-comp")
2037 (autoload 'mh-send-letter "mh-comp")
2038 (autoload 'nndraft-request-associate-buffer "nndraft")
2039 (autoload 'nndraft-request-expire-articles "nndraft")
2040 (autoload 'nnvirtual-find-group-art "nnvirtual")
2041 (autoload 'rmail-msg-is-pruned "rmail")
2042 (autoload 'rmail-output "rmailout")
2043
2044 ;; Emacs < 24.1 do not have mail-dont-reply-to
2045 (unless (fboundp 'mail-dont-reply-to)
2046   (defalias 'mail-dont-reply-to 'rmail-dont-reply-to))
2047
2048 \f
2049
2050 ;;;
2051 ;;; Utility functions.
2052 ;;;
2053
2054 (defmacro message-y-or-n-p (question show &rest text)
2055   "Ask QUESTION, displaying remaining args in a temporary buffer if SHOW."
2056   `(message-talkative-question 'y-or-n-p ,question ,show ,@text))
2057
2058 (defmacro message-delete-line (&optional n)
2059   "Delete the current line (and the next N lines)."
2060   `(delete-region (progn (beginning-of-line) (point))
2061                   (progn (forward-line ,(or n 1)) (point))))
2062
2063 (defun message-mark-active-p ()
2064   "Non-nil means the mark and region are currently active in this buffer."
2065   mark-active)
2066
2067 (defun message-unquote-tokens (elems)
2068   "Remove double quotes (\") from strings in list ELEMS."
2069   (mapcar (lambda (item)
2070             (while (string-match "^\\(.*\\)\"\\(.*\\)$" item)
2071               (setq item (concat (match-string 1 item)
2072                                  (match-string 2 item))))
2073             item)
2074           elems))
2075
2076 (defun message-tokenize-header (header &optional separator)
2077   "Split HEADER into a list of header elements.
2078 SEPARATOR is a string of characters to be used as separators.  \",\"
2079 is used by default."
2080   (if (not header)
2081       nil
2082     (let ((regexp (format "[%s]+" (or separator ",")))
2083           (first t)
2084           beg quoted elems paren)
2085       (with-temp-buffer
2086         (mm-enable-multibyte)
2087         (setq beg (point-min))
2088         (insert header)
2089         (goto-char (point-min))
2090         (while (not (eobp))
2091           (if first
2092               (setq first nil)
2093             (forward-char 1))
2094           (cond ((and (> (point) beg)
2095                       (or (eobp)
2096                           (and (looking-at regexp)
2097                                (not quoted)
2098                                (not paren))))
2099                  (push (buffer-substring beg (point)) elems)
2100                  (setq beg (match-end 0)))
2101                 ((eq (char-after) ?\")
2102                  (setq quoted (not quoted)))
2103                 ((and (eq (char-after) ?\()
2104                       (not quoted))
2105                  (setq paren t))
2106                 ((and (eq (char-after) ?\))
2107                       (not quoted))
2108                  (setq paren nil))))
2109         (nreverse elems)))))
2110
2111 (autoload 'nnheader-insert-file-contents "nnheader")
2112
2113 (defun message-mail-file-mbox-p (file)
2114   "Say whether FILE looks like a Unix mbox file."
2115   (when (and (file-exists-p file)
2116              (file-readable-p file)
2117              (file-regular-p file))
2118     (with-temp-buffer
2119       (nnheader-insert-file-contents file)
2120       (goto-char (point-min))
2121       (looking-at message-unix-mail-delimiter))))
2122
2123 (defun message-fetch-field (header &optional not-all)
2124   "The same as `mail-fetch-field', only remove all newlines.
2125 The buffer is expected to be narrowed to just the header of the message;
2126 see `message-narrow-to-headers-or-head'."
2127   (let* ((inhibit-point-motion-hooks t)
2128          (value (mail-fetch-field header nil (not not-all))))
2129     (when value
2130       (while (string-match "\n[\t ]+" value)
2131         (setq value (replace-match " " t t value)))
2132       value)))
2133
2134 (defun message-field-value (header &optional not-all)
2135   "The same as `message-fetch-field', only narrow to the headers first."
2136   (save-excursion
2137     (save-restriction
2138       (message-narrow-to-headers-or-head)
2139       (message-fetch-field header not-all))))
2140
2141 (defun message-narrow-to-field ()
2142   "Narrow the buffer to the header on the current line."
2143   (beginning-of-line)
2144   (while (looking-at "[ \t]")
2145     (forward-line -1))
2146   (narrow-to-region
2147    (point)
2148    (progn
2149      (forward-line 1)
2150      (if (re-search-forward "^[^ \n\t]" nil t)
2151          (point-at-bol)
2152        (point-max))))
2153   (goto-char (point-min)))
2154
2155 (defun message-add-header (&rest headers)
2156   "Add the HEADERS to the message header, skipping those already present."
2157   (while headers
2158     (let (hclean)
2159       (unless (string-match "^\\([^:]+\\):[ \t]*[^ \t]" (car headers))
2160         (error "Invalid header `%s'" (car headers)))
2161       (setq hclean (match-string 1 (car headers)))
2162       (save-restriction
2163         (message-narrow-to-headers)
2164         (unless (re-search-forward (concat "^" (regexp-quote hclean) ":") nil t)
2165           (goto-char (point-max))
2166           (if (string-match "\n$" (car headers))
2167               (insert (car headers))
2168             (insert (car headers) ?\n)))))
2169     (setq headers (cdr headers))))
2170
2171 (defmacro message-with-reply-buffer (&rest forms)
2172   "Evaluate FORMS in the reply buffer, if it exists."
2173   `(when (and (bufferp message-reply-buffer)
2174               (buffer-name message-reply-buffer))
2175      (with-current-buffer message-reply-buffer
2176        ,@forms)))
2177
2178 (put 'message-with-reply-buffer 'lisp-indent-function 0)
2179 (put 'message-with-reply-buffer 'edebug-form-spec '(body))
2180
2181 (defun message-fetch-reply-field (header)
2182   "Fetch field HEADER from the message we're replying to."
2183   (message-with-reply-buffer
2184     (save-restriction
2185       (mail-narrow-to-head)
2186       (message-fetch-field header))))
2187
2188 (defun message-strip-list-identifiers (subject)
2189   "Remove list identifiers in `gnus-list-identifiers' from string SUBJECT."
2190   (require 'gnus-sum)                   ; for gnus-list-identifiers
2191   (let ((regexp (if (stringp gnus-list-identifiers)
2192                     gnus-list-identifiers
2193                   (mapconcat 'identity gnus-list-identifiers " *\\|"))))
2194     (if (string-match (concat "\\(\\(\\(Re: +\\)?\\(" regexp
2195                               " *\\)\\)+\\(Re: +\\)?\\)") subject)
2196         (concat (substring subject 0 (match-beginning 1))
2197                 (or (match-string 3 subject)
2198                     (match-string 5 subject))
2199                 (substring subject
2200                            (match-end 1)))
2201       subject)))
2202
2203 (defun message-strip-subject-re (subject)
2204   "Remove \"Re:\" from subject lines in string SUBJECT."
2205   (if (string-match message-subject-re-regexp subject)
2206       (substring subject (match-end 0))
2207     subject))
2208
2209 (defcustom message-replacement-char "."
2210   "Replacement character used instead of unprintable or not decodable chars."
2211   :group 'message-various
2212   :version "22.1" ;; Gnus 5.10.9
2213   :type '(choice string
2214                  (const ".")
2215                  (const "?")))
2216
2217 ;; FIXME: We also should call `message-strip-subject-encoded-words'
2218 ;; when forwarding.  Probably in `message-make-forward-subject' and
2219 ;; `message-forward-make-body'.
2220
2221 (defun message-strip-subject-encoded-words (subject)
2222   "Fix non-decodable words in SUBJECT."
2223   ;; Cf. `gnus-simplify-subject-fully'.
2224   (let* ((case-fold-search t)
2225          (replacement-chars (format "[%s%s%s]"
2226                                     message-replacement-char
2227                                     message-replacement-char
2228                                     message-replacement-char))
2229          (enc-word-re "=\\?\\([^?]+\\)\\?\\([QB]\\)\\?\\([^?]+\\)\\(\\?=\\)")
2230          cs-string
2231          (have-marker
2232           (with-temp-buffer
2233             (insert subject)
2234             (goto-char (point-min))
2235             (when (re-search-forward enc-word-re nil t)
2236               (setq cs-string (match-string 1)))))
2237          cs-coding q-or-b word-beg word-end)
2238     (if (or (not have-marker) ;; No encoded word found...
2239             ;; ... or double encoding was correct:
2240             (and (stringp cs-string)
2241                  (setq cs-string (downcase cs-string))
2242                  (mm-coding-system-p (intern cs-string))
2243                  (not (prog1
2244                           (y-or-n-p
2245                            (format "\
2246 Decoded Subject \"%s\"
2247 contains a valid encoded word.  Decode again? "
2248                                    subject))
2249                         (setq cs-coding (intern cs-string))))))
2250         subject
2251       (with-temp-buffer
2252         (insert subject)
2253         (goto-char (point-min))
2254         (while (re-search-forward enc-word-re nil t)
2255           (setq cs-string (downcase (match-string 1))
2256                 q-or-b    (match-string 2)
2257                 word-beg (match-beginning 0)
2258                 word-end (match-end 0))
2259           (setq cs-coding
2260                 (if (mm-coding-system-p (intern cs-string))
2261                     (setq cs-coding (intern cs-string))
2262                   nil))
2263           ;; No double encoded subject? => bogus charset.
2264           (unless cs-coding
2265             (setq cs-coding
2266                   (mm-read-coding-system
2267                    (format "\
2268 Decoded Subject \"%s\"
2269 contains an encoded word.  The charset `%s' is unknown or invalid.
2270 Hit RET to replace non-decodable characters with \"%s\" or enter replacement
2271 charset: "
2272                            subject cs-string message-replacement-char)))
2273             (if cs-coding
2274                 (replace-match (concat "=?" (symbol-name cs-coding)
2275                                        "?\\2?\\3\\4\\5"))
2276               (save-excursion
2277                 (goto-char word-beg)
2278                 (re-search-forward "=\\?\\([^?]+\\)\\?\\([QB]\\)\\?" word-end t)
2279                 (replace-match "")
2280                 ;; QP or base64
2281                 (if (string-match "\\`Q\\'" q-or-b)
2282                     ;; QP
2283                     (progn
2284                       (message "Replacing non-decodable characters with \"%s\"."
2285                                message-replacement-char)
2286                       (while (re-search-forward "\\(=[A-F0-9][A-F0-9]\\)+"
2287                                                 word-end t)
2288                         (replace-match message-replacement-char)))
2289                   ;; base64
2290                   (message "Replacing non-decodable characters with \"%s\"."
2291                            replacement-chars)
2292                   (re-search-forward "[^?]+" word-end t)
2293                   (replace-match replacement-chars))
2294                 (re-search-forward "\\?=")
2295                 (replace-match "")))))
2296         (rfc2047-decode-region (point-min) (point-max))
2297         (buffer-string)))))
2298
2299 ;;; Start of functions adopted from `message-utils.el'.
2300
2301 (defun message-strip-subject-trailing-was (subject)
2302   "Remove trailing \"(was: <old subject>)\" from SUBJECT lines.
2303 Leading \"Re: \" is not stripped by this function.  Use the function
2304 `message-strip-subject-re' for this."
2305   (let* ((query message-subject-trailing-was-query)
2306          (new) (found))
2307     (setq found
2308           (string-match
2309            (if (eq query 'ask)
2310                message-subject-trailing-was-ask-regexp
2311              message-subject-trailing-was-regexp)
2312            subject))
2313     (if found
2314         (setq new (substring subject 0 (match-beginning 0))))
2315     (if (or (not found) (eq query nil))
2316         subject
2317       (if (eq query 'ask)
2318           (if (message-y-or-n-p
2319                "Strip `(was: <old subject>)' in subject? " t
2320                (concat
2321                 "Strip `(was: <old subject>)' in subject "
2322                 "and use the new one instead?\n\n"
2323                 "Current subject is:   \""
2324                 subject "\"\n\n"
2325                 "New subject would be: \""
2326                 new "\"\n\n"
2327                 "See the variable `message-subject-trailing-was-query' "
2328                 "to get rid of this query."
2329                 ))
2330               new subject)
2331         new))))
2332
2333 ;;; Suggested by Jonas Steverud  @  www.dtek.chalmers.se/~d4jonas/
2334
2335 (defun message-change-subject (new-subject)
2336   "Ask for NEW-SUBJECT header, append (was: <Old Subject>)."
2337   (interactive
2338    (list
2339     (read-from-minibuffer "New subject: ")))
2340   (cond ((and (not (or (null new-subject) ; new subject not empty
2341                        (zerop (string-width new-subject))
2342                        (string-match "^[ \t]*$" new-subject))))
2343          (save-excursion
2344            (let ((old-subject
2345                   (save-restriction
2346                     (message-narrow-to-headers)
2347                     (message-fetch-field "Subject"))))
2348              (cond ((not old-subject)
2349                     (error "No current subject"))
2350                    ((not (string-match
2351                           (concat "^[ \t]*"
2352                                   (regexp-quote new-subject)
2353                                   " \t]*$")
2354                           old-subject))  ; yes, it really is a new subject
2355                     ;; delete eventual Re: prefix
2356                     (setq old-subject
2357                           (message-strip-subject-re old-subject))
2358                     (message-goto-subject)
2359                     (message-delete-line)
2360                     (insert (concat "Subject: "
2361                                     new-subject
2362                                     " (was: "
2363                                     old-subject ")\n")))))))))
2364
2365 (defun message-mark-inserted-region (beg end &optional verbatim)
2366   "Mark some region in the current article with enclosing tags.
2367 See `message-mark-insert-begin' and `message-mark-insert-end'.
2368 If VERBATIM, use slrn style verbatim marks (\"#v+\" and \"#v-\")."
2369   (interactive "r\nP")
2370   (save-excursion
2371     ;; add to the end of the region first, otherwise end would be invalid
2372     (goto-char end)
2373     (insert (if verbatim "#v-\n" message-mark-insert-end))
2374     (goto-char beg)
2375     (insert (if verbatim "#v+\n" message-mark-insert-begin))))
2376
2377 (defun message-mark-insert-file (file &optional verbatim)
2378   "Insert FILE at point, marking it with enclosing tags.
2379 See `message-mark-insert-begin' and `message-mark-insert-end'.
2380 If VERBATIM, use slrn style verbatim marks (\"#v+\" and \"#v-\")."
2381   (interactive "fFile to insert: \nP")
2382     ;; reverse insertion to get correct result.
2383   (let ((p (point)))
2384     (insert (if verbatim "#v-\n" message-mark-insert-end))
2385     (goto-char p)
2386     (insert-file-contents file)
2387     (goto-char p)
2388     (insert (if verbatim "#v+\n" message-mark-insert-begin))))
2389
2390 (defun message-add-archive-header ()
2391   "Insert \"X-No-Archive: Yes\" in the header and a note in the body.
2392 The note can be customized using `message-archive-note'.  When called with a
2393 prefix argument, ask for a text to insert.  If you don't want the note in the
2394 body, set  `message-archive-note' to nil."
2395   (interactive)
2396   (if current-prefix-arg
2397       (setq message-archive-note
2398             (read-from-minibuffer "Reason for No-Archive: "
2399                                   (cons message-archive-note 0))))
2400     (save-excursion
2401       (if (message-goto-signature)
2402           (re-search-backward message-signature-separator))
2403       (when message-archive-note
2404         (insert message-archive-note)
2405         (newline))
2406       (message-add-header message-archive-header)
2407       (message-sort-headers)))
2408
2409 (defun message-cross-post-followup-to-header (target-group)
2410   "Mangles FollowUp-To and Newsgroups header to point to TARGET-GROUP.
2411 With prefix-argument just set Follow-Up, don't cross-post."
2412   (interactive
2413    (list ; Completion based on Gnus
2414     (completing-read "Followup To: "
2415                      (if (boundp 'gnus-newsrc-alist)
2416                          gnus-newsrc-alist)
2417                      nil nil '("poster" . 0)
2418                      (if (boundp 'gnus-group-history)
2419                          'gnus-group-history))))
2420   (message-remove-header "Follow[Uu]p-[Tt]o" t)
2421   (message-goto-newsgroups)
2422   (beginning-of-line)
2423   ;; if we already did a crosspost before, kill old target
2424   (if (and message-cross-post-old-target
2425            (re-search-forward
2426             (regexp-quote (concat "," message-cross-post-old-target))
2427             nil t))
2428       (replace-match ""))
2429   ;; unless (followup is to poster or user explicitly asked not
2430   ;; to cross-post, or target-group is already in Newsgroups)
2431   ;; add target-group to Newsgroups line.
2432   (cond ((and (or
2433                ;; def: cross-post, req:no
2434                (and message-cross-post-default (not current-prefix-arg))
2435                ;; def: no-cross-post, req:yes
2436                (and (not message-cross-post-default) current-prefix-arg))
2437               (not (string-match "poster" target-group))
2438               (not (string-match (regexp-quote target-group)
2439                                  (message-fetch-field "Newsgroups"))))
2440          (end-of-line)
2441          (insert (concat "," target-group))))
2442   (end-of-line) ; ensure Followup: comes after Newsgroups:
2443   ;; unless new followup would be identical to Newsgroups line
2444   ;; make a new Followup-To line
2445   (if (not (string-match (concat "^[ \t]*"
2446                                  target-group
2447                                  "[ \t]*$")
2448                          (message-fetch-field "Newsgroups")))
2449       (insert (concat "\nFollowup-To: " target-group)))
2450   (setq message-cross-post-old-target target-group))
2451
2452 (defun message-cross-post-insert-note (target-group cross-post in-old
2453                                                     old-groups)
2454   "Insert a in message body note about a set Followup or Crosspost.
2455 If there have been previous notes, delete them.  TARGET-GROUP specifies the
2456 group to Followup-To.  When CROSS-POST is t, insert note about
2457 crossposting.  IN-OLD specifies whether TARGET-GROUP is a member of
2458 OLD-GROUPS.  OLD-GROUPS lists the old-groups the posting would have
2459 been made to before the user asked for a Crosspost."
2460   ;; start scanning body for previous uses
2461   (message-goto-signature)
2462   (let ((head (re-search-backward
2463                (concat "^" mail-header-separator)
2464                nil t))) ; just search in body
2465     (message-goto-signature)
2466     (while (re-search-backward
2467             (concat "^" (regexp-quote message-cross-post-note) ".*")
2468             head t)
2469       (message-delete-line))
2470     (message-goto-signature)
2471     (while (re-search-backward
2472             (concat "^" (regexp-quote message-followup-to-note) ".*")
2473             head t)
2474       (message-delete-line))
2475     ;; insert new note
2476     (if (message-goto-signature)
2477         (re-search-backward message-signature-separator))
2478     (if (or in-old
2479             (not cross-post)
2480             (string-match "^[ \t]*poster[ \t]*$" target-group))
2481         (insert (concat message-followup-to-note target-group "\n"))
2482       (insert (concat message-cross-post-note target-group "\n")))))
2483
2484 (defun message-cross-post-followup-to (target-group)
2485   "Crossposts message and set Followup-To to TARGET-GROUP.
2486 With prefix-argument just set Follow-Up, don't cross-post."
2487   (interactive
2488    (list ; Completion based on Gnus
2489     (completing-read "Followup To: "
2490                      (if (boundp 'gnus-newsrc-alist)
2491                          gnus-newsrc-alist)
2492                      nil nil '("poster" . 0)
2493                      (if (boundp 'gnus-group-history)
2494                          'gnus-group-history))))
2495   (cond ((not (or (null target-group) ; new subject not empty
2496                   (zerop (string-width target-group))
2497                   (string-match "^[ \t]*$" target-group)))
2498          (save-excursion
2499            (let* ((old-groups (message-fetch-field "Newsgroups"))
2500                   (in-old (string-match
2501                            (regexp-quote target-group)
2502                            (or old-groups ""))))
2503              ;; check whether target exactly matches old Newsgroups
2504              (cond ((not old-groups)
2505                     (error "No current newsgroup"))
2506                    ((or (not in-old)
2507                         (not (string-match
2508                               (concat "^[ \t]*"
2509                                       (regexp-quote target-group)
2510                                       "[ \t]*$")
2511                               old-groups)))
2512                     ;; yes, Newsgroups line must change
2513                     (message-cross-post-followup-to-header target-group)
2514                     ;; insert note whether we do cross-post or followup-to
2515                     (funcall message-cross-post-note-function
2516                              target-group
2517                              (if (or (and message-cross-post-default
2518                                           (not current-prefix-arg))
2519                                      (and (not message-cross-post-default)
2520                                           current-prefix-arg)) t)
2521                              in-old old-groups))))))))
2522
2523 ;;; Reduce To: to Cc: or Bcc: header
2524
2525 (defun message-reduce-to-to-cc ()
2526  "Replace contents of To: header with contents of Cc: or Bcc: header."
2527  (interactive)
2528  (let ((cc-content
2529         (save-restriction (message-narrow-to-headers)
2530                           (message-fetch-field "cc")))
2531        (bcc nil))
2532    (if (and (not cc-content)
2533             (setq cc-content
2534                   (save-restriction
2535                     (message-narrow-to-headers)
2536                     (message-fetch-field "bcc"))))
2537        (setq bcc t))
2538    (cond (cc-content
2539           (save-excursion
2540             (message-goto-to)
2541             (message-delete-line)
2542             (insert (concat "To: " cc-content "\n"))
2543             (save-restriction
2544               (message-narrow-to-headers)
2545               (message-remove-header (if bcc
2546                                          "bcc"
2547                                        "cc"))))))))
2548
2549 ;;; End of functions adopted from `message-utils.el'.
2550
2551 (defun message-remove-header (header &optional is-regexp first reverse)
2552   "Remove HEADER in the narrowed buffer.
2553 If IS-REGEXP, HEADER is a regular expression.
2554 If FIRST, only remove the first instance of the header.
2555 If REVERSE, remove headers that doesn't match HEADER.
2556 Return the number of headers removed."
2557   (goto-char (point-min))
2558   (let ((regexp (if is-regexp header (concat "^" (regexp-quote header) ":")))
2559         (number 0)
2560         (case-fold-search t)
2561         last)
2562     (while (and (not (eobp))
2563                 (not last))
2564       (if (if reverse
2565               (not (looking-at regexp))
2566             (looking-at regexp))
2567           (progn
2568             (incf number)
2569             (when first
2570               (setq last t))
2571             (delete-region
2572              (point)
2573              ;; There might be a continuation header, so we have to search
2574              ;; until we find a new non-continuation line.
2575              (progn
2576                (forward-line 1)
2577                (if (re-search-forward "^[^ \t]" nil t)
2578                    (goto-char (match-beginning 0))
2579                  (point-max)))))
2580         (forward-line 1)
2581         (if (re-search-forward "^[^ \t]" nil t)
2582             (goto-char (match-beginning 0))
2583           (goto-char (point-max)))))
2584     number))
2585
2586 (defun message-remove-first-header (header)
2587   "Remove the first instance of HEADER if there is more than one."
2588   (let ((count 0)
2589         (regexp (concat "^" (regexp-quote header) ":")))
2590     (save-excursion
2591       (goto-char (point-min))
2592       (while (re-search-forward regexp nil t)
2593         (incf count)))
2594     (while (> count 1)
2595       (message-remove-header header nil t)
2596       (decf count))))
2597
2598 (defun message-narrow-to-headers ()
2599   "Narrow the buffer to the head of the message."
2600   (widen)
2601   (narrow-to-region
2602    (goto-char (point-min))
2603    (if (re-search-forward
2604         (concat "^" (regexp-quote mail-header-separator) "\n") nil t)
2605        (match-beginning 0)
2606      (point-max)))
2607   (goto-char (point-min)))
2608
2609 (defun message-narrow-to-head-1 ()
2610   "Like `message-narrow-to-head'.  Don't widen."
2611   (narrow-to-region
2612    (goto-char (point-min))
2613    (if (search-forward "\n\n" nil 1)
2614        (1- (point))
2615      (point-max)))
2616   (goto-char (point-min)))
2617
2618 ;; FIXME: clarify difference: message-narrow-to-head,
2619 ;; message-narrow-to-headers-or-head, message-narrow-to-headers
2620 (defun message-narrow-to-head ()
2621   "Narrow the buffer to the head of the message.
2622 Point is left at the beginning of the narrowed-to region."
2623   (widen)
2624   (message-narrow-to-head-1))
2625
2626 (defun message-narrow-to-headers-or-head ()
2627   "Narrow the buffer to the head of the message."
2628   (widen)
2629   (narrow-to-region
2630    (goto-char (point-min))
2631    (if (re-search-forward (concat "\\(\n\\)\n\\|^\\("
2632                                   (regexp-quote mail-header-separator)
2633                                   "\n\\)")
2634                           nil t)
2635        (or (match-end 1) (match-beginning 2))
2636      (point-max)))
2637   (goto-char (point-min)))
2638
2639 (defun message-news-p ()
2640   "Say whether the current buffer contains a news message."
2641   (and (not message-this-is-mail)
2642        (or message-this-is-news
2643            (save-excursion
2644              (save-restriction
2645                (message-narrow-to-headers)
2646                (and (message-fetch-field "newsgroups")
2647                     (not (message-fetch-field "posted-to"))))))))
2648
2649 (defun message-mail-p ()
2650   "Say whether the current buffer contains a mail message."
2651   (and (not message-this-is-news)
2652        (or message-this-is-mail
2653            (save-excursion
2654              (save-restriction
2655                (message-narrow-to-headers)
2656                (or (message-fetch-field "to")
2657                    (message-fetch-field "cc")
2658                    (message-fetch-field "bcc")))))))
2659
2660 (defun message-subscribed-p ()
2661   "Say whether we need to insert a MFT header."
2662   (or message-subscribed-regexps
2663       message-subscribed-addresses
2664       message-subscribed-address-file
2665       message-subscribed-address-functions))
2666
2667 (defun message-next-header ()
2668   "Go to the beginning of the next header."
2669   (beginning-of-line)
2670   (or (eobp) (forward-char 1))
2671   (not (if (re-search-forward "^[^ \t]" nil t)
2672            (beginning-of-line)
2673          (goto-char (point-max)))))
2674
2675 (defun message-sort-headers-1 ()
2676   "Sort the buffer as headers using `message-rank' text props."
2677   (goto-char (point-min))
2678   (require 'sort)
2679   (sort-subr
2680    nil 'message-next-header
2681    (lambda ()
2682      (message-next-header)
2683      (unless (bobp)
2684        (forward-char -1)))
2685    (lambda ()
2686      (or (get-text-property (point) 'message-rank)
2687          10000))))
2688
2689 (defun message-sort-headers ()
2690   "Sort the headers of the current message according to `message-header-format-alist'."
2691   (interactive)
2692   (save-excursion
2693     (save-restriction
2694       (let ((max (1+ (length message-header-format-alist)))
2695             rank)
2696         (message-narrow-to-headers)
2697         (while (re-search-forward "^[^ \n]+:" nil t)
2698           (put-text-property
2699            (match-beginning 0) (1+ (match-beginning 0))
2700            'message-rank
2701            (if (setq rank (length (memq (assq (intern (buffer-substring
2702                                                        (match-beginning 0)
2703                                                        (1- (match-end 0))))
2704                                               message-header-format-alist)
2705                                         message-header-format-alist)))
2706                (- max rank)
2707              (1+ max)))))
2708       (message-sort-headers-1))))
2709
2710 (defun message-kill-address ()
2711   "Kill the address under point."
2712   (interactive)
2713   (let ((start (point)))
2714     (message-skip-to-next-address)
2715     (kill-region start (if (bolp) (1- (point)) (point)))))
2716
2717
2718 (autoload 'Info-goto-node "info")
2719 (defvar mml2015-use)
2720
2721 (defun message-info (&optional arg)
2722   "Display the Message manual.
2723
2724 Prefixed with one \\[universal-argument], display the Emacs MIME
2725 manual.  With two \\[universal-argument]'s, display the EasyPG or
2726 PGG manual, depending on the value of `mml2015-use'."
2727   (interactive "p")
2728   ;; Don't use `info' because support for `(filename)nodename' is not
2729   ;; available in XEmacs < 21.5.12.
2730   (Info-goto-node (format "(%s)Top"
2731                           (cond ((eq arg 16)
2732                                  (require 'mml2015)
2733                                  mml2015-use)
2734                                 ((eq arg  4) 'emacs-mime)
2735                                 ;; `booleanp' only available in Emacs 22+
2736                                 ((and (not (memq arg '(nil t)))
2737                                       (symbolp arg))
2738                                  arg)
2739                                 (t
2740                                  'message)))))
2741
2742 \f
2743
2744 ;;;
2745 ;;; Message mode
2746 ;;;
2747
2748 ;;; Set up keymap.
2749
2750 (defvar message-mode-map nil)
2751
2752 (unless message-mode-map
2753   (setq message-mode-map (make-keymap))
2754   (set-keymap-parent message-mode-map text-mode-map)
2755   (define-key message-mode-map "\C-c?" 'describe-mode)
2756
2757   (define-key message-mode-map "\C-c\C-f\C-t" 'message-goto-to)
2758   (define-key message-mode-map "\C-c\C-f\C-o" 'message-goto-from)
2759   (define-key message-mode-map "\C-c\C-f\C-b" 'message-goto-bcc)
2760   (define-key message-mode-map "\C-c\C-f\C-w" 'message-goto-fcc)
2761   (define-key message-mode-map "\C-c\C-f\C-c" 'message-goto-cc)
2762   (define-key message-mode-map "\C-c\C-f\C-s" 'message-goto-subject)
2763   (define-key message-mode-map "\C-c\C-f\C-r" 'message-goto-reply-to)
2764   (define-key message-mode-map "\C-c\C-f\C-n" 'message-goto-newsgroups)
2765   (define-key message-mode-map "\C-c\C-f\C-d" 'message-goto-distribution)
2766   (define-key message-mode-map "\C-c\C-f\C-f" 'message-goto-followup-to)
2767   (define-key message-mode-map "\C-c\C-f\C-m" 'message-goto-mail-followup-to)
2768   (define-key message-mode-map "\C-c\C-f\C-k" 'message-goto-keywords)
2769   (define-key message-mode-map "\C-c\C-f\C-u" 'message-goto-summary)
2770   (define-key message-mode-map "\C-c\C-f\C-i"
2771     'message-insert-or-toggle-importance)
2772   (define-key message-mode-map "\C-c\C-f\C-a"
2773     'message-generate-unsubscribed-mail-followup-to)
2774
2775   ;; modify headers (and insert notes in body)
2776   (define-key message-mode-map "\C-c\C-fs"    'message-change-subject)
2777   ;;
2778   (define-key message-mode-map "\C-c\C-fx"    'message-cross-post-followup-to)
2779   ;; prefix+message-cross-post-followup-to = same w/o cross-post
2780   (define-key message-mode-map "\C-c\C-ft"    'message-reduce-to-to-cc)
2781   (define-key message-mode-map "\C-c\C-fa"    'message-add-archive-header)
2782   ;; mark inserted text
2783   (define-key message-mode-map "\C-c\M-m" 'message-mark-inserted-region)
2784   (define-key message-mode-map "\C-c\M-f" 'message-mark-insert-file)
2785
2786   (define-key message-mode-map "\C-c\C-b" 'message-goto-body)
2787   (define-key message-mode-map "\C-c\C-i" 'message-goto-signature)
2788
2789   (define-key message-mode-map "\C-c\C-t" 'message-insert-to)
2790   (define-key message-mode-map "\C-c\C-fw" 'message-insert-wide-reply)
2791   (define-key message-mode-map "\C-c\C-n" 'message-insert-newsgroups)
2792   (define-key message-mode-map "\C-c\C-l" 'message-to-list-only)
2793   (define-key message-mode-map "\C-c\C-f\C-e" 'message-insert-expires)
2794
2795   (define-key message-mode-map "\C-c\C-u" 'message-insert-or-toggle-importance)
2796   (define-key message-mode-map "\C-c\M-n"
2797     'message-insert-disposition-notification-to)
2798
2799   (define-key message-mode-map "\C-c\C-y" 'message-yank-original)
2800   (define-key message-mode-map "\C-c\M-\C-y" 'message-yank-buffer)
2801   (define-key message-mode-map "\C-c\C-q" 'message-fill-yanked-message)
2802   (define-key message-mode-map "\C-c\C-w" 'message-insert-signature)
2803   (define-key message-mode-map "\C-c\M-h" 'message-insert-headers)
2804   (define-key message-mode-map "\C-c\C-r" 'message-caesar-buffer-body)
2805   (define-key message-mode-map "\C-c\C-o" 'message-sort-headers)
2806   (define-key message-mode-map "\C-c\M-r" 'message-rename-buffer)
2807
2808   (define-key message-mode-map "\C-c\C-c" 'message-send-and-exit)
2809   (define-key message-mode-map "\C-c\C-s" 'message-send)
2810   (define-key message-mode-map "\C-c\C-k" 'message-kill-buffer)
2811   (define-key message-mode-map "\C-c\C-d" 'message-dont-send)
2812   (define-key message-mode-map "\C-c\n" 'gnus-delay-article)
2813
2814   (define-key message-mode-map "\C-c\M-k" 'message-kill-address)
2815   (define-key message-mode-map "\C-c\C-e" 'message-elide-region)
2816   (define-key message-mode-map "\C-c\C-v" 'message-delete-not-region)
2817   (define-key message-mode-map "\C-c\C-z" 'message-kill-to-signature)
2818   (define-key message-mode-map "\M-\r" 'message-newline-and-reformat)
2819   (define-key message-mode-map [remap split-line]  'message-split-line)
2820
2821   (define-key message-mode-map "\C-c\C-a" 'mml-attach-file)
2822
2823   (define-key message-mode-map "\C-a" 'message-beginning-of-line)
2824   (define-key message-mode-map "\t" 'message-tab)
2825
2826   (define-key message-mode-map "\M-n" 'message-display-abbrev))
2827
2828 (easy-menu-define
2829   message-mode-menu message-mode-map "Message Menu."
2830   `("Message"
2831     ["Yank Original" message-yank-original message-reply-buffer]
2832     ["Fill Yanked Message" message-fill-yanked-message t]
2833     ["Insert Signature" message-insert-signature t]
2834     ["Caesar (rot13) Message" message-caesar-buffer-body t]
2835     ["Caesar (rot13) Region" message-caesar-region (message-mark-active-p)]
2836     ["Elide Region" message-elide-region
2837      :active (message-mark-active-p)
2838      ,@(if (featurep 'xemacs) nil
2839          '(:help "Replace text in region with an ellipsis"))]
2840     ["Delete Outside Region" message-delete-not-region
2841      :active (message-mark-active-p)
2842      ,@(if (featurep 'xemacs) nil
2843          '(:help "Delete all quoted text outside region"))]
2844     ["Kill To Signature" message-kill-to-signature t]
2845     ["Newline and Reformat" message-newline-and-reformat t]
2846     ["Rename buffer" message-rename-buffer t]
2847     ["Spellcheck" ispell-message
2848      ,@(if (featurep 'xemacs) '(t)
2849          '(:help "Spellcheck this message"))]
2850     "----"
2851     ["Insert Region Marked" message-mark-inserted-region
2852      :active (message-mark-active-p)
2853      ,@(if (featurep 'xemacs) nil
2854          '(:help "Mark region with enclosing tags"))]
2855     ["Insert File Marked..." message-mark-insert-file
2856      ,@(if (featurep 'xemacs) '(t)
2857          '(:help "Insert file at point marked with enclosing tags"))]
2858     "----"
2859     ["Send Message" message-send-and-exit
2860      ,@(if (featurep 'xemacs) '(t)
2861          '(:help "Send this message"))]
2862     ["Postpone Message" message-dont-send
2863      ,@(if (featurep 'xemacs) '(t)
2864          '(:help "File this draft message and exit"))]
2865     ["Send at Specific Time..." gnus-delay-article
2866      ,@(if (featurep 'xemacs) '(t)
2867          '(:help "Ask, then arrange to send message at that time"))]
2868     ["Kill Message" message-kill-buffer
2869      ,@(if (featurep 'xemacs) '(t)
2870          '(:help "Delete this message without sending"))]
2871     "----"
2872     ["Message manual" message-info
2873      ,@(if (featurep 'xemacs) '(t)
2874          '(:help "Display the Message manual"))]))
2875
2876 (easy-menu-define
2877   message-mode-field-menu message-mode-map ""
2878   `("Field"
2879     ["To" message-goto-to t]
2880     ["From" message-goto-from t]
2881     ["Subject" message-goto-subject t]
2882     ["Change subject..." message-change-subject t]
2883     ["Cc" message-goto-cc t]
2884     ["Bcc" message-goto-bcc t]
2885     ["Fcc" message-goto-fcc t]
2886     ["Reply-To" message-goto-reply-to t]
2887     ["Flag As Important" message-insert-importance-high
2888      ,@(if (featurep 'xemacs) '(t)
2889          '(:help "Mark this message as important"))]
2890     ["Flag As Unimportant" message-insert-importance-low
2891      ,@(if (featurep 'xemacs) '(t)
2892          '(:help "Mark this message as unimportant"))]
2893     ["Request Receipt"
2894      message-insert-disposition-notification-to
2895      ,@(if (featurep 'xemacs) '(t)
2896          '(:help "Request a receipt notification"))]
2897     "----"
2898     ;; (typical) news stuff
2899     ["Summary" message-goto-summary t]
2900     ["Keywords" message-goto-keywords t]
2901     ["Newsgroups" message-goto-newsgroups t]
2902     ["Fetch Newsgroups" message-insert-newsgroups t]
2903     ["Followup-To" message-goto-followup-to t]
2904     ;; ["Followup-To (with note in body)" message-cross-post-followup-to t]
2905     ["Crosspost / Followup-To..." message-cross-post-followup-to t]
2906     ["Distribution" message-goto-distribution t]
2907     ["Expires" message-insert-expires t ]
2908     ["X-No-Archive" message-add-archive-header t ]
2909     "----"
2910     ;; (typical) mailing-lists stuff
2911     ["Fetch To" message-insert-to
2912      ,@(if (featurep 'xemacs) '(t)
2913          '(:help "Insert a To header that points to the author."))]
2914     ["Fetch To and Cc" message-insert-wide-reply
2915      ,@(if (featurep 'xemacs) '(t)
2916          '(:help
2917            "Insert To and Cc headers as if you were doing a wide reply."))]
2918     "----"
2919     ["Send to list only" message-to-list-only t]
2920     ["Mail-Followup-To" message-goto-mail-followup-to t]
2921     ["Unsubscribed list post" message-generate-unsubscribed-mail-followup-to
2922      ,@(if (featurep 'xemacs) '(t)
2923          '(:help "Insert a reasonable `Mail-Followup-To:' header."))]
2924     ["Reduce To: to Cc:" message-reduce-to-to-cc t]
2925     "----"
2926     ["Sort Headers" message-sort-headers t]
2927     ["Encode non-ASCII domain names" message-idna-to-ascii-rhs t]
2928     ;; We hide `message-hidden-headers' by narrowing the buffer.
2929     ["Show Hidden Headers" widen t]
2930     ["Goto Body" message-goto-body t]
2931     ["Goto Signature" message-goto-signature t]))
2932
2933 (defvar message-tool-bar-map nil)
2934
2935 (defvar facemenu-add-face-function)
2936 (defvar facemenu-remove-face-function)
2937
2938 ;;; Forbidden properties
2939 ;;
2940 ;; We use `after-change-functions' to keep special text properties
2941 ;; that interfere with the normal function of message mode out of the
2942 ;; buffer.
2943
2944 (defcustom message-strip-special-text-properties t
2945   "Strip special properties from the message buffer.
2946
2947 Emacs has a number of special text properties which can break message
2948 composing in various ways.  If this option is set, message will strip
2949 these properties from the message composition buffer.  However, some
2950 packages requires these properties to be present in order to work.
2951 If you use one of these packages, turn this option off, and hope the
2952 message composition doesn't break too bad."
2953   :version "22.1"
2954   :group 'message-various
2955   :link '(custom-manual "(message)Various Message Variables")
2956   :type 'boolean)
2957
2958 (defvar message-forbidden-properties
2959   ;; No reason this should be clutter up customize.  We make it a
2960   ;; property list (rather than a list of property symbols), to be
2961   ;; directly useful for `remove-text-properties'.
2962   '(field nil read-only nil invisible nil intangible nil
2963           mouse-face nil modification-hooks nil insert-in-front-hooks nil
2964           insert-behind-hooks nil point-entered nil point-left nil)
2965   ;; Other special properties:
2966   ;; category, face, display: probably doesn't do any harm.
2967   ;; fontified: is used by font-lock.
2968   ;; syntax-table, local-map: I dunno.
2969   ;; We need to add XEmacs names to the list.
2970   "Property list of with properties forbidden in message buffers.
2971 The values of the properties are ignored, only the property names are used.")
2972
2973 (defun message-tamago-not-in-use-p (pos)
2974   "Return t when tamago version 4 is not in use at the cursor position.
2975 Tamago version 4 is a popular input method for writing Japanese text.
2976 It uses the properties `intangible', `invisible', `modification-hooks'
2977 and `read-only' when translating ascii or kana text to kanji text.
2978 These properties are essential to work, so we should never strip them."
2979   (not (and (boundp 'egg-modefull-mode)
2980             (symbol-value 'egg-modefull-mode)
2981             (or (memq (get-text-property pos 'intangible)
2982                       '(its-part-1 its-part-2))
2983                 (get-text-property pos 'egg-end)
2984                 (get-text-property pos 'egg-lang)
2985                 (get-text-property pos 'egg-start)))))
2986
2987 (defsubst message-mail-alias-type-p (type)
2988   (if (atom message-mail-alias-type)
2989       (eq message-mail-alias-type type)
2990     (memq type message-mail-alias-type)))
2991
2992 (defun message-strip-forbidden-properties (begin end &optional old-length)
2993   "Strip forbidden properties between BEGIN and END, ignoring the third arg.
2994 This function is intended to be called from `after-change-functions'.
2995 See also `message-forbidden-properties'."
2996   (when (and (message-mail-alias-type-p 'ecomplete)
2997              (memq this-command message-self-insert-commands))
2998     (message-display-abbrev))
2999   (when (and message-strip-special-text-properties
3000              (message-tamago-not-in-use-p begin))
3001     (let ((buffer-read-only nil)
3002           (inhibit-read-only t))
3003       (remove-text-properties begin end message-forbidden-properties))))
3004
3005 (autoload 'ecomplete-setup "ecomplete") ;; for Emacs <23.
3006
3007 ;;;###autoload
3008 (define-derived-mode message-mode text-mode "Message"
3009   "Major mode for editing mail and news to be sent.
3010 Like Text Mode but with these additional commands:\\<message-mode-map>
3011 C-c C-s  `message-send' (send the message)  C-c C-c  `message-send-and-exit'
3012 C-c C-d  Postpone sending the message       C-c C-k  Kill the message
3013 C-c C-f  move to a header field (and create it if there isn't):
3014          C-c C-f C-t  move to To        C-c C-f C-s  move to Subject
3015          C-c C-f C-c  move to Cc        C-c C-f C-b  move to Bcc
3016          C-c C-f C-w  move to Fcc       C-c C-f C-r  move to Reply-To
3017          C-c C-f C-u  move to Summary   C-c C-f C-n  move to Newsgroups
3018          C-c C-f C-k  move to Keywords  C-c C-f C-d  move to Distribution
3019          C-c C-f C-o  move to From (\"Originator\")
3020          C-c C-f C-f  move to Followup-To
3021          C-c C-f C-m  move to Mail-Followup-To
3022          C-c C-f C-e  move to Expires
3023          C-c C-f C-i  cycle through Importance values
3024          C-c C-f s    change subject and append \"(was: <Old Subject>)\"
3025          C-c C-f x    crossposting with FollowUp-To header and note in body
3026          C-c C-f t    replace To: header with contents of Cc: or Bcc:
3027          C-c C-f a    Insert X-No-Archive: header and a note in the body
3028 C-c C-t  `message-insert-to' (add a To header to a news followup)
3029 C-c C-l  `message-to-list-only' (removes all but list address in to/cc)
3030 C-c C-n  `message-insert-newsgroups' (add a Newsgroup header to a news reply)
3031 C-c C-b  `message-goto-body' (move to beginning of message text).
3032 C-c C-i  `message-goto-signature' (move to the beginning of the signature).
3033 C-c C-w  `message-insert-signature' (insert `message-signature-file' file).
3034 C-c C-y  `message-yank-original' (insert current message, if any).
3035 C-c C-q  `message-fill-yanked-message' (fill what was yanked).
3036 C-c C-e  `message-elide-region' (elide the text between point and mark).
3037 C-c C-v  `message-delete-not-region' (remove the text outside the region).
3038 C-c C-z  `message-kill-to-signature' (kill the text up to the signature).
3039 C-c C-r  `message-caesar-buffer-body' (rot13 the message body).
3040 C-c C-a  `mml-attach-file' (attach a file as MIME).
3041 C-c C-u  `message-insert-or-toggle-importance'  (insert or cycle importance).
3042 C-c M-n  `message-insert-disposition-notification-to'  (request receipt).
3043 C-c M-m  `message-mark-inserted-region' (mark region with enclosing tags).
3044 C-c M-f  `message-mark-insert-file' (insert file marked with enclosing tags).
3045 M-RET    `message-newline-and-reformat' (break the line and reformat)."
3046   (set (make-local-variable 'message-reply-buffer) nil)
3047   (set (make-local-variable 'message-inserted-headers) nil)
3048   (set (make-local-variable 'message-send-actions) nil)
3049   (set (make-local-variable 'message-return-action) nil)
3050   (set (make-local-variable 'message-exit-actions) nil)
3051   (set (make-local-variable 'message-kill-actions) nil)
3052   (set (make-local-variable 'message-postpone-actions) nil)
3053   (set (make-local-variable 'message-draft-article) nil)
3054   (setq buffer-offer-save t)
3055   (set (make-local-variable 'facemenu-add-face-function)
3056        (lambda (face end)
3057          (let ((face-fun (cdr (assq face message-face-alist))))
3058            (if face-fun
3059                (funcall face-fun (point) end)
3060              (error "Face %s not configured for %s mode" face mode-name)))
3061          ""))
3062   (set (make-local-variable 'facemenu-remove-face-function) t)
3063   (set (make-local-variable 'message-reply-headers) nil)
3064   (make-local-variable 'message-newsreader)
3065   (make-local-variable 'message-mailer)
3066   (make-local-variable 'message-post-method)
3067   (set (make-local-variable 'message-sent-message-via) nil)
3068   (set (make-local-variable 'message-checksum) nil)
3069   (set (make-local-variable 'message-mime-part) 0)
3070   (message-setup-fill-variables)
3071   (when message-fill-column
3072     (setq fill-column message-fill-column)
3073     (turn-on-auto-fill))
3074   ;; Allow using comment commands to add/remove quoting.
3075   ;; (set (make-local-variable 'comment-start) message-yank-prefix)
3076   (when message-yank-prefix
3077     (set (make-local-variable 'comment-start) message-yank-prefix)
3078     (set (make-local-variable 'comment-start-skip)
3079          (concat "^" (regexp-quote message-yank-prefix) "[ \t]*")))
3080   (if (featurep 'xemacs)
3081       (message-setup-toolbar)
3082     (set (make-local-variable 'font-lock-defaults)
3083          '(message-font-lock-keywords t))
3084     (if (boundp 'tool-bar-map)
3085         (set (make-local-variable 'tool-bar-map) (message-make-tool-bar))))
3086   (easy-menu-add message-mode-menu message-mode-map)
3087   (easy-menu-add message-mode-field-menu message-mode-map)
3088   (gnus-make-local-hook 'after-change-functions)
3089   ;; Mmmm... Forbidden properties...
3090   (add-hook 'after-change-functions 'message-strip-forbidden-properties
3091             nil 'local)
3092   ;; Allow mail alias things.
3093   (cond
3094    ((message-mail-alias-type-p 'abbrev)
3095     (if (fboundp 'mail-abbrevs-setup)
3096         (mail-abbrevs-setup)
3097       (if (fboundp 'mail-aliases-setup) ; warning avoidance
3098           (mail-aliases-setup))))
3099    ((message-mail-alias-type-p 'ecomplete)
3100     (ecomplete-setup)))
3101   (add-hook 'completion-at-point-functions 'message-completion-function nil t)
3102   (unless buffer-file-name
3103     (message-set-auto-save-file-name))
3104   (unless (buffer-base-buffer)
3105     ;; Don't enable multibyte on an indirect buffer.  Maybe enabling
3106     ;; multibyte is not necessary at all. -- zsh
3107     (mm-enable-multibyte))
3108   (set (make-local-variable 'indent-tabs-mode) nil) ;No tabs for indentation.
3109   (mml-mode))
3110
3111 (defun message-setup-fill-variables ()
3112   "Setup message fill variables."
3113   (set (make-local-variable 'fill-paragraph-function)
3114        'message-fill-paragraph)
3115   (make-local-variable 'paragraph-separate)
3116   (make-local-variable 'paragraph-start)
3117   (make-local-variable 'adaptive-fill-regexp)
3118   (unless (boundp 'adaptive-fill-first-line-regexp)
3119     (setq adaptive-fill-first-line-regexp nil))
3120   (make-local-variable 'adaptive-fill-first-line-regexp)
3121   (let ((quote-prefix-regexp
3122          ;; User should change message-cite-prefix-regexp if
3123          ;; message-yank-prefix is set to an abnormal value.
3124          (concat "\\(" message-cite-prefix-regexp "\\)[ \t]*")))
3125     (setq paragraph-start
3126           (concat
3127            (regexp-quote mail-header-separator) "$\\|"
3128            "[ \t]*$\\|"                 ; blank lines
3129            "-- $\\|"                    ; signature delimiter
3130            "---+$\\|"              ; delimiters for forwarded messages
3131            page-delimiter "$\\|"        ; spoiler warnings
3132            ".*wrote:$\\|"               ; attribution lines
3133            quote-prefix-regexp "$\\|"   ; empty lines in quoted text
3134                                         ; mml tags
3135            "<#!*/?\\(multipart\\|part\\|external\\|mml\\|secure\\)"))
3136     (setq paragraph-separate paragraph-start)
3137     (setq adaptive-fill-regexp
3138           (concat quote-prefix-regexp "\\|" adaptive-fill-regexp))
3139     (setq adaptive-fill-first-line-regexp
3140           (concat quote-prefix-regexp "\\|"
3141                   adaptive-fill-first-line-regexp)))
3142   (make-local-variable 'auto-fill-inhibit-regexp)
3143   ;;(setq auto-fill-inhibit-regexp "^[A-Z][^: \n\t]+:")
3144   (setq auto-fill-inhibit-regexp nil)
3145   (make-local-variable 'normal-auto-fill-function)
3146   (setq normal-auto-fill-function 'message-do-auto-fill)
3147   ;; KLUDGE: auto fill might already be turned on in `text-mode-hook'.
3148   ;; In that case, ensure that it uses the right function.  The real
3149   ;; solution would be not to use `define-derived-mode', and run
3150   ;; `text-mode-hook' ourself at the end of the mode.
3151   ;; -- Per Abrahamsen <abraham@dina.kvl.dk> Date: 2001-10-19.
3152   ;; This kludge is unneeded in Emacs>=21 since define-derived-mode is
3153   ;; now careful to run parent hooks after the body.  --Stef
3154   (when auto-fill-function
3155     (setq auto-fill-function normal-auto-fill-function)))
3156
3157 \f
3158
3159 ;;;
3160 ;;; Message mode commands
3161 ;;;
3162
3163 ;;; Movement commands
3164
3165 (defun message-goto-to ()
3166   "Move point to the To header."
3167   (interactive)
3168   (push-mark)
3169   (message-position-on-field "To"))
3170
3171 (defun message-goto-from ()
3172   "Move point to the From header."
3173   (interactive)
3174   (push-mark)
3175   (message-position-on-field "From"))
3176
3177 (defun message-goto-subject ()
3178   "Move point to the Subject header."
3179   (interactive)
3180   (push-mark)
3181   (message-position-on-field "Subject"))
3182
3183 (defun message-goto-cc ()
3184   "Move point to the Cc header."
3185   (interactive)
3186   (push-mark)
3187   (message-position-on-field "Cc" "To"))
3188
3189 (defun message-goto-bcc ()
3190   "Move point to the Bcc  header."
3191   (interactive)
3192   (push-mark)
3193   (message-position-on-field "Bcc" "Cc" "To"))
3194
3195 (defun message-goto-fcc ()
3196   "Move point to the Fcc header."
3197   (interactive)
3198   (push-mark)
3199   (message-position-on-field "Fcc" "To" "Newsgroups"))
3200
3201 (defun message-goto-reply-to ()
3202   "Move point to the Reply-To header."
3203   (interactive)
3204   (push-mark)
3205   (message-position-on-field "Reply-To" "Subject"))
3206
3207 (defun message-goto-newsgroups ()
3208   "Move point to the Newsgroups header."
3209   (interactive)
3210   (push-mark)
3211   (message-position-on-field "Newsgroups"))
3212
3213 (defun message-goto-distribution ()
3214   "Move point to the Distribution header."
3215   (interactive)
3216   (push-mark)
3217   (message-position-on-field "Distribution"))
3218
3219 (defun message-goto-followup-to ()
3220   "Move point to the Followup-To header."
3221   (interactive)
3222   (push-mark)
3223   (message-position-on-field "Followup-To" "Newsgroups"))
3224
3225 (defun message-goto-mail-followup-to ()
3226   "Move point to the Mail-Followup-To header."
3227   (interactive)
3228   (push-mark)
3229   (message-position-on-field "Mail-Followup-To" "To"))
3230
3231 (defun message-goto-keywords ()
3232   "Move point to the Keywords header."
3233   (interactive)
3234   (push-mark)
3235   (message-position-on-field "Keywords" "Subject"))
3236
3237 (defun message-goto-summary ()
3238   "Move point to the Summary header."
3239   (interactive)
3240   (push-mark)
3241   (message-position-on-field "Summary" "Subject"))
3242
3243 (defun message-goto-body ()
3244   "Move point to the beginning of the message body."
3245   (interactive)
3246   (when (and (gmm-called-interactively-p 'any)
3247              (looking-at "[ \t]*\n"))
3248     (expand-abbrev))
3249   (push-mark)
3250   (goto-char (point-min))
3251   (or (search-forward (concat "\n" mail-header-separator "\n") nil t)
3252       (search-forward-regexp "[^:]+:\\([^\n]\\|\n[ \t]\\)+\n\n" nil t)))
3253
3254 (defun message-in-body-p ()
3255   "Return t if point is in the message body."
3256   (>= (point)
3257       (save-excursion
3258         (goto-char (point-min))
3259         (or (search-forward (concat "\n" mail-header-separator "\n") nil t)
3260             (search-forward-regexp "[^:]+:\\([^\n]\\|\n[ \t]\\)+\n\n" nil t))
3261         (point))))
3262
3263 (defun message-goto-eoh ()
3264   "Move point to the end of the headers."
3265   (interactive)
3266   (message-goto-body)
3267   (forward-line -1))
3268
3269 (defun message-goto-signature ()
3270   "Move point to the beginning of the message signature.
3271 If there is no signature in the article, go to the end and
3272 return nil."
3273   (interactive)
3274   (push-mark)
3275   (goto-char (point-min))
3276   (if (re-search-forward message-signature-separator nil t)
3277       (forward-line 1)
3278     (goto-char (point-max))
3279     nil))
3280
3281 (defun message-generate-unsubscribed-mail-followup-to (&optional include-cc)
3282   "Insert a reasonable MFT header in a post to an unsubscribed list.
3283 When making original posts to a mailing list you are not subscribed to,
3284 you have to type in a MFT header by hand.  The contents, usually, are
3285 the addresses of the list and your own address.  This function inserts
3286 such a header automatically.  It fetches the contents of the To: header
3287 in the current mail buffer, and appends the current `user-mail-address'.
3288
3289 If the optional argument INCLUDE-CC is non-nil, the addresses in the
3290 Cc: header are also put into the MFT."
3291
3292   (interactive "P")
3293   (let* (cc tos)
3294     (save-restriction
3295       (message-narrow-to-headers)
3296       (message-remove-header "Mail-Followup-To")
3297       (setq cc (and include-cc (message-fetch-field "Cc")))
3298       (setq tos (if cc
3299                     (concat (message-fetch-field "To") "," cc)
3300                   (message-fetch-field "To"))))
3301     (message-goto-mail-followup-to)
3302     (insert (concat tos ", " user-mail-address))))
3303
3304 \f
3305
3306 (defun message-insert-to (&optional force)
3307   "Insert a To header that points to the author of the article being replied to.
3308 If the original author requested not to be sent mail, don't insert unless the
3309 prefix FORCE is given."
3310   (interactive "P")
3311   (let* ((mct (message-fetch-reply-field "mail-copies-to"))
3312          (dont (and mct (or (equal (downcase mct) "never")
3313                             (equal (downcase mct) "nobody"))))
3314          (to (or (message-fetch-reply-field "mail-reply-to")
3315                  (message-fetch-reply-field "reply-to")
3316                  (message-fetch-reply-field "from"))))
3317     (when (and dont to)
3318       (message
3319        (if force
3320            "Ignoring the user request not to have copies sent via mail"
3321          "Complying with the user request not to have copies sent via mail")))
3322     (when (and force (not to))
3323       (error "No mail address in the article"))
3324     (when (and to (or force (not dont)))
3325       (message-carefully-insert-headers (list (cons 'To to))))))
3326
3327 (defun message-insert-wide-reply ()
3328   "Insert To and Cc headers as if you were doing a wide reply."
3329   (interactive)
3330   (let ((headers (message-with-reply-buffer
3331                    (message-get-reply-headers t))))
3332     (message-carefully-insert-headers headers)))
3333
3334 (defcustom message-header-synonyms
3335   '((To Cc Bcc)
3336     (Original-To))
3337   "List of lists of header synonyms.
3338 E.g., if this list contains a member list with elements `Cc' and `To',
3339 then `message-carefully-insert-headers' will not insert a `To' header
3340 when the message is already `Cc'ed to the recipient."
3341   :version "22.1"
3342   :group 'message-headers
3343   :link '(custom-manual "(message)Message Headers")
3344   :type '(repeat sexp))
3345
3346 (defun message-carefully-insert-headers (headers)
3347   "Insert the HEADERS, an alist, into the message buffer.
3348 Does not insert the headers when they are already present there
3349 or in the synonym headers, defined by `message-header-synonyms'."
3350   ;; FIXME: Should compare only the address and not the full name.  Comparison
3351   ;; should be done case-folded (and with `string=' rather than
3352   ;; `string-match').
3353   ;; (mail-strip-quoted-names "Foo Bar <foo@bar>, bla@fasel (Bla Fasel)")
3354   (dolist (header headers)
3355     (let* ((header-name (symbol-name (car header)))
3356            (new-header (cdr header))
3357            (synonyms (loop for synonym in message-header-synonyms
3358                            when (memq (car header) synonym) return synonym))
3359            (old-header
3360             (loop for synonym in synonyms
3361                   for old-header = (mail-fetch-field (symbol-name synonym))
3362                   when (and old-header (string-match new-header old-header))
3363                   return synonym)))
3364       (if old-header
3365           (message "already have `%s' in `%s'" new-header old-header)
3366         (when (and (message-position-on-field header-name)
3367                    (setq old-header (mail-fetch-field header-name))
3368                    (not (string-match "\\` *\\'" old-header)))
3369           (insert ", "))
3370         (insert new-header)))))
3371
3372 (defun message-widen-reply ()
3373   "Widen the reply to include maximum recipients."
3374   (interactive)
3375   (let ((follow-to
3376          (and (bufferp message-reply-buffer)
3377               (buffer-name message-reply-buffer)
3378               (with-current-buffer message-reply-buffer
3379                 (message-get-reply-headers t)))))
3380     (save-excursion
3381       (save-restriction
3382         (message-narrow-to-headers)
3383         (dolist (elem follow-to)
3384           (message-remove-header (symbol-name (car elem)))
3385           (goto-char (point-min))
3386           (insert (symbol-name (car elem)) ": "
3387                   (cdr elem) "\n"))))))
3388
3389 (defun message-insert-newsgroups ()
3390   "Insert the Newsgroups header from the article being replied to."
3391   (interactive)
3392   (let ((old-newsgroups (mail-fetch-field "newsgroups"))
3393         (new-newsgroups (message-fetch-reply-field "newsgroups"))
3394         (first t)
3395         insert-newsgroups)
3396     (message-position-on-field "Newsgroups")
3397     (cond
3398      ((not new-newsgroups)
3399       (error "No Newsgroups to insert"))
3400      ((not old-newsgroups)
3401       (insert new-newsgroups))
3402      (t
3403       (setq new-newsgroups (split-string new-newsgroups "[, ]+")
3404             old-newsgroups (split-string old-newsgroups "[, ]+"))
3405       (dolist (group new-newsgroups)
3406         (unless (member group old-newsgroups)
3407           (push group insert-newsgroups)))
3408       (if (null insert-newsgroups)
3409           (error "Newgroup%s already in the header"
3410                  (if (> (length new-newsgroups) 1)
3411                      "s" ""))
3412         (when old-newsgroups
3413           (setq first nil))
3414         (dolist (group insert-newsgroups)
3415           (unless first
3416             (insert ","))
3417           (setq first nil)
3418           (insert group)))))))
3419
3420 \f
3421
3422 ;;; Various commands
3423
3424 (defun message-delete-not-region (beg end)
3425   "Delete everything in the body of the current message outside of the region."
3426   (interactive "r")
3427   (let (citeprefix)
3428     (save-excursion
3429       (goto-char beg)
3430       ;; snarf citation prefix, if appropriate
3431       (unless (eq (point) (progn (beginning-of-line) (point)))
3432         (when (looking-at message-cite-prefix-regexp)
3433           (setq citeprefix (match-string 0))))
3434       (goto-char end)
3435       (delete-region (point) (if (not (message-goto-signature))
3436                                  (point)
3437                                (forward-line -2)
3438                                (point)))
3439       (insert "\n")
3440       (goto-char beg)
3441       (delete-region beg (progn (message-goto-body)
3442                                 (forward-line 2)
3443                                 (point)))
3444       (when citeprefix
3445         (insert citeprefix))))
3446   (when (message-goto-signature)
3447     (forward-line -2)))
3448
3449 (defun message-kill-to-signature (&optional arg)
3450   "Kill all text up to the signature.
3451 If a numeric argument or prefix arg is given, leave that number
3452 of lines before the signature intact."
3453   (interactive "P")
3454   (save-excursion
3455     (save-restriction
3456       (let ((point (point)))
3457         (narrow-to-region point (point-max))
3458         (message-goto-signature)
3459         (unless (eobp)
3460           (if (and arg (numberp arg))
3461               (forward-line (- -1 arg))
3462             (end-of-line -1)))
3463         (unless (= point (point))
3464           (kill-region point (point))
3465           (unless (bolp)
3466             (insert "\n")))))))
3467
3468 (defun message-newline-and-reformat (&optional arg not-break)
3469   "Insert four newlines, and then reformat if inside quoted text.
3470 Prefix arg means justify as well."
3471   (interactive (list (if current-prefix-arg 'full)))
3472   (let (quoted point beg end leading-space bolp fill-paragraph-function)
3473     (setq point (point))
3474     (beginning-of-line)
3475     (setq beg (point))
3476     (setq bolp (= beg point))
3477     ;; Find first line of the paragraph.
3478     (if not-break
3479         (while (and (not (eobp))
3480                     (not (looking-at message-cite-prefix-regexp))
3481                     (looking-at paragraph-start))
3482           (forward-line 1)))
3483     ;; Find the prefix
3484     (when (looking-at message-cite-prefix-regexp)
3485       (setq quoted (match-string 0))
3486       (goto-char (match-end 0))
3487       (looking-at "[ \t]*")
3488       (setq leading-space (match-string 0)))
3489     (if (and quoted
3490              (not not-break)
3491              (not bolp)
3492              (< (- point beg) (length quoted)))
3493         ;; break inside the cite prefix.
3494         (setq quoted nil
3495               end nil))
3496     (if quoted
3497         (progn
3498           (forward-line 1)
3499           (while (and (not (eobp))
3500                       (not (looking-at paragraph-separate))
3501                       (looking-at message-cite-prefix-regexp)
3502                       (equal quoted (match-string 0)))
3503             (goto-char (match-end 0))
3504             (looking-at "[ \t]*")
3505             (if (> (length leading-space) (length (match-string 0)))
3506                 (setq leading-space (match-string 0)))
3507             (forward-line 1))
3508           (setq end (point))
3509           (goto-char beg)
3510           (while (and (if (bobp) nil (forward-line -1) t)
3511                       (not (looking-at paragraph-start))
3512                       (looking-at message-cite-prefix-regexp)
3513                       (equal quoted (match-string 0)))
3514             (setq beg (point))
3515             (goto-char (match-end 0))
3516             (looking-at "[ \t]*")
3517             (if (> (length leading-space) (length (match-string 0)))
3518                 (setq leading-space (match-string 0)))))
3519       (while (and (not (eobp))
3520                   (not (looking-at paragraph-separate))
3521                   (not (looking-at message-cite-prefix-regexp)))
3522         (forward-line 1))
3523       (setq end (point))
3524       (goto-char beg)
3525       (while (and (if (bobp) nil (forward-line -1) t)
3526                   (not (looking-at paragraph-start))
3527                   (not (looking-at message-cite-prefix-regexp)))
3528         (setq beg (point))))
3529     (goto-char point)
3530     (save-restriction
3531       (narrow-to-region beg end)
3532       (if not-break
3533           (setq point nil)
3534         (if bolp
3535             (newline)
3536           (newline)
3537           (newline))
3538         (setq point (point))
3539         ;; (newline 2) doesn't mark both newline's as hard, so call
3540         ;; newline twice. -jas
3541         (newline)
3542         (newline)
3543         (delete-region (point) (re-search-forward "[ \t]*"))
3544         (when (and quoted (not bolp))
3545           (insert quoted leading-space)))
3546       (undo-boundary)
3547       (if quoted
3548           (let* ((adaptive-fill-regexp
3549                   (regexp-quote (concat quoted leading-space)))
3550                  (adaptive-fill-first-line-regexp
3551                   adaptive-fill-regexp ))
3552             (fill-paragraph arg))
3553         (fill-paragraph arg))
3554       (if point (goto-char point)))))
3555
3556 (defun message-fill-paragraph (&optional arg)
3557   "Message specific function to fill a paragraph.
3558 This function is used as the value of `fill-paragraph-function' in
3559 Message buffers and is not meant to be called directly."
3560   (interactive (list (if current-prefix-arg 'full)))
3561   (if (if (boundp 'filladapt-mode) filladapt-mode)
3562       nil
3563     (if (message-point-in-header-p)
3564         (message-fill-field)
3565       (message-newline-and-reformat arg t))
3566     t))
3567
3568 (defun message-point-in-header-p ()
3569   "Return t if point is in the header."
3570   (save-excursion
3571     (and
3572      (not
3573       (re-search-backward
3574        (concat "^" (regexp-quote mail-header-separator) "\n") nil t))
3575      (re-search-forward
3576       (concat "^" (regexp-quote mail-header-separator) "\n") nil t))))
3577
3578 (defun message-do-auto-fill ()
3579   "Like `do-auto-fill', but don't fill in message header."
3580   (unless (message-point-in-header-p)
3581     (do-auto-fill)))
3582
3583 (defun message-insert-signature (&optional force)
3584   "Insert a signature.  See documentation for variable `message-signature'."
3585   (interactive (list 0))
3586   (let* ((signature
3587           (cond
3588            ((and (null message-signature)
3589                  (eq force 0))
3590             (save-excursion
3591               (goto-char (point-max))
3592               (not (re-search-backward message-signature-separator nil t))))
3593            ((and (null message-signature)
3594                  force)
3595             t)
3596            ((functionp message-signature)
3597             (funcall message-signature))
3598            ((listp message-signature)
3599             (eval message-signature))
3600            (t message-signature)))
3601          signature-file)
3602     (setq signature
3603           (cond ((stringp signature)
3604                  signature)
3605                 ((and (eq t signature) message-signature-file)
3606                  (setq signature-file
3607                        (if (and message-signature-directory
3608                                 ;; don't actually use the signature directory
3609                                 ;; if message-signature-file contains a path.
3610                                 (not (file-name-directory
3611                                       message-signature-file)))
3612                            (expand-file-name message-signature-file
3613                                              message-signature-directory)
3614                          message-signature-file))
3615                  (file-exists-p signature-file))))
3616     (when signature
3617       (goto-char (point-max))
3618       ;; Insert the signature.
3619       (unless (bolp)
3620         (newline))
3621       (when message-signature-insert-empty-line
3622         (newline))
3623       (insert "-- ")
3624       (newline)
3625       (if (eq signature t)
3626           (insert-file-contents signature-file)
3627         (insert signature))
3628       (goto-char (point-max))
3629       (or (bolp) (newline)))))
3630
3631 (defun message-insert-importance-high ()
3632   "Insert header to mark message as important."
3633   (interactive)
3634   (save-excursion
3635     (save-restriction
3636       (message-narrow-to-headers)
3637       (message-remove-header "Importance"))
3638     (message-goto-eoh)
3639     (insert "Importance: high\n")))
3640
3641 (defun message-insert-importance-low ()
3642   "Insert header to mark message as unimportant."
3643   (interactive)
3644   (save-excursion
3645     (save-restriction
3646       (message-narrow-to-headers)
3647       (message-remove-header "Importance"))
3648     (message-goto-eoh)
3649     (insert "Importance: low\n")))
3650
3651 (defun message-insert-or-toggle-importance ()
3652   "Insert a \"Importance: high\" header, or cycle through the header values.
3653 The three allowed values according to RFC 1327 are `high', `normal'
3654 and `low'."
3655   (interactive)
3656   (save-excursion
3657     (let ((new "high")
3658           cur)
3659       (save-restriction
3660         (message-narrow-to-headers)
3661         (when (setq cur (message-fetch-field "Importance"))
3662           (message-remove-header "Importance")
3663           (setq new (cond ((string= cur "high")
3664                            "low")
3665                           ((string= cur "low")
3666                            "normal")
3667                           (t
3668                            "high")))))
3669       (message-goto-eoh)
3670       (insert (format "Importance: %s\n" new)))))
3671
3672 (defun message-insert-disposition-notification-to ()
3673   "Request a disposition notification (return receipt) to this message.
3674 Note that this should not be used in newsgroups."
3675   (interactive)
3676   (save-excursion
3677     (save-restriction
3678       (message-narrow-to-headers)
3679       (message-remove-header "Disposition-Notification-To"))
3680     (message-goto-eoh)
3681     (insert (format "Disposition-Notification-To: %s\n"
3682                     (or (message-field-value "Reply-to")
3683                         (message-field-value "From")
3684                         (message-make-from))))))
3685
3686 (defun message-elide-region (b e)
3687   "Elide the text in the region.
3688 An ellipsis (from `message-elide-ellipsis') will be inserted where the
3689 text was killed."
3690   (interactive "r")
3691   (let ((lines (count-lines b e))
3692         (chars (- e b)))
3693     (kill-region b e)
3694     (insert (format-spec message-elide-ellipsis
3695                          `((?l . ,lines)
3696                            (?c . ,chars))))))
3697
3698 (defvar message-caesar-translation-table nil)
3699
3700 (defun message-caesar-region (b e &optional n)
3701   "Caesar rotate region B to E by N, default 13, for decrypting netnews."
3702   (interactive
3703    (list
3704     (min (point) (or (mark t) (point)))
3705     (max (point) (or (mark t) (point)))
3706     (when current-prefix-arg
3707       (prefix-numeric-value current-prefix-arg))))
3708
3709   (setq n (if (numberp n) (mod n 26) 13)) ;canonize N
3710   (unless (or (zerop n)                 ; no action needed for a rot of 0
3711               (= b e))                  ; no region to rotate
3712     ;; We build the table, if necessary.
3713     (when (or (not message-caesar-translation-table)
3714               (/= (aref message-caesar-translation-table ?a) (+ ?a n)))
3715       (setq message-caesar-translation-table
3716             (message-make-caesar-translation-table n)))
3717     (translate-region b e message-caesar-translation-table)))
3718
3719 (defun message-make-caesar-translation-table (n)
3720   "Create a rot table with offset N."
3721   (let ((i -1)
3722         (table (make-string 256 0)))
3723     (while (< (incf i) 256)
3724       (aset table i i))
3725     (concat
3726      (substring table 0 ?A)
3727      (substring table (+ ?A n) (+ ?A n (- 26 n)))
3728      (substring table ?A (+ ?A n))
3729      (substring table (+ ?A 26) ?a)
3730      (substring table (+ ?a n) (+ ?a n (- 26 n)))
3731      (substring table ?a (+ ?a n))
3732      (substring table (+ ?a 26) 255))))
3733
3734 (defun message-caesar-buffer-body (&optional rotnum wide)
3735   "Caesar rotate all letters in the current buffer by 13 places.
3736 Used to encode/decode possibly offensive messages (commonly in rec.humor).
3737 With prefix arg, specifies the number of places to rotate each letter forward.
3738 Mail and USENET news headers are not rotated unless WIDE is non-nil."
3739   (interactive (if current-prefix-arg
3740                    (list (prefix-numeric-value current-prefix-arg))
3741                  (list nil)))
3742   (save-excursion
3743     (save-restriction
3744       (when (and (not wide) (message-goto-body))
3745         (narrow-to-region (point) (point-max)))
3746       (message-caesar-region (point-min) (point-max) rotnum))))
3747
3748 (defun message-pipe-buffer-body (program)
3749   "Pipe the message body in the current buffer through PROGRAM."
3750   (save-excursion
3751     (save-restriction
3752       (when (message-goto-body)
3753         (narrow-to-region (point) (point-max)))
3754       (shell-command-on-region
3755 &nb