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