* spam-report.el (spam-report-gmane-ham): Renamed from
[gnus] / lisp / message.el
1 ;;; message.el --- composing mail and news messages
2
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;;   2005 Free Software Foundation, Inc.
5
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Keywords: mail, news
8
9 ;; This file is part of GNU Emacs.
10
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
15
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 ;; GNU General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
25
26 ;;; Commentary:
27
28 ;; This mode provides mail-sending facilities from within Emacs.  It
29 ;; consists mainly of large chunks of code from the sendmail.el,
30 ;; gnus-msg.el and rnewspost.el files.
31
32 ;;; Code:
33
34 (eval-when-compile
35   (require 'cl)
36   (defvar gnus-message-group-art)
37   (defvar gnus-list-identifiers) ; gnus-sum is required where necessary
38   (require 'hashcash))
39 (require 'canlock)
40 (require 'mailheader)
41 (require 'nnheader)
42 ;; This is apparently necessary even though things are autoloaded.
43 ;; Because we dynamically bind mail-abbrev-mode-regexp, we'd better
44 ;; require mailabbrev here.
45 (if (featurep 'xemacs)
46     (require 'mail-abbrevs)
47   (require 'mailabbrev))
48 (require 'mail-parse)
49 (require 'mml)
50 (require 'rfc822)
51
52 (defgroup message '((user-mail-address custom-variable)
53                     (user-full-name custom-variable))
54   "Mail and news message composing."
55   :link '(custom-manual "(message)Top")
56   :group 'mail
57   :group 'news)
58
59 (put 'user-mail-address 'custom-type 'string)
60 (put 'user-full-name 'custom-type 'string)
61
62 (defgroup message-various nil
63   "Various Message Variables."
64   :link '(custom-manual "(message)Various Message Variables")
65   :group 'message)
66
67 (defgroup message-buffers nil
68   "Message Buffers."
69   :link '(custom-manual "(message)Message Buffers")
70   :group 'message)
71
72 (defgroup message-sending nil
73   "Message Sending."
74   :link '(custom-manual "(message)Sending Variables")
75   :group 'message)
76
77 (defgroup message-interface nil
78   "Message Interface."
79   :link '(custom-manual "(message)Interface")
80   :group 'message)
81
82 (defgroup message-forwarding nil
83   "Message Forwarding."
84   :link '(custom-manual "(message)Forwarding")
85   :group 'message-interface)
86
87 (defgroup message-insertion nil
88   "Message Insertion."
89   :link '(custom-manual "(message)Insertion")
90   :group 'message)
91
92 (defgroup message-headers nil
93   "Message Headers."
94   :link '(custom-manual "(message)Message Headers")
95   :group 'message)
96
97 (defgroup message-news nil
98   "Composing News Messages."
99   :group 'message)
100
101 (defgroup message-mail nil
102   "Composing Mail Messages."
103   :group 'message)
104
105 (defgroup message-faces nil
106   "Faces used for message composing."
107   :group 'message
108   :group 'faces)
109
110 (defcustom message-directory "~/Mail/"
111   "*Directory from which all other mail file variables are derived."
112   :group 'message-various
113   :type 'directory)
114
115 (defcustom message-max-buffers 10
116   "*How many buffers to keep before starting to kill them off."
117   :group 'message-buffers
118   :type 'integer)
119
120 (defcustom message-send-rename-function nil
121   "Function called to rename the buffer after sending it."
122   :group 'message-buffers
123   :type '(choice function (const nil)))
124
125 (defcustom message-fcc-handler-function 'message-output
126   "*A function called to save outgoing articles.
127 This function will be called with the name of the file to store the
128 article in.  The default function is `message-output' which saves in Unix
129 mailbox format."
130   :type '(radio (function-item message-output)
131                 (function :tag "Other"))
132   :group 'message-sending)
133
134 (defcustom message-fcc-externalize-attachments nil
135   "If non-nil, attachments are included as external parts in Fcc copies."
136   :version "22.1"
137   :type 'boolean
138   :group 'message-sending)
139
140 (defcustom message-courtesy-message
141   "The following message is a courtesy copy of an article\nthat has been posted to %s as well.\n\n"
142   "*This is inserted at the start of a mailed copy of a posted message.
143 If the string contains the format spec \"%s\", the Newsgroups
144 the article has been posted to will be inserted there.
145 If this variable is nil, no such courtesy message will be added."
146   :group 'message-sending
147   :type '(radio string (const nil)))
148
149 (defcustom message-ignored-bounced-headers
150   "^\\(Received\\|Return-Path\\|Delivered-To\\):"
151   "*Regexp that matches headers to be removed in resent bounced mail."
152   :group 'message-interface
153   :type 'regexp)
154
155 ;;;###autoload
156 (defcustom message-from-style 'default
157   "*Specifies how \"From\" headers look.
158
159 If nil, they contain just the return address like:
160         king@grassland.com
161 If `parens', they look like:
162         king@grassland.com (Elvis Parsley)
163 If `angles', they look like:
164         Elvis Parsley <king@grassland.com>
165
166 Otherwise, most addresses look like `angles', but they look like
167 `parens' if `angles' would need quoting and `parens' would not."
168   :type '(choice (const :tag "simple" nil)
169                  (const parens)
170                  (const angles)
171                  (const default))
172   :group 'message-headers)
173
174 (defcustom message-insert-canlock t
175   "Whether to insert a Cancel-Lock header in news postings."
176   :version "22.1"
177   :group 'message-headers
178   :type 'boolean)
179
180 (defcustom message-syntax-checks
181   (if message-insert-canlock '((sender . disabled)) nil)
182   ;; Guess this one shouldn't be easy to customize...
183   "*Controls what syntax checks should not be performed on outgoing posts.
184 To disable checking of long signatures, for instance, add
185  `(signature . disabled)' to this list.
186
187 Don't touch this variable unless you really know what you're doing.
188
189 Checks include `subject-cmsg', `multiple-headers', `sendsys',
190 `message-id', `from', `long-lines', `control-chars', `size',
191 `new-text', `quoting-style', `redirected-followup', `signature',
192 `approved', `sender', `empty', `empty-headers', `message-id', `from',
193 `subject', `shorten-followup-to', `existing-newsgroups',
194 `buffer-file-name', `unchanged', `newsgroups', `reply-to',
195 `continuation-headers', `long-header-lines', `invisible-text' and
196 `illegible-text'."
197   :group 'message-news
198   :type '(repeat sexp))                 ; Fixme: improve this
199
200 (defcustom message-required-headers '((optional . References)
201                                       From)
202   "*Headers to be generated or prompted for when sending a message.
203 Also see `message-required-news-headers' and
204 `message-required-mail-headers'."
205   :version "22.1"
206   :group 'message-news
207   :group 'message-headers
208   :link '(custom-manual "(message)Message Headers")
209   :type '(repeat sexp))
210
211 (defcustom message-draft-headers '(References From)
212   "*Headers to be generated when saving a draft message."
213   :version "22.1"
214   :group 'message-news
215   :group 'message-headers
216   :link '(custom-manual "(message)Message Headers")
217   :type '(repeat sexp))
218
219 (defcustom message-required-news-headers
220   '(From Newsgroups Subject Date Message-ID
221          (optional . Organization)
222          (optional . User-Agent))
223   "*Headers to be generated or prompted for when posting an article.
224 RFC977 and RFC1036 require From, Date, Newsgroups, Subject,
225 Message-ID.  Organization, Lines, In-Reply-To, Expires, and
226 User-Agent are optional.  If don't you want message to insert some
227 header, remove it from this list."
228   :group 'message-news
229   :group 'message-headers
230   :link '(custom-manual "(message)Message Headers")
231   :type '(repeat sexp))
232
233 (defcustom message-required-mail-headers
234   '(From Subject Date (optional . In-Reply-To) Message-ID
235          (optional . User-Agent))
236   "*Headers to be generated or prompted for when mailing a message.
237 It is recommended that From, Date, To, Subject and Message-ID be
238 included.  Organization and User-Agent are optional."
239   :group 'message-mail
240   :group 'message-headers
241   :link '(custom-manual "(message)Message Headers")
242   :type '(repeat sexp))
243
244 (defcustom message-deletable-headers '(Message-ID Date Lines)
245   "Headers to be deleted if they already exist and were generated by message previously."
246   :group 'message-headers
247   :link '(custom-manual "(message)Message Headers")
248   :type 'sexp)
249
250 (defcustom message-ignored-news-headers
251   "^NNTP-Posting-Host:\\|^Xref:\\|^[BGF]cc:\\|^Resent-Fcc:\\|^X-Draft-From:\\|^X-Gnus-Agent-Meta-Information:"
252   "*Regexp of headers to be removed unconditionally before posting."
253   :group 'message-news
254   :group 'message-headers
255   :link '(custom-manual "(message)Message Headers")
256   :type '(repeat :value-to-internal (lambda (widget value)
257                                       (custom-split-regexp-maybe value))
258                  :match (lambda (widget value)
259                           (or (stringp value)
260                               (widget-editable-list-match widget value)))
261                  regexp))
262
263 (defcustom message-ignored-mail-headers
264   "^[GF]cc:\\|^Resent-Fcc:\\|^Xref:\\|^X-Draft-From:\\|^X-Gnus-Agent-Meta-Information:"
265   "*Regexp of headers to be removed unconditionally before mailing."
266   :group 'message-mail
267   :group 'message-headers
268   :link '(custom-manual "(message)Mail Headers")
269   :type 'regexp)
270
271 (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:\\|^X-Hashcash:\\|^X-Payment:\\|^Approved:"
272   "*Header lines matching this regexp will be deleted before posting.
273 It's best to delete old Path and Date headers before posting to avoid
274 any confusion."
275   :group 'message-interface
276   :link '(custom-manual "(message)Superseding")
277   :type '(repeat :value-to-internal (lambda (widget value)
278                                       (custom-split-regexp-maybe value))
279                  :match (lambda (widget value)
280                           (or (stringp value)
281                               (widget-editable-list-match widget value)))
282                  regexp))
283
284 (defcustom message-subject-re-regexp
285   "^[ \t]*\\([Rr][Ee]\\(\\[[0-9]*\\]\\)*:[ \t]*\\)*[ \t]*"
286   "*Regexp matching \"Re: \" in the subject line."
287   :group 'message-various
288   :link '(custom-manual "(message)Message Headers")
289   :type 'regexp)
290
291 ;;; Start of variables adopted from `message-utils.el'.
292
293 (defcustom message-subject-trailing-was-query 'ask
294   "*What to do with trailing \"(was: <old subject>)\" in subject lines.
295 If nil, leave the subject unchanged.  If it is the symbol `ask', query
296 the user what do do.  In this case, the subject is matched against
297 `message-subject-trailing-was-ask-regexp'.  If
298 `message-subject-trailing-was-query' is t, always strip the trailing
299 old subject.  In this case, `message-subject-trailing-was-regexp' is
300 used."
301   :version "22.1"
302   :type '(choice (const :tag "never" nil)
303                  (const :tag "always strip" t)
304                  (const ask))
305   :link '(custom-manual "(message)Message Headers")
306   :group 'message-various)
307
308 (defcustom message-subject-trailing-was-ask-regexp
309   "[ \t]*\\([[(]+[Ww][Aa][Ss][ \t]*.*[\])]+\\)"
310   "*Regexp matching \"(was: <old subject>)\" in the subject line.
311
312 The function `message-strip-subject-trailing-was' uses this regexp if
313 `message-subject-trailing-was-query' is set to the symbol `ask'.  If
314 the variable is t instead of `ask', use
315 `message-subject-trailing-was-regexp' instead.
316
317 It is okay to create some false positives here, as the user is asked."
318   :version "22.1"
319   :group 'message-various
320   :link '(custom-manual "(message)Message Headers")
321   :type 'regexp)
322
323 (defcustom message-subject-trailing-was-regexp
324   "[ \t]*\\((*[Ww][Aa][Ss]:[ \t]*.*)\\)"
325   "*Regexp matching \"(was: <old subject>)\" in the subject line.
326
327 If `message-subject-trailing-was-query' is set to t, the subject is
328 matched against `message-subject-trailing-was-regexp' in
329 `message-strip-subject-trailing-was'.  You should use a regexp creating very
330 few false positives here."
331   :version "22.1"
332   :group 'message-various
333   :link '(custom-manual "(message)Message Headers")
334   :type 'regexp)
335
336 ;;; marking inserted text
337
338 (defcustom message-mark-insert-begin
339   "--8<---------------cut here---------------start------------->8---\n"
340   "How to mark the beginning of some inserted text."
341   :version "22.1"
342   :type 'string
343   :link '(custom-manual "(message)Insertion Variables")
344   :group 'message-various)
345
346 (defcustom message-mark-insert-end
347   "--8<---------------cut here---------------end--------------->8---\n"
348   "How to mark the end of some inserted text."
349   :version "22.1"
350   :type 'string
351   :link '(custom-manual "(message)Insertion Variables")
352   :group 'message-various)
353
354 (defcustom message-archive-header "X-No-Archive: Yes\n"
355   "Header to insert when you don't want your article to be archived.
356 Archives \(such as groups.google.com\) respect this header."
357   :version "22.1"
358   :type 'string
359   :link '(custom-manual "(message)Header Commands")
360   :group 'message-various)
361
362 (defcustom message-archive-note
363   "X-No-Archive: Yes - save http://groups.google.com/"
364   "Note to insert why you wouldn't want this posting archived.
365 If nil, don't insert any text in the body."
366   :version "22.1"
367   :type '(radio string (const nil))
368   :link '(custom-manual "(message)Header Commands")
369   :group 'message-various)
370
371 ;;; Crossposts and Followups
372 ;; inspired by JoH-followup-to by Jochem Huhman <joh  at gmx.de>
373 ;; new suggestions by R. Weikusat <rw at another.de>
374
375 (defvar message-cross-post-old-target nil
376   "Old target for cross-posts or follow-ups.")
377 (make-variable-buffer-local 'message-cross-post-old-target)
378
379 (defcustom message-cross-post-default t
380   "When non-nil `message-cross-post-followup-to' will perform a crosspost.
381 If nil, `message-cross-post-followup-to' will only do a followup.  Note that
382 you can explicitly override this setting by calling
383 `message-cross-post-followup-to' with a prefix."
384   :version "22.1"
385   :type 'boolean
386   :group 'message-various)
387
388 (defcustom message-cross-post-note "Crosspost & Followup-To: "
389   "Note to insert before signature to notify of cross-post and follow-up."
390   :version "22.1"
391   :type 'string
392   :group 'message-various)
393
394 (defcustom message-followup-to-note "Followup-To: "
395   "Note to insert before signature to notify of follow-up only."
396   :version "22.1"
397   :type 'string
398   :group 'message-various)
399
400 (defcustom message-cross-post-note-function 'message-cross-post-insert-note
401   "Function to use to insert note about Crosspost or Followup-To.
402 The function will be called with four arguments.  The function should not only
403 insert a note, but also ensure old notes are deleted.  See the documentation
404 for `message-cross-post-insert-note'."
405   :version "22.1"
406   :type 'function
407   :group 'message-various)
408
409 ;;; End of variables adopted from `message-utils.el'.
410
411 ;;;###autoload
412 (defcustom message-signature-separator "^-- *$"
413   "Regexp matching the signature separator."
414   :type 'regexp
415   :link '(custom-manual "(message)Various Message Variables")
416   :group 'message-various)
417
418 (defcustom message-elide-ellipsis "\n[...]\n\n"
419   "*The string which is inserted for elided text."
420   :type 'string
421   :link '(custom-manual "(message)Various Commands")
422   :group 'message-various)
423
424 (defcustom message-interactive t
425   "Non-nil means when sending a message wait for and display errors.
426 nil means let mailer mail back a message to report errors."
427   :group 'message-sending
428   :group 'message-mail
429   :link '(custom-manual "(message)Sending Variables")
430   :type 'boolean)
431
432 (defcustom message-generate-new-buffers 'unique
433   "*Non-nil means create a new message buffer whenever `message-setup' is called.
434 If this is a function, call that function with three parameters:  The type,
435 the to address and the group name.  (Any of these may be nil.)  The function
436 should return the new buffer name."
437   :group 'message-buffers
438   :link '(custom-manual "(message)Message Buffers")
439   :type '(choice (const :tag "off" nil)
440                  (const :tag "unique" unique)
441                  (const :tag "unsent" unsent)
442                  (function fun)))
443
444 (defcustom message-kill-buffer-on-exit nil
445   "*Non-nil means that the message buffer will be killed after sending a message."
446   :group 'message-buffers
447   :link '(custom-manual "(message)Message Buffers")
448   :type 'boolean)
449
450 (defcustom message-kill-buffer-query t
451   "*Non-nil means that killing a modified message buffer has to be confirmed.
452 This is used by `message-kill-buffer'."
453   :version "23.0" ;; No Gnus
454   :group 'message-buffers
455   :type 'boolean)
456
457 (eval-when-compile
458   (defvar gnus-local-organization))
459 (defcustom message-user-organization
460   (or (and (boundp 'gnus-local-organization)
461            (stringp gnus-local-organization)
462            gnus-local-organization)
463       (getenv "ORGANIZATION")
464       t)
465   "*String to be used as an Organization header.
466 If t, use `message-user-organization-file'."
467   :group 'message-headers
468   :type '(choice string
469                  (const :tag "consult file" t)))
470
471 ;;;###autoload
472 (defcustom message-user-organization-file "/usr/lib/news/organization"
473   "*Local news organization file."
474   :type 'file
475   :link '(custom-manual "(message)News Headers")
476   :group 'message-headers)
477
478 (defcustom message-make-forward-subject-function
479   #'message-forward-subject-name-subject
480   "*List of functions called to generate subject headers for forwarded messages.
481 The subject generated by the previous function is passed into each
482 successive function.
483
484 The provided functions are:
485
486 * `message-forward-subject-author-subject' Source of article (author or
487       newsgroup), in brackets followed by the subject
488 * `message-forward-subject-name-subject' Source of article (name of author
489       or newsgroup), in brackets followed by the subject
490 * `message-forward-subject-fwd' Subject of article with 'Fwd:' prepended
491       to it."
492   :group 'message-forwarding
493   :link '(custom-manual "(message)Forwarding")
494   :type '(radio (function-item message-forward-subject-author-subject)
495                 (function-item message-forward-subject-fwd)
496                 (function-item message-forward-subject-name-subject)
497                 (repeat :tag "List of functions" function)))
498
499 (defcustom message-forward-as-mime t
500   "*Non-nil means forward messages as an inline/rfc822 MIME section.
501 Otherwise, directly inline the old message in the forwarded message."
502   :version "21.1"
503   :group 'message-forwarding
504   :link '(custom-manual "(message)Forwarding")
505   :type 'boolean)
506
507 (defcustom message-forward-show-mml 'best
508   "*Non-nil means show forwarded messages as MML (decoded from MIME).
509 Otherwise, forwarded messages are unchanged.
510 Can also be the symbol `best' to indicate that MML should be
511 used, except when it is a bad idea to use MML.  One example where
512 it is a bad idea is when forwarding a signed or encrypted
513 message, because converting MIME to MML would invalidate the
514 digital signature."
515   :version "21.1"
516   :group 'message-forwarding
517   :type '(choice (const :tag "use MML" t)
518                  (const :tag "don't use MML " nil)
519                  (const :tag "use MML when appropriate" best)))
520
521 (defcustom message-forward-before-signature t
522   "*Non-nil means put forwarded message before signature, else after."
523   :group 'message-forwarding
524   :type 'boolean)
525
526 (defcustom message-wash-forwarded-subjects nil
527   "*Non-nil means try to remove as much cruft as possible from the subject.
528 Done before generating the new subject of a forward."
529   :group 'message-forwarding
530   :link '(custom-manual "(message)Forwarding")
531   :type 'boolean)
532
533 (defcustom message-ignored-resent-headers "^Return-receipt\\|^X-Gnus\\|^Gnus-Warning:\\|^>?From "
534   "*All headers that match this regexp will be deleted when resending a message."
535   :group 'message-interface
536   :link '(custom-manual "(message)Resending")
537   :type '(repeat :value-to-internal (lambda (widget value)
538                                       (custom-split-regexp-maybe value))
539                  :match (lambda (widget value)
540                           (or (stringp value)
541                               (widget-editable-list-match widget value)))
542                  regexp))
543
544 (defcustom message-forward-ignored-headers "^Content-Transfer-Encoding:\\|^X-Gnus"
545   "*All headers that match this regexp will be deleted when forwarding a message."
546   :version "21.1"
547   :group 'message-forwarding
548   :type '(repeat :value-to-internal (lambda (widget value)
549                                       (custom-split-regexp-maybe value))
550                  :match (lambda (widget value)
551                           (or (stringp value)
552                               (widget-editable-list-match widget value)))
553                  regexp))
554
555 (defcustom message-ignored-cited-headers "."
556   "*Delete these headers from the messages you yank."
557   :group 'message-insertion
558   :link '(custom-manual "(message)Insertion Variables")
559   :type 'regexp)
560
561 (defcustom message-cite-prefix-regexp
562   (if (string-match "[[:digit:]]" "1") ;; support POSIX?
563       "\\([ \t]*[-_.[:word:]]+>+\\|[ \t]*[]>|}+]\\)+"
564     ;; ?-, ?_ or ?. MUST NOT be in syntax entry w.
565     (let (non-word-constituents)
566       (with-syntax-table text-mode-syntax-table
567         (setq non-word-constituents
568               (concat
569                (if (string-match "\\w" "-")  "" "-")
570                (if (string-match "\\w" "_")  "" "_")
571                (if (string-match "\\w" ".")  "" "."))))
572       (if (equal non-word-constituents "")
573           "\\([ \t]*\\(\\w\\)+>+\\|[ \t]*[]>|}+]\\)+"
574         (concat "\\([ \t]*\\(\\w\\|["
575                 non-word-constituents
576                 "]\\)+>+\\|[ \t]*[]>|}+]\\)+"))))
577   "*Regexp matching the longest possible citation prefix on a line."
578   :version "22.1"
579   :group 'message-insertion
580   :link '(custom-manual "(message)Insertion Variables")
581   :type 'regexp)
582
583 (defcustom message-cancel-message "I am canceling my own article.\n"
584   "Message to be inserted in the cancel message."
585   :group 'message-interface
586   :link '(custom-manual "(message)Canceling News")
587   :type 'string)
588
589 ;; Useful to set in site-init.el
590 ;;;###autoload
591 (defcustom message-send-mail-function
592   (let ((program (if (boundp 'sendmail-program)
593                      ;; see paths.el
594                      sendmail-program)))
595     (cond
596      ((and program
597            (string-match "/" program) ;; Skip path
598            (file-executable-p program))
599       'message-send-mail-with-sendmail)
600      ((and program
601            (executable-find program))
602       'message-send-mail-with-sendmail)
603      (t
604       'smtpmail-send-it)))
605   "Function to call to send the current buffer as mail.
606 The headers should be delimited by a line whose contents match the
607 variable `mail-header-separator'.
608
609 Valid values include `message-send-mail-with-sendmail' (the default),
610 `message-send-mail-with-mh', `message-send-mail-with-qmail',
611 `message-smtpmail-send-it', `smtpmail-send-it' and `feedmail-send-it'.
612
613 See also `send-mail-function'."
614   :type '(radio (function-item message-send-mail-with-sendmail)
615                 (function-item message-send-mail-with-mh)
616                 (function-item message-send-mail-with-qmail)
617                 (function-item message-smtpmail-send-it)
618                 (function-item smtpmail-send-it)
619                 (function-item feedmail-send-it)
620                 (function :tag "Other"))
621   :group 'message-sending
622   :link '(custom-manual "(message)Mail Variables")
623   :group 'message-mail)
624
625 (defcustom message-send-news-function 'message-send-news
626   "Function to call to send the current buffer as news.
627 The headers should be delimited by a line whose contents match the
628 variable `mail-header-separator'."
629   :group 'message-sending
630   :group 'message-news
631   :link '(custom-manual "(message)News Variables")
632   :type 'function)
633
634 (defcustom message-reply-to-function nil
635   "If non-nil, function that should return a list of headers.
636 This function should pick out addresses from the To, Cc, and From headers
637 and respond with new To and Cc headers."
638   :group 'message-interface
639   :link '(custom-manual "(message)Reply")
640   :type '(choice function (const nil)))
641
642 (defcustom message-wide-reply-to-function nil
643   "If non-nil, function that should return a list of headers.
644 This function should pick out addresses from the To, Cc, and From headers
645 and respond with new To and Cc headers."
646   :group 'message-interface
647   :link '(custom-manual "(message)Wide Reply")
648   :type '(choice function (const nil)))
649
650 (defcustom message-followup-to-function nil
651   "If non-nil, function that should return a list of headers.
652 This function should pick out addresses from the To, Cc, and From headers
653 and respond with new To and Cc headers."
654   :group 'message-interface
655   :link '(custom-manual "(message)Followup")
656   :type '(choice function (const nil)))
657
658 (defcustom message-extra-wide-headers nil
659   "If non-nil, a list of additional address headers.
660 These are used when composing a wide reply."
661   :group 'message-sending
662   :type '(repeat string))
663
664 (defcustom message-use-followup-to 'ask
665   "*Specifies what to do with Followup-To header.
666 If nil, always ignore the header.  If it is t, use its value, but
667 query before using the \"poster\" value.  If it is the symbol `ask',
668 always query the user whether to use the value.  If it is the symbol
669 `use', always use the value."
670   :group 'message-interface
671   :link '(custom-manual "(message)Followup")
672   :type '(choice (const :tag "ignore" nil)
673                  (const :tag "use & query" t)
674                  (const use)
675                  (const ask)))
676
677 (defcustom message-use-mail-followup-to 'use
678   "*Specifies what to do with Mail-Followup-To header.
679 If nil, always ignore the header.  If it is the symbol `ask', always
680 query the user whether to use the value.  If it is the symbol `use',
681 always use the value."
682   :version "22.1"
683   :group 'message-interface
684   :link '(custom-manual "(message)Mailing Lists")
685   :type '(choice (const :tag "ignore" nil)
686                  (const use)
687                  (const ask)))
688
689 (defcustom message-subscribed-address-functions nil
690   "*Specifies functions for determining list subscription.
691 If nil, do not attempt to determine list subscription with functions.
692 If non-nil, this variable contains a list of functions which return
693 regular expressions to match lists.  These functions can be used in
694 conjunction with `message-subscribed-regexps' and
695 `message-subscribed-addresses'."
696   :version "22.1"
697   :group 'message-interface
698   :link '(custom-manual "(message)Mailing Lists")
699   :type '(repeat sexp))
700
701 (defcustom message-subscribed-address-file nil
702   "*A file containing addresses the user is subscribed to.
703 If nil, do not look at any files to determine list subscriptions.  If
704 non-nil, each line of this file should be a mailing list address."
705   :version "22.1"
706   :group 'message-interface
707   :link '(custom-manual "(message)Mailing Lists")
708   :type '(radio file (const nil)))
709
710 (defcustom message-subscribed-addresses nil
711   "*Specifies a list of addresses the user is subscribed to.
712 If nil, do not use any predefined list subscriptions.  This list of
713 addresses can be used in conjunction with
714 `message-subscribed-address-functions' and `message-subscribed-regexps'."
715   :version "22.1"
716   :group 'message-interface
717   :link '(custom-manual "(message)Mailing Lists")
718   :type '(repeat string))
719
720 (defcustom message-subscribed-regexps nil
721   "*Specifies a list of addresses the user is subscribed to.
722 If nil, do not use any predefined list subscriptions.  This list of
723 regular expressions can be used in conjunction with
724 `message-subscribed-address-functions' and `message-subscribed-addresses'."
725   :version "22.1"
726   :group 'message-interface
727   :link '(custom-manual "(message)Mailing Lists")
728   :type '(repeat regexp))
729
730 (defcustom message-allow-no-recipients 'ask
731   "Specifies what to do when there are no recipients other than Gcc/Fcc.
732 If it is the symbol `always', the posting is allowed.  If it is the
733 symbol `never', the posting is not allowed.  If it is the symbol
734 `ask', you are prompted."
735   :version "22.1"
736   :group 'message-interface
737   :link '(custom-manual "(message)Message Headers")
738   :type '(choice (const always)
739                  (const never)
740                  (const ask)))
741
742 (defcustom message-sendmail-f-is-evil nil
743   "*Non-nil means don't add \"-f username\" to the sendmail command line.
744 Doing so would be even more evil than leaving it out."
745   :group 'message-sending
746   :link '(custom-manual "(message)Mail Variables")
747   :type 'boolean)
748
749 (defcustom message-sendmail-envelope-from nil
750   "*Envelope-from when sending mail with sendmail.
751 If this is nil, use `user-mail-address'.  If it is the symbol
752 `header', use the From: header of the message."
753   :version "22.1"
754   :type '(choice (string :tag "From name")
755                  (const :tag "Use From: header from message" header)
756                  (const :tag "Use `user-mail-address'" nil))
757   :link '(custom-manual "(message)Mail Variables")
758   :group 'message-sending)
759
760 ;; qmail-related stuff
761 (defcustom message-qmail-inject-program "/var/qmail/bin/qmail-inject"
762   "Location of the qmail-inject program."
763   :group 'message-sending
764   :link '(custom-manual "(message)Mail Variables")
765   :type 'file)
766
767 (defcustom message-qmail-inject-args nil
768   "Arguments passed to qmail-inject programs.
769 This should be a list of strings, one string for each argument.  It
770 may also be a function.
771
772 For e.g., if you wish to set the envelope sender address so that bounces
773 go to the right place or to deal with listserv's usage of that address, you
774 might set this variable to '(\"-f\" \"you@some.where\")."
775   :group 'message-sending
776   :link '(custom-manual "(message)Mail Variables")
777   :type '(choice (function)
778                  (repeat string)))
779
780 (eval-when-compile
781   (defvar gnus-post-method)
782   (defvar gnus-select-method))
783 (defcustom message-post-method
784   (cond ((and (boundp 'gnus-post-method)
785               (listp gnus-post-method)
786               gnus-post-method)
787          gnus-post-method)
788         ((boundp 'gnus-select-method)
789          gnus-select-method)
790         (t '(nnspool "")))
791   "*Method used to post news.
792 Note that when posting from inside Gnus, for instance, this
793 variable isn't used."
794   :group 'message-news
795   :group 'message-sending
796   ;; This should be the `gnus-select-method' widget, but that might
797   ;; create a dependence to `gnus.el'.
798   :type 'sexp)
799
800 ;; FIXME: This should be a temporary workaround until someone implements a
801 ;; proper solution.  If a crash happens while replying, the auto-save file
802 ;; will *not* have a `References:' header if `message-generate-headers-first'
803 ;; is nil.  See: http://article.gmane.org/gmane.emacs.gnus.general/51138
804 (defcustom message-generate-headers-first '(references)
805   "Which headers should be generated before starting to compose a message.
806 If t, generate all required headers.  This can also be a list of headers to
807 generate.  The variables `message-required-news-headers' and
808 `message-required-mail-headers' specify which headers to generate.
809
810 Note that the variable `message-deletable-headers' specifies headers which
811 are to be deleted and then re-generated before sending, so this variable
812 will not have a visible effect for those headers."
813   :group 'message-headers
814   :link '(custom-manual "(message)Message Headers")
815   :type '(choice (const :tag "None" nil)
816                  (const :tag "References" '(references))
817                  (const :tag "All" t)
818                  (repeat (sexp :tag "Header"))))
819
820 (defcustom message-setup-hook nil
821   "Normal hook, run each time a new outgoing message is initialized.
822 The function `message-setup' runs this hook."
823   :group 'message-various
824   :link '(custom-manual "(message)Various Message Variables")
825   :type 'hook)
826
827 (defcustom message-cancel-hook nil
828   "Hook run when cancelling articles."
829   :group 'message-various
830   :link '(custom-manual "(message)Various Message Variables")
831   :type 'hook)
832
833 (defcustom message-signature-setup-hook nil
834   "Normal hook, run each time a new outgoing message is initialized.
835 It is run after the headers have been inserted and before
836 the signature is inserted."
837   :group 'message-various
838   :link '(custom-manual "(message)Various Message Variables")
839   :type 'hook)
840
841 (defcustom message-mode-hook nil
842   "Hook run in message mode buffers."
843   :group 'message-various
844   :type 'hook)
845
846 (defcustom message-header-hook nil
847   "Hook run in a message mode buffer narrowed to the headers."
848   :group 'message-various
849   :type 'hook)
850
851 (defcustom message-header-setup-hook nil
852   "Hook called narrowed to the headers when setting up a message buffer."
853   :group 'message-various
854   :link '(custom-manual "(message)Various Message Variables")
855   :type 'hook)
856
857 (defcustom message-minibuffer-local-map
858   (let ((map (make-sparse-keymap 'message-minibuffer-local-map)))
859     (set-keymap-parent map minibuffer-local-map)
860     map)
861   "Keymap for `message-read-from-minibuffer'."
862   :version "22.1"
863   :group 'message-various)
864
865 ;;;###autoload
866 (defcustom message-citation-line-function 'message-insert-citation-line
867   "*Function called to insert the \"Whomever writes:\" line.
868
869 Note that Gnus provides a feature where the reader can click on
870 `writes:' to hide the cited text.  If you change this line too much,
871 people who read your message will have to change their Gnus
872 configuration.  See the variable `gnus-cite-attribution-suffix'."
873   :type 'function
874   :link '(custom-manual "(message)Insertion Variables")
875   :group 'message-insertion)
876
877 ;;;###autoload
878 (defcustom message-yank-prefix "> "
879   "*Prefix inserted on the lines of yanked messages.
880 Fix `message-cite-prefix-regexp' if it is set to an abnormal value.
881 See also `message-yank-cited-prefix' and `message-yank-empty-prefix'."
882   :type 'string
883   :link '(custom-manual "(message)Insertion Variables")
884   :group 'message-insertion)
885
886 (defcustom message-yank-cited-prefix ">"
887   "*Prefix inserted on cited lines of yanked messages.
888 Fix `message-cite-prefix-regexp' if it is set to an abnormal value.
889 See also `message-yank-prefix' and `message-yank-empty-prefix'."
890   :version "22.1"
891   :type 'string
892   :link '(custom-manual "(message)Insertion Variables")
893   :group 'message-insertion)
894
895 (defcustom message-yank-empty-prefix ">"
896   "*Prefix inserted on empty lines of yanked messages.
897 See also `message-yank-prefix' and `message-yank-cited-prefix'."
898   :version "22.1"
899   :type 'string
900   :link '(custom-manual "(message)Insertion Variables")
901   :group 'message-insertion)
902
903 (defcustom message-indentation-spaces 3
904   "*Number of spaces to insert at the beginning of each cited line.
905 Used by `message-yank-original' via `message-yank-cite'."
906   :group 'message-insertion
907   :link '(custom-manual "(message)Insertion Variables")
908   :type 'integer)
909
910 ;;;###autoload
911 (defcustom message-cite-function 'message-cite-original
912   "*Function for citing an original message.
913 Predefined functions include `message-cite-original' and
914 `message-cite-original-without-signature'.
915 Note that these functions use `mail-citation-hook' if that is non-nil."
916   :type '(radio (function-item message-cite-original)
917                 (function-item message-cite-original-without-signature)
918                 (function-item sc-cite-original)
919                 (function :tag "Other"))
920   :link '(custom-manual "(message)Insertion Variables")
921   :group 'message-insertion)
922
923 ;;;###autoload
924 (defcustom message-indent-citation-function 'message-indent-citation
925   "*Function for modifying a citation just inserted in the mail buffer.
926 This can also be a list of functions.  Each function can find the
927 citation between (point) and (mark t).  And each function should leave
928 point and mark around the citation text as modified."
929   :type 'function
930   :link '(custom-manual "(message)Insertion Variables")
931   :group 'message-insertion)
932
933 ;;;###autoload
934 (defcustom message-signature t
935   "*String to be inserted at the end of the message buffer.
936 If t, the `message-signature-file' file will be inserted instead.
937 If a function, the result from the function will be used instead.
938 If a form, the result from the form will be used instead."
939   :type 'sexp
940   :link '(custom-manual "(message)Insertion Variables")
941   :group 'message-insertion)
942
943 ;;;###autoload
944 (defcustom message-signature-file "~/.signature"
945   "*Name of file containing the text inserted at end of message buffer.
946 Ignored if the named file doesn't exist.
947 If nil, don't insert a signature."
948   :type '(choice file (const :tags "None" nil))
949   :link '(custom-manual "(message)Insertion Variables")
950   :group 'message-insertion)
951
952 ;;;###autoload
953 (defcustom message-signature-insert-empty-line t
954   "*If non-nil, insert an empty line before the signature separator."
955   :version "22.1"
956   :type 'boolean
957   :link '(custom-manual "(message)Insertion Variables")
958   :group 'message-insertion)
959
960 (defcustom message-distribution-function nil
961   "*Function called to return a Distribution header."
962   :group 'message-news
963   :group 'message-headers
964   :link '(custom-manual "(message)News Headers")
965   :type '(choice function (const nil)))
966
967 (defcustom message-expires 14
968   "Number of days before your article expires."
969   :group 'message-news
970   :group 'message-headers
971   :link '(custom-manual "(message)News Headers")
972   :type 'integer)
973
974 (defcustom message-user-path nil
975   "If nil, use the NNTP server name in the Path header.
976 If stringp, use this; if non-nil, use no host name (user name only)."
977   :group 'message-news
978   :group 'message-headers
979   :link '(custom-manual "(message)News Headers")
980   :type '(choice (const :tag "nntp" nil)
981                  (string :tag "name")
982                  (sexp :tag "none" :format "%t" t)))
983
984 (defvar message-reply-buffer nil)
985 (defvar message-reply-headers nil
986   "The headers of the current replied article.
987 It is a vector of the following headers:
988 \[number subject from date id references chars lines xref extra].")
989 (defvar message-newsreader nil)
990 (defvar message-mailer nil)
991 (defvar message-sent-message-via nil)
992 (defvar message-checksum nil)
993 (defvar message-send-actions nil
994   "A list of actions to be performed upon successful sending of a message.")
995 (defvar message-exit-actions nil
996   "A list of actions to be performed upon exiting after sending a message.")
997 (defvar message-kill-actions nil
998   "A list of actions to be performed before killing a message buffer.")
999 (defvar message-postpone-actions nil
1000   "A list of actions to be performed after postponing a message.")
1001
1002 (define-widget 'message-header-lines 'text
1003   "All header lines must be LFD terminated."
1004   :format "%{%t%}:%n%v"
1005   :valid-regexp "^\\'"
1006   :error "All header lines must be newline terminated")
1007
1008 (defcustom message-default-headers ""
1009   "*A string containing header lines to be inserted in outgoing messages.
1010 It is inserted before you edit the message, so you can edit or delete
1011 these lines."
1012   :group 'message-headers
1013   :link '(custom-manual "(message)Message Headers")
1014   :type 'message-header-lines)
1015
1016 (defcustom message-default-mail-headers ""
1017   "*A string of header lines to be inserted in outgoing mails."
1018   :group 'message-headers
1019   :group 'message-mail
1020   :link '(custom-manual "(message)Mail Headers")
1021   :type 'message-header-lines)
1022
1023 (defcustom message-default-news-headers ""
1024   "*A string of header lines to be inserted in outgoing news articles."
1025   :group 'message-headers
1026   :group 'message-news
1027   :link '(custom-manual "(message)News Headers")
1028   :type 'message-header-lines)
1029
1030 ;; Note: could use /usr/ucb/mail instead of sendmail;
1031 ;; options -t, and -v if not interactive.
1032 (defcustom message-mailer-swallows-blank-line
1033   (if (and (string-match "sparc-sun-sunos\\(\\'\\|[^5]\\)"
1034                          system-configuration)
1035            (file-readable-p "/etc/sendmail.cf")
1036            (let ((buffer (get-buffer-create " *temp*")))
1037              (unwind-protect
1038                  (save-excursion
1039                    (set-buffer buffer)
1040                    (insert-file-contents "/etc/sendmail.cf")
1041                    (goto-char (point-min))
1042                    (let ((case-fold-search nil))
1043                      (re-search-forward "^OR\\>" nil t)))
1044                (kill-buffer buffer))))
1045       ;; According to RFC822, "The field-name must be composed of printable
1046       ;; ASCII characters (i. e., characters that have decimal values between
1047       ;; 33 and 126, except colon)", i. e., any chars except ctl chars,
1048       ;; space, or colon.
1049       '(looking-at "[ \t]\\|[][!\"#$%&'()*+,-./0-9;<=>?@A-Z\\\\^_`a-z{|}~]+:"))
1050   "*Set this non-nil if the system's mailer runs the header and body together.
1051 \(This problem exists on Sunos 4 when sendmail is run in remote mode.)
1052 The value should be an expression to test whether the problem will
1053 actually occur."
1054   :group 'message-sending
1055   :link '(custom-manual "(message)Mail Variables")
1056   :type 'sexp)
1057
1058 ;;;###autoload
1059 (define-mail-user-agent 'message-user-agent
1060   'message-mail 'message-send-and-exit
1061   'message-kill-buffer 'message-send-hook)
1062
1063 (defvar message-mh-deletable-headers '(Message-ID Date Lines Sender)
1064   "If non-nil, delete the deletable headers before feeding to mh.")
1065
1066 (defvar message-send-method-alist
1067   '((news message-news-p message-send-via-news)
1068     (mail message-mail-p message-send-via-mail))
1069   "Alist of ways to send outgoing messages.
1070 Each element has the form
1071
1072   \(TYPE PREDICATE FUNCTION)
1073
1074 where TYPE is a symbol that names the method; PREDICATE is a function
1075 called without any parameters to determine whether the message is
1076 a message of type TYPE; and FUNCTION is a function to be called if
1077 PREDICATE returns non-nil.  FUNCTION is called with one parameter --
1078 the prefix.")
1079
1080 (defcustom message-mail-alias-type 'abbrev
1081   "*What alias expansion type to use in Message buffers.
1082 The default is `abbrev', which uses mailabbrev.  nil switches
1083 mail aliases off."
1084   :group 'message
1085   :link '(custom-manual "(message)Mail Aliases")
1086   :type '(choice (const :tag "Use Mailabbrev" abbrev)
1087                  (const :tag "No expansion" nil)))
1088
1089 (defcustom message-auto-save-directory
1090   (file-name-as-directory (nnheader-concat message-directory "drafts"))
1091   "*Directory where Message auto-saves buffers if Gnus isn't running.
1092 If nil, Message won't auto-save."
1093   :group 'message-buffers
1094   :link '(custom-manual "(message)Various Message Variables")
1095   :type '(choice directory (const :tag "Don't auto-save" nil)))
1096
1097 (defcustom message-default-charset
1098   (and (not (mm-multibyte-p)) 'iso-8859-1)
1099   "Default charset used in non-MULE Emacsen.
1100 If nil, you might be asked to input the charset."
1101   :version "21.1"
1102   :group 'message
1103   :link '(custom-manual "(message)Various Message Variables")
1104   :type 'symbol)
1105
1106 (defcustom message-dont-reply-to-names
1107   (and (boundp 'rmail-dont-reply-to-names) rmail-dont-reply-to-names)
1108   "*A regexp specifying addresses to prune when doing wide replies.
1109 A value of nil means exclude your own user name only."
1110   :version "21.1"
1111   :group 'message
1112   :link '(custom-manual "(message)Wide Reply")
1113   :type '(choice (const :tag "Yourself" nil)
1114                  regexp))
1115
1116 (defvar message-shoot-gnksa-feet nil
1117   "*A list of GNKSA feet you are allowed to shoot.
1118 Gnus gives you all the opportunity you could possibly want for
1119 shooting yourself in the foot.  Also, Gnus allows you to shoot the
1120 feet of Good Net-Keeping Seal of Approval.  The following are foot
1121 candidates:
1122 `empty-article'     Allow you to post an empty article;
1123 `quoted-text-only'  Allow you to post quoted text only;
1124 `multiple-copies'   Allow you to post multiple copies;
1125 `cancel-messages'   Allow you to cancel or supersede messages from
1126                     your other email addresses.")
1127
1128 (defsubst message-gnksa-enable-p (feature)
1129   (or (not (listp message-shoot-gnksa-feet))
1130       (memq feature message-shoot-gnksa-feet)))
1131
1132 (defcustom message-hidden-headers "^References:"
1133   "Regexp of headers to be hidden when composing new messages.
1134 This can also be a list of regexps to match headers.  Or a list
1135 starting with `not' and followed by regexps."
1136   :version "22.1"
1137   :group 'message
1138   :link '(custom-manual "(message)Message Headers")
1139   :type '(choice
1140           :format "%{%t%}: %[Value Type%] %v"
1141           (regexp :menu-tag "regexp" :format "regexp\n%t: %v")
1142           (repeat :menu-tag "(regexp ...)" :format "(regexp ...)\n%v%i"
1143                   (regexp :format "%t: %v"))
1144           (cons :menu-tag "(not regexp ...)" :format "(not regexp ...)\n%v"
1145                 (const not)
1146                 (repeat :format "%v%i"
1147                         (regexp :format "%t: %v")))))
1148
1149 (defcustom message-cite-articles-with-x-no-archive t
1150   "If non-nil, cite text from articles that has X-No-Archive set."
1151   :group 'message
1152   :type 'boolean)
1153
1154 ;;; Internal variables.
1155 ;;; Well, not really internal.
1156
1157 (defvar message-mode-syntax-table
1158   (let ((table (copy-syntax-table text-mode-syntax-table)))
1159     (modify-syntax-entry ?% ". " table)
1160     (modify-syntax-entry ?> ". " table)
1161     (modify-syntax-entry ?< ". " table)
1162     table)
1163   "Syntax table used while in Message mode.")
1164
1165 (defface message-header-to
1166   '((((class color)
1167       (background dark))
1168      (:foreground "green2" :bold t))
1169     (((class color)
1170       (background light))
1171      (:foreground "MidnightBlue" :bold t))
1172     (t
1173      (:bold t :italic t)))
1174   "Face used for displaying From headers."
1175   :group 'message-faces)
1176 ;; backward-compatibility alias
1177 (put 'message-header-to-face 'face-alias 'message-header-to)
1178
1179 (defface message-header-cc
1180   '((((class color)
1181       (background dark))
1182      (:foreground "green4" :bold t))
1183     (((class color)
1184       (background light))
1185      (:foreground "MidnightBlue"))
1186     (t
1187      (:bold t)))
1188   "Face used for displaying Cc headers."
1189   :group 'message-faces)
1190 ;; backward-compatibility alias
1191 (put 'message-header-cc-face 'face-alias 'message-header-cc)
1192
1193 (defface message-header-subject
1194   '((((class color)
1195       (background dark))
1196      (:foreground "green3"))
1197     (((class color)
1198       (background light))
1199      (:foreground "navy blue" :bold t))
1200     (t
1201      (:bold t)))
1202   "Face used for displaying subject headers."
1203   :group 'message-faces)
1204 ;; backward-compatibility alias
1205 (put 'message-header-subject-face 'face-alias 'message-header-subject)
1206
1207 (defface message-header-newsgroups
1208   '((((class color)
1209       (background dark))
1210      (:foreground "yellow" :bold t :italic t))
1211     (((class color)
1212       (background light))
1213      (:foreground "blue4" :bold t :italic t))
1214     (t
1215      (:bold t :italic t)))
1216   "Face used for displaying newsgroups headers."
1217   :group 'message-faces)
1218 ;; backward-compatibility alias
1219 (put 'message-header-newsgroups-face 'face-alias 'message-header-newsgroups)
1220
1221 (defface message-header-other
1222   '((((class color)
1223       (background dark))
1224      (:foreground "#b00000"))
1225     (((class color)
1226       (background light))
1227      (:foreground "steel blue"))
1228     (t
1229      (:bold t :italic t)))
1230   "Face used for displaying newsgroups headers."
1231   :group 'message-faces)
1232 ;; backward-compatibility alias
1233 (put 'message-header-other-face 'face-alias 'message-header-other)
1234
1235 (defface message-header-name
1236   '((((class color)
1237       (background dark))
1238      (:foreground "DarkGreen"))
1239     (((class color)
1240       (background light))
1241      (:foreground "cornflower blue"))
1242     (t
1243      (:bold t)))
1244   "Face used for displaying header names."
1245   :group 'message-faces)
1246 ;; backward-compatibility alias
1247 (put 'message-header-name-face 'face-alias 'message-header-name)
1248
1249 (defface message-header-xheader
1250   '((((class color)
1251       (background dark))
1252      (:foreground "blue"))
1253     (((class color)
1254       (background light))
1255      (:foreground "blue"))
1256     (t
1257      (:bold t)))
1258   "Face used for displaying X-Header headers."
1259   :group 'message-faces)
1260 ;; backward-compatibility alias
1261 (put 'message-header-xheader-face 'face-alias 'message-header-xheader)
1262
1263 (defface message-separator
1264   '((((class color)
1265       (background dark))
1266      (:foreground "blue3"))
1267     (((class color)
1268       (background light))
1269      (:foreground "brown"))
1270     (t
1271      (:bold t)))
1272   "Face used for displaying the separator."
1273   :group 'message-faces)
1274 ;; backward-compatibility alias
1275 (put 'message-separator-face 'face-alias 'message-separator)
1276
1277 (defface message-cited-text
1278   '((((class color)
1279       (background dark))
1280      (:foreground "red"))
1281     (((class color)
1282       (background light))
1283      (:foreground "red"))
1284     (t
1285      (:bold t)))
1286   "Face used for displaying cited text names."
1287   :group 'message-faces)
1288 ;; backward-compatibility alias
1289 (put 'message-cited-text-face 'face-alias 'message-cited-text)
1290
1291 (defface message-mml
1292   '((((class color)
1293       (background dark))
1294      (:foreground "ForestGreen"))
1295     (((class color)
1296       (background light))
1297      (:foreground "ForestGreen"))
1298     (t
1299      (:bold t)))
1300   "Face used for displaying MML."
1301   :group 'message-faces)
1302 ;; backward-compatibility alias
1303 (put 'message-mml-face 'face-alias 'message-mml)
1304
1305 (defun message-font-lock-make-header-matcher (regexp)
1306   (let ((form
1307          `(lambda (limit)
1308             (let ((start (point)))
1309               (save-restriction
1310                 (widen)
1311                 (goto-char (point-min))
1312                 (if (re-search-forward
1313                      (concat "^" (regexp-quote mail-header-separator) "$")
1314                      nil t)
1315                     (setq limit (min limit (match-beginning 0))))
1316                 (goto-char start))
1317               (and (< start limit)
1318                    (re-search-forward ,regexp limit t))))))
1319     (if (featurep 'bytecomp)
1320         (byte-compile form)
1321       form)))
1322
1323 (defvar message-font-lock-keywords
1324   (let ((content "[ \t]*\\(.+\\(\n[ \t].*\\)*\\)\n?"))
1325     `((,(message-font-lock-make-header-matcher
1326          (concat "^\\([Tt]o:\\)" content))
1327        (1 'message-header-name)
1328        (2 'message-header-to nil t))
1329       (,(message-font-lock-make-header-matcher
1330          (concat "^\\(^[GBF]?[Cc][Cc]:\\|^[Rr]eply-[Tt]o:\\)" content))
1331        (1 'message-header-name)
1332        (2 'message-header-cc nil t))
1333       (,(message-font-lock-make-header-matcher
1334          (concat "^\\([Ss]ubject:\\)" content))
1335        (1 'message-header-name)
1336        (2 'message-header-subject nil t))
1337       (,(message-font-lock-make-header-matcher
1338          (concat "^\\([Nn]ewsgroups:\\|Followup-[Tt]o:\\)" content))
1339        (1 'message-header-name)
1340        (2 'message-header-newsgroups nil t))
1341       (,(message-font-lock-make-header-matcher
1342          (concat "^\\([A-Z][^: \n\t]+:\\)" content))
1343        (1 'message-header-name)
1344        (2 'message-header-other nil t))
1345       (,(message-font-lock-make-header-matcher
1346          (concat "^\\(X-[A-Za-z0-9-]+:\\|In-Reply-To:\\)" content))
1347        (1 'message-header-name)
1348        (2 'message-header-name))
1349       ,@(if (and mail-header-separator
1350                  (not (equal mail-header-separator "")))
1351             `((,(concat "^\\(" (regexp-quote mail-header-separator) "\\)$")
1352                1 'message-separator))
1353           nil)
1354       ((lambda (limit)
1355          (re-search-forward (concat "^\\("
1356                                     message-cite-prefix-regexp
1357                                     "\\).*")
1358                             limit t))
1359        (0 'message-cited-text))
1360       ("<#/?\\(multipart\\|part\\|external\\|mml\\|secure\\)[^>]*>"
1361        (0 'message-mml))))
1362   "Additional expressions to highlight in Message mode.")
1363
1364
1365 ;; XEmacs does it like this.  For Emacs, we have to set the
1366 ;; `font-lock-defaults' buffer-local variable.
1367 (put 'message-mode 'font-lock-defaults '(message-font-lock-keywords t))
1368
1369 (defvar message-face-alist
1370   '((bold . bold-region)
1371     (underline . underline-region)
1372     (default . (lambda (b e)
1373                  (unbold-region b e)
1374                  (ununderline-region b e))))
1375   "Alist of mail and news faces for facemenu.
1376 The cdr of each entry is a function for applying the face to a region.")
1377
1378 (defcustom message-send-hook nil
1379   "Hook run before sending messages.
1380 This hook is run quite early when sending."
1381   :group 'message-various
1382   :options '(ispell-message)
1383   :link '(custom-manual "(message)Various Message Variables")
1384   :type 'hook)
1385
1386 (defcustom message-send-mail-hook nil
1387   "Hook run before sending mail messages.
1388 This hook is run very late -- just before the message is sent as
1389 mail."
1390   :group 'message-various
1391   :link '(custom-manual "(message)Various Message Variables")
1392   :type 'hook)
1393
1394 (defcustom message-send-news-hook nil
1395   "Hook run before sending news messages.
1396 This hook is run very late -- just before the message is sent as
1397 news."
1398   :group 'message-various
1399   :link '(custom-manual "(message)Various Message Variables")
1400   :type 'hook)
1401
1402 (defcustom message-sent-hook nil
1403   "Hook run after sending messages."
1404   :group 'message-various
1405   :type 'hook)
1406
1407 (defvar message-send-coding-system 'binary
1408   "Coding system to encode outgoing mail.")
1409
1410 (defvar message-draft-coding-system
1411   mm-auto-save-coding-system
1412   "*Coding system to compose mail.
1413 If you'd like to make it possible to share draft files between XEmacs
1414 and Emacs, you may use `iso-2022-7bit' for this value at your own risk.
1415 Note that the coding-system `iso-2022-7bit' isn't suitable to all data.")
1416
1417 (defcustom message-send-mail-partially-limit 1000000
1418   "The limitation of messages sent as message/partial.
1419 The lower bound of message size in characters, beyond which the message
1420 should be sent in several parts.  If it is nil, the size is unlimited."
1421   :version "21.1"
1422   :group 'message-buffers
1423   :link '(custom-manual "(message)Mail Variables")
1424   :type '(choice (const :tag "unlimited" nil)
1425                  (integer 1000000)))
1426
1427 (defcustom message-alternative-emails nil
1428   "*Regexp matching alternative email addresses.
1429 The first address in the To, Cc or From headers of the original
1430 article matching this variable is used as the From field of
1431 outgoing messages.
1432
1433 This variable has precedence over posting styles and anything that runs
1434 off `message-setup-hook'."
1435   :group 'message-headers
1436   :link '(custom-manual "(message)Message Headers")
1437   :type '(choice (const :tag "Always use primary" nil)
1438                  regexp))
1439
1440 (defcustom message-hierarchical-addresses nil
1441   "A list of hierarchical mail address definitions.
1442
1443 Inside each entry, the first address is the \"top\" address, and
1444 subsequent addresses are subaddresses; this is used to indicate that
1445 mail sent to the first address will automatically be delivered to the
1446 subaddresses.  So if the first address appears in the recipient list
1447 for a message, the subaddresses will be removed (if present) before
1448 the mail is sent.  All addresses in this structure should be
1449 downcased."
1450   :version "22.1"
1451   :group 'message-headers
1452   :type '(repeat (repeat string)))
1453
1454 (defcustom message-mail-user-agent nil
1455   "Like `mail-user-agent'.
1456 Except if it is nil, use Gnus native MUA; if it is t, use
1457 `mail-user-agent'."
1458   :version "22.1"
1459   :type '(radio (const :tag "Gnus native"
1460                        :format "%t\n"
1461                        nil)
1462                 (const :tag "`mail-user-agent'"
1463                        :format "%t\n"
1464                        t)
1465                 (function-item :tag "Default Emacs mail"
1466                                :format "%t\n"
1467                                sendmail-user-agent)
1468                 (function-item :tag "Emacs interface to MH"
1469                                :format "%t\n"
1470                                mh-e-user-agent)
1471                 (function :tag "Other"))
1472   :version "21.1"
1473   :group 'message)
1474
1475 (defcustom message-wide-reply-confirm-recipients nil
1476   "Whether to confirm a wide reply to multiple email recipients.
1477 If this variable is nil, don't ask whether to reply to all recipients.
1478 If this variable is non-nil, pose the question \"Reply to all
1479 recipients?\" before a wide reply to multiple recipients.  If the user
1480 answers yes, reply to all recipients as usual.  If the user answers
1481 no, only reply back to the author."
1482   :version "22.1"
1483   :group 'message-headers
1484   :link '(custom-manual "(message)Wide Reply")
1485   :type 'boolean)
1486
1487 (defcustom message-user-fqdn nil
1488   "*Domain part of Message-Ids."
1489   :version "22.1"
1490   :group 'message-headers
1491   :link '(custom-manual "(message)News Headers")
1492   :type '(radio (const :format "%v  " nil)
1493                 (string :format "FQDN: %v")))
1494
1495 (defcustom message-use-idna (and (condition-case nil (require 'idna)
1496                                    (file-error))
1497                                  (mm-coding-system-p 'utf-8)
1498                                  (executable-find idna-program)
1499                                  'ask)
1500   "Whether to encode non-ASCII in domain names into ASCII according to IDNA."
1501   :version "22.1"
1502   :group 'message-headers
1503   :link '(custom-manual "(message)IDNA")
1504   :type '(choice (const :tag "Ask" ask)
1505                  (const :tag "Never" nil)
1506                  (const :tag "Always" t)))
1507
1508 (defcustom message-generate-hashcash nil
1509   "*Whether to generate X-Hashcash: headers.
1510 You must have the \"hashcash\" binary installed, see `hashcash-path'."
1511   :group 'message-headers
1512   :link '(custom-manual "(message)Mail Headers")
1513   :type 'boolean)
1514
1515 ;;; Internal variables.
1516
1517 (defvar message-sending-message "Sending...")
1518 (defvar message-buffer-list nil)
1519 (defvar message-this-is-news nil)
1520 (defvar message-this-is-mail nil)
1521 (defvar message-draft-article nil)
1522 (defvar message-mime-part nil)
1523 (defvar message-posting-charset nil)
1524 (defvar message-inserted-headers nil)
1525
1526 ;; Byte-compiler warning
1527 (eval-when-compile
1528   (defvar gnus-active-hashtb)
1529   (defvar gnus-read-active-file))
1530
1531 ;;; Regexp matching the delimiter of messages in UNIX mail format
1532 ;;; (UNIX From lines), minus the initial ^.  It should be a copy
1533 ;;; of rmail.el's rmail-unix-mail-delimiter.
1534 (defvar message-unix-mail-delimiter
1535   (let ((time-zone-regexp
1536          (concat "\\([A-Z]?[A-Z]?[A-Z][A-Z]\\( DST\\)?"
1537                  "\\|[-+]?[0-9][0-9][0-9][0-9]"
1538                  "\\|"
1539                  "\\) *")))
1540     (concat
1541      "From "
1542
1543      ;; Many things can happen to an RFC 822 mailbox before it is put into
1544      ;; a `From' line.  The leading phrase can be stripped, e.g.
1545      ;; `Joe <@w.x:joe@y.z>' -> `<@w.x:joe@y.z>'.  The <> can be stripped, e.g.
1546      ;; `<@x.y:joe@y.z>' -> `@x.y:joe@y.z'.  Everything starting with a CRLF
1547      ;; can be removed, e.g.
1548      ;;         From: joe@y.z (Joe      K
1549      ;;                 User)
1550      ;; can yield `From joe@y.z (Joe    K Fri Mar 22 08:11:15 1996', and
1551      ;;         From: Joe User
1552      ;;                 <joe@y.z>
1553      ;; can yield `From Joe User Fri Mar 22 08:11:15 1996'.
1554      ;; The mailbox can be removed or be replaced by white space, e.g.
1555      ;;         From: "Joe User"{space}{tab}
1556      ;;                 <joe@y.z>
1557      ;; can yield `From {space}{tab} Fri Mar 22 08:11:15 1996',
1558      ;; where {space} and {tab} represent the Ascii space and tab characters.
1559      ;; We want to match the results of any of these manglings.
1560      ;; The following regexp rejects names whose first characters are
1561      ;; obviously bogus, but after that anything goes.
1562      "\\([^\0-\b\n-\r\^?].*\\)?"
1563
1564      ;; The time the message was sent.
1565      "\\([^\0-\r \^?]+\\) +"            ; day of the week
1566      "\\([^\0-\r \^?]+\\) +"            ; month
1567      "\\([0-3]?[0-9]\\) +"              ; day of month
1568      "\\([0-2][0-9]:[0-5][0-9]\\(:[0-6][0-9]\\)?\\) *" ; time of day
1569
1570      ;; Perhaps a time zone, specified by an abbreviation, or by a
1571      ;; numeric offset.
1572      time-zone-regexp
1573
1574      ;; The year.
1575      " \\([0-9][0-9]+\\) *"
1576
1577      ;; On some systems the time zone can appear after the year, too.
1578      time-zone-regexp
1579
1580      ;; Old uucp cruft.
1581      "\\(remote from .*\\)?"
1582
1583      "\n"))
1584   "Regexp matching the delimiter of messages in UNIX mail format.")
1585
1586 (defvar message-unsent-separator
1587   (concat "^ *---+ +Unsent message follows +---+ *$\\|"
1588           "^ *---+ +Returned message +---+ *$\\|"
1589           "^Start of returned message$\\|"
1590           "^ *---+ +Original message +---+ *$\\|"
1591           "^ *--+ +begin message +--+ *$\\|"
1592           "^ *---+ +Original message follows +---+ *$\\|"
1593           "^ *---+ +Undelivered message follows +---+ *$\\|"
1594           "^|? *---+ +Message text follows: +---+ *|?$")
1595   "A regexp that matches the separator before the text of a failed message.")
1596
1597 (defvar message-field-fillers
1598   '((To message-fill-field-address)
1599     (Cc message-fill-field-address)
1600     (From message-fill-field-address))
1601   "Alist of header names/filler functions.")
1602
1603 (defvar message-header-format-alist
1604   `((From)
1605     (Newsgroups)
1606     (To)
1607     (Cc)
1608     (Subject)
1609     (In-Reply-To)
1610     (Fcc)
1611     (Bcc)
1612     (Date)
1613     (Organization)
1614     (Distribution)
1615     (Lines)
1616     (Expires)
1617     (Message-ID)
1618     (References . message-shorten-references)
1619     (User-Agent))
1620   "Alist used for formatting headers.")
1621
1622 (defvar message-options nil
1623   "Some saved answers when sending message.")
1624
1625 (defvar message-send-mail-real-function nil
1626   "Internal send mail function.")
1627
1628 (defvar message-bogus-system-names "^localhost\\."
1629   "The regexp of bogus system names.")
1630
1631 (defcustom message-valid-fqdn-regexp
1632   (concat "[a-z0-9][-.a-z0-9]+\\." ;; [hostname.subdomain.]domain.
1633           ;; valid TLDs:
1634           "\\([a-z][a-z]" ;; two letter country TDLs
1635           "\\|biz\\|com\\|edu\\|gov\\|int\\|mil\\|net\\|org"
1636           "\\|aero\\|coop\\|info\\|name\\|museum"
1637           "\\|arpa\\|pro\\|uucp\\|bitnet\\|bofh" ;; old style?
1638           "\\)")
1639   "Regular expression that matches a valid FQDN."
1640   ;; see also: gnus-button-valid-fqdn-regexp
1641   :version "22.1"
1642   :group 'message-headers
1643   :type 'regexp)
1644
1645 (eval-and-compile
1646   (autoload 'gnus-alive-p "gnus-util")
1647   (autoload 'gnus-delay-article "gnus-delay")
1648   (autoload 'gnus-extract-address-components "gnus-util")
1649   (autoload 'gnus-find-method-for-group "gnus")
1650   (autoload 'gnus-group-decoded-name "gnus-group")
1651   (autoload 'gnus-group-name-charset "gnus-group")
1652   (autoload 'gnus-group-name-decode "gnus-group")
1653   (autoload 'gnus-groups-from-server "gnus")
1654   (autoload 'gnus-make-local-hook "gnus-util")
1655   (autoload 'gnus-open-server "gnus-int")
1656   (autoload 'gnus-output-to-mail "gnus-util")
1657   (autoload 'gnus-output-to-rmail "gnus-util")
1658   (autoload 'gnus-request-post "gnus-int")
1659   (autoload 'gnus-server-string "gnus")
1660   (autoload 'idna-to-ascii "idna")
1661   (autoload 'message-setup-toolbar "messagexmas")
1662   (autoload 'mh-new-draft-name "mh-comp")
1663   (autoload 'mh-send-letter "mh-comp")
1664   (autoload 'nndraft-request-associate-buffer "nndraft")
1665   (autoload 'nndraft-request-expire-articles "nndraft")
1666   (autoload 'nnvirtual-find-group-art "nnvirtual")
1667   (autoload 'rmail-dont-reply-to "mail-utils")
1668   (autoload 'rmail-msg-is-pruned "rmail")
1669   (autoload 'rmail-msg-restore-non-pruned-header "rmail")
1670   (autoload 'rmail-output "rmailout"))
1671
1672 \f
1673
1674 ;;;
1675 ;;; Utility functions.
1676 ;;;
1677
1678 (defmacro message-y-or-n-p (question show &rest text)
1679   "Ask QUESTION, displaying remaining args in a temporary buffer if SHOW."
1680   `(message-talkative-question 'y-or-n-p ,question ,show ,@text))
1681
1682 (defmacro message-delete-line (&optional n)
1683   "Delete the current line (and the next N lines)."
1684   `(delete-region (progn (beginning-of-line) (point))
1685                   (progn (forward-line ,(or n 1)) (point))))
1686
1687 (defun message-mark-active-p ()
1688   "Non-nil means the mark and region are currently active in this buffer."
1689   mark-active)
1690
1691 (defun message-unquote-tokens (elems)
1692   "Remove double quotes (\") from strings in list ELEMS."
1693   (mapcar (lambda (item)
1694             (while (string-match "^\\(.*\\)\"\\(.*\\)$" item)
1695               (setq item (concat (match-string 1 item)
1696                                  (match-string 2 item))))
1697             item)
1698           elems))
1699
1700 (defun message-tokenize-header (header &optional separator)
1701   "Split HEADER into a list of header elements.
1702 SEPARATOR is a string of characters to be used as separators.  \",\"
1703 is used by default."
1704   (if (not header)
1705       nil
1706     (let ((regexp (format "[%s]+" (or separator ",")))
1707           (first t)
1708           beg quoted elems paren)
1709       (with-temp-buffer
1710         (mm-enable-multibyte)
1711         (setq beg (point-min))
1712         (insert header)
1713         (goto-char (point-min))
1714         (while (not (eobp))
1715           (if first
1716               (setq first nil)
1717             (forward-char 1))
1718           (cond ((and (> (point) beg)
1719                       (or (eobp)
1720                           (and (looking-at regexp)
1721                                (not quoted)
1722                                (not paren))))
1723                  (push (buffer-substring beg (point)) elems)
1724                  (setq beg (match-end 0)))
1725                 ((eq (char-after) ?\")
1726                  (setq quoted (not quoted)))
1727                 ((and (eq (char-after) ?\()
1728                       (not quoted))
1729                  (setq paren t))
1730                 ((and (eq (char-after) ?\))
1731                       (not quoted))
1732                  (setq paren nil))))
1733         (nreverse elems)))))
1734
1735 (defun message-mail-file-mbox-p (file)
1736   "Say whether FILE looks like a Unix mbox file."
1737   (when (and (file-exists-p file)
1738              (file-readable-p file)
1739              (file-regular-p file))
1740     (with-temp-buffer
1741       (nnheader-insert-file-contents file)
1742       (goto-char (point-min))
1743       (looking-at message-unix-mail-delimiter))))
1744
1745 (defun message-fetch-field (header &optional not-all)
1746   "The same as `mail-fetch-field', only remove all newlines.
1747 The buffer is expected to be narrowed to just the header of the message;
1748 see `message-narrow-to-headers-or-head'."
1749   (let* ((inhibit-point-motion-hooks t)
1750          (value (mail-fetch-field header nil (not not-all))))
1751     (when value
1752       (while (string-match "\n[\t ]+" value)
1753         (setq value (replace-match " " t t value)))
1754       value)))
1755
1756 (defun message-field-value (header &optional not-all)
1757   "The same as `message-fetch-field', only narrow to the headers first."
1758   (save-excursion
1759     (save-restriction
1760       (message-narrow-to-headers-or-head)
1761       (message-fetch-field header not-all))))
1762
1763 (defun message-narrow-to-field ()
1764   "Narrow the buffer to the header on the current line."
1765   (beginning-of-line)
1766   (while (looking-at "[ \t]")
1767     (forward-line -1))
1768   (narrow-to-region
1769    (point)
1770    (progn
1771      (forward-line 1)
1772      (if (re-search-forward "^[^ \n\t]" nil t)
1773          (point-at-bol)
1774        (point-max))))
1775   (goto-char (point-min)))
1776
1777 (defun message-add-header (&rest headers)
1778   "Add the HEADERS to the message header, skipping those already present."
1779   (while headers
1780     (let (hclean)
1781       (unless (string-match "^\\([^:]+\\):[ \t]*[^ \t]" (car headers))
1782         (error "Invalid header `%s'" (car headers)))
1783       (setq hclean (match-string 1 (car headers)))
1784       (save-restriction
1785         (message-narrow-to-headers)
1786         (unless (re-search-forward (concat "^" (regexp-quote hclean) ":") nil t)
1787           (goto-char (point-max))
1788           (if (string-match "\n$" (car headers))
1789               (insert (car headers))
1790             (insert (car headers) ?\n)))))
1791     (setq headers (cdr headers))))
1792
1793 (defmacro message-with-reply-buffer (&rest forms)
1794   "Evaluate FORMS in the reply buffer, if it exists."
1795   `(when (and message-reply-buffer
1796               (buffer-name message-reply-buffer))
1797      (save-excursion
1798        (set-buffer message-reply-buffer)
1799        ,@forms)))
1800
1801 (put 'message-with-reply-buffer 'lisp-indent-function 0)
1802 (put 'message-with-reply-buffer 'edebug-form-spec '(body))
1803
1804 (defun message-fetch-reply-field (header)
1805   "Fetch field HEADER from the message we're replying to."
1806   (message-with-reply-buffer
1807     (save-restriction
1808       (mail-narrow-to-head)
1809       (message-fetch-field header))))
1810
1811 (defun message-strip-list-identifiers (subject)
1812   "Remove list identifiers in `gnus-list-identifiers' from string SUBJECT."
1813   (require 'gnus-sum)                   ; for gnus-list-identifiers
1814   (let ((regexp (if (stringp gnus-list-identifiers)
1815                     gnus-list-identifiers
1816                   (mapconcat 'identity gnus-list-identifiers " *\\|"))))
1817     (if (string-match (concat "\\(\\(\\(Re: +\\)?\\(" regexp
1818                               " *\\)\\)+\\(Re: +\\)?\\)") subject)
1819         (concat (substring subject 0 (match-beginning 1))
1820                 (or (match-string 3 subject)
1821                     (match-string 5 subject))
1822                 (substring subject
1823                            (match-end 1)))
1824       subject)))
1825
1826 (defun message-strip-subject-re (subject)
1827   "Remove \"Re:\" from subject lines in string SUBJECT."
1828   (if (string-match message-subject-re-regexp subject)
1829       (substring subject (match-end 0))
1830     subject))
1831
1832 ;;; Start of functions adopted from `message-utils.el'.
1833
1834 (defun message-strip-subject-trailing-was (subject)
1835   "Remove trailing \"(was: <old subject>)\" from SUBJECT lines.
1836 Leading \"Re: \" is not stripped by this function.  Use the function
1837 `message-strip-subject-re' for this."
1838   (let* ((query message-subject-trailing-was-query)
1839          (new) (found))
1840     (setq found
1841           (string-match
1842            (if (eq query 'ask)
1843                message-subject-trailing-was-ask-regexp
1844              message-subject-trailing-was-regexp)
1845            subject))
1846     (if found
1847         (setq new (substring subject 0 (match-beginning 0))))
1848     (if (or (not found) (eq query nil))
1849         subject
1850       (if (eq query 'ask)
1851           (if (message-y-or-n-p
1852                "Strip `(was: <old subject>)' in subject? " t
1853                (concat
1854                 "Strip `(was: <old subject>)' in subject "
1855                 "and use the new one instead?\n\n"
1856                 "Current subject is:   \""
1857                 subject "\"\n\n"
1858                 "New subject would be: \""
1859                 new "\"\n\n"
1860                 "See the variable `message-subject-trailing-was-query' "
1861                 "to get rid of this query."
1862                 ))
1863               new subject)
1864         new))))
1865
1866 ;;; Suggested by Jonas Steverud  @  www.dtek.chalmers.se/~d4jonas/
1867
1868 ;;;###autoload
1869 (defun message-change-subject (new-subject)
1870   "Ask for NEW-SUBJECT header, append (was: <Old Subject>)."
1871   ;; <URL:http://www.landfield.com/usefor/drafts/draft-ietf-usefor-useage--1.02.unpaged>
1872   (interactive
1873    (list
1874     (read-from-minibuffer "New subject: ")))
1875   (cond ((and (not (or (null new-subject) ; new subject not empty
1876                        (zerop (string-width new-subject))
1877                        (string-match "^[ \t]*$" new-subject))))
1878          (save-excursion
1879            (let ((old-subject
1880                   (save-restriction
1881                     (message-narrow-to-headers)
1882                     (message-fetch-field "Subject"))))
1883              (cond ((not old-subject)
1884                     (error "No current subject"))
1885                    ((not (string-match
1886                           (concat "^[ \t]*"
1887                                   (regexp-quote new-subject)
1888                                   " \t]*$")
1889                           old-subject))  ; yes, it really is a new subject
1890                     ;; delete eventual Re: prefix
1891                     (setq old-subject
1892                           (message-strip-subject-re old-subject))
1893                     (message-goto-subject)
1894                     (message-delete-line)
1895                     (insert (concat "Subject: "
1896                                     new-subject
1897                                     " (was: "
1898                                     old-subject ")\n")))))))))
1899
1900 ;;;###autoload
1901 (defun message-mark-inserted-region (beg end)
1902   "Mark some region in the current article with enclosing tags.
1903 See `message-mark-insert-begin' and `message-mark-insert-end'."
1904   (interactive "r")
1905   (save-excursion
1906     ;; add to the end of the region first, otherwise end would be invalid
1907     (goto-char end)
1908     (insert message-mark-insert-end)
1909     (goto-char beg)
1910     (insert message-mark-insert-begin)))
1911
1912 ;;;###autoload
1913 (defun message-mark-insert-file (file)
1914   "Insert FILE at point, marking it with enclosing tags.
1915 See `message-mark-insert-begin' and `message-mark-insert-end'."
1916   (interactive "fFile to insert: ")
1917     ;; reverse insertion to get correct result.
1918   (let ((p (point)))
1919     (insert message-mark-insert-end)
1920     (goto-char p)
1921     (insert-file-contents file)
1922     (goto-char p)
1923     (insert message-mark-insert-begin)))
1924
1925 ;;;###autoload
1926 (defun message-add-archive-header ()
1927   "Insert \"X-No-Archive: Yes\" in the header and a note in the body.
1928 The note can be customized using `message-archive-note'.  When called with a
1929 prefix argument, ask for a text to insert.  If you don't want the note in the
1930 body, set  `message-archive-note' to nil."
1931   (interactive)
1932   (if current-prefix-arg
1933       (setq message-archive-note
1934             (read-from-minibuffer "Reason for No-Archive: "
1935                                   (cons message-archive-note 0))))
1936     (save-excursion
1937       (if (message-goto-signature)
1938           (re-search-backward message-signature-separator))
1939       (when message-archive-note
1940         (insert message-archive-note)
1941         (newline))
1942       (message-add-header message-archive-header)
1943       (message-sort-headers)))
1944
1945 ;;;###autoload
1946 (defun message-cross-post-followup-to-header (target-group)
1947   "Mangles FollowUp-To and Newsgroups header to point to TARGET-GROUP.
1948 With prefix-argument just set Follow-Up, don't cross-post."
1949   (interactive
1950    (list ; Completion based on Gnus
1951     (completing-read "Followup To: "
1952                      (if (boundp 'gnus-newsrc-alist)
1953                          gnus-newsrc-alist)
1954                      nil nil '("poster" . 0)
1955                      (if (boundp 'gnus-group-history)
1956                          'gnus-group-history))))
1957   (message-remove-header "Follow[Uu]p-[Tt]o" t)
1958   (message-goto-newsgroups)
1959   (beginning-of-line)
1960   ;; if we already did a crosspost before, kill old target
1961   (if (and message-cross-post-old-target
1962            (re-search-forward
1963             (regexp-quote (concat "," message-cross-post-old-target))
1964             nil t))
1965       (replace-match ""))
1966   ;; unless (followup is to poster or user explicitly asked not
1967   ;; to cross-post, or target-group is already in Newsgroups)
1968   ;; add target-group to Newsgroups line.
1969   (cond ((and (or
1970                ;; def: cross-post, req:no
1971                (and message-cross-post-default (not current-prefix-arg))
1972                ;; def: no-cross-post, req:yes
1973                (and (not message-cross-post-default) current-prefix-arg))
1974               (not (string-match "poster" target-group))
1975               (not (string-match (regexp-quote target-group)
1976                                  (message-fetch-field "Newsgroups"))))
1977          (end-of-line)
1978          (insert (concat "," target-group))))
1979   (end-of-line) ; ensure Followup: comes after Newsgroups:
1980   ;; unless new followup would be identical to Newsgroups line
1981   ;; make a new Followup-To line
1982   (if (not (string-match (concat "^[ \t]*"
1983                                  target-group
1984                                  "[ \t]*$")
1985                          (message-fetch-field "Newsgroups")))
1986       (insert (concat "\nFollowup-To: " target-group)))
1987   (setq message-cross-post-old-target target-group))
1988
1989 ;;;###autoload
1990 (defun message-cross-post-insert-note (target-group cross-post in-old
1991                                                     old-groups)
1992   "Insert a in message body note about a set Followup or Crosspost.
1993 If there have been previous notes, delete them.  TARGET-GROUP specifies the
1994 group to Followup-To.  When CROSS-POST is t, insert note about
1995 crossposting.  IN-OLD specifies whether TARGET-GROUP is a member of
1996 OLD-GROUPS.  OLD-GROUPS lists the old-groups the posting would have
1997 been made to before the user asked for a Crosspost."
1998   ;; start scanning body for previous uses
1999   (message-goto-signature)
2000   (let ((head (re-search-backward
2001                (concat "^" mail-header-separator)
2002                nil t))) ; just search in body
2003     (message-goto-signature)
2004     (while (re-search-backward
2005             (concat "^" (regexp-quote message-cross-post-note) ".*")
2006             head t)
2007       (message-delete-line))
2008     (message-goto-signature)
2009     (while (re-search-backward
2010             (concat "^" (regexp-quote message-followup-to-note) ".*")
2011             head t)
2012       (message-delete-line))
2013     ;; insert new note
2014     (if (message-goto-signature)
2015         (re-search-backward message-signature-separator))
2016     (if (or in-old
2017             (not cross-post)
2018             (string-match "^[ \t]*poster[ \t]*$" target-group))
2019         (insert (concat message-followup-to-note target-group "\n"))
2020       (insert (concat message-cross-post-note target-group "\n")))))
2021
2022 ;;;###autoload
2023 (defun message-cross-post-followup-to (target-group)
2024   "Crossposts message and set Followup-To to TARGET-GROUP.
2025 With prefix-argument just set Follow-Up, don't cross-post."
2026   (interactive
2027    (list ; Completion based on Gnus
2028     (completing-read "Followup To: "
2029                      (if (boundp 'gnus-newsrc-alist)
2030                          gnus-newsrc-alist)
2031                      nil nil '("poster" . 0)
2032                      (if (boundp 'gnus-group-history)
2033                          'gnus-group-history))))
2034   (cond ((not (or (null target-group) ; new subject not empty
2035                   (zerop (string-width target-group))
2036                   (string-match "^[ \t]*$" target-group)))
2037          (save-excursion
2038            (let* ((old-groups (message-fetch-field "Newsgroups"))
2039                   (in-old (string-match
2040                            (regexp-quote target-group)
2041                            (or old-groups ""))))
2042              ;; check whether target exactly matches old Newsgroups
2043              (cond ((not old-groups)
2044                     (error "No current newsgroup"))
2045                    ((or (not in-old)
2046                         (not (string-match
2047                               (concat "^[ \t]*"
2048                                       (regexp-quote target-group)
2049                                       "[ \t]*$")
2050                               old-groups)))
2051                     ;; yes, Newsgroups line must change
2052                     (message-cross-post-followup-to-header target-group)
2053                     ;; insert note whether we do cross-post or followup-to
2054                     (funcall message-cross-post-note-function
2055                              target-group
2056                              (if (or (and message-cross-post-default
2057                                           (not current-prefix-arg))
2058                                      (and (not message-cross-post-default)
2059                                           current-prefix-arg)) t)
2060                              in-old old-groups))))))))
2061
2062 ;;; Reduce To: to Cc: or Bcc: header
2063
2064 ;;;###autoload
2065 (defun message-reduce-to-to-cc ()
2066  "Replace contents of To: header with contents of Cc: or Bcc: header."
2067  (interactive)
2068  (let ((cc-content
2069         (save-restriction (message-narrow-to-headers)
2070                           (message-fetch-field "cc")))
2071        (bcc nil))
2072    (if (and (not cc-content)
2073             (setq cc-content
2074                   (save-restriction
2075                     (message-narrow-to-headers)
2076                     (message-fetch-field "bcc"))))
2077        (setq bcc t))
2078    (cond (cc-content
2079           (save-excursion
2080             (message-goto-to)
2081             (message-delete-line)
2082             (insert (concat "To: " cc-content "\n"))
2083             (save-restriction
2084               (message-narrow-to-headers)
2085               (message-remove-header (if bcc
2086                                          "bcc"
2087                                        "cc"))))))))
2088
2089 ;;; End of functions adopted from `message-utils.el'.
2090
2091 (defun message-remove-header (header &optional is-regexp first reverse)
2092   "Remove HEADER in the narrowed buffer.
2093 If IS-REGEXP, HEADER is a regular expression.
2094 If FIRST, only remove the first instance of the header.
2095 Return the number of headers removed."
2096   (goto-char (point-min))
2097   (let ((regexp (if is-regexp header (concat "^" (regexp-quote header) ":")))
2098         (number 0)
2099         (case-fold-search t)
2100         last)
2101     (while (and (not (eobp))
2102                 (not last))
2103       (if (if reverse
2104               (not (looking-at regexp))
2105             (looking-at regexp))
2106           (progn
2107             (incf number)
2108             (when first
2109               (setq last t))
2110             (delete-region
2111              (point)
2112              ;; There might be a continuation header, so we have to search
2113              ;; until we find a new non-continuation line.
2114              (progn
2115                (forward-line 1)
2116                (if (re-search-forward "^[^ \t]" nil t)
2117                    (goto-char (match-beginning 0))
2118                  (point-max)))))
2119         (forward-line 1)
2120         (if (re-search-forward "^[^ \t]" nil t)
2121             (goto-char (match-beginning 0))
2122           (goto-char (point-max)))))
2123     number))
2124
2125 (defun message-remove-first-header (header)
2126   "Remove the first instance of HEADER if there is more than one."
2127   (let ((count 0)
2128         (regexp (concat "^" (regexp-quote header) ":")))
2129     (save-excursion
2130       (goto-char (point-min))
2131       (while (re-search-forward regexp nil t)
2132         (incf count)))
2133     (while (> count 1)
2134       (message-remove-header header nil t)
2135       (decf count))))
2136
2137 (defun message-narrow-to-headers ()
2138   "Narrow the buffer to the head of the message."
2139   (widen)
2140   (narrow-to-region
2141    (goto-char (point-min))
2142    (if (re-search-forward
2143         (concat "^" (regexp-quote mail-header-separator) "\n") nil t)
2144        (match-beginning 0)
2145      (point-max)))
2146   (goto-char (point-min)))
2147
2148 (defun message-narrow-to-head-1 ()
2149   "Like `message-narrow-to-head'.  Don't widen."
2150   (narrow-to-region
2151    (goto-char (point-min))
2152    (if (search-forward "\n\n" nil 1)
2153        (1- (point))
2154      (point-max)))
2155   (goto-char (point-min)))
2156
2157 (defun message-narrow-to-head ()
2158   "Narrow the buffer to the head of the message.
2159 Point is left at the beginning of the narrowed-to region."
2160   (widen)
2161   (message-narrow-to-head-1))
2162
2163 (defun message-narrow-to-headers-or-head ()
2164   "Narrow the buffer to the head of the message."
2165   (widen)
2166   (narrow-to-region
2167    (goto-char (point-min))
2168    (cond
2169     ((re-search-forward
2170       (concat "^" (regexp-quote mail-header-separator) "\n") nil t)
2171      (match-beginning 0))
2172     ((search-forward "\n\n" nil t)
2173      (1- (point)))
2174     (t
2175      (point-max))))
2176   (goto-char (point-min)))
2177
2178 (defun message-news-p ()
2179   "Say whether the current buffer contains a news message."
2180   (and (not message-this-is-mail)
2181        (or message-this-is-news
2182            (save-excursion
2183              (save-restriction
2184                (message-narrow-to-headers)
2185                (and (message-fetch-field "newsgroups")
2186                     (not (message-fetch-field "posted-to"))))))))
2187
2188 (defun message-mail-p ()
2189   "Say whether the current buffer contains a mail message."
2190   (and (not message-this-is-news)
2191        (or message-this-is-mail
2192            (save-excursion
2193              (save-restriction
2194                (message-narrow-to-headers)
2195                (or (message-fetch-field "to")
2196                    (message-fetch-field "cc")
2197                    (message-fetch-field "bcc")))))))
2198
2199 (defun message-subscribed-p ()
2200   "Say whether we need to insert a MFT header."
2201   (or message-subscribed-regexps
2202       message-subscribed-addresses
2203       message-subscribed-address-file
2204       message-subscribed-address-functions))
2205
2206 (defun message-next-header ()
2207   "Go to the beginning of the next header."
2208   (beginning-of-line)
2209   (or (eobp) (forward-char 1))
2210   (not (if (re-search-forward "^[^ \t]" nil t)
2211            (beginning-of-line)
2212          (goto-char (point-max)))))
2213
2214 (defun message-sort-headers-1 ()
2215   "Sort the buffer as headers using `message-rank' text props."
2216   (goto-char (point-min))
2217   (require 'sort)
2218   (sort-subr
2219    nil 'message-next-header
2220    (lambda ()
2221      (message-next-header)
2222      (unless (bobp)
2223        (forward-char -1)))
2224    (lambda ()
2225      (or (get-text-property (point) 'message-rank)
2226          10000))))
2227
2228 (defun message-sort-headers ()
2229   "Sort the headers of the current message according to `message-header-format-alist'."
2230   (interactive)
2231   (save-excursion
2232     (save-restriction
2233       (let ((max (1+ (length message-header-format-alist)))
2234             rank)
2235         (message-narrow-to-headers)
2236         (while (re-search-forward "^[^ \n]+:" nil t)
2237           (put-text-property
2238            (match-beginning 0) (1+ (match-beginning 0))
2239            'message-rank
2240            (if (setq rank (length (memq (assq (intern (buffer-substring
2241                                                        (match-beginning 0)
2242                                                        (1- (match-end 0))))
2243                                               message-header-format-alist)
2244                                         message-header-format-alist)))
2245                (- max rank)
2246              (1+ max)))))
2247       (message-sort-headers-1))))
2248
2249 (defun message-kill-address ()
2250   "Kill the address under point."
2251   (interactive)
2252   (let ((start (point)))
2253     (message-skip-to-next-address)
2254     (kill-region start (point))))
2255
2256 \f
2257
2258 ;;;
2259 ;;; Message mode
2260 ;;;
2261
2262 ;;; Set up keymap.
2263
2264 (defvar message-mode-map nil)
2265
2266 (unless message-mode-map
2267   (setq message-mode-map (make-keymap))
2268   (set-keymap-parent message-mode-map text-mode-map)
2269   (define-key message-mode-map "\C-c?" 'describe-mode)
2270
2271   (define-key message-mode-map "\C-c\C-f\C-t" 'message-goto-to)
2272   (define-key message-mode-map "\C-c\C-f\C-o" 'message-goto-from)
2273   (define-key message-mode-map "\C-c\C-f\C-b" 'message-goto-bcc)
2274   (define-key message-mode-map "\C-c\C-f\C-w" 'message-goto-fcc)
2275   (define-key message-mode-map "\C-c\C-f\C-c" 'message-goto-cc)
2276   (define-key message-mode-map "\C-c\C-f\C-s" 'message-goto-subject)
2277   (define-key message-mode-map "\C-c\C-f\C-r" 'message-goto-reply-to)
2278   (define-key message-mode-map "\C-c\C-f\C-n" 'message-goto-newsgroups)
2279   (define-key message-mode-map "\C-c\C-f\C-d" 'message-goto-distribution)
2280   (define-key message-mode-map "\C-c\C-f\C-f" 'message-goto-followup-to)
2281   (define-key message-mode-map "\C-c\C-f\C-m" 'message-goto-mail-followup-to)
2282   (define-key message-mode-map "\C-c\C-f\C-k" 'message-goto-keywords)
2283   (define-key message-mode-map "\C-c\C-f\C-u" 'message-goto-summary)
2284   (define-key message-mode-map "\C-c\C-f\C-i"
2285     'message-insert-or-toggle-importance)
2286   (define-key message-mode-map "\C-c\C-f\C-a"
2287     'message-generate-unsubscribed-mail-followup-to)
2288
2289   ;; modify headers (and insert notes in body)
2290   (define-key message-mode-map "\C-c\C-fs"    'message-change-subject)
2291   ;;
2292   (define-key message-mode-map "\C-c\C-fx"    'message-cross-post-followup-to)
2293   ;; prefix+message-cross-post-followup-to = same w/o cross-post
2294   (define-key message-mode-map "\C-c\C-ft"    'message-reduce-to-to-cc)
2295   (define-key message-mode-map "\C-c\C-fa"    'message-add-archive-header)
2296   ;; mark inserted text
2297   (define-key message-mode-map "\C-c\M-m" 'message-mark-inserted-region)
2298   (define-key message-mode-map "\C-c\M-f" 'message-mark-insert-file)
2299
2300   (define-key message-mode-map "\C-c\C-b" 'message-goto-body)
2301   (define-key message-mode-map "\C-c\C-i" 'message-goto-signature)
2302
2303   (define-key message-mode-map "\C-c\C-t" 'message-insert-to)
2304   (define-key message-mode-map "\C-c\C-fw" 'message-insert-wide-reply)
2305   (define-key message-mode-map "\C-c\C-n" 'message-insert-newsgroups)
2306   (define-key message-mode-map "\C-c\C-l" 'message-to-list-only)
2307
2308   (define-key message-mode-map "\C-c\C-u" 'message-insert-or-toggle-importance)
2309   (define-key message-mode-map "\C-c\M-n"
2310     'message-insert-disposition-notification-to)
2311
2312   (define-key message-mode-map "\C-c\C-y" 'message-yank-original)
2313   (define-key message-mode-map "\C-c\M-\C-y" 'message-yank-buffer)
2314   (define-key message-mode-map "\C-c\C-q" 'message-fill-yanked-message)
2315   (define-key message-mode-map "\C-c\C-w" 'message-insert-signature)
2316   (define-key message-mode-map "\C-c\M-h" 'message-insert-headers)
2317   (define-key message-mode-map "\C-c\C-r" 'message-caesar-buffer-body)
2318   (define-key message-mode-map "\C-c\C-o" 'message-sort-headers)
2319   (define-key message-mode-map "\C-c\M-r" 'message-rename-buffer)
2320
2321   (define-key message-mode-map "\C-c\C-c" 'message-send-and-exit)
2322   (define-key message-mode-map "\C-c\C-s" 'message-send)
2323   (define-key message-mode-map "\C-c\C-k" 'message-kill-buffer)
2324   (define-key message-mode-map "\C-c\C-d" 'message-dont-send)
2325   (define-key message-mode-map "\C-c\n" 'gnus-delay-article)
2326
2327   (define-key message-mode-map "\C-c\M-k" 'message-kill-address)
2328   (define-key message-mode-map "\C-c\C-e" 'message-elide-region)
2329   (define-key message-mode-map "\C-c\C-v" 'message-delete-not-region)
2330   (define-key message-mode-map "\C-c\C-z" 'message-kill-to-signature)
2331   (define-key message-mode-map "\M-\r" 'message-newline-and-reformat)
2332   (define-key message-mode-map [remap split-line]  'message-split-line)
2333
2334   (define-key message-mode-map "\C-c\C-a" 'mml-attach-file)
2335
2336   (define-key message-mode-map "\C-a" 'message-beginning-of-line)
2337   (define-key message-mode-map "\t" 'message-tab)
2338   (define-key message-mode-map "\M-;" 'comment-region))
2339
2340 (easy-menu-define
2341   message-mode-menu message-mode-map "Message Menu."
2342   `("Message"
2343     ["Yank Original" message-yank-original message-reply-buffer]
2344     ["Fill Yanked Message" message-fill-yanked-message t]
2345     ["Insert Signature" message-insert-signature t]
2346     ["Caesar (rot13) Message" message-caesar-buffer-body t]
2347     ["Caesar (rot13) Region" message-caesar-region (message-mark-active-p)]
2348     ["Elide Region" message-elide-region
2349      :active (message-mark-active-p)
2350      ,@(if (featurep 'xemacs) nil
2351          '(:help "Replace text in region with an ellipsis"))]
2352     ["Delete Outside Region" message-delete-not-region
2353      :active (message-mark-active-p)
2354      ,@(if (featurep 'xemacs) nil
2355          '(:help "Delete all quoted text outside region"))]
2356     ["Kill To Signature" message-kill-to-signature t]
2357     ["Newline and Reformat" message-newline-and-reformat t]
2358     ["Rename buffer" message-rename-buffer t]
2359     ["Spellcheck" ispell-message
2360      ,@(if (featurep 'xemacs) '(t)
2361          '(:help "Spellcheck this message"))]
2362     "----"
2363     ["Insert Region Marked" message-mark-inserted-region
2364      :active (message-mark-active-p)
2365      ,@(if (featurep 'xemacs) nil
2366          '(:help "Mark region with enclosing tags"))]
2367     ["Insert File Marked..." message-mark-insert-file
2368      ,@(if (featurep 'xemacs) '(t)
2369          '(:help "Insert file at point marked with enclosing tags"))]
2370     "----"
2371     ["Send Message" message-send-and-exit
2372      ,@(if (featurep 'xemacs) '(t)
2373          '(:help "Send this message"))]
2374     ["Postpone Message" message-dont-send
2375      ,@(if (featurep 'xemacs) '(t)
2376          '(:help "File this draft message and exit"))]
2377     ["Send at Specific Time..." gnus-delay-article
2378      ,@(if (featurep 'xemacs) '(t)
2379          '(:help "Ask, then arrange to send message at that time"))]
2380     ["Kill Message" message-kill-buffer
2381      ,@(if (featurep 'xemacs) '(t)
2382          '(:help "Delete this message without sending"))]))
2383
2384 (easy-menu-define
2385   message-mode-field-menu message-mode-map ""
2386   `("Field"
2387     ["To" message-goto-to t]
2388     ["From" message-goto-from t]
2389     ["Subject" message-goto-subject t]
2390     ["Change subject..." message-change-subject t]
2391     ["Cc" message-goto-cc t]
2392     ["Bcc" message-goto-bcc t]
2393     ["Fcc" message-goto-fcc t]
2394     ["Reply-To" message-goto-reply-to t]
2395     ["Flag As Important" message-insert-importance-high
2396      ,@(if (featurep 'xemacs) '(t)
2397          '(:help "Mark this message as important"))]
2398     ["Flag As Unimportant" message-insert-importance-low
2399      ,@(if (featurep 'xemacs) '(t)
2400          '(:help "Mark this message as unimportant"))]
2401     ["Request Receipt"
2402      message-insert-disposition-notification-to
2403      ,@(if (featurep 'xemacs) '(t)
2404          '(:help "Request a receipt notification"))]
2405     "----"
2406     ;; (typical) news stuff
2407     ["Summary" message-goto-summary t]
2408     ["Keywords" message-goto-keywords t]
2409     ["Newsgroups" message-goto-newsgroups t]
2410     ["Fetch Newsgroups" message-insert-newsgroups t]
2411     ["Followup-To" message-goto-followup-to t]
2412     ;; ["Followup-To (with note in body)" message-cross-post-followup-to t]
2413     ["Crosspost / Followup-To..." message-cross-post-followup-to t]
2414     ["Distribution" message-goto-distribution t]
2415     ["X-No-Archive:" message-add-archive-header t ]
2416     "----"
2417     ;; (typical) mailing-lists stuff
2418     ["Fetch To" message-insert-to
2419      ,@(if (featurep 'xemacs) '(t)
2420          '(:help "Insert a To header that points to the author."))]
2421     ["Fetch To and Cc" message-insert-wide-reply
2422      ,@(if (featurep 'xemacs) '(t)
2423          '(:help
2424            "Insert To and Cc headers as if you were doing a wide reply."))]
2425     "----"
2426     ["Send to list only" message-to-list-only t]
2427     ["Mail-Followup-To" message-goto-mail-followup-to t]
2428     ["Unsubscribed list post" message-generate-unsubscribed-mail-followup-to
2429      ,@(if (featurep 'xemacs) '(t)
2430          '(:help "Insert a reasonable `Mail-Followup-To:' header."))]
2431     ["Reduce To: to Cc:" message-reduce-to-to-cc t]
2432     "----"
2433     ["Sort Headers" message-sort-headers t]
2434     ["Encode non-ASCII domain names" message-idna-to-ascii-rhs t]
2435     ["Goto Body" message-goto-body t]
2436     ["Goto Signature" message-goto-signature t]))
2437
2438 (defvar message-tool-bar-map nil)
2439
2440 (eval-when-compile
2441   (defvar facemenu-add-face-function)
2442   (defvar facemenu-remove-face-function))
2443
2444 ;;; Forbidden properties
2445 ;;
2446 ;; We use `after-change-functions' to keep special text properties
2447 ;; that interfer with the normal function of message mode out of the
2448 ;; buffer.
2449
2450 (defcustom message-strip-special-text-properties t
2451   "Strip special properties from the message buffer.
2452
2453 Emacs has a number of special text properties which can break message
2454 composing in various ways.  If this option is set, message will strip
2455 these properties from the message composition buffer.  However, some
2456 packages requires these properties to be present in order to work.
2457 If you use one of these packages, turn this option off, and hope the
2458 message composition doesn't break too bad."
2459   :version "22.1"
2460   :group 'message-various
2461   :link '(custom-manual "(message)Various Message Variables")
2462   :type 'boolean)
2463
2464 (defconst message-forbidden-properties
2465   ;; No reason this should be clutter up customize.  We make it a
2466   ;; property list (rather than a list of property symbols), to be
2467   ;; directly useful for `remove-text-properties'.
2468   '(field nil read-only nil invisible nil intangible nil
2469           mouse-face nil modification-hooks nil insert-in-front-hooks nil
2470           insert-behind-hooks nil point-entered nil point-left nil)
2471   ;; Other special properties:
2472   ;; category, face, display: probably doesn't do any harm.
2473   ;; fontified: is used by font-lock.
2474   ;; syntax-table, local-map: I dunno.
2475   ;; We need to add XEmacs names to the list.
2476   "Property list of with properties forbidden in message buffers.
2477 The values of the properties are ignored, only the property names are used.")
2478
2479 (defun message-tamago-not-in-use-p (pos)
2480   "Return t when tamago version 4 is not in use at the cursor position.
2481 Tamago version 4 is a popular input method for writing Japanese text.
2482 It uses the properties `intangible', `invisible', `modification-hooks'
2483 and `read-only' when translating ascii or kana text to kanji text.
2484 These properties are essential to work, so we should never strip them."
2485   (not (and (boundp 'egg-modefull-mode)
2486             (symbol-value 'egg-modefull-mode)
2487             (or (memq (get-text-property pos 'intangible)
2488                       '(its-part-1 its-part-2))
2489                 (get-text-property pos 'egg-end)
2490                 (get-text-property pos 'egg-lang)
2491                 (get-text-property pos 'egg-start)))))
2492
2493 (defun message-strip-forbidden-properties (begin end &optional old-length)
2494   "Strip forbidden properties between BEGIN and END, ignoring the third arg.
2495 This function is intended to be called from `after-change-functions'.
2496 See also `message-forbidden-properties'."
2497   (when (and message-strip-special-text-properties
2498              (message-tamago-not-in-use-p begin))
2499     (let ((buffer-read-only nil)
2500           (inhibit-read-only t))
2501       (remove-text-properties begin end message-forbidden-properties))))
2502
2503 ;;;###autoload
2504 (define-derived-mode message-mode text-mode "Message"
2505   "Major mode for editing mail and news to be sent.
2506 Like Text Mode but with these additional commands:\\<message-mode-map>
2507 C-c C-s  `message-send' (send the message)  C-c C-c  `message-send-and-exit'
2508 C-c C-d  Postpone sending the message       C-c C-k  Kill the message
2509 C-c C-f  move to a header field (and create it if there isn't):
2510          C-c C-f C-t  move to To        C-c C-f C-s  move to Subject
2511          C-c C-f C-c  move to Cc        C-c C-f C-b  move to Bcc
2512          C-c C-f C-w  move to Fcc       C-c C-f C-r  move to Reply-To
2513          C-c C-f C-u  move to Summary   C-c C-f C-n  move to Newsgroups
2514          C-c C-f C-k  move to Keywords  C-c C-f C-d  move to Distribution
2515          C-c C-f C-o  move to From (\"Originator\")
2516          C-c C-f C-f  move to Followup-To
2517          C-c C-f C-m  move to Mail-Followup-To
2518          C-c C-f C-i  cycle through Importance values
2519          C-c C-f s    change subject and append \"(was: <Old Subject>)\"
2520          C-c C-f x    crossposting with FollowUp-To header and note in body
2521          C-c C-f t    replace To: header with contents of Cc: or Bcc:
2522          C-c C-f a    Insert X-No-Archive: header and a note in the body
2523 C-c C-t  `message-insert-to' (add a To header to a news followup)
2524 C-c C-l  `message-to-list-only' (removes all but list address in to/cc)
2525 C-c C-n  `message-insert-newsgroups' (add a Newsgroup header to a news reply)
2526 C-c C-b  `message-goto-body' (move to beginning of message text).
2527 C-c C-i  `message-goto-signature' (move to the beginning of the signature).
2528 C-c C-w  `message-insert-signature' (insert `message-signature-file' file).
2529 C-c C-y  `message-yank-original' (insert current message, if any).
2530 C-c C-q  `message-fill-yanked-message' (fill what was yanked).
2531 C-c C-e  `message-elide-region' (elide the text between point and mark).
2532 C-c C-v  `message-delete-not-region' (remove the text outside the region).
2533 C-c C-z  `message-kill-to-signature' (kill the text up to the signature).
2534 C-c C-r  `message-caesar-buffer-body' (rot13 the message body).
2535 C-c C-a  `mml-attach-file' (attach a file as MIME).
2536 C-c C-u  `message-insert-or-toggle-importance'  (insert or cycle importance).
2537 C-c M-n  `message-insert-disposition-notification-to'  (request receipt).
2538 C-c M-m  `message-mark-inserted-region' (mark region with enclosing tags).
2539 C-c M-f  `message-mark-insert-file' (insert file marked with enclosing tags).
2540 M-RET    `message-newline-and-reformat' (break the line and reformat)."
2541   (setq local-abbrev-table text-mode-abbrev-table)
2542   (set (make-local-variable 'message-reply-buffer) nil)
2543   (set (make-local-variable 'message-inserted-headers) nil)
2544   (set (make-local-variable 'message-send-actions) nil)
2545   (set (make-local-variable 'message-exit-actions) nil)
2546   (set (make-local-variable 'message-kill-actions) nil)
2547   (set (make-local-variable 'message-postpone-actions) nil)
2548   (set (make-local-variable 'message-draft-article) nil)
2549   (setq buffer-offer-save t)
2550   (set (make-local-variable 'facemenu-add-face-function)
2551        (lambda (face end)
2552          (let ((face-fun (cdr (assq face message-face-alist))))
2553            (if face-fun
2554                (funcall face-fun (point) end)
2555              (error "Face %s not configured for %s mode" face mode-name)))
2556          ""))
2557   (set (make-local-variable 'facemenu-remove-face-function) t)
2558   (set (make-local-variable 'message-reply-headers) nil)
2559   (make-local-variable 'message-newsreader)
2560   (make-local-variable 'message-mailer)
2561   (make-local-variable 'message-post-method)
2562   (set (make-local-variable 'message-sent-message-via) nil)
2563   (set (make-local-variable 'message-checksum) nil)
2564   (set (make-local-variable 'message-mime-part) 0)
2565   (message-setup-fill-variables)
2566   ;; Allow using comment commands to add/remove quoting.
2567   ;; (set (make-local-variable 'comment-start) message-yank-prefix)
2568   (when message-yank-prefix
2569     (set (make-local-variable 'comment-start) message-yank-prefix)
2570     (set (make-local-variable 'comment-start-skip)
2571          (concat "^" (regexp-quote message-yank-prefix) "[ \t]*")))
2572   (if (featurep 'xemacs)
2573       (message-setup-toolbar)
2574     (set (make-local-variable 'font-lock-defaults)
2575          '(message-font-lock-keywords t))
2576     (if (boundp 'tool-bar-map)
2577         (set (make-local-variable 'tool-bar-map) (message-tool-bar-map))))
2578   (easy-menu-add message-mode-menu message-mode-map)
2579   (easy-menu-add message-mode-field-menu message-mode-map)
2580   (gnus-make-local-hook 'after-change-functions)
2581   ;; Mmmm... Forbidden properties...
2582   (add-hook 'after-change-functions 'message-strip-forbidden-properties
2583             nil 'local)
2584   ;; Allow mail alias things.
2585   (when (eq message-mail-alias-type 'abbrev)
2586     (if (fboundp 'mail-abbrevs-setup)
2587         (mail-abbrevs-setup)
2588       (if (fboundp 'mail-aliases-setup) ; warning avoidance
2589           (mail-aliases-setup))))
2590   (unless buffer-file-name
2591     (message-set-auto-save-file-name))
2592   (unless (buffer-base-buffer)
2593     ;; Don't enable multibyte on an indirect buffer.  Maybe enabling
2594     ;; multibyte is not necessary at all. -- zsh
2595     (mm-enable-multibyte))
2596   (set (make-local-variable 'indent-tabs-mode) nil) ;No tabs for indentation.
2597   (mml-mode))
2598
2599 (defun message-setup-fill-variables ()
2600   "Setup message fill variables."
2601   (set (make-local-variable 'fill-paragraph-function)
2602        'message-fill-paragraph)
2603   (make-local-variable 'paragraph-separate)
2604   (make-local-variable 'paragraph-start)
2605   (make-local-variable 'adaptive-fill-regexp)
2606   (unless (boundp 'adaptive-fill-first-line-regexp)
2607     (setq adaptive-fill-first-line-regexp nil))
2608   (make-local-variable 'adaptive-fill-first-line-regexp)
2609   (let ((quote-prefix-regexp
2610          ;; User should change message-cite-prefix-regexp if
2611          ;; message-yank-prefix is set to an abnormal value.
2612          (concat "\\(" message-cite-prefix-regexp "\\)[ \t]*")))
2613     (setq paragraph-start
2614           (concat
2615            (regexp-quote mail-header-separator) "$\\|"
2616            "[ \t]*$\\|"                 ; blank lines
2617            "-- $\\|"                    ; signature delimiter
2618            "---+$\\|"              ; delimiters for forwarded messages
2619            page-delimiter "$\\|"        ; spoiler warnings
2620            ".*wrote:$\\|"               ; attribution lines
2621            quote-prefix-regexp "$\\|"   ; empty lines in quoted text
2622                                         ; mml tags
2623            "<#!*/?\\(multipart\\|part\\|external\\|mml\\|secure\\)"))
2624     (setq paragraph-separate paragraph-start)
2625     (setq adaptive-fill-regexp
2626           (concat quote-prefix-regexp "\\|" adaptive-fill-regexp))
2627     (setq adaptive-fill-first-line-regexp
2628           (concat quote-prefix-regexp "\\|"
2629                   adaptive-fill-first-line-regexp)))
2630   (make-local-variable 'auto-fill-inhibit-regexp)
2631   ;;(setq auto-fill-inhibit-regexp "^[A-Z][^: \n\t]+:")
2632   (setq auto-fill-inhibit-regexp nil)
2633   (make-local-variable 'normal-auto-fill-function)
2634   (setq normal-auto-fill-function 'message-do-auto-fill)
2635   ;; KLUDGE: auto fill might already be turned on in `text-mode-hook'.
2636   ;; In that case, ensure that it uses the right function.  The real
2637   ;; solution would be not to use `define-derived-mode', and run
2638   ;; `text-mode-hook' ourself at the end of the mode.
2639   ;; -- Per Abrahamsen <abraham@dina.kvl.dk> Date: 2001-10-19.
2640   (when auto-fill-function
2641     (setq auto-fill-function normal-auto-fill-function)))
2642
2643 \f
2644
2645 ;;;
2646 ;;; Message mode commands
2647 ;;;
2648
2649 ;;; Movement commands
2650
2651 (defun message-goto-to ()
2652   "Move point to the To header."
2653   (interactive)
2654   (message-position-on-field "To"))
2655
2656 (defun message-goto-from ()
2657   "Move point to the From header."
2658   (interactive)
2659   (message-position-on-field "From"))
2660
2661 (defun message-goto-subject ()
2662   "Move point to the Subject header."
2663   (interactive)
2664   (message-position-on-field "Subject"))
2665
2666 (defun message-goto-cc ()
2667   "Move point to the Cc header."
2668   (interactive)
2669   (message-position-on-field "Cc" "To"))
2670
2671 (defun message-goto-bcc ()
2672   "Move point to the Bcc  header."
2673   (interactive)
2674   (message-position-on-field "Bcc" "Cc" "To"))
2675
2676 (defun message-goto-fcc ()
2677   "Move point to the Fcc header."
2678   (interactive)
2679   (message-position-on-field "Fcc" "To" "Newsgroups"))
2680
2681 (defun message-goto-reply-to ()
2682   "Move point to the Reply-To header."
2683   (interactive)
2684   (message-position-on-field "Reply-To" "Subject"))
2685
2686 (defun message-goto-newsgroups ()
2687   "Move point to the Newsgroups header."
2688   (interactive)
2689   (message-position-on-field "Newsgroups"))
2690
2691 (defun message-goto-distribution ()
2692   "Move point to the Distribution header."
2693   (interactive)
2694   (message-position-on-field "Distribution"))
2695
2696 (defun message-goto-followup-to ()
2697   "Move point to the Followup-To header."
2698   (interactive)
2699   (message-position-on-field "Followup-To" "Newsgroups"))
2700
2701 (defun message-goto-mail-followup-to ()
2702   "Move point to the Mail-Followup-To header."
2703   (interactive)
2704   (message-position-on-field "Mail-Followup-To" "To"))
2705
2706 (defun message-goto-keywords ()
2707   "Move point to the Keywords header."
2708   (interactive)
2709   (message-position-on-field "Keywords" "Subject"))
2710
2711 (defun message-goto-summary ()
2712   "Move point to the Summary header."
2713   (interactive)
2714   (message-position-on-field "Summary" "Subject"))
2715
2716 (defun message-goto-body (&optional interactivep)
2717   "Move point to the beginning of the message body."
2718   (interactive (list t))
2719   (when (and interactivep
2720              (looking-at "[ \t]*\n"))
2721     (expand-abbrev))
2722   (goto-char (point-min))
2723   (or (search-forward (concat "\n" mail-header-separator "\n") nil t)
2724       (search-forward-regexp "[^:]+:\\([^\n]\\|\n[ \t]\\)+\n\n" nil t)))
2725
2726 (defun message-goto-eoh ()
2727   "Move point to the end of the headers."
2728   (interactive)
2729   (message-goto-body)
2730   (forward-line -1))
2731
2732 (defun message-goto-signature ()
2733   "Move point to the beginning of the message signature.
2734 If there is no signature in the article, go to the end and
2735 return nil."
2736   (interactive)
2737   (goto-char (point-min))
2738   (if (re-search-forward message-signature-separator nil t)
2739       (forward-line 1)
2740     (goto-char (point-max))
2741     nil))
2742
2743 (defun message-generate-unsubscribed-mail-followup-to (&optional include-cc)
2744   "Insert a reasonable MFT header in a post to an unsubscribed list.
2745 When making original posts to a mailing list you are not subscribed to,
2746 you have to type in a MFT header by hand.  The contents, usually, are
2747 the addresses of the list and your own address.  This function inserts
2748 such a header automatically.  It fetches the contents of the To: header
2749 in the current mail buffer, and appends the current `user-mail-address'.
2750
2751 If the optional argument INCLUDE-CC is non-nil, the addresses in the
2752 Cc: header are also put into the MFT."
2753
2754   (interactive "P")
2755   (let* (cc tos)
2756     (save-restriction
2757       (message-narrow-to-headers)
2758       (message-remove-header "Mail-Followup-To")
2759       (setq cc (and include-cc (message-fetch-field "Cc")))
2760       (setq tos (if cc
2761                     (concat (message-fetch-field "To") "," cc)
2762                   (message-fetch-field "To"))))
2763     (message-goto-mail-followup-to)
2764     (insert (concat tos ", " user-mail-address))))
2765
2766 \f
2767
2768 (defun message-insert-to (&optional force)
2769   "Insert a To header that points to the author of the article being replied to.
2770 If the original author requested not to be sent mail, don't insert unless the
2771 prefix FORCE is given."
2772   (interactive "P")
2773   (let* ((mct (message-fetch-reply-field "mail-copies-to"))
2774          (dont (and mct (or (equal (downcase mct) "never")
2775                             (equal (downcase mct) "nobody"))))
2776          (to (or (message-fetch-reply-field "mail-reply-to")
2777                  (message-fetch-reply-field "reply-to")
2778                  (message-fetch-reply-field "from"))))
2779     (when (and dont to)
2780       (message
2781        (if force
2782            "Ignoring the user request not to have copies sent via mail"
2783          "Complying with the user request not to have copies sent via mail")))
2784     (when (and force (not to))
2785       (error "No mail address in the article"))
2786     (when (and to (or force (not dont)))
2787       (message-carefully-insert-headers (list (cons 'To to))))))
2788
2789 (defun message-insert-wide-reply ()
2790   "Insert To and Cc headers as if you were doing a wide reply."
2791   (interactive)
2792   (let ((headers (message-with-reply-buffer
2793                    (message-get-reply-headers t))))
2794     (message-carefully-insert-headers headers)))
2795
2796 (defcustom message-header-synonyms
2797   '((To Cc Bcc))
2798   "List of lists of header synonyms.
2799 E.g., if this list contains a member list with elements `Cc' and `To',
2800 then `message-carefully-insert-headers' will not insert a `To' header
2801 when the message is already `Cc'ed to the recipient."
2802   :version "22.1"
2803   :group 'message-headers
2804   :link '(custom-manual "(message)Message Headers")
2805   :type '(repeat sexp))
2806
2807 (defun message-carefully-insert-headers (headers)
2808   "Insert the HEADERS, an alist, into the message buffer.
2809 Does not insert the headers when they are already present there
2810 or in the synonym headers, defined by `message-header-synonyms'."
2811   ;; FIXME: Should compare only the address and not the full name.  Comparison
2812   ;; should be done case-folded (and with `string=' rather than
2813   ;; `string-match').
2814   ;; (mail-strip-quoted-names "Foo Bar <foo@bar>, bla@fasel (Bla Fasel)")
2815   (dolist (header headers)
2816     (let* ((header-name (symbol-name (car header)))
2817            (new-header (cdr header))
2818            (synonyms (loop for synonym in message-header-synonyms
2819                            when (memq (car header) synonym) return synonym))
2820            (old-header
2821             (loop for synonym in synonyms
2822                   for old-header = (mail-fetch-field (symbol-name synonym))
2823                   when (and old-header (string-match new-header old-header))
2824                   return synonym)))
2825       (if old-header
2826           (message "already have `%s' in `%s'" new-header old-header)
2827         (when (and (message-position-on-field header-name)
2828                    (setq old-header (mail-fetch-field header-name))
2829                    (not (string-match "\\` *\\'" old-header)))
2830           (insert ", "))
2831         (insert new-header)))))
2832
2833 (defun message-widen-reply ()
2834   "Widen the reply to include maximum recipients."
2835   (interactive)
2836   (let ((follow-to
2837          (and message-reply-buffer
2838               (buffer-name message-reply-buffer)
2839               (save-excursion
2840                 (set-buffer message-reply-buffer)
2841                 (message-get-reply-headers t)))))
2842     (save-excursion
2843       (save-restriction
2844         (message-narrow-to-headers)
2845         (dolist (elem follow-to)
2846           (message-remove-header (symbol-name (car elem)))
2847           (goto-char (point-min))
2848           (insert (symbol-name (car elem)) ": "
2849                   (cdr elem) "\n"))))))
2850
2851 (defun message-insert-newsgroups ()
2852   "Insert the Newsgroups header from the article being replied to."
2853   (interactive)
2854   (when (and (message-position-on-field "Newsgroups")
2855              (mail-fetch-field "newsgroups")
2856              (not (string-match "\\` *\\'" (mail-fetch-field "newsgroups"))))
2857     (insert ","))
2858   (insert (or (message-fetch-reply-field "newsgroups") "")))
2859
2860 \f
2861
2862 ;;; Various commands
2863
2864 (defun message-delete-not-region (beg end)
2865   "Delete everything in the body of the current message outside of the region."
2866   (interactive "r")
2867   (let (citeprefix)
2868     (save-excursion
2869       (goto-char beg)
2870       ;; snarf citation prefix, if appropriate
2871       (unless (eq (point) (progn (beginning-of-line) (point)))
2872         (when (looking-at message-cite-prefix-regexp)
2873           (setq citeprefix (match-string 0))))
2874       (goto-char end)
2875       (delete-region (point) (if (not (message-goto-signature))
2876                                  (point)
2877                                (forward-line -2)
2878                                (point)))
2879       (insert "\n")
2880       (goto-char beg)
2881       (delete-region beg (progn (message-goto-body)
2882                                 (forward-line 2)
2883                                 (point)))
2884       (when citeprefix
2885         (insert citeprefix))))
2886   (when (message-goto-signature)
2887     (forward-line -2)))
2888
2889 (defun message-kill-to-signature (&optional arg)
2890   "Kill all text up to the signature.
2891 If a numberic argument or prefix arg is given, leave that number
2892 of lines before the signature intact."
2893   (interactive "p")
2894   (save-excursion
2895     (save-restriction
2896       (let ((point (point)))
2897         (narrow-to-region point (point-max))
2898         (message-goto-signature)
2899         (unless (eobp)
2900           (if (and arg (numberp arg))
2901               (forward-line (- -1 arg))
2902             (end-of-line -1)))
2903         (unless (= point (point))
2904           (kill-region point (point))
2905           (unless (bolp)
2906             (insert "\n")))))))
2907
2908 (defun message-newline-and-reformat (&optional arg not-break)
2909   "Insert four newlines, and then reformat if inside quoted text.
2910 Prefix arg means justify as well."
2911   (interactive (list (if current-prefix-arg 'full)))
2912   (let (quoted point beg end leading-space bolp fill-paragraph-function)
2913     (setq point (point))
2914     (beginning-of-line)
2915     (setq beg (point))
2916     (setq bolp (= beg point))
2917     ;; Find first line of the paragraph.
2918     (if not-break
2919         (while (and (not (eobp))
2920                     (not (looking-at message-cite-prefix-regexp))
2921                     (looking-at paragraph-start))
2922           (forward-line 1)))
2923     ;; Find the prefix
2924     (when (looking-at message-cite-prefix-regexp)
2925       (setq quoted (match-string 0))
2926       (goto-char (match-end 0))
2927       (looking-at "[ \t]*")
2928       (setq leading-space (match-string 0)))
2929     (if (and quoted
2930              (not not-break)
2931              (not bolp)
2932              (< (- point beg) (length quoted)))
2933         ;; break inside the cite prefix.
2934         (setq quoted nil
2935               end nil))
2936     (if quoted
2937         (progn
2938           (forward-line 1)
2939           (while (and (not (eobp))
2940                       (not (looking-at paragraph-separate))
2941                       (looking-at message-cite-prefix-regexp)
2942                       (equal quoted (match-string 0)))
2943             (goto-char (match-end 0))
2944             (looking-at "[ \t]*")
2945             (if (> (length leading-space) (length (match-string 0)))
2946                 (setq leading-space (match-string 0)))
2947             (forward-line 1))
2948           (setq end (point))
2949           (goto-char beg)
2950           (while (and (if (bobp) nil (forward-line -1) t)
2951                       (not (looking-at paragraph-start))
2952                       (looking-at message-cite-prefix-regexp)
2953                       (equal quoted (match-string 0)))
2954             (setq beg (point))
2955             (goto-char (match-end 0))
2956             (looking-at "[ \t]*")
2957             (if (> (length leading-space) (length (match-string 0)))
2958                 (setq leading-space (match-string 0)))))
2959       (while (and (not (eobp))
2960                   (not (looking-at paragraph-separate))
2961                   (not (looking-at message-cite-prefix-regexp)))
2962         (forward-line 1))
2963       (setq end (point))
2964       (goto-char beg)
2965       (while (and (if (bobp) nil (forward-line -1) t)
2966                   (not (looking-at paragraph-start))
2967                   (not (looking-at message-cite-prefix-regexp)))
2968         (setq beg (point))))
2969     (goto-char point)
2970     (save-restriction
2971       (narrow-to-region beg end)
2972       (if not-break
2973           (setq point nil)
2974         (if bolp
2975             (newline)
2976           (newline)
2977           (newline))
2978         (setq point (point))
2979         ;; (newline 2) doesn't mark both newline's as hard, so call
2980         ;; newline twice. -jas
2981         (newline)
2982         (newline)
2983         (delete-region (point) (re-search-forward "[ \t]*"))
2984         (when (and quoted (not bolp))
2985           (insert quoted leading-space)))
2986       (undo-boundary)
2987       (if quoted
2988           (let* ((adaptive-fill-regexp
2989                   (regexp-quote (concat quoted leading-space)))
2990                  (adaptive-fill-first-line-regexp
2991                   adaptive-fill-regexp ))
2992             (fill-paragraph arg))
2993         (fill-paragraph arg))
2994       (if point (goto-char point)))))
2995
2996 (defun message-fill-paragraph (&optional arg)
2997   "Message specific function to fill a paragraph.
2998 This function is used as the value of `fill-paragraph-function' in
2999 Message buffers and is not meant to be called directly."
3000   (interactive (list (if current-prefix-arg 'full)))
3001   (if (if (boundp 'filladapt-mode) filladapt-mode)
3002       nil
3003     (if (message-point-in-header-p)
3004         (message-fill-field)
3005       (message-newline-and-reformat arg t))
3006     t))
3007
3008 ;; Is it better to use `mail-header-end'?
3009 (defun message-point-in-header-p ()
3010   "Return t if point is in the header."
3011   (save-excursion
3012     (let ((p (point)))
3013       (goto-char (point-min))
3014       (not (re-search-forward
3015             (concat "^" (regexp-quote mail-header-separator) "\n")
3016             p t)))))
3017
3018 (defun message-do-auto-fill ()
3019   "Like `do-auto-fill', but don't fill in message header."
3020   (unless (message-point-in-header-p)
3021     (do-auto-fill)))
3022
3023 (defun message-insert-signature (&optional force)
3024   "Insert a signature.  See documentation for variable `message-signature'."
3025   (interactive (list 0))
3026   (let* ((signature
3027           (cond
3028            ((and (null message-signature)
3029                  (eq force 0))
3030             (save-excursion
3031               (goto-char (point-max))
3032               (not (re-search-backward message-signature-separator nil t))))
3033            ((and (null message-signature)
3034                  force)
3035             t)
3036            ((functionp message-signature)
3037             (funcall message-signature))
3038            ((listp message-signature)
3039             (eval message-signature))
3040            (t message-signature)))
3041          (signature
3042           (cond ((stringp signature)
3043                  signature)
3044                 ((and (eq t signature)
3045                       message-signature-file
3046                       (file-exists-p message-signature-file))
3047                  signature))))
3048     (when signature
3049       (goto-char (point-max))
3050       ;; Insert the signature.
3051       (unless (bolp)
3052         (insert "\n"))
3053       (when message-signature-insert-empty-line
3054         (insert "\n"))
3055       (insert "-- \n")
3056       (if (eq signature t)
3057           (insert-file-contents message-signature-file)
3058         (insert signature))
3059       (goto-char (point-max))
3060       (or (bolp) (insert "\n")))))
3061
3062 (defun message-insert-importance-high ()
3063   "Insert header to mark message as important."
3064   (interactive)
3065   (save-excursion
3066     (save-restriction
3067       (message-narrow-to-headers)
3068       (message-remove-header "Importance"))
3069     (message-goto-eoh)
3070     (insert "Importance: high\n")))
3071
3072 (defun message-insert-importance-low ()
3073   "Insert header to mark message as unimportant."
3074   (interactive)
3075   (save-excursion
3076     (save-restriction
3077       (message-narrow-to-headers)
3078       (message-remove-header "Importance"))
3079     (message-goto-eoh)
3080     (insert "Importance: low\n")))
3081
3082 (defun message-insert-or-toggle-importance ()
3083   "Insert a \"Importance: high\" header, or cycle through the header values.
3084 The three allowed values according to RFC 1327 are `high', `normal'
3085 and `low'."
3086   (interactive)
3087   (save-excursion
3088     (let ((valid '("high" "normal" "low"))
3089           (new "high")
3090           cur)
3091       (save-restriction
3092         (message-narrow-to-headers)
3093         (when (setq cur (message-fetch-field "Importance"))
3094           (message-remove-header "Importance")
3095           (setq new (cond ((string= cur "high")
3096                            "low")
3097                           ((string= cur "low")
3098                            "normal")
3099                           (t
3100                            "high")))))
3101       (message-goto-eoh)
3102       (insert (format "Importance: %s\n" new)))))
3103
3104 (defun message-insert-disposition-notification-to ()
3105   "Request a disposition notification (return receipt) to this message.
3106 Note that this should not be used in newsgroups."
3107   (interactive)
3108   (save-excursion
3109     (save-restriction
3110       (message-narrow-to-headers)
3111       (message-remove-header "Disposition-Notification-To"))
3112     (message-goto-eoh)
3113     (insert (format "Disposition-Notification-To: %s\n"
3114                     (or (message-field-value "Reply-to")
3115                         (message-field-value "From")
3116                         (message-make-from))))))
3117
3118 (defun message-elide-region (b e)
3119   "Elide the text in the region.
3120 An ellipsis (from `message-elide-ellipsis') will be inserted where the
3121 text was killed."
3122   (interactive "r")
3123   (kill-region b e)
3124   (insert message-elide-ellipsis))
3125
3126 (defvar message-caesar-translation-table nil)
3127
3128 (defun message-caesar-region (b e &optional n)
3129   "Caesar rotate region B to E by N, default 13, for decrypting netnews."
3130   (interactive
3131    (list
3132     (min (point) (or (mark t) (point)))
3133     (max (point) (or (mark t) (point)))
3134     (when current-prefix-arg
3135       (prefix-numeric-value current-prefix-arg))))
3136
3137   (setq n (if (numberp n) (mod n 26) 13)) ;canonize N
3138   (unless (or (zerop n)                 ; no action needed for a rot of 0
3139               (= b e))                  ; no region to rotate
3140     ;; We build the table, if necessary.
3141     (when (or (not message-caesar-translation-table)
3142               (/= (aref message-caesar-translation-table ?a) (+ ?a n)))
3143       (setq message-caesar-translation-table
3144             (message-make-caesar-translation-table n)))
3145     (translate-region b e message-caesar-translation-table)))
3146
3147 (defun message-make-caesar-translation-table (n)
3148   "Create a rot table with offset N."
3149   (let ((i -1)
3150         (table (make-string 256 0)))
3151     (while (< (incf i) 256)
3152       (aset table i i))
3153     (concat
3154      (substring table 0 ?A)
3155      (substring table (+ ?A n) (+ ?A n (- 26 n)))
3156      (substring table ?A (+ ?A n))
3157      (substring table (+ ?A 26) ?a)
3158      (substring table (+ ?a n) (+ ?a n (- 26 n)))
3159      (substring table ?a (+ ?a n))
3160      (substring table (+ ?a 26) 255))))
3161
3162 (defun message-caesar-buffer-body (&optional rotnum)
3163   "Caesar rotate all letters in the current buffer by 13 places.
3164 Used to encode/decode possibly offensive messages (commonly in rec.humor).
3165 With prefix arg, specifies the number of places to rotate each letter forward.
3166 Mail and USENET news headers are not rotated."
3167   (interactive (if current-prefix-arg
3168                    (list (prefix-numeric-value current-prefix-arg))
3169                  (list nil)))
3170   (save-excursion
3171     (save-restriction
3172       (when (message-goto-body)
3173         (narrow-to-region (point) (point-max)))
3174       (message-caesar-region (point-min) (point-max) rotnum))))
3175
3176 (defun message-pipe-buffer-body (program)
3177   "Pipe the message body in the current buffer through PROGRAM."
3178   (save-excursion
3179     (save-restriction
3180       (when (message-goto-body)
3181         (narrow-to-region (point) (point-max)))
3182       (shell-command-on-region
3183        (point-min) (point-max) program nil t))))
3184
3185 (defun message-rename-buffer (&optional enter-string)
3186   "Rename the *message* buffer to \"*message* RECIPIENT\".
3187 If the function is run with a prefix, it will ask for a new buffer
3188 name, rather than giving an automatic name."
3189   (interactive "Pbuffer name: ")
3190   (save-excursion
3191     (save-restriction
3192       (goto-char (point-min))
3193       (narrow-to-region (point)
3194                         (search-forward mail-header-separator nil 'end))
3195       (let* ((mail-to (or
3196                        (if (message-news-p) (message-fetch-field "Newsgroups")
3197                          (message-fetch-field "To"))
3198                        ""))
3199              (mail-trimmed-to
3200               (if (string-match "," mail-to)
3201                   (concat (substring mail-to 0 (match-beginning 0)) ", ...")
3202                 mail-to))
3203              (name-default (concat "*message* " mail-trimmed-to))
3204              (name (if enter-string
3205                        (read-string "New buffer name: " name-default)
3206                      name-default)))
3207         (rename-buffer name t)))))
3208
3209 (defun message-fill-yanked-message (&optional justifyp)
3210   "Fill the paragraphs of a message yanked into this one.
3211 Numeric argument means justify as well."
3212   (interactive "P")
3213   (save-excursion
3214     (goto-char (point-min))
3215     (search-forward (concat "\n" mail-header-separator "\n") nil t)
3216     (let ((fill-prefix message-yank-prefix))
3217       (fill-individual-paragraphs (point) (point-max) justifyp))))
3218
3219 (defun message-indent-citation ()
3220   "Modify text just inserted from a message to be cited.
3221 The inserted text should be the region.
3222 When this function returns, the region is again around the modified text.
3223
3224 Normally, indent each nonblank line `message-indentation-spaces' spaces.
3225 However, if `message-yank-prefix' is non-nil, insert that prefix on each line."
3226   (let ((start (point)))
3227     ;; Remove unwanted headers.
3228     (when message-ignored-cited-headers
3229       (let (all-removed)
3230         (save-restriction
3231           (narrow-to-region
3232            (goto-char start)
3233            (if (search-forward "\n\n" nil t)
3234                (1- (point))
3235              (point)))
3236           (message-remove-header message-ignored-cited-headers t)
3237           (when (= (point-min) (point-max))
3238             (setq all-removed t))
3239           (goto-char (point-max)))
3240         (if all-removed
3241             (goto-char start)
3242           (forward-line 1))))
3243     ;; Delete blank lines at the start of the buffer.
3244     (while (and (point-min)
3245                 (eolp)
3246                 (not (eobp)))
3247       (message-delete-line))
3248     ;; Delete blank lines at the end of the buffer.
3249     (goto-char (point-max))
3250     (unless (eolp)
3251       (insert "\n"))
3252     (while (and (zerop (forward-line -1))
3253                 (looking-at "$"))
3254       (message-delete-line))
3255     ;; Do the indentation.
3256     (if (null message-yank-prefix)
3257         (indent-rigidly start (mark t) message-indentation-spaces)
3258       (save-excursion
3259         (goto-char start)
3260         (while (< (point) (mark t))
3261           (cond ((looking-at ">")
3262                  (insert message-yank-cited-prefix))
3263                 ((looking-at "^$")
3264                  (insert message-yank-empty-prefix))
3265                 (t
3266                  (insert message-yank-prefix)))
3267           (forward-line 1))))
3268     (goto-char start)))
3269
3270 (defun message-yank-original (&optional arg)
3271   "Insert the message being replied to, if any.
3272 Puts point before the text and mark after.
3273 Normally indents each nonblank line ARG spaces (default 3).  However,
3274 if `message-yank-prefix' is non-nil, insert that prefix on each line.
3275
3276 This function uses `message-cite-function' to do the actual citing.
3277
3278 Just \\[universal-argument] as argument means don't indent, insert no
3279 prefix, and don't delete any headers."
3280   (interactive "P")
3281   (let ((modified (buffer-modified-p)))
3282     (when (and message-reply-buffer
3283                message-cite-function)
3284       (delete-windows-on message-reply-buffer t)
3285       (push-mark (save-excursion
3286                    (insert-buffer-substring message-reply-buffer)
3287                    (point)))
3288       (unless arg
3289         (funcall message-cite-function))
3290       (message-exchange-point-and-mark)
3291       (unless (bolp)
3292         (insert ?\n))
3293       (unless modified
3294         (setq message-checksum (message-checksum))))))
3295
3296 (defun message-yank-buffer (buffer)
3297   "Insert BUFFER into the current buffer and quote it."
3298   (interactive "bYank buffer: ")
3299   (let ((message-reply-buffer (get-buffer buffer)))
3300     (save-window-excursion
3301       (message-yank-original))))
3302
3303 (defun message-buffers ()
3304   "Return a list of active message buffers."
3305   (let (buffers)
3306     (save-excursion
3307       (dolist (buffer (buffer-list t))
3308         (set-buffer buffer)
3309         (when (and (eq major-mode 'message-mode)
3310                    (null message-sent-message-via))
3311           (push (buffer-name buffer) buffers))))
3312     (nreverse buffers)))
3313
3314 (eval-when-compile (defvar mail-citation-hook)) ; Compiler directive
3315
3316 (defun message-cite-original-1 (strip-signature)
3317   "Cite an original message.
3318 If STRIP-SIGNATURE is non-nil, strips off the signature from the
3319 original message.
3320
3321 This function uses `mail-citation-hook' if that is non-nil."
3322   (if (and (boundp 'mail-citation-hook)
3323            mail-citation-hook)
3324       (run-hooks 'mail-citation-hook)
3325     (let* ((start (point))
3326            (end (mark t))
3327            (x-no-archive nil)
3328            (functions
3329             (when message-indent-citation-function
3330               (if (listp message-indent-citation-function)
3331                   message-indent-citation-function
3332                 (list message-indent-citation-function))))
3333            ;; This function may be called by `gnus-summary-yank-message' and
3334            ;; may insert a different article from the original.  So, we will
3335            ;; modify the value of `message-reply-headers' with that article.
3336            (message-reply-headers
3337             (save-restriction
3338               (narrow-to-region start end)
3339               (message-narrow-to-head-1)
3340               (setq x-no-archive (message-fetch-field "x-no-archive"))
3341               (vector 0
3342                       (or (message-fetch-field "subject") "none")
3343                       (message-fetch-field "from")
3344                       (message-fetch-field "date")
3345                       (message-fetch-field "message-id" t)
3346                       (message-fetch-field "references")
3347                       0 0 ""))))
3348       (mml-quote-region start end)
3349       (when strip-signature
3350         ;; Allow undoing.
3351         (undo-boundary)
3352         (goto-char end)
3353         (when (re-search-backward message-signature-separator start t)
3354           ;; Also peel off any blank lines before the signature.
3355           (forward-line -1)
3356           (while (looking-at "^[ \t]*$")
3357             (forward-line -1))
3358           (forward-line 1)
3359           (delete-region (point) end)
3360           (unless (search-backward "\n\n" start t)
3361             ;; Insert a blank line if it is peeled off.
3362             (insert "\n"))))
3363       (goto-char start)
3364       (mapc 'funcall functions)
3365       (when message-citation-line-function
3366         (unless (bolp)
3367           (insert "\n"))
3368         (funcall message-citation-line-function))
3369       (when (and x-no-archive
3370                  (not message-cite-articles-with-x-no-archive)
3371                  (string-match "yes" x-no-archive))
3372         (undo-boundary)
3373         (delete-region (point) (mark t))
3374         (insert "> [Quoted text removed due to X-No-Archive]\n")
3375         (forward-line -1)))))
3376
3377 (defun message-cite-original ()
3378   "Cite function in the standard Message manner."
3379   (message-cite-original-1 nil))
3380
3381 (defun message-cite-original-without-signature ()
3382   "Cite function in the standard Message manner.
3383 This function strips off the signature from the original message."
3384   (message-cite-original-1 t))
3385
3386 (defun message-insert-citation-line ()
3387   "Insert a simple citation line."
3388   (when message-reply-headers
3389     (insert (mail-header-from message-reply-headers) " writes:\n\n")))
3390
3391 (defun message-position-on-field (header &rest afters)
3392   (let ((case-fold-search t))
3393     (save-restriction
3394       (narrow-to-region
3395        (goto-char (point-min))
3396        (progn
3397          (re-search-forward
3398           (concat "^" (regexp-quote mail-header-separator) "$"))
3399          (match-beginning 0)))
3400       (goto-char (point-min))
3401       (if (re-search-forward (concat "^" (regexp-quote header) ":") nil t)
3402           (progn
3403             (re-search-forward "^[^ \t]" nil 'move)
3404             (beginning-of-line)
3405             (skip-chars-backward "\n")
3406             t)
3407         (while (and afters
3408                     (not (re-search-forward
3409                           (concat "^" (regexp-quote (car afters)) ":")
3410                           nil t)))
3411           (pop afters))
3412         (when afters
3413           (re-search-forward "^[^ \t]" nil 'move)
3414           (beginning-of-line))
3415         (insert header ": \n")
3416         (forward-char -1)
3417         nil))))
3418
3419 (defun message-remove-signature ()
3420   "Remove the signature from the text between point and mark.
3421 The text will also be indented the normal way."
3422   (save-excursion
3423     (let ((start (point))
3424           mark)
3425       (if (not (re-search-forward message-signature-separator (mark t) t))
3426           ;; No signature here, so we just indent the cited text.
3427           (message-indent-citation)
3428         ;; Find the last non-empty line.
3429         (forward-line -1)
3430         (while (looking-at "[ \t]*$")
3431           (forward-line -1))
3432         (forward-line 1)
3433         (setq mark (set-marker (make-marker) (point)))
3434         (goto-char start)
3435         (message-indent-citation)
3436         ;; Enable undoing the deletion.
3437         (undo-boundary)
3438         (delete-region mark (mark t))
3439         (set-marker mark nil)))))
3440
3441 \f
3442
3443 ;;;
3444 ;;; Sending messages
3445 ;;;
3446
3447 (defun message-send-and-exit (&optional arg)
3448   "Send message like `message-send', then, if no errors, exit from mail buffer."
3449   (interactive "P")
3450   (let ((buf (current-buffer))
3451         (actions message-exit-actions))
3452     (when (and (message-send arg)
3453                (buffer-name buf))
3454       (if message-kill-buffer-on-exit
3455           (kill-buffer buf)
3456         (bury-buffer buf)
3457         (when (eq buf (current-buffer))
3458           (message-bury buf)))
3459       (message-do-actions actions)
3460       t)))
3461
3462 (defun message-dont-send ()
3463   "Don't send the message you have been editing.
3464 Instead, just auto-save the buffer and then bury it."
3465   (interactive)
3466   (set-buffer-modified-p t)
3467   (save-buffer)
3468   (let ((actions message-postpone-actions))
3469     (message-bury (current-buffer))
3470     (message-do-actions actions)))
3471
3472 (defun message-kill-buffer ()
3473   "Kill the current buffer."
3474   (interactive)
3475   (when (or (not (buffer-modified-p))
3476             (not message-kill-buffer-query)
3477             (yes-or-no-p "Message modified; kill anyway? "))
3478     (let ((actions message-kill-actions)
3479           (draft-article message-draft-article)
3480           (auto-save-file-name buffer-auto-save-file-name)
3481           (file-name buffer-file-name)
3482           (modified (buffer-modified-p)))
3483       (setq buffer-file-name nil)
3484       (kill-buffer (current-buffer))
3485       (when (and (or (and auto-save-file-name
3486                           (file-exists-p auto-save-file-name))
3487                      (and file-name
3488                           (file-exists-p file-name)))
3489                  (progn
3490                    ;; If the message buffer has lived in a dedicated window,
3491                    ;; `kill-buffer' has killed the frame.  Thus the
3492                    ;; `yes-or-no-p' may show up in a lowered frame.  Make sure
3493                    ;; that the user can see the question by raising the
3494                    ;; current frame:
3495                    (raise-frame)
3496                    (yes-or-no-p (format "Remove the backup file%s? "
3497                                         (if modified " too" "")))))
3498         (ignore-errors
3499           (delete-file auto-save-file-name))
3500         (let ((message-draft-article draft-article))
3501           (message-disassociate-draft)))
3502       (message-do-actions actions))))
3503
3504 (defun message-bury (buffer)
3505   "Bury this mail BUFFER."
3506   (let ((newbuf (other-buffer buffer)))
3507     (bury-buffer buffer)
3508     (if (and (window-dedicated-p (selected-window))
3509              (not (null (delq (selected-frame) (visible-frame-list)))))
3510         (delete-frame (selected-frame))
3511       (switch-to-buffer newbuf))))
3512
3513 (defun message-send (&optional arg)
3514   "Send the message in the current buffer.
3515 If `message-interactive' is non-nil, wait for success indication or
3516 error messages, and inform user.
3517 Otherwise any failure is reported in a message back to the user from
3518 the mailer.
3519 The usage of ARG is defined by the instance that called Message.
3520 It should typically alter the sending method in some way or other."
3521   (interactive "P")
3522   ;; Make it possible to undo the coming changes.
3523   (undo-boundary)
3524   (let ((inhibit-read-only t))
3525     (put-text-property (point-min) (point-max) 'read-only nil))
3526   (message-fix-before-sending)
3527   (run-hooks 'message-send-hook)
3528   (message message-sending-message)
3529   (let ((alist message-send-method-alist)
3530         (success t)
3531         elem sent dont-barf-on-no-method
3532         (message-options message-options))
3533     (message-options-set-recipient)
3534     (while (and success
3535                 (setq elem (pop alist)))
3536       (when (funcall (cadr elem))
3537         (when (and (or (not (memq (car elem)
3538                                   message-sent-message-via))
3539                        (message-fetch-field "supersedes")
3540                        (if (or (message-gnksa-enable-p 'multiple-copies)
3541                                (not (eq (car elem) 'news)))
3542                            (y-or-n-p
3543                             (format
3544                              "Already sent message via %s; resend? "
3545                              (car elem)))
3546                          (error "Denied posting -- multiple copies")))
3547                    (setq success (funcall (caddr elem) arg)))
3548           (setq sent t))))
3549     (unless (or sent
3550                 (not success)
3551                 (let ((fcc (message-fetch-field "Fcc"))
3552                       (gcc (message-fetch-field "Gcc")))
3553                   (when (or fcc gcc)
3554                     (or (eq message-allow-no-recipients 'always)
3555                         (and (not (eq message-allow-no-recipients 'never))
3556                              (setq dont-barf-on-no-method
3557                                    (gnus-y-or-n-p
3558                                     (format "No receiver, perform %s anyway? "
3559                                             (cond ((and fcc gcc) "Fcc and Gcc")
3560                                                   (fcc "Fcc")
3561                                                   (t "Gcc"))))))))))
3562       (error "No methods specified to send by"))
3563     (when (or dont-barf-on-no-method
3564               (and success sent))
3565       (message-do-fcc)
3566       (save-excursion
3567         (run-hooks 'message-sent-hook))
3568       (message "Sending...done")
3569       ;; Mark the buffer as unmodified and delete auto-save.
3570       (set-buffer-modified-p nil)
3571       (delete-auto-save-file-if-necessary t)
3572       (message-disassociate-draft)
3573       ;; Delete other mail buffers and stuff.
3574       (message-do-send-housekeeping)
3575       (message-do-actions message-send-actions)
3576       ;; Return success.
3577       t)))
3578
3579 (defun message-send-via-mail (arg)
3580   "Send the current message via mail."
3581   (message-send-mail arg))
3582
3583 (defun message-send-via-news (arg)
3584   "Send the current message via news."
3585   (funcall message-send-news-function arg))
3586
3587 (defmacro message-check (type &rest forms)
3588   "Eval FORMS if TYPE is to be checked."
3589   `(or (message-check-element ,type)
3590        (save-excursion
3591          ,@forms)))
3592
3593 (put 'message-check 'lisp-indent-function 1)
3594 (put 'message-check 'edebug-form-spec '(form body))
3595
3596 (defun message-text-with-property (prop &optional start end reverse)
3597   "Return a list of start and end positions where the text has PROP.
3598 START and END bound the search, they default to `point-min' and
3599 `point-max' respectively.  If REVERSE is non-nil, find text which does
3600 not have PROP."
3601   (unless start
3602     (setq start (point-min)))
3603   (unless end
3604     (setq end (point-max)))
3605   (let (next regions)
3606     (if reverse
3607         (while (and start
3608                     (setq start (text-property-any start end prop nil)))
3609           (setq next (next-single-property-change start prop nil end))
3610           (push (cons start (or next end)) regions)
3611           (setq start next))
3612       (while (and start
3613                   (or (get-text-property start prop)
3614                       (and (setq start (next-single-property-change
3615                                         start prop nil end))
3616                            (get-text-property start prop))))
3617         (setq next (text-property-any start end prop nil))
3618         (push (cons start (or next end)) regions)
3619         (setq start next)))
3620     (nreverse regions)))
3621
3622 (defun message-fix-before-sending ()
3623   "Do various things to make the message nice before sending it."
3624   ;; Make sure there's a newline at the end of the message.
3625   (goto-char (point-max))
3626   (unless (bolp)
3627     (insert "\n"))
3628   ;; Make the hidden headers visible.
3629   (widen)
3630   ;; Sort headers before sending the message.
3631   (message-sort-headers)
3632   ;; Make invisible text visible.
3633   ;; It doesn't seem as if this is useful, since the invisible property
3634   ;; is clobbered by an after-change hook anyhow.
3635   (message-check 'invisible-text
3636     (let ((regions (message-text-with-property 'invisible))
3637           from to)
3638       (when regions
3639         (while regions
3640           (setq from (caar regions)
3641                 to (cdar regions)
3642                 regions (cdr regions))
3643           (put-text-property from to 'invisible nil)
3644           (message-overlay-put (message-make-overlay from to)
3645                                'face 'highlight))
3646         (unless (yes-or-no-p
3647                  "Invisible text found and made visible; continue sending? ")
3648           (error "Invisible text found and made visible")))))
3649   (message-check 'illegible-text
3650     (let (found choice)
3651       (message-goto-body)
3652       (skip-chars-forward mm-7bit-chars)
3653       (while (not (eobp))
3654         (when (let ((char (char-after)))
3655                 (or (< (mm-char-int char) 128)
3656                     (and (mm-multibyte-p)
3657                          (memq (char-charset char)
3658                                '(eight-bit-control eight-bit-graphic
3659                                                    control-1))
3660                          (not (get-text-property
3661                                (point) 'untranslated-utf-8)))))
3662           (message-overlay-put (message-make-overlay (point) (1+ (point)))
3663                                'face 'highlight)
3664           (setq found t))
3665         (forward-char)
3666         (skip-chars-forward mm-7bit-chars))
3667       (when found
3668         (setq choice
3669               (gnus-multiple-choice
3670                "Non-printable characters found.  Continue sending?"
3671                '((?d "Remove non-printable characters and send")
3672                  (?r "Replace non-printable characters with dots and send")
3673                  (?i "Ignore non-printable characters and send")
3674                  (?e "Continue editing"))))
3675         (if (eq choice ?e)
3676           (error "Non-printable characters"))
3677         (message-goto-body)
3678         (skip-chars-forward mm-7bit-chars)
3679         (while (not (eobp))
3680           (when (let ((char (char-after)))
3681                   (or (< (mm-char-int char) 128)
3682                       (and (mm-multibyte-p)
3683                            ;; Fixme: Wrong for Emacs 22 and for things
3684                            ;; like undecable utf-8.  Should at least
3685                            ;; use find-coding-systems-region.
3686                            (memq (char-charset char)
3687                                  '(eight-bit-control eight-bit-graphic
3688                                                      control-1))
3689                            (not (get-text-property
3690                                  (point) 'untranslated-utf-8)))))
3691             (if (eq choice ?i)
3692                 (message-kill-all-overlays)
3693               (delete-char 1)
3694               (when (eq choice ?r)
3695                 (insert "."))))
3696           (forward-char)
3697           (skip-chars-forward mm-7bit-chars))))))
3698
3699 (defun message-add-action (action &rest types)
3700   "Add ACTION to be performed when doing an exit of type TYPES."
3701   (while types
3702     (add-to-list (intern (format "message-%s-actions" (pop types)))
3703                  action)))
3704
3705 (defun message-delete-action (action &rest types)
3706   "Delete ACTION from lists of actions performed when doing an exit of type TYPES."
3707   (let (var)
3708     (while types
3709       (set (setq var (intern (format "message-%s-actions" (pop types))))
3710            (delq action (symbol-value var))))))
3711
3712 (defun message-do-actions (actions)
3713   "Perform all actions in ACTIONS."
3714   ;; Now perform actions on successful sending.
3715   (dolist (action actions)
3716     (ignore-errors
3717       (cond
3718        ;; A simple function.
3719        ((functionp action)
3720         (funcall action))
3721        ;; Something to be evaled.
3722        (t
3723         (eval action))))))
3724
3725 (defun message-send-mail-partially ()
3726   "Send mail as message/partial."
3727   ;; replace the header delimiter with a blank line
3728   (goto-char (point-min))
3729   (re-search-forward
3730    (concat "^" (regexp-quote mail-header-separator) "\n"))
3731   (replace-match "\n")
3732   (run-hooks 'message-send-mail-hook)
3733   (let ((p (goto-char (point-min)))
3734         (tembuf (message-generate-new-buffer-clone-locals " message temp"))
3735         (curbuf (current-buffer))
3736         (id (message-make-message-id)) (n 1)
3737         plist total  header required-mail-headers)
3738     (while (not (eobp))
3739       (if (< (point-max) (+ p message-send-mail-partially-limit))
3740           (goto-char (point-max))
3741         (goto-char (+ p message-send-mail-partially-limit))
3742         (beginning-of-line)
3743         (if (<= (point) p) (forward-line 1))) ;; In case of bad message.
3744       (push p plist)
3745       (setq p (point)))
3746     (setq total (length plist))
3747     (push (point-max) plist)
3748     (setq plist (nreverse plist))
3749     (unwind-protect
3750         (save-excursion
3751           (setq p (pop plist))
3752           (while plist
3753             (set-buffer curbuf)
3754             (copy-to-buffer tembuf p (car plist))
3755             (set-buffer tembuf)
3756             (goto-char (point-min))
3757             (if header
3758                 (progn
3759                   (goto-char (point-min))
3760                   (narrow-to-region (point) (point))
3761                   (insert header))
3762               (message-goto-eoh)
3763               (setq header (buffer-substring (point-min) (point)))
3764               (goto-char (point-min))
3765               (narrow-to-region (point) (point))
3766               (insert header)
3767               (message-remove-header "Mime-Version")
3768               (message-remove-header "Content-Type")
3769               (message-remove-header "Content-Transfer-Encoding")
3770               (message-remove-header "Message-ID")
3771               (message-remove-header "Lines")
3772               (goto-char (point-max))
3773               (insert "Mime-Version: 1.0\n")
3774               (setq header (buffer-string)))
3775             (goto-char (point-max))
3776             (insert (format "Content-Type: message/partial; id=\"%s\"; number=%d; total=%d\n\n"
3777                             id n total))
3778             (forward-char -1)
3779             (let ((mail-header-separator ""))
3780               (when (memq 'Message-ID message-required-mail-headers)
3781                 (insert "Message-ID: " (message-make-message-id) "\n"))
3782               (when (memq 'Lines message-required-mail-headers)
3783                 (insert "Lines: " (message-make-lines) "\n"))
3784               (message-goto-subject)
3785               (end-of-line)
3786               (insert (format " (%d/%d)" n total))
3787               (widen)
3788               (mm-with-unibyte-current-buffer
3789                 (funcall (or message-send-mail-real-function
3790                              message-send-mail-function))))
3791             (setq n (+ n 1))
3792             (setq p (pop plist))
3793             (erase-buffer)))
3794       (kill-buffer tembuf))))
3795
3796 (defun message-send-mail (&optional arg)
3797   (require 'mail-utils)
3798   (let* ((tembuf (message-generate-new-buffer-clone-locals " message temp"))
3799          (case-fold-search nil)
3800          (news (message-news-p))
3801          (mailbuf (current-buffer))
3802          (message-this-is-mail t)
3803          (message-posting-charset
3804           (if (fboundp 'gnus-setup-posting-charset)
3805               (gnus-setup-posting-charset nil)
3806             message-posting-charset))
3807          (headers message-required-mail-headers))
3808     (when message-generate-hashcash
3809       (message "Generating hashcash...")
3810       ;; Wait for calculations already started to finish...
3811       (hashcash-wait-async)
3812       ;; ...and do calculations not already done.  mail-add-payment
3813       ;; will leave existing X-Hashcash headers alone.
3814       (mail-add-payment)
3815       (message "Generating hashcash...done"))
3816     (save-restriction
3817       (message-narrow-to-headers)
3818       ;; Generate the Mail-Followup-To header if the header is not there...
3819       (if (and (message-subscribed-p)
3820                (not (mail-fetch-field "mail-followup-to")))
3821           (setq headers
3822                 (cons
3823                  (cons "Mail-Followup-To" (message-make-mail-followup-to))
3824                  message-required-mail-headers))
3825         ;; otherwise, delete the MFT header if the field is empty
3826         (when (equal "" (mail-fetch-field "mail-followup-to"))
3827           (message-remove-header "^Mail-Followup-To:")))
3828       ;; Insert some headers.
3829       (let ((message-deletable-headers
3830              (if news nil message-deletable-headers)))
3831         (message-generate-headers headers))
3832       ;; Let the user do all of the above.
3833       (run-hooks 'message-header-hook))
3834     (unwind-protect
3835         (save-excursion
3836           (set-buffer tembuf)
3837           (erase-buffer)
3838           ;; Avoid copying text props (except hard newlines).
3839           (insert (with-current-buffer mailbuf
3840                     (mml-buffer-substring-no-properties-except-hard-newlines
3841                      (point-min) (point-max))))
3842           ;; Remove some headers.
3843           (message-encode-message-body)
3844           (save-restriction
3845             (message-narrow-to-headers)
3846             ;; We (re)generate the Lines header.
3847             (when (memq 'Lines message-required-mail-headers)
3848               (message-generate-headers '(Lines)))
3849             ;; Remove some headers.
3850             (message-remove-header message-ignored-mail-headers t)
3851             (let ((mail-parse-charset message-default-charset))
3852               (mail-encode-encoded-word-buffer)))
3853           (goto-char (point-max))
3854           ;; require one newline at the end.
3855           (or (= (preceding-char) ?\n)
3856               (insert ?\n))
3857           (message-cleanup-headers)
3858           ;; FIXME: we're inserting the courtesy copy after encoding.
3859           ;; This is wrong if the courtesy copy string contains
3860           ;; non-ASCII characters. -- jh
3861           (when
3862               (save-restriction
3863                 (message-narrow-to-headers)
3864                 (and news
3865                      (or (message-fetch-field "cc")
3866                          (message-fetch-field "bcc")
3867                          (message-fetch-field "to"))
3868                      (let ((content-type (message-fetch-field
3869                                           "content-type")))
3870                        (and
3871                         (or
3872                          (not content-type)
3873                          (string= "text/plain"
3874                                   (car
3875                                    (mail-header-parse-content-type
3876                                     content-type))))
3877                         (not
3878                          (string= "base64"
3879                                   (message-fetch-field
3880                                    "content-transfer-encoding")))))))
3881             (message-insert-courtesy-copy))
3882           (if (or (not message-send-mail-partially-limit)
3883                   (< (buffer-size) message-send-mail-partially-limit)
3884                   (not (message-y-or-n-p
3885                         "The message size is too large, split? "
3886                         t
3887                         "\
3888 The message size, "
3889                         (/ (buffer-size) 1000) "KB, is too large.
3890
3891 Some mail gateways (MTA's) bounce large messages.  To avoid the
3892 problem, answer `y', and the message will be split into several
3893 smaller pieces, the size of each is about "
3894                         (/ message-send-mail-partially-limit 1000)
3895                         "KB except the last
3896 one.
3897
3898 However, some mail readers (MUA's) can't read split messages, i.e.,
3899 mails in message/partially format. Answer `n', and the message will be
3900 sent in one piece.
3901
3902 The size limit is controlled by `message-send-mail-partially-limit'.
3903 If you always want Gnus to send messages in one piece, set
3904 `message-send-mail-partially-limit' to nil.
3905 ")))
3906               (mm-with-unibyte-current-buffer
3907                 (message "Sending via mail...")
3908                 (funcall (or message-send-mail-real-function
3909                              message-send-mail-function)))
3910             (message-send-mail-partially)))
3911       (kill-buffer tembuf))
3912     (set-buffer mailbuf)
3913     (push 'mail message-sent-message-via)))
3914
3915 (defun message-send-mail-with-sendmail ()
3916   "Send off the prepared buffer with sendmail."
3917   (let ((errbuf (if message-interactive
3918                     (message-generate-new-buffer-clone-locals
3919                      " sendmail errors")
3920                   0))
3921         resend-to-addresses delimline)
3922     (unwind-protect
3923         (progn
3924           (let ((case-fold-search t))
3925             (save-restriction
3926               (message-narrow-to-headers)
3927               (setq resend-to-addresses (message-fetch-field "resent-to")))
3928             ;; Change header-delimiter to be what sendmail expects.
3929             (goto-char (point-min))
3930             (re-search-forward
3931              (concat "^" (regexp-quote mail-header-separator) "\n"))
3932             (replace-match "\n")
3933             (backward-char 1)
3934             (setq delimline (point-marker))
3935             (run-hooks 'message-send-mail-hook)
3936             ;; Insert an extra newline if we need it to work around
3937             ;; Sun's bug that swallows newlines.
3938             (goto-char (1+ delimline))
3939             (when (eval message-mailer-swallows-blank-line)
3940               (newline))
3941             (when message-interactive
3942               (with-current-buffer errbuf
3943                 (erase-buffer))))
3944           (let* ((default-directory "/")
3945                  (coding-system-for-write message-send-coding-system)
3946                  (cpr (apply
3947                        'call-process-region
3948                        (append
3949                         (list (point-min) (point-max)
3950                               (if (boundp 'sendmail-program)
3951                                   sendmail-program
3952                                 "/usr/lib/sendmail")
3953                               nil errbuf nil "-oi")
3954                         ;; Always specify who from,
3955                         ;; since some systems have broken sendmails.
3956                         ;; But some systems are more broken with -f, so
3957                         ;; we'll let users override this.
3958                         (if (null message-sendmail-f-is-evil)
3959                             (list "-f" (message-sendmail-envelope-from)))
3960                         ;; These mean "report errors by mail"
3961                         ;; and "deliver in background".
3962                         (if (null message-interactive) '("-oem" "-odb"))
3963                         ;; Get the addresses from the message
3964                         ;; unless this is a resend.
3965                         ;; We must not do that for a resend
3966                         ;; because we would find the original addresses.
3967                         ;; For a resend, include the specific addresses.
3968                         (if resend-to-addresses
3969                             (list resend-to-addresses)
3970                           '("-t"))))))
3971             (unless (or (null cpr) (and (numberp cpr) (zerop cpr)))
3972               (error "Sending...failed with exit value %d" cpr)))
3973           (when message-interactive
3974             (save-excursion
3975               (set-buffer errbuf)
3976               (goto-char (point-min))
3977               (while (re-search-forward "\n+ *" nil t)
3978                 (replace-match "; "))
3979               (if (not (zerop (buffer-size)))
3980                   (error "Sending...failed to %s"
3981                          (buffer-string))))))
3982       (when (bufferp errbuf)
3983         (kill-buffer errbuf)))))
3984
3985 (defun message-send-mail-with-qmail ()
3986   "Pass the prepared message buffer to qmail-inject.
3987 Refer to the documentation for the variable `message-send-mail-function'
3988 to find out how to use this."
3989   ;; replace the header delimiter with a blank line
3990   (goto-char (point-min))
3991   (re-search-forward
3992    (concat "^" (regexp-quote mail-header-separator) "\n"))
3993   (replace-match "\n")
3994   (run-hooks 'message-send-mail-hook)
3995   ;; send the message
3996   (case
3997       (let ((coding-system-for-write message-send-coding-system))
3998         (apply
3999          'call-process-region (point-min) (point-max)
4000          message-qmail-inject-program nil nil nil
4001          ;; qmail-inject's default behaviour is to look for addresses on the
4002          ;; command line; if there're none, it scans the headers.
4003          ;; yes, it does The Right Thing w.r.t. Resent-To and it's kin.
4004          ;;
4005          ;; in general, ALL of qmail-inject's defaults are perfect for simply
4006          ;; reading a formatted (i. e., at least a To: or Resent-To header)
4007          ;; message from stdin.
4008          ;;
4009          ;; qmail also has the advantage of not having been raped by
4010          ;; various vendors, so we don't have to allow for that, either --
4011          ;; compare this with message-send-mail-with-sendmail and weep
4012          ;; for sendmail's lost innocence.
4013          ;;
4014          ;; all this is way cool coz it lets us keep the arguments entirely
4015          ;; free for -inject-arguments -- a big win for the user and for us
4016          ;; since we don't have to play that double-guessing game and the user
4017          ;; gets full control (no gestapo'ish -f's, for instance).  --sj
4018          (if (functionp message-qmail-inject-args)
4019              (funcall message-qmail-inject-args)
4020            message-qmail-inject-args)))
4021     ;; qmail-inject doesn't say anything on it's stdout/stderr,
4022     ;; we have to look at the retval instead
4023     (0 nil)
4024     (100 (error "qmail-inject reported permanent failure"))
4025     (111 (error "qmail-inject reported transient failure"))
4026     ;; should never happen
4027     (t   (error "qmail-inject reported unknown failure"))))
4028
4029 (defun message-send-mail-with-mh ()
4030   "Send the prepared message buffer with mh."
4031   (let ((mh-previous-window-config nil)
4032         (name (mh-new-draft-name)))
4033     (setq buffer-file-name name)
4034     ;; MH wants to generate these headers itself.
4035     (when message-mh-deletable-headers
4036       (let ((headers message-mh-deletable-headers))
4037         (while headers
4038           (goto-char (point-min))
4039           (and (re-search-forward
4040                 (concat "^" (symbol-name (car headers)) ": *") nil t)
4041                (message-delete-line))
4042           (pop headers))))
4043     (run-hooks 'message-send-mail-hook)
4044     ;; Pass it on to mh.
4045     (mh-send-letter)))
4046
4047 (defun message-smtpmail-send-it ()
4048   "Send the prepared message buffer with `smtpmail-send-it'.
4049 This only differs from `smtpmail-send-it' that this command evaluates
4050 `message-send-mail-hook' just before sending a message.  It is useful
4051 if your ISP requires the POP-before-SMTP authentication.  See the Gnus
4052 manual for details."
4053   (run-hooks 'message-send-mail-hook)
4054   (smtpmail-send-it))
4055
4056 (defun message-canlock-generate ()
4057   "Return a string that is non-trivial to guess.
4058 Do not use this for anything important, it is cryptographically weak."
4059   (require 'sha1)
4060   (let (sha1-maximum-internal-length)
4061     (sha1 (concat (message-unique-id)
4062                   (format "%x%x%x" (random) (random t) (random))
4063                   (prin1-to-string (recent-keys))
4064                   (prin1-to-string (garbage-collect))))))
4065
4066 (defun message-canlock-password ()
4067   "The password used by message for cancel locks.
4068 This is the value of `canlock-password', if that option is non-nil.
4069 Otherwise, generate and save a value for `canlock-password' first."
4070   (unless canlock-password
4071     (customize-save-variable 'canlock-password (message-canlock-generate))
4072     (setq canlock-password-for-verify canlock-password))
4073   canlock-password)
4074
4075 (defun message-insert-canlock ()
4076   (when message-insert-canlock
4077     (message-canlock-password)
4078     (canlock-insert-header)))
4079
4080 (defun message-send-news (&optional arg)
4081   (let* ((tembuf (message-generate-new-buffer-clone-locals " *message temp*"))
4082          (case-fold-search nil)
4083          (method (if (functionp message-post-method)
4084                      (funcall message-post-method arg)
4085                    message-post-method))
4086          (newsgroups-field (save-restriction
4087                             (message-narrow-to-headers-or-head)
4088                             (message-fetch-field "Newsgroups")))
4089          (followup-field (save-restriction
4090                            (message-narrow-to-headers-or-head)
4091                            (message-fetch-field "Followup-To")))
4092          ;; BUG: We really need to get the charset for each name in the
4093          ;; Newsgroups and Followup-To lines to allow crossposting
4094          ;; between group namess with incompatible character sets.
4095          ;; -- Per Abrahamsen <abraham@dina.kvl.dk> 2001-10-08.
4096          (group-field-charset
4097           (gnus-group-name-charset method newsgroups-field))
4098          (followup-field-charset
4099           (gnus-group-name-charset method (or followup-field "")))
4100          (rfc2047-header-encoding-alist
4101           (append (when group-field-charset
4102                     (list (cons "Newsgroups" group-field-charset)))
4103                   (when followup-field-charset
4104                     (list (cons "Followup-To" followup-field-charset)))
4105                   rfc2047-header-encoding-alist))
4106          (messbuf (current-buffer))
4107          (message-syntax-checks
4108           (if (and arg
4109                    (listp message-syntax-checks))
4110               (cons '(existing-newsgroups . disabled)
4111                     message-syntax-checks)
4112             message-syntax-checks))
4113          (message-this-is-news t)
4114          (message-posting-charset
4115           (gnus-setup-posting-charset newsgroups-field))
4116          result)
4117     (if (not (message-check-news-body-syntax))
4118         nil
4119       (save-restriction
4120         (message-narrow-to-headers)
4121         ;; Insert some headers.
4122         (message-generate-headers message-required-news-headers)
4123         (message-insert-canlock)
4124         ;; Let the user do all of the above.
4125         (run-hooks 'message-header-hook))
4126       ;; Note: This check will be disabled by the ".*" default value for
4127       ;; gnus-group-name-charset-group-alist. -- Pa 2001-10-07.
4128       (when (and group-field-charset
4129                  (listp message-syntax-checks))
4130         (setq message-syntax-checks
4131               (cons '(valid-newsgroups . disabled)
4132                     message-syntax-checks)))
4133       (message-cleanup-headers)
4134       (if (not (let ((message-post-method method))
4135                  (message-check-news-syntax)))
4136           nil
4137         (unwind-protect
4138             (save-excursion
4139               (set-buffer tembuf)
4140               (buffer-disable-undo)
4141               (erase-buffer)
4142               ;; Avoid copying text props (except hard newlines).
4143               (insert
4144                (with-current-buffer messbuf
4145                  (mml-buffer-substring-no-properties-except-hard-newlines
4146                   (point-min) (point-max))))
4147               (message-encode-message-body)
4148               ;; Remove some headers.
4149               (save-restriction
4150                 (message-narrow-to-headers)
4151                 ;; We (re)generate the Lines header.
4152                 (when (memq 'Lines message-required-mail-headers)
4153                   (message-generate-headers '(Lines)))
4154                 ;; Remove some headers.
4155                 (message-remove-header message-ignored-news-headers t)
4156                 (let ((mail-parse-charset message-default-charset))
4157                   (mail-encode-encoded-word-buffer)))
4158               (goto-char (point-max))
4159               ;; require one newline at the end.
4160               (or (= (preceding-char) ?\n)
4161                   (insert ?\n))
4162               (let ((case-fold-search t))
4163                 ;; Remove the delimiter.
4164                 (goto-char (point-min))
4165                 (re-search-forward
4166                  (concat "^" (regexp-quote mail-header-separator) "\n"))
4167                 (replace-match "\n")
4168                 (backward-char 1))
4169               (run-hooks 'message-send-news-hook)
4170               (gnus-open-server method)
4171               (message "Sending news via %s..." (gnus-server-string method))
4172               (setq result (let ((mail-header-separator ""))
4173                              (gnus-request-post method))))
4174           (kill-buffer tembuf))
4175         (set-buffer messbuf)
4176         (if result
4177             (push 'news message-sent-message-via)
4178           (message "Couldn't send message via news: %s"
4179                    (nnheader-get-report (car method)))
4180           nil)))))
4181
4182 ;;;
4183 ;;; Header generation & syntax checking.
4184 ;;;
4185
4186 (defun message-check-element (type)
4187   "Return non-nil if this TYPE is not to be checked."
4188   (if (eq message-syntax-checks 'dont-check-for-anything-just-trust-me)
4189       t
4190     (let ((able (assq type message-syntax-checks)))
4191       (and (consp able)
4192            (eq (cdr able) 'disabled)))))
4193
4194 (defun message-check-news-syntax ()
4195   "Check the syntax of the message."
4196   (save-excursion
4197     (save-restriction
4198       (widen)
4199       ;; We narrow to the headers and check them first.
4200       (save-excursion
4201         (save-restriction
4202           (message-narrow-to-headers)
4203           (message-check-news-header-syntax))))))
4204
4205 (defun message-check-news-header-syntax ()
4206   (and
4207    ;; Check Newsgroups header.
4208    (message-check 'newsgroups
4209      (let ((group (message-fetch-field "newsgroups")))
4210        (or
4211         (and group
4212              (not (string-match "\\`[ \t]*\\'" group)))
4213         (ignore
4214          (message
4215           "The newsgroups field is empty or missing.  Posting is denied.")))))
4216    ;; Check the Subject header.
4217    (message-check 'subject
4218      (let* ((case-fold-search t)
4219             (subject (message-fetch-field "subject")))
4220        (or
4221         (and subject
4222              (not (string-match "\\`[ \t]*\\'" subject)))
4223         (ignore
4224          (message
4225           "The subject field is empty or missing.  Posting is denied.")))))
4226    ;; Check for commands in Subject.
4227    (message-check 'subject-cmsg
4228      (if (string-match "^cmsg " (message-fetch-field "subject"))
4229          (y-or-n-p
4230           "The control code \"cmsg\" is in the subject.  Really post? ")
4231        t))
4232    ;; Check long header lines.
4233    (message-check 'long-header-lines
4234      (let ((start (point))
4235            (header nil)
4236            (length 0)
4237            found)
4238        (while (and (not found)
4239                    (re-search-forward "^\\([^ \t:]+\\): " nil t))
4240          (if (> (- (point) (match-beginning 0)) 998)
4241              (setq found t
4242                    length (- (point) (match-beginning 0)))
4243            (setq header (match-string-no-properties 1)))
4244          (setq start (match-beginning 0))
4245          (forward-line 1))
4246        (if found
4247            (y-or-n-p (format "Your %s header is too long (%d).  Really post? "
4248                              header length))
4249          t)))
4250    ;; Check for multiple identical headers.
4251    (message-check 'multiple-headers
4252      (let (found)
4253        (while (and (not found)
4254                    (re-search-forward "^[^ \t:]+: " nil t))
4255          (save-excursion
4256            (or (re-search-forward
4257                 (concat "^"
4258                         (regexp-quote
4259                          (setq found
4260                                (buffer-substring
4261                                 (match-beginning 0) (- (match-end 0) 2))))
4262                         ":")
4263                 nil t)
4264                (setq found nil))))
4265        (if found
4266            (y-or-n-p (format "Multiple %s headers.  Really post? " found))
4267          t)))
4268    ;; Check for Version and Sendsys.
4269    (message-check 'sendsys
4270      (if (re-search-forward "^Sendsys:\\|^Version:" nil t)
4271          (y-or-n-p
4272           (format "The article contains a %s command.  Really post? "
4273                   (buffer-substring (match-beginning 0)
4274                                     (1- (match-end 0)))))
4275        t))
4276    ;; See whether we can shorten Followup-To.
4277    (message-check 'shorten-followup-to
4278      (let ((newsgroups (message-fetch-field "newsgroups"))
4279            (followup-to (message-fetch-field "followup-to"))
4280            to)
4281        (when (and newsgroups
4282                   (string-match "," newsgroups)
4283                   (not followup-to)
4284                   (not
4285                    (zerop
4286                     (length
4287                      (setq to (completing-read
4288                                "Followups to (default: no Followup-To header) "
4289                                (mapcar #'list
4290                                        (cons "poster"
4291                                              (message-tokenize-header
4292                                               newsgroups)))))))))
4293          (goto-char (point-min))
4294          (insert "Followup-To: " to "\n"))
4295        t))
4296    ;; Check "Shoot me".
4297    (message-check 'shoot
4298      (if (re-search-forward
4299           "Message-ID.*.i-did-not-set--mail-host-address--so-tickle-me" nil t)
4300          (y-or-n-p "You appear to have a misconfigured system.  Really post? ")
4301        t))
4302    ;; Check for Approved.
4303    (message-check 'approved
4304      (if (re-search-forward "^Approved:" nil t)
4305          (y-or-n-p "The article contains an Approved header.  Really post? ")
4306        t))
4307    ;; Check the Message-ID header.
4308    (message-check 'message-id
4309      (let* ((case-fold-search t)
4310             (message-id (message-fetch-field "message-id" t)))
4311        (or (not message-id)
4312            ;; Is there an @ in the ID?
4313            (and (string-match "@" message-id)
4314                 ;; Is there a dot in the ID?
4315                 (string-match "@[^.]*\\." message-id)
4316                 ;; Does the ID end with a dot?
4317                 (not (string-match "\\.>" message-id)))
4318            (y-or-n-p
4319             (format "The Message-ID looks strange: \"%s\".  Really post? "
4320                     message-id)))))
4321    ;; Check the Newsgroups & Followup-To headers.
4322    (message-check 'existing-newsgroups
4323      (let* ((case-fold-search t)
4324             (newsgroups (message-fetch-field "newsgroups"))
4325             (followup-to (message-fetch-field "followup-to"))
4326             (groups (message-tokenize-header
4327                      (if followup-to
4328                          (concat newsgroups "," followup-to)
4329                        newsgroups)))
4330             (post-method (if (functionp message-post-method)
4331                              (funcall message-post-method)
4332                            message-post-method))
4333             ;; KLUDGE to handle nnvirtual groups.  Doing this right
4334             ;; would probably involve a new nnoo function.
4335             ;; -- Per Abrahamsen <abraham@dina.kvl.dk>, 2001-10-17.
4336             (method (if (and (consp post-method)
4337                              (eq (car post-method) 'nnvirtual)
4338                              gnus-message-group-art)
4339                         (let ((group (car (nnvirtual-find-group-art
4340                                            (car gnus-message-group-art)
4341                                            (cdr gnus-message-group-art)))))
4342                           (gnus-find-method-for-group group))
4343                       post-method))
4344             (known-groups
4345              (mapcar (lambda (n)
4346                        (gnus-group-name-decode
4347                         (gnus-group-real-name n)
4348                         (gnus-group-name-charset method n)))
4349                      (gnus-groups-from-server method)))
4350             errors)
4351        (while groups
4352          (when (and (not (equal (car groups) "poster"))
4353                     (not (member (car groups) known-groups))
4354                     (not (member (car groups) errors)))
4355            (push (car groups) errors))
4356          (pop groups))
4357        (cond
4358         ;; Gnus is not running.
4359         ((or (not (and (boundp 'gnus-active-hashtb)
4360                        gnus-active-hashtb))
4361              (not (boundp 'gnus-read-active-file)))
4362          t)
4363         ;; We don't have all the group names.
4364         ((and (or (not gnus-read-active-file)
4365                   (eq gnus-read-active-file 'some))
4366               errors)
4367          (y-or-n-p
4368           (format
4369            "Really use %s possibly unknown group%s: %s? "
4370            (if (= (length errors) 1) "this" "these")
4371            (if (= (length errors) 1) "" "s")
4372            (mapconcat 'identity errors ", "))))
4373         ;; There were no errors.
4374         ((not errors)
4375          t)
4376         ;; There are unknown groups.
4377         (t
4378          (y-or-n-p
4379           (format
4380            "Really post to %s unknown group%s: %s? "
4381            (if (= (length errors) 1) "this" "these")
4382            (if (= (length errors) 1) "" "s")
4383            (mapconcat 'identity errors ", ")))))))
4384    ;; Check continuation headers.
4385    (message-check 'continuation-headers
4386      (goto-char (point-min))
4387      (let ((do-posting t))
4388        (while (re-search-forward "^[^ \t\n][^:\n]*$" nil t)
4389          (if (y-or-n-p "Fix continuation lines? ")
4390              (progn
4391                (goto-char (match-beginning 0))
4392                (insert " "))
4393            (unless (y-or-n-p "Send anyway? ")
4394              (setq do-posting nil))))
4395        do-posting))
4396    ;; Check the Newsgroups & Followup-To headers for syntax errors.
4397    (message-check 'valid-newsgroups
4398      (let ((case-fold-search t)
4399            (headers '("Newsgroups" "Followup-To"))
4400            header error)
4401        (while (and headers (not error))
4402          (when (setq header (mail-fetch-field (car headers)))
4403            (if (or
4404                 (not
4405                  (string-match
4406                   "\\`\\([-+_&.a-zA-Z0-9]+\\)?\\(,[-+_&.a-zA-Z0-9]+\\)*\\'"
4407                   header))
4408                 (memq
4409                  nil (mapcar
4410                       (lambda (g)
4411                         (not (string-match "\\.\\'\\|\\.\\." g)))
4412                       (message-tokenize-header header ","))))
4413                (setq error t)))
4414          (unless error
4415            (pop headers)))
4416        (if (not error)
4417            t
4418          (y-or-n-p
4419           (format "The %s header looks odd: \"%s\".  Really post? "
4420                   (car headers) header)))))
4421    (message-check 'repeated-newsgroups
4422      (let ((case-fold-search t)
4423            (headers '("Newsgroups" "Followup-To"))
4424            header error groups group)
4425        (while (and headers
4426                    (not error))
4427          (when (setq header (mail-fetch-field (pop headers)))
4428            (setq groups (message-tokenize-header header ","))
4429            (while (setq group (pop groups))
4430              (when (member group groups)
4431                (setq error group
4432                      groups nil)))))
4433        (if (not error)
4434            t
4435          (y-or-n-p
4436           (format "Group %s is repeated in headers.  Really post? " error)))))
4437    ;; Check the From header.
4438    (message-check 'from
4439      (let* ((case-fold-search t)
4440             (from (message-fetch-field "from"))
4441             ad)
4442        (cond
4443         ((not from)
4444          (message "There is no From line.  Posting is denied.")
4445          nil)
4446         ((or (not (string-match
4447                    "@[^\\.]*\\."
4448                    (setq ad (nth 1 (mail-extract-address-components
4449                                     from))))) ;larsi@ifi
4450              (string-match "\\.\\." ad) ;larsi@ifi..uio
4451              (string-match "@\\." ad)   ;larsi@.ifi.uio
4452              (string-match "\\.$" ad)   ;larsi@ifi.uio.
4453              (not (string-match "^[^@]+@[^@]+$" ad)) ;larsi.ifi.uio
4454              (string-match "(.*).*(.*)" from)) ;(lars) (lars)
4455          (message
4456           "Denied posting -- the From looks strange: \"%s\"." from)
4457          nil)
4458         ((let ((addresses (rfc822-addresses from)))
4459            (while (and addresses
4460                        (not (eq (string-to-char (car addresses)) ?\()))
4461              (setq addresses (cdr addresses)))
4462            addresses)
4463          (message
4464           "Denied posting -- bad From address: \"%s\"." from)
4465          nil)
4466         (t t))))
4467    ;; Check the Reply-To header.
4468    (message-check 'reply-to
4469      (let* ((case-fold-search t)
4470             (reply-to (message-fetch-field "reply-to"))
4471             ad)
4472        (cond
4473         ((not reply-to)
4474          t)
4475         ((string-match "," reply-to)
4476          (y-or-n-p
4477           (format "Multiple Reply-To addresses: \"%s\". Really post? "
4478                   reply-to)))
4479         ((or (not (string-match
4480                    "@[^\\.]*\\."
4481                    (setq ad (nth 1 (mail-extract-address-components
4482                                     reply-to))))) ;larsi@ifi
4483              (string-match "\\.\\." ad) ;larsi@ifi..uio
4484              (string-match "@\\." ad)   ;larsi@.ifi.uio
4485              (string-match "\\.$" ad)   ;larsi@ifi.uio.
4486              (not (string-match "^[^@]+@[^@]+$" ad)) ;larsi.ifi.uio
4487              (string-match "(.*).*(.*)" reply-to)) ;(lars) (lars)
4488          (y-or-n-p
4489           (format
4490            "The Reply-To looks strange: \"%s\". Really post? "
4491            reply-to)))
4492         (t t))))))
4493
4494 (defun message-check-news-body-syntax ()
4495   (and
4496    ;; Check for long lines.
4497    (message-check 'long-lines
4498      (goto-char (point-min))
4499      (re-search-forward
4500       (concat "^" (regexp-quote mail-header-separator) "$"))
4501      (forward-line 1)
4502      (while (and
4503              (or (looking-at
4504                   "<#\\(/\\)?\\(multipart\\|part\\|external\\|mml\\)")
4505                  (let ((p (point)))
4506                    (end-of-line)
4507                    (< (- (point) p) 80)))
4508              (zerop (forward-line 1))))
4509      (or (bolp)
4510          (eobp)
4511          (y-or-n-p
4512           "You have lines longer than 79 characters.  Really post? ")))
4513    ;; Check whether the article is empty.
4514    (message-check 'empty
4515      (goto-char (point-min))
4516      (re-search-forward
4517       (concat "^" (regexp-quote mail-header-separator) "$"))
4518      (forward-line 1)
4519      (let ((b (point)))
4520        (goto-char (point-max))
4521        (re-search-backward message-signature-separator nil t)
4522        (beginning-of-line)
4523        (or (re-search-backward "[^ \n\t]" b t)
4524            (if (message-gnksa-enable-p 'empty-article)
4525                (y-or-n-p "Empty article.  Really post? ")
4526              (message "Denied posting -- Empty article.")
4527              nil))))
4528    ;; Check for control characters.
4529    (message-check 'control-chars
4530      (if (re-search-forward
4531           (mm-string-as-multibyte "[\000-\007\013\015-\032\034-\037\200-\237]")
4532           nil t)
4533          (y-or-n-p
4534           "The article contains control characters.  Really post? ")
4535        t))
4536    ;; Check excessive size.
4537    (message-check 'size
4538      (if (> (buffer-size) 60000)
4539          (y-or-n-p
4540           (format "The article is %d octets long.  Really post? "
4541                   (buffer-size)))
4542        t))
4543    ;; Check whether any new text has been added.
4544    (message-check 'new-text
4545      (or
4546       (not message-checksum)
4547       (not (eq (message-checksum) message-checksum))
4548       (if (message-gnksa-enable-p 'quoted-text-only)
4549           (y-or-n-p
4550            "It looks like no new text has been added.  Really post? ")
4551         (message "Denied posting -- no new text has been added.")
4552         nil)))
4553    ;; Check the length of the signature.
4554    (message-check 'signature
4555      (goto-char (point-max))
4556      (if (> (count-lines (point) (point-max)) 5)
4557          (y-or-n-p
4558           (format
4559            "Your .sig is %d lines; it should be max 4.  Really post? "
4560            (1- (count-lines (point) (point-max)))))
4561        t))
4562    ;; Ensure that text follows last quoted portion.
4563    (message-check 'quoting-style
4564      (goto-char (point-max))
4565      (let ((no-problem t))
4566        (when (search-backward-regexp "^>[^\n]*\n" nil t)
4567          (setq no-problem (search-forward-regexp "^[ \t]*[^>\n]" nil t)))
4568        (if no-problem
4569            t
4570          (if (message-gnksa-enable-p 'quoted-text-only)
4571              (y-or-n-p "Your text should follow quoted text.  Really post? ")
4572            ;; Ensure that
4573            (goto-char (point-min))
4574            (re-search-forward
4575             (concat "^" (regexp-quote mail-header-separator) "$"))
4576            (if (search-forward-regexp "^[ \t]*[^>\n]" nil t)
4577                (y-or-n-p "Your text should follow quoted text.  Really post? ")
4578              (message "Denied posting -- only quoted text.")
4579              nil)))))))
4580
4581 (defun message-checksum ()
4582   "Return a \"checksum\" for the current buffer."
4583   (let ((sum 0))
4584     (save-excursion
4585       (goto-char (point-min))
4586       (re-search-forward
4587        (concat "^" (regexp-quote mail-header-separator) "$"))
4588       (while (not (eobp))
4589         (when (not (looking-at "[ \t\n]"))
4590           (setq sum (logxor (ash sum 1) (if (natnump sum) 0 1)
4591                             (char-after))))
4592         (forward-char 1)))
4593     sum))
4594
4595 (defun message-do-fcc ()
4596   "Process Fcc headers in the current buffer."
4597   (let ((case-fold-search t)
4598         (buf (current-buffer))
4599         list file
4600         (mml-externalize-attachments message-fcc-externalize-attachments))
4601     (save-excursion
4602       (save-restriction
4603         (message-narrow-to-headers)
4604         (setq file (message-fetch-field "fcc" t)))
4605       (when file
4606         (set-buffer (get-buffer-create " *message temp*"))
4607         (erase-buffer)
4608         (insert-buffer-substring buf)
4609         (message-encode-message-body)
4610         (save-restriction
4611           (message-narrow-to-headers)
4612           (while (setq file (message-fetch-field "fcc" t))
4613             (push file list)
4614             (message-remove-header "fcc" nil t))
4615           (let ((mail-parse-charset message-default-charset)
4616                 (rfc2047-header-encoding-alist
4617                  (cons '("Newsgroups" . default)
4618                        rfc2047-header-encoding-alist)))
4619             (mail-encode-encoded-word-buffer)))
4620         (goto-char (point-min))
4621         (when (re-search-forward
4622                (concat "^" (regexp-quote mail-header-separator) "$")
4623                nil t)
4624           (replace-match "" t t ))
4625         ;; Process FCC operations.
4626         (while list
4627           (setq file (pop list))
4628           (if (string-match "^[ \t]*|[ \t]*\\(.*\\)[ \t]*$" file)
4629               ;; Pipe the article to the program in question.
4630               (call-process-region (point-min) (point-max) shell-file-name
4631                                    nil nil nil shell-command-switch
4632                                    (match-string 1 file))
4633             ;; Save the article.
4634             (setq file (expand-file-name file))
4635             (unless (file-exists-p (file-name-directory file))
4636               (make-directory (file-name-directory file) t))
4637             (if (and message-fcc-handler-function
4638                      (not (eq message-fcc-handler-function 'rmail-output)))
4639                 (funcall message-fcc-handler-function file)
4640               (if (and (file-readable-p file) (mail-file-babyl-p file))
4641                   (rmail-output file 1 nil t)
4642                 (let ((mail-use-rfc822 t))
4643                   (rmail-output file 1 t t))))))
4644         (kill-buffer (current-buffer))))))
4645
4646 (defun message-output (filename)
4647   "Append this article to Unix/babyl mail file FILENAME."
4648   (if (and (file-readable-p filename)
4649            (mail-file-babyl-p filename))
4650       (gnus-output-to-rmail filename t)
4651     (gnus-output-to-mail filename t)))
4652
4653 (defun message-cleanup-headers ()
4654   "Do various automatic cleanups of the headers."
4655   ;; Remove empty lines in the header.
4656   (save-restriction
4657     (message-narrow-to-headers)
4658     ;; Remove blank lines.
4659     (while (re-search-forward "^[ \t]*\n" nil t)
4660       (replace-match "" t t))
4661
4662     ;; Correct Newsgroups and Followup-To headers:  Change sequence of
4663     ;; spaces to comma and eliminate spaces around commas.  Eliminate
4664     ;; embedded line breaks.
4665     (goto-char (point-min))
4666     (while (re-search-forward "^\\(Newsgroups\\|Followup-To\\): +" nil t)
4667       (save-restriction
4668         (narrow-to-region
4669          (point)
4670          (if (re-search-forward "^[^ \t]" nil t)
4671              (match-beginning 0)
4672            (forward-line 1)
4673            (point)))
4674         (goto-char (point-min))
4675         (while (re-search-forward "\n[ \t]+" nil t)
4676           (replace-match " " t t))     ;No line breaks (too confusing)
4677         (goto-char (point-min))
4678         (while (re-search-forward "[ \t\n]*,[ \t\n]*\\|[ \t]+" nil t)
4679           (replace-match "," t t))
4680         (goto-char (point-min))
4681         ;; Remove trailing commas.
4682         (when (re-search-forward ",+$" nil t)
4683           (replace-match "" t t))))))
4684
4685 (defun message-make-date (&optional now)
4686   "Make a valid data header.
4687 If NOW, use that time instead."
4688   (let ((system-time-locale "C"))
4689     (format-time-string "%a, %d %b %Y %T %z" now)))
4690
4691 (defun message-make-message-id ()
4692   "Make a unique Message-ID."
4693   (concat "<" (message-unique-id)
4694           (let ((psubject (save-excursion (message-fetch-field "subject")))
4695                 (psupersedes
4696                  (save-excursion (message-fetch-field "supersedes"))))
4697             (if (or
4698                  (and message-reply-headers
4699                       (mail-header-references message-reply-headers)
4700                       (mail-header-subject message-reply-headers)
4701                       psubject
4702                       (not (string=
4703                             (message-strip-subject-re
4704                              (mail-header-subject message-reply-headers))
4705                             (message-strip-subject-re psubject))))
4706                  (and psupersedes
4707                       (string-match "_-_@" psupersedes)))
4708                 "_-_" ""))
4709           "@" (message-make-fqdn) ">"))
4710
4711 (defvar message-unique-id-char nil)
4712
4713 ;; If you ever change this function, make sure the new version
4714 ;; cannot generate IDs that the old version could.
4715 ;; You might for example insert a "." somewhere (not next to another dot
4716 ;; or string boundary), or modify the "fsf" string.
4717 (defun message-unique-id ()
4718   ;; Don't use microseconds from (current-time), they may be unsupported.
4719   ;; Instead we use this randomly inited counter.
4720   (setq message-unique-id-char
4721         (% (1+ (or message-unique-id-char (logand (random t) (1- (lsh 1 20)))))
4722            ;; (current-time) returns 16-bit ints,
4723            ;; and 2^16*25 just fits into 4 digits i base 36.
4724            (* 25 25)))
4725   (let ((tm (current-time)))
4726     (concat
4727      (if (memq system-type '(ms-dos emx vax-vms))
4728          (let ((user (downcase (user-login-name))))
4729            (while (string-match "[^a-z0-9_]" user)
4730              (aset user (match-beginning 0) ?_))
4731            user)
4732        (message-number-base36 (user-uid) -1))
4733      (message-number-base36 (+ (car tm)
4734                                (lsh (% message-unique-id-char 25) 16)) 4)
4735      (message-number-base36 (+ (nth 1 tm)
4736                                (lsh (/ message-unique-id-char 25) 16)) 4)
4737      ;; Append a given name, because while the generated ID is unique
4738      ;; to this newsreader, other newsreaders might otherwise generate
4739      ;; the same ID via another algorithm.
4740      ".fsf")))
4741
4742 (defun message-number-base36 (num len)
4743   (if (if (< len 0)
4744           (<= num 0)
4745         (= len 0))
4746       ""
4747     (concat (message-number-base36 (/ num 36) (1- len))
4748             (char-to-string (aref "zyxwvutsrqponmlkjihgfedcba9876543210"
4749                                   (% num 36))))))
4750
4751 (defun message-make-organization ()
4752   "Make an Organization header."
4753   (let* ((organization
4754           (when message-user-organization
4755             (if (functionp message-user-organization)
4756                 (funcall message-user-organization)
4757               message-user-organization))))
4758     (with-temp-buffer
4759       (mm-enable-multibyte)
4760       (cond ((stringp organization)
4761              (insert organization))
4762             ((and (eq t organization)
4763                   message-user-organization-file
4764                   (file-exists-p message-user-organization-file))
4765              (insert-file-contents message-user-organization-file)))
4766       (goto-char (point-min))
4767       (while (re-search-forward "[\t\n]+" nil t)
4768         (replace-match "" t t))
4769       (unless (zerop (buffer-size))
4770         (buffer-string)))))
4771
4772 (defun message-make-lines ()
4773   "Count the number of lines and return numeric string."
4774   (save-excursion
4775     (save-restriction
4776       (widen)
4777       (message-goto-body)
4778       (int-to-string (count-lines (point) (point-max))))))
4779
4780 (defun message-make-references ()
4781   "Return the References header for this message."
4782   (when message-reply-headers
4783     (let ((message-id (mail-header-message-id message-reply-headers))
4784           (references (mail-header-references message-reply-headers))
4785           new-references)
4786       (if (or references message-id)
4787           (concat (or references "") (and references " ")
4788                   (or message-id ""))
4789         nil))))
4790
4791 (defun message-make-in-reply-to ()
4792   "Return the In-Reply-To header for this message."
4793   (when message-reply-headers
4794     (let ((from (mail-header-from message-reply-headers))
4795           (date (mail-header-date message-reply-headers))
4796           (msg-id (mail-header-message-id message-reply-headers)))
4797       (when from
4798         (let ((name (mail-extract-address-components from)))
4799           (concat msg-id (if msg-id " (")
4800                   (or (car name)
4801                       (nth 1 name))
4802                   "'s message of \""
4803                   (if (or (not date) (string= date ""))
4804                       "(unknown date)" date)
4805                   "\"" (if msg-id ")")))))))
4806
4807 (defun message-make-distribution ()
4808   "Make a Distribution header."
4809   (let ((orig-distribution (message-fetch-reply-field "distribution")))
4810     (cond ((functionp message-distribution-function)
4811            (funcall message-distribution-function))
4812           (t orig-distribution))))
4813
4814 (defun message-make-expires ()
4815   "Return an Expires header based on `message-expires'."
4816   (let ((current (current-time))
4817         (future (* 1.0 message-expires 60 60 24)))
4818     ;; Add the future to current.
4819     (setcar current (+ (car current) (round (/ future (expt 2 16)))))
4820     (setcar (cdr current) (+ (nth 1 current) (% (round future) (expt 2 16))))
4821     (message-make-date current)))
4822
4823 (defun message-make-path ()
4824   "Return uucp path."
4825   (let ((login-name (user-login-name)))
4826     (cond ((null message-user-path)
4827            (concat (system-name) "!" login-name))
4828           ((stringp message-user-path)
4829            ;; Support GENERICPATH.  Suggested by vixie@decwrl.dec.com.
4830            (concat message-user-path "!" login-name))
4831           (t login-name))))
4832
4833 (defun message-make-from ()
4834   "Make a From header."
4835   (let* ((style message-from-style)
4836          (login (message-make-address))
4837          (fullname
4838           (or (and (boundp 'user-full-name)
4839                    user-full-name)
4840               (user-full-name))))
4841     (when (string= fullname "&")
4842       (setq fullname (user-login-name)))
4843     (with-temp-buffer
4844       (mm-enable-multibyte)
4845       (cond
4846        ((or (null style)
4847             (equal fullname ""))
4848         (insert login))
4849        ((or (eq style 'angles)
4850             (and (not (eq style 'parens))
4851                  ;; Use angles if no quoting is needed, or if parens would
4852                  ;; need quoting too.
4853                  (or (not (string-match "[^- !#-'*+/-9=?A-Z^-~]" fullname))
4854                      (let ((tmp (concat fullname nil)))
4855                        (while (string-match "([^()]*)" tmp)
4856                          (aset tmp (match-beginning 0) ?-)
4857                          (aset tmp (1- (match-end 0)) ?-))
4858                        (string-match "[\\()]" tmp)))))
4859         (insert fullname)
4860         (goto-char (point-min))
4861         ;; Look for a character that cannot appear unquoted
4862         ;; according to RFC 822.
4863         (when (re-search-forward "[^- !#-'*+/-9=?A-Z^-~]" nil 1)
4864           ;; Quote fullname, escaping specials.
4865           (goto-char (point-min))
4866           (insert "\"")
4867           (while (re-search-forward "[\"\\]" nil 1)
4868             (replace-match "\\\\\\&" t))
4869           (insert "\""))
4870         (insert " <" login ">"))
4871        (t                               ; 'parens or default
4872         (insert login " (")
4873         (let ((fullname-start (point)))
4874           (insert fullname)
4875           (goto-char fullname-start)
4876           ;; RFC 822 says \ and nonmatching parentheses
4877           ;; must be escaped in comments.
4878           ;; Escape every instance of ()\ ...
4879           (while (re-search-forward "[()\\]" nil 1)
4880             (replace-match "\\\\\\&" t))
4881           ;; ... then undo escaping of matching parentheses,
4882           ;; including matching nested parentheses.
4883           (goto-char fullname-start)
4884           (while (re-search-forward
4885                   "\\(\\=\\|[^\\]\\(\\\\\\\\\\)*\\)\\\\(\\(\\([^\\]\\|\\\\\\\\\\)*\\)\\\\)"
4886                   nil 1)
4887             (replace-match "\\1(\\3)" t)
4888             (goto-char fullname-start)))
4889         (insert ")")))
4890       (buffer-string))))
4891
4892 (defun message-make-sender ()
4893   "Return the \"real\" user address.
4894 This function tries to ignore all user modifications, and
4895 give as trustworthy answer as possible."
4896   (concat (user-login-name) "@" (system-name)))
4897
4898 (defun message-make-address ()
4899   "Make the address of the user."
4900   (or (message-user-mail-address)
4901       (concat (user-login-name) "@" (message-make-domain))))
4902
4903 (defun message-user-mail-address ()
4904   "Return the pertinent part of `user-mail-address'."
4905   (when (and user-mail-address
4906              (string-match "@.*\\." user-mail-address))
4907     (if (string-match " " user-mail-address)
4908         (nth 1 (mail-extract-address-components user-mail-address))
4909       user-mail-address)))
4910
4911 (defun message-sendmail-envelope-from ()
4912   "Return the envelope from."
4913   (cond ((eq message-sendmail-envelope-from 'header)
4914          (nth 1 (mail-extract-address-components
4915                  (message-fetch-field "from"))))
4916         ((stringp message-sendmail-envelope-from)
4917          message-sendmail-envelope-from)
4918         (t
4919          (message-make-address))))
4920
4921 (defun message-make-fqdn ()
4922   "Return user's fully qualified domain name."
4923   (let* ((system-name (system-name))
4924          (user-mail (message-user-mail-address))
4925          (user-domain
4926           (if (and user-mail
4927                    (string-match "@\\(.*\\)\\'" user-mail))
4928               (match-string 1 user-mail)))
4929          (case-fold-search t))
4930     (cond
4931      ((and message-user-fqdn
4932            (stringp message-user-fqdn)
4933            (string-match message-valid-fqdn-regexp message-user-fqdn)
4934            (not (string-match message-bogus-system-names message-user-fqdn)))
4935       message-user-fqdn)
4936      ;; `message-user-fqdn' seems to be valid
4937      ((and (string-match message-valid-fqdn-regexp system-name)
4938            (not (string-match message-bogus-system-names system-name)))
4939       ;; `system-name' returned the right result.
4940       system-name)
4941      ;; Try `mail-host-address'.
4942      ((and (boundp 'mail-host-address)
4943            (stringp mail-host-address)
4944            (string-match message-valid-fqdn-regexp mail-host-address)
4945            (not (string-match message-bogus-system-names mail-host-address)))
4946       mail-host-address)
4947      ;; We try `user-mail-address' as a backup.
4948      ((and user-domain
4949            (stringp user-domain)
4950            (string-match message-valid-fqdn-regexp user-domain)
4951            (not (string-match message-bogus-system-names user-domain)))
4952       user-domain)
4953      ;; Default to this bogus thing.
4954      (t
4955       (concat system-name
4956               ".i-did-not-set--mail-host-address--so-tickle-me")))))
4957
4958 (defun message-make-host-name ()
4959   "Return the name of the host."
4960   (let ((fqdn (message-make-fqdn)))
4961     (string-match "^[^.]+\\." fqdn)
4962     (substring fqdn 0 (1- (match-end 0)))))
4963
4964 (defun message-make-domain ()
4965   "Return the domain name."
4966   (or mail-host-address
4967       (message-make-fqdn)))
4968
4969 (defun message-to-list-only ()
4970   "Send a message to the list only.
4971 Remove all addresses but the list address from To and Cc headers."
4972   (interactive)
4973   (let ((listaddr (message-make-mail-followup-to t)))
4974     (when listaddr
4975       (save-excursion
4976         (message-remove-header "to")
4977         (message-remove-header "cc")
4978         (message-position-on-field "To" "X-Draft-From")
4979         (insert listaddr)))))
4980
4981 (defun message-make-mail-followup-to (&optional only-show-subscribed)
4982   "Return the Mail-Followup-To header.
4983 If passed the optional argument ONLY-SHOW-SUBSCRIBED only return the
4984 subscribed address (and not the additional To and Cc header contents)."
4985   (let* ((case-fold-search t)
4986          (to (message-fetch-field "To"))
4987          (cc (message-fetch-field "cc"))
4988          (msg-recipients (concat to (and to cc ", ") cc))
4989          (recipients
4990           (mapcar 'mail-strip-quoted-names
4991                   (message-tokenize-header msg-recipients)))
4992          (file-regexps
4993           (if message-subscribed-address-file
4994               (let (begin end item re)
4995                 (save-excursion
4996                   (with-temp-buffer
4997                     (insert-file-contents message-subscribed-address-file)
4998                     (while (not (eobp))
4999                       (setq begin (point))
5000                       (forward-line 1)
5001                       (setq end (point))
5002                       (if (bolp) (setq end (1- end)))
5003                       (setq item (regexp-quote (buffer-substring begin end)))
5004                       (if re (setq re (concat re "\\|" item))
5005                         (setq re (concat "\\`\\(" item))))
5006                     (and re (list (concat re "\\)\\'"))))))))
5007          (mft-regexps (apply 'append message-subscribed-regexps
5008                              (mapcar 'regexp-quote
5009                                      message-subscribed-addresses)
5010                              file-regexps
5011                              (mapcar 'funcall
5012                                      message-subscribed-address-functions))))
5013     (save-match-data
5014       (let ((subscribed-lists nil)
5015             (list
5016              (loop for recipient in recipients
5017                when (loop for regexp in mft-regexps
5018                       when (string-match regexp recipient) return t)
5019                return recipient)))
5020         (when list
5021           (if only-show-subscribed
5022               list
5023             msg-recipients))))))
5024
5025 (defun message-idna-to-ascii-rhs-1 (header)
5026   "Interactively potentially IDNA encode domain names in HEADER."
5027   (let ((field (message-fetch-field header))
5028         rhs ace  address)
5029     (when field
5030       (dolist (address (mail-header-parse-addresses field))
5031         (setq address (car address)
5032               rhs (downcase (or (cadr (split-string address "@")) ""))
5033               ace (downcase (idna-to-ascii rhs)))
5034         (when (and (not (equal rhs ace))
5035                    (or (not (eq message-use-idna 'ask))
5036                        (y-or-n-p (format "Replace %s with %s? " rhs ace))))
5037           (goto-char (point-min))
5038           (while (re-search-forward (concat "^" header ":") nil t)
5039             (message-narrow-to-field)
5040             (while (search-forward (concat "@" rhs) nil t)
5041               (replace-match (concat "@" ace) t t))
5042             (goto-char (point-max))
5043             (widen)))))))
5044
5045 (defun message-idna-to-ascii-rhs ()
5046   "Possibly IDNA encode non-ASCII domain names in From:, To: and Cc: headers.
5047 See `message-idna-encode'."
5048   (interactive)
5049   (when message-use-idna
5050     (save-excursion
5051       (save-restriction
5052         (message-narrow-to-head)
5053         (message-idna-to-ascii-rhs-1 "From")
5054         (message-idna-to-ascii-rhs-1 "To")
5055         (message-idna-to-ascii-rhs-1 "Reply-To")
5056         (message-idna-to-ascii-rhs-1 "Cc")))))
5057
5058 (defun message-generate-headers (headers)
5059   "Prepare article HEADERS.
5060 Headers already prepared in the buffer are not modified."
5061   (setq headers (append headers message-required-headers))
5062   (save-restriction
5063     (message-narrow-to-headers)
5064     (let* ((Date (message-make-date))
5065            (Message-ID (message-make-message-id))
5066            (Organization (message-make-organization))
5067            (From (message-make-from))
5068            (Path (message-make-path))
5069            (Subject nil)
5070            (Newsgroups nil)
5071            (In-Reply-To (message-make-in-reply-to))
5072            (References (message-make-references))
5073            (To nil)
5074            (Distribution (message-make-distribution))
5075            (Lines (message-make-lines))
5076            (User-Agent message-newsreader)
5077            (Expires (message-make-expires))
5078            (case-fold-search t)
5079            (optionalp nil)
5080            header value elem header-string)
5081       ;; First we remove any old generated headers.
5082       (let ((headers message-deletable-headers))
5083         (unless (buffer-modified-p)
5084           (setq headers (delq 'Message-ID (copy-sequence headers))))
5085         (while headers
5086           (goto-char (point-min))
5087           (and (re-search-forward
5088                 (concat "^" (symbol-name (car headers)) ": *") nil t)
5089                (get-text-property (1+ (match-beginning 0)) 'message-deletable)
5090                (message-delete-line))
5091           (pop headers)))
5092       ;; Go through all the required headers and see if they are in the
5093       ;; articles already.  If they are not, or are empty, they are
5094       ;; inserted automatically - except for Subject, Newsgroups and
5095       ;; Distribution.
5096       (while headers
5097         (goto-char (point-min))
5098         (setq elem (pop headers))
5099         (if (consp elem)
5100             (if (eq (car elem) 'optional)
5101                 (setq header (cdr elem)
5102                       optionalp t)
5103               (setq header (car elem)))
5104           (setq header elem))
5105         (setq header-string  (if (stringp header)
5106                                  header
5107                                (symbol-name header)))
5108         (when (or (not (re-search-forward
5109                         (concat "^"
5110                                 (regexp-quote (downcase header-string))
5111                                 ":")
5112                         nil t))
5113                   (progn
5114                     ;; The header was found.  We insert a space after the
5115                     ;; colon, if there is none.
5116                     (if (/= (char-after) ? ) (insert " ") (forward-char 1))
5117                     ;; Find out whether the header is empty.
5118                     (looking-at "[ \t]*\n[^ \t]")))
5119           ;; So we find out what value we should insert.
5120           (setq value
5121                 (cond
5122                  ((and (consp elem)
5123                        (eq (car elem) 'optional)
5124                        (not (member header-string message-inserted-headers)))
5125                   ;; This is an optional header.  If the cdr of this
5126                   ;; is something that is nil, then we do not insert
5127                   ;; this header.
5128                   (setq header (cdr elem))
5129                   (or (and (functionp (cdr elem))
5130                            (funcall (cdr elem)))
5131                       (and (boundp (cdr elem))
5132                            (symbol-value (cdr elem)))))
5133                  ((consp elem)
5134                   ;; The element is a cons.  Either the cdr is a
5135                   ;; string to be inserted verbatim, or it is a
5136                   ;; function, and we insert the value returned from
5137                   ;; this function.
5138                   (or (and (stringp (cdr elem))
5139                            (cdr elem))
5140                       (and (functionp (cdr elem))
5141                            (funcall (cdr elem)))))
5142                  ((and (boundp header)
5143                        (symbol-value header))
5144                   ;; The element is a symbol.  We insert the value
5145                   ;; of this symbol, if any.
5146                   (symbol-value header))
5147                  ((not (message-check-element header))
5148                   ;; We couldn't generate a value for this header,
5149                   ;; so we just ask the user.
5150                   (read-from-minibuffer
5151                    (format "Empty header for %s; enter value: " header)))))
5152           ;; Finally insert the header.
5153           (when (and value
5154                      (not (equal value "")))
5155             (save-excursion
5156               (if (bolp)
5157                   (progn
5158                     ;; This header didn't exist, so we insert it.
5159                     (goto-char (point-max))
5160                     (let ((formatter
5161                            (cdr (assq header message-header-format-alist))))
5162                       (if formatter
5163                           (funcall formatter header value)
5164                         (insert header-string ": " value))
5165                       (goto-char (message-fill-field))
5166                       ;; We check whether the value was ended by a
5167                       ;; newline.  If not, we insert one.
5168                       (unless (bolp)
5169                         (insert "\n"))
5170                       (forward-line -1)))
5171                 ;; The value of this header was empty, so we clear
5172                 ;; totally and insert the new value.
5173                 (delete-region (point) (point-at-eol))
5174                 ;; If the header is optional, and the header was
5175                 ;; empty, we con't insert it anyway.
5176                 (unless optionalp
5177                   (push header-string message-inserted-headers)
5178                   (insert value)
5179                   (message-fill-field)))
5180               ;; Add the deletable property to the headers that require it.
5181               (and (memq header message-deletable-headers)
5182                    (progn (beginning-of-line) (looking-at "[^:]+: "))
5183                    (add-text-properties
5184                     (point) (match-end 0)
5185                     '(message-deletable t face italic) (current-buffer)))))))
5186       ;; Insert new Sender if the From is strange.
5187       (let ((from (message-fetch-field "from"))
5188             (sender (message-fetch-field "sender"))
5189             (secure-sender (message-make-sender)))
5190         (when (and from
5191                    (not (message-check-element 'sender))
5192                    (not (string=
5193                          (downcase
5194                           (cadr (mail-extract-address-components from)))
5195                          (downcase secure-sender)))
5196                    (or (null sender)
5197                        (not
5198                         (string=
5199                          (downcase
5200                           (cadr (mail-extract-address-components sender)))
5201                          (downcase secure-sender)))))
5202           (goto-char (point-min))
5203           ;; Rename any old Sender headers to Original-Sender.
5204           (when (re-search-forward "^\\(Original-\\)*Sender:" nil t)
5205             (beginning-of-line)
5206             (insert "Original-")
5207             (beginning-of-line))
5208           (when (or (message-news-p)
5209                     (string-match "@.+\\.." secure-sender))
5210             (insert "Sender: " secure-sender "\n"))))
5211       ;; Check for IDNA
5212       (message-idna-to-ascii-rhs))))
5213
5214 (defun message-insert-courtesy-copy ()
5215   "Insert a courtesy message in mail copies of combined messages."
5216   (let (newsgroups)
5217     (save-excursion
5218       (save-restriction
5219         (message-narrow-to-headers)
5220         (when (setq newsgroups (message-fetch-field "newsgroups"))
5221           (goto-char (point-max))
5222           (insert "Posted-To: " newsgroups "\n")))
5223       (forward-line 1)
5224       (when message-courtesy-message
5225         (cond
5226          ((string-match "%s" message-courtesy-message)
5227           (insert (format message-courtesy-message newsgroups)))
5228          (t
5229           (insert message-courtesy-message)))))))
5230
5231 ;;;
5232 ;;; Setting up a message buffer
5233 ;;;
5234
5235 (defun message-skip-to-next-address ()
5236   (let ((end (save-excursion
5237                (message-next-header)
5238                (point)))
5239         quoted char)
5240     (when (looking-at ",")
5241       (forward-char 1))
5242     (while (and (not (= (point) end))
5243                 (or (not (eq char ?,))
5244                     quoted))
5245       (skip-chars-forward "^,\"" (point-max))
5246       (when (eq (setq char (following-char)) ?\")
5247         (setq quoted (not quoted)))
5248       (unless (= (point) end)
5249         (forward-char 1)))
5250     (skip-chars-forward " \t\n")))
5251
5252 (defun message-fill-address (header value)
5253   (insert (capitalize (symbol-name header))
5254           ": "
5255           (if (consp value) (car value) value)
5256           "\n")
5257   (message-fill-field-address))
5258
5259 (defun message-split-line ()
5260   "Split current line, moving portion beyond point vertically down.
5261 If the current line has `message-yank-prefix', insert it on the new line."
5262   (interactive "*")
5263   (condition-case nil
5264       (split-line message-yank-prefix) ;; Emacs 22.1+ supports arg.
5265     (error
5266      (split-line))))
5267
5268 (defun message-insert-header (header value)
5269   (insert (capitalize (symbol-name header))
5270           ": "
5271           (if (consp value) (car value) value)))
5272
5273 (defun message-field-name ()
5274   (save-excursion
5275     (goto-char (point-min))
5276     (when (looking-at "\\([^:]+\\):")
5277       (intern (capitalize (match-string 1))))))
5278
5279 (defun message-fill-field ()
5280   (save-excursion
5281     (save-restriction
5282       (message-narrow-to-field)
5283       (let ((field-name (message-field-name)))
5284         (funcall (or (cadr (assq field-name message-field-fillers))
5285                      'message-fill-field-general)))
5286       (point-max))))
5287
5288 (defun message-fill-field-address ()
5289   (while (not (eobp))
5290     (message-skip-to-next-address)
5291     (let (last)
5292       (if (and (> (current-column) 78)
5293                last)
5294           (progn
5295             (save-excursion
5296               (goto-char last)
5297               (insert "\n\t"))
5298             (setq last (1+ (point))))
5299         (setq last (1+ (point)))))))
5300
5301 (defun message-fill-field-general ()
5302   (let ((begin (point))
5303         (fill-column 78)
5304         (fill-prefix "\t"))
5305     (while (and (search-forward "\n" nil t)
5306                 (not (eobp)))
5307       (replace-match " " t t))
5308     (fill-region-as-paragraph begin (point-max))
5309     ;; Tapdance around looong Message-IDs.
5310     (forward-line -1)
5311     (when (looking-at "[ \t]*$")
5312       (message-delete-line))
5313     (goto-char begin)
5314     (search-forward ":" nil t)
5315     (when (looking-at "\n[ \t]+")
5316       (replace-match " " t t))
5317     (goto-char (point-max))))
5318
5319 (defun message-shorten-1 (list cut surplus)
5320   "Cut SURPLUS elements out of LIST, beginning with CUTth one."
5321   (setcdr (nthcdr (- cut 2) list)
5322           (nthcdr (+ (- cut 2) surplus 1) list)))
5323
5324 (defun message-shorten-references (header references)
5325   "Trim REFERENCES to be 21 Message-ID long or less, and fold them.
5326 When sending via news, also check that the REFERENCES are less
5327 than 988 characters long, and if they are not, trim them until
5328 they are."
5329   (let ((maxcount 21)
5330         (count 0)
5331         (cut 2)
5332         refs)
5333     (with-temp-buffer
5334       (insert references)
5335       (goto-char (point-min))
5336       ;; Cons a list of valid references.
5337       (while (re-search-forward "<[^>]+>" nil t)
5338         (push (match-string 0) refs))
5339       (setq refs (nreverse refs)
5340             count (length refs)))
5341
5342     ;; If the list has more than MAXCOUNT elements, trim it by
5343     ;; removing the CUTth element and the required number of
5344     ;; elements that follow.
5345     (when (> count maxcount)
5346       (let ((surplus (- count maxcount)))
5347         (message-shorten-1 refs cut surplus)
5348         (decf count surplus)))
5349
5350     ;; When sending via news, make sure the total folded length will
5351     ;; be less than 998 characters.  This is to cater to broken INN
5352     ;; 2.3 which counts the total number of characters in a header
5353     ;; rather than the physical line length of each line, as it should.
5354     ;;
5355     ;; This hack should be removed when it's believed than INN 2.3 is
5356     ;; no longer widely used.
5357     ;;
5358     ;; At this point the headers have not been generated, thus we use
5359     ;; message-this-is-news directly.
5360     (when message-this-is-news
5361       (while (< 998
5362                 (with-temp-buffer
5363                   (message-insert-header
5364                    header (mapconcat #'identity refs " "))
5365                   (buffer-size)))
5366         (message-shorten-1 refs cut 1)))
5367     ;; Finally, collect the references back into a string and insert
5368     ;; it into the buffer.
5369     (message-insert-header header (mapconcat #'identity refs " "))))
5370
5371 (defun message-position-point ()
5372   "Move point to where the user probably wants to find it."
5373   (message-narrow-to-headers)
5374   (cond
5375    ((re-search-forward "^[^:]+:[ \t]*$" nil t)
5376     (search-backward ":" )
5377     (widen)
5378     (forward-char 1)
5379     (if (eq (char-after) ? )
5380         (forward-char 1)
5381       (insert " ")))
5382    (t
5383     (goto-char (point-max))
5384     (widen)
5385     (forward-line 1)
5386     (unless (looking-at "$")
5387       (forward-line 2)))
5388    (sit-for 0)))
5389
5390 (defcustom message-beginning-of-line t
5391   "Whether \\<message-mode-map>\\[message-beginning-of-line]\
5392  goes to beginning of header values."
5393   :version "22.1"
5394   :group 'message-buffers
5395   :link '(custom-manual "(message)Movement")
5396   :type 'boolean)
5397
5398 (defun message-beginning-of-line (&optional n)
5399   "Move point to beginning of header value or to beginning of line.
5400 The prefix argument N is passed directly to `beginning-of-line'.
5401
5402 This command is identical to `beginning-of-line' if point is
5403 outside the message header or if the option `message-beginning-of-line'
5404 is nil.
5405
5406 If point is in the message header and on a (non-continued) header
5407 line, move point to the beginning of the header value or the beginning of line,
5408 whichever is closer.  If point is already at beginning of line, move point to
5409 beginning of header value.  Therefore, repeated calls will toggle point
5410 between beginning of field and beginning of line."
5411   (interactive "p")
5412   (let ((zrs 'zmacs-region-stays))
5413     (when (and (interactive-p) (boundp zrs))
5414       (set zrs t)))
5415   (if (and message-beginning-of-line
5416            (message-point-in-header-p))
5417       (let* ((here (point))
5418              (bol (progn (beginning-of-line n) (point)))
5419              (eol (point-at-eol))
5420              (eoh (re-search-forward ": *" eol t)))
5421         (goto-char
5422          (if (and eoh (or (< eoh here) (= bol here)))
5423              eoh bol)))
5424     (beginning-of-line n)))
5425
5426 (defun message-buffer-name (type &optional to group)
5427   "Return a new (unique) buffer name based on TYPE and TO."
5428   (cond
5429    ;; Generate a new buffer name The Message Way.
5430    ((eq message-generate-new-buffers 'unique)
5431     (generate-new-buffer-name
5432      (concat "*" type
5433              (if to
5434                  (concat " to "
5435                          (or (car (mail-extract-address-components to))
5436                              to) "")
5437                "")
5438              (if (and group (not (string= group ""))) (concat " on " group) "")
5439              "*")))
5440    ;; Check whether `message-generate-new-buffers' is a function,
5441    ;; and if so, call it.
5442    ((functionp message-generate-new-buffers)
5443     (funcall message-generate-new-buffers type to group))
5444    ((eq message-generate-new-buffers 'unsent)
5445     (generate-new-buffer-name
5446      (concat "*unsent " type
5447              (if to
5448                  (concat " to "
5449                          (or (car (mail-extract-address-components to))
5450                              to) "")
5451                "")
5452              (if (and group (not (string= group ""))) (concat " on " group) "")
5453              "*")))
5454    ;; Use standard name.
5455    (t
5456     (format "*%s message*" type))))
5457
5458 (defun message-pop-to-buffer (name)
5459   "Pop to buffer NAME, and warn if it already exists and is modified."
5460   (let ((buffer (get-buffer name)))
5461     (if (and buffer
5462              (buffer-name buffer))
5463         (progn
5464           (set-buffer (pop-to-buffer buffer))
5465           (when (and (buffer-modified-p)
5466                      (not (y-or-n-p
5467                            "Message already being composed; erase? ")))
5468             (error "Message being composed")))
5469       (set-buffer (pop-to-buffer name)))
5470     (erase-buffer)
5471     (message-mode)))
5472
5473 (defun message-do-send-housekeeping ()
5474   "Kill old message buffers."
5475   ;; We might have sent this buffer already.  Delete it from the
5476   ;; list of buffers.
5477   (setq message-buffer-list (delq (current-buffer) message-buffer-list))
5478   (while (and message-max-buffers
5479               message-buffer-list
5480               (>= (length message-buffer-list) message-max-buffers))
5481     ;; Kill the oldest buffer -- unless it has been changed.
5482     (let ((buffer (pop message-buffer-list)))
5483       (when (and (buffer-name buffer)
5484                  (not (buffer-modified-p buffer)))
5485         (kill-buffer buffer))))
5486   ;; Rename the buffer.
5487   (if message-send-rename-function
5488       (funcall message-send-rename-function)
5489     ;; Note: mail-abbrevs of XEmacs renames buffer name behind Gnus.
5490     (when (string-match
5491            "\\`\\*\\(sent \\|unsent \\)?\\(.+\\)\\*[^\\*]*\\|\\`mail to "
5492            (buffer-name))
5493       (let ((name (match-string 2 (buffer-name)))
5494             to group)
5495         (if (not (or (null name)
5496                      (string-equal name "mail")
5497                      (string-equal name "posting")))
5498             (setq name (concat "*sent " name "*"))
5499           (message-narrow-to-headers)
5500           (setq to (message-fetch-field "to"))
5501           (setq group (message-fetch-field "newsgroups"))
5502           (widen)
5503           (setq name
5504                 (cond
5505                  (to (concat "*sent mail to "
5506                              (or (car (mail-extract-address-components to))
5507                                  to) "*"))
5508                  ((and group (not (string= group "")))
5509                   (concat "*sent posting on " group "*"))
5510                  (t "*sent mail*"))))
5511         (unless (string-equal name (buffer-name))
5512           (rename-buffer name t)))))
5513   ;; Push the current buffer onto the list.
5514   (when message-max-buffers
5515     (setq message-buffer-list
5516           (nconc message-buffer-list (list (current-buffer))))))
5517
5518 (defun message-mail-user-agent ()
5519   (let ((mua (cond
5520               ((not message-mail-user-agent) nil)
5521               ((eq message-mail-user-agent t) mail-user-agent)
5522               (t message-mail-user-agent))))
5523     (if (memq mua '(message-user-agent gnus-user-agent))
5524         nil
5525       mua)))
5526
5527 (defun message-setup (headers &optional replybuffer actions switch-function)
5528   (let ((mua (message-mail-user-agent))
5529         subject to field yank-action)
5530     (if (not (and message-this-is-mail mua))
5531         (message-setup-1 headers replybuffer actions)
5532       (if replybuffer
5533           (setq yank-action (list 'insert-buffer replybuffer)))
5534       (setq headers (copy-sequence headers))
5535       (setq field (assq 'Subject headers))
5536       (when field
5537         (setq subject (cdr field))
5538         (setq headers (delq field headers)))
5539       (setq field (assq 'To headers))
5540       (when field
5541         (setq to (cdr field))
5542         (setq headers (delq field headers)))
5543       (let ((mail-user-agent mua))
5544         (compose-mail to subject
5545                       (mapcar (lambda (item)
5546                                 (cons
5547                                  (format "%s" (car item))
5548                                  (cdr item)))
5549                               headers)
5550                       nil switch-function yank-action actions)))))
5551
5552 (defun message-headers-to-generate (headers included-headers excluded-headers)
5553   "Return a list that includes all headers from HEADERS.
5554 If INCLUDED-HEADERS is a list, just include those headers.  If if is
5555 t, include all headers.  In any case, headers from EXCLUDED-HEADERS
5556 are not included."
5557   (let ((result nil)
5558         header-name)
5559     (dolist (header headers)
5560       (setq header-name (cond
5561                          ((and (consp header)
5562                                (eq (car header) 'optional))
5563                           ;; On the form (optional . Header)
5564                           (cdr header))
5565                          ((consp header)
5566                           ;; On the form (Header . function)
5567                           (car header))
5568                          (t
5569                           ;; Just a Header.
5570                           header)))
5571       (when (and (not (memq header-name excluded-headers))
5572                  (or (eq included-headers t)
5573                      (memq header-name included-headers)))
5574         (push header result)))
5575     (nreverse result)))
5576
5577 (defun message-setup-1 (headers &optional replybuffer actions)
5578   (dolist (action actions)
5579     (condition-case nil
5580         (add-to-list 'message-send-actions
5581                      `(apply ',(car action) ',(cdr action)))))
5582   (setq message-reply-buffer replybuffer)
5583   (goto-char (point-min))
5584   ;; Insert all the headers.
5585   (mail-header-format
5586    (let ((h headers)
5587          (alist message-header-format-alist))
5588      (while h
5589        (unless (assq (caar h) message-header-format-alist)
5590          (push (list (caar h)) alist))
5591        (pop h))
5592      alist)
5593    headers)
5594   (delete-region (point) (progn (forward-line -1) (point)))
5595   (when message-default-headers
5596     (insert message-default-headers)
5597     (or (bolp) (insert ?\n)))
5598   (insert mail-header-separator "\n")
5599   (forward-line -1)
5600   (when (message-news-p)
5601     (when message-default-news-headers
5602       (insert message-default-news-headers)
5603       (or (bolp) (insert ?\n)))
5604     (when message-generate-headers-first
5605       (message-generate-headers
5606        (message-headers-to-generate
5607         (append message-required-news-headers
5608                 message-required-headers)
5609         message-generate-headers-first
5610         '(Lines Subject)))))
5611   (when (message-mail-p)
5612     (when message-default-mail-headers
5613       (insert message-default-mail-headers)
5614       (or (bolp) (insert ?\n)))
5615     (when message-generate-headers-first
5616       (message-generate-headers
5617        (message-headers-to-generate
5618         (append message-required-mail-headers
5619                 message-required-headers)
5620         message-generate-headers-first
5621         '(Lines Subject)))))
5622   (run-hooks 'message-signature-setup-hook)
5623   (message-insert-signature)
5624   (save-restriction
5625     (message-narrow-to-headers)
5626     (run-hooks 'message-header-setup-hook))
5627   (set-buffer-modified-p nil)
5628   (setq buffer-undo-list nil)
5629   (when message-generate-hashcash
5630     ;; Generate hashcash headers for recipients already known
5631     (mail-add-payment-async))
5632   (run-hooks 'message-setup-hook)
5633   ;; Do this last to give it precedence over posting styles, etc.
5634   (when (message-mail-p)
5635     (save-restriction
5636       (message-narrow-to-headers)
5637       (if message-alternative-emails
5638           (message-use-alternative-email-as-from))))
5639   (message-position-point)
5640   (undo-boundary))
5641
5642 (defun message-set-auto-save-file-name ()
5643   "Associate the message buffer with a file in the drafts directory."
5644   (when message-auto-save-directory
5645     (unless (file-directory-p
5646              (directory-file-name message-auto-save-directory))
5647       (make-directory message-auto-save-directory t))
5648     (if (gnus-alive-p)
5649         (setq message-draft-article
5650               (nndraft-request-associate-buffer "drafts"))
5651       (setq buffer-file-name (expand-file-name
5652                               (if (memq system-type
5653                                         '(ms-dos ms-windows windows-nt
5654                                                  cygwin cygwin32 win32 w32
5655                                                  mswindows))
5656                                   "message"
5657                                 "*message*")
5658                               message-auto-save-directory))
5659       (setq buffer-auto-save-file-name (make-auto-save-file-name)))
5660     (clear-visited-file-modtime)
5661     (setq buffer-file-coding-system message-draft-coding-system)))
5662
5663 (defun message-disassociate-draft ()
5664   "Disassociate the message buffer from the drafts directory."
5665   (when message-draft-article
5666     (nndraft-request-expire-articles
5667      (list message-draft-article) "drafts" nil t)))
5668
5669 (defun message-insert-headers ()
5670   "Generate the headers for the article."
5671   (interactive)
5672   (save-excursion
5673     (save-restriction
5674       (message-narrow-to-headers)
5675       (when (message-news-p)
5676         (message-generate-headers
5677          (delq 'Lines
5678                (delq 'Subject
5679                      (copy-sequence message-required-news-headers)))))
5680       (when (message-mail-p)
5681         (message-generate-headers
5682          (delq 'Lines
5683                (delq 'Subject
5684                      (copy-sequence message-required-mail-headers))))))))
5685
5686 \f
5687
5688 ;;;
5689 ;;; Commands for interfacing with message
5690 ;;;
5691
5692 ;;;###autoload
5693 (defun message-mail (&optional to subject
5694                                other-headers continue switch-function
5695                                yank-action send-actions)
5696   "Start editing a mail message to be sent.
5697 OTHER-HEADERS is an alist of header/value pairs."
5698   (interactive)
5699   (let ((message-this-is-mail t) replybuffer)
5700     (unless (message-mail-user-agent)
5701       (message-pop-to-buffer (message-buffer-name "mail" to)))
5702     ;; FIXME: message-mail should do something if YANK-ACTION is not
5703     ;; insert-buffer.
5704     (and (consp yank-action) (eq (car yank-action) 'insert-buffer)
5705          (setq replybuffer (nth 1 yank-action)))
5706     (message-setup
5707      (nconc
5708       `((To . ,(or to "")) (Subject . ,(or subject "")))
5709       (when other-headers other-headers))
5710      replybuffer send-actions)
5711     ;; FIXME: Should return nil if failure.
5712     t))
5713
5714 ;;;###autoload
5715 (defun message-news (&optional newsgroups subject)
5716   "Start editing a news article to be sent."
5717   (interactive)
5718   (let ((message-this-is-news t))
5719     (message-pop-to-buffer (message-buffer-name "posting" nil newsgroups))
5720     (message-setup `((Newsgroups . ,(or newsgroups ""))
5721                      (Subject . ,(or subject ""))))))
5722
5723 (defun message-get-reply-headers (wide &optional to-address address-headers)
5724   (let (follow-to mct never-mct to cc author mft recipients extra)
5725     ;; Find all relevant headers we need.
5726     (save-restriction
5727       (message-narrow-to-headers-or-head)
5728       ;; Gmane renames "To".  Look at "Original-To", too, if it is present in
5729       ;; message-header-synonyms.
5730       (setq to (or (message-fetch-field "to")
5731                    (and (loop for synonym in message-header-synonyms
5732                               when (memq 'Original-To synonym)
5733                               return t)
5734                         (message-fetch-field "original-to")))
5735             cc (message-fetch-field "cc")
5736             extra (when message-extra-wide-headers
5737                     (mapconcat 'identity
5738                                (mapcar 'message-fetch-field
5739                                        message-extra-wide-headers)
5740                                ", "))
5741             mct (message-fetch-field "mail-copies-to")
5742             author (or (message-fetch-field "mail-reply-to")
5743                        (message-fetch-field "reply-to")
5744                        (message-fetch-field "from")
5745                        "")
5746             mft (and message-use-mail-followup-to
5747                      (message-fetch-field "mail-followup-to"))))
5748
5749     ;; Handle special values of Mail-Copies-To.
5750     (when mct
5751       (cond ((or (equal (downcase mct) "never")
5752                  (equal (downcase mct) "nobody"))
5753              (setq never-mct t)
5754              (setq mct nil))
5755             ((or (equal (downcase mct) "always")
5756                  (equal (downcase mct) "poster"))
5757              (setq mct author))))
5758
5759     (save-match-data
5760       ;; Build (textual) list of new recipient addresses.
5761       (cond
5762        ((not wide)
5763         (setq recipients (concat ", " author)))
5764        (address-headers
5765         (dolist (header address-headers)
5766           (let ((value (message-fetch-field header)))
5767             (when value
5768               (setq recipients (concat recipients ", " value))))))
5769        ((and mft
5770              (string-match "[^ \t,]" mft)
5771              (or (not (eq message-use-mail-followup-to 'ask))
5772                  (message-y-or-n-p "Obey Mail-Followup-To? " t "\
5773 You should normally obey the Mail-Followup-To: header.  In this
5774 article, it has the value of
5775
5776 " mft "
5777
5778 which directs your response to " (if (string-match "," mft)
5779                                      "the specified addresses"
5780                                    "that address only") ".
5781
5782 Most commonly, Mail-Followup-To is used by a mailing list poster to
5783 express that responses should be sent to just the list, and not the
5784 poster as well.
5785
5786 If a message is posted to several mailing lists, Mail-Followup-To may
5787 also be used to direct the following discussion to one list only,
5788 because discussions that are spread over several lists tend to be
5789 fragmented and very difficult to follow.
5790
5791 Also, some source/announcement lists are not intended for discussion;
5792 responses here are directed to other addresses.
5793
5794 You may customize the variable `message-use-mail-followup-to', if you
5795 want to get rid of this query permanently.")))
5796         (setq recipients (concat ", " mft)))
5797        (to-address
5798         (setq recipients (concat ", " to-address))
5799         ;; If the author explicitly asked for a copy, we don't deny it to them.
5800         (if mct (setq recipients (concat recipients ", " mct))))
5801        (t
5802         (setq recipients (if never-mct "" (concat ", " author)))
5803         (if to (setq recipients (concat recipients ", " to)))
5804         (if cc (setq recipients (concat recipients ", " cc)))
5805         (if extra (setq recipients (concat recipients ", " extra)))
5806         (if mct (setq recipients (concat recipients ", " mct)))))
5807       (if (>= (length recipients) 2)
5808           ;; Strip the leading ", ".
5809           (setq recipients (substring recipients 2)))
5810       ;; Squeeze whitespace.
5811       (while (string-match "[ \t][ \t]+" recipients)
5812         (setq recipients (replace-match " " t t recipients)))
5813       ;; Remove addresses that match `rmail-dont-reply-to-names'.
5814       (let ((rmail-dont-reply-to-names message-dont-reply-to-names))
5815         (setq recipients (rmail-dont-reply-to recipients)))
5816       ;; Perhaps "Mail-Copies-To: never" removed the only address?
5817       (if (string-equal recipients "")
5818           (setq recipients author))
5819       ;; Convert string to a list of (("foo@bar" . "Name <Foo@BAR>") ...).
5820       (setq recipients
5821             (mapcar
5822              (lambda (addr)
5823                (cons (downcase (mail-strip-quoted-names addr)) addr))
5824              (message-tokenize-header recipients)))
5825       ;; Remove first duplicates.  (Why not all duplicates?  Is this a bug?)
5826       (let ((s recipients))
5827         (while s
5828           (setq recipients (delq (assoc (car (pop s)) s) recipients))))
5829
5830       ;; Remove hierarchical lists that are contained within each other,
5831       ;; if message-hierarchical-addresses is defined.
5832       (when message-hierarchical-addresses
5833         (let ((plain-addrs (mapcar 'car recipients))
5834               subaddrs recip)
5835           (while plain-addrs
5836             (setq subaddrs (assoc (car plain-addrs)
5837                                   message-hierarchical-addresses)
5838                   plain-addrs (cdr plain-addrs))
5839             (when subaddrs
5840               (setq subaddrs (cdr subaddrs))
5841               (while subaddrs
5842                 (setq recip (assoc (car subaddrs) recipients)
5843                       subaddrs (cdr subaddrs))
5844                 (if recip
5845                     (setq recipients (delq recip recipients))))))))
5846
5847       ;; Build the header alist.  Allow the user to be asked whether
5848       ;; or not to reply to all recipients in a wide reply.
5849       (setq follow-to (list (cons 'To (cdr (pop recipients)))))
5850       (when (and recipients
5851                  (or (not message-wide-reply-confirm-recipients)
5852                      (y-or-n-p "Reply to all recipients? ")))
5853         (setq recipients (mapconcat
5854                           (lambda (addr) (cdr addr)) recipients ", "))
5855         (if (string-match "^ +" recipients)
5856             (setq recipients (substring recipients (match-end 0))))
5857         (push (cons 'Cc recipients) follow-to)))
5858     follow-to))
5859
5860 ;;;###autoload
5861 (defun message-reply (&optional to-address wide)
5862   "Start editing a reply to the article in the current buffer."
5863   (interactive)
5864   (require 'gnus-sum)                   ; for gnus-list-identifiers
5865   (let ((cur (current-buffer))
5866         from subject date reply-to to cc
5867         references message-id follow-to
5868         (inhibit-point-motion-hooks t)
5869         (message-this-is-mail t)
5870         gnus-warning)
5871     (save-restriction
5872       (message-narrow-to-head-1)
5873       ;; Allow customizations to have their say.
5874       (if (not wide)
5875           ;; This is a regular reply.
5876           (when (functionp message-reply-to-function)
5877             (save-excursion
5878               (setq follow-to (funcall message-reply-to-function))))
5879         ;; This is a followup.
5880         (when (functionp message-wide-reply-to-function)
5881           (save-excursion
5882             (setq follow-to
5883                   (funcall message-wide-reply-to-function)))))
5884       (setq message-id (message-fetch-field "message-id" t)
5885             references (message-fetch-field "references")
5886             date (message-fetch-field "date")
5887             from (message-fetch-field "from")
5888             subject (or (message-fetch-field "subject") "none"))
5889       (when gnus-list-identifiers
5890         (setq subject (message-strip-list-identifiers subject)))
5891       (setq subject (concat "Re: " (message-strip-subject-re subject)))
5892       (when message-subject-trailing-was-query
5893         (setq subject (message-strip-subject-trailing-was subject)))
5894
5895       (when (and (setq gnus-warning (message-fetch-field "gnus-warning"))
5896                  (string-match "<[^>]+>" gnus-warning))
5897         (setq message-id (match-string 0 gnus-warning)))
5898
5899       (unless follow-to
5900         (setq follow-to (message-get-reply-headers wide to-address))))
5901
5902     (unless (message-mail-user-agent)
5903       (message-pop-to-buffer
5904        (message-buffer-name
5905         (if wide "wide reply" "reply") from
5906         (if wide to-address nil))))
5907
5908     (setq message-reply-headers
5909           (vector 0 subject from date message-id references 0 0 ""))
5910
5911     (message-setup
5912      `((Subject . ,subject)
5913        ,@follow-to)
5914      cur)))
5915
5916 ;;;###autoload
5917 (defun message-wide-reply (&optional to-address)
5918   "Make a \"wide\" reply to the message in the current buffer."
5919   (interactive)
5920   (message-reply to-address t))
5921
5922 ;;;###autoload
5923 (defun message-followup (&optional to-newsgroups)
5924   "Follow up to the message in the current buffer.
5925 If TO-NEWSGROUPS, use that as the new Newsgroups line."
5926   (interactive)
5927   (require 'gnus-sum)                   ; for gnus-list-identifiers
5928   (let ((cur (current-buffer))
5929         from subject date reply-to mrt mct
5930         references message-id follow-to
5931         (inhibit-point-motion-hooks t)
5932         (message-this-is-news t)
5933         followup-to distribution newsgroups gnus-warning posted-to)
5934     (save-restriction
5935       (narrow-to-region
5936        (goto-char (point-min))
5937        (if (search-forward "\n\n" nil t)
5938            (1- (point))
5939          (point-max)))
5940       (when (functionp message-followup-to-function)
5941         (setq follow-to
5942               (funcall message-followup-to-function)))
5943       (setq from (message-fetch-field "from")
5944             date (message-fetch-field "date")
5945             subject (or (message-fetch-field "subject") "none")
5946             references (message-fetch-field "references")
5947             message-id (message-fetch-field "message-id" t)
5948             followup-to (message-fetch-field "followup-to")
5949             newsgroups (message-fetch-field "newsgroups")
5950             posted-to (message-fetch-field "posted-to")
5951             reply-to (message-fetch-field "reply-to")
5952             mrt (message-fetch-field "mail-reply-to")
5953             distribution (message-fetch-field "distribution")
5954             mct (message-fetch-field "mail-copies-to"))
5955       (when (and (setq gnus-warning (message-fetch-field "gnus-warning"))
5956                  (string-match "<[^>]+>" gnus-warning))
5957         (setq message-id (match-string 0 gnus-warning)))
5958       ;; Remove bogus distribution.
5959       (when (and (stringp distribution)
5960                  (let ((case-fold-search t))
5961                    (string-match "world" distribution)))
5962         (setq distribution nil))
5963       (if gnus-list-identifiers
5964           (setq subject (message-strip-list-identifiers subject)))
5965       (setq subject (concat "Re: " (message-strip-subject-re subject)))
5966       (when message-subject-trailing-was-query
5967         (setq subject (message-strip-subject-trailing-was subject)))
5968       (widen))
5969
5970     (message-pop-to-buffer (message-buffer-name "followup" from newsgroups))
5971
5972     (setq message-reply-headers
5973           (vector 0 subject from date message-id references 0 0 ""))
5974
5975     (message-setup
5976      `((Subject . ,subject)
5977        ,@(cond
5978           (to-newsgroups
5979            (list (cons 'Newsgroups to-newsgroups)))
5980           (follow-to follow-to)
5981           ((and followup-to message-use-followup-to)
5982            (list
5983             (cond
5984              ((equal (downcase followup-to) "poster")
5985               (if (or (eq message-use-followup-to 'use)
5986                       (message-y-or-n-p "Obey Followup-To: poster? " t "\
5987 You should normally obey the Followup-To: header.
5988
5989 `Followup-To: poster' sends your response via e-mail instead of news.
5990
5991 A typical situation where `Followup-To: poster' is used is when the poster
5992 does not read the newsgroup, so he wouldn't see any replies sent to it.
5993
5994 You may customize the variable `message-use-followup-to', if you
5995 want to get rid of this query permanently."))
5996                   (progn
5997                     (setq message-this-is-news nil)
5998                     (cons 'To (or mrt reply-to from "")))
5999                 (cons 'Newsgroups newsgroups)))
6000              (t
6001               (if (or (equal followup-to newsgroups)
6002                       (not (eq message-use-followup-to 'ask))
6003                       (message-y-or-n-p
6004                        (concat "Obey Followup-To: " followup-to "? ") t "\
6005 You should normally obey the Followup-To: header.
6006
6007         `Followup-To: " followup-to "'
6008 directs your response to " (if (string-match "," followup-to)
6009                                "the specified newsgroups"
6010                              "that newsgroup only") ".
6011
6012 If a message is posted to several newsgroups, Followup-To is often
6013 used to direct the following discussion to one newsgroup only,
6014 because discussions that are spread over several newsgroup tend to
6015 be fragmented and very difficult to follow.
6016
6017 Also, some source/announcement newsgroups are not intended for discussion;
6018 responses here are directed to other newsgroups.
6019
6020 You may customize the variable `message-use-followup-to', if you
6021 want to get rid of this query permanently."))
6022                   (cons 'Newsgroups followup-to)
6023                 (cons 'Newsgroups newsgroups))))))
6024           (posted-to
6025            `((Newsgroups . ,posted-to)))
6026           (t
6027            `((Newsgroups . ,newsgroups))))
6028        ,@(and distribution (list (cons 'Distribution distribution)))
6029        ,@(when (and mct
6030                     (not (or (equal (downcase mct) "never")
6031                              (equal (downcase mct) "nobody"))))
6032            (list (cons 'Cc (if (or (equal (downcase mct) "always")
6033                                    (equal (downcase mct) "poster"))
6034                                (or mrt reply-to from "")
6035                              mct)))))
6036
6037      cur)))
6038
6039 (defun message-is-yours-p ()
6040   "Non-nil means current article is yours.
6041 If you have added 'cancel-messages to `message-shoot-gnksa-feet', all articles
6042 are yours except those that have Cancel-Lock header not belonging to you.
6043 Instead of shooting GNKSA feet, you should modify `message-alternative-emails'
6044 regexp to match all of yours addresses."
6045   ;; Canlock-logic as suggested by Per Abrahamsen
6046   ;; <abraham@dina.kvl.dk>
6047   ;;
6048   ;; IF article has cancel-lock THEN
6049   ;;   IF we can verify it THEN
6050   ;;     issue cancel
6051   ;;   ELSE
6052   ;;     error: cancellock: article is not yours
6053   ;; ELSE
6054   ;;   Use old rules, comparing sender...
6055   (save-excursion
6056     (save-restriction
6057       (message-narrow-to-head-1)
6058       (if (message-fetch-field "Cancel-Lock")
6059           (if (null (canlock-verify))
6060               t
6061             (error "Failed to verify Cancel-lock: This article is not yours"))
6062         (let (sender from)
6063           (or
6064            (message-gnksa-enable-p 'cancel-messages)
6065            (and (setq sender (message-fetch-field "sender"))
6066                 (string-equal (downcase sender)
6067                               (downcase (message-make-sender))))
6068            ;; Email address in From field equals to our address
6069            (and (setq from (message-fetch-field "from"))
6070                 (string-equal
6071                  (downcase (cadr (mail-extract-address-components from)))
6072                  (downcase (cadr (mail-extract-address-components
6073                                   (message-make-from))))))
6074            ;; Email address in From field matches
6075            ;; 'message-alternative-emails' regexp
6076            (and from
6077                 message-alternative-emails
6078                 (string-match
6079                  message-alternative-emails
6080                  (cadr (mail-extract-address-components from))))))))))
6081
6082 ;;;###autoload
6083 (defun message-cancel-news (&optional arg)
6084   "Cancel an article you posted.
6085 If ARG, allow editing of the cancellation message."
6086   (interactive "P")
6087   (unless (message-news-p)
6088     (error "This is not a news article; canceling is impossible"))
6089   (let (from newsgroups message-id distribution buf)
6090     (save-excursion
6091       ;; Get header info from original article.
6092       (save-restriction
6093         (message-narrow-to-head-1)
6094         (setq from (message-fetch-field "from")
6095               newsgroups (message-fetch-field "newsgroups")
6096               message-id (message-fetch-field "message-id" t)
6097               distribution (message-fetch-field "distribution")))
6098       ;; Make sure that this article was written by the user.
6099       (unless (message-is-yours-p)
6100         (error "This article is not yours"))
6101       (when (yes-or-no-p "Do you really want to cancel this article? ")
6102         ;; Make control message.
6103         (if arg
6104             (message-news)
6105           (setq buf (set-buffer (get-buffer-create " *message cancel*"))))
6106         (erase-buffer)
6107         (insert "Newsgroups: " newsgroups "\n"
6108                 "From: " from "\n"
6109                 "Subject: cmsg cancel " message-id "\n"
6110                 "Control: cancel " message-id "\n"
6111                 (if distribution
6112                     (concat "Distribution: " distribution "\n")
6113                   "")
6114                 mail-header-separator "\n"
6115                 message-cancel-message)
6116         (run-hooks 'message-cancel-hook)
6117         (unless arg
6118           (message "Canceling your article...")
6119           (if (let ((message-syntax-checks
6120                      'dont-check-for-anything-just-trust-me))
6121                 (funcall message-send-news-function))
6122               (message "Canceling your article...done"))
6123           (kill-buffer buf))))))
6124
6125 ;;;###autoload
6126 (defun message-supersede ()
6127   "Start composing a message to supersede the current message.
6128 This is done simply by taking the old article and adding a Supersedes
6129 header line with the old Message-ID."
6130   (interactive)
6131   (let ((cur (current-buffer)))
6132     ;; Check whether the user owns the article that is to be superseded.
6133     (unless (message-is-yours-p)
6134       (error "This article is not yours"))
6135     ;; Get a normal message buffer.
6136     (message-pop-to-buffer (message-buffer-name "supersede"))
6137     (insert-buffer-substring cur)
6138     (mime-to-mml)
6139     (message-narrow-to-head-1)
6140     ;; Remove unwanted headers.
6141     (when message-ignored-supersedes-headers
6142       (message-remove-header message-ignored-supersedes-headers t))
6143     (goto-char (point-min))
6144     (if (not (re-search-forward "^Message-ID: " nil t))
6145         (error "No Message-ID in this article")
6146       (replace-match "Supersedes: " t t))
6147     (goto-char (point-max))
6148     (insert mail-header-separator)
6149     (widen)
6150     (forward-line 1)))
6151
6152 ;;;###autoload
6153 (defun message-recover ()
6154   "Reread contents of current buffer from its last auto-save file."
6155   (interactive)
6156   (let ((file-name (make-auto-save-file-name)))
6157     (cond ((save-window-excursion
6158              (if (not (eq system-type 'vax-vms))
6159                  (with-output-to-temp-buffer "*Directory*"
6160                    (with-current-buffer standard-output
6161                      (fundamental-mode)) ; for Emacs 20.4+
6162                    (buffer-disable-undo standard-output)
6163                    (let ((default-directory "/"))
6164                      (call-process
6165                       "ls" nil standard-output nil "-l" file-name))))
6166              (yes-or-no-p (format "Recover auto save file %s? " file-name)))
6167            (let ((buffer-read-only nil))
6168              (erase-buffer)
6169              (insert-file-contents file-name nil)))
6170           (t (error "message-recover cancelled")))))
6171
6172 ;;; Washing Subject:
6173
6174 (defun message-wash-subject (subject)
6175   "Remove junk like \"Re:\", \"(fwd)\", etc. added to subject string SUBJECT.
6176 Previous forwarders, replyers, etc. may add it."
6177   (with-temp-buffer
6178     (insert subject)
6179     (goto-char (point-min))
6180     ;; strip Re/Fwd stuff off the beginning
6181     (while (re-search-forward
6182             "\\([Rr][Ee]:\\|[Ff][Ww][Dd]\\(\\[[0-9]*\\]\\)?:\\|[Ff][Ww]:\\)" nil t)
6183       (replace-match ""))
6184
6185     ;; and gnus-style forwards [foo@bar.com] subject
6186     (goto-char (point-min))
6187     (while (re-search-forward "\\[[^ \t]*\\(@\\|\\.\\)[^ \t]*\\]" nil t)
6188       (replace-match ""))
6189
6190     ;; and off the end
6191     (goto-char (point-max))
6192     (while (re-search-backward "([Ff][Ww][Dd])" nil t)
6193       (replace-match ""))
6194
6195     ;; and finally, any whitespace that was left-over
6196     (goto-char (point-min))
6197     (while (re-search-forward "^[ \t]+" nil t)
6198       (replace-match ""))
6199     (goto-char (point-max))
6200     (while (re-search-backward "[ \t]+$" nil t)
6201       (replace-match ""))
6202
6203     (buffer-string)))
6204
6205 ;;; Forwarding messages.
6206
6207 (defvar message-forward-decoded-p nil
6208   "Non-nil means the original message is decoded.")
6209
6210 (defun message-forward-subject-name-subject (subject)
6211   "Generate a SUBJECT for a forwarded message.
6212 The form is: [Source] Subject, where if the original message was mail,
6213 Source is the name of the sender, and if the original message was
6214 news, Source is the list of newsgroups is was posted to."
6215   (let* ((group (message-fetch-field "newsgroups"))
6216          (from (message-fetch-field "from"))
6217          (prefix
6218           (if group
6219               (gnus-group-decoded-name group)
6220             (or (and from (car (gnus-extract-address-components from)))
6221                 "(nowhere)"))))
6222     (concat "["
6223             (if message-forward-decoded-p
6224                 prefix
6225               (mail-decode-encoded-word-string prefix))
6226             "] " subject)))
6227
6228 (defun message-forward-subject-author-subject (subject)
6229   "Generate a SUBJECT for a forwarded message.
6230 The form is: [Source] Subject, where if the original message was mail,
6231 Source is the sender, and if the original message was news, Source is
6232 the list of newsgroups is was posted to."
6233   (let* ((group (message-fetch-field "newsgroups"))
6234          (prefix
6235           (if group
6236               (gnus-group-decoded-name group)
6237             (or (message-fetch-field "from")
6238                 "(nowhere)"))))
6239     (concat "["
6240             (if message-forward-decoded-p
6241                 prefix
6242               (mail-decode-encoded-word-string prefix))
6243             "] " subject)))
6244
6245 (defun message-forward-subject-fwd (subject)
6246   "Generate a SUBJECT for a forwarded message.
6247 The form is: Fwd: Subject, where Subject is the original subject of
6248 the message."
6249   (if (string-match "^Fwd: " subject)
6250       subject
6251     (concat "Fwd: " subject)))
6252
6253 (defun message-make-forward-subject ()
6254   "Return a Subject header suitable for the message in the current buffer."
6255   (save-excursion
6256     (save-restriction
6257       (message-narrow-to-head-1)
6258       (let ((funcs message-make-forward-subject-function)
6259             (subject (message-fetch-field "Subject")))
6260         (setq subject
6261               (if subject
6262                   (if message-forward-decoded-p
6263                       subject
6264                     (mail-decode-encoded-word-string subject))
6265                 ""))
6266         (when message-wash-forwarded-subjects
6267           (setq subject (message-wash-subject subject)))
6268         ;; Make sure funcs is a list.
6269         (and funcs
6270              (not (listp funcs))
6271              (setq funcs (list funcs)))
6272         ;; Apply funcs in order, passing subject generated by previous
6273         ;; func to the next one.
6274         (dolist (func funcs)
6275           (when (functionp func)
6276             (setq subject (funcall func subject))))
6277         subject))))
6278
6279 (eval-when-compile
6280   (defvar gnus-article-decoded-p))
6281
6282
6283 ;;;###autoload
6284 (defun message-forward (&optional news digest)
6285   "Forward the current message via mail.
6286 Optional NEWS will use news to forward instead of mail.
6287 Optional DIGEST will use digest to forward."
6288   (interactive "P")
6289   (let* ((cur (current-buffer))
6290          (message-forward-decoded-p
6291           (if (local-variable-p 'gnus-article-decoded-p (current-buffer))
6292               gnus-article-decoded-p ;; In an article buffer.
6293             message-forward-decoded-p))
6294          (subject (message-make-forward-subject)))
6295     (if news
6296         (message-news nil subject)
6297       (message-mail nil subject))
6298     (message-forward-make-body cur digest)))
6299
6300 (defun message-forward-make-body-plain (forward-buffer)
6301   (insert
6302    "\n-------------------- Start of forwarded message --------------------\n")
6303   (let ((b (point)) e)
6304     (insert
6305      (with-temp-buffer
6306        (mm-disable-multibyte)
6307        (insert
6308         (with-current-buffer forward-buffer
6309           (mm-with-unibyte-current-buffer (buffer-string))))
6310        (mm-enable-multibyte)
6311        (mime-to-mml)
6312        (goto-char (point-min))
6313        (when (looking-at "From ")
6314          (replace-match "X-From-Line: "))
6315        (buffer-string)))
6316     (setq e (point))
6317     (insert
6318      "\n-------------------- End of forwarded message --------------------\n")
6319     (when message-forward-ignored-headers
6320       (save-restriction
6321         (narrow-to-region b e)
6322         (goto-char b)
6323         (narrow-to-region (point)
6324                           (or (search-forward "\n\n" nil t) (point)))
6325         (message-remove-header message-forward-ignored-headers t)))))
6326
6327 (defun message-forward-make-body-mime (forward-buffer)
6328   (insert "\n\n<#part type=message/rfc822 disposition=inline raw=t>\n")
6329   (let ((b (point)) e)
6330     (save-restriction
6331       (narrow-to-region (point) (point))
6332       (mml-insert-buffer forward-buffer)
6333       (goto-char (point-min))
6334       (when (looking-at "From ")
6335         (replace-match "X-From-Line: "))
6336       (goto-char (point-max)))
6337     (setq e (point))
6338     (insert "<#/part>\n")))
6339
6340 (defun message-forward-make-body-mml (forward-buffer)
6341   (insert "\n\n<#mml type=message/rfc822 disposition=inline>\n")
6342   (let ((b (point)) e)
6343     (if (not message-forward-decoded-p)
6344         (insert
6345          (with-temp-buffer
6346            (mm-disable-multibyte)
6347            (insert
6348             (with-current-buffer forward-buffer
6349               (mm-with-unibyte-current-buffer (buffer-string))))
6350            (mm-enable-multibyte)
6351            (mime-to-mml)
6352            (goto-char (point-min))
6353            (when (looking-at "From ")
6354              (replace-match "X-From-Line: "))
6355            (buffer-string)))
6356       (save-restriction
6357         (narrow-to-region (point) (point))
6358         (mml-insert-buffer forward-buffer)
6359         (goto-char (point-min))
6360         (when (looking-at "From ")
6361           (replace-match "X-From-Line: "))
6362         (goto-char (point-max))))
6363     (setq e (point))
6364     (insert "<#/mml>\n")
6365     (when (and (not message-forward-decoded-p)
6366                message-forward-ignored-headers)
6367       (save-restriction
6368         (narrow-to-region b e)
6369         (goto-char b)
6370         (narrow-to-region (point)
6371                           (or (search-forward "\n\n" nil t) (point)))
6372         (message-remove-header message-forward-ignored-headers t)))))
6373
6374 (defun message-forward-make-body-digest-plain (forward-buffer)
6375   (insert
6376    "\n-------------------- Start of forwarded message --------------------\n")
6377   (let ((b (point)) e)
6378     (mml-insert-buffer forward-buffer)
6379     (setq e (point))
6380     (insert
6381      "\n-------------------- End of forwarded message --------------------\n")))
6382
6383 (defun message-forward-make-body-digest-mime (forward-buffer)
6384   (insert "\n<#multipart type=digest>\n")
6385   (let ((b (point)) e)
6386     (insert-buffer-substring forward-buffer)
6387     (setq e (point))
6388     (insert "<#/multipart>\n")
6389     (save-restriction
6390       (narrow-to-region b e)
6391       (goto-char b)
6392       (narrow-to-region (point)
6393                         (or (search-forward "\n\n" nil t) (point)))
6394       (delete-region (point-min) (point-max)))))
6395
6396 (defun message-forward-make-body-digest (forward-buffer)
6397   (if message-forward-as-mime
6398       (message-forward-make-body-digest-mime forward-buffer)
6399     (message-forward-make-body-digest-plain forward-buffer)))
6400
6401 ;;;###autoload
6402 (defun message-forward-make-body (forward-buffer &optional digest)
6403   ;; Put point where we want it before inserting the forwarded
6404   ;; message.
6405   (if message-forward-before-signature
6406       (message-goto-body)
6407     (goto-char (point-max)))
6408   (if digest
6409       (message-forward-make-body-digest forward-buffer)
6410     (if message-forward-as-mime
6411         (if (and message-forward-show-mml
6412                  (not (and (eq message-forward-show-mml 'best)
6413                            (with-current-buffer forward-buffer
6414                              (goto-char (point-min))
6415                              (re-search-forward
6416                               "Content-Type: *multipart/\\(signed\\|encrypted\\)"
6417                               nil t)))))
6418             (message-forward-make-body-mml forward-buffer)
6419           (message-forward-make-body-mime forward-buffer))
6420       (message-forward-make-body-plain forward-buffer)))
6421   (message-position-point))
6422
6423 ;;;###autoload
6424 (defun message-forward-rmail-make-body (forward-buffer)
6425   (save-window-excursion
6426     (set-buffer forward-buffer)
6427     (if (rmail-msg-is-pruned)
6428         (rmail-msg-restore-non-pruned-header)))
6429   (message-forward-make-body forward-buffer))
6430
6431 (eval-when-compile (defvar rmail-enable-mime-composing))
6432
6433 ;; Fixme: Should have defcustom.
6434 ;;;###autoload
6435 (defun message-insinuate-rmail ()
6436   "Let RMAIL use message to forward."
6437   (interactive)
6438   (setq rmail-enable-mime-composing t)
6439   (setq rmail-insert-mime-forwarded-message-function
6440         'message-forward-rmail-make-body))
6441
6442 ;;;###autoload
6443 (defun message-resend (address)
6444   "Resend the current article to ADDRESS."
6445   (interactive
6446    (list (message-read-from-minibuffer "Resend message to: ")))
6447   (message "Resending message to %s..." address)
6448   (save-excursion
6449     (let ((cur (current-buffer))
6450           beg)
6451       ;; We first set up a normal mail buffer.
6452       (unless (message-mail-user-agent)
6453         (set-buffer (get-buffer-create " *message resend*"))
6454         (erase-buffer))
6455       (let ((message-this-is-mail t)
6456             message-setup-hook)
6457         (message-setup `((To . ,address))))
6458       ;; Insert our usual headers.
6459       (message-generate-headers '(From Date To Message-ID))
6460       (message-narrow-to-headers)
6461       ;; Remove X-Draft-From header etc.
6462       (message-remove-header message-ignored-mail-headers t)
6463       ;; Rename them all to "Resent-*".
6464       (goto-char (point-min))
6465       (while (re-search-forward "^[A-Za-z]" nil t)
6466         (forward-char -1)
6467         (insert "Resent-"))
6468       (widen)
6469       (forward-line)
6470       (delete-region (point) (point-max))
6471       (setq beg (point))
6472       ;; Insert the message to be resent.
6473       (insert-buffer-substring cur)
6474       (goto-char (point-min))
6475       (search-forward "\n\n")
6476       (forward-char -1)
6477       (save-restriction
6478         (narrow-to-region beg (point))
6479         (message-remove-header message-ignored-resent-headers t)
6480         (goto-char (point-max)))
6481       (insert mail-header-separator)
6482       ;; Rename all old ("Also-")Resent headers.
6483       (while (re-search-backward "^\\(Also-\\)*Resent-" beg t)
6484         (beginning-of-line)
6485         (insert "Also-"))
6486       ;; Quote any "From " lines at the beginning.
6487       (goto-char beg)
6488       (when (looking-at "From ")
6489         (replace-match "X-From-Line: "))
6490       ;; Send it.
6491       (let ((message-inhibit-body-encoding t)
6492             message-required-mail-headers
6493             rfc2047-encode-encoded-words)
6494         (message-send-mail))
6495       (kill-buffer (current-buffer)))
6496     (message "Resending message to %s...done" address)))
6497
6498 ;;;###autoload
6499 (defun message-bounce ()
6500   "Re-mail the current message.
6501 This only makes sense if the current message is a bounce message that
6502 contains some mail you have written which has been bounced back to
6503 you."
6504   (interactive)
6505   (let ((handles (mm-dissect-buffer t))
6506         boundary)
6507     (message-pop-to-buffer (message-buffer-name "bounce"))
6508     (if (stringp (car handles))
6509         ;; This is a MIME bounce.
6510         (mm-insert-part (car (last handles)))
6511       ;; This is a non-MIME bounce, so we try to remove things
6512       ;; manually.
6513       (mm-insert-part handles)
6514       (undo-boundary)
6515       (goto-char (point-min))
6516       (re-search-forward "\n\n+" nil t)
6517       (setq boundary (point))
6518       ;; We remove everything before the bounced mail.
6519       (if (or (re-search-forward message-unsent-separator nil t)
6520               (progn
6521                 (search-forward "\n\n" nil 'move)
6522                 (re-search-backward "^Return-Path:.*\n" boundary t)))
6523           (progn
6524             (forward-line 1)
6525             (delete-region (point-min)
6526                            (if (re-search-forward "^[^ \n\t]+:" nil t)
6527                                (match-beginning 0)
6528                              (point))))
6529         (goto-char boundary)
6530         (when (re-search-backward "^.?From .*\n" nil t)
6531           (delete-region (match-beginning 0) (match-end 0)))))
6532     (mm-enable-multibyte)
6533     (save-restriction
6534       (message-narrow-to-head-1)
6535       (message-remove-header message-ignored-bounced-headers t)
6536       (goto-char (point-max))
6537       (insert mail-header-separator))
6538     (message-position-point)))
6539
6540 ;;;
6541 ;;; Interactive entry points for new message buffers.
6542 ;;;
6543
6544 ;;;###autoload
6545 (defun message-mail-other-window (&optional to subject)
6546   "Like `message-mail' command, but display mail buffer in another window."
6547   (interactive)
6548   (unless (message-mail-user-agent)
6549     (let ((pop-up-windows t)
6550           (special-display-buffer-names nil)
6551           (special-display-regexps nil)
6552           (same-window-buffer-names nil)
6553           (same-window-regexps nil))
6554       (message-pop-to-buffer (message-buffer-name "mail" to))))
6555   (let ((message-this-is-mail t))
6556     (message-setup `((To . ,(or to "")) (Subject . ,(or subject "")))
6557                    nil nil 'switch-to-buffer-other-window)))
6558
6559 ;;;###autoload
6560 (defun message-mail-other-frame (&optional to subject)
6561   "Like `message-mail' command, but display mail buffer in another frame."
6562   (interactive)
6563   (unless (message-mail-user-agent)
6564     (let ((pop-up-frames t)
6565           (special-display-buffer-names nil)
6566           (special-display-regexps nil)
6567           (same-window-buffer-names nil)
6568           (same-window-regexps nil))
6569       (message-pop-to-buffer (message-buffer-name "mail" to))))
6570   (let ((message-this-is-mail t))
6571     (message-setup `((To . ,(or to "")) (Subject . ,(or subject "")))
6572                    nil nil 'switch-to-buffer-other-frame)))
6573
6574 ;;;###autoload
6575 (defun message-news-other-window (&optional newsgroups subject)
6576   "Start editing a news article to be sent."
6577   (interactive)
6578   (let ((pop-up-windows t)
6579         (special-display-buffer-names nil)
6580         (special-display-regexps nil)
6581         (same-window-buffer-names nil)
6582         (same-window-regexps nil))
6583     (message-pop-to-buffer (message-buffer-name "posting" nil newsgroups)))
6584   (let ((message-this-is-news t))
6585     (message-setup `((Newsgroups . ,(or newsgroups ""))
6586                      (Subject . ,(or subject ""))))))
6587
6588 ;;;###autoload
6589 (defun message-news-other-frame (&optional newsgroups subject)
6590   "Start editing a news article to be sent."
6591   (interactive)
6592   (let ((pop-up-frames t)
6593         (special-display-buffer-names nil)
6594         (special-display-regexps nil)
6595         (same-window-buffer-names nil)
6596         (same-window-regexps nil))
6597     (message-pop-to-buffer (message-buffer-name "posting" nil newsgroups)))
6598   (let ((message-this-is-news t))
6599     (message-setup `((Newsgroups . ,(or newsgroups ""))
6600                      (Subject . ,(or subject ""))))))
6601
6602 ;;; underline.el
6603
6604 ;; This code should be moved to underline.el (from which it is stolen).
6605
6606 ;;;###autoload
6607 (defun bold-region (start end)
6608   "Bold all nonblank characters in the region.
6609 Works by overstriking characters.
6610 Called from program, takes two arguments START and END
6611 which specify the range to operate on."
6612   (interactive "r")
6613   (save-excursion
6614     (let ((end1 (make-marker)))
6615       (move-marker end1 (max start end))
6616       (goto-char (min start end))
6617       (while (< (point) end1)
6618         (or (looking-at "[_\^@- ]")
6619             (insert (char-after) "\b"))
6620         (forward-char 1)))))
6621
6622 ;;;###autoload
6623 (defun unbold-region (start end)
6624   "Remove all boldness (overstruck characters) in the region.
6625 Called from program, takes two arguments START and END
6626 which specify the range to operate on."
6627   (interactive "r")
6628   (save-excursion
6629     (let ((end1 (make-marker)))
6630       (move-marker end1 (max start end))
6631       (goto-char (min start end))
6632       (while (search-forward "\b" end1 t)
6633         (if (eq (char-after) (char-after (- (point) 2)))
6634             (delete-char -2))))))
6635
6636 (defun message-exchange-point-and-mark ()
6637   "Exchange point and mark, but don't activate region if it was inactive."
6638   (unless (prog1
6639               (message-mark-active-p)
6640             (exchange-point-and-mark))
6641     (setq mark-active nil)))
6642
6643 (defalias 'message-make-overlay 'make-overlay)
6644 (defalias 'message-delete-overlay 'delete-overlay)
6645 (defalias 'message-overlay-put 'overlay-put)
6646 (defun message-kill-all-overlays ()
6647   (if (featurep 'xemacs)
6648       (map-extents (lambda (extent ignore) (delete-extent extent)))
6649     (mapcar #'delete-overlay (overlays-in (point-min) (point-max)))))
6650
6651 ;; Support for toolbar
6652 (eval-when-compile
6653   (defvar tool-bar-map)
6654   (defvar tool-bar-mode))
6655
6656 (defun message-tool-bar-local-item-from-menu (command icon in-map &optional from-map &rest props)
6657   ;; We need to make tool bar entries in local keymaps with
6658   ;; `tool-bar-local-item-from-menu' in Emacs > 21.3
6659   (if (fboundp 'tool-bar-local-item-from-menu)
6660       ;; This is for Emacs 21.3
6661       (tool-bar-local-item-from-menu command icon in-map from-map props)
6662     (tool-bar-add-item-from-menu command icon from-map props)))
6663
6664 (defun message-tool-bar-map ()
6665   (or message-tool-bar-map
6666       (setq message-tool-bar-map
6667             (and
6668              (condition-case nil (require 'tool-bar) (error nil))
6669              (fboundp 'tool-bar-add-item-from-menu)
6670              tool-bar-mode
6671              (let ((tool-bar-map (copy-keymap tool-bar-map))
6672                    (load-path (mm-image-load-path)))
6673                ;; Zap some items which aren't so relevant and take
6674                ;; up space.
6675                (dolist (key '(print-buffer kill-buffer save-buffer
6676                                            write-file dired open-file))
6677                  (define-key tool-bar-map (vector key) nil))
6678                (message-tool-bar-local-item-from-menu
6679                 'message-send-and-exit "mail_send" tool-bar-map message-mode-map)
6680                (message-tool-bar-local-item-from-menu
6681                 'message-kill-buffer "close" tool-bar-map message-mode-map)
6682                (message-tool-bar-local-item-from-menu
6683                     'message-dont-send "cancel" tool-bar-map message-mode-map)
6684                (message-tool-bar-local-item-from-menu
6685                 'mml-attach-file "attach" tool-bar-map mml-mode-map)
6686                (message-tool-bar-local-item-from-menu
6687                 'ispell-message "spell" tool-bar-map message-mode-map)
6688                (message-tool-bar-local-item-from-menu
6689                 'mml-preview "preview"
6690                 tool-bar-map mml-mode-map)
6691                (message-tool-bar-local-item-from-menu
6692                 'message-insert-importance-high "important"
6693                 tool-bar-map message-mode-map)
6694                (message-tool-bar-local-item-from-menu
6695                 'message-insert-importance-low "unimportant"
6696                 tool-bar-map message-mode-map)
6697                (message-tool-bar-local-item-from-menu
6698                 'message-insert-disposition-notification-to "receipt"
6699                 tool-bar-map message-mode-map)
6700                tool-bar-map)))))
6701
6702 ;;; Group name completion.
6703
6704 (defcustom message-newgroups-header-regexp
6705   "^\\(Newsgroups\\|Followup-To\\|Posted-To\\|Gcc\\):"
6706   "Regexp that match headers that lists groups."
6707   :group 'message
6708   :type 'regexp)
6709
6710 (defcustom message-completion-alist
6711   (list (cons message-newgroups-header-regexp 'message-expand-group)
6712         '("^\\(Resent-\\)?\\(To\\|B?Cc\\):" . message-expand-name)
6713         '("^\\(Reply-To\\|From\\|Mail-Followup-To\\|Mail-Copies-To\\):"
6714           . message-expand-name)
6715         '("^\\(Disposition-Notification-To\\|Return-Receipt-To\\):"
6716           . message-expand-name))
6717   "Alist of (RE . FUN).  Use FUN for completion on header lines matching RE."
6718   :version "22.1"
6719   :group 'message
6720   :type '(alist :key-type regexp :value-type function))
6721
6722 (defcustom message-expand-name-databases
6723   (list 'bbdb 'eudc)
6724   "List of databases to try for name completion (`message-expand-name').
6725 Each element is a symbol and can be `bbdb' or `eudc'."
6726   :group 'message
6727   :type '(set (const bbdb) (const eudc)))
6728
6729 (defcustom message-tab-body-function nil
6730   "*Function to execute when `message-tab' (TAB) is executed in the body.
6731 If nil, the function bound in `text-mode-map' or `global-map' is executed."
6732   :version "22.1"
6733   :group 'message
6734   :link '(custom-manual "(message)Various Commands")
6735   :type '(choice (const nil)
6736                  function))
6737
6738 (defun message-tab ()
6739   "Complete names according to `message-completion-alist'.
6740 Execute function specified by `message-tab-body-function' when not in
6741 those headers."
6742   (interactive)
6743   (let ((alist message-completion-alist))
6744     (while (and alist
6745                 (let ((mail-abbrev-mode-regexp (caar alist)))
6746                   (not (mail-abbrev-in-expansion-header-p))))
6747       (setq alist (cdr alist)))
6748     (funcall (or (cdar alist) message-tab-body-function
6749                  (lookup-key text-mode-map "\t")
6750                  (lookup-key global-map "\t")
6751                  'indent-relative))))
6752
6753 (defun message-expand-group ()
6754   "Expand the group name under point."
6755   (let* ((b (save-excursion
6756               (save-restriction
6757                 (narrow-to-region
6758                  (save-excursion
6759                    (beginning-of-line)
6760                    (skip-chars-forward "^:")
6761                    (1+ (point)))
6762                  (point))
6763                 (skip-chars-backward "^, \t\n") (point))))
6764          (completion-ignore-case t)
6765          (string (buffer-substring b (progn (skip-chars-forward "^,\t\n ")
6766                                             (point))))
6767          (hashtb (and (boundp 'gnus-active-hashtb) gnus-active-hashtb))
6768          (completions (all-completions string hashtb))
6769          comp)
6770     (delete-region b (point))
6771     (cond
6772      ((= (length completions) 1)
6773       (if (string= (car completions) string)
6774           (progn
6775             (insert string)
6776             (message "Only matching group"))
6777         (insert (car completions))))
6778      ((and (setq comp (try-completion string hashtb))
6779            (not (string= comp string)))
6780       (insert comp))
6781      (t
6782       (insert string)
6783       (if (not comp)
6784           (message "No matching groups")
6785         (save-selected-window
6786           (pop-to-buffer "*Completions*")
6787           (buffer-disable-undo)
6788           (let ((buffer-read-only nil))
6789             (erase-buffer)
6790             (let ((standard-output (current-buffer)))
6791               (display-completion-list (sort completions 'string<)))
6792             (goto-char (point-min))
6793             (delete-region (point) (progn (forward-line 3) (point))))))))))
6794
6795 (defun message-expand-name ()
6796   (cond ((and (memq 'eudc message-expand-name-databases)
6797                     (boundp 'eudc-protocol)
6798                     eudc-protocol)
6799          (eudc-expand-inline))
6800         ((and (memq 'bbdb message-expand-name-databases)
6801               (fboundp 'bbdb-complete-name))
6802          (bbdb-complete-name))
6803         (t
6804          (expand-abbrev))))
6805
6806 ;;; Help stuff.
6807
6808 (defun message-talkative-question (ask question show &rest text)
6809   "Call FUNCTION with argument QUESTION; optionally display TEXT... args.
6810 If SHOW is non-nil, the arguments TEXT... are displayed in a temp buffer.
6811 The following arguments may contain lists of values."
6812   (if (and show
6813            (setq text (message-flatten-list text)))
6814       (save-window-excursion
6815         (save-excursion
6816           (with-output-to-temp-buffer " *MESSAGE information message*"
6817             (set-buffer " *MESSAGE information message*")
6818             (fundamental-mode)          ; for Emacs 20.4+
6819             (mapcar 'princ text)
6820             (goto-char (point-min))))
6821         (funcall ask question))
6822     (funcall ask question)))
6823
6824 (defun message-flatten-list (list)
6825   "Return a new, flat list that contains all elements of LIST.
6826
6827 \(message-flatten-list '(1 (2 3 (4 5 (6))) 7))
6828 => (1 2 3 4 5 6 7)"
6829   (cond ((consp list)
6830          (apply 'append (mapcar 'message-flatten-list list)))
6831         (list
6832          (list list))))
6833
6834 (defun message-generate-new-buffer-clone-locals (name &optional varstr)
6835   "Create and return a buffer with name based on NAME using `generate-new-buffer'.
6836 Then clone the local variables and values from the old buffer to the
6837 new one, cloning only the locals having a substring matching the
6838 regexp VARSTR."
6839   (let ((oldbuf (current-buffer)))
6840     (save-excursion
6841       (set-buffer (generate-new-buffer name))
6842       (message-clone-locals oldbuf varstr)
6843       (current-buffer))))
6844
6845 (defun message-clone-locals (buffer &optional varstr)
6846   "Clone the local variables from BUFFER to the current buffer."
6847   (let ((locals (save-excursion
6848                   (set-buffer buffer)
6849                   (buffer-local-variables)))
6850         (regexp "^gnus\\|^nn\\|^message\\|^sendmail\\|^smtp\\|^user-mail-address"))
6851     (mapcar
6852      (lambda (local)
6853        (when (and (consp local)
6854                   (car local)
6855                   (string-match regexp (symbol-name (car local)))
6856                   (or (null varstr)
6857                       (string-match varstr (symbol-name (car local)))))
6858          (ignore-errors
6859            (set (make-local-variable (car local))
6860                 (cdr local)))))
6861      locals)))
6862
6863 ;;;
6864 ;;; MIME functions
6865 ;;;
6866
6867 (defvar message-inhibit-body-encoding nil)
6868
6869 (defun message-encode-message-body ()
6870   (unless message-inhibit-body-encoding
6871     (let ((mail-parse-charset (or mail-parse-charset
6872                                   message-default-charset))
6873           (case-fold-search t)
6874           lines content-type-p)
6875       (message-goto-body)
6876       (save-restriction
6877         (narrow-to-region (point) (point-max))
6878         (let ((new (mml-generate-mime)))
6879           (when new
6880             (delete-region (point-min) (point-max))
6881             (insert new)
6882             (goto-char (point-min))
6883             (if (eq (aref new 0) ?\n)
6884                 (delete-char 1)
6885               (search-forward "\n\n")
6886               (setq lines (buffer-substring (point-min) (1- (point))))
6887               (delete-region (point-min) (point))))))
6888       (save-restriction
6889         (message-narrow-to-headers-or-head)
6890         (message-remove-header "Mime-Version")
6891         (goto-char (point-max))
6892         (insert "MIME-Version: 1.0\n")
6893         (when lines
6894           (insert lines))
6895         (setq content-type-p
6896               (or mml-boundary
6897                   (re-search-backward "^Content-Type:" nil t))))
6898       (save-restriction
6899         (message-narrow-to-headers-or-head)
6900         (message-remove-first-header "Content-Type")
6901         (message-remove-first-header "Content-Transfer-Encoding"))
6902       ;; We always make sure that the message has a Content-Type
6903       ;; header.  This is because some broken MTAs and MUAs get
6904       ;; awfully confused when confronted with a message with a
6905       ;; MIME-Version header and without a Content-Type header.  For
6906       ;; instance, Solaris' /usr/bin/mail.
6907       (unless content-type-p
6908         (goto-char (point-min))
6909         ;; For unknown reason, MIME-Version doesn't exist.
6910         (when (re-search-forward "^MIME-Version:" nil t)
6911           (forward-line 1)
6912           (insert "Content-Type: text/plain; charset=us-ascii\n"))))))
6913
6914 (defun message-read-from-minibuffer (prompt &optional initial-contents)
6915   "Read from the minibuffer while providing abbrev expansion."
6916   (if (fboundp 'mail-abbrevs-setup)
6917       (let ((mail-abbrev-mode-regexp "")
6918             (minibuffer-setup-hook 'mail-abbrevs-setup)
6919             (minibuffer-local-map message-minibuffer-local-map))
6920         (read-from-minibuffer prompt initial-contents))
6921     (let ((minibuffer-setup-hook 'mail-abbrev-minibuffer-setup-hook)
6922           (minibuffer-local-map message-minibuffer-local-map))
6923       (read-string prompt initial-contents))))
6924
6925 (defun message-use-alternative-email-as-from ()
6926   "Set From field of the outgoing message to the first matching
6927 address in `message-alternative-emails', looking at To, Cc and
6928 From headers in the original article."
6929   (require 'mail-utils)
6930   (let* ((fields '("To" "Cc" "From"))
6931          (emails
6932           (split-string
6933            (mail-strip-quoted-names
6934             (mapconcat 'message-fetch-reply-field fields ","))
6935            "[ \f\t\n\r\v,]+"))
6936          email)
6937     (while emails
6938       (if (string-match message-alternative-emails (car emails))
6939           (setq email (car emails)
6940                 emails nil))
6941       (pop emails))
6942     (unless (or (not email) (equal email user-mail-address))
6943       (message-remove-header "From")
6944       (goto-char (point-max))
6945       (insert "From: " (let ((user-mail-address email)) (message-make-from))
6946               "\n"))))
6947
6948 (defun message-options-get (symbol)
6949   (cdr (assq symbol message-options)))
6950
6951 (defun message-options-set (symbol value)
6952   (let ((the-cons (assq symbol message-options)))
6953     (if the-cons
6954         (if value
6955             (setcdr the-cons value)
6956           (setq message-options (delq the-cons message-options)))
6957       (and value
6958            (push (cons symbol value) message-options))))
6959   value)
6960
6961 (defun message-options-set-recipient ()
6962   (save-restriction
6963     (message-narrow-to-headers-or-head)
6964     (message-options-set 'message-sender
6965                          (mail-strip-quoted-names
6966                           (message-fetch-field "from")))
6967     (message-options-set 'message-recipients
6968                          (mail-strip-quoted-names
6969                           (let ((to (message-fetch-field "to"))
6970                                 (cc (message-fetch-field "cc"))
6971                                 (bcc (message-fetch-field "bcc")))
6972                             (concat
6973                              (or to "")
6974                              (if (and to cc) ", ")
6975                              (or cc "")
6976                              (if (and (or to cc) bcc) ", ")
6977                              (or bcc "")))))))
6978
6979 (defun message-hide-headers ()
6980   "Hide headers based on the `message-hidden-headers' variable."
6981   (let ((regexps (if (stringp message-hidden-headers)
6982                      (list message-hidden-headers)
6983                    message-hidden-headers))
6984         (inhibit-point-motion-hooks t)
6985         (after-change-functions nil)
6986         (end-of-headers 0))
6987     (when regexps
6988       (save-excursion
6989         (save-restriction
6990           (message-narrow-to-headers)
6991           (goto-char (point-min))
6992           (while (not (eobp))
6993             (if (not (message-hide-header-p regexps))
6994                 (message-next-header)
6995               (let ((begin (point))
6996                     header header-len)
6997                 (message-next-header)
6998                 (setq header (buffer-substring begin (point))
6999                       header-len (- (point) begin))
7000                 (delete-region begin (point))
7001                 (goto-char (1+ end-of-headers))
7002                 (insert header)
7003                 (setq end-of-headers
7004                       (+ end-of-headers header-len))))))))
7005     (narrow-to-region (1+ end-of-headers) (point-max))))
7006
7007 (defun message-hide-header-p (regexps)
7008   (let ((result nil)
7009         (reverse nil))
7010     (when (eq (car regexps) 'not)
7011       (setq reverse t)
7012       (pop regexps))
7013     (dolist (regexp regexps)
7014       (setq result (or result (looking-at regexp))))
7015     (if reverse
7016         (not result)
7017       result)))
7018
7019 (when (featurep 'xemacs)
7020   (require 'messagexmas)
7021   (message-xmas-redefine))
7022
7023 (provide 'message)
7024
7025 (run-hooks 'message-load-hook)
7026
7027 ;; Local Variables:
7028 ;; coding: iso-8859-1
7029 ;; End:
7030
7031 ;; arch-tag: 94b32cac-4504-4b6c-8181-030ebf380ee0
7032 ;;; message.el ends here