Testing cvslog.
[gnus] / lisp / message.el
1 ;;; message.el --- composing mail and news messages
2 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001
3 ;;        Free Software Foundation, Inc.
4
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: mail, news
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Commentary:
26
27 ;; This mode provides mail-sending facilities from within Emacs.  It
28 ;; consists mainly of large chunks of code from the sendmail.el,
29 ;; gnus-msg.el and rnewspost.el files.
30
31 ;;; Code:
32
33 (eval-when-compile
34   (require 'cl)
35   (defvar gnus-list-identifiers)) ; gnus-sum is required where necessary
36 (require 'canlock)
37 (require 'mailheader)
38 (require 'nnheader)
39 ;; This is apparently necessary even though things are autoloaded:
40 (if (featurep 'xemacs)
41     (require 'mail-abbrevs))
42 (require 'mail-parse)
43 (require 'mml)
44 (require 'rfc822)
45 (eval-and-compile
46   (autoload 'sha1 "sha1-el"))
47
48 (defgroup message '((user-mail-address custom-variable)
49                     (user-full-name custom-variable))
50   "Mail and news message composing."
51   :link '(custom-manual "(message)Top")
52   :group 'mail
53   :group 'news)
54
55 (put 'user-mail-address 'custom-type 'string)
56 (put 'user-full-name 'custom-type 'string)
57
58 (defgroup message-various nil
59   "Various Message Variables"
60   :link '(custom-manual "(message)Various Message Variables")
61   :group 'message)
62
63 (defgroup message-buffers nil
64   "Message Buffers"
65   :link '(custom-manual "(message)Message Buffers")
66   :group 'message)
67
68 (defgroup message-sending nil
69   "Message Sending"
70   :link '(custom-manual "(message)Sending Variables")
71   :group 'message)
72
73 (defgroup message-interface nil
74   "Message Interface"
75   :link '(custom-manual "(message)Interface")
76   :group 'message)
77
78 (defgroup message-forwarding nil
79   "Message Forwarding"
80   :link '(custom-manual "(message)Forwarding")
81   :group 'message-interface)
82
83 (defgroup message-insertion nil
84   "Message Insertion"
85   :link '(custom-manual "(message)Insertion")
86   :group 'message)
87
88 (defgroup message-headers nil
89   "Message Headers"
90   :link '(custom-manual "(message)Message Headers")
91   :group 'message)
92
93 (defgroup message-news nil
94   "Composing News Messages"
95   :group 'message)
96
97 (defgroup message-mail nil
98   "Composing Mail Messages"
99   :group 'message)
100
101 (defgroup message-faces nil
102   "Faces used for message composing."
103   :group 'message
104   :group 'faces)
105
106 (defcustom message-directory "~/Mail/"
107   "*Directory from which all other mail file variables are derived."
108   :group 'message-various
109   :type 'directory)
110
111 (defcustom message-max-buffers 10
112   "*How many buffers to keep before starting to kill them off."
113   :group 'message-buffers
114   :type 'integer)
115
116 (defcustom message-send-rename-function nil
117   "Function called to rename the buffer after sending it."
118   :group 'message-buffers
119   :type '(choice function (const nil)))
120
121 (defcustom message-fcc-handler-function 'message-output
122   "*A function called to save outgoing articles.
123 This function will be called with the name of the file to store the
124 article in.  The default function is `message-output' which saves in Unix
125 mailbox format."
126   :type '(radio (function-item message-output)
127                 (function :tag "Other"))
128   :group 'message-sending)
129
130 (defcustom message-courtesy-message
131   "The following message is a courtesy copy of an article\nthat has been posted to %s as well.\n\n"
132   "*This is inserted at the start of a mailed copy of a posted message.
133 If the string contains the format spec \"%s\", the Newsgroups
134 the article has been posted to will be inserted there.
135 If this variable is nil, no such courtesy message will be added."
136   :group 'message-sending
137   :type 'string)
138
139 (defcustom message-ignored-bounced-headers "^\\(Received\\|Return-Path\\):"
140   "*Regexp that matches headers to be removed in resent bounced mail."
141   :group 'message-interface
142   :type 'regexp)
143
144 ;;;###autoload
145 (defcustom message-from-style 'default
146   "*Specifies how \"From\" headers look.
147
148 If nil, they contain just the return address like:
149         king@grassland.com
150 If `parens', they look like:
151         king@grassland.com (Elvis Parsley)
152 If `angles', they look like:
153         Elvis Parsley <king@grassland.com>
154
155 Otherwise, most addresses look like `angles', but they look like
156 `parens' if `angles' would need quoting and `parens' would not."
157   :type '(choice (const :tag "simple" nil)
158                  (const parens)
159                  (const angles)
160                  (const default))
161   :group 'message-headers)
162
163 (defcustom message-syntax-checks nil
164   ;; Guess this one shouldn't be easy to customize...
165   "*Controls what syntax checks should not be performed on outgoing posts.
166 To disable checking of long signatures, for instance, add
167  `(signature . disabled)' to this list.
168
169 Don't touch this variable unless you really know what you're doing.
170
171 Checks include `subject-cmsg', `multiple-headers', `sendsys',
172 `message-id', `from', `long-lines', `control-chars', `size',
173 `new-text', `quoting-style', `redirected-followup', `signature',
174 `approved', `sender', `empty', `empty-headers', `message-id', `from',
175 `subject', `shorten-followup-to', `existing-newsgroups',
176 `buffer-file-name', `unchanged', `newsgroups', `reply-to'."
177   :group 'message-news
178   :type '(repeat sexp))                 ; Fixme: improve this
179
180 (defcustom message-required-news-headers
181   '(From Newsgroups Subject Date Message-ID
182          (optional . Organization) Lines
183          (optional . User-Agent))
184   "*Headers to be generated or prompted for when posting an article.
185 RFC977 and RFC1036 require From, Date, Newsgroups, Subject,
186 Message-ID.  Organization, Lines, In-Reply-To, Expires, and
187 User-Agent are optional.  If don't you want message to insert some
188 header, remove it from this list."
189   :group 'message-news
190   :group 'message-headers
191   :type '(repeat sexp))
192
193 (defcustom message-required-mail-headers
194   '(From Subject Date (optional . In-Reply-To) Message-ID Lines
195          (optional . User-Agent))
196   "*Headers to be generated or prompted for when mailing a message.
197 It is recommended that From, Date, To, Subject and Message-ID be
198 included.  Organization, Lines and User-Agent are optional."
199   :group 'message-mail
200   :group 'message-headers
201   :type '(repeat sexp))
202
203 (defcustom message-deletable-headers '(Message-ID Date Lines)
204   "Headers to be deleted if they already exist and were generated by message previously."
205   :group 'message-headers
206   :type 'sexp)
207
208 (defcustom message-ignored-news-headers
209   "^NNTP-Posting-Host:\\|^Xref:\\|^[BGF]cc:\\|^Resent-Fcc:\\|^X-Draft-From:"
210   "*Regexp of headers to be removed unconditionally before posting."
211   :group 'message-news
212   :group 'message-headers
213   :type 'regexp)
214
215 (defcustom message-ignored-mail-headers
216   "^[GF]cc:\\|^Resent-Fcc:\\|^Xref:\\|^X-Draft-From:"
217   "*Regexp of headers to be removed unconditionally before mailing."
218   :group 'message-mail
219   :group 'message-headers
220   :type 'regexp)
221
222 (defcustom message-ignored-supersedes-headers "^Path:\\|^Date\\|^NNTP-Posting-Host:\\|^Xref:\\|^Lines:\\|^Received:\\|^X-From-Line:\\|^X-Trace:\\|^X-Complaints-To:\\|Return-Path:\\|^Supersedes:\\|^NNTP-Posting-Date:\\|^X-Trace:\\|^X-Complaints-To:\\|^Cancel-Lock:\\|^Cancel-Key:"
223   "*Header lines matching this regexp will be deleted before posting.
224 It's best to delete old Path and Date headers before posting to avoid
225 any confusion."
226   :group 'message-interface
227   :type 'regexp)
228
229 (defcustom message-subject-re-regexp "^[ \t]*\\([Rr][Ee]:[ \t]*\\)*[ \t]*"
230   "*Regexp matching \"Re: \" in the subject line."
231   :group 'message-various
232   :type 'regexp)
233
234 ;;;###autoload
235 (defcustom message-signature-separator "^-- *$"
236   "Regexp matching the signature separator."
237   :type 'regexp
238   :group 'message-various)
239
240 (defcustom message-elide-ellipsis "\n[...]\n\n"
241   "*The string which is inserted for elided text."
242   :type 'string
243   :group 'message-various)
244
245 (defcustom message-interactive nil
246   "Non-nil means when sending a message wait for and display errors.
247 nil means let mailer mail back a message to report errors."
248   :group 'message-sending
249   :group 'message-mail
250   :type 'boolean)
251
252 (defcustom message-generate-new-buffers 'unique
253   "*Non-nil means create a new message buffer whenever `message-setup' is called.
254 If this is a function, call that function with three parameters:  The type,
255 the to address and the group name.  (Any of these may be nil.)  The function
256 should return the new buffer name."
257   :group 'message-buffers
258   :type '(choice (const :tag "off" nil)
259                  (const :tag "unique" unique)
260                  (const :tag "unsent" unsent)
261                  (function fun)))
262
263 (defcustom message-kill-buffer-on-exit nil
264   "*Non-nil means that the message buffer will be killed after sending a message."
265   :group 'message-buffers
266   :type 'boolean)
267
268 (eval-when-compile
269   (defvar gnus-local-organization))
270 (defcustom message-user-organization
271   (or (and (boundp 'gnus-local-organization)
272            (stringp gnus-local-organization)
273            gnus-local-organization)
274       (getenv "ORGANIZATION")
275       t)
276   "*String to be used as an Organization header.
277 If t, use `message-user-organization-file'."
278   :group 'message-headers
279   :type '(choice string
280                  (const :tag "consult file" t)))
281
282 ;;;###autoload
283 (defcustom message-user-organization-file "/usr/lib/news/organization"
284   "*Local news organization file."
285   :type 'file
286   :group 'message-headers)
287
288 (defcustom message-make-forward-subject-function
289   'message-forward-subject-author-subject
290   "*List of functions called to generate subject headers for forwarded messages.
291 The subject generated by the previous function is passed into each
292 successive function.
293
294 The provided functions are:
295
296 * `message-forward-subject-author-subject' (Source of article (author or
297       newsgroup)), in brackets followed by the subject
298 * `message-forward-subject-fwd' (Subject of article with 'Fwd:' prepended
299       to it."
300   :group 'message-forwarding
301   :type '(radio (function-item message-forward-subject-author-subject)
302                 (function-item message-forward-subject-fwd)
303                 (repeat :tag "List of functions" function)))
304
305 (defcustom message-forward-as-mime t
306   "*If non-nil, forward messages as an inline/rfc822 MIME section.  Otherwise, directly inline the old message in the forwarded message."
307   :version "21.1"
308   :group 'message-forwarding
309   :type 'boolean)
310
311 (defcustom message-forward-show-mml t
312   "*If non-nil, forward messages are shown as mml.  Otherwise, forward messages are unchanged."
313   :version "21.1"
314   :group 'message-forwarding
315   :type 'boolean)
316
317 (defcustom message-forward-before-signature t
318   "*If non-nil, put forwarded message before signature, else after."
319   :group 'message-forwarding
320   :type 'boolean)
321
322 (defcustom message-wash-forwarded-subjects nil
323   "*If non-nil, try to remove as much old cruft as possible from the subject of messages before generating the new subject of a forward."
324   :group 'message-forwarding
325   :type 'boolean)
326
327 (defcustom message-ignored-resent-headers "^Return-receipt\\|^X-Gnus\\|^Gnus-Warning:"
328   "*All headers that match this regexp will be deleted when resending a message."
329   :group 'message-interface
330   :type 'regexp)
331
332 (defcustom message-forward-ignored-headers "^Content-Transfer-Encoding:\\|^X-Gnus"
333   "*All headers that match this regexp will be deleted when forwarding a message."
334   :version "21.1"
335   :group 'message-forwarding
336   :type '(choice (const :tag "None" nil)
337                  regexp))
338
339 (defcustom message-ignored-cited-headers "."
340   "*Delete these headers from the messages you yank."
341   :group 'message-insertion
342   :type 'regexp)
343
344 (defcustom message-cite-prefix-regexp
345   (if (string-match "[[:digit:]]" "1") ;; support POSIX?
346       "\\([ \t]*[-_.[:word:]]+>+\\|[ \t]*[]>»|:}+]\\)+"
347     ;; ?-, ?_ or ?. MUST NOT be in syntax entry w.
348     "\\([ \t]*\\(\\w\\|[-_.]\\)+>+\\|[ \t]*[]>»|:}+]\\)+")
349   "*Regexp matching the longest possible citation prefix on a line."
350   :group 'message-insertion
351   :type 'regexp)
352
353 (defcustom message-cancel-message "I am canceling my own article.\n"
354   "Message to be inserted in the cancel message."
355   :group 'message-interface
356   :type 'string)
357
358 ;; Useful to set in site-init.el
359 ;;;###autoload
360 (defcustom message-send-mail-function 'message-send-mail-with-sendmail
361   "Function to call to send the current buffer as mail.
362 The headers should be delimited by a line whose contents match the
363 variable `mail-header-separator'.
364
365 Valid values include `message-send-mail-with-sendmail' (the default),
366 `message-send-mail-with-mh', `message-send-mail-with-qmail',
367 `smtpmail-send-it' and `feedmail-send-it'.
368
369 See also `send-mail-function'."
370   :type '(radio (function-item message-send-mail-with-sendmail)
371                 (function-item message-send-mail-with-mh)
372                 (function-item message-send-mail-with-qmail)
373                 (function-item smtpmail-send-it)
374                 (function-item feedmail-send-it)
375                 (function :tag "Other"))
376   :group 'message-sending
377   :group 'message-mail)
378
379 (defcustom message-send-news-function 'message-send-news
380   "Function to call to send the current buffer as news.
381 The headers should be delimited by a line whose contents match the
382 variable `mail-header-separator'."
383   :group 'message-sending
384   :group 'message-news
385   :type 'function)
386
387 (defcustom message-reply-to-function nil
388   "If non-nil, function that should return a list of headers.
389 This function should pick out addresses from the To, Cc, and From headers
390 and respond with new To and Cc headers."
391   :group 'message-interface
392   :type '(choice function (const nil)))
393
394 (defcustom message-wide-reply-to-function nil
395   "If non-nil, function that should return a list of headers.
396 This function should pick out addresses from the To, Cc, and From headers
397 and respond with new To and Cc headers."
398   :group 'message-interface
399   :type '(choice function (const nil)))
400
401 (defcustom message-followup-to-function nil
402   "If non-nil, function that should return a list of headers.
403 This function should pick out addresses from the To, Cc, and From headers
404 and respond with new To and Cc headers."
405   :group 'message-interface
406   :type '(choice function (const nil)))
407
408 (defcustom message-use-followup-to 'ask
409   "*Specifies what to do with Followup-To header.
410 If nil, always ignore the header.  If it is t, use its value, but
411 query before using the \"poster\" value.  If it is the symbol `ask',
412 always query the user whether to use the value.  If it is the symbol
413 `use', always use the value."
414   :group 'message-interface
415   :type '(choice (const :tag "ignore" nil)
416                  (const :tag "use & query" t)
417                  (const use)
418                  (const ask)))
419
420 (defcustom message-use-mail-followup-to 'use
421   "*Specifies what to do with Mail-Followup-To header.
422 If nil, always ignore the header.  If it is the symbol `ask', always
423 query the user whether to use the value.  If it is the symbol `use',
424 always use the value."
425   :group 'message-interface
426   :type '(choice (const :tag "ignore" nil)
427                  (const use)
428                  (const ask)))
429
430 (defcustom message-subscribed-address-functions nil
431   "*Specifies functions for determining list subscription.
432 If nil, do not attempt to determine list subscribtion with functions.
433 If non-nil, this variable contains a list of functions which return
434 regular expressions to match lists.  These functions can be used in
435 conjunction with `message-subscribed-regexps' and
436 `message-subscribed-addresses'."
437   :group 'message-interface
438   :type '(repeat sexp))
439
440 (defcustom message-subscribed-address-file nil
441   "*A file containing addresses the user is subscribed to.
442 If nil, do not look at any files to determine list subscriptions.  If
443 non-nil, each line of this file should be a mailing list address."
444   :group 'message-interface
445   :type 'string)
446
447 (defcustom message-subscribed-addresses nil
448   "*Specifies a list of addresses the user is subscribed to.
449 If nil, do not use any predefined list subscriptions.  This list of
450 addresses can be used in conjuction with
451 `message-subscribed-address-functions' and `message-subscribed-regexps'."
452   :group 'message-interface
453   :type '(repeat string))
454
455 (defcustom message-subscribed-regexps nil
456   "*Specifies a list of addresses the user is subscribed to.
457 If nil, do not use any predefined list subscriptions.  This list of
458 regular expressions can be used in conjuction with
459 `message-subscribed-address-functions' and `message-subscribed-addresses'."
460   :group 'message-interface
461   :type '(repeat regexp))
462
463 (defcustom message-allow-no-recipients 'ask
464   "Specifies what to do when there are no recipients other than Gcc/Fcc.
465 If it is the symbol `always', the posting is allowed.  If it is the
466 symbol `never', the posting is not allowed.  If it is the symbol
467 `ask', you are prompted."
468   :group 'message-interface
469   :type '(choice (const always)
470                  (const never)
471                  (const ask)))
472
473 (defcustom message-sendmail-f-is-evil nil
474   "*Non-nil means don't add \"-f username\" to the sendmail command line.
475 Doing so would be even more evil than leaving it out."
476   :group 'message-sending
477   :type 'boolean)
478
479 ;; qmail-related stuff
480 (defcustom message-qmail-inject-program "/var/qmail/bin/qmail-inject"
481   "Location of the qmail-inject program."
482   :group 'message-sending
483   :type 'file)
484
485 (defcustom message-qmail-inject-args nil
486   "Arguments passed to qmail-inject programs.
487 This should be a list of strings, one string for each argument.
488
489 For e.g., if you wish to set the envelope sender address so that bounces
490 go to the right place or to deal with listserv's usage of that address, you
491 might set this variable to '(\"-f\" \"you@some.where\")."
492   :group 'message-sending
493   :type '(repeat string))
494
495 (defvar message-cater-to-broken-inn t
496   "Non-nil means Gnus should not fold the `References' header.
497 Folding `References' makes ancient versions of INN create incorrect
498 NOV lines.")
499
500 (eval-when-compile
501   (defvar gnus-post-method)
502   (defvar gnus-select-method))
503 (defcustom message-post-method
504   (cond ((and (boundp 'gnus-post-method)
505               (listp gnus-post-method)
506               gnus-post-method)
507          gnus-post-method)
508         ((boundp 'gnus-select-method)
509          gnus-select-method)
510         (t '(nnspool "")))
511   "*Method used to post news.
512 Note that when posting from inside Gnus, for instance, this
513 variable isn't used."
514   :group 'message-news
515   :group 'message-sending
516   ;; This should be the `gnus-select-method' widget, but that might
517   ;; create a dependence to `gnus.el'.
518   :type 'sexp)
519
520 (defcustom message-generate-headers-first nil
521   "*If non-nil, generate all required headers before composing.
522 The variables `message-required-news-headers' and
523 `message-required-mail-headers' specify which headers to generate.
524
525 Note that the variable `message-deletable-headers' specifies headers which
526 are to be deleted and then re-generated before sending, so this variable
527 will not have a visible effect for those headers."
528   :group 'message-headers
529   :type 'boolean)
530
531 (defcustom message-setup-hook nil
532   "Normal hook, run each time a new outgoing message is initialized.
533 The function `message-setup' runs this hook."
534   :group 'message-various
535   :type 'hook)
536
537 (defcustom message-cancel-hook nil
538   "Hook run when cancelling articles."
539   :group 'message-various
540   :type 'hook)
541
542 (defcustom message-signature-setup-hook nil
543   "Normal hook, run each time a new outgoing message is initialized.
544 It is run after the headers have been inserted and before
545 the signature is inserted."
546   :group 'message-various
547   :type 'hook)
548
549 (defcustom message-mode-hook nil
550   "Hook run in message mode buffers."
551   :group 'message-various
552   :type 'hook)
553
554 (defcustom message-header-hook nil
555   "Hook run in a message mode buffer narrowed to the headers."
556   :group 'message-various
557   :type 'hook)
558
559 (defcustom message-header-setup-hook nil
560   "Hook called narrowed to the headers when setting up a message buffer."
561   :group 'message-various
562   :type 'hook)
563
564 (defcustom message-minibuffer-local-map
565   (let ((map (make-sparse-keymap 'message-minibuffer-local-map)))
566     (set-keymap-parent map minibuffer-local-map)
567     map)
568   "Keymap for `message-read-from-minibuffer'.")
569
570 ;;;###autoload
571 (defcustom message-citation-line-function 'message-insert-citation-line
572   "*Function called to insert the \"Whomever writes:\" line.
573
574 Note that Gnus provides a feature where the reader can click on
575 `writes:' to hide the cited text.  If you change this line too much,
576 people who read your message will have to change their Gnus
577 configuration.  See the variable `gnus-cite-attribution-suffix'."
578   :type 'function
579   :group 'message-insertion)
580
581 ;;;###autoload
582 (defcustom message-yank-prefix "> "
583   "*Prefix inserted on the lines of yanked messages.
584 Fix `message-cite-prefix-regexp' if it is set to an abnormal value.
585 See also `message-yank-cited-prefix'."
586   :type 'string
587   :group 'message-insertion)
588
589 (defcustom message-yank-cited-prefix ">"
590   "*Prefix inserted on cited or empty lines of yanked messages.
591 Fix `message-cite-prefix-regexp' if it is set to an abnormal value.
592 See also `message-yank-prefix'."
593   :type 'string
594   :group 'message-insertion)
595
596 (defcustom message-indentation-spaces 3
597   "*Number of spaces to insert at the beginning of each cited line.
598 Used by `message-yank-original' via `message-yank-cite'."
599   :group 'message-insertion
600   :type 'integer)
601
602 ;;;###autoload
603 (defcustom message-cite-function 'message-cite-original
604   "*Function for citing an original message.
605 Predefined functions include `message-cite-original' and
606 `message-cite-original-without-signature'.
607 Note that `message-cite-original' uses `mail-citation-hook' if that is non-nil."
608   :type '(radio (function-item message-cite-original)
609                 (function-item message-cite-original-without-signature)
610                 (function-item sc-cite-original)
611                 (function :tag "Other"))
612   :group 'message-insertion)
613
614 ;;;###autoload
615 (defcustom message-indent-citation-function 'message-indent-citation
616   "*Function for modifying a citation just inserted in the mail buffer.
617 This can also be a list of functions.  Each function can find the
618 citation between (point) and (mark t).  And each function should leave
619 point and mark around the citation text as modified."
620   :type 'function
621   :group 'message-insertion)
622
623 (defvar message-abbrevs-loaded nil)
624
625 ;;;###autoload
626 (defcustom message-signature t
627   "*String to be inserted at the end of the message buffer.
628 If t, the `message-signature-file' file will be inserted instead.
629 If a function, the result from the function will be used instead.
630 If a form, the result from the form will be used instead."
631   :type 'sexp
632   :group 'message-insertion)
633
634 ;;;###autoload
635 (defcustom message-signature-file "~/.signature"
636   "*Name of file containing the text inserted at end of message buffer.
637 Ignored if the named file doesn't exist.
638 If nil, don't insert a signature."
639   :type '(choice file (const :tags "None" nil))
640   :group 'message-insertion)
641
642 (defcustom message-distribution-function nil
643   "*Function called to return a Distribution header."
644   :group 'message-news
645   :group 'message-headers
646   :type '(choice function (const nil)))
647
648 (defcustom message-expires 14
649   "Number of days before your article expires."
650   :group 'message-news
651   :group 'message-headers
652   :link '(custom-manual "(message)News Headers")
653   :type 'integer)
654
655 (defcustom message-user-path nil
656   "If nil, use the NNTP server name in the Path header.
657 If stringp, use this; if non-nil, use no host name (user name only)."
658   :group 'message-news
659   :group 'message-headers
660   :link '(custom-manual "(message)News Headers")
661   :type '(choice (const :tag "nntp" nil)
662                  (string :tag "name")
663                  (sexp :tag "none" :format "%t" t)))
664
665 (defvar message-reply-buffer nil)
666 (defvar message-reply-headers nil)
667 (defvar message-newsreader nil)
668 (defvar message-mailer nil)
669 (defvar message-sent-message-via nil)
670 (defvar message-checksum nil)
671 (defvar message-send-actions nil
672   "A list of actions to be performed upon successful sending of a message.")
673 (defvar message-exit-actions nil
674   "A list of actions to be performed upon exiting after sending a message.")
675 (defvar message-kill-actions nil
676   "A list of actions to be performed before killing a message buffer.")
677 (defvar message-postpone-actions nil
678   "A list of actions to be performed after postponing a message.")
679
680 (define-widget 'message-header-lines 'text
681   "All header lines must be LFD terminated."
682   :format "%{%t%}:%n%v"
683   :valid-regexp "^\\'"
684   :error "All header lines must be newline terminated")
685
686 (defcustom message-default-headers ""
687   "*A string containing header lines to be inserted in outgoing messages.
688 It is inserted before you edit the message, so you can edit or delete
689 these lines."
690   :group 'message-headers
691   :type 'message-header-lines)
692
693 (defcustom message-default-mail-headers ""
694   "*A string of header lines to be inserted in outgoing mails."
695   :group 'message-headers
696   :group 'message-mail
697   :type 'message-header-lines)
698
699 (defcustom message-default-news-headers ""
700   "*A string of header lines to be inserted in outgoing news articles."
701   :group 'message-headers
702   :group 'message-news
703   :type 'message-header-lines)
704
705 ;; Note: could use /usr/ucb/mail instead of sendmail;
706 ;; options -t, and -v if not interactive.
707 (defcustom message-mailer-swallows-blank-line
708   (if (and (string-match "sparc-sun-sunos\\(\\'\\|[^5]\\)"
709                          system-configuration)
710            (file-readable-p "/etc/sendmail.cf")
711            (let ((buffer (get-buffer-create " *temp*")))
712              (unwind-protect
713                  (save-excursion
714                    (set-buffer buffer)
715                    (insert-file-contents "/etc/sendmail.cf")
716                    (goto-char (point-min))
717                    (let ((case-fold-search nil))
718                      (re-search-forward "^OR\\>" nil t)))
719                (kill-buffer buffer))))
720       ;; According to RFC822, "The field-name must be composed of printable
721       ;; ASCII characters (i. e., characters that have decimal values between
722       ;; 33 and 126, except colon)", i. e., any chars except ctl chars,
723       ;; space, or colon.
724       '(looking-at "[ \t]\\|[][!\"#$%&'()*+,-./0-9;<=>?@A-Z\\\\^_`a-z{|}~]+:"))
725   "*Set this non-nil if the system's mailer runs the header and body together.
726 \(This problem exists on Sunos 4 when sendmail is run in remote mode.)
727 The value should be an expression to test whether the problem will
728 actually occur."
729   :group 'message-sending
730   :type 'sexp)
731
732 ;;;###autoload
733 (define-mail-user-agent 'message-user-agent
734   'message-mail 'message-send-and-exit
735   'message-kill-buffer 'message-send-hook)
736
737 (defvar message-mh-deletable-headers '(Message-ID Date Lines Sender)
738   "If non-nil, delete the deletable headers before feeding to mh.")
739
740 (defvar message-send-method-alist
741   '((news message-news-p message-send-via-news)
742     (mail message-mail-p message-send-via-mail))
743   "Alist of ways to send outgoing messages.
744 Each element has the form
745
746   \(TYPE PREDICATE FUNCTION)
747
748 where TYPE is a symbol that names the method; PREDICATE is a function
749 called without any parameters to determine whether the message is
750 a message of type TYPE; and FUNCTION is a function to be called if
751 PREDICATE returns non-nil.  FUNCTION is called with one parameter --
752 the prefix.")
753
754 (defcustom message-mail-alias-type 'abbrev
755   "*What alias expansion type to use in Message buffers.
756 The default is `abbrev', which uses mailabbrev.  nil switches
757 mail aliases off."
758   :group 'message
759   :link '(custom-manual "(message)Mail Aliases")
760   :type '(choice (const :tag "Use Mailabbrev" abbrev)
761                  (const :tag "No expansion" nil)))
762
763 (defcustom message-auto-save-directory
764   (file-name-as-directory (nnheader-concat message-directory "drafts"))
765   "*Directory where Message auto-saves buffers if Gnus isn't running.
766 If nil, Message won't auto-save."
767   :group 'message-buffers
768   :type '(choice directory (const :tag "Don't auto-save" nil)))
769
770 (defcustom message-buffer-naming-style 'unique
771   "*The way new message buffers are named.
772 Valid valued are `unique' and `unsent'."
773   :version "21.1"
774   :group 'message-buffers
775   :type '(choice (const :tag "unique" unique)
776                  (const :tag "unsent" unsent)))
777
778 (defcustom message-default-charset
779   (and (not (mm-multibyte-p)) 'iso-8859-1)
780   "Default charset used in non-MULE Emacsen.
781 If nil, you might be asked to input the charset."
782   :version "21.1"
783   :group 'message
784   :type 'symbol)
785
786 (defcustom message-dont-reply-to-names
787   (and (boundp 'rmail-dont-reply-to-names) rmail-dont-reply-to-names)
788   "*A regexp specifying addresses to prune when doing wide replies.
789 A value of nil means exclude your own user name only."
790   :version "21.1"
791   :group 'message
792   :type '(choice (const :tag "Yourself" nil)
793                  regexp))
794
795 (defvar message-shoot-gnksa-feet nil
796   "*A list of GNKSA feet you are allowed to shoot.
797 Gnus gives you all the opportunity you could possibly want for
798 shooting yourself in the foot.  Also, Gnus allows you to shoot the
799 feet of Good Net-Keeping Seal of Approval. The following are foot
800 candidates:
801 `empty-article'     Allow you to post an empty article;
802 `quoted-text-only'  Allow you to post quoted text only;
803 `multiple-copies'   Allow you to post multiple copies.")
804 ;; `cancel-messages'   Allow you to cancel or supersede others' messages.
805
806 (defsubst message-gnksa-enable-p (feature)
807   (or (not (listp message-shoot-gnksa-feet))
808       (memq feature message-shoot-gnksa-feet)))
809
810 ;;; Internal variables.
811 ;;; Well, not really internal.
812
813 (defvar message-mode-syntax-table
814   (let ((table (copy-syntax-table text-mode-syntax-table)))
815     (modify-syntax-entry ?% ". " table)
816     (modify-syntax-entry ?> ". " table)
817     (modify-syntax-entry ?< ". " table)
818     table)
819   "Syntax table used while in Message mode.")
820
821 (defface message-header-to-face
822   '((((class color)
823       (background dark))
824      (:foreground "green2" :bold t))
825     (((class color)
826       (background light))
827      (:foreground "MidnightBlue" :bold t))
828     (t
829      (:bold t :italic t)))
830   "Face used for displaying From headers."
831   :group 'message-faces)
832
833 (defface message-header-cc-face
834   '((((class color)
835       (background dark))
836      (:foreground "green4" :bold t))
837     (((class color)
838       (background light))
839      (:foreground "MidnightBlue"))
840     (t
841      (:bold t)))
842   "Face used for displaying Cc headers."
843   :group 'message-faces)
844
845 (defface message-header-subject-face
846   '((((class color)
847       (background dark))
848      (:foreground "green3"))
849     (((class color)
850       (background light))
851      (:foreground "navy blue" :bold t))
852     (t
853      (:bold t)))
854   "Face used for displaying subject headers."
855   :group 'message-faces)
856
857 (defface message-header-newsgroups-face
858   '((((class color)
859       (background dark))
860      (:foreground "yellow" :bold t :italic t))
861     (((class color)
862       (background light))
863      (:foreground "blue4" :bold t :italic t))
864     (t
865      (:bold t :italic t)))
866   "Face used for displaying newsgroups headers."
867   :group 'message-faces)
868
869 (defface message-header-other-face
870   '((((class color)
871       (background dark))
872      (:foreground "#b00000"))
873     (((class color)
874       (background light))
875      (:foreground "steel blue"))
876     (t
877      (:bold t :italic t)))
878   "Face used for displaying newsgroups headers."
879   :group 'message-faces)
880
881 (defface message-header-name-face
882   '((((class color)
883       (background dark))
884      (:foreground "DarkGreen"))
885     (((class color)
886       (background light))
887      (:foreground "cornflower blue"))
888     (t
889      (:bold t)))
890   "Face used for displaying header names."
891   :group 'message-faces)
892
893 (defface message-header-xheader-face
894   '((((class color)
895       (background dark))
896      (:foreground "blue"))
897     (((class color)
898       (background light))
899      (:foreground "blue"))
900     (t
901      (:bold t)))
902   "Face used for displaying X-Header headers."
903   :group 'message-faces)
904
905 (defface message-separator-face
906   '((((class color)
907       (background dark))
908      (:foreground "blue3"))
909     (((class color)
910       (background light))
911      (:foreground "brown"))
912     (t
913      (:bold t)))
914   "Face used for displaying the separator."
915   :group 'message-faces)
916
917 (defface message-cited-text-face
918   '((((class color)
919       (background dark))
920      (:foreground "red"))
921     (((class color)
922       (background light))
923      (:foreground "red"))
924     (t
925      (:bold t)))
926   "Face used for displaying cited text names."
927   :group 'message-faces)
928
929 (defface message-mml-face
930   '((((class color)
931       (background dark))
932      (:foreground "ForestGreen"))
933     (((class color)
934       (background light))
935      (:foreground "ForestGreen"))
936     (t
937      (:bold t)))
938   "Face used for displaying MML."
939   :group 'message-faces)
940
941 (defvar message-font-lock-keywords
942   (let ((content "[ \t]*\\(.+\\(\n[ \t].*\\)*\\)\n?"))
943     `((,(concat "^\\([Tt]o:\\)" content)
944        (1 'message-header-name-face)
945        (2 'message-header-to-face nil t))
946       (,(concat "^\\(^[GBF]?[Cc][Cc]:\\|^[Rr]eply-[Tt]o:\\)" content)
947        (1 'message-header-name-face)
948        (2 'message-header-cc-face nil t))
949       (,(concat "^\\([Ss]ubject:\\)" content)
950        (1 'message-header-name-face)
951        (2 'message-header-subject-face nil t))
952       (,(concat "^\\([Nn]ewsgroups:\\|Followup-[Tt]o:\\)" content)
953        (1 'message-header-name-face)
954        (2 'message-header-newsgroups-face nil t))
955       (,(concat "^\\([A-Z][^: \n\t]+:\\)" content)
956        (1 'message-header-name-face)
957        (2 'message-header-other-face nil t))
958       (,(concat "^\\(X-[A-Za-z0-9-]+\\|In-Reply-To\\):" content)
959        (1 'message-header-name-face)
960        (2 'message-header-name-face))
961       ,@(if (and mail-header-separator
962                  (not (equal mail-header-separator "")))
963             `((,(concat "^\\(" (regexp-quote mail-header-separator) "\\)$")
964                1 'message-separator-face))
965           nil)
966       (,(concat "^\\(" message-cite-prefix-regexp "\\).*")
967        (0 'message-cited-text-face))
968       ("<#/?\\(multipart\\|part\\|external\\|mml\\).*>"
969        (0 'message-mml-face))))
970   "Additional expressions to highlight in Message mode.")
971
972 ;; XEmacs does it like this.  For Emacs, we have to set the
973 ;; `font-lock-defaults' buffer-local variable.
974 (put 'message-mode 'font-lock-defaults '(message-font-lock-keywords t))
975
976 (defvar message-face-alist
977   '((bold . bold-region)
978     (underline . underline-region)
979     (default . (lambda (b e)
980                  (unbold-region b e)
981                  (ununderline-region b e))))
982   "Alist of mail and news faces for facemenu.
983 The cdr of ech entry is a function for applying the face to a region.")
984
985 (defcustom message-send-hook nil
986   "Hook run before sending messages."
987   :group 'message-various
988   :options '(ispell-message)
989   :type 'hook)
990
991 (defcustom message-send-mail-hook nil
992   "Hook run before sending mail messages."
993   :group 'message-various
994   :type 'hook)
995
996 (defcustom message-send-news-hook nil
997   "Hook run before sending news messages."
998   :group 'message-various
999   :type 'hook)
1000
1001 (defcustom message-sent-hook nil
1002   "Hook run after sending messages."
1003   :group 'message-various
1004   :type 'hook)
1005
1006 (defvar message-send-coding-system 'binary
1007   "Coding system to encode outgoing mail.")
1008
1009 (defvar message-draft-coding-system
1010   mm-auto-save-coding-system
1011   "Coding system to compose mail.")
1012
1013 (defcustom message-send-mail-partially-limit 1000000
1014   "The limitation of messages sent as message/partial.
1015 The lower bound of message size in characters, beyond which the message
1016 should be sent in several parts.  If it is nil, the size is unlimited."
1017   :version "21.1"
1018   :group 'message-buffers
1019   :type '(choice (const :tag "unlimited" nil)
1020                  (integer 1000000)))
1021
1022 (defcustom message-alternative-emails nil
1023   "A regexp to match the alternative email addresses.
1024 The first matched address (not primary one) is used in the From field."
1025   :group 'message-headers
1026   :type '(choice (const :tag "Always use primary" nil)
1027                  regexp))
1028
1029 (defcustom message-mail-user-agent nil
1030   "Like `mail-user-agent'.
1031 Except if it is nil, use Gnus native MUA; if it is t, use
1032 `mail-user-agent'."
1033   :type '(radio (const :tag "Gnus native"
1034                        :format "%t\n"
1035                        nil)
1036                 (const :tag "`mail-user-agent'"
1037                        :format "%t\n"
1038                        t)
1039                 (function-item :tag "Default Emacs mail"
1040                                :format "%t\n"
1041                                sendmail-user-agent)
1042                 (function-item :tag "Emacs interface to MH"
1043                                :format "%t\n"
1044                                mh-e-user-agent)
1045                 (function :tag "Other"))
1046   :version "21.1"
1047   :group 'message)
1048
1049 (defcustom message-wide-reply-confirm-recipients nil
1050   "Whether to confirm a wide reply to multiple email recipients.
1051 If this variable is nil, don't ask whether to reply to all recipients.
1052 If this variable is non-nil, pose the question \"Reply to all
1053 recipients?\" before a wide reply to multiple recipients.  If the user
1054 answers yes, reply to all recipients as usual.  If the user answers
1055 no, only reply back to the author."
1056   :group 'message-headers
1057   :type 'boolean)
1058
1059 (defcustom message-insert-canlock t
1060   "Whether to insert a Cancel-Lock header in news postings."
1061   :group 'message-headers
1062   :type 'boolean)
1063
1064 ;;; Internal variables.
1065
1066 (defvar message-sending-message "Sending...")
1067 (defvar message-buffer-list nil)
1068 (defvar message-this-is-news nil)
1069 (defvar message-this-is-mail nil)
1070 (defvar message-draft-article nil)
1071 (defvar message-mime-part nil)
1072 (defvar message-posting-charset nil)
1073
1074 ;; Byte-compiler warning
1075 (eval-when-compile
1076   (defvar gnus-active-hashtb)
1077   (defvar gnus-read-active-file))
1078
1079 ;;; Regexp matching the delimiter of messages in UNIX mail format
1080 ;;; (UNIX From lines), minus the initial ^.  It should be a copy
1081 ;;; of rmail.el's rmail-unix-mail-delimiter.
1082 (defvar message-unix-mail-delimiter
1083   (let ((time-zone-regexp
1084          (concat "\\([A-Z]?[A-Z]?[A-Z][A-Z]\\( DST\\)?"
1085                  "\\|[-+]?[0-9][0-9][0-9][0-9]"
1086                  "\\|"
1087                  "\\) *")))
1088     (concat
1089      "From "
1090
1091      ;; Many things can happen to an RFC 822 mailbox before it is put into
1092      ;; a `From' line.  The leading phrase can be stripped, e.g.
1093      ;; `Joe <@w.x:joe@y.z>' -> `<@w.x:joe@y.z>'.  The <> can be stripped, e.g.
1094      ;; `<@x.y:joe@y.z>' -> `@x.y:joe@y.z'.  Everything starting with a CRLF
1095      ;; can be removed, e.g.
1096      ;;         From: joe@y.z (Joe      K
1097      ;;                 User)
1098      ;; can yield `From joe@y.z (Joe    K Fri Mar 22 08:11:15 1996', and
1099      ;;         From: Joe User
1100      ;;                 <joe@y.z>
1101      ;; can yield `From Joe User Fri Mar 22 08:11:15 1996'.
1102      ;; The mailbox can be removed or be replaced by white space, e.g.
1103      ;;         From: "Joe User"{space}{tab}
1104      ;;                 <joe@y.z>
1105      ;; can yield `From {space}{tab} Fri Mar 22 08:11:15 1996',
1106      ;; where {space} and {tab} represent the Ascii space and tab characters.
1107      ;; We want to match the results of any of these manglings.
1108      ;; The following regexp rejects names whose first characters are
1109      ;; obviously bogus, but after that anything goes.
1110      "\\([^\0-\b\n-\r\^?].*\\)? "
1111
1112      ;; The time the message was sent.
1113      "\\([^\0-\r \^?]+\\) +"            ; day of the week
1114      "\\([^\0-\r \^?]+\\) +"            ; month
1115      "\\([0-3]?[0-9]\\) +"              ; day of month
1116      "\\([0-2][0-9]:[0-5][0-9]\\(:[0-6][0-9]\\)?\\) *" ; time of day
1117
1118      ;; Perhaps a time zone, specified by an abbreviation, or by a
1119      ;; numeric offset.
1120      time-zone-regexp
1121
1122      ;; The year.
1123      " \\([0-9][0-9]+\\) *"
1124
1125      ;; On some systems the time zone can appear after the year, too.
1126      time-zone-regexp
1127
1128      ;; Old uucp cruft.
1129      "\\(remote from .*\\)?"
1130
1131      "\n"))
1132   "Regexp matching the delimiter of messages in UNIX mail format.")
1133
1134 (defvar message-unsent-separator
1135   (concat "^ *---+ +Unsent message follows +---+ *$\\|"
1136           "^ *---+ +Returned message +---+ *$\\|"
1137           "^Start of returned message$\\|"
1138           "^ *---+ +Original message +---+ *$\\|"
1139           "^ *--+ +begin message +--+ *$\\|"
1140           "^ *---+ +Original message follows +---+ *$\\|"
1141           "^ *---+ +Undelivered message follows +---+ *$\\|"
1142           "^|? *---+ +Message text follows: +---+ *|?$")
1143   "A regexp that matches the separator before the text of a failed message.")
1144
1145 (defvar message-header-format-alist
1146   `((Newsgroups)
1147     (To . message-fill-address)
1148     (Cc . message-fill-address)
1149     (Subject)
1150     (In-Reply-To)
1151     (Fcc)
1152     (Bcc)
1153     (Date)
1154     (Organization)
1155     (Distribution)
1156     (Lines)
1157     (Expires)
1158     (Message-ID)
1159     (References . message-shorten-references)
1160     (User-Agent))
1161   "Alist used for formatting headers.")
1162
1163 (defvar message-options nil
1164   "Some saved answers when sending message.")
1165
1166 (defvar message-send-mail-real-function nil
1167   "Internal send mail function.")
1168
1169 (defvar message-bogus-system-names "^localhost\\."
1170   "The regexp of bogus system names.")
1171
1172 (eval-and-compile
1173   (autoload 'message-setup-toolbar "messagexmas")
1174   (autoload 'mh-new-draft-name "mh-comp")
1175   (autoload 'mh-send-letter "mh-comp")
1176   (autoload 'gnus-point-at-eol "gnus-util")
1177   (autoload 'gnus-point-at-bol "gnus-util")
1178   (autoload 'gnus-output-to-rmail "gnus-util")
1179   (autoload 'gnus-output-to-mail "gnus-util")
1180   (autoload 'mail-abbrev-in-expansion-header-p "mailabbrev")
1181   (autoload 'nndraft-request-associate-buffer "nndraft")
1182   (autoload 'nndraft-request-expire-articles "nndraft")
1183   (autoload 'gnus-open-server "gnus-int")
1184   (autoload 'gnus-request-post "gnus-int")
1185   (autoload 'gnus-alive-p "gnus-util")
1186   (autoload 'gnus-server-string "gnus")
1187   (autoload 'gnus-group-name-charset "gnus-group")
1188   (autoload 'gnus-group-name-decode "gnus-group")
1189   (autoload 'gnus-groups-from-server "gnus")
1190   (autoload 'rmail-output "rmailout"))
1191
1192 \f
1193
1194 ;;;
1195 ;;; Utility functions.
1196 ;;;
1197
1198 (defmacro message-y-or-n-p (question show &rest text)
1199   "Ask QUESTION, displaying remaining args in a temporary buffer if SHOW."
1200   `(message-talkative-question 'y-or-n-p ,question ,show ,@text))
1201
1202 (defmacro message-delete-line (&optional n)
1203   "Delete the current line (and the next N lines)."
1204   `(delete-region (progn (beginning-of-line) (point))
1205                   (progn (forward-line ,(or n 1)) (point))))
1206
1207 (defun message-unquote-tokens (elems)
1208   "Remove double quotes (\") from strings in list ELEMS."
1209   (mapcar (lambda (item)
1210             (while (string-match "^\\(.*\\)\"\\(.*\\)$" item)
1211               (setq item (concat (match-string 1 item)
1212                                  (match-string 2 item))))
1213             item)
1214           elems))
1215
1216 (defun message-tokenize-header (header &optional separator)
1217   "Split HEADER into a list of header elements.
1218 SEPARATOR is a string of characters to be used as separators.  \",\"
1219 is used by default."
1220   (if (not header)
1221       nil
1222     (let ((regexp (format "[%s]+" (or separator ",")))
1223           (beg 1)
1224           (first t)
1225           quoted elems paren)
1226       (save-excursion
1227         (message-set-work-buffer)
1228         (insert header)
1229         (goto-char (point-min))
1230         (while (not (eobp))
1231           (if first
1232               (setq first nil)
1233             (forward-char 1))
1234           (cond ((and (> (point) beg)
1235                       (or (eobp)
1236                           (and (looking-at regexp)
1237                                (not quoted)
1238                                (not paren))))
1239                  (push (buffer-substring beg (point)) elems)
1240                  (setq beg (match-end 0)))
1241                 ((eq (char-after) ?\")
1242                  (setq quoted (not quoted)))
1243                 ((and (eq (char-after) ?\()
1244                       (not quoted))
1245                  (setq paren t))
1246                 ((and (eq (char-after) ?\))
1247                       (not quoted))
1248                  (setq paren nil))))
1249         (nreverse elems)))))
1250
1251 (defun message-mail-file-mbox-p (file)
1252   "Say whether FILE looks like a Unix mbox file."
1253   (when (and (file-exists-p file)
1254              (file-readable-p file)
1255              (file-regular-p file))
1256     (with-temp-buffer
1257       (nnheader-insert-file-contents file)
1258       (goto-char (point-min))
1259       (looking-at message-unix-mail-delimiter))))
1260
1261 (defun message-fetch-field (header &optional not-all)
1262   "The same as `mail-fetch-field', only remove all newlines."
1263   (let* ((inhibit-point-motion-hooks t)
1264          (case-fold-search t)
1265          (value (mail-fetch-field header nil (not not-all))))
1266     (when value
1267       (while (string-match "\n[\t ]+" value)
1268         (setq value (replace-match " " t t value)))
1269       (set-text-properties 0 (length value) nil value)
1270       value)))
1271
1272 (defun message-narrow-to-field ()
1273   "Narrow the buffer to the header on the current line."
1274   (beginning-of-line)
1275   (narrow-to-region
1276    (point)
1277    (progn
1278      (forward-line 1)
1279      (if (re-search-forward "^[^ \n\t]" nil t)
1280          (progn
1281            (beginning-of-line)
1282            (point))
1283        (point-max))))
1284   (goto-char (point-min)))
1285
1286 (defun message-add-header (&rest headers)
1287   "Add the HEADERS to the message header, skipping those already present."
1288   (while headers
1289     (let (hclean)
1290       (unless (string-match "^\\([^:]+\\):[ \t]*[^ \t]" (car headers))
1291         (error "Invalid header `%s'" (car headers)))
1292       (setq hclean (match-string 1 (car headers)))
1293       (save-restriction
1294         (message-narrow-to-headers)
1295         (unless (re-search-forward (concat "^" (regexp-quote hclean) ":") nil t)
1296           (goto-char (point-max))
1297           (if (string-match "\n$" (car headers))
1298               (insert (car headers))
1299             (insert (car headers) ?\n)))))
1300     (setq headers (cdr headers))))
1301
1302
1303 (defun message-fetch-reply-field (header)
1304   "Fetch field HEADER from the message we're replying to."
1305   (when (and message-reply-buffer
1306              (buffer-name message-reply-buffer))
1307     (save-excursion
1308       (set-buffer message-reply-buffer)
1309       (message-fetch-field header))))
1310
1311 (defun message-set-work-buffer ()
1312   (if (get-buffer " *message work*")
1313       (progn
1314         (set-buffer " *message work*")
1315         (erase-buffer))
1316     (set-buffer (get-buffer-create " *message work*"))
1317     (kill-all-local-variables)
1318     (mm-enable-multibyte)))
1319
1320 (defun message-functionp (form)
1321   "Return non-nil if FORM is funcallable."
1322   (or (and (symbolp form) (fboundp form))
1323       (and (listp form) (eq (car form) 'lambda))
1324       (byte-code-function-p form)))
1325
1326 (defun message-strip-list-identifiers (subject)
1327   "Remove list identifiers in `gnus-list-identifiers' from string SUBJECT."
1328   (require 'gnus-sum)                   ; for gnus-list-identifiers
1329   (let ((regexp (if (stringp gnus-list-identifiers)
1330                     gnus-list-identifiers
1331                   (mapconcat 'identity gnus-list-identifiers " *\\|"))))
1332     (if (string-match (concat "\\(\\(\\(Re: +\\)?\\(" regexp
1333                               " *\\)\\)+\\(Re: +\\)?\\)") subject)
1334         (concat (substring subject 0 (match-beginning 1))
1335                 (or (match-string 3 subject)
1336                     (match-string 5 subject))
1337                 (substring subject
1338                            (match-end 1)))
1339       subject)))
1340
1341 (defun message-strip-subject-re (subject)
1342   "Remove \"Re:\" from subject lines in string SUBJECT."
1343   (if (string-match message-subject-re-regexp subject)
1344       (substring subject (match-end 0))
1345     subject))
1346
1347 (defun message-remove-header (header &optional is-regexp first reverse)
1348   "Remove HEADER in the narrowed buffer.
1349 If IS-REGEXP, HEADER is a regular expression.
1350 If FIRST, only remove the first instance of the header.
1351 Return the number of headers removed."
1352   (goto-char (point-min))
1353   (let ((regexp (if is-regexp header (concat "^" (regexp-quote header) ":")))
1354         (number 0)
1355         (case-fold-search t)
1356         last)
1357     (while (and (not (eobp))
1358                 (not last))
1359       (if (if reverse
1360               (not (looking-at regexp))
1361             (looking-at regexp))
1362           (progn
1363             (incf number)
1364             (when first
1365               (setq last t))
1366             (delete-region
1367              (point)
1368              ;; There might be a continuation header, so we have to search
1369              ;; until we find a new non-continuation line.
1370              (progn
1371                (forward-line 1)
1372                (if (re-search-forward "^[^ \t]" nil t)
1373                    (goto-char (match-beginning 0))
1374                  (point-max)))))
1375         (forward-line 1)
1376         (if (re-search-forward "^[^ \t]" nil t)
1377             (goto-char (match-beginning 0))
1378           (goto-char (point-max)))))
1379     number))
1380
1381 (defun message-remove-first-header (header)
1382   "Remove the first instance of HEADER if there is more than one."
1383   (let ((count 0)
1384         (regexp (concat "^" (regexp-quote header) ":")))
1385     (save-excursion
1386       (goto-char (point-min))
1387       (while (re-search-forward regexp nil t)
1388         (incf count)))
1389     (while (> count 1)
1390       (message-remove-header header nil t)
1391       (decf count))))
1392
1393 (defun message-narrow-to-headers ()
1394   "Narrow the buffer to the head of the message."
1395   (widen)
1396   (narrow-to-region
1397    (goto-char (point-min))
1398    (if (re-search-forward
1399         (concat "^" (regexp-quote mail-header-separator) "\n") nil t)
1400        (match-beginning 0)
1401      (point-max)))
1402   (goto-char (point-min)))
1403
1404 (defun message-narrow-to-head-1 ()
1405   "Like `message-narrow-to-head'.  Don't widen."
1406   (narrow-to-region
1407    (goto-char (point-min))
1408    (if (search-forward "\n\n" nil 1)
1409        (1- (point))
1410      (point-max)))
1411   (goto-char (point-min)))
1412
1413 (defun message-narrow-to-head ()
1414   "Narrow the buffer to the head of the message.
1415 Point is left at the beginning of the narrowed-to region."
1416   (widen)
1417   (message-narrow-to-head-1))
1418
1419 (defun message-narrow-to-headers-or-head ()
1420   "Narrow the buffer to the head of the message."
1421   (widen)
1422   (narrow-to-region
1423    (goto-char (point-min))
1424    (cond
1425     ((re-search-forward
1426       (concat "^" (regexp-quote mail-header-separator) "\n") nil t)
1427      (match-beginning 0))
1428     ((search-forward "\n\n" nil t)
1429      (1- (point)))
1430     (t
1431      (point-max))))
1432   (goto-char (point-min)))
1433
1434 (defun message-news-p ()
1435   "Say whether the current buffer contains a news message."
1436   (and (not message-this-is-mail)
1437        (or message-this-is-news
1438            (save-excursion
1439              (save-restriction
1440                (message-narrow-to-headers)
1441                (and (message-fetch-field "newsgroups")
1442                     (not (message-fetch-field "posted-to"))))))))
1443
1444 (defun message-mail-p ()
1445   "Say whether the current buffer contains a mail message."
1446   (and (not message-this-is-news)
1447        (or message-this-is-mail
1448            (save-excursion
1449              (save-restriction
1450                (message-narrow-to-headers)
1451                (or (message-fetch-field "to")
1452                    (message-fetch-field "cc")
1453                    (message-fetch-field "bcc")))))))
1454
1455 (defun message-next-header ()
1456   "Go to the beginning of the next header."
1457   (beginning-of-line)
1458   (or (eobp) (forward-char 1))
1459   (not (if (re-search-forward "^[^ \t]" nil t)
1460            (beginning-of-line)
1461          (goto-char (point-max)))))
1462
1463 (defun message-sort-headers-1 ()
1464   "Sort the buffer as headers using `message-rank' text props."
1465   (goto-char (point-min))
1466   (require 'sort)
1467   (sort-subr
1468    nil 'message-next-header
1469    (lambda ()
1470      (message-next-header)
1471      (unless (bobp)
1472        (forward-char -1)))
1473    (lambda ()
1474      (or (get-text-property (point) 'message-rank)
1475          10000))))
1476
1477 (defun message-sort-headers ()
1478   "Sort the headers of the current message according to `message-header-format-alist'."
1479   (interactive)
1480   (save-excursion
1481     (save-restriction
1482       (let ((max (1+ (length message-header-format-alist)))
1483             rank)
1484         (message-narrow-to-headers)
1485         (while (re-search-forward "^[^ \n]+:" nil t)
1486           (put-text-property
1487            (match-beginning 0) (1+ (match-beginning 0))
1488            'message-rank
1489            (if (setq rank (length (memq (assq (intern (buffer-substring
1490                                                        (match-beginning 0)
1491                                                        (1- (match-end 0))))
1492                                               message-header-format-alist)
1493                                         message-header-format-alist)))
1494                (- max rank)
1495              (1+ max)))))
1496       (message-sort-headers-1))))
1497
1498 \f
1499
1500 ;;;
1501 ;;; Message mode
1502 ;;;
1503
1504 ;;; Set up keymap.
1505
1506 (defvar message-mode-map nil)
1507
1508 (unless message-mode-map
1509   (setq message-mode-map (make-keymap))
1510   (set-keymap-parent message-mode-map text-mode-map)
1511   (define-key message-mode-map "\C-c?" 'describe-mode)
1512
1513   (define-key message-mode-map "\C-c\C-f\C-t" 'message-goto-to)
1514   (define-key message-mode-map "\C-c\C-f\C-b" 'message-goto-bcc)
1515   (define-key message-mode-map "\C-c\C-f\C-w" 'message-goto-fcc)
1516   (define-key message-mode-map "\C-c\C-f\C-c" 'message-goto-cc)
1517   (define-key message-mode-map "\C-c\C-f\C-s" 'message-goto-subject)
1518   (define-key message-mode-map "\C-c\C-f\C-r" 'message-goto-reply-to)
1519   (define-key message-mode-map "\C-c\C-f\C-n" 'message-goto-newsgroups)
1520   (define-key message-mode-map "\C-c\C-f\C-d" 'message-goto-distribution)
1521   (define-key message-mode-map "\C-c\C-f\C-f" 'message-goto-followup-to)
1522   (define-key message-mode-map "\C-c\C-f\C-m" 'message-goto-mail-followup-to)
1523   (define-key message-mode-map "\C-c\C-f\C-k" 'message-goto-keywords)
1524   (define-key message-mode-map "\C-c\C-f\C-u" 'message-goto-summary)
1525   (define-key message-mode-map "\C-c\C-f\C-i" 'message-insert-or-toggle-importance)
1526   (define-key message-mode-map "\C-c\C-b" 'message-goto-body)
1527   (define-key message-mode-map "\C-c\C-i" 'message-goto-signature)
1528
1529   (define-key message-mode-map "\C-c\C-t" 'message-insert-to)
1530   (define-key message-mode-map "\C-c\C-n" 'message-insert-newsgroups)
1531
1532   (define-key message-mode-map "\C-c\C-y" 'message-yank-original)
1533   (define-key message-mode-map "\C-c\M-\C-y" 'message-yank-buffer)
1534   (define-key message-mode-map "\C-c\C-q" 'message-fill-yanked-message)
1535   (define-key message-mode-map "\C-c\C-w" 'message-insert-signature)
1536   (define-key message-mode-map "\C-c\M-h" 'message-insert-headers)
1537   (define-key message-mode-map "\C-c\C-r" 'message-caesar-buffer-body)
1538   (define-key message-mode-map "\C-c\C-o" 'message-sort-headers)
1539   (define-key message-mode-map "\C-c\M-r" 'message-rename-buffer)
1540
1541   (define-key message-mode-map "\C-c\C-c" 'message-send-and-exit)
1542   (define-key message-mode-map "\C-c\C-s" 'message-send)
1543   (define-key message-mode-map "\C-c\C-k" 'message-kill-buffer)
1544   (define-key message-mode-map "\C-c\C-d" 'message-dont-send)
1545   (define-key message-mode-map "\C-c\n" 'gnus-delay-article)
1546
1547   (define-key message-mode-map "\C-c\C-e" 'message-elide-region)
1548   (define-key message-mode-map "\C-c\C-v" 'message-delete-not-region)
1549   (define-key message-mode-map "\C-c\C-z" 'message-kill-to-signature)
1550   (define-key message-mode-map "\M-\r" 'message-newline-and-reformat)
1551   ;;(define-key message-mode-map "\M-q" 'message-fill-paragraph)
1552
1553   (define-key message-mode-map "\C-c\C-a" 'mml-attach-file)
1554   
1555   (define-key message-mode-map "\C-a" 'message-beginning-of-line)
1556   (define-key message-mode-map "\t" 'message-tab)
1557   (define-key message-mode-map "\M-;" 'comment-region))
1558
1559 (easy-menu-define
1560   message-mode-menu message-mode-map "Message Menu."
1561   `("Message"
1562     ["Sort Headers" message-sort-headers t]
1563     ["Yank Original" message-yank-original t]
1564     ["Fill Yanked Message" message-fill-yanked-message t]
1565     ["Insert Signature" message-insert-signature t]
1566     ["Caesar (rot13) Message" message-caesar-buffer-body t]
1567     ["Caesar (rot13) Region" message-caesar-region (mark t)]
1568     ["Elide Region" message-elide-region (mark t)]
1569     ["Delete Outside Region" message-delete-not-region (mark t)]
1570     ["Kill To Signature" message-kill-to-signature t]
1571     ["Newline and Reformat" message-newline-and-reformat t]
1572     ["Rename buffer" message-rename-buffer t]
1573     ["Flag as important" message-insert-importance-high
1574      ,@(if (featurep 'xemacs) '(t)
1575          '(:help "Mark this message as important"))]
1576     ["Flag as unimportant" message-insert-importance-low
1577      ,@(if (featurep 'xemacs) '(t)
1578          '(:help "Mark this message as unimportant"))]
1579     ["Spellcheck" ispell-message
1580      ,@(if (featurep 'xemacs) '(t)
1581          '(:help "Spellcheck this message"))]
1582     "----"
1583     ["Send Message" message-send-and-exit
1584      ,@(if (featurep 'xemacs) '(t)
1585          '(:help "Send this message"))]
1586     ["Postpone Message" message-dont-send
1587      ,@(if (featurep 'xemacs) '(t)
1588          '(:help "File this draft message and exit"))]
1589     ["Send at Specific Time" gnus-delay-article
1590      ,@(if (featurep 'xemacs) '(t)
1591          '(:help "Ask, then arrange to send message at that time"))]
1592     ["Kill Message" message-kill-buffer
1593      ,@(if (featurep 'xemacs) '(t)
1594          '(:help "Delete this message without sending"))]))
1595
1596 (easy-menu-define
1597   message-mode-field-menu message-mode-map ""
1598   '("Field"
1599     ["Fetch To" message-insert-to t]
1600     ["Fetch Newsgroups" message-insert-newsgroups t]
1601     "----"
1602     ["To" message-goto-to t]
1603     ["Subject" message-goto-subject t]
1604     ["Cc" message-goto-cc t]
1605     ["Reply-To" message-goto-reply-to t]
1606     ["Summary" message-goto-summary t]
1607     ["Keywords" message-goto-keywords t]
1608     ["Newsgroups" message-goto-newsgroups t]
1609     ["Followup-To" message-goto-followup-to t]
1610     ["Mail-Followup-To" message-goto-mail-followup-to t]
1611     ["Distribution" message-goto-distribution t]
1612     ["Body" message-goto-body t]
1613     ["Signature" message-goto-signature t]))
1614
1615 (defvar message-tool-bar-map nil)
1616
1617 (eval-when-compile
1618   (defvar facemenu-add-face-function)
1619   (defvar facemenu-remove-face-function))
1620
1621 ;;; Forbidden properties
1622 ;;
1623 ;; We use `after-change-functions' to keep special text properties
1624 ;; that interfer with the normal function of message mode out of the
1625 ;; buffer. 
1626
1627 (defcustom message-strip-special-text-properties t
1628   "Strip special properties from the message buffer.
1629
1630 Emacs has a number of special text properties which can break message
1631 composing in various ways.  If this option is set, message will strip
1632 these properties from the message composition buffer.  However, some
1633 packages requires these properties to be present in order to work.
1634 If you use one of these packages, turn this option off, and hope the
1635 message composition doesn't break too bad."
1636   :group 'message-various
1637   :type 'boolean)
1638
1639 (defconst message-forbidden-properties 
1640   ;; No reason this should be clutter up customize.  We make it a
1641   ;; property list (rather than a list of property symbols), to be
1642   ;; directly useful for `remove-text-properties'.
1643   '(field nil read-only nil intangible nil invisible nil 
1644           mouse-face nil modification-hooks nil insert-in-front-hooks nil
1645           insert-behind-hooks nil point-entered nil point-left nil) 
1646   ;; Other special properties:
1647   ;; category, face, display: probably doesn't do any harm.
1648   ;; fontified: is used by font-lock.
1649   ;; syntax-table, local-map: I dunno.
1650   ;; We need to add XEmacs names to the list.
1651   "Property list of with properties.forbidden in message buffers.
1652 The values of the properties are ignored, only the property names are used.")
1653
1654 (defun message-tamago-not-in-use-p (pos)
1655   "Return t when tamago version 4 is not in use at the cursor position.
1656 Tamago version 4 is a popular input method for writing Japanese text.
1657 It uses the properties `intangible', `invisible', `modification-hooks'
1658 and `read-only' when translating ascii or kana text to kanji text.
1659 These properties are essential to work, so we should never strip them."
1660   (not (and (boundp 'egg-modefull-mode)
1661             (symbol-value 'egg-modefull-mode)
1662             (or (memq (get-text-property pos 'intangible)
1663                       '(its-part-1 its-part-2))
1664                 (get-text-property pos 'egg-end)
1665                 (get-text-property pos 'egg-lang)
1666                 (get-text-property pos 'egg-start)))))
1667
1668 (defun message-strip-forbidden-properties (begin end &optional old-length)
1669   "Strip forbidden properties between BEGIN and END, ignoring the third arg.
1670 This function is intended to be called from `after-change-functions'.
1671 See also `message-forbidden-properties'."
1672   (when (and message-strip-special-text-properties
1673              (message-tamago-not-in-use-p begin))
1674     (remove-text-properties begin end message-forbidden-properties)))
1675
1676 ;;;###autoload
1677 (define-derived-mode message-mode text-mode "Message"
1678   "Major mode for editing mail and news to be sent.
1679 Like Text Mode but with these additional commands:\\<message-mode-map>
1680 C-c C-s  `message-send' (send the message)  C-c C-c  `message-send-and-exit'
1681 C-c C-d  Postpone sending the message       C-c C-k  Kill the message
1682 C-c C-f  move to a header field (and create it if there isn't):
1683          C-c C-f C-t  move to To        C-c C-f C-s  move to Subject
1684          C-c C-f C-c  move to Cc        C-c C-f C-b  move to Bcc
1685          C-c C-f C-w  move to Fcc       C-c C-f C-r  move to Reply-To
1686          C-c C-f C-u  move to Summary   C-c C-f C-n  move to Newsgroups
1687          C-c C-f C-k  move to Keywords  C-c C-f C-d  move to Distribution
1688          C-c C-f C-f  move to Followup-To
1689          C-c C-f C-m  move to Mail-Followup-To
1690 C-c C-t  `message-insert-to' (add a To header to a news followup)
1691 C-c C-n  `message-insert-newsgroups' (add a Newsgroup header to a news reply)
1692 C-c C-b  `message-goto-body' (move to beginning of message text).
1693 C-c C-i  `message-goto-signature' (move to the beginning of the signature).
1694 C-c C-w  `message-insert-signature' (insert `message-signature-file' file).
1695 C-c C-y  `message-yank-original' (insert current message, if any).
1696 C-c C-q  `message-fill-yanked-message' (fill what was yanked).
1697 C-c C-e  `message-elide-region' (elide the text between point and mark).
1698 C-c C-v  `message-delete-not-region' (remove the text outside the region).
1699 C-c C-z  `message-kill-to-signature' (kill the text up to the signature).
1700 C-c C-r  `message-caesar-buffer-body' (rot13 the message body).
1701 C-c C-a  `mml-attach-file' (attach a file as MIME).
1702 C-c C-u  `message-insert-or-toggle-importance'  (insert or cycle importance)
1703 M-RET    `message-newline-and-reformat' (break the line and reformat)."
1704   (set (make-local-variable 'message-reply-buffer) nil)
1705   (make-local-variable 'message-send-actions)
1706   (make-local-variable 'message-exit-actions)
1707   (make-local-variable 'message-kill-actions)
1708   (make-local-variable 'message-postpone-actions)
1709   (make-local-variable 'message-draft-article)
1710   (setq buffer-offer-save t)
1711   (set (make-local-variable 'facemenu-add-face-function)
1712        (lambda (face end)
1713          (let ((face-fun (cdr (assq face message-face-alist))))
1714            (if face-fun
1715                (funcall face-fun (point) end)
1716              (error "Face %s not configured for %s mode" face mode-name)))
1717          ""))
1718   (set (make-local-variable 'facemenu-remove-face-function) t)
1719   (set (make-local-variable 'message-reply-headers) nil)
1720   (make-local-variable 'message-newsreader)
1721   (make-local-variable 'message-mailer)
1722   (make-local-variable 'message-post-method)
1723   (set (make-local-variable 'message-sent-message-via) nil)
1724   (set (make-local-variable 'message-checksum) nil)
1725   (set (make-local-variable 'message-mime-part) 0)
1726   (message-setup-fill-variables)
1727   ;; Allow using comment commands to add/remove quoting.
1728   (set (make-local-variable 'comment-start) message-yank-prefix)
1729   (if (featurep 'xemacs)
1730       (message-setup-toolbar)
1731     (set (make-local-variable 'font-lock-defaults)
1732          '(message-font-lock-keywords t))
1733     (if (boundp 'tool-bar-map)
1734         (set (make-local-variable 'tool-bar-map) (message-tool-bar-map))))
1735   (easy-menu-add message-mode-menu message-mode-map)
1736   (easy-menu-add message-mode-field-menu message-mode-map)
1737   ;; make-local-hook is harmless though obsolete in Emacs 21.
1738   ;; Emacs 20 and XEmacs need make-local-hook. 
1739   (make-local-hook 'after-change-functions)
1740   ;; Mmmm... Forbidden properties...
1741   (add-hook 'after-change-functions 'message-strip-forbidden-properties 
1742             nil 'local)
1743   ;; Allow mail alias things.
1744   (when (eq message-mail-alias-type 'abbrev)
1745     (if (fboundp 'mail-abbrevs-setup)
1746         (mail-abbrevs-setup)
1747       (mail-aliases-setup)))
1748   (message-set-auto-save-file-name)
1749   (mm-enable-multibyte)
1750   (set (make-local-variable 'indent-tabs-mode) nil) ;No tabs for indentation.
1751   (mml-mode))
1752
1753 (defun message-setup-fill-variables ()
1754   "Setup message fill variables."
1755   (set (make-local-variable 'fill-paragraph-function)
1756        'message-fill-paragraph)
1757   (make-local-variable 'paragraph-separate)
1758   (make-local-variable 'paragraph-start)
1759   (make-local-variable 'adaptive-fill-regexp)
1760   (unless (boundp 'adaptive-fill-first-line-regexp)
1761     (setq adaptive-fill-first-line-regexp nil))
1762   (make-local-variable 'adaptive-fill-first-line-regexp)
1763   (let ((quote-prefix-regexp
1764          ;; User should change message-cite-prefix-regexp if
1765          ;; message-yank-prefix is set to an abnormal value.
1766          (concat "\\(" message-cite-prefix-regexp "\\)[ \t]*")))
1767     (setq paragraph-start
1768           (concat
1769            (regexp-quote mail-header-separator) "$\\|"
1770            "[ \t]*$\\|"                 ; blank lines
1771            "-- $\\|"                    ; signature delimiter
1772            "---+$\\|"              ; delimiters for forwarded messages
1773            page-delimiter "$\\|"        ; spoiler warnings
1774            ".*wrote:$\\|"               ; attribution lines
1775            quote-prefix-regexp "$"))    ; empty lines in quoted text
1776     (setq paragraph-separate paragraph-start)
1777     (setq adaptive-fill-regexp
1778           (concat quote-prefix-regexp "\\|" adaptive-fill-regexp))
1779     (setq adaptive-fill-first-line-regexp
1780           (concat quote-prefix-regexp "\\|"
1781                   adaptive-fill-first-line-regexp)))
1782   (make-local-variable 'auto-fill-inhibit-regexp)
1783   ;;(setq auto-fill-inhibit-regexp "^[A-Z][^: \n\t]+:")
1784   (setq auto-fill-inhibit-regexp nil)
1785   (make-local-variable 'normal-auto-fill-function)
1786   (setq normal-auto-fill-function 'message-do-auto-fill)
1787   ;; KLUDGE: auto fill might already be turned on in `text-mode-hook'.
1788   ;; In that case, ensure that it uses the right function.  The real
1789   ;; solution would be not to use `define-derived-mode', and run
1790   ;; `text-mode-hook' ourself at the end of the mode.
1791   ;; -- Per Abrahamsen <abraham@dina.kvl.dk> Date: 2001-10-19.
1792   (when auto-fill-function
1793     (setq auto-fill-function normal-auto-fill-function)))
1794
1795 \f
1796
1797 ;;;
1798 ;;; Message mode commands
1799 ;;;
1800
1801 ;;; Movement commands
1802
1803 (defun message-goto-to ()
1804   "Move point to the To header."
1805   (interactive)
1806   (message-position-on-field "To"))
1807
1808 (defun message-goto-subject ()
1809   "Move point to the Subject header."
1810   (interactive)
1811   (message-position-on-field "Subject"))
1812
1813 (defun message-goto-cc ()
1814   "Move point to the Cc header."
1815   (interactive)
1816   (message-position-on-field "Cc" "To"))
1817
1818 (defun message-goto-bcc ()
1819   "Move point to the Bcc  header."
1820   (interactive)
1821   (message-position-on-field "Bcc" "Cc" "To"))
1822
1823 (defun message-goto-fcc ()
1824   "Move point to the Fcc header."
1825   (interactive)
1826   (message-position-on-field "Fcc" "To" "Newsgroups"))
1827
1828 (defun message-goto-reply-to ()
1829   "Move point to the Reply-To header."
1830   (interactive)
1831   (message-position-on-field "Reply-To" "Subject"))
1832
1833 (defun message-goto-newsgroups ()
1834   "Move point to the Newsgroups header."
1835   (interactive)
1836   (message-position-on-field "Newsgroups"))
1837
1838 (defun message-goto-distribution ()
1839   "Move point to the Distribution header."
1840   (interactive)
1841   (message-position-on-field "Distribution"))
1842
1843 (defun message-goto-followup-to ()
1844   "Move point to the Followup-To header."
1845   (interactive)
1846   (message-position-on-field "Followup-To" "Newsgroups"))
1847
1848 (defun message-goto-mail-followup-to ()
1849   "Move point to the Mail-Followup-To header."
1850   (interactive)
1851   (message-position-on-field "Mail-Followup-To" "From"))
1852
1853 (defun message-goto-keywords ()
1854   "Move point to the Keywords header."
1855   (interactive)
1856   (message-position-on-field "Keywords" "Subject"))
1857
1858 (defun message-goto-summary ()
1859   "Move point to the Summary header."
1860   (interactive)
1861   (message-position-on-field "Summary" "Subject"))
1862
1863 (defun message-goto-body (&optional interactivep)
1864   "Move point to the beginning of the message body."
1865   (interactive (list t))
1866   (when (and interactivep
1867              (looking-at "[ \t]*\n"))
1868     (expand-abbrev))
1869   (goto-char (point-min))
1870   (or (search-forward (concat "\n" mail-header-separator "\n") nil t)
1871       (search-forward-regexp "[^:]+:\\([^\n]\\|\n[ \t]\\)+\n\n" nil t)))
1872
1873 (defun message-goto-eoh ()
1874   "Move point to the end of the headers."
1875   (interactive)
1876   (message-goto-body)
1877   (forward-line -1))
1878
1879 (defun message-goto-signature ()
1880   "Move point to the beginning of the message signature.
1881 If there is no signature in the article, go to the end and
1882 return nil."
1883   (interactive)
1884   (goto-char (point-min))
1885   (if (re-search-forward message-signature-separator nil t)
1886       (forward-line 1)
1887     (goto-char (point-max))
1888     nil))
1889
1890 \f
1891
1892 (defun message-insert-to (&optional force)
1893   "Insert a To header that points to the author of the article being replied to.
1894 If the original author requested not to be sent mail, the function signals
1895 an error.
1896 With the prefix argument FORCE, insert the header anyway."
1897   (interactive "P")
1898   (let ((co (message-fetch-reply-field "mail-copies-to")))
1899     (when (and (null force)
1900                co
1901                (or (equal (downcase co) "never")
1902                    (equal (downcase co) "nobody")))
1903       (error "The user has requested not to have copies sent via mail")))
1904   (when (and (message-position-on-field "To")
1905              (mail-fetch-field "to")
1906              (not (string-match "\\` *\\'" (mail-fetch-field "to"))))
1907     (insert ", "))
1908   (insert (or (message-fetch-reply-field "mail-reply-to")
1909               (message-fetch-reply-field "reply-to")
1910               (message-fetch-reply-field "from") "")))
1911
1912 (defun message-widen-reply ()
1913   "Widen the reply to include maximum recipients."
1914   (interactive)
1915   (let ((follow-to
1916          (and message-reply-buffer
1917               (buffer-name message-reply-buffer)
1918               (save-excursion
1919                 (set-buffer message-reply-buffer)
1920                 (message-get-reply-headers t)))))
1921     (save-excursion
1922       (save-restriction
1923         (message-narrow-to-headers)
1924         (dolist (elem follow-to)
1925           (message-remove-header (symbol-name (car elem)))
1926           (goto-char (point-min))
1927           (insert (symbol-name (car elem)) ": "
1928                   (cdr elem) "\n"))))))
1929
1930 (defun message-insert-newsgroups ()
1931   "Insert the Newsgroups header from the article being replied to."
1932   (interactive)
1933   (when (and (message-position-on-field "Newsgroups")
1934              (mail-fetch-field "newsgroups")
1935              (not (string-match "\\` *\\'" (mail-fetch-field "newsgroups"))))
1936     (insert ","))
1937   (insert (or (message-fetch-reply-field "newsgroups") "")))
1938
1939 \f
1940
1941 ;;; Various commands
1942
1943 (defun message-delete-not-region (beg end)
1944   "Delete everything in the body of the current message outside of the region."
1945   (interactive "r")
1946   (let (citeprefix)
1947     (save-excursion
1948       (goto-char beg)
1949       ;; snarf citation prefix, if appropriate
1950       (unless (eq (point) (progn (beginning-of-line) (point)))
1951         (when (looking-at message-cite-prefix-regexp)
1952           (setq citeprefix (match-string 0))))
1953       (goto-char end)
1954       (delete-region (point) (if (not (message-goto-signature))
1955                                  (point)
1956                                (forward-line -2)
1957                                (point)))
1958       (insert "\n")
1959       (goto-char beg)
1960       (delete-region beg (progn (message-goto-body)
1961                                 (forward-line 2)
1962                                 (point)))
1963       (when citeprefix
1964         (insert citeprefix))))
1965   (when (message-goto-signature)
1966     (forward-line -2)))
1967
1968 (defun message-kill-to-signature ()
1969   "Deletes all text up to the signature."
1970   (interactive)
1971   (let ((point (point)))
1972     (message-goto-signature)
1973     (unless (eobp)
1974       (forward-line -2))
1975     (kill-region point (point))
1976     (unless (bolp)
1977       (insert "\n"))))
1978
1979 (defun message-newline-and-reformat (&optional arg not-break)
1980   "Insert four newlines, and then reformat if inside quoted text.
1981 Prefix arg means justify as well."
1982   (interactive (list (if current-prefix-arg 'full)))
1983   (let (quoted point beg end leading-space bolp)
1984     (setq point (point))
1985     (beginning-of-line)
1986     (setq beg (point))
1987     (setq bolp (= beg point))
1988     ;; Find first line of the paragraph.
1989     (if not-break
1990         (while (and (not (eobp))
1991                     (not (looking-at message-cite-prefix-regexp))
1992                     (looking-at paragraph-start))
1993           (forward-line 1)))
1994     ;; Find the prefix
1995     (when (looking-at message-cite-prefix-regexp)
1996       (setq quoted (match-string 0))
1997       (goto-char (match-end 0))
1998       (looking-at "[ \t]*")
1999       (setq leading-space (match-string 0)))
2000     (if (and quoted
2001              (not not-break)
2002              (not bolp)
2003              (< (- point beg) (length quoted)))
2004         ;; break inside the cite prefix.
2005         (setq quoted nil
2006               end nil))
2007     (if quoted
2008         (progn
2009           (forward-line 1)
2010           (while (and (not (eobp))
2011                       (not (looking-at paragraph-separate))
2012                       (looking-at message-cite-prefix-regexp)
2013                       (equal quoted (match-string 0)))
2014             (goto-char (match-end 0))
2015             (looking-at "[ \t]*")
2016             (if (> (length leading-space) (length (match-string 0)))
2017                 (setq leading-space (match-string 0)))
2018             (forward-line 1))
2019           (setq end (point))
2020           (goto-char beg)
2021           (while (and (if (bobp) nil (forward-line -1) t)
2022                       (not (looking-at paragraph-start))
2023                       (looking-at message-cite-prefix-regexp)
2024                       (equal quoted (match-string 0)))
2025             (setq beg (point))
2026             (goto-char (match-end 0))
2027             (looking-at "[ \t]*")
2028             (if (> (length leading-space) (length (match-string 0)))
2029                 (setq leading-space (match-string 0)))))
2030       (while (and (not (eobp))
2031                   (not (looking-at paragraph-separate))
2032                   (not (looking-at message-cite-prefix-regexp)))
2033         (forward-line 1))
2034       (setq end (point))
2035       (goto-char beg)
2036       (while (and (if (bobp) nil (forward-line -1) t)
2037                   (not (looking-at paragraph-start))
2038                   (not (looking-at message-cite-prefix-regexp)))
2039         (setq beg (point))))
2040     (goto-char point)
2041     (save-restriction
2042       (narrow-to-region beg end)
2043       (if not-break
2044           (setq point nil)
2045         (if bolp
2046             (insert "\n")
2047           (insert "\n\n"))
2048         (setq point (point))
2049         (insert "\n\n")
2050         (delete-region (point) (re-search-forward "[ \t]*"))
2051         (when (and quoted (not bolp))
2052           (insert quoted leading-space)))
2053       (if quoted
2054           (let* ((adaptive-fill-regexp
2055                   (regexp-quote (concat quoted leading-space)))
2056                  (adaptive-fill-first-line-regexp
2057                   adaptive-fill-regexp ))
2058             (fill-paragraph arg))
2059         (fill-paragraph arg))
2060       (if point (goto-char point)))))
2061
2062 (defun message-fill-paragraph (&optional arg)
2063   "Like `fill-paragraph'."
2064   (interactive (list (if current-prefix-arg 'full)))
2065   (if (and (boundp 'filladapt-mode) filladapt-mode)
2066       nil
2067     (message-newline-and-reformat arg t)
2068     t))
2069
2070 ;; Is it better to use `mail-header-end'?
2071 (defun message-point-in-header-p ()
2072   "Return t if point is in the header."
2073   (save-excursion
2074     (let ((p (point)))
2075       (goto-char (point-min))
2076       (not (re-search-forward
2077             (concat "^" (regexp-quote mail-header-separator) "\n")
2078             p t)))))
2079
2080 (defun message-do-auto-fill ()
2081   "Like `do-auto-fill', but don't fill in message header."
2082   (unless (message-point-in-header-p)
2083     (do-auto-fill)))
2084
2085 (defun message-insert-signature (&optional force)
2086   "Insert a signature.  See documentation for variable `message-signature'."
2087   (interactive (list 0))
2088   (let* ((signature
2089           (cond
2090            ((and (null message-signature)
2091                  (eq force 0))
2092             (save-excursion
2093               (goto-char (point-max))
2094               (not (re-search-backward message-signature-separator nil t))))
2095            ((and (null message-signature)
2096                  force)
2097             t)
2098            ((message-functionp message-signature)
2099             (funcall message-signature))
2100            ((listp message-signature)
2101             (eval message-signature))
2102            (t message-signature)))
2103          (signature
2104           (cond ((stringp signature)
2105                  signature)
2106                 ((and (eq t signature)
2107                       message-signature-file
2108                       (file-exists-p message-signature-file))
2109                  signature))))
2110     (when signature
2111       (goto-char (point-max))
2112       ;; Insert the signature.
2113       (unless (bolp)
2114         (insert "\n"))
2115       (insert "\n-- \n")
2116       (if (eq signature t)
2117           (insert-file-contents message-signature-file)
2118         (insert signature))
2119       (goto-char (point-max))
2120       (or (bolp) (insert "\n")))))
2121
2122 (defun message-insert-importance-high ()
2123   "Insert header to mark message as important."
2124   (interactive)
2125   (save-excursion
2126     (message-remove-header "Importance")
2127     (message-goto-eoh)
2128     (insert "Importance: high\n")))
2129
2130 (defun message-insert-importance-low ()
2131   "Insert header to mark message as unimportant."
2132   (interactive)
2133   (save-excursion
2134     (message-remove-header "Importance")
2135     (message-goto-eoh)
2136     (insert "Importance: low\n")))
2137
2138 (defun message-insert-or-toggle-importance ()
2139   "Insert a \"Importance: high\" header, or cycle through the header values.
2140 The three allowed values according to RFC 1327 are `high', `normal'
2141 and `low'."
2142   (interactive)
2143   (save-excursion
2144     (let ((valid '("high" "normal" "low"))
2145           (new "high")
2146           cur)
2147       (when (setq cur (message-fetch-field "Importance"))
2148         (message-remove-header "Importance")
2149         (setq new (cond ((string= cur "high")
2150                          "low")
2151                         ((string= cur "low")
2152                          "normal")
2153                         (t
2154                          "high"))))
2155       (message-goto-eoh)
2156       (insert (format "Importance: %s\n" new)))))
2157
2158 (defun message-elide-region (b e)
2159   "Elide the text in the region.
2160 An ellipsis (from `message-elide-ellipsis') will be inserted where the
2161 text was killed."
2162   (interactive "r")
2163   (kill-region b e)
2164   (insert message-elide-ellipsis))
2165
2166 (defvar message-caesar-translation-table nil)
2167
2168 (defun message-caesar-region (b e &optional n)
2169   "Caesar rotate region B to E by N, default 13, for decrypting netnews."
2170   (interactive
2171    (list
2172     (min (point) (or (mark t) (point)))
2173     (max (point) (or (mark t) (point)))
2174     (when current-prefix-arg
2175       (prefix-numeric-value current-prefix-arg))))
2176
2177   (setq n (if (numberp n) (mod n 26) 13)) ;canonize N
2178   (unless (or (zerop n)                 ; no action needed for a rot of 0
2179               (= b e))                  ; no region to rotate
2180     ;; We build the table, if necessary.
2181     (when (or (not message-caesar-translation-table)
2182               (/= (aref message-caesar-translation-table ?a) (+ ?a n)))
2183       (setq message-caesar-translation-table
2184             (message-make-caesar-translation-table n)))
2185     (translate-region b e message-caesar-translation-table)))
2186
2187 (defun message-make-caesar-translation-table (n)
2188   "Create a rot table with offset N."
2189   (let ((i -1)
2190         (table (make-string 256 0)))
2191     (while (< (incf i) 256)
2192       (aset table i i))
2193     (concat
2194      (substring table 0 ?A)
2195      (substring table (+ ?A n) (+ ?A n (- 26 n)))
2196      (substring table ?A (+ ?A n))
2197      (substring table (+ ?A 26) ?a)
2198      (substring table (+ ?a n) (+ ?a n (- 26 n)))
2199      (substring table ?a (+ ?a n))
2200      (substring table (+ ?a 26) 255))))
2201
2202 (defun message-caesar-buffer-body (&optional rotnum)
2203   "Caesar rotate all letters in the current buffer by 13 places.
2204 Used to encode/decode possibly offensive messages (commonly in rec.humor).
2205 With prefix arg, specifies the number of places to rotate each letter forward.
2206 Mail and USENET news headers are not rotated."
2207   (interactive (if current-prefix-arg
2208                    (list (prefix-numeric-value current-prefix-arg))
2209                  (list nil)))
2210   (save-excursion
2211     (save-restriction
2212       (when (message-goto-body)
2213         (narrow-to-region (point) (point-max)))
2214       (message-caesar-region (point-min) (point-max) rotnum))))
2215
2216 (defun message-pipe-buffer-body (program)
2217   "Pipe the message body in the current buffer through PROGRAM."
2218   (save-excursion
2219     (save-restriction
2220       (when (message-goto-body)
2221         (narrow-to-region (point) (point-max)))
2222       (shell-command-on-region
2223        (point-min) (point-max) program nil t))))
2224
2225 (defun message-rename-buffer (&optional enter-string)
2226   "Rename the *message* buffer to \"*message* RECIPIENT\".
2227 If the function is run with a prefix, it will ask for a new buffer
2228 name, rather than giving an automatic name."
2229   (interactive "Pbuffer name: ")
2230   (save-excursion
2231     (save-restriction
2232       (goto-char (point-min))
2233       (narrow-to-region (point)
2234                         (search-forward mail-header-separator nil 'end))
2235       (let* ((mail-to (or
2236                        (if (message-news-p) (message-fetch-field "Newsgroups")
2237                          (message-fetch-field "To"))
2238                        ""))
2239              (mail-trimmed-to
2240               (if (string-match "," mail-to)
2241                   (concat (substring mail-to 0 (match-beginning 0)) ", ...")
2242                 mail-to))
2243              (name-default (concat "*message* " mail-trimmed-to))
2244              (name (if enter-string
2245                        (read-string "New buffer name: " name-default)
2246                      name-default)))
2247         (rename-buffer name t)))))
2248
2249 (defun message-fill-yanked-message (&optional justifyp)
2250   "Fill the paragraphs of a message yanked into this one.
2251 Numeric argument means justify as well."
2252   (interactive "P")
2253   (save-excursion
2254     (goto-char (point-min))
2255     (search-forward (concat "\n" mail-header-separator "\n") nil t)
2256     (let ((fill-prefix message-yank-prefix))
2257       (fill-individual-paragraphs (point) (point-max) justifyp))))
2258
2259 (defun message-indent-citation ()
2260   "Modify text just inserted from a message to be cited.
2261 The inserted text should be the region.
2262 When this function returns, the region is again around the modified text.
2263
2264 Normally, indent each nonblank line `message-indentation-spaces' spaces.
2265 However, if `message-yank-prefix' is non-nil, insert that prefix on each line."
2266   (let ((start (point)))
2267     ;; Remove unwanted headers.
2268     (when message-ignored-cited-headers
2269       (let (all-removed)
2270         (save-restriction
2271           (narrow-to-region
2272            (goto-char start)
2273            (if (search-forward "\n\n" nil t)
2274                (1- (point))
2275              (point)))
2276           (message-remove-header message-ignored-cited-headers t)
2277           (when (= (point-min) (point-max))
2278             (setq all-removed t))
2279           (goto-char (point-max)))
2280         (if all-removed
2281             (goto-char start)
2282           (forward-line 1))))
2283     ;; Delete blank lines at the start of the buffer.
2284     (while (and (point-min)
2285                 (eolp)
2286                 (not (eobp)))
2287       (message-delete-line))
2288     ;; Delete blank lines at the end of the buffer.
2289     (goto-char (point-max))
2290     (unless (eolp)
2291       (insert "\n"))
2292     (while (and (zerop (forward-line -1))
2293                 (looking-at "$"))
2294       (message-delete-line))
2295     ;; Do the indentation.
2296     (if (null message-yank-prefix)
2297         (indent-rigidly start (mark t) message-indentation-spaces)
2298       (save-excursion
2299         (goto-char start)
2300         (while (< (point) (mark t))
2301           (if (or (looking-at ">") (looking-at "^$"))
2302               (insert message-yank-cited-prefix)
2303             (insert message-yank-prefix))
2304           (forward-line 1))))
2305     (goto-char start)))
2306
2307 (defun message-yank-original (&optional arg)
2308   "Insert the message being replied to, if any.
2309 Puts point before the text and mark after.
2310 Normally indents each nonblank line ARG spaces (default 3).  However,
2311 if `message-yank-prefix' is non-nil, insert that prefix on each line.
2312
2313 This function uses `message-cite-function' to do the actual citing.
2314
2315 Just \\[universal-argument] as argument means don't indent, insert no
2316 prefix, and don't delete any headers."
2317   (interactive "P")
2318   (let ((modified (buffer-modified-p)))
2319     (when (and message-reply-buffer
2320                message-cite-function)
2321       (delete-windows-on message-reply-buffer t)
2322       (insert-buffer message-reply-buffer)
2323       (unless arg
2324         (funcall message-cite-function))
2325       (message-exchange-point-and-mark)
2326       (unless (bolp)
2327         (insert ?\n))
2328       (unless modified
2329         (setq message-checksum (message-checksum))))))
2330
2331 (defun message-yank-buffer (buffer)
2332   "Insert BUFFER into the current buffer and quote it."
2333   (interactive "bYank buffer: ")
2334   (let ((message-reply-buffer buffer))
2335     (save-window-excursion
2336       (message-yank-original))))
2337
2338 (defun message-buffers ()
2339   "Return a list of active message buffers."
2340   (let (buffers)
2341     (save-excursion
2342       (dolist (buffer (buffer-list t))
2343         (set-buffer buffer)
2344         (when (and (eq major-mode 'message-mode)
2345                    (null message-sent-message-via))
2346           (push (buffer-name buffer) buffers))))
2347     (nreverse buffers)))
2348
2349 (defun message-cite-original-without-signature ()
2350   "Cite function in the standard Message manner."
2351   (let ((start (point))
2352         (end (mark t))
2353         (functions
2354          (when message-indent-citation-function
2355            (if (listp message-indent-citation-function)
2356                message-indent-citation-function
2357              (list message-indent-citation-function)))))
2358     (mml-quote-region start end)
2359     ;; Allow undoing.
2360     (undo-boundary)
2361     (goto-char end)
2362     (when (re-search-backward message-signature-separator start t)
2363       ;; Also peel off any blank lines before the signature.
2364       (forward-line -1)
2365       (while (looking-at "^[ \t]*$")
2366         (forward-line -1))
2367       (forward-line 1)
2368       (delete-region (point) end)
2369       (unless (search-backward "\n\n" start t)
2370         ;; Insert a blank line if it is peeled off.
2371         (insert "\n")))
2372     (goto-char start)
2373     (while functions
2374       (funcall (pop functions)))
2375     (when message-citation-line-function
2376       (unless (bolp)
2377         (insert "\n"))
2378       (funcall message-citation-line-function))))
2379
2380 (eval-when-compile (defvar mail-citation-hook)) ;Compiler directive
2381 (defun message-cite-original ()
2382   "Cite function in the standard Message manner."
2383   (if (and (boundp 'mail-citation-hook)
2384            mail-citation-hook)
2385       (run-hooks 'mail-citation-hook)
2386     (let ((start (point))
2387           (end (mark t))
2388           (functions
2389            (when message-indent-citation-function
2390              (if (listp message-indent-citation-function)
2391                  message-indent-citation-function
2392                (list message-indent-citation-function)))))
2393       (mml-quote-region start end)