2005-10-04 Reiner Steib <Reiner.Steib@gmx.de>
[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 . message-bold-region)
1371     (underline . underline-region)
1372     (default . (lambda (b e)
1373                  (message-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                                  (string= (idna-to-ascii "räksmörgÃ¥s")
1500                                           "xn--rksmrgs-5wao1o")
1501                                  t)
1502   "Whether to encode non-ASCII in domain names into ASCII according to IDNA.
1503 GNU Libidn, and in particular the elisp package \"idna.el\" and
1504 the external program \"idn\", must be installed for this
1505 functionality to work."
1506   :version "22.1"
1507   :group 'message-headers
1508   :link '(custom-manual "(message)IDNA")
1509   :type '(choice (const :tag "Ask" ask)
1510                  (const :tag "Never" nil)
1511                  (const :tag "Always" t)))
1512
1513 (defcustom message-generate-hashcash nil
1514   "*Whether to generate X-Hashcash: headers.
1515 You must have the \"hashcash\" binary installed, see `hashcash-path'."
1516   :group 'message-headers
1517   :link '(custom-manual "(message)Mail Headers")
1518   :type 'boolean)
1519
1520 ;;; Internal variables.
1521
1522 (defvar message-sending-message "Sending...")
1523 (defvar message-buffer-list nil)
1524 (defvar message-this-is-news nil)
1525 (defvar message-this-is-mail nil)
1526 (defvar message-draft-article nil)
1527 (defvar message-mime-part nil)
1528 (defvar message-posting-charset nil)
1529 (defvar message-inserted-headers nil)
1530
1531 ;; Byte-compiler warning
1532 (eval-when-compile
1533   (defvar gnus-active-hashtb)
1534   (defvar gnus-read-active-file))
1535
1536 ;;; Regexp matching the delimiter of messages in UNIX mail format
1537 ;;; (UNIX From lines), minus the initial ^.  It should be a copy
1538 ;;; of rmail.el's rmail-unix-mail-delimiter.
1539 (defvar message-unix-mail-delimiter
1540   (let ((time-zone-regexp
1541          (concat "\\([A-Z]?[A-Z]?[A-Z][A-Z]\\( DST\\)?"
1542                  "\\|[-+]?[0-9][0-9][0-9][0-9]"
1543                  "\\|"
1544                  "\\) *")))
1545     (concat
1546      "From "
1547
1548      ;; Many things can happen to an RFC 822 mailbox before it is put into
1549      ;; a `From' line.  The leading phrase can be stripped, e.g.
1550      ;; `Joe <@w.x:joe@y.z>' -> `<@w.x:joe@y.z>'.  The <> can be stripped, e.g.
1551      ;; `<@x.y:joe@y.z>' -> `@x.y:joe@y.z'.  Everything starting with a CRLF
1552      ;; can be removed, e.g.
1553      ;;         From: joe@y.z (Joe      K
1554      ;;                 User)
1555      ;; can yield `From joe@y.z (Joe    K Fri Mar 22 08:11:15 1996', and
1556      ;;         From: Joe User
1557      ;;                 <joe@y.z>
1558      ;; can yield `From Joe User Fri Mar 22 08:11:15 1996'.
1559      ;; The mailbox can be removed or be replaced by white space, e.g.
1560      ;;         From: "Joe User"{space}{tab}
1561      ;;                 <joe@y.z>
1562      ;; can yield `From {space}{tab} Fri Mar 22 08:11:15 1996',
1563      ;; where {space} and {tab} represent the Ascii space and tab characters.
1564      ;; We want to match the results of any of these manglings.
1565      ;; The following regexp rejects names whose first characters are
1566      ;; obviously bogus, but after that anything goes.
1567      "\\([^\0-\b\n-\r\^?].*\\)?"
1568
1569      ;; The time the message was sent.
1570      "\\([^\0-\r \^?]+\\) +"            ; day of the week
1571      "\\([^\0-\r \^?]+\\) +"            ; month
1572      "\\([0-3]?[0-9]\\) +"              ; day of month
1573      "\\([0-2][0-9]:[0-5][0-9]\\(:[0-6][0-9]\\)?\\) *" ; time of day
1574
1575      ;; Perhaps a time zone, specified by an abbreviation, or by a
1576      ;; numeric offset.
1577      time-zone-regexp
1578
1579      ;; The year.
1580      " \\([0-9][0-9]+\\) *"
1581
1582      ;; On some systems the time zone can appear after the year, too.
1583      time-zone-regexp
1584
1585      ;; Old uucp cruft.
1586      "\\(remote from .*\\)?"
1587
1588      "\n"))
1589   "Regexp matching the delimiter of messages in UNIX mail format.")
1590
1591 (defvar message-unsent-separator
1592   (concat "^ *---+ +Unsent message follows +---+ *$\\|"
1593           "^ *---+ +Returned message +---+ *$\\|"
1594           "^Start of returned message$\\|"
1595           "^ *---+ +Original message +---+ *$\\|"
1596           "^ *--+ +begin message +--+ *$\\|"
1597           "^ *---+ +Original message follows +---+ *$\\|"
1598           "^ *---+ +Undelivered message follows +---+ *$\\|"
1599           "^|? *---+ +Message text follows: +---+ *|?$")
1600   "A regexp that matches the separator before the text of a failed message.")
1601
1602 (defvar message-field-fillers
1603   '((To message-fill-field-address)
1604     (Cc message-fill-field-address)
1605     (From message-fill-field-address))
1606   "Alist of header names/filler functions.")
1607
1608 (defvar message-header-format-alist
1609   `((From)
1610     (Newsgroups)
1611     (To)
1612     (Cc)
1613     (Subject)
1614     (In-Reply-To)
1615     (Fcc)
1616     (Bcc)
1617     (Date)
1618     (Organization)
1619     (Distribution)
1620     (Lines)
1621     (Expires)
1622     (Message-ID)
1623     (References . message-shorten-references)
1624     (User-Agent))
1625   "Alist used for formatting headers.")
1626
1627 (defvar message-options nil
1628   "Some saved answers when sending message.")
1629
1630 (defvar message-send-mail-real-function nil
1631   "Internal send mail function.")
1632
1633 (defvar message-bogus-system-names "^localhost\\."
1634   "The regexp of bogus system names.")
1635
1636 (defcustom message-valid-fqdn-regexp
1637   (concat "[a-z0-9][-.a-z0-9]+\\." ;; [hostname.subdomain.]domain.
1638           ;; valid TLDs:
1639           "\\([a-z][a-z]" ;; two letter country TDLs
1640           "\\|biz\\|com\\|edu\\|gov\\|int\\|mil\\|net\\|org"
1641           "\\|aero\\|coop\\|info\\|name\\|museum"
1642           "\\|arpa\\|pro\\|uucp\\|bitnet\\|bofh" ;; old style?
1643           "\\)")
1644   "Regular expression that matches a valid FQDN."
1645   ;; see also: gnus-button-valid-fqdn-regexp
1646   :version "22.1"
1647   :group 'message-headers
1648   :type 'regexp)
1649
1650 (eval-and-compile
1651   (autoload 'gnus-alive-p "gnus-util")
1652   (autoload 'gnus-delay-article "gnus-delay")
1653   (autoload 'gnus-extract-address-components "gnus-util")
1654   (autoload 'gnus-find-method-for-group "gnus")
1655   (autoload 'gnus-group-decoded-name "gnus-group")
1656   (autoload 'gnus-group-name-charset "gnus-group")
1657   (autoload 'gnus-group-name-decode "gnus-group")
1658   (autoload 'gnus-groups-from-server "gnus")
1659   (autoload 'gnus-make-local-hook "gnus-util")
1660   (autoload 'gnus-open-server "gnus-int")
1661   (autoload 'gnus-output-to-mail "gnus-util")
1662   (autoload 'gnus-output-to-rmail "gnus-util")
1663   (autoload 'gnus-request-post "gnus-int")
1664   (autoload 'gnus-server-string "gnus")
1665   (autoload 'idna-to-ascii "idna")
1666   (autoload 'message-setup-toolbar "messagexmas")
1667   (autoload 'mh-new-draft-name "mh-comp")
1668   (autoload 'mh-send-letter "mh-comp")
1669   (autoload 'nndraft-request-associate-buffer "nndraft")
1670   (autoload 'nndraft-request-expire-articles "nndraft")
1671   (autoload 'nnvirtual-find-group-art "nnvirtual")
1672   (autoload 'rmail-dont-reply-to "mail-utils")
1673   (autoload 'rmail-msg-is-pruned "rmail")
1674   (autoload 'rmail-msg-restore-non-pruned-header "rmail")
1675   (autoload 'rmail-output "rmailout"))
1676
1677 \f
1678
1679 ;;;
1680 ;;; Utility functions.
1681 ;;;
1682
1683 (defmacro message-y-or-n-p (question show &rest text)
1684   "Ask QUESTION, displaying remaining args in a temporary buffer if SHOW."
1685   `(message-talkative-question 'y-or-n-p ,question ,show ,@text))
1686
1687 (defmacro message-delete-line (&optional n)
1688   "Delete the current line (and the next N lines)."
1689   `(delete-region (progn (beginning-of-line) (point))
1690                   (progn (forward-line ,(or n 1)) (point))))
1691
1692 (defun message-mark-active-p ()
1693   "Non-nil means the mark and region are currently active in this buffer."
1694   mark-active)
1695
1696 (defun message-unquote-tokens (elems)
1697   "Remove double quotes (\") from strings in list ELEMS."
1698   (mapcar (lambda (item)
1699             (while (string-match "^\\(.*\\)\"\\(.*\\)$" item)
1700               (setq item (concat (match-string 1 item)
1701                                  (match-string 2 item))))
1702             item)
1703           elems))
1704
1705 (defun message-tokenize-header (header &optional separator)
1706   "Split HEADER into a list of header elements.
1707 SEPARATOR is a string of characters to be used as separators.  \",\"
1708 is used by default."
1709   (if (not header)
1710       nil
1711     (let ((regexp (format "[%s]+" (or separator ",")))
1712           (first t)
1713           beg quoted elems paren)
1714       (with-temp-buffer
1715         (mm-enable-multibyte)
1716         (setq beg (point-min))
1717         (insert header)
1718         (goto-char (point-min))
1719         (while (not (eobp))
1720           (if first
1721               (setq first nil)
1722             (forward-char 1))
1723           (cond ((and (> (point) beg)
1724                       (or (eobp)
1725                           (and (looking-at regexp)
1726                                (not quoted)
1727                                (not paren))))
1728                  (push (buffer-substring beg (point)) elems)
1729                  (setq beg (match-end 0)))
1730                 ((eq (char-after) ?\")
1731                  (setq quoted (not quoted)))
1732                 ((and (eq (char-after) ?\()
1733                       (not quoted))
1734                  (setq paren t))
1735                 ((and (eq (char-after) ?\))
1736                       (not quoted))
1737                  (setq paren nil))))
1738         (nreverse elems)))))
1739
1740 (defun message-mail-file-mbox-p (file)
1741   "Say whether FILE looks like a Unix mbox file."
1742   (when (and (file-exists-p file)
1743              (file-readable-p file)
1744              (file-regular-p file))
1745     (with-temp-buffer
1746       (nnheader-insert-file-contents file)
1747       (goto-char (point-min))
1748       (looking-at message-unix-mail-delimiter))))
1749
1750 (defun message-fetch-field (header &optional not-all)
1751   "The same as `mail-fetch-field', only remove all newlines.
1752 The buffer is expected to be narrowed to just the header of the message;
1753 see `message-narrow-to-headers-or-head'."
1754   (let* ((inhibit-point-motion-hooks t)
1755          (value (mail-fetch-field header nil (not not-all))))
1756     (when value
1757       (while (string-match "\n[\t ]+" value)
1758         (setq value (replace-match " " t t value)))
1759       value)))
1760
1761 (defun message-field-value (header &optional not-all)
1762   "The same as `message-fetch-field', only narrow to the headers first."
1763   (save-excursion
1764     (save-restriction
1765       (message-narrow-to-headers-or-head)
1766       (message-fetch-field header not-all))))
1767
1768 (defun message-narrow-to-field ()
1769   "Narrow the buffer to the header on the current line."
1770   (beginning-of-line)
1771   (while (looking-at "[ \t]")
1772     (forward-line -1))
1773   (narrow-to-region
1774    (point)
1775    (progn
1776      (forward-line 1)
1777      (if (re-search-forward "^[^ \n\t]" nil t)
1778          (point-at-bol)
1779        (point-max))))
1780   (goto-char (point-min)))
1781
1782 (defun message-add-header (&rest headers)
1783   "Add the HEADERS to the message header, skipping those already present."
1784   (while headers
1785     (let (hclean)
1786       (unless (string-match "^\\([^:]+\\):[ \t]*[^ \t]" (car headers))
1787         (error "Invalid header `%s'" (car headers)))
1788       (setq hclean (match-string 1 (car headers)))
1789       (save-restriction
1790         (message-narrow-to-headers)
1791         (unless (re-search-forward (concat "^" (regexp-quote hclean) ":") nil t)
1792           (goto-char (point-max))
1793           (if (string-match "\n$" (car headers))
1794               (insert (car headers))
1795             (insert (car headers) ?\n)))))
1796     (setq headers (cdr headers))))
1797
1798 (defmacro message-with-reply-buffer (&rest forms)
1799   "Evaluate FORMS in the reply buffer, if it exists."
1800   `(when (and message-reply-buffer
1801               (buffer-name message-reply-buffer))
1802      (save-excursion
1803        (set-buffer message-reply-buffer)
1804        ,@forms)))
1805
1806 (put 'message-with-reply-buffer 'lisp-indent-function 0)
1807 (put 'message-with-reply-buffer 'edebug-form-spec '(body))
1808
1809 (defun message-fetch-reply-field (header)
1810   "Fetch field HEADER from the message we're replying to."
1811   (message-with-reply-buffer
1812     (save-restriction
1813       (mail-narrow-to-head)
1814       (message-fetch-field header))))
1815
1816 (defun message-strip-list-identifiers (subject)
1817   "Remove list identifiers in `gnus-list-identifiers' from string SUBJECT."
1818   (require 'gnus-sum)                   ; for gnus-list-identifiers
1819   (let ((regexp (if (stringp gnus-list-identifiers)
1820                     gnus-list-identifiers
1821                   (mapconcat 'identity gnus-list-identifiers " *\\|"))))
1822     (if (string-match (concat "\\(\\(\\(Re: +\\)?\\(" regexp
1823                               " *\\)\\)+\\(Re: +\\)?\\)") subject)
1824         (concat (substring subject 0 (match-beginning 1))
1825                 (or (match-string 3 subject)
1826                     (match-string 5 subject))
1827                 (substring subject
1828                            (match-end 1)))
1829       subject)))
1830
1831 (defun message-strip-subject-re (subject)
1832   "Remove \"Re:\" from subject lines in string SUBJECT."
1833   (if (string-match message-subject-re-regexp subject)
1834       (substring subject (match-end 0))
1835     subject))
1836
1837 ;;; Start of functions adopted from `message-utils.el'.
1838
1839 (defun message-strip-subject-trailing-was (subject)
1840   "Remove trailing \"(was: <old subject>)\" from SUBJECT lines.
1841 Leading \"Re: \" is not stripped by this function.  Use the function
1842 `message-strip-subject-re' for this."
1843   (let* ((query message-subject-trailing-was-query)
1844          (new) (found))
1845     (setq found
1846           (string-match
1847            (if (eq query 'ask)
1848                message-subject-trailing-was-ask-regexp
1849              message-subject-trailing-was-regexp)
1850            subject))
1851     (if found
1852         (setq new (substring subject 0 (match-beginning 0))))
1853     (if (or (not found) (eq query nil))
1854         subject
1855       (if (eq query 'ask)
1856           (if (message-y-or-n-p
1857                "Strip `(was: <old subject>)' in subject? " t
1858                (concat
1859                 "Strip `(was: <old subject>)' in subject "
1860                 "and use the new one instead?\n\n"
1861                 "Current subject is:   \""
1862                 subject "\"\n\n"
1863                 "New subject would be: \""
1864                 new "\"\n\n"
1865                 "See the variable `message-subject-trailing-was-query' "
1866                 "to get rid of this query."
1867                 ))
1868               new subject)
1869         new))))
1870
1871 ;;; Suggested by Jonas Steverud  @  www.dtek.chalmers.se/~d4jonas/
1872
1873 (defun message-change-subject (new-subject)
1874   "Ask for NEW-SUBJECT header, append (was: <Old Subject>)."
1875   ;; <URL:http://www.landfield.com/usefor/drafts/draft-ietf-usefor-useage--1.02.unpaged>
1876   (interactive
1877    (list
1878     (read-from-minibuffer "New subject: ")))
1879   (cond ((and (not (or (null new-subject) ; new subject not empty
1880                        (zerop (string-width new-subject))
1881                        (string-match "^[ \t]*$" new-subject))))
1882          (save-excursion
1883            (let ((old-subject
1884                   (save-restriction
1885                     (message-narrow-to-headers)
1886                     (message-fetch-field "Subject"))))
1887              (cond ((not old-subject)
1888                     (error "No current subject"))
1889                    ((not (string-match
1890                           (concat "^[ \t]*"
1891                                   (regexp-quote new-subject)
1892                                   " \t]*$")
1893                           old-subject))  ; yes, it really is a new subject
1894                     ;; delete eventual Re: prefix
1895                     (setq old-subject
1896                           (message-strip-subject-re old-subject))
1897                     (message-goto-subject)
1898                     (message-delete-line)
1899                     (insert (concat "Subject: "
1900                                     new-subject
1901                                     " (was: "
1902                                     old-subject ")\n")))))))))
1903
1904 (defun message-mark-inserted-region (beg end &optional verbatim)
1905   "Mark some region in the current article with enclosing tags.
1906 See `message-mark-insert-begin' and `message-mark-insert-end'.
1907 If VERBATIM, use slrn style verbatim marks (\"#v+\" and \"#v-\")."
1908   (interactive "r\nP")
1909   (save-excursion
1910     ;; add to the end of the region first, otherwise end would be invalid
1911     (goto-char end)
1912     (insert (if verbatim "#v-\n" message-mark-insert-end))
1913     (goto-char beg)
1914     (insert (if verbatim "#v+\n" message-mark-insert-begin))))
1915
1916 (defun message-mark-insert-file (file &optional verbatim)
1917   "Insert FILE at point, marking it with enclosing tags.
1918 See `message-mark-insert-begin' and `message-mark-insert-end'.
1919 If VERBATIM, use slrn style verbatim marks (\"#v+\" and \"#v-\")."
1920   (interactive "fFile to insert: \nP")
1921     ;; reverse insertion to get correct result.
1922   (let ((p (point)))
1923     (insert (if verbatim "#v-\n" message-mark-insert-end))
1924     (goto-char p)
1925     (insert-file-contents file)
1926     (goto-char p)
1927     (insert (if verbatim "#v+\n" message-mark-insert-begin))))
1928
1929 (defun message-add-archive-header ()
1930   "Insert \"X-No-Archive: Yes\" in the header and a note in the body.
1931 The note can be customized using `message-archive-note'.  When called with a
1932 prefix argument, ask for a text to insert.  If you don't want the note in the
1933 body, set  `message-archive-note' to nil."
1934   (interactive)
1935   (if current-prefix-arg
1936       (setq message-archive-note
1937             (read-from-minibuffer "Reason for No-Archive: "
1938                                   (cons message-archive-note 0))))
1939     (save-excursion
1940       (if (message-goto-signature)
1941           (re-search-backward message-signature-separator))
1942       (when message-archive-note
1943         (insert message-archive-note)
1944         (newline))
1945       (message-add-header message-archive-header)
1946       (message-sort-headers)))
1947
1948 (defun message-cross-post-followup-to-header (target-group)
1949   "Mangles FollowUp-To and Newsgroups header to point to TARGET-GROUP.
1950 With prefix-argument just set Follow-Up, don't cross-post."
1951   (interactive
1952    (list ; Completion based on Gnus
1953     (completing-read "Followup To: "
1954                      (if (boundp 'gnus-newsrc-alist)
1955                          gnus-newsrc-alist)
1956                      nil nil '("poster" . 0)
1957                      (if (boundp 'gnus-group-history)
1958                          'gnus-group-history))))
1959   (message-remove-header "Follow[Uu]p-[Tt]o" t)
1960   (message-goto-newsgroups)
1961   (beginning-of-line)
1962   ;; if we already did a crosspost before, kill old target
1963   (if (and message-cross-post-old-target
1964            (re-search-forward
1965             (regexp-quote (concat "," message-cross-post-old-target))
1966             nil t))
1967       (replace-match ""))
1968   ;; unless (followup is to poster or user explicitly asked not
1969   ;; to cross-post, or target-group is already in Newsgroups)
1970   ;; add target-group to Newsgroups line.
1971   (cond ((and (or
1972                ;; def: cross-post, req:no
1973                (and message-cross-post-default (not current-prefix-arg))
1974                ;; def: no-cross-post, req:yes
1975                (and (not message-cross-post-default) current-prefix-arg))
1976               (not (string-match "poster" target-group))
1977               (not (string-match (regexp-quote target-group)
1978                                  (message-fetch-field "Newsgroups"))))
1979          (end-of-line)
1980          (insert (concat "," target-group))))
1981   (end-of-line) ; ensure Followup: comes after Newsgroups:
1982   ;; unless new followup would be identical to Newsgroups line
1983   ;; make a new Followup-To line
1984   (if (not (string-match (concat "^[ \t]*"
1985                                  target-group
1986                                  "[ \t]*$")
1987                          (message-fetch-field "Newsgroups")))
1988       (insert (concat "\nFollowup-To: " target-group)))
1989   (setq message-cross-post-old-target target-group))
1990
1991 (defun message-cross-post-insert-note (target-group cross-post in-old
1992                                                     old-groups)
1993   "Insert a in message body note about a set Followup or Crosspost.
1994 If there have been previous notes, delete them.  TARGET-GROUP specifies the
1995 group to Followup-To.  When CROSS-POST is t, insert note about
1996 crossposting.  IN-OLD specifies whether TARGET-GROUP is a member of
1997 OLD-GROUPS.  OLD-GROUPS lists the old-groups the posting would have
1998 been made to before the user asked for a Crosspost."
1999   ;; start scanning body for previous uses
2000   (message-goto-signature)
2001   (let ((head (re-search-backward
2002                (concat "^" mail-header-separator)
2003                nil t))) ; just search in body
2004     (message-goto-signature)
2005     (while (re-search-backward
2006             (concat "^" (regexp-quote message-cross-post-note) ".*")
2007             head t)
2008       (message-delete-line))
2009     (message-goto-signature)
2010     (while (re-search-backward
2011             (concat "^" (regexp-quote message-followup-to-note) ".*")
2012             head t)
2013       (message-delete-line))
2014     ;; insert new note
2015     (if (message-goto-signature)
2016         (re-search-backward message-signature-separator))
2017     (if (or in-old
2018             (not cross-post)
2019             (string-match "^[ \t]*poster[ \t]*$" target-group))
2020         (insert (concat message-followup-to-note target-group "\n"))
2021       (insert (concat message-cross-post-note target-group "\n")))))
2022
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 (defun message-reduce-to-to-cc ()
2065  "Replace contents of To: header with contents of Cc: or Bcc: header."
2066  (interactive)
2067  (let ((cc-content
2068         (save-restriction (message-narrow-to-headers)
2069                           (message-fetch-field "cc")))
2070        (bcc nil))
2071    (if (and (not cc-content)
2072             (setq cc-content
2073                   (save-restriction
2074                     (message-narrow-to-headers)
2075                     (message-fetch-field "bcc"))))
2076        (setq bcc t))
2077    (cond (cc-content
2078           (save-excursion
2079             (message-goto-to)
2080             (message-delete-line)
2081             (insert (concat "To: " cc-content "\n"))
2082             (save-restriction
2083               (message-narrow-to-headers)
2084               (message-remove-header (if bcc
2085                                          "bcc"
2086                                        "cc"))))))))
2087
2088 ;;; End of functions adopted from `message-utils.el'.
2089
2090 (defun message-remove-duplicates (list)
2091   (let (new)
2092     (while list
2093       (or (member (car list) new)
2094           (setq new (cons (car list) new)))
2095       (setq list (cdr list)))
2096     (nreverse new)))
2097
2098 (defun message-remove-header (header &optional is-regexp first reverse)
2099   "Remove HEADER in the narrowed buffer.
2100 If IS-REGEXP, HEADER is a regular expression.
2101 If FIRST, only remove the first instance of the header.
2102 Return the number of headers removed."
2103   (goto-char (point-min))
2104   (let ((regexp (if is-regexp header (concat "^" (regexp-quote header) ":")))
2105         (number 0)
2106         (case-fold-search t)
2107         last)
2108     (while (and (not (eobp))
2109                 (not last))
2110       (if (if reverse
2111               (not (looking-at regexp))
2112             (looking-at regexp))
2113           (progn
2114             (incf number)
2115             (when first
2116               (setq last t))
2117             (delete-region
2118              (point)
2119              ;; There might be a continuation header, so we have to search
2120              ;; until we find a new non-continuation line.
2121              (progn
2122                (forward-line 1)
2123                (if (re-search-forward "^[^ \t]" nil t)
2124                    (goto-char (match-beginning 0))
2125                  (point-max)))))
2126         (forward-line 1)
2127         (if (re-search-forward "^[^ \t]" nil t)
2128             (goto-char (match-beginning 0))
2129           (goto-char (point-max)))))
2130     number))
2131
2132 (defun message-remove-first-header (header)
2133   "Remove the first instance of HEADER if there is more than one."
2134   (let ((count 0)
2135         (regexp (concat "^" (regexp-quote header) ":")))
2136     (save-excursion
2137       (goto-char (point-min))
2138       (while (re-search-forward regexp nil t)
2139         (incf count)))
2140     (while (> count 1)
2141       (message-remove-header header nil t)
2142       (decf count))))
2143
2144 (defun message-narrow-to-headers ()
2145   "Narrow the buffer to the head of the message."
2146   (widen)
2147   (narrow-to-region
2148    (goto-char (point-min))
2149    (if (re-search-forward
2150         (concat "^" (regexp-quote mail-header-separator) "\n") nil t)
2151        (match-beginning 0)
2152      (point-max)))
2153   (goto-char (point-min)))
2154
2155 (defun message-narrow-to-head-1 ()
2156   "Like `message-narrow-to-head'.  Don't widen."
2157   (narrow-to-region
2158    (goto-char (point-min))
2159    (if (search-forward "\n\n" nil 1)
2160        (1- (point))
2161      (point-max)))
2162   (goto-char (point-min)))
2163
2164 (defun message-narrow-to-head ()
2165   "Narrow the buffer to the head of the message.
2166 Point is left at the beginning of the narrowed-to region."
2167   (widen)
2168   (message-narrow-to-head-1))
2169
2170 (defun message-narrow-to-headers-or-head ()
2171   "Narrow the buffer to the head of the message."
2172   (widen)
2173   (narrow-to-region
2174    (goto-char (point-min))
2175    (cond
2176     ((re-search-forward
2177       (concat "^" (regexp-quote mail-header-separator) "\n") nil t)
2178      (match-beginning 0))
2179     ((search-forward "\n\n" nil t)
2180      (1- (point)))
2181     (t
2182      (point-max))))
2183   (goto-char (point-min)))
2184
2185 (defun message-news-p ()
2186   "Say whether the current buffer contains a news message."
2187   (and (not message-this-is-mail)
2188        (or message-this-is-news
2189            (save-excursion
2190              (save-restriction
2191                (message-narrow-to-headers)
2192                (and (message-fetch-field "newsgroups")
2193                     (not (message-fetch-field "posted-to"))))))))
2194
2195 (defun message-mail-p ()
2196   "Say whether the current buffer contains a mail message."
2197   (and (not message-this-is-news)
2198        (or message-this-is-mail
2199            (save-excursion
2200              (save-restriction
2201                (message-narrow-to-headers)
2202                (or (message-fetch-field "to")
2203                    (message-fetch-field "cc")
2204                    (message-fetch-field "bcc")))))))
2205
2206 (defun message-subscribed-p ()
2207   "Say whether we need to insert a MFT header."
2208   (or message-subscribed-regexps
2209       message-subscribed-addresses
2210       message-subscribed-address-file
2211       message-subscribed-address-functions))
2212
2213 (defun message-next-header ()
2214   "Go to the beginning of the next header."
2215   (beginning-of-line)
2216   (or (eobp) (forward-char 1))
2217   (not (if (re-search-forward "^[^ \t]" nil t)
2218            (beginning-of-line)
2219          (goto-char (point-max)))))
2220
2221 (defun message-sort-headers-1 ()
2222   "Sort the buffer as headers using `message-rank' text props."
2223   (goto-char (point-min))
2224   (require 'sort)
2225   (sort-subr
2226    nil 'message-next-header
2227    (lambda ()
2228      (message-next-header)
2229      (unless (bobp)
2230        (forward-char -1)))
2231    (lambda ()
2232      (or (get-text-property (point) 'message-rank)
2233          10000))))
2234
2235 (defun message-sort-headers ()
2236   "Sort the headers of the current message according to `message-header-format-alist'."
2237   (interactive)
2238   (save-excursion
2239     (save-restriction
2240       (let ((max (1+ (length message-header-format-alist)))
2241             rank)
2242         (message-narrow-to-headers)
2243         (while (re-search-forward "^[^ \n]+:" nil t)
2244           (put-text-property
2245            (match-beginning 0) (1+ (match-beginning 0))
2246            'message-rank
2247            (if (setq rank (length (memq (assq (intern (buffer-substring
2248                                                        (match-beginning 0)
2249                                                        (1- (match-end 0))))
2250                                               message-header-format-alist)
2251                                         message-header-format-alist)))
2252                (- max rank)
2253              (1+ max)))))
2254       (message-sort-headers-1))))
2255
2256 (defun message-kill-address ()
2257   "Kill the address under point."
2258   (interactive)
2259   (let ((start (point)))
2260     (message-skip-to-next-address)
2261     (kill-region start (point))))
2262
2263 \f
2264
2265 ;;;
2266 ;;; Message mode
2267 ;;;
2268
2269 ;;; Set up keymap.
2270
2271 (defvar message-mode-map nil)
2272
2273 (unless message-mode-map
2274   (setq message-mode-map (make-keymap))
2275   (set-keymap-parent message-mode-map text-mode-map)
2276   (define-key message-mode-map "\C-c?" 'describe-mode)
2277
2278   (define-key message-mode-map "\C-c\C-f\C-t" 'message-goto-to)
2279   (define-key message-mode-map "\C-c\C-f\C-o" 'message-goto-from)
2280   (define-key message-mode-map "\C-c\C-f\C-b" 'message-goto-bcc)
2281   (define-key message-mode-map "\C-c\C-f\C-w" 'message-goto-fcc)
2282   (define-key message-mode-map "\C-c\C-f\C-c" 'message-goto-cc)
2283   (define-key message-mode-map "\C-c\C-f\C-s" 'message-goto-subject)
2284   (define-key message-mode-map "\C-c\C-f\C-r" 'message-goto-reply-to)
2285   (define-key message-mode-map "\C-c\C-f\C-n" 'message-goto-newsgroups)
2286   (define-key message-mode-map "\C-c\C-f\C-d" 'message-goto-distribution)
2287   (define-key message-mode-map "\C-c\C-f\C-f" 'message-goto-followup-to)
2288   (define-key message-mode-map "\C-c\C-f\C-m" 'message-goto-mail-followup-to)
2289   (define-key message-mode-map "\C-c\C-f\C-k" 'message-goto-keywords)
2290   (define-key message-mode-map "\C-c\C-f\C-u" 'message-goto-summary)
2291   (define-key message-mode-map "\C-c\C-f\C-i"
2292     'message-insert-or-toggle-importance)
2293   (define-key message-mode-map "\C-c\C-f\C-a"
2294     'message-generate-unsubscribed-mail-followup-to)
2295
2296   ;; modify headers (and insert notes in body)
2297   (define-key message-mode-map "\C-c\C-fs"    'message-change-subject)
2298   ;;
2299   (define-key message-mode-map "\C-c\C-fx"    'message-cross-post-followup-to)
2300   ;; prefix+message-cross-post-followup-to = same w/o cross-post
2301   (define-key message-mode-map "\C-c\C-ft"    'message-reduce-to-to-cc)
2302   (define-key message-mode-map "\C-c\C-fa"    'message-add-archive-header)
2303   ;; mark inserted text
2304   (define-key message-mode-map "\C-c\M-m" 'message-mark-inserted-region)
2305   (define-key message-mode-map "\C-c\M-f" 'message-mark-insert-file)
2306
2307   (define-key message-mode-map "\C-c\C-b" 'message-goto-body)
2308   (define-key message-mode-map "\C-c\C-i" 'message-goto-signature)
2309
2310   (define-key message-mode-map "\C-c\C-t" 'message-insert-to)
2311   (define-key message-mode-map "\C-c\C-fw" 'message-insert-wide-reply)
2312   (define-key message-mode-map "\C-c\C-n" 'message-insert-newsgroups)
2313   (define-key message-mode-map "\C-c\C-l" 'message-to-list-only)
2314   (define-key message-mode-map "\C-c\C-f\C-e" 'message-insert-expires)
2315
2316   (define-key message-mode-map "\C-c\C-u" 'message-insert-or-toggle-importance)
2317   (define-key message-mode-map "\C-c\M-n"
2318     'message-insert-disposition-notification-to)
2319
2320   (define-key message-mode-map "\C-c\C-y" 'message-yank-original)
2321   (define-key message-mode-map "\C-c\M-\C-y" 'message-yank-buffer)
2322   (define-key message-mode-map "\C-c\C-q" 'message-fill-yanked-message)
2323   (define-key message-mode-map "\C-c\C-w" 'message-insert-signature)
2324   (define-key message-mode-map "\C-c\M-h" 'message-insert-headers)
2325   (define-key message-mode-map "\C-c\C-r" 'message-caesar-buffer-body)
2326   (define-key message-mode-map "\C-c\C-o" 'message-sort-headers)
2327   (define-key message-mode-map "\C-c\M-r" 'message-rename-buffer)
2328
2329   (define-key message-mode-map "\C-c\C-c" 'message-send-and-exit)
2330   (define-key message-mode-map "\C-c\C-s" 'message-send)
2331   (define-key message-mode-map "\C-c\C-k" 'message-kill-buffer)
2332   (define-key message-mode-map "\C-c\C-d" 'message-dont-send)
2333   (define-key message-mode-map "\C-c\n" 'gnus-delay-article)
2334
2335   (define-key message-mode-map "\C-c\M-k" 'message-kill-address)
2336   (define-key message-mode-map "\C-c\C-e" 'message-elide-region)
2337   (define-key message-mode-map "\C-c\C-v" 'message-delete-not-region)
2338   (define-key message-mode-map "\C-c\C-z" 'message-kill-to-signature)
2339   (define-key message-mode-map "\M-\r" 'message-newline-and-reformat)
2340   (define-key message-mode-map [remap split-line]  'message-split-line)
2341
2342   (define-key message-mode-map "\C-c\C-a" 'mml-attach-file)
2343
2344   (define-key message-mode-map "\C-a" 'message-beginning-of-line)
2345   (define-key message-mode-map "\t" 'message-tab)
2346   (define-key message-mode-map "\M-;" 'comment-region))
2347
2348 (easy-menu-define
2349   message-mode-menu message-mode-map "Message Menu."
2350   `("Message"
2351     ["Yank Original" message-yank-original message-reply-buffer]
2352     ["Fill Yanked Message" message-fill-yanked-message t]
2353     ["Insert Signature" message-insert-signature t]
2354     ["Caesar (rot13) Message" message-caesar-buffer-body t]
2355     ["Caesar (rot13) Region" message-caesar-region (message-mark-active-p)]
2356     ["Elide Region" message-elide-region
2357      :active (message-mark-active-p)
2358      ,@(if (featurep 'xemacs) nil
2359          '(:help "Replace text in region with an ellipsis"))]
2360     ["Delete Outside Region" message-delete-not-region
2361      :active (message-mark-active-p)
2362      ,@(if (featurep 'xemacs) nil
2363          '(:help "Delete all quoted text outside region"))]
2364     ["Kill To Signature" message-kill-to-signature t]
2365     ["Newline and Reformat" message-newline-and-reformat t]
2366     ["Rename buffer" message-rename-buffer t]
2367     ["Spellcheck" ispell-message
2368      ,@(if (featurep 'xemacs) '(t)
2369          '(:help "Spellcheck this message"))]
2370     "----"
2371     ["Insert Region Marked" message-mark-inserted-region
2372      :active (message-mark-active-p)
2373      ,@(if (featurep 'xemacs) nil
2374          '(:help "Mark region with enclosing tags"))]
2375     ["Insert File Marked..." message-mark-insert-file
2376      ,@(if (featurep 'xemacs) '(t)
2377          '(:help "Insert file at point marked with enclosing tags"))]
2378     "----"
2379     ["Send Message" message-send-and-exit
2380      ,@(if (featurep 'xemacs) '(t)
2381          '(:help "Send this message"))]
2382     ["Postpone Message" message-dont-send
2383      ,@(if (featurep 'xemacs) '(t)
2384          '(:help "File this draft message and exit"))]
2385     ["Send at Specific Time..." gnus-delay-article
2386      ,@(if (featurep 'xemacs) '(t)
2387          '(:help "Ask, then arrange to send message at that time"))]
2388     ["Kill Message" message-kill-buffer
2389      ,@(if (featurep 'xemacs) '(t)
2390          '(:help "Delete this message without sending"))]))
2391
2392 (easy-menu-define
2393   message-mode-field-menu message-mode-map ""
2394   `("Field"
2395     ["To" message-goto-to t]
2396     ["From" message-goto-from t]
2397     ["Subject" message-goto-subject t]
2398     ["Change subject..." message-change-subject t]
2399     ["Cc" message-goto-cc t]
2400     ["Bcc" message-goto-bcc t]
2401     ["Fcc" message-goto-fcc t]
2402     ["Reply-To" message-goto-reply-to t]
2403     ["Flag As Important" message-insert-importance-high
2404      ,@(if (featurep 'xemacs) '(t)
2405          '(:help "Mark this message as important"))]
2406     ["Flag As Unimportant" message-insert-importance-low
2407      ,@(if (featurep 'xemacs) '(t)
2408          '(:help "Mark this message as unimportant"))]
2409     ["Request Receipt"
2410      message-insert-disposition-notification-to
2411      ,@(if (featurep 'xemacs) '(t)
2412          '(:help "Request a receipt notification"))]
2413     "----"
2414     ;; (typical) news stuff
2415     ["Summary" message-goto-summary t]
2416     ["Keywords" message-goto-keywords t]
2417     ["Newsgroups" message-goto-newsgroups t]
2418     ["Fetch Newsgroups" message-insert-newsgroups t]
2419     ["Followup-To" message-goto-followup-to t]
2420     ;; ["Followup-To (with note in body)" message-cross-post-followup-to t]
2421     ["Crosspost / Followup-To..." message-cross-post-followup-to t]
2422     ["Distribution" message-goto-distribution t]
2423     ["Expires" message-insert-expires t ]
2424     ["X-No-Archive" message-add-archive-header t ]
2425     "----"
2426     ;; (typical) mailing-lists stuff
2427     ["Fetch To" message-insert-to
2428      ,@(if (featurep 'xemacs) '(t)
2429          '(:help "Insert a To header that points to the author."))]
2430     ["Fetch To and Cc" message-insert-wide-reply
2431      ,@(if (featurep 'xemacs) '(t)
2432          '(:help
2433            "Insert To and Cc headers as if you were doing a wide reply."))]
2434     "----"
2435     ["Send to list only" message-to-list-only t]
2436     ["Mail-Followup-To" message-goto-mail-followup-to t]
2437     ["Unsubscribed list post" message-generate-unsubscribed-mail-followup-to
2438      ,@(if (featurep 'xemacs) '(t)
2439          '(:help "Insert a reasonable `Mail-Followup-To:' header."))]
2440     ["Reduce To: to Cc:" message-reduce-to-to-cc t]
2441     "----"
2442     ["Sort Headers" message-sort-headers t]
2443     ["Encode non-ASCII domain names" message-idna-to-ascii-rhs t]
2444     ["Goto Body" message-goto-body t]
2445     ["Goto Signature" message-goto-signature t]))
2446
2447 (defvar message-tool-bar-map nil)
2448
2449 (eval-when-compile
2450   (defvar facemenu-add-face-function)
2451   (defvar facemenu-remove-face-function))
2452
2453 ;;; Forbidden properties
2454 ;;
2455 ;; We use `after-change-functions' to keep special text properties
2456 ;; that interfer with the normal function of message mode out of the
2457 ;; buffer.
2458
2459 (defcustom message-strip-special-text-properties t
2460   "Strip special properties from the message buffer.
2461
2462 Emacs has a number of special text properties which can break message
2463 composing in various ways.  If this option is set, message will strip
2464 these properties from the message composition buffer.  However, some
2465 packages requires these properties to be present in order to work.
2466 If you use one of these packages, turn this option off, and hope the
2467 message composition doesn't break too bad."
2468   :version "22.1"
2469   :group 'message-various
2470   :link '(custom-manual "(message)Various Message Variables")
2471   :type 'boolean)
2472
2473 (defconst message-forbidden-properties
2474   ;; No reason this should be clutter up customize.  We make it a
2475   ;; property list (rather than a list of property symbols), to be
2476   ;; directly useful for `remove-text-properties'.
2477   '(field nil read-only nil invisible nil intangible nil
2478           mouse-face nil modification-hooks nil insert-in-front-hooks nil
2479           insert-behind-hooks nil point-entered nil point-left nil)
2480   ;; Other special properties:
2481   ;; category, face, display: probably doesn't do any harm.
2482   ;; fontified: is used by font-lock.
2483   ;; syntax-table, local-map: I dunno.
2484   ;; We need to add XEmacs names to the list.
2485   "Property list of with properties forbidden in message buffers.
2486 The values of the properties are ignored, only the property names are used.")
2487
2488 (defun message-tamago-not-in-use-p (pos)
2489   "Return t when tamago version 4 is not in use at the cursor position.
2490 Tamago version 4 is a popular input method for writing Japanese text.
2491 It uses the properties `intangible', `invisible', `modification-hooks'
2492 and `read-only' when translating ascii or kana text to kanji text.
2493 These properties are essential to work, so we should never strip them."
2494   (not (and (boundp 'egg-modefull-mode)
2495             (symbol-value 'egg-modefull-mode)
2496             (or (memq (get-text-property pos 'intangible)
2497                       '(its-part-1 its-part-2))
2498                 (get-text-property pos 'egg-end)
2499                 (get-text-property pos 'egg-lang)
2500                 (get-text-property pos 'egg-start)))))
2501
2502 (defun message-strip-forbidden-properties (begin end &optional old-length)
2503   "Strip forbidden properties between BEGIN and END, ignoring the third arg.
2504 This function is intended to be called from `after-change-functions'.
2505 See also `message-forbidden-properties'."
2506   (when (and message-strip-special-text-properties
2507              (message-tamago-not-in-use-p begin))
2508     (let ((buffer-read-only nil)
2509           (inhibit-read-only t))
2510       (remove-text-properties begin end message-forbidden-properties))))
2511
2512 ;;;###autoload
2513 (define-derived-mode message-mode text-mode "Message"
2514   "Major mode for editing mail and news to be sent.
2515 Like Text Mode but with these additional commands:\\<message-mode-map>
2516 C-c C-s  `message-send' (send the message)  C-c C-c  `message-send-and-exit'
2517 C-c C-d  Postpone sending the message       C-c C-k  Kill the message
2518 C-c C-f  move to a header field (and create it if there isn't):
2519          C-c C-f C-t  move to To        C-c C-f C-s  move to Subject
2520          C-c C-f C-c  move to Cc        C-c C-f C-b  move to Bcc
2521          C-c C-f C-w  move to Fcc       C-c C-f C-r  move to Reply-To
2522          C-c C-f C-u  move to Summary   C-c C-f C-n  move to Newsgroups
2523          C-c C-f C-k  move to Keywords  C-c C-f C-d  move to Distribution
2524          C-c C-f C-o  move to From (\"Originator\")
2525          C-c C-f C-f  move to Followup-To
2526          C-c C-f C-m  move to Mail-Followup-To
2527          C-c C-f C-e  move to Expires
2528          C-c C-f C-i  cycle through Importance values
2529          C-c C-f s    change subject and append \"(was: <Old Subject>)\"
2530          C-c C-f x    crossposting with FollowUp-To header and note in body
2531          C-c C-f t    replace To: header with contents of Cc: or Bcc:
2532          C-c C-f a    Insert X-No-Archive: header and a note in the body
2533 C-c C-t  `message-insert-to' (add a To header to a news followup)
2534 C-c C-l  `message-to-list-only' (removes all but list address in to/cc)
2535 C-c C-n  `message-insert-newsgroups' (add a Newsgroup header to a news reply)
2536 C-c C-b  `message-goto-body' (move to beginning of message text).
2537 C-c C-i  `message-goto-signature' (move to the beginning of the signature).
2538 C-c C-w  `message-insert-signature' (insert `message-signature-file' file).
2539 C-c C-y  `message-yank-original' (insert current message, if any).
2540 C-c C-q  `message-fill-yanked-message' (fill what was yanked).
2541 C-c C-e  `message-elide-region' (elide the text between point and mark).
2542 C-c C-v  `message-delete-not-region' (remove the text outside the region).
2543 C-c C-z  `message-kill-to-signature' (kill the text up to the signature).
2544 C-c C-r  `message-caesar-buffer-body' (rot13 the message body).
2545 C-c C-a  `mml-attach-file' (attach a file as MIME).
2546 C-c C-u  `message-insert-or-toggle-importance'  (insert or cycle importance).
2547 C-c M-n  `message-insert-disposition-notification-to'  (request receipt).
2548 C-c M-m  `message-mark-inserted-region' (mark region with enclosing tags).
2549 C-c M-f  `message-mark-insert-file' (insert file marked with enclosing tags).
2550 M-RET    `message-newline-and-reformat' (break the line and reformat)."
2551   (setq local-abbrev-table text-mode-abbrev-table)
2552   (set (make-local-variable 'message-reply-buffer) nil)
2553   (set (make-local-variable 'message-inserted-headers) nil)
2554   (set (make-local-variable 'message-send-actions) nil)
2555   (set (make-local-variable 'message-exit-actions) nil)
2556   (set (make-local-variable 'message-kill-actions) nil)
2557   (set (make-local-variable 'message-postpone-actions) nil)
2558   (set (make-local-variable 'message-draft-article) nil)
2559   (setq buffer-offer-save t)
2560   (set (make-local-variable 'facemenu-add-face-function)
2561        (lambda (face end)
2562          (let ((face-fun (cdr (assq face message-face-alist))))
2563            (if face-fun
2564                (funcall face-fun (point) end)
2565              (error "Face %s not configured for %s mode" face mode-name)))
2566          ""))
2567   (set (make-local-variable 'facemenu-remove-face-function) t)
2568   (set (make-local-variable 'message-reply-headers) nil)
2569   (make-local-variable 'message-newsreader)
2570   (make-local-variable 'message-mailer)
2571   (make-local-variable 'message-post-method)
2572   (set (make-local-variable 'message-sent-message-via) nil)
2573   (set (make-local-variable 'message-checksum) nil)
2574   (set (make-local-variable 'message-mime-part) 0)
2575   (message-setup-fill-variables)
2576   ;; Allow using comment commands to add/remove quoting.
2577   ;; (set (make-local-variable 'comment-start) message-yank-prefix)
2578   (when message-yank-prefix
2579     (set (make-local-variable 'comment-start) message-yank-prefix)
2580     (set (make-local-variable 'comment-start-skip)
2581          (concat "^" (regexp-quote message-yank-prefix) "[ \t]*")))
2582   (if (featurep 'xemacs)
2583       (message-setup-toolbar)
2584     (set (make-local-variable 'font-lock-defaults)
2585          '(message-font-lock-keywords t))
2586     (if (boundp 'tool-bar-map)
2587         (set (make-local-variable 'tool-bar-map) (message-tool-bar-map))))
2588   (easy-menu-add message-mode-menu message-mode-map)
2589   (easy-menu-add message-mode-field-menu message-mode-map)
2590   (gnus-make-local-hook 'after-change-functions)
2591   ;; Mmmm... Forbidden properties...
2592   (add-hook 'after-change-functions 'message-strip-forbidden-properties
2593             nil 'local)
2594   ;; Allow mail alias things.
2595   (when (eq message-mail-alias-type 'abbrev)
2596     (if (fboundp 'mail-abbrevs-setup)
2597         (mail-abbrevs-setup)
2598       (if (fboundp 'mail-aliases-setup) ; warning avoidance
2599           (mail-aliases-setup))))
2600   (unless buffer-file-name
2601     (message-set-auto-save-file-name))
2602   (unless (buffer-base-buffer)
2603     ;; Don't enable multibyte on an indirect buffer.  Maybe enabling
2604     ;; multibyte is not necessary at all. -- zsh
2605     (mm-enable-multibyte))
2606   (set (make-local-variable 'indent-tabs-mode) nil) ;No tabs for indentation.
2607   (mml-mode))
2608
2609 (defun message-setup-fill-variables ()
2610   "Setup message fill variables."
2611   (set (make-local-variable 'fill-paragraph-function)
2612        'message-fill-paragraph)
2613   (make-local-variable 'paragraph-separate)
2614   (make-local-variable 'paragraph-start)
2615   (make-local-variable 'adaptive-fill-regexp)
2616   (unless (boundp 'adaptive-fill-first-line-regexp)
2617     (setq adaptive-fill-first-line-regexp nil))
2618   (make-local-variable 'adaptive-fill-first-line-regexp)
2619   (let ((quote-prefix-regexp
2620          ;; User should change message-cite-prefix-regexp if
2621          ;; message-yank-prefix is set to an abnormal value.
2622          (concat "\\(" message-cite-prefix-regexp "\\)[ \t]*")))
2623     (setq paragraph-start
2624           (concat
2625            (regexp-quote mail-header-separator) "$\\|"
2626            "[ \t]*$\\|"                 ; blank lines
2627            "-- $\\|"                    ; signature delimiter
2628            "---+$\\|"              ; delimiters for forwarded messages
2629            page-delimiter "$\\|"        ; spoiler warnings
2630            ".*wrote:$\\|"               ; attribution lines
2631            quote-prefix-regexp "$\\|"   ; empty lines in quoted text
2632                                         ; mml tags
2633            "<#!*/?\\(multipart\\|part\\|external\\|mml\\|secure\\)"))
2634     (setq paragraph-separate paragraph-start)
2635     (setq adaptive-fill-regexp
2636           (concat quote-prefix-regexp "\\|" adaptive-fill-regexp))
2637     (setq adaptive-fill-first-line-regexp
2638           (concat quote-prefix-regexp "\\|"
2639                   adaptive-fill-first-line-regexp)))
2640   (make-local-variable 'auto-fill-inhibit-regexp)
2641   ;;(setq auto-fill-inhibit-regexp "^[A-Z][^: \n\t]+:")
2642   (setq auto-fill-inhibit-regexp nil)
2643   (make-local-variable 'normal-auto-fill-function)
2644   (setq normal-auto-fill-function 'message-do-auto-fill)
2645   ;; KLUDGE: auto fill might already be turned on in `text-mode-hook'.
2646   ;; In that case, ensure that it uses the right function.  The real
2647   ;; solution would be not to use `define-derived-mode', and run
2648   ;; `text-mode-hook' ourself at the end of the mode.
2649   ;; -- Per Abrahamsen <abraham@dina.kvl.dk> Date: 2001-10-19.
2650   (when auto-fill-function
2651     (setq auto-fill-function normal-auto-fill-function)))
2652
2653 \f
2654
2655 ;;;
2656 ;;; Message mode commands
2657 ;;;
2658
2659 ;;; Movement commands
2660
2661 (defun message-goto-to ()
2662   "Move point to the To header."
2663   (interactive)
2664   (message-position-on-field "To"))
2665
2666 (defun message-goto-from ()
2667   "Move point to the From header."
2668   (interactive)
2669   (message-position-on-field "From"))
2670
2671 (defun message-goto-subject ()
2672   "Move point to the Subject header."
2673   (interactive)
2674   (message-position-on-field "Subject"))
2675
2676 (defun message-goto-cc ()
2677   "Move point to the Cc header."
2678   (interactive)
2679   (message-position-on-field "Cc" "To"))
2680
2681 (defun message-goto-bcc ()
2682   "Move point to the Bcc  header."
2683   (interactive)
2684   (message-position-on-field "Bcc" "Cc" "To"))
2685
2686 (defun message-goto-fcc ()
2687   "Move point to the Fcc header."
2688   (interactive)
2689   (message-position-on-field "Fcc" "To" "Newsgroups"))
2690
2691 (defun message-goto-reply-to ()
2692   "Move point to the Reply-To header."
2693   (interactive)
2694   (message-position-on-field "Reply-To" "Subject"))
2695
2696 (defun message-goto-newsgroups ()
2697   "Move point to the Newsgroups header."
2698   (interactive)
2699   (message-position-on-field "Newsgroups"))
2700
2701 (defun message-goto-distribution ()
2702   "Move point to the Distribution header."
2703   (interactive)
2704   (message-position-on-field "Distribution"))
2705
2706 (defun message-goto-followup-to ()
2707   "Move point to the Followup-To header."
2708   (interactive)
2709   (message-position-on-field "Followup-To" "Newsgroups"))
2710
2711 (defun message-goto-mail-followup-to ()
2712   "Move point to the Mail-Followup-To header."
2713   (interactive)
2714   (message-position-on-field "Mail-Followup-To" "To"))
2715
2716 (defun message-goto-keywords ()
2717   "Move point to the Keywords header."
2718   (interactive)
2719   (message-position-on-field "Keywords" "Subject"))
2720
2721 (defun message-goto-summary ()
2722   "Move point to the Summary header."
2723   (interactive)
2724   (message-position-on-field "Summary" "Subject"))
2725
2726 (defun message-goto-body (&optional interactivep)
2727   "Move point to the beginning of the message body."
2728   (interactive (list t))
2729   (when (and interactivep
2730              (looking-at "[ \t]*\n"))
2731     (expand-abbrev))
2732   (goto-char (point-min))
2733   (or (search-forward (concat "\n" mail-header-separator "\n") nil t)
2734       (search-forward-regexp "[^:]+:\\([^\n]\\|\n[ \t]\\)+\n\n" nil t)))
2735
2736 (defun message-goto-eoh ()
2737   "Move point to the end of the headers."
2738   (interactive)
2739   (message-goto-body)
2740   (forward-line -1))
2741
2742 (defun message-goto-signature ()
2743   "Move point to the beginning of the message signature.
2744 If there is no signature in the article, go to the end and
2745 return nil."
2746   (interactive)
2747   (goto-char (point-min))
2748   (if (re-search-forward message-signature-separator nil t)
2749       (forward-line 1)
2750     (goto-char (point-max))
2751     nil))
2752
2753 (defun message-generate-unsubscribed-mail-followup-to (&optional include-cc)
2754   "Insert a reasonable MFT header in a post to an unsubscribed list.
2755 When making original posts to a mailing list you are not subscribed to,
2756 you have to type in a MFT header by hand.  The contents, usually, are
2757 the addresses of the list and your own address.  This function inserts
2758 such a header automatically.  It fetches the contents of the To: header
2759 in the current mail buffer, and appends the current `user-mail-address'.
2760
2761 If the optional argument INCLUDE-CC is non-nil, the addresses in the
2762 Cc: header are also put into the MFT."
2763
2764   (interactive "P")
2765   (let* (cc tos)
2766     (save-restriction
2767       (message-narrow-to-headers)
2768       (message-remove-header "Mail-Followup-To")
2769       (setq cc (and include-cc (message-fetch-field "Cc")))
2770       (setq tos (if cc
2771                     (concat (message-fetch-field "To") "," cc)
2772                   (message-fetch-field "To"))))
2773     (message-goto-mail-followup-to)
2774     (insert (concat tos ", " user-mail-address))))
2775
2776 \f
2777
2778 (defun message-insert-to (&optional force)
2779   "Insert a To header that points to the author of the article being replied to.
2780 If the original author requested not to be sent mail, don't insert unless the
2781 prefix FORCE is given."
2782   (interactive "P")
2783   (let* ((mct (message-fetch-reply-field "mail-copies-to"))
2784          (dont (and mct (or (equal (downcase mct) "never")
2785                             (equal (downcase mct) "nobody"))))
2786          (to (or (message-fetch-reply-field "mail-reply-to")
2787                  (message-fetch-reply-field "reply-to")
2788                  (message-fetch-reply-field "from"))))
2789     (when (and dont to)
2790       (message
2791        (if force
2792            "Ignoring the user request not to have copies sent via mail"
2793          "Complying with the user request not to have copies sent via mail")))
2794     (when (and force (not to))
2795       (error "No mail address in the article"))
2796     (when (and to (or force (not dont)))
2797       (message-carefully-insert-headers (list (cons 'To to))))))
2798
2799 (defun message-insert-wide-reply ()
2800   "Insert To and Cc headers as if you were doing a wide reply."
2801   (interactive)
2802   (let ((headers (message-with-reply-buffer
2803                    (message-get-reply-headers t))))
2804     (message-carefully-insert-headers headers)))
2805
2806 (defcustom message-header-synonyms
2807   '((To Cc Bcc))
2808   "List of lists of header synonyms.
2809 E.g., if this list contains a member list with elements `Cc' and `To',
2810 then `message-carefully-insert-headers' will not insert a `To' header
2811 when the message is already `Cc'ed to the recipient."
2812   :version "22.1"
2813   :group 'message-headers
2814   :link '(custom-manual "(message)Message Headers")
2815   :type '(repeat sexp))
2816
2817 (defun message-carefully-insert-headers (headers)
2818   "Insert the HEADERS, an alist, into the message buffer.
2819 Does not insert the headers when they are already present there
2820 or in the synonym headers, defined by `message-header-synonyms'."
2821   ;; FIXME: Should compare only the address and not the full name.  Comparison
2822   ;; should be done case-folded (and with `string=' rather than
2823   ;; `string-match').
2824   ;; (mail-strip-quoted-names "Foo Bar <foo@bar>, bla@fasel (Bla Fasel)")
2825   (dolist (header headers)
2826     (let* ((header-name (symbol-name (car header)))
2827            (new-header (cdr header))
2828            (synonyms (loop for synonym in message-header-synonyms
2829                            when (memq (car header) synonym) return synonym))
2830            (old-header
2831             (loop for synonym in synonyms
2832                   for old-header = (mail-fetch-field (symbol-name synonym))
2833                   when (and old-header (string-match new-header old-header))
2834                   return synonym)))
2835       (if old-header
2836           (message "already have `%s' in `%s'" new-header old-header)
2837         (when (and (message-position-on-field header-name)
2838                    (setq old-header (mail-fetch-field header-name))
2839                    (not (string-match "\\` *\\'" old-header)))
2840           (insert ", "))
2841         (insert new-header)))))
2842
2843 (defun message-widen-reply ()
2844   "Widen the reply to include maximum recipients."
2845   (interactive)
2846   (let ((follow-to
2847          (and message-reply-buffer
2848               (buffer-name message-reply-buffer)
2849               (save-excursion
2850                 (set-buffer message-reply-buffer)
2851                 (message-get-reply-headers t)))))
2852     (save-excursion
2853       (save-restriction
2854         (message-narrow-to-headers)
2855         (dolist (elem follow-to)
2856           (message-remove-header (symbol-name (car elem)))
2857           (goto-char (point-min))
2858           (insert (symbol-name (car elem)) ": "
2859                   (cdr elem) "\n"))))))
2860
2861 (defun message-insert-newsgroups ()
2862   "Insert the Newsgroups header from the article being replied to."
2863   (interactive)
2864   (when (and (message-position-on-field "Newsgroups")
2865              (mail-fetch-field "newsgroups")
2866              (not (string-match "\\` *\\'" (mail-fetch-field "newsgroups"))))
2867     (insert ","))
2868   (insert (or (message-fetch-reply-field "newsgroups") "")))
2869
2870 \f
2871
2872 ;;; Various commands
2873
2874 (defun message-delete-not-region (beg end)
2875   "Delete everything in the body of the current message outside of the region."
2876   (interactive "r")
2877   (let (citeprefix)
2878     (save-excursion
2879       (goto-char beg)
2880       ;; snarf citation prefix, if appropriate
2881       (unless (eq (point) (progn (beginning-of-line) (point)))
2882         (when (looking-at message-cite-prefix-regexp)
2883           (setq citeprefix (match-string 0))))
2884       (goto-char end)
2885       (delete-region (point) (if (not (message-goto-signature))
2886                                  (point)
2887                                (forward-line -2)
2888                                (point)))
2889       (insert "\n")
2890       (goto-char beg)
2891       (delete-region beg (progn (message-goto-body)
2892                                 (forward-line 2)
2893                                 (point)))
2894       (when citeprefix
2895         (insert citeprefix))))
2896   (when (message-goto-signature)
2897     (forward-line -2)))
2898
2899 (defun message-kill-to-signature (&optional arg)
2900   "Kill all text up to the signature.
2901 If a numberic argument or prefix arg is given, leave that number
2902 of lines before the signature intact."
2903   (interactive "p")
2904   (save-excursion
2905     (save-restriction
2906       (let ((point (point)))
2907         (narrow-to-region point (point-max))
2908         (message-goto-signature)
2909         (unless (eobp)
2910           (if (and arg (numberp arg))
2911               (forward-line (- -1 arg))
2912             (end-of-line -1)))
2913         (unless (= point (point))
2914           (kill-region point (point))
2915           (unless (bolp)
2916             (insert "\n")))))))
2917
2918 (defun message-newline-and-reformat (&optional arg not-break)
2919   "Insert four newlines, and then reformat if inside quoted text.
2920 Prefix arg means justify as well."
2921   (interactive (list (if current-prefix-arg 'full)))
2922   (let (quoted point beg end leading-space bolp fill-paragraph-function)
2923     (setq point (point))
2924     (beginning-of-line)
2925     (setq beg (point))
2926     (setq bolp (= beg point))
2927     ;; Find first line of the paragraph.
2928     (if not-break
2929         (while (and (not (eobp))
2930                     (not (looking-at message-cite-prefix-regexp))
2931                     (looking-at paragraph-start))
2932           (forward-line 1)))
2933     ;; Find the prefix
2934     (when (looking-at message-cite-prefix-regexp)
2935       (setq quoted (match-string 0))
2936       (goto-char (match-end 0))
2937       (looking-at "[ \t]*")
2938       (setq leading-space (match-string 0)))
2939     (if (and quoted
2940              (not not-break)
2941              (not bolp)
2942              (< (- point beg) (length quoted)))
2943         ;; break inside the cite prefix.
2944         (setq quoted nil
2945               end nil))
2946     (if quoted
2947         (progn
2948           (forward-line 1)
2949           (while (and (not (eobp))
2950                       (not (looking-at paragraph-separate))
2951                       (looking-at message-cite-prefix-regexp)
2952                       (equal quoted (match-string 0)))
2953             (goto-char (match-end 0))
2954             (looking-at "[ \t]*")
2955             (if (> (length leading-space) (length (match-string 0)))
2956                 (setq leading-space (match-string 0)))
2957             (forward-line 1))
2958           (setq end (point))
2959           (goto-char beg)
2960           (while (and (if (bobp) nil (forward-line -1) t)
2961                       (not (looking-at paragraph-start))
2962                       (looking-at message-cite-prefix-regexp)
2963                       (equal quoted (match-string 0)))
2964             (setq beg (point))
2965             (goto-char (match-end 0))
2966             (looking-at "[ \t]*")
2967             (if (> (length leading-space) (length (match-string 0)))
2968                 (setq leading-space (match-string 0)))))
2969       (while (and (not (eobp))
2970                   (not (looking-at paragraph-separate))
2971                   (not (looking-at message-cite-prefix-regexp)))
2972         (forward-line 1))
2973       (setq end (point))
2974       (goto-char beg)
2975       (while (and (if (bobp) nil (forward-line -1) t)
2976                   (not (looking-at paragraph-start))
2977                   (not (looking-at message-cite-prefix-regexp)))
2978         (setq beg (point))))
2979     (goto-char point)
2980     (save-restriction
2981       (narrow-to-region beg end)
2982       (if not-break
2983           (setq point nil)
2984         (if bolp
2985             (newline)
2986           (newline)
2987           (newline))
2988         (setq point (point))
2989         ;; (newline 2) doesn't mark both newline's as hard, so call
2990         ;; newline twice. -jas
2991         (newline)
2992         (newline)
2993         (delete-region (point) (re-search-forward "[ \t]*"))
2994         (when (and quoted (not bolp))
2995           (insert quoted leading-space)))
2996       (undo-boundary)
2997       (if quoted
2998           (let* ((adaptive-fill-regexp
2999                   (regexp-quote (concat quoted leading-space)))
3000                  (adaptive-fill-first-line-regexp
3001                   adaptive-fill-regexp ))
3002             (fill-paragraph arg))
3003         (fill-paragraph arg))
3004       (if point (goto-char point)))))
3005
3006 (defun message-fill-paragraph (&optional arg)
3007   "Message specific function to fill a paragraph.
3008 This function is used as the value of `fill-paragraph-function' in
3009 Message buffers and is not meant to be called directly."
3010   (interactive (list (if current-prefix-arg 'full)))
3011   (if (if (boundp 'filladapt-mode) filladapt-mode)
3012       nil
3013     (if (message-point-in-header-p)
3014         (message-fill-field)
3015       (message-newline-and-reformat arg t))
3016     t))
3017
3018 ;; Is it better to use `mail-header-end'?
3019 (defun message-point-in-header-p ()
3020   "Return t if point is in the header."
3021   (save-excursion
3022     (let ((p (point)))
3023       (goto-char (point-min))
3024       (not (re-search-forward
3025             (concat "^" (regexp-quote mail-header-separator) "\n")
3026             p t)))))
3027
3028 (defun message-do-auto-fill ()
3029   "Like `do-auto-fill', but don't fill in message header."
3030   (unless (message-point-in-header-p)
3031     (do-auto-fill)))
3032
3033 (defun message-insert-signature (&optional force)
3034   "Insert a signature.  See documentation for variable `message-signature'."
3035   (interactive (list 0))
3036   (let* ((signature
3037           (cond
3038            ((and (null message-signature)
3039                  (eq force 0))
3040             (save-excursion
3041               (goto-char (point-max))
3042               (not (re-search-backward message-signature-separator nil t))))
3043            ((and (null message-signature)
3044                  force)
3045             t)
3046            ((functionp message-signature)
3047             (funcall message-signature))
3048            ((listp message-signature)
3049             (eval message-signature))
3050            (t message-signature)))
3051          (signature
3052           (cond ((stringp signature)
3053                  signature)
3054                 ((and (eq t signature)
3055                       message-signature-file
3056                       (file-exists-p message-signature-file))
3057                  signature))))
3058     (when signature
3059       (goto-char (point-max))
3060       ;; Insert the signature.
3061       (unless (bolp)
3062         (insert "\n"))
3063       (when message-signature-insert-empty-line
3064         (insert "\n"))
3065       (insert "-- \n")
3066       (if (eq signature t)
3067           (insert-file-contents message-signature-file)
3068         (insert signature))
3069       (goto-char (point-max))
3070       (or (bolp) (insert "\n")))))
3071
3072 (defun message-insert-importance-high ()
3073   "Insert header to mark message as important."
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: high\n")))
3081
3082 (defun message-insert-importance-low ()
3083   "Insert header to mark message as unimportant."
3084   (interactive)
3085   (save-excursion
3086     (save-restriction
3087       (message-narrow-to-headers)
3088       (message-remove-header "Importance"))
3089     (message-goto-eoh)
3090     (insert "Importance: low\n")))
3091
3092 (defun message-insert-or-toggle-importance ()
3093   "Insert a \"Importance: high\" header, or cycle through the header values.
3094 The three allowed values according to RFC 1327 are `high', `normal'
3095 and `low'."
3096   (interactive)
3097   (save-excursion
3098     (let ((valid '("high" "normal" "low"))
3099           (new "high")
3100           cur)
3101       (save-restriction
3102         (message-narrow-to-headers)
3103         (when (setq cur (message-fetch-field "Importance"))
3104           (message-remove-header "Importance")
3105           (setq new (cond ((string= cur "high")
3106                            "low")
3107                           ((string= cur "low")
3108                            "normal")
3109                           (t
3110                            "high")))))
3111       (message-goto-eoh)
3112       (insert (format "Importance: %s\n" new)))))
3113
3114 (defun message-insert-disposition-notification-to ()
3115   "Request a disposition notification (return receipt) to this message.
3116 Note that this should not be used in newsgroups."
3117   (interactive)
3118   (save-excursion
3119     (save-restriction
3120       (message-narrow-to-headers)
3121       (message-remove-header "Disposition-Notification-To"))
3122     (message-goto-eoh)
3123     (insert (format "Disposition-Notification-To: %s\n"
3124                     (or (message-field-value "Reply-to")
3125                         (message-field-value "From")
3126                         (message-make-from))))))
3127
3128 (defun message-elide-region (b e)
3129   "Elide the text in the region.
3130 An ellipsis (from `message-elide-ellipsis') will be inserted where the
3131 text was killed."
3132   (interactive "r")
3133   (kill-region b e)
3134   (insert message-elide-ellipsis))
3135
3136 (defvar message-caesar-translation-table nil)
3137
3138 (defun message-caesar-region (b e &optional n)
3139   "Caesar rotate region B to E by N, default 13, for decrypting netnews."
3140   (interactive
3141    (list
3142     (min (point) (or (mark t) (point)))
3143     (max (point) (or (mark t) (point)))
3144     (when current-prefix-arg
3145       (prefix-numeric-value current-prefix-arg))))
3146
3147   (setq n (if (numberp n) (mod n 26) 13)) ;canonize N
3148   (unless (or (zerop n)                 ; no action needed for a rot of 0
3149               (= b e))                  ; no region to rotate
3150     ;; We build the table, if necessary.
3151     (when (or (not message-caesar-translation-table)
3152               (/= (aref message-caesar-translation-table ?a) (+ ?a n)))
3153       (setq message-caesar-translation-table
3154             (message-make-caesar-translation-table n)))
3155     (translate-region b e message-caesar-translation-table)))
3156
3157 (defun message-make-caesar-translation-table (n)
3158   "Create a rot table with offset N."
3159   (let ((i -1)
3160         (table (make-string 256 0)))
3161     (while (< (incf i) 256)
3162       (aset table i i))
3163     (concat
3164      (substring table 0 ?A)
3165      (substring table (+ ?A n) (+ ?A n (- 26 n)))
3166      (substring table ?A (+ ?A n))
3167      (substring table (+ ?A 26) ?a)
3168      (substring table (+ ?a n) (+ ?a n (- 26 n)))
3169      (substring table ?a (+ ?a n))
3170      (substring table (+ ?a 26) 255))))
3171
3172 (defun message-caesar-buffer-body (&optional rotnum)
3173   "Caesar rotate all letters in the current buffer by 13 places.
3174 Used to encode/decode possibly offensive messages (commonly in rec.humor).
3175 With prefix arg, specifies the number of places to rotate each letter forward.
3176 Mail and USENET news headers are not rotated."
3177   (interactive (if current-prefix-arg
3178                    (list (prefix-numeric-value current-prefix-arg))
3179                  (list nil)))
3180   (save-excursion
3181     (save-restriction
3182       (when (message-goto-body)
3183         (narrow-to-region (point) (point-max)))
3184       (message-caesar-region (point-min) (point-max) rotnum))))
3185
3186 (defun message-pipe-buffer-body (program)
3187   "Pipe the message body in the current buffer through PROGRAM."
3188   (save-excursion
3189     (save-restriction
3190       (when (message-goto-body)
3191         (narrow-to-region (point) (point-max)))
3192       (shell-command-on-region
3193        (point-min) (point-max) program nil t))))
3194
3195 (defun message-rename-buffer (&optional enter-string)
3196   "Rename the *message* buffer to \"*message* RECIPIENT\".
3197 If the function is run with a prefix, it will ask for a new buffer
3198 name, rather than giving an automatic name."
3199   (interactive "Pbuffer name: ")
3200   (save-excursion
3201     (save-restriction
3202       (goto-char (point-min))
3203       (narrow-to-region (point)
3204                         (search-forward mail-header-separator nil 'end))
3205       (let* ((mail-to (or
3206                        (if (message-news-p) (message-fetch-field "Newsgroups")
3207                          (message-fetch-field "To"))
3208                        ""))
3209              (mail-trimmed-to
3210               (if (string-match "," mail-to)
3211                   (concat (substring mail-to 0 (match-beginning 0)) ", ...")
3212                 mail-to))
3213              (name-default (concat "*message* " mail-trimmed-to))
3214              (name (if enter-string
3215                        (read-string "New buffer name: " name-default)
3216                      name-default)))
3217         (rename-buffer name t)))))
3218
3219 (defun message-fill-yanked-message (&optional justifyp)
3220   "Fill the paragraphs of a message yanked into this one.
3221 Numeric argument means justify as well."
3222   (interactive "P")
3223   (save-excursion
3224     (goto-char (point-min))
3225     (search-forward (concat "\n" mail-header-separator "\n") nil t)
3226     (let ((fill-prefix message-yank-prefix))
3227       (fill-individual-paragraphs (point) (point-max) justifyp))))
3228
3229 (defun message-indent-citation ()
3230   "Modify text just inserted from a message to be cited.
3231 The inserted text should be the region.
3232 When this function returns, the region is again around the modified text.
3233
3234 Normally, indent each nonblank line `message-indentation-spaces' spaces.
3235 However, if `message-yank-prefix' is non-nil, insert that prefix on each line."
3236   (let ((start (point)))
3237     ;; Remove unwanted headers.
3238     (when message-ignored-cited-headers
3239       (let (all-removed)
3240         (save-restriction
3241           (narrow-to-region
3242            (goto-char start)
3243            (if (search-forward "\n\n" nil t)
3244                (1- (point))
3245              (point)))
3246           (message-remove-header message-ignored-cited-headers t)
3247           (when (= (point-min) (point-max))
3248             (setq all-removed t))
3249           (goto-char (point-max)))
3250         (if all-removed
3251             (goto-char start)
3252           (forward-line 1))))
3253     ;; Delete blank lines at the start of the buffer.
3254     (while (and (point-min)
3255                 (eolp)
3256                 (not (eobp)))
3257       (message-delete-line))
3258     ;; Delete blank lines at the end of the buffer.
3259     (goto-char (point-max))
3260     (unless (eolp)
3261       (insert "\n"))
3262     (while (and (zerop (forward-line -1))
3263                 (looking-at "$"))
3264       (message-delete-line))
3265     ;; Do the indentation.
3266     (if (null message-yank-prefix)
3267         (indent-rigidly start (mark t) message-indentation-spaces)
3268       (save-excursion
3269         (goto-char start)
3270         (while (< (point) (mark t))
3271           (cond ((looking-at ">")
3272                  (insert message-yank-cited-prefix))
3273                 ((looking-at "^$")
3274                  (insert message-yank-empty-prefix))
3275                 (t
3276                  (insert message-yank-prefix)))
3277           (forward-line 1))))
3278     (goto-char start)))
3279
3280 (defun message-yank-original (&optional arg)
3281   "Insert the message being replied to, if any.
3282 Puts point before the text and mark after.
3283 Normally indents each nonblank line ARG spaces (default 3).  However,
3284 if `message-yank-prefix' is non-nil, insert that prefix on each line.
3285
3286 This function uses `message-cite-function' to do the actual citing.
3287
3288 Just \\[universal-argument] as argument means don't indent, insert no
3289 prefix, and don't delete any headers."
3290   (interactive "P")
3291   (let ((modified (buffer-modified-p)))
3292     (when (and message-reply-buffer
3293                message-cite-function)
3294       (delete-windows-on message-reply-buffer t)
3295       (push-mark (save-excursion
3296                    (insert-buffer-substring message-reply-buffer)
3297                    (point)))
3298       (unless arg
3299         (funcall message-cite-function))
3300       (message-exchange-point-and-mark)
3301       (unless (bolp)
3302         (insert ?\n))
3303       (unless modified
3304         (setq message-checksum (message-checksum))))))
3305
3306 (defun message-yank-buffer (buffer)
3307   "Insert BUFFER into the current buffer and quote it."
3308   (interactive "bYank buffer: ")
3309   (let ((message-reply-buffer (get-buffer buffer)))
3310     (save-window-excursion
3311       (message-yank-original))))
3312
3313 (defun message-buffers ()
3314   "Return a list of active message buffers."
3315   (let (buffers)
3316     (save-excursion
3317       (dolist (buffer (buffer-list t))
3318         (set-buffer buffer)
3319         (when (and (eq major-mode 'message-mode)
3320                    (null message-sent-message-via))
3321           (push (buffer-name buffer) buffers))))
3322     (nreverse buffers)))
3323
3324 (eval-when-compile (defvar mail-citation-hook)) ; Compiler directive
3325
3326 (defun message-cite-original-1 (strip-signature)
3327   "Cite an original message.
3328 If STRIP-SIGNATURE is non-nil, strips off the signature from the
3329 original message.
3330
3331 This function uses `mail-citation-hook' if that is non-nil."
3332   (if (and (boundp 'mail-citation-hook)
3333            mail-citation-hook)
3334       (run-hooks 'mail-citation-hook)
3335     (let* ((start (point))
3336            (end (mark t))
3337            (x-no-archive nil)
3338            (functions
3339             (when message-indent-citation-function
3340               (if (listp message-indent-citation-function)
3341                   message-indent-citation-function
3342                 (list message-indent-citation-function))))
3343            ;; This function may be called by `gnus-summary-yank-message' and
3344            ;; may insert a different article from the original.  So, we will
3345            ;; modify the value of `message-reply-headers' with that article.
3346            (message-reply-headers
3347             (save-restriction
3348               (narrow-to-region start end)
3349               (message-narrow-to-head-1)
3350               (setq x-no-archive (message-fetch-field "x-no-archive"))
3351               (vector 0
3352                       (or (message-fetch-field "subject") "none")
3353                       (message-fetch-field "from")
3354                       (message-fetch-field "date")
3355                       (message-fetch-field "message-id" t)
3356                       (message-fetch-field "references")
3357                       0 0 ""))))
3358       (mml-quote-region start end)
3359       (when strip-signature
3360         ;; Allow undoing.
3361         (undo-boundary)
3362         (goto-char end)
3363         (when (re-search-backward message-signature-separator start t)
3364           ;; Also peel off any blank lines before the signature.
3365           (forward-line -1)
3366           (while (looking-at "^[ \t]*$")
3367             (forward-line -1))
3368           (forward-line 1)
3369           (delete-region (point) end)
3370           (unless (search-backward "\n\n" start t)
3371             ;; Insert a blank line if it is peeled off.
3372             (insert "\n"))))
3373       (goto-char start)
3374       (mapc 'funcall functions)
3375       (when message-citation-line-function
3376         (unless (bolp)
3377           (insert "\n"))
3378         (funcall message-citation-line-function))
3379       (when (and x-no-archive
3380                  (not message-cite-articles-with-x-no-archive)
3381                  (string-match "yes" x-no-archive))
3382         (undo-boundary)
3383         (delete-region (point) (mark t))
3384         (insert "> [Quoted text removed due to X-No-Archive]\n")
3385         (forward-line -1)))))
3386
3387 (defun message-cite-original ()
3388   "Cite function in the standard Message manner."
3389   (message-cite-original-1 nil))
3390
3391 (defun message-cite-original-without-signature ()
3392   "Cite function in the standard Message manner.
3393 This function strips off the signature from the original message."
3394   (message-cite-original-1 t))
3395
3396 (defun message-insert-citation-line ()
3397   "Insert a simple citation line."
3398   (when message-reply-headers
3399     (insert (mail-header-from message-reply-headers) " writes:\n\n")))
3400
3401 (defun message-position-on-field (header &rest afters)
3402   (let ((case-fold-search t))
3403     (save-restriction
3404       (narrow-to-region
3405        (goto-char (point-min))
3406        (progn
3407          (re-search-forward
3408           (concat "^" (regexp-quote mail-header-separator) "$"))
3409          (match-beginning 0)))
3410       (goto-char (point-min))
3411       (if (re-search-forward (concat "^" (regexp-quote header) ":") nil t)
3412           (progn
3413             (re-search-forward "^[^ \t]" nil 'move)
3414             (beginning-of-line)
3415             (skip-chars-backward "\n")
3416             t)
3417         (while (and afters
3418                     (not (re-search-forward
3419                           (concat "^" (regexp-quote (car afters)) ":")
3420                           nil t)))
3421           (pop afters))
3422         (when afters
3423           (re-search-forward "^[^ \t]" nil 'move)
3424           (beginning-of-line))
3425         (insert header ": \n")
3426         (forward-char -1)
3427         nil))))
3428
3429 (defun message-remove-signature ()
3430   "Remove the signature from the text between point and mark.
3431 The text will also be indented the normal way."
3432   (save-excursion
3433     (let ((start (point))
3434           mark)
3435       (if (not (re-search-forward message-signature-separator (mark t) t))
3436           ;; No signature here, so we just indent the cited text.
3437           (message-indent-citation)
3438         ;; Find the last non-empty line.
3439         (forward-line -1)
3440         (while (looking-at "[ \t]*$")
3441           (forward-line -1))
3442         (forward-line 1)
3443         (setq mark (set-marker (make-marker) (point)))
3444         (goto-char start)
3445         (message-indent-citation)
3446         ;; Enable undoing the deletion.
3447         (undo-boundary)
3448         (delete-region mark (mark t))
3449         (set-marker mark nil)))))
3450
3451 \f
3452
3453 ;;;
3454 ;;; Sending messages
3455 ;;;
3456
3457 (defun message-send-and-exit (&optional arg)
3458   "Send message like `message-send', then, if no errors, exit from mail buffer."
3459   (interactive "P")
3460   (let ((buf (current-buffer))
3461         (actions message-exit-actions))
3462     (when (and (message-send arg)
3463                (buffer-name buf))
3464       (if message-kill-buffer-on-exit
3465           (kill-buffer buf)
3466         (bury-buffer buf)
3467         (when (eq buf (current-buffer))
3468           (message-bury buf)))
3469       (message-do-actions actions)
3470       t)))
3471
3472 (defun message-dont-send ()
3473   "Don't send the message you have been editing.
3474 Instead, just auto-save the buffer and then bury it."
3475   (interactive)
3476   (set-buffer-modified-p t)
3477   (save-buffer)
3478   (let ((actions message-postpone-actions))
3479     (message-bury (current-buffer))
3480     (message-do-actions actions)))
3481
3482 (defun message-kill-buffer ()
3483   "Kill the current buffer."
3484   (interactive)
3485   (when (or (not (buffer-modified-p))
3486             (not message-kill-buffer-query)
3487             (yes-or-no-p "Message modified; kill anyway? "))
3488     (let ((actions message-kill-actions)
3489           (draft-article message-draft-article)
3490           (auto-save-file-name buffer-auto-save-file-name)
3491           (file-name buffer-file-name)
3492           (modified (buffer-modified-p)))
3493       (setq buffer-file-name nil)
3494       (kill-buffer (current-buffer))
3495       (when (and (or (and auto-save-file-name
3496                           (file-exists-p auto-save-file-name))
3497                      (and file-name
3498                           (file-exists-p file-name)))
3499                  (progn
3500                    ;; If the message buffer has lived in a dedicated window,
3501                    ;; `kill-buffer' has killed the frame.  Thus the
3502                    ;; `yes-or-no-p' may show up in a lowered frame.  Make sure
3503                    ;; that the user can see the question by raising the
3504                    ;; current frame:
3505                    (raise-frame)
3506                    (yes-or-no-p (format "Remove the backup file%s? "
3507                                         (if modified " too" "")))))
3508         (ignore-errors
3509           (delete-file auto-save-file-name))
3510         (let ((message-draft-article draft-article))
3511           (message-disassociate-draft)))
3512       (message-do-actions actions))))
3513
3514 (defun message-bury (buffer)
3515   "Bury this mail BUFFER."
3516   (let ((newbuf (other-buffer buffer)))
3517     (bury-buffer buffer)
3518     (if (and (window-dedicated-p (selected-window))
3519              (not (null (delq (selected-frame) (visible-frame-list)))))
3520         (delete-frame (selected-frame))
3521       (switch-to-buffer newbuf))))
3522
3523 (defun message-send (&optional arg)
3524   "Send the message in the current buffer.
3525 If `message-interactive' is non-nil, wait for success indication or
3526 error messages, and inform user.
3527 Otherwise any failure is reported in a message back to the user from
3528 the mailer.
3529 The usage of ARG is defined by the instance that called Message.
3530 It should typically alter the sending method in some way or other."
3531   (interactive "P")
3532   ;; Make it possible to undo the coming changes.
3533   (undo-boundary)
3534   (let ((inhibit-read-only t))
3535     (put-text-property (point-min) (point-max) 'read-only nil))
3536   (message-fix-before-sending)
3537   (run-hooks 'message-send-hook)
3538   (message message-sending-message)
3539   (let ((alist message-send-method-alist)
3540         (success t)
3541         elem sent dont-barf-on-no-method
3542         (message-options message-options))
3543     (message-options-set-recipient)
3544     (while (and success
3545                 (setq elem (pop alist)))
3546       (when (funcall (cadr elem))
3547         (when (and (or (not (memq (car elem)
3548                                   message-sent-message-via))
3549                        (message-fetch-field "supersedes")
3550                        (if (or (message-gnksa-enable-p 'multiple-copies)
3551                                (not (eq (car elem) 'news)))
3552                            (y-or-n-p
3553                             (format
3554                              "Already sent message via %s; resend? "
3555                              (car elem)))
3556                          (error "Denied posting -- multiple copies")))
3557                    (setq success (funcall (caddr elem) arg)))
3558           (setq sent t))))
3559     (unless (or sent
3560                 (not success)
3561                 (let ((fcc (message-fetch-field "Fcc"))
3562                       (gcc (message-fetch-field "Gcc")))
3563                   (when (or fcc gcc)
3564                     (or (eq message-allow-no-recipients 'always)
3565                         (and (not (eq message-allow-no-recipients 'never))
3566                              (setq dont-barf-on-no-method
3567                                    (gnus-y-or-n-p
3568                                     (format "No receiver, perform %s anyway? "
3569                                             (cond ((and fcc gcc) "Fcc and Gcc")
3570                                                   (fcc "Fcc")
3571                                                   (t "Gcc"))))))))))
3572       (error "No methods specified to send by"))
3573     (when (or dont-barf-on-no-method
3574               (and success sent))
3575       (message-do-fcc)
3576       (save-excursion
3577         (run-hooks 'message-sent-hook))
3578       (message "Sending...done")
3579       ;; Mark the buffer as unmodified and delete auto-save.
3580       (set-buffer-modified-p nil)
3581       (delete-auto-save-file-if-necessary t)
3582       (message-disassociate-draft)
3583       ;; Delete other mail buffers and stuff.
3584       (message-do-send-housekeeping)
3585       (message-do-actions message-send-actions)
3586       ;; Return success.
3587       t)))
3588
3589 (defun message-send-via-mail (arg)
3590   "Send the current message via mail."
3591   (message-send-mail arg))
3592
3593 (defun message-send-via-news (arg)
3594   "Send the current message via news."
3595   (funcall message-send-news-function arg))
3596
3597 (defmacro message-check (type &rest forms)
3598   "Eval FORMS if TYPE is to be checked."
3599   `(or (message-check-element ,type)
3600        (save-excursion
3601          ,@forms)))
3602
3603 (put 'message-check 'lisp-indent-function 1)
3604 (put 'message-check 'edebug-form-spec '(form body))
3605
3606 (defun message-text-with-property (prop &optional start end reverse)
3607   "Return a list of start and end positions where the text has PROP.
3608 START and END bound the search, they default to `point-min' and
3609 `point-max' respectively.  If REVERSE is non-nil, find text which does
3610 not have PROP."
3611   (unless start
3612     (setq start (point-min)))
3613   (unless end
3614     (setq end (point-max)))
3615   (let (next regions)
3616     (if reverse
3617         (while (and start
3618                     (setq start (text-property-any start end prop nil)))
3619           (setq next (next-single-property-change start prop nil end))
3620           (push (cons start (or next end)) regions)
3621           (setq start next))
3622       (while (and start
3623                   (or (get-text-property start prop)
3624                       (and (setq start (next-single-property-change
3625                                         start prop nil end))
3626                            (get-text-property start prop))))
3627         (setq next (text-property-any start end prop nil))
3628         (push (cons start (or next end)) regions)
3629         (setq start next)))
3630     (nreverse regions)))
3631
3632 (defun message-fix-before-sending ()
3633   "Do various things to make the message nice before sending it."
3634   ;; Make sure there's a newline at the end of the message.
3635   (goto-char (point-max))
3636   (unless (bolp)
3637     (insert "\n"))
3638   ;; Make the hidden headers visible.
3639   (widen)
3640   ;; Sort headers before sending the message.
3641   (message-sort-headers)
3642   ;; Make invisible text visible.
3643   ;; It doesn't seem as if this is useful, since the invisible property
3644   ;; is clobbered by an after-change hook anyhow.
3645   (message-check 'invisible-text
3646     (let ((regions (message-text-with-property 'invisible))
3647           from to)
3648       (when regions
3649         (while regions
3650           (setq from (caar regions)
3651                 to (cdar regions)
3652                 regions (cdr regions))
3653           (put-text-property from to 'invisible nil)
3654           (message-overlay-put (message-make-overlay from to)
3655                                'face 'highlight))
3656         (unless (yes-or-no-p
3657                  "Invisible text found and made visible; continue sending? ")
3658           (error "Invisible text found and made visible")))))
3659   (message-check 'illegible-text
3660     (let (found choice)
3661       (message-goto-body)
3662       (skip-chars-forward mm-7bit-chars)
3663       (while (not (eobp))
3664         (when (let ((char (char-after)))
3665                 (or (< (mm-char-int char) 128)
3666                     (and (mm-multibyte-p)
3667                          (memq (char-charset char)
3668                                '(eight-bit-control eight-bit-graphic
3669                                                    control-1))
3670                          (not (get-text-property
3671                                (point) 'untranslated-utf-8)))))
3672           (message-overlay-put (message-make-overlay (point) (1+ (point)))
3673                                'face 'highlight)
3674           (setq found t))
3675         (forward-char)
3676         (skip-chars-forward mm-7bit-chars))
3677       (when found
3678         (setq choice
3679               (gnus-multiple-choice
3680                "Non-printable characters found.  Continue sending?"
3681                '((?d "Remove non-printable characters and send")
3682                  (?r "Replace non-printable characters with dots and send")
3683                  (?i "Ignore non-printable characters and send")
3684                  (?e "Continue editing"))))
3685         (if (eq choice ?e)
3686           (error "Non-printable characters"))
3687         (message-goto-body)
3688         (skip-chars-forward mm-7bit-chars)
3689         (while (not (eobp))
3690           (when (let ((char (char-after)))
3691                   (or (< (mm-char-int char) 128)
3692                       (and (mm-multibyte-p)
3693                            ;; Fixme: Wrong for Emacs 22 and for things
3694                            ;; like undecable utf-8.  Should at least
3695                            ;; use find-coding-systems-region.
3696                            (memq (char-charset char)
3697                                  '(eight-bit-control eight-bit-graphic
3698                                                      control-1))
3699                            (not (get-text-property
3700                                  (point) 'untranslated-utf-8)))))
3701             (if (eq choice ?i)
3702                 (message-kill-all-overlays)
3703               (delete-char 1)
3704               (when (eq choice ?r)
3705                 (insert "."))))
3706           (forward-char)
3707           (skip-chars-forward mm-7bit-chars))))))
3708
3709 (defun message-add-action (action &rest types)
3710   "Add ACTION to be performed when doing an exit of type TYPES."
3711   (while types
3712     (add-to-list (intern (format "message-%s-actions" (pop types)))
3713                  action)))
3714
3715 (defun message-delete-action (action &rest types)
3716   "Delete ACTION from lists of actions performed when doing an exit of type TYPES."
3717   (let (var)
3718     (while types
3719       (set (setq var (intern (format "message-%s-actions" (pop types))))
3720            (delq action (symbol-value var))))))
3721
3722 (defun message-do-actions (actions)
3723   "Perform all actions in ACTIONS."
3724   ;; Now perform actions on successful sending.
3725   (dolist (action actions)
3726     (ignore-errors
3727       (cond
3728        ;; A simple function.
3729        ((functionp action)
3730         (funcall action))
3731        ;; Something to be evaled.
3732        (t
3733         (eval action))))))
3734
3735 (defun message-send-mail-partially ()
3736   "Send mail as message/partial."
3737   ;; replace the header delimiter with a blank line
3738   (goto-char (point-min))
3739   (re-search-forward
3740    (concat "^" (regexp-quote mail-header-separator) "\n"))
3741   (replace-match "\n")
3742   (run-hooks 'message-send-mail-hook)
3743   (let ((p (goto-char (point-min)))
3744         (tembuf (message-generate-new-buffer-clone-locals " message temp"))
3745         (curbuf (current-buffer))
3746         (id (message-make-message-id)) (n 1)
3747         plist total  header required-mail-headers)
3748     (while (not (eobp))
3749       (if (< (point-max) (+ p message-send-mail-partially-limit))
3750           (goto-char (point-max))
3751         (goto-char (+ p message-send-mail-partially-limit))
3752         (beginning-of-line)
3753         (if (<= (point) p) (forward-line 1))) ;; In case of bad message.
3754       (push p plist)
3755       (setq p (point)))
3756     (setq total (length plist))
3757     (push (point-max) plist)
3758     (setq plist (nreverse plist))
3759     (unwind-protect
3760         (save-excursion
3761           (setq p (pop plist))
3762           (while plist
3763             (set-buffer curbuf)
3764             (copy-to-buffer tembuf p (car plist))
3765             (set-buffer tembuf)
3766             (goto-char (point-min))
3767             (if header
3768                 (progn
3769                   (goto-char (point-min))
3770                   (narrow-to-region (point) (point))
3771                   (insert header))
3772               (message-goto-eoh)
3773               (setq header (buffer-substring (point-min) (point)))
3774               (goto-char (point-min))
3775               (narrow-to-region (point) (point))
3776               (insert header)
3777               (message-remove-header "Mime-Version")
3778               (message-remove-header "Content-Type")
3779               (message-remove-header "Content-Transfer-Encoding")
3780               (message-remove-header "Message-ID")
3781               (message-remove-header "Lines")
3782               (goto-char (point-max))
3783               (insert "Mime-Version: 1.0\n")
3784               (setq header (buffer-string)))
3785             (goto-char (point-max))
3786             (insert (format "Content-Type: message/partial; id=\"%s\"; number=%d; total=%d\n\n"
3787                             id n total))
3788             (forward-char -1)
3789             (let ((mail-header-separator ""))
3790               (when (memq 'Message-ID message-required-mail-headers)
3791                 (insert "Message-ID: " (message-make-message-id) "\n"))
3792               (when (memq 'Lines message-required-mail-headers)
3793                 (insert "Lines: " (message-make-lines) "\n"))
3794               (message-goto-subject)
3795               (end-of-line)
3796               (insert (format " (%d/%d)" n total))
3797               (widen)
3798               (mm-with-unibyte-current-buffer
3799                 (funcall (or message-send-mail-real-function
3800                              message-send-mail-function))))
3801             (setq n (+ n 1))
3802             (setq p (pop plist))
3803             (erase-buffer)))
3804       (kill-buffer tembuf))))
3805
3806 (defun message-send-mail (&optional arg)
3807   (require 'mail-utils)
3808   (let* ((tembuf (message-generate-new-buffer-clone-locals " message temp"))
3809          (case-fold-search nil)
3810          (news (message-news-p))
3811          (mailbuf (current-buffer))
3812          (message-this-is-mail t)
3813          (message-posting-charset
3814           (if (fboundp 'gnus-setup-posting-charset)
3815               (gnus-setup-posting-charset nil)
3816             message-posting-charset))
3817          (headers message-required-mail-headers))
3818     (when message-generate-hashcash
3819       (message "Generating hashcash...")
3820       ;; Wait for calculations already started to finish...
3821       (hashcash-wait-async)
3822       ;; ...and do calculations not already done.  mail-add-payment
3823       ;; will leave existing X-Hashcash headers alone.
3824       (mail-add-payment)
3825       (message "Generating hashcash...done"))
3826     (save-restriction
3827       (message-narrow-to-headers)
3828       ;; Generate the Mail-Followup-To header if the header is not there...
3829       (if (and (message-subscribed-p)
3830                (not (mail-fetch-field "mail-followup-to")))
3831           (setq headers
3832                 (cons
3833                  (cons "Mail-Followup-To" (message-make-mail-followup-to))
3834                  message-required-mail-headers))
3835         ;; otherwise, delete the MFT header if the field is empty
3836         (when (equal "" (mail-fetch-field "mail-followup-to"))
3837           (message-remove-header "^Mail-Followup-To:")))
3838       ;; Insert some headers.
3839       (let ((message-deletable-headers
3840              (if news nil message-deletable-headers)))
3841         (message-generate-headers headers))
3842       ;; Let the user do all of the above.
3843       (run-hooks 'message-header-hook))
3844     (unwind-protect
3845         (save-excursion
3846           (set-buffer tembuf)
3847           (erase-buffer)
3848           ;; Avoid copying text props (except hard newlines).
3849           (insert (with-current-buffer mailbuf
3850                     (mml-buffer-substring-no-properties-except-hard-newlines
3851                      (point-min) (point-max))))
3852           ;; Remove some headers.
3853           (message-encode-message-body)
3854           (save-restriction
3855             (message-narrow-to-headers)
3856             ;; We (re)generate the Lines header.
3857             (when (memq 'Lines message-required-mail-headers)
3858               (message-generate-headers '(Lines)))
3859             ;; Remove some headers.
3860             (message-remove-header message-ignored-mail-headers t)
3861             (let ((mail-parse-charset message-default-charset))
3862               (mail-encode-encoded-word-buffer)))
3863           (goto-char (point-max))
3864           ;; require one newline at the end.
3865           (or (= (preceding-char) ?\n)
3866               (insert ?\n))
3867           (message-cleanup-headers)
3868           ;; FIXME: we're inserting the courtesy copy after encoding.
3869           ;; This is wrong if the courtesy copy string contains
3870           ;; non-ASCII characters. -- jh
3871           (when
3872               (save-restriction
3873                 (message-narrow-to-headers)
3874                 (and news
3875                      (or (message-fetch-field "cc")
3876                          (message-fetch-field "bcc")
3877                          (message-fetch-field "to"))
3878                      (let ((content-type (message-fetch-field
3879                                           "content-type")))
3880                        (and
3881                         (or
3882                          (not content-type)
3883                          (string= "text/plain"
3884                                   (car
3885                                    (mail-header-parse-content-type
3886                                     content-type))))
3887                         (not
3888                          (string= "base64"
3889                                   (message-fetch-field
3890                                    "content-transfer-encoding")))))))
3891             (message-insert-courtesy-copy))
3892           (if (or (not message-send-mail-partially-limit)
3893                   (< (buffer-size) message-send-mail-partially-limit)
3894                   (not (message-y-or-n-p
3895                         "The message size is too large, split? "
3896                         t
3897                         "\
3898 The message size, "
3899                         (/ (buffer-size) 1000) "KB, is too large.
3900
3901 Some mail gateways (MTA's) bounce large messages.  To avoid the
3902 problem, answer `y', and the message will be split into several
3903 smaller pieces, the size of each is about "
3904                         (/ message-send-mail-partially-limit 1000)
3905                         "KB except the last
3906 one.
3907
3908 However, some mail readers (MUA's) can't read split messages, i.e.,
3909 mails in message/partially format. Answer `n', and the message will be
3910 sent in one piece.
3911
3912 The size limit is controlled by `message-send-mail-partially-limit'.
3913 If you always want Gnus to send messages in one piece, set
3914 `message-send-mail-partially-limit' to nil.
3915 ")))
3916               (mm-with-unibyte-current-buffer
3917                 (message "Sending via mail...")
3918                 (funcall (or message-send-mail-real-function
3919                              message-send-mail-function)))
3920             (message-send-mail-partially)))
3921       (kill-buffer tembuf))
3922     (set-buffer mailbuf)
3923     (push 'mail message-sent-message-via)))
3924
3925 (defun message-send-mail-with-sendmail ()
3926   "Send off the prepared buffer with sendmail."
3927   (let ((errbuf (if message-interactive
3928                     (message-generate-new-buffer-clone-locals
3929                      " sendmail errors")
3930                   0))
3931         resend-to-addresses delimline)
3932     (unwind-protect
3933         (progn
3934           (let ((case-fold-search t))
3935             (save-restriction
3936               (message-narrow-to-headers)
3937               (setq resend-to-addresses (message-fetch-field "resent-to")))
3938             ;; Change header-delimiter to be what sendmail expects.
3939             (goto-char (point-min))
3940             (re-search-forward
3941              (concat "^" (regexp-quote mail-header-separator) "\n"))
3942             (replace-match "\n")
3943             (backward-char 1)
3944             (setq delimline (point-marker))
3945             (run-hooks 'message-send-mail-hook)
3946             ;; Insert an extra newline if we need it to work around
3947             ;; Sun's bug that swallows newlines.
3948             (goto-char (1+ delimline))
3949             (when (eval message-mailer-swallows-blank-line)
3950               (newline))
3951             (when message-interactive
3952               (with-current-buffer errbuf
3953                 (erase-buffer))))
3954           (let* ((default-directory "/")
3955                  (coding-system-for-write message-send-coding-system)
3956                  (cpr (apply
3957                        'call-process-region
3958                        (append
3959                         (list (point-min) (point-max)
3960                               (if (boundp 'sendmail-program)
3961                                   sendmail-program
3962                                 "/usr/lib/sendmail")
3963                               nil errbuf nil "-oi")
3964                         ;; Always specify who from,
3965                         ;; since some systems have broken sendmails.
3966                         ;; But some systems are more broken with -f, so
3967                         ;; we'll let users override this.
3968                         (if (null message-sendmail-f-is-evil)
3969                             (list "-f" (message-sendmail-envelope-from)))
3970                         ;; These mean "report errors by mail"
3971                         ;; and "deliver in background".
3972                         (if (null message-interactive) '("-oem" "-odb"))
3973                         ;; Get the addresses from the message
3974                         ;; unless this is a resend.
3975                         ;; We must not do that for a resend
3976                         ;; because we would find the original addresses.
3977                         ;; For a resend, include the specific addresses.
3978                         (if resend-to-addresses
3979                             (list resend-to-addresses)
3980                           '("-t"))))))
3981             (unless (or (null cpr) (and (numberp cpr) (zerop cpr)))
3982               (error "Sending...failed with exit value %d" cpr)))
3983           (when message-interactive
3984             (save-excursion
3985               (set-buffer errbuf)
3986               (goto-char (point-min))
3987               (while (re-search-forward "\n+ *" nil t)
3988                 (replace-match "; "))
3989               (if (not (zerop (buffer-size)))
3990                   (error "Sending...failed to %s"
3991                          (buffer-string))))))
3992       (when (bufferp errbuf)
3993         (kill-buffer errbuf)))))
3994
3995 (defun message-send-mail-with-qmail ()
3996   "Pass the prepared message buffer to qmail-inject.
3997 Refer to the documentation for the variable `message-send-mail-function'
3998 to find out how to use this."
3999   ;; replace the header delimiter with a blank line
4000   (goto-char (point-min))
4001   (re-search-forward
4002    (concat "^" (regexp-quote mail-header-separator) "\n"))
4003   (replace-match "\n")
4004   (run-hooks 'message-send-mail-hook)
4005   ;; send the message
4006   (case
4007       (let ((coding-system-for-write message-send-coding-system))
4008         (apply
4009          'call-process-region (point-min) (point-max)
4010          message-qmail-inject-program nil nil nil
4011          ;; qmail-inject's default behaviour is to look for addresses on the
4012          ;; command line; if there're none, it scans the headers.
4013          ;; yes, it does The Right Thing w.r.t. Resent-To and it's kin.
4014          ;;
4015          ;; in general, ALL of qmail-inject's defaults are perfect for simply
4016          ;; reading a formatted (i. e., at least a To: or Resent-To header)
4017          ;; message from stdin.
4018          ;;
4019          ;; qmail also has the advantage of not having been raped by
4020          ;; various vendors, so we don't have to allow for that, either --
4021          ;; compare this with message-send-mail-with-sendmail and weep
4022          ;; for sendmail's lost innocence.
4023          ;;
4024          ;; all this is way cool coz it lets us keep the arguments entirely
4025          ;; free for -inject-arguments -- a big win for the user and for us
4026          ;; since we don't have to play that double-guessing game and the user
4027          ;; gets full control (no gestapo'ish -f's, for instance).  --sj
4028          (if (functionp message-qmail-inject-args)
4029              (funcall message-qmail-inject-args)
4030            message-qmail-inject-args)))
4031     ;; qmail-inject doesn't say anything on it's stdout/stderr,
4032     ;; we have to look at the retval instead
4033     (0 nil)
4034     (100 (error "qmail-inject reported permanent failure"))
4035     (111 (error "qmail-inject reported transient failure"))
4036     ;; should never happen
4037     (t   (error "qmail-inject reported unknown failure"))))
4038
4039 (defun message-send-mail-with-mh ()
4040   "Send the prepared message buffer with mh."
4041   (let ((mh-previous-window-config nil)
4042         (name (mh-new-draft-name)))
4043     (setq buffer-file-name name)
4044     ;; MH wants to generate these headers itself.
4045     (when message-mh-deletable-headers
4046       (let ((headers message-mh-deletable-headers))
4047         (while headers
4048           (goto-char (point-min))
4049           (and (re-search-forward
4050                 (concat "^" (symbol-name (car headers)) ": *") nil t)
4051                (message-delete-line))
4052           (pop headers))))
4053     (run-hooks 'message-send-mail-hook)
4054     ;; Pass it on to mh.
4055     (mh-send-letter)))
4056
4057 (defun message-smtpmail-send-it ()
4058   "Send the prepared message buffer with `smtpmail-send-it'.
4059 This only differs from `smtpmail-send-it' that this command evaluates
4060 `message-send-mail-hook' just before sending a message.  It is useful
4061 if your ISP requires the POP-before-SMTP authentication.  See the Gnus
4062 manual for details."
4063   (run-hooks 'message-send-mail-hook)
4064   (smtpmail-send-it))
4065
4066 (defun message-canlock-generate ()
4067   "Return a string that is non-trivial to guess.
4068 Do not use this for anything important, it is cryptographically weak."
4069   (require 'sha1)
4070   (let (sha1-maximum-internal-length)
4071     (sha1 (concat (message-unique-id)
4072                   (format "%x%x%x" (random) (random t) (random))
4073                   (prin1-to-string (recent-keys))
4074                   (prin1-to-string (garbage-collect))))))
4075
4076 (defun message-canlock-password ()
4077   "The password used by message for cancel locks.
4078 This is the value of `canlock-password', if that option is non-nil.
4079 Otherwise, generate and save a value for `canlock-password' first."
4080   (unless canlock-password
4081     (customize-save-variable 'canlock-password (message-canlock-generate))
4082     (setq canlock-password-for-verify canlock-password))
4083   canlock-password)
4084
4085 (defun message-insert-canlock ()
4086   (when message-insert-canlock
4087     (message-canlock-password)
4088     (canlock-insert-header)))
4089
4090 (defun message-send-news (&optional arg)
4091   (let* ((tembuf (message-generate-new-buffer-clone-locals " *message temp*"))
4092          (case-fold-search nil)
4093          (method (if (functionp message-post-method)
4094                      (funcall message-post-method arg)
4095                    message-post-method))
4096          (newsgroups-field (save-restriction
4097                             (message-narrow-to-headers-or-head)
4098                             (message-fetch-field "Newsgroups")))
4099          (followup-field (save-restriction
4100                            (message-narrow-to-headers-or-head)
4101                            (message-fetch-field "Followup-To")))
4102          ;; BUG: We really need to get the charset for each name in the
4103          ;; Newsgroups and Followup-To lines to allow crossposting
4104          ;; between group namess with incompatible character sets.
4105          ;; -- Per Abrahamsen <abraham@dina.kvl.dk> 2001-10-08.
4106          (group-field-charset
4107           (gnus-group-name-charset method newsgroups-field))
4108          (followup-field-charset
4109           (gnus-group-name-charset method (or followup-field "")))
4110          (rfc2047-header-encoding-alist
4111           (append (when group-field-charset
4112                     (list (cons "Newsgroups" group-field-charset)))
4113                   (when followup-field-charset
4114                     (list (cons "Followup-To" followup-field-charset)))
4115                   rfc2047-header-encoding-alist))
4116          (messbuf (current-buffer))
4117          (message-syntax-checks
4118           (if (and arg
4119                    (listp message-syntax-checks))
4120               (cons '(existing-newsgroups . disabled)
4121                     message-syntax-checks)
4122             message-syntax-checks))
4123          (message-this-is-news t)
4124          (message-posting-charset
4125           (gnus-setup-posting-charset newsgroups-field))
4126          result)
4127     (if (not (message-check-news-body-syntax))
4128         nil
4129       (save-restriction
4130         (message-narrow-to-headers)
4131         ;; Insert some headers.
4132         (message-generate-headers message-required-news-headers)
4133         (message-insert-canlock)
4134         ;; Let the user do all of the above.
4135         (run-hooks 'message-header-hook))
4136       ;; Note: This check will be disabled by the ".*" default value for
4137       ;; gnus-group-name-charset-group-alist. -- Pa 2001-10-07.
4138       (when (and group-field-charset
4139                  (listp message-syntax-checks))
4140         (setq message-syntax-checks
4141               (cons '(valid-newsgroups . disabled)
4142                     message-syntax-checks)))
4143       (message-cleanup-headers)
4144       (if (not (let ((message-post-method method))
4145                  (message-check-news-syntax)))
4146           nil
4147         (unwind-protect
4148             (save-excursion
4149               (set-buffer tembuf)
4150               (buffer-disable-undo)
4151               (erase-buffer)
4152               ;; Avoid copying text props (except hard newlines).
4153               (insert
4154                (with-current-buffer messbuf
4155                  (mml-buffer-substring-no-properties-except-hard-newlines
4156                   (point-min) (point-max))))
4157               (message-encode-message-body)
4158               ;; Remove some headers.
4159               (save-restriction
4160                 (message-narrow-to-headers)
4161                 ;; We (re)generate the Lines header.
4162                 (when (memq 'Lines message-required-mail-headers)
4163                   (message-generate-headers '(Lines)))
4164                 ;; Remove some headers.
4165                 (message-remove-header message-ignored-news-headers t)
4166                 (let ((mail-parse-charset message-default-charset))
4167                   (mail-encode-encoded-word-buffer)))
4168               (goto-char (point-max))
4169               ;; require one newline at the end.
4170               (or (= (preceding-char) ?\n)
4171                   (insert ?\n))
4172               (let ((case-fold-search t))
4173                 ;; Remove the delimiter.
4174                 (goto-char (point-min))
4175                 (re-search-forward
4176                  (concat "^" (regexp-quote mail-header-separator) "\n"))
4177                 (replace-match "\n")
4178                 (backward-char 1))
4179               (run-hooks 'message-send-news-hook)
4180               (gnus-open-server method)
4181               (message "Sending news via %s..." (gnus-server-string method))
4182               (setq result (let ((mail-header-separator ""))
4183                              (gnus-request-post method))))
4184           (kill-buffer tembuf))
4185         (set-buffer messbuf)
4186         (if result
4187             (push 'news message-sent-message-via)
4188           (message "Couldn't send message via news: %s"
4189                    (nnheader-get-report (car method)))
4190           nil)))))
4191
4192 ;;;
4193 ;;; Header generation & syntax checking.
4194 ;;;
4195
4196 (defun message-check-element (type)
4197   "Return non-nil if this TYPE is not to be checked."
4198   (if (eq message-syntax-checks 'dont-check-for-anything-just-trust-me)
4199       t
4200     (let ((able (assq type message-syntax-checks)))
4201       (and (consp able)
4202            (eq (cdr able) 'disabled)))))
4203
4204 (defun message-check-news-syntax ()
4205   "Check the syntax of the message."
4206   (save-excursion
4207     (save-restriction
4208       (widen)
4209       ;; We narrow to the headers and check them first.
4210       (save-excursion
4211         (save-restriction
4212           (message-narrow-to-headers)
4213           (message-check-news-header-syntax))))))
4214
4215 (defun message-check-news-header-syntax ()
4216   (and
4217    ;; Check Newsgroups header.
4218    (message-check 'newsgroups
4219      (let ((group (message-fetch-field "newsgroups")))
4220        (or
4221         (and group
4222              (not (string-match "\\`[ \t]*\\'" group)))
4223         (ignore
4224          (message
4225           "The newsgroups field is empty or missing.  Posting is denied.")))))
4226    ;; Check the Subject header.
4227    (message-check 'subject
4228      (let* ((case-fold-search t)
4229             (subject (message-fetch-field "subject")))
4230        (or
4231         (and subject
4232              (not (string-match "\\`[ \t]*\\'" subject)))
4233         (ignore
4234          (message
4235           "The subject field is empty or missing.  Posting is denied.")))))
4236    ;; Check for commands in Subject.
4237    (message-check 'subject-cmsg
4238      (if (string-match "^cmsg " (message-fetch-field "subject"))
4239          (y-or-n-p
4240           "The control code \"cmsg\" is in the subject.  Really post? ")
4241        t))
4242    ;; Check long header lines.
4243    (message-check 'long-header-lines
4244      (let ((start (point))
4245            (header nil)
4246            (length 0)
4247            found)
4248        (while (and (not found)
4249                    (re-search-forward "^\\([^ \t:]+\\): " nil t))
4250          (if (> (- (point) (match-beginning 0)) 998)
4251              (setq found t
4252                    length (- (point) (match-beginning 0)))
4253            (setq header (match-string-no-properties 1)))
4254          (setq start (match-beginning 0))
4255          (forward-line 1))
4256        (if found
4257            (y-or-n-p (format "Your %s header is too long (%d).  Really post? "
4258                              header length))
4259          t)))
4260    ;; Check for multiple identical headers.
4261    (message-check 'multiple-headers
4262      (let (found)
4263        (while (and (not found)
4264                    (re-search-forward "^[^ \t:]+: " nil t))
4265          (save-excursion
4266            (or (re-search-forward
4267                 (concat "^"
4268                         (regexp-quote
4269                          (setq found
4270                                (buffer-substring
4271                                 (match-beginning 0) (- (match-end 0) 2))))
4272                         ":")
4273                 nil t)
4274                (setq found nil))))
4275        (if found
4276            (y-or-n-p (format "Multiple %s headers.  Really post? " found))
4277          t)))
4278    ;; Check for Version and Sendsys.
4279    (message-check 'sendsys
4280      (if (re-search-forward "^Sendsys:\\|^Version:" nil t)
4281          (y-or-n-p
4282           (format "The article contains a %s command.  Really post? "
4283                   (buffer-substring (match-beginning 0)
4284                                     (1- (match-end 0)))))
4285        t))
4286    ;; See whether we can shorten Followup-To.
4287    (message-check 'shorten-followup-to
4288      (let ((newsgroups (message-fetch-field "newsgroups"))
4289            (followup-to (message-fetch-field "followup-to"))
4290            to)
4291        (when (and newsgroups
4292                   (string-match "," newsgroups)
4293                   (not followup-to)
4294                   (not
4295                    (zerop
4296                     (length
4297                      (setq to (completing-read
4298                                "Followups to (default no Followup-To header): "
4299                                (mapcar #'list
4300                                        (cons "poster"
4301                                              (message-tokenize-header
4302                                               newsgroups)))))))))
4303          (goto-char (point-min))
4304          (insert "Followup-To: " to "\n"))
4305        t))
4306    ;; Check "Shoot me".
4307    (message-check 'shoot
4308      (if (re-search-forward
4309           "Message-ID.*.i-did-not-set--mail-host-address--so-tickle-me" nil t)
4310          (y-or-n-p "You appear to have a misconfigured system.  Really post? ")
4311        t))
4312    ;; Check for Approved.
4313    (message-check 'approved
4314      (if (re-search-forward "^Approved:" nil t)
4315          (y-or-n-p "The article contains an Approved header.  Really post? ")
4316        t))
4317    ;; Check the Message-ID header.
4318    (message-check 'message-id
4319      (let* ((case-fold-search t)
4320             (message-id (message-fetch-field "message-id" t)))
4321        (or (not message-id)
4322            ;; Is there an @ in the ID?
4323            (and (string-match "@" message-id)
4324                 ;; Is there a dot in the ID?
4325                 (string-match "@[^.]*\\." message-id)
4326                 ;; Does the ID end with a dot?
4327                 (not (string-match "\\.>" message-id)))
4328            (y-or-n-p
4329             (format "The Message-ID looks strange: \"%s\".  Really post? "
4330                     message-id)))))
4331    ;; Check the Newsgroups & Followup-To headers.
4332    (message-check 'existing-newsgroups
4333      (let* ((case-fold-search t)
4334             (newsgroups (message-fetch-field "newsgroups"))
4335             (followup-to (message-fetch-field "followup-to"))
4336             (groups (message-tokenize-header
4337                      (if followup-to
4338                          (concat newsgroups "," followup-to)
4339                        newsgroups)))
4340             (post-method (if (functionp message-post-method)
4341                              (funcall message-post-method)
4342                            message-post-method))
4343             ;; KLUDGE to handle nnvirtual groups.  Doing this right
4344             ;; would probably involve a new nnoo function.
4345             ;; -- Per Abrahamsen <abraham@dina.kvl.dk>, 2001-10-17.
4346             (method (if (and (consp post-method)
4347                              (eq (car post-method) 'nnvirtual)
4348                              gnus-message-group-art)
4349                         (let ((group (car (nnvirtual-find-group-art
4350                                            (car gnus-message-group-art)
4351                                            (cdr gnus-message-group-art)))))
4352                           (gnus-find-method-for-group group))
4353                       post-method))
4354             (known-groups
4355              (mapcar (lambda (n)
4356                        (gnus-group-name-decode
4357                         (gnus-group-real-name n)
4358                         (gnus-group-name-charset method n)))
4359                      (gnus-groups-from-server method)))
4360             errors)
4361        (while groups
4362          (when (and (not (equal (car groups) "poster"))
4363                     (not (member (car groups) known-groups))
4364                     (not (member (car groups) errors)))
4365            (push (car groups) errors))
4366          (pop groups))
4367        (cond
4368         ;; Gnus is not running.
4369         ((or (not (and (boundp 'gnus-active-hashtb)
4370                        gnus-active-hashtb))
4371              (not (boundp 'gnus-read-active-file)))
4372          t)
4373         ;; We don't have all the group names.
4374         ((and (or (not gnus-read-active-file)
4375                   (eq gnus-read-active-file 'some))
4376               errors)
4377          (y-or-n-p
4378           (format
4379            "Really use %s possibly unknown group%s: %s? "
4380            (if (= (length errors) 1) "this" "these")
4381            (if (= (length errors) 1) "" "s")
4382            (mapconcat 'identity errors ", "))))
4383         ;; There were no errors.
4384         ((not errors)
4385          t)
4386         ;; There are unknown groups.
4387         (t
4388          (y-or-n-p
4389           (format
4390            "Really post to %s unknown group%s: %s? "
4391            (if (= (length errors) 1) "this" "these")
4392            (if (= (length errors) 1) "" "s")
4393            (mapconcat 'identity errors ", ")))))))
4394    ;; Check continuation headers.
4395    (message-check 'continuation-headers
4396      (goto-char (point-min))
4397      (let ((do-posting t))
4398        (while (re-search-forward "^[^ \t\n][^:\n]*$" nil t)
4399          (if (y-or-n-p "Fix continuation lines? ")
4400              (progn
4401                (goto-char (match-beginning 0))
4402                (insert " "))
4403            (unless (y-or-n-p "Send anyway? ")
4404              (setq do-posting nil))))
4405        do-posting))
4406    ;; Check the Newsgroups & Followup-To headers for syntax errors.
4407    (message-check 'valid-newsgroups
4408      (let ((case-fold-search t)
4409            (headers '("Newsgroups" "Followup-To"))
4410            header error)
4411        (while (and headers (not error))
4412          (when (setq header (mail-fetch-field (car headers)))
4413            (if (or
4414                 (not
4415                  (string-match
4416                   "\\`\\([-+_&.a-zA-Z0-9]+\\)?\\(,[-+_&.a-zA-Z0-9]+\\)*\\'"
4417                   header))
4418                 (memq
4419                  nil (mapcar
4420                       (lambda (g)
4421                         (not (string-match "\\.\\'\\|\\.\\." g)))
4422                       (message-tokenize-header header ","))))
4423                (setq error t)))
4424          (unless error
4425            (pop headers)))
4426        (if (not error)
4427            t
4428          (y-or-n-p
4429           (format "The %s header looks odd: \"%s\".  Really post? "
4430                   (car headers) header)))))
4431    (message-check 'repeated-newsgroups
4432      (let ((case-fold-search t)
4433            (headers '("Newsgroups" "Followup-To"))
4434            header error groups group)
4435        (while (and headers
4436                    (not error))
4437          (when (setq header (mail-fetch-field (pop headers)))
4438            (setq groups (message-tokenize-header header ","))
4439            (while (setq group (pop groups))
4440              (when (member group groups)
4441                (setq error group
4442                      groups nil)))))
4443        (if (not error)
4444            t
4445          (y-or-n-p
4446           (format "Group %s is repeated in headers.  Really post? " error)))))
4447    ;; Check the From header.
4448    (message-check 'from
4449      (let* ((case-fold-search t)
4450             (from (message-fetch-field "from"))
4451             ad)
4452        (cond
4453         ((not from)
4454          (message "There is no From line.  Posting is denied.")
4455          nil)
4456         ((or (not (string-match
4457                    "@[^\\.]*\\."
4458                    (setq ad (nth 1 (mail-extract-address-components
4459                                     from))))) ;larsi@ifi
4460              (string-match "\\.\\." ad) ;larsi@ifi..uio
4461              (string-match "@\\." ad)   ;larsi@.ifi.uio
4462              (string-match "\\.$" ad)   ;larsi@ifi.uio.
4463              (not (string-match "^[^@]+@[^@]+$" ad)) ;larsi.ifi.uio
4464              (string-match "(.*).*(.*)" from)) ;(lars) (lars)
4465          (message
4466           "Denied posting -- the From looks strange: \"%s\"." from)
4467          nil)
4468         ((let ((addresses (rfc822-addresses from)))
4469            (while (and addresses
4470                        (not (eq (string-to-char (car addresses)) ?\()))
4471              (setq addresses (cdr addresses)))
4472            addresses)
4473          (message
4474           "Denied posting -- bad From address: \"%s\"." from)
4475          nil)
4476         (t t))))
4477    ;; Check the Reply-To header.
4478    (message-check 'reply-to
4479      (let* ((case-fold-search t)
4480             (reply-to (message-fetch-field "reply-to"))
4481             ad)
4482        (cond
4483         ((not reply-to)
4484          t)
4485         ((string-match "," reply-to)
4486          (y-or-n-p
4487           (format "Multiple Reply-To addresses: \"%s\". Really post? "
4488                   reply-to)))
4489         ((or (not (string-match
4490                    "@[^\\.]*\\."
4491                    (setq ad (nth 1 (mail-extract-address-components
4492                                     reply-to))))) ;larsi@ifi
4493              (string-match "\\.\\." ad) ;larsi@ifi..uio
4494              (string-match "@\\." ad)   ;larsi@.ifi.uio
4495              (string-match "\\.$" ad)   ;larsi@ifi.uio.
4496              (not (string-match "^[^@]+@[^@]+$" ad)) ;larsi.ifi.uio
4497              (string-match "(.*).*(.*)" reply-to)) ;(lars) (lars)
4498          (y-or-n-p
4499           (format
4500            "The Reply-To looks strange: \"%s\". Really post? "
4501            reply-to)))
4502         (t t))))))
4503
4504 (defun message-check-news-body-syntax ()
4505   (and
4506    ;; Check for long lines.
4507    (message-check 'long-lines
4508      (goto-char (point-min))
4509      (re-search-forward
4510       (concat "^" (regexp-quote mail-header-separator) "$"))
4511      (forward-line 1)
4512      (while (and
4513              (or (looking-at
4514                   "<#\\(/\\)?\\(multipart\\|part\\|external\\|mml\\)")
4515                  (let ((p (point)))
4516                    (end-of-line)
4517                    (< (- (point) p) 80)))
4518              (zerop (forward-line 1))))
4519      (or (bolp)
4520          (eobp)
4521          (y-or-n-p
4522           "You have lines longer than 79 characters.  Really post? ")))
4523    ;; Check whether the article is empty.
4524    (message-check 'empty
4525      (goto-char (point-min))
4526      (re-search-forward
4527       (concat "^" (regexp-quote mail-header-separator) "$"))
4528      (forward-line 1)
4529      (let ((b (point)))
4530        (goto-char (point-max))
4531        (re-search-backward message-signature-separator nil t)
4532        (beginning-of-line)
4533        (or (re-search-backward "[^ \n\t]" b t)
4534            (if (message-gnksa-enable-p 'empty-article)
4535                (y-or-n-p "Empty article.  Really post? ")
4536              (message "Denied posting -- Empty article.")
4537              nil))))
4538    ;; Check for control characters.
4539    (message-check 'control-chars
4540      (if (re-search-forward
4541           (mm-string-as-multibyte "[\000-\007\013\015-\032\034-\037\200-\237]")
4542           nil t)
4543          (y-or-n-p
4544           "The article contains control characters.  Really post? ")
4545        t))
4546    ;; Check excessive size.
4547    (message-check 'size
4548      (if (> (buffer-size) 60000)
4549          (y-or-n-p
4550           (format "The article is %d octets long.  Really post? "
4551                   (buffer-size)))
4552        t))
4553    ;; Check whether any new text has been added.
4554    (message-check 'new-text
4555      (or
4556       (not message-checksum)
4557       (not (eq (message-checksum) message-checksum))
4558       (if (message-gnksa-enable-p 'quoted-text-only)
4559           (y-or-n-p
4560            "It looks like no new text has been added.  Really post? ")
4561         (message "Denied posting -- no new text has been added.")
4562         nil)))
4563    ;; Check the length of the signature.
4564    (message-check 'signature
4565      (goto-char (point-max))
4566      (if (> (count-lines (point) (point-max)) 5)
4567          (y-or-n-p
4568           (format
4569            "Your .sig is %d lines; it should be max 4.  Really post? "
4570            (1- (count-lines (point) (point-max)))))
4571        t))
4572    ;; Ensure that text follows last quoted portion.
4573    (message-check 'quoting-style
4574      (goto-char (point-max))
4575      (let ((no-problem t))
4576        (when (search-backward-regexp "^>[^\n]*\n" nil t)
4577          (setq no-problem (search-forward-regexp "^[ \t]*[^>\n]" nil t)))
4578        (if no-problem
4579            t
4580          (if (message-gnksa-enable-p 'quoted-text-only)
4581              (y-or-n-p "Your text should follow quoted text.  Really post? ")
4582            ;; Ensure that
4583            (goto-char (point-min))
4584            (re-search-forward
4585             (concat "^" (regexp-quote mail-header-separator) "$"))
4586            (if (search-forward-regexp "^[ \t]*[^>\n]" nil t)
4587                (y-or-n-p "Your text should follow quoted text.  Really post? ")
4588              (message "Denied posting -- only quoted text.")
4589              nil)))))))
4590
4591 (defun message-checksum ()
4592   "Return a \"checksum\" for the current buffer."
4593   (let ((sum 0))
4594     (save-excursion
4595       (goto-char (point-min))
4596       (re-search-forward
4597        (concat "^" (regexp-quote mail-header-separator) "$"))
4598       (while (not (eobp))
4599         (when (not (looking-at "[ \t\n]"))
4600           (setq sum (logxor (ash sum 1) (if (natnump sum) 0 1)
4601                             (char-after))))
4602         (forward-char 1)))
4603     sum))
4604
4605 (defun message-do-fcc ()
4606   "Process Fcc headers in the current buffer."
4607   (let ((case-fold-search t)
4608         (buf (current-buffer))
4609         list file
4610         (mml-externalize-attachments message-fcc-externalize-attachments))
4611     (save-excursion
4612       (save-restriction
4613         (message-narrow-to-headers)
4614         (setq file (message-fetch-field "fcc" t)))
4615       (when file
4616         (set-buffer (get-buffer-create " *message temp*"))
4617         (erase-buffer)
4618         (insert-buffer-substring buf)
4619         (message-encode-message-body)
4620         (save-restriction
4621           (message-narrow-to-headers)
4622           (while (setq file (message-fetch-field "fcc" t))
4623             (push file list)
4624             (message-remove-header "fcc" nil t))
4625           (let ((mail-parse-charset message-default-charset)
4626                 (rfc2047-header-encoding-alist
4627                  (cons '("Newsgroups" . default)
4628                        rfc2047-header-encoding-alist)))
4629             (mail-encode-encoded-word-buffer)))
4630         (goto-char (point-min))
4631         (when (re-search-forward
4632                (concat "^" (regexp-quote mail-header-separator) "$")
4633                nil t)
4634           (replace-match "" t t ))
4635         ;; Process FCC operations.
4636         (while list
4637           (setq file (pop list))
4638           (if (string-match "^[ \t]*|[ \t]*\\(.*\\)[ \t]*$" file)
4639               ;; Pipe the article to the program in question.
4640               (call-process-region (point-min) (point-max) shell-file-name
4641                                    nil nil nil shell-command-switch
4642                                    (match-string 1 file))
4643             ;; Save the article.
4644             (setq file (expand-file-name file))
4645             (unless (file-exists-p (file-name-directory file))
4646               (make-directory (file-name-directory file) t))
4647             (if (and message-fcc-handler-function
4648                      (not (eq message-fcc-handler-function 'rmail-output)))
4649                 (funcall message-fcc-handler-function file)
4650               (if (and (file-readable-p file) (mail-file-babyl-p file))
4651                   (rmail-output file 1 nil t)
4652                 (let ((mail-use-rfc822 t))
4653                   (rmail-output file 1 t t))))))
4654         (kill-buffer (current-buffer))))))
4655
4656 (defun message-output (filename)
4657   "Append this article to Unix/babyl mail file FILENAME."
4658   (if (and (file-readable-p filename)
4659            (mail-file-babyl-p filename))
4660       (gnus-output-to-rmail filename t)
4661     (gnus-output-to-mail filename t)))
4662
4663 (defun message-cleanup-headers ()
4664   "Do various automatic cleanups of the headers."
4665   ;; Remove empty lines in the header.
4666   (save-restriction
4667     (message-narrow-to-headers)
4668     ;; Remove blank lines.
4669     (while (re-search-forward "^[ \t]*\n" nil t)
4670       (replace-match "" t t))
4671
4672     ;; Correct Newsgroups and Followup-To headers:  Change sequence of
4673     ;; spaces to comma and eliminate spaces around commas.  Eliminate
4674     ;; embedded line breaks.
4675     (goto-char (point-min))
4676     (while (re-search-forward "^\\(Newsgroups\\|Followup-To\\): +" nil t)
4677       (save-restriction
4678         (narrow-to-region
4679          (point)
4680          (if (re-search-forward "^[^ \t]" nil t)
4681              (match-beginning 0)
4682            (forward-line 1)
4683            (point)))
4684         (goto-char (point-min))
4685         (while (re-search-forward "\n[ \t]+" nil t)
4686           (replace-match " " t t))     ;No line breaks (too confusing)
4687         (goto-char (point-min))
4688         (while (re-search-forward "[ \t\n]*,[ \t\n]*\\|[ \t]+" nil t)
4689           (replace-match "," t t))
4690         (goto-char (point-min))
4691         ;; Remove trailing commas.
4692         (when (re-search-forward ",+$" nil t)
4693           (replace-match "" t t))))))
4694
4695 (defun message-make-date (&optional now)
4696   "Make a valid data header.
4697 If NOW, use that time instead."
4698   (let ((system-time-locale "C"))
4699     (format-time-string "%a, %d %b %Y %T %z" now)))
4700
4701 (defun message-insert-expires (days)
4702   "Insert the Expires header.  Expiry in DAYS days."
4703   (interactive "NExpire article in how many days? ")
4704   (save-excursion
4705     (message-position-on-field "Expires" "X-Draft-From")
4706     (insert (message-make-expires-date days))))
4707
4708 (defun message-make-expires-date (days)
4709   "Make date string for the Expires header.  Expiry in DAYS days.
4710
4711 In posting styles use `(\"Expires\" (make-expires-date 30))'."
4712   (let* ((cur (decode-time (current-time)))
4713          (nday (+ days (nth 3 cur))))
4714     (setf (nth 3 cur) nday)
4715     (format-time-string "%a, %d %b %Y %H:%M:%S %Z"
4716                         (apply 'encode-time cur))))
4717
4718 (defun message-make-message-id ()
4719   "Make a unique Message-ID."
4720   (concat "<" (message-unique-id)
4721           (let ((psubject (save-excursion (message-fetch-field "subject")))
4722                 (psupersedes
4723                  (save-excursion (message-fetch-field "supersedes"))))
4724             (if (or
4725                  (and message-reply-headers
4726                       (mail-header-references message-reply-headers)
4727                       (mail-header-subject message-reply-headers)
4728                       psubject
4729                       (not (string=
4730                             (message-strip-subject-re
4731                              (mail-header-subject message-reply-headers))
4732                             (message-strip-subject-re psubject))))
4733                  (and psupersedes
4734                       (string-match "_-_@" psupersedes)))
4735                 "_-_" ""))
4736           "@" (message-make-fqdn) ">"))
4737
4738 (defvar message-unique-id-char nil)
4739
4740 ;; If you ever change this function, make sure the new version
4741 ;; cannot generate IDs that the old version could.
4742 ;; You might for example insert a "." somewhere (not next to another dot
4743 ;; or string boundary), or modify the "fsf" string.
4744 (defun message-unique-id ()
4745   ;; Don't use microseconds from (current-time), they may be unsupported.
4746   ;; Instead we use this randomly inited counter.
4747   (setq message-unique-id-char
4748         (% (1+ (or message-unique-id-char (logand (random t) (1- (lsh 1 20)))))
4749            ;; (current-time) returns 16-bit ints,
4750            ;; and 2^16*25 just fits into 4 digits i base 36.
4751            (* 25 25)))
4752   (let ((tm (current-time)))
4753     (concat
4754      (if (memq system-type '(ms-dos emx vax-vms))
4755          (let ((user (downcase (user-login-name))))
4756            (while (string-match "[^a-z0-9_]" user)
4757              (aset user (match-beginning 0) ?_))
4758            user)
4759        (message-number-base36 (user-uid) -1))
4760      (message-number-base36 (+ (car tm)
4761                                (lsh (% message-unique-id-char 25) 16)) 4)
4762      (message-number-base36 (+ (nth 1 tm)
4763                                (lsh (/ message-unique-id-char 25) 16)) 4)
4764      ;; Append a given name, because while the generated ID is unique
4765      ;; to this newsreader, other newsreaders might otherwise generate
4766      ;; the same ID via another algorithm.
4767      ".fsf")))
4768
4769 (defun message-number-base36 (num len)
4770   (if (if (< len 0)
4771           (<= num 0)
4772         (= len 0))
4773       ""
4774     (concat (message-number-base36 (/ num 36) (1- len))
4775             (char-to-string (aref "zyxwvutsrqponmlkjihgfedcba9876543210"
4776                                   (% num 36))))))
4777
4778 (defun message-make-organization ()
4779   "Make an Organization header."
4780   (let* ((organization
4781           (when message-user-organization
4782             (if (functionp message-user-organization)
4783                 (funcall message-user-organization)
4784               message-user-organization))))
4785     (with-temp-buffer
4786       (mm-enable-multibyte)
4787       (cond ((stringp organization)
4788              (insert organization))
4789             ((and (eq t organization)
4790                   message-user-organization-file
4791                   (file-exists-p message-user-organization-file))
4792              (insert-file-contents message-user-organization-file)))
4793       (goto-char (point-min))
4794       (while (re-search-forward "[\t\n]+" nil t)
4795         (replace-match "" t t))
4796       (unless (zerop (buffer-size))
4797         (buffer-string)))))
4798
4799 (defun message-make-lines ()
4800   "Count the number of lines and return numeric string."
4801   (save-excursion
4802     (save-restriction
4803       (widen)
4804       (message-goto-body)
4805       (int-to-string (count-lines (point) (point-max))))))
4806
4807 (defun message-make-references ()
4808   "Return the References header for this message."
4809   (when message-reply-headers
4810     (let ((message-id (mail-header-message-id message-reply-headers))
4811           (references (mail-header-references message-reply-headers))
4812           new-references)
4813       (if (or references message-id)
4814           (concat (or references "") (and references " ")
4815                   (or message-id ""))
4816         nil))))
4817
4818 (defun message-make-in-reply-to ()
4819   "Return the In-Reply-To header for this message."
4820   (when message-reply-headers
4821     (let ((from (mail-header-from message-reply-headers))
4822           (date (mail-header-date message-reply-headers))
4823           (msg-id (mail-header-message-id message-reply-headers)))
4824       (when from
4825         (let ((name (mail-extract-address-components from)))
4826           (concat msg-id (if msg-id " (")
4827                   (or (car name)
4828                       (nth 1 name))
4829                   "'s message of \""
4830                   (if (or (not date) (string= date ""))
4831                       "(unknown date)" date)
4832                   "\"" (if msg-id ")")))))))
4833
4834 (defun message-make-distribution ()
4835   "Make a Distribution header."
4836   (let ((orig-distribution (message-fetch-reply-field "distribution")))
4837     (cond ((functionp message-distribution-function)
4838            (funcall message-distribution-function))
4839           (t orig-distribution))))
4840
4841 (defun message-make-expires ()
4842   "Return an Expires header based on `message-expires'."
4843   (let ((current (current-time))
4844         (future (* 1.0 message-expires 60 60 24)))
4845     ;; Add the future to current.
4846     (setcar current (+ (car current) (round (/ future (expt 2 16)))))
4847     (setcar (cdr current) (+ (nth 1 current) (% (round future) (expt 2 16))))
4848     (message-make-date current)))
4849
4850 (defun message-make-path ()
4851   "Return uucp path."
4852   (let ((login-name (user-login-name)))
4853     (cond ((null message-user-path)
4854            (concat (system-name) "!" login-name))
4855           ((stringp message-user-path)
4856            ;; Support GENERICPATH.  Suggested by vixie@decwrl.dec.com.
4857            (concat message-user-path "!" login-name))
4858           (t login-name))))
4859
4860 (defun message-make-from ()
4861   "Make a From header."
4862   (let* ((style message-from-style)
4863          (login (message-make-address))
4864          (fullname
4865           (or (and (boundp 'user-full-name)
4866                    user-full-name)
4867               (user-full-name))))
4868     (when (string= fullname "&")
4869       (setq fullname (user-login-name)))
4870     (with-temp-buffer
4871       (mm-enable-multibyte)
4872       (cond
4873        ((or (null style)
4874             (equal fullname ""))
4875         (insert login))
4876        ((or (eq style 'angles)
4877             (and (not (eq style 'parens))
4878                  ;; Use angles if no quoting is needed, or if parens would
4879                  ;; need quoting too.
4880                  (or (not (string-match "[^- !#-'*+/-9=?A-Z^-~]" fullname))
4881                      (let ((tmp (concat fullname nil)))
4882                        (while (string-match "([^()]*)" tmp)
4883                          (aset tmp (match-beginning 0) ?-)
4884                          (aset tmp (1- (match-end 0)) ?-))
4885                        (string-match "[\\()]" tmp)))))
4886         (insert fullname)
4887         (goto-char (point-min))
4888         ;; Look for a character that cannot appear unquoted
4889         ;; according to RFC 822.
4890         (when (re-search-forward "[^- !#-'*+/-9=?A-Z^-~]" nil 1)
4891           ;; Quote fullname, escaping specials.
4892           (goto-char (point-min))
4893           (insert "\"")
4894           (while (re-search-forward "[\"\\]" nil 1)
4895             (replace-match "\\\\\\&" t))
4896           (insert "\""))
4897         (insert " <" login ">"))
4898        (t                               ; 'parens or default
4899         (insert login " (")
4900         (let ((fullname-start (point)))
4901           (insert fullname)
4902           (goto-char fullname-start)
4903           ;; RFC 822 says \ and nonmatching parentheses
4904           ;; must be escaped in comments.
4905           ;; Escape every instance of ()\ ...
4906           (while (re-search-forward "[()\\]" nil 1)
4907             (replace-match "\\\\\\&" t))
4908           ;; ... then undo escaping of matching parentheses,
4909           ;; including matching nested parentheses.
4910           (goto-char fullname-start)
4911           (while (re-search-forward
4912                   "\\(\\=\\|[^\\]\\(\\\\\\\\\\)*\\)\\\\(\\(\\([^\\]\\|\\\\\\\\\\)*\\)\\\\)"
4913                   nil 1)
4914             (replace-match "\\1(\\3)" t)
4915             (goto-char fullname-start)))
4916         (insert ")")))
4917       (buffer-string))))
4918
4919 (defun message-make-sender ()
4920   "Return the \"real\" user address.
4921 This function tries to ignore all user modifications, and
4922 give as trustworthy answer as possible."
4923   (concat (user-login-name) "@" (system-name)))
4924
4925 (defun message-make-address ()
4926   "Make the address of the user."
4927   (or (message-user-mail-address)
4928       (concat (user-login-name) "@" (message-make-domain))))
4929
4930 (defun message-user-mail-address ()
4931   "Return the pertinent part of `user-mail-address'."
4932   (when (and user-mail-address
4933              (string-match "@.*\\." user-mail-address))
4934     (if (string-match " " user-mail-address)
4935         (nth 1 (mail-extract-address-components user-mail-address))
4936       user-mail-address)))
4937
4938 (defun message-sendmail-envelope-from ()
4939   "Return the envelope from."
4940   (cond ((eq message-sendmail-envelope-from 'header)
4941          (nth 1 (mail-extract-address-components
4942                  (message-fetch-field "from"))))
4943         ((stringp message-sendmail-envelope-from)
4944          message-sendmail-envelope-from)
4945         (t
4946          (message-make-address))))
4947
4948 (defun message-make-fqdn ()
4949   "Return user's fully qualified domain name."
4950   (let* ((system-name (system-name))
4951          (user-mail (message-user-mail-address))
4952          (user-domain
4953           (if (and user-mail
4954                    (string-match "@\\(.*\\)\\'" user-mail))
4955               (match-string 1 user-mail)))
4956          (case-fold-search t))
4957     (cond
4958      ((and message-user-fqdn
4959            (stringp message-user-fqdn)
4960            (string-match message-valid-fqdn-regexp message-user-fqdn)
4961            (not (string-match message-bogus-system-names message-user-fqdn)))
4962       message-user-fqdn)
4963      ;; `message-user-fqdn' seems to be valid
4964      ((and (string-match message-valid-fqdn-regexp system-name)
4965            (not (string-match message-bogus-system-names system-name)))
4966       ;; `system-name' returned the right result.
4967       system-name)
4968      ;; Try `mail-host-address'.
4969      ((and (boundp 'mail-host-address)
4970            (stringp mail-host-address)
4971            (string-match message-valid-fqdn-regexp mail-host-address)
4972            (not (string-match message-bogus-system-names mail-host-address)))
4973       mail-host-address)
4974      ;; We try `user-mail-address' as a backup.
4975      ((and user-domain
4976            (stringp user-domain)
4977            (string-match message-valid-fqdn-regexp user-domain)
4978            (not (string-match message-bogus-system-names user-domain)))
4979       user-domain)
4980      ;; Default to this bogus thing.
4981      (t
4982       (concat system-name
4983               ".i-did-not-set--mail-host-address--so-tickle-me")))))
4984
4985 (defun message-make-host-name ()
4986   "Return the name of the host."
4987   (let ((fqdn (message-make-fqdn)))
4988     (string-match "^[^.]+\\." fqdn)
4989     (substring fqdn 0 (1- (match-end 0)))))
4990
4991 (defun message-make-domain ()
4992   "Return the domain name."
4993   (or mail-host-address
4994       (message-make-fqdn)))
4995
4996 (defun message-to-list-only ()
4997   "Send a message to the list only.
4998 Remove all addresses but the list address from To and Cc headers."
4999   (interactive)
5000   (let ((listaddr (message-make-mail-followup-to t)))
5001     (when listaddr
5002       (save-excursion
5003         (message-remove-header "to")
5004         (message-remove-header "cc")
5005         (message-position-on-field "To" "X-Draft-From")
5006         (insert listaddr)))))
5007
5008 (defun message-make-mail-followup-to (&optional only-show-subscribed)
5009   "Return the Mail-Followup-To header.
5010 If passed the optional argument ONLY-SHOW-SUBSCRIBED only return the
5011 subscribed address (and not the additional To and Cc header contents)."
5012   (let* ((case-fold-search t)
5013          (to (message-fetch-field "To"))
5014          (cc (message-fetch-field "cc"))
5015          (msg-recipients (concat to (and to cc ", ") cc))
5016          (recipients
5017           (mapcar 'mail-strip-quoted-names
5018                   (message-tokenize-header msg-recipients)))
5019          (file-regexps
5020           (if message-subscribed-address-file
5021               (let (begin end item re)
5022                 (save-excursion
5023                   (with-temp-buffer
5024                     (insert-file-contents message-subscribed-address-file)
5025                     (while (not (eobp))
5026                       (setq begin (point))
5027                       (forward-line 1)
5028                       (setq end (point))
5029                       (if (bolp) (setq end (1- end)))
5030                       (setq item (regexp-quote (buffer-substring begin end)))
5031                       (if re (setq re (concat re "\\|" item))
5032                         (setq re (concat "\\`\\(" item))))
5033                     (and re (list (concat re "\\)\\'"))))))))
5034          (mft-regexps (apply 'append message-subscribed-regexps
5035                              (mapcar 'regexp-quote
5036                                      message-subscribed-addresses)
5037                              file-regexps
5038                              (mapcar 'funcall
5039                                      message-subscribed-address-functions))))
5040     (save-match-data
5041       (let ((subscribed-lists nil)
5042             (list
5043              (loop for recipient in recipients
5044                when (loop for regexp in mft-regexps
5045                       when (string-match regexp recipient) return t)
5046                return recipient)))
5047         (when list
5048           (if only-show-subscribed
5049               list
5050             msg-recipients))))))
5051
5052 (defun message-idna-to-ascii-rhs-1 (header)
5053   "Interactively potentially IDNA encode domain names in HEADER."
5054   (let ((field (message-fetch-field header))
5055         rhs ace  address)
5056     (when field
5057       (dolist (rhs
5058                (message-remove-duplicates
5059                 (mapcar (lambda (rhs) (or (cadr (split-string rhs "@")) ""))
5060                         (mapcar 'downcase
5061                                 (mapcar
5062                                  'car (mail-header-parse-addresses field))))))
5063         (setq ace (downcase (idna-to-ascii rhs)))
5064         (when (and (not (equal rhs ace))
5065                    (or (not (eq message-use-idna 'ask))
5066                        (y-or-n-p (format "Replace %s with %s in %s:? "
5067                                          rhs ace header))))
5068           (goto-char (point-min))
5069           (while (re-search-forward (concat "^" header ":") nil t)
5070             (message-narrow-to-field)
5071             (while (search-forward (concat "@" rhs) nil t)
5072               (replace-match (concat "@" ace) t t))
5073             (goto-char (point-max))
5074             (widen)))))))
5075
5076 (defun message-idna-to-ascii-rhs ()
5077   "Possibly IDNA encode non-ASCII domain names in From:, To: and Cc: headers.
5078 See `message-idna-encode'."
5079   (interactive)
5080   (when message-use-idna
5081     (save-excursion
5082       (save-restriction
5083         (message-narrow-to-head)
5084         (message-idna-to-ascii-rhs-1 "From")
5085         (message-idna-to-ascii-rhs-1 "To")
5086         (message-idna-to-ascii-rhs-1 "Reply-To")
5087         (message-idna-to-ascii-rhs-1 "Mail-Reply-To")
5088         (message-idna-to-ascii-rhs-1 "Mail-Followup-To")
5089         (message-idna-to-ascii-rhs-1 "Cc")))))
5090
5091 (defun message-generate-headers (headers)
5092   "Prepare article HEADERS.
5093 Headers already prepared in the buffer are not modified."
5094   (setq headers (append headers message-required-headers))
5095   (save-restriction
5096     (message-narrow-to-headers)
5097     (let* ((Date (message-make-date))
5098            (Message-ID (message-make-message-id))
5099            (Organization (message-make-organization))
5100            (From (message-make-from))
5101            (Path (message-make-path))
5102            (Subject nil)
5103            (Newsgroups nil)
5104            (In-Reply-To (message-make-in-reply-to))
5105            (References (message-make-references))
5106            (To nil)
5107            (Distribution (message-make-distribution))
5108            (Lines (message-make-lines))
5109            (User-Agent message-newsreader)
5110            (Expires (message-make-expires))
5111            (case-fold-search t)
5112            (optionalp nil)
5113            header value elem header-string)
5114       ;; First we remove any old generated headers.
5115       (let ((headers message-deletable-headers))
5116         (unless (buffer-modified-p)
5117           (setq headers (delq 'Message-ID (copy-sequence headers))))
5118         (while headers
5119           (goto-char (point-min))
5120           (and (re-search-forward
5121                 (concat "^" (symbol-name (car headers)) ": *") nil t)
5122                (get-text-property (1+ (match-beginning 0)) 'message-deletable)
5123                (message-delete-line))
5124           (pop headers)))
5125       ;; Go through all the required headers and see if they are in the
5126       ;; articles already.  If they are not, or are empty, they are
5127       ;; inserted automatically - except for Subject, Newsgroups and
5128       ;; Distribution.
5129       (while headers
5130         (goto-char (point-min))
5131         (setq elem (pop headers))
5132         (if (consp elem)
5133             (if (eq (car elem) 'optional)
5134                 (setq header (cdr elem)
5135                       optionalp t)
5136               (setq header (car elem)))
5137           (setq header elem))
5138         (setq header-string  (if (stringp header)
5139                                  header
5140                                (symbol-name header)))
5141         (when (or (not (re-search-forward
5142                         (concat "^"
5143                                 (regexp-quote (downcase header-string))
5144                                 ":")
5145                         nil t))
5146                   (progn
5147                     ;; The header was found.  We insert a space after the
5148                     ;; colon, if there is none.
5149                     (if (/= (char-after) ? ) (insert " ") (forward-char 1))
5150                     ;; Find out whether the header is empty.
5151                     (looking-at "[ \t]*\n[^ \t]")))
5152           ;; So we find out what value we should insert.
5153           (setq value
5154                 (cond
5155                  ((and (consp elem)
5156                        (eq (car elem) 'optional)
5157                        (not (member header-string message-inserted-headers)))
5158                   ;; This is an optional header.  If the cdr of this
5159                   ;; is something that is nil, then we do not insert
5160                   ;; this header.
5161                   (setq header (cdr elem))
5162                   (or (and (functionp (cdr elem))
5163                            (funcall (cdr elem)))
5164                       (and (boundp (cdr elem))
5165                            (symbol-value (cdr elem)))))
5166                  ((consp elem)
5167                   ;; The element is a cons.  Either the cdr is a
5168                   ;; string to be inserted verbatim, or it is a
5169                   ;; function, and we insert the value returned from
5170                   ;; this function.
5171                   (or (and (stringp (cdr elem))
5172                            (cdr elem))
5173                       (and (functionp (cdr elem))
5174                            (funcall (cdr elem)))))
5175                  ((and (boundp header)
5176                        (symbol-value header))
5177                   ;; The element is a symbol.  We insert the value
5178                   ;; of this symbol, if any.
5179                   (symbol-value header))
5180                  ((not (message-check-element header))
5181                   ;; We couldn't generate a value for this header,
5182                   ;; so we just ask the user.
5183                   (read-from-minibuffer
5184                    (format "Empty header for %s; enter value: " header)))))
5185           ;; Finally insert the header.
5186           (when (and value
5187                      (not (equal value "")))
5188             (save-excursion
5189               (if (bolp)
5190                   (progn
5191                     ;; This header didn't exist, so we insert it.
5192                     (goto-char (point-max))
5193                     (let ((formatter
5194                            (cdr (assq header message-header-format-alist))))
5195                       (if formatter
5196                           (funcall formatter header value)
5197                         (insert header-string ": " value))
5198                       (goto-char (message-fill-field))
5199                       ;; We check whether the value was ended by a
5200                       ;; newline.  If not, we insert one.
5201                       (unless (bolp)
5202                         (insert "\n"))
5203                       (forward-line -1)))
5204                 ;; The value of this header was empty, so we clear
5205                 ;; totally and insert the new value.
5206                 (delete-region (point) (point-at-eol))
5207                 ;; If the header is optional, and the header was
5208                 ;; empty, we con't insert it anyway.
5209                 (unless optionalp
5210                   (push header-string message-inserted-headers)
5211                   (insert value)
5212                   (message-fill-field)))
5213               ;; Add the deletable property to the headers that require it.
5214               (and (memq header message-deletable-headers)
5215                    (progn (beginning-of-line) (looking-at "[^:]+: "))
5216                    (add-text-properties
5217                     (point) (match-end 0)
5218                     '(message-deletable t face italic) (current-buffer)))))))
5219       ;; Insert new Sender if the From is strange.
5220       (let ((from (message-fetch-field "from"))
5221             (sender (message-fetch-field "sender"))
5222             (secure-sender (message-make-sender)))
5223         (when (and from
5224                    (not (message-check-element 'sender))
5225                    (not (string=
5226                          (downcase
5227                           (cadr (mail-extract-address-components from)))
5228                          (downcase secure-sender)))
5229                    (or (null sender)
5230                        (not
5231                         (string=
5232                          (downcase
5233                           (cadr (mail-extract-address-components sender)))
5234                          (downcase secure-sender)))))
5235           (goto-char (point-min))
5236           ;; Rename any old Sender headers to Original-Sender.
5237           (when (re-search-forward "^\\(Original-\\)*Sender:" nil t)
5238             (beginning-of-line)
5239             (insert "Original-")
5240             (beginning-of-line))
5241           (when (or (message-news-p)
5242                     (string-match "@.+\\.." secure-sender))
5243             (insert "Sender: " secure-sender "\n"))))
5244       ;; Check for IDNA
5245       (message-idna-to-ascii-rhs))))
5246
5247 (defun message-insert-courtesy-copy ()
5248   "Insert a courtesy message in mail copies of combined messages."
5249   (let (newsgroups)
5250     (save-excursion
5251       (save-restriction
5252         (message-narrow-to-headers)
5253         (when (setq newsgroups (message-fetch-field "newsgroups"))
5254           (goto-char (point-max))
5255           (insert "Posted-To: " newsgroups "\n")))
5256       (forward-line 1)
5257       (when message-courtesy-message
5258         (cond
5259          ((string-match "%s" message-courtesy-message)
5260           (insert (format message-courtesy-message newsgroups)))
5261          (t
5262           (insert message-courtesy-message)))))))
5263
5264 ;;;
5265 ;;; Setting up a message buffer
5266 ;;;
5267
5268 (defun message-skip-to-next-address ()
5269   (let ((end (save-excursion
5270                (message-next-header)
5271                (point)))
5272         quoted char)
5273     (when (looking-at ",")
5274       (forward-char 1))
5275     (while (and (not (= (point) end))
5276                 (or (not (eq char ?,))
5277                     quoted))
5278       (skip-chars-forward "^,\"" (point-max))
5279       (when (eq (setq char (following-char)) ?\")
5280         (setq quoted (not quoted)))
5281       (unless (= (point) end)
5282         (forward-char 1)))
5283     (skip-chars-forward " \t\n")))
5284
5285 (defun message-fill-address (header value)
5286   (insert (capitalize (symbol-name header))
5287           ": "
5288           (if (consp value) (car value) value)
5289           "\n")
5290   (message-fill-field-address))
5291
5292 (defun message-split-line ()
5293   "Split current line, moving portion beyond point vertically down.
5294 If the current line has `message-yank-prefix', insert it on the new line."
5295   (interactive "*")
5296   (condition-case nil
5297       (split-line message-yank-prefix) ;; Emacs 22.1+ supports arg.
5298     (error
5299      (split-line))))
5300
5301 (defun message-insert-header (header value)
5302   (insert (capitalize (symbol-name header))
5303           ": "
5304           (if (consp value) (car value) value)))
5305
5306 (defun message-field-name ()
5307   (save-excursion
5308     (goto-char (point-min))
5309     (when (looking-at "\\([^:]+\\):")
5310       (intern (capitalize (match-string 1))))))
5311
5312 (defun message-fill-field ()
5313   (save-excursion
5314     (save-restriction
5315       (message-narrow-to-field)
5316       (let ((field-name (message-field-name)))
5317         (funcall (or (cadr (assq field-name message-field-fillers))
5318                      'message-fill-field-general)))
5319       (point-max))))
5320
5321 (defun message-fill-field-address ()
5322   (while (not (eobp))
5323     (message-skip-to-next-address)
5324     (let (last)
5325       (if (and (> (current-column) 78)
5326                last)
5327           (progn
5328             (save-excursion
5329               (goto-char last)
5330               (insert "\n\t"))
5331             (setq last (1+ (point))))
5332         (setq last (1+ (point)))))))
5333
5334 (defun message-fill-field-general ()
5335   (let ((begin (point))
5336         (fill-column 78)
5337         (fill-prefix "\t"))
5338     (while (and (search-forward "\n" nil t)
5339                 (not (eobp)))
5340       (replace-match " " t t))
5341     (fill-region-as-paragraph begin (point-max))
5342     ;; Tapdance around looong Message-IDs.
5343     (forward-line -1)
5344     (when (looking-at "[ \t]*$")
5345       (message-delete-line))
5346     (goto-char begin)
5347     (search-forward ":" nil t)
5348     (when (looking-at "\n[ \t]+")
5349       (replace-match " " t t))
5350     (goto-char (point-max))))
5351
5352 (defun message-shorten-1 (list cut surplus)
5353   "Cut SURPLUS elements out of LIST, beginning with CUTth one."
5354   (setcdr (nthcdr (- cut 2) list)
5355           (nthcdr (+ (- cut 2) surplus 1) list)))
5356
5357 (defun message-shorten-references (header references)
5358   "Trim REFERENCES to be 21 Message-ID long or less, and fold them.
5359 When sending via news, also check that the REFERENCES are less
5360 than 988 characters long, and if they are not, trim them until
5361 they are."
5362   (let ((maxcount 21)
5363         (count 0)
5364         (cut 2)
5365         refs)
5366     (with-temp-buffer
5367       (insert references)
5368       (goto-char (point-min))
5369       ;; Cons a list of valid references.
5370       (while (re-search-forward "<[^>]+>" nil t)
5371         (push (match-string 0) refs))
5372       (setq refs (nreverse refs)
5373             count (length refs)))
5374
5375     ;; If the list has more than MAXCOUNT elements, trim it by
5376     ;; removing the CUTth element and the required number of
5377     ;; elements that follow.
5378     (when (> count maxcount)
5379       (let ((surplus (- count maxcount)))
5380         (message-shorten-1 refs cut surplus)
5381         (decf count surplus)))
5382
5383     ;; When sending via news, make sure the total folded length will
5384     ;; be less than 998 characters.  This is to cater to broken INN
5385     ;; 2.3 which counts the total number of characters in a header
5386     ;; rather than the physical line length of each line, as it should.
5387     ;;
5388     ;; This hack should be removed when it's believed than INN 2.3 is
5389     ;; no longer widely used.
5390     ;;
5391     ;; At this point the headers have not been generated, thus we use
5392     ;; message-this-is-news directly.
5393     (when message-this-is-news
5394       (while (< 998
5395                 (with-temp-buffer
5396                   (message-insert-header
5397                    header (mapconcat #'identity refs " "))
5398                   (buffer-size)))
5399         (message-shorten-1 refs cut 1)))
5400     ;; Finally, collect the references back into a string and insert
5401     ;; it into the buffer.
5402     (message-insert-header header (mapconcat #'identity refs " "))))
5403
5404 (defun message-position-point ()
5405   "Move point to where the user probably wants to find it."
5406   (message-narrow-to-headers)
5407   (cond
5408    ((re-search-forward "^[^:]+:[ \t]*$" nil t)
5409     (search-backward ":" )
5410     (widen)
5411     (forward-char 1)
5412     (if (eq (char-after) ? )
5413         (forward-char 1)
5414       (insert " ")))
5415    (t
5416     (goto-char (point-max))
5417     (widen)
5418     (forward-line 1)
5419     (unless (looking-at "$")
5420       (forward-line 2)))
5421    (sit-for 0)))
5422
5423 (defcustom message-beginning-of-line t
5424   "Whether \\<message-mode-map>\\[message-beginning-of-line]\
5425  goes to beginning of header values."
5426   :version "22.1"
5427   :group 'message-buffers
5428   :link '(custom-manual "(message)Movement")
5429   :type 'boolean)
5430
5431 (defun message-beginning-of-line (&optional n)
5432   "Move point to beginning of header value or to beginning of line.
5433 The prefix argument N is passed directly to `beginning-of-line'.
5434
5435 This command is identical to `beginning-of-line' if point is
5436 outside the message header or if the option `message-beginning-of-line'
5437 is nil.
5438
5439 If point is in the message header and on a (non-continued) header
5440 line, move point to the beginning of the header value or the beginning of line,
5441 whichever is closer.  If point is already at beginning of line, move point to
5442 beginning of header value.  Therefore, repeated calls will toggle point
5443 between beginning of field and beginning of line."
5444   (interactive "p")
5445   (let ((zrs 'zmacs-region-stays))
5446     (when (and (interactive-p) (boundp zrs))
5447       (set zrs t)))
5448   (if (and message-beginning-of-line
5449            (message-point-in-header-p))
5450       (let* ((here (point))
5451              (bol (progn (beginning-of-line n) (point)))
5452              (eol (point-at-eol))
5453              (eoh (re-search-forward ": *" eol t)))
5454         (goto-char
5455          (if (and eoh (or (< eoh here) (= bol here)))
5456              eoh bol)))
5457     (beginning-of-line n)))
5458
5459 (defun message-buffer-name (type &optional to group)
5460   "Return a new (unique) buffer name based on TYPE and TO."
5461   (cond
5462    ;; Generate a new buffer name The Message Way.
5463    ((eq message-generate-new-buffers 'unique)
5464     (generate-new-buffer-name
5465      (concat "*" type
5466              (if to
5467                  (concat " to "
5468                          (or (car (mail-extract-address-components to))
5469                              to) "")
5470                "")
5471              (if (and group (not (string= group ""))) (concat " on " group) "")
5472              "*")))
5473    ;; Check whether `message-generate-new-buffers' is a function,
5474    ;; and if so, call it.
5475    ((functionp message-generate-new-buffers)
5476     (funcall message-generate-new-buffers type to group))
5477    ((eq message-generate-new-buffers 'unsent)
5478     (generate-new-buffer-name
5479      (concat "*unsent " type
5480              (if to
5481                  (concat " to "
5482                          (or (car (mail-extract-address-components to))
5483                              to) "")
5484                "")
5485              (if (and group (not (string= group ""))) (concat " on " group) "")
5486              "*")))
5487    ;; Use standard name.
5488    (t
5489     (format "*%s message*" type))))
5490
5491 (defun message-pop-to-buffer (name)
5492   "Pop to buffer NAME, and warn if it already exists and is modified."
5493   (let ((buffer (get-buffer name)))
5494     (if (and buffer
5495              (buffer-name buffer))
5496         (progn
5497           (set-buffer (pop-to-buffer buffer))
5498           (when (and (buffer-modified-p)
5499                      (not (y-or-n-p
5500                            "Message already being composed; erase? ")))
5501             (error "Message being composed")))
5502       (set-buffer (pop-to-buffer name)))
5503     (erase-buffer)
5504     (message-mode)))
5505
5506 (defun message-do-send-housekeeping ()
5507   "Kill old message buffers."
5508   ;; We might have sent this buffer already.  Delete it from the
5509   ;; list of buffers.
5510   (setq message-buffer-list (delq (current-buffer) message-buffer-list))
5511   (while (and message-max-buffers
5512               message-buffer-list
5513               (>= (length message-buffer-list) message-max-buffers))
5514     ;; Kill the oldest buffer -- unless it has been changed.
5515     (let ((buffer (pop message-buffer-list)))
5516       (when (and (buffer-name buffer)
5517                  (not (buffer-modified-p buffer)))
5518         (kill-buffer buffer))))
5519   ;; Rename the buffer.
5520   (if message-send-rename-function
5521       (funcall message-send-rename-function)
5522     ;; Note: mail-abbrevs of XEmacs renames buffer name behind Gnus.
5523     (when (string-match
5524            "\\`\\*\\(sent \\|unsent \\)?\\(.+\\)\\*[^\\*]*\\|\\`mail to "
5525            (buffer-name))
5526       (let ((name (match-string 2 (buffer-name)))
5527             to group)
5528         (if (not (or (null name)
5529                      (string-equal name "mail")
5530                      (string-equal name "posting")))
5531             (setq name (concat "*sent " name "*"))
5532           (message-narrow-to-headers)
5533           (setq to (message-fetch-field "to"))
5534           (setq group (message-fetch-field "newsgroups"))
5535           (widen)
5536           (setq name
5537                 (cond
5538                  (to (concat "*sent mail to "
5539                              (or (car (mail-extract-address-components to))
5540                                  to) "*"))
5541                  ((and group (not (string= group "")))
5542                   (concat "*sent posting on " group "*"))
5543                  (t "*sent mail*"))))
5544         (unless (string-equal name (buffer-name))
5545           (rename-buffer name t)))))
5546   ;; Push the current buffer onto the list.
5547   (when message-max-buffers
5548     (setq message-buffer-list
5549           (nconc message-buffer-list (list (current-buffer))))))
5550
5551 (defun message-mail-user-agent ()
5552   (let ((mua (cond
5553               ((not message-mail-user-agent) nil)
5554               ((eq message-mail-user-agent t) mail-user-agent)
5555               (t message-mail-user-agent))))
5556     (if (memq mua '(message-user-agent gnus-user-agent))
5557         nil
5558       mua)))
5559
5560 (defun message-setup (headers &optional replybuffer actions switch-function)
5561   (let ((mua (message-mail-user-agent))
5562         subject to field yank-action)
5563     (if (not (and message-this-is-mail mua))
5564         (message-setup-1 headers replybuffer actions)
5565       (if replybuffer
5566           (setq yank-action (list 'insert-buffer replybuffer)))
5567       (setq headers (copy-sequence headers))
5568       (setq field (assq 'Subject headers))
5569       (when field
5570         (setq subject (cdr field))
5571         (setq headers (delq field headers)))
5572       (setq field (assq 'To headers))
5573       (when field
5574         (setq to (cdr field))
5575         (setq headers (delq field headers)))
5576       (let ((mail-user-agent mua))
5577         (compose-mail to subject
5578                       (mapcar (lambda (item)
5579                                 (cons
5580                                  (format "%s" (car item))
5581                                  (cdr item)))
5582                               headers)
5583                       nil switch-function yank-action actions)))))
5584
5585 (defun message-headers-to-generate (headers included-headers excluded-headers)
5586   "Return a list that includes all headers from HEADERS.
5587 If INCLUDED-HEADERS is a list, just include those headers.  If if is
5588 t, include all headers.  In any case, headers from EXCLUDED-HEADERS
5589 are not included."
5590   (let ((result nil)
5591         header-name)
5592     (dolist (header headers)
5593       (setq header-name (cond
5594                          ((and (consp header)
5595                                (eq (car header) 'optional))
5596                           ;; On the form (optional . Header)
5597                           (cdr header))
5598                          ((consp header)
5599                           ;; On the form (Header . function)
5600                           (car header))
5601                          (t
5602                           ;; Just a Header.
5603                           header)))
5604       (when (and (not (memq header-name excluded-headers))
5605                  (or (eq included-headers t)
5606                      (memq header-name included-headers)))
5607         (push header result)))
5608     (nreverse result)))
5609
5610 (defun message-setup-1 (headers &optional replybuffer actions)
5611   (dolist (action actions)
5612     (condition-case nil
5613         (add-to-list 'message-send-actions
5614                      `(apply ',(car action) ',(cdr action)))))
5615   (setq message-reply-buffer replybuffer)
5616   (goto-char (point-min))
5617   ;; Insert all the headers.
5618   (mail-header-format
5619    (let ((h headers)
5620          (alist message-header-format-alist))
5621      (while h
5622        (unless (assq (caar h) message-header-format-alist)
5623          (push (list (caar h)) alist))
5624        (pop h))
5625      alist)
5626    headers)
5627   (delete-region (point) (progn (forward-line -1) (point)))
5628   (when message-default-headers
5629     (insert message-default-headers)
5630     (or (bolp) (insert ?\n)))
5631   (insert mail-header-separator "\n")
5632   (forward-line -1)
5633   (when (message-news-p)
5634     (when message-default-news-headers
5635       (insert message-default-news-headers)
5636       (or (bolp) (insert ?\n)))
5637     (when message-generate-headers-first
5638       (message-generate-headers
5639        (message-headers-to-generate
5640         (append message-required-news-headers
5641                 message-required-headers)
5642         message-generate-headers-first
5643         '(Lines Subject)))))
5644   (when (message-mail-p)
5645     (when message-default-mail-headers
5646       (insert message-default-mail-headers)
5647       (or (bolp) (insert ?\n)))
5648     (when message-generate-headers-first
5649       (message-generate-headers
5650        (message-headers-to-generate
5651         (append message-required-mail-headers
5652                 message-required-headers)
5653         message-generate-headers-first
5654         '(Lines Subject)))))
5655   (run-hooks 'message-signature-setup-hook)
5656   (message-insert-signature)
5657   (save-restriction
5658     (message-narrow-to-headers)
5659     (run-hooks 'message-header-setup-hook))
5660   (set-buffer-modified-p nil)
5661   (setq buffer-undo-list nil)
5662   (when message-generate-hashcash
5663     ;; Generate hashcash headers for recipients already known
5664     (mail-add-payment-async))
5665   (run-hooks 'message-setup-hook)
5666   ;; Do this last to give it precedence over posting styles, etc.
5667   (when (message-mail-p)
5668     (save-restriction
5669       (message-narrow-to-headers)
5670       (if message-alternative-emails
5671           (message-use-alternative-email-as-from))))
5672   (message-position-point)
5673   (undo-boundary))
5674
5675 (defun message-set-auto-save-file-name ()
5676   "Associate the message buffer with a file in the drafts directory."
5677   (when message-auto-save-directory
5678     (unless (file-directory-p
5679              (directory-file-name message-auto-save-directory))
5680       (make-directory message-auto-save-directory t))
5681     (if (gnus-alive-p)
5682         (setq message-draft-article
5683               (nndraft-request-associate-buffer "drafts"))
5684       (setq buffer-file-name (expand-file-name
5685                               (if (memq system-type
5686                                         '(ms-dos ms-windows windows-nt
5687                                                  cygwin cygwin32 win32 w32
5688                                                  mswindows))
5689                                   "message"
5690                                 "*message*")
5691                               message-auto-save-directory))
5692       (setq buffer-auto-save-file-name (make-auto-save-file-name)))
5693     (clear-visited-file-modtime)
5694     (setq buffer-file-coding-system message-draft-coding-system)))
5695
5696 (defun message-disassociate-draft ()
5697   "Disassociate the message buffer from the drafts directory."
5698   (when message-draft-article
5699     (nndraft-request-expire-articles
5700      (list message-draft-article) "drafts" nil t)))
5701
5702 (defun message-insert-headers ()
5703   "Generate the headers for the article."
5704   (interactive)
5705   (save-excursion
5706     (save-restriction
5707       (message-narrow-to-headers)
5708       (when (message-news-p)
5709         (message-generate-headers
5710          (delq 'Lines
5711                (delq 'Subject
5712                      (copy-sequence message-required-news-headers)))))
5713       (when (message-mail-p)
5714         (message-generate-headers
5715          (delq 'Lines
5716                (delq 'Subject
5717                      (copy-sequence message-required-mail-headers))))))))
5718
5719 \f
5720
5721 ;;;
5722 ;;; Commands for interfacing with message
5723 ;;;
5724
5725 ;;;###autoload
5726 (defun message-mail (&optional to subject
5727                                other-headers continue switch-function
5728                                yank-action send-actions)
5729   "Start editing a mail message to be sent.
5730 OTHER-HEADERS is an alist of header/value pairs."
5731   (interactive)
5732   (let ((message-this-is-mail t) replybuffer)
5733     (unless (message-mail-user-agent)
5734       (message-pop-to-buffer (message-buffer-name "mail" to)))
5735     ;; FIXME: message-mail should do something if YANK-ACTION is not
5736     ;; insert-buffer.
5737     (and (consp yank-action) (eq (car yank-action) 'insert-buffer)
5738          (setq replybuffer (nth 1 yank-action)))
5739     (message-setup
5740      (nconc
5741       `((To . ,(or to "")) (Subject . ,(or subject "")))
5742       (when other-headers other-headers))
5743      replybuffer send-actions)
5744     ;; FIXME: Should return nil if failure.
5745     t))
5746
5747 ;;;###autoload
5748 (defun message-news (&optional newsgroups subject)
5749   "Start editing a news article to be sent."
5750   (interactive)
5751   (let ((message-this-is-news t))
5752     (message-pop-to-buffer (message-buffer-name "posting" nil newsgroups))
5753     (message-setup `((Newsgroups . ,(or newsgroups ""))
5754                      (Subject . ,(or subject ""))))))
5755
5756 (defun message-get-reply-headers (wide &optional to-address address-headers)
5757   (let (follow-to mct never-mct to cc author mft recipients extra)
5758     ;; Find all relevant headers we need.
5759     (save-restriction
5760       (message-narrow-to-headers-or-head)
5761       ;; Gmane renames "To".  Look at "Original-To", too, if it is present in
5762       ;; message-header-synonyms.
5763       (setq to (or (message-fetch-field "to")
5764                    (and (loop for synonym in message-header-synonyms
5765                               when (memq 'Original-To synonym)
5766                               return t)
5767                         (message-fetch-field "original-to")))
5768             cc (message-fetch-field "cc")
5769             extra (when message-extra-wide-headers
5770                     (mapconcat 'identity
5771                                (mapcar 'message-fetch-field
5772                                        message-extra-wide-headers)
5773                                ", "))
5774             mct (message-fetch-field "mail-copies-to")
5775             author (or (message-fetch-field "mail-reply-to")
5776                        (message-fetch-field "reply-to")
5777                        (message-fetch-field "from")
5778                        "")
5779             mft (and message-use-mail-followup-to
5780                      (message-fetch-field "mail-followup-to"))))
5781
5782     ;; Handle special values of Mail-Copies-To.
5783     (when mct
5784       (cond ((or (equal (downcase mct) "never")
5785                  (equal (downcase mct) "nobody"))
5786              (setq never-mct t)
5787              (setq mct nil))
5788             ((or (equal (downcase mct) "always")
5789                  (equal (downcase mct) "poster"))
5790              (setq mct author))))
5791
5792     (save-match-data
5793       ;; Build (textual) list of new recipient addresses.
5794       (cond
5795        ((not wide)
5796         (setq recipients (concat ", " author)))
5797        (address-headers
5798         (dolist (header address-headers)
5799           (let ((value (message-fetch-field header)))
5800             (when value
5801               (setq recipients (concat recipients ", " value))))))
5802        ((and mft
5803              (string-match "[^ \t,]" mft)
5804              (or (not (eq message-use-mail-followup-to 'ask))
5805                  (message-y-or-n-p "Obey Mail-Followup-To? " t "\
5806 You should normally obey the Mail-Followup-To: header.  In this
5807 article, it has the value of
5808
5809 " mft "
5810
5811 which directs your response to " (if (string-match "," mft)
5812                                      "the specified addresses"
5813                                    "that address only") ".
5814
5815 Most commonly, Mail-Followup-To is used by a mailing list poster to
5816 express that responses should be sent to just the list, and not the
5817 poster as well.
5818
5819 If a message is posted to several mailing lists, Mail-Followup-To may
5820 also be used to direct the following discussion to one list only,
5821 because discussions that are spread over several lists tend to be
5822 fragmented and very difficult to follow.
5823
5824 Also, some source/announcement lists are not intended for discussion;
5825 responses here are directed to other addresses.
5826
5827 You may customize the variable `message-use-mail-followup-to', if you
5828 want to get rid of this query permanently.")))
5829         (setq recipients (concat ", " mft)))
5830        (to-address
5831         (setq recipients (concat ", " to-address))
5832         ;; If the author explicitly asked for a copy, we don't deny it to them.
5833         (if mct (setq recipients (concat recipients ", " mct))))
5834        (t
5835         (setq recipients (if never-mct "" (concat ", " author)))
5836         (if to (setq recipients (concat recipients ", " to)))
5837         (if cc (setq recipients (concat recipients ", " cc)))
5838         (if extra (setq recipients (concat recipients ", " extra)))
5839         (if mct (setq recipients (concat recipients ", " mct)))))
5840       (if (>= (length recipients) 2)
5841           ;; Strip the leading ", ".
5842           (setq recipients (substring recipients 2)))
5843       ;; Squeeze whitespace.
5844       (while (string-match "[ \t][ \t]+" recipients)
5845         (setq recipients (replace-match " " t t recipients)))
5846       ;; Remove addresses that match `rmail-dont-reply-to-names'.
5847       (let ((rmail-dont-reply-to-names message-dont-reply-to-names))
5848         (setq recipients (rmail-dont-reply-to recipients)))
5849       ;; Perhaps "Mail-Copies-To: never" removed the only address?
5850       (if (string-equal recipients "")
5851           (setq recipients author))
5852       ;; Convert string to a list of (("foo@bar" . "Name <Foo@BAR>") ...).
5853       (setq recipients
5854             (mapcar
5855              (lambda (addr)
5856                (cons (downcase (mail-strip-quoted-names addr)) addr))
5857              (message-tokenize-header recipients)))
5858       ;; Remove first duplicates.  (Why not all duplicates?  Is this a bug?)
5859       (let ((s recipients))
5860         (while s
5861           (setq recipients (delq (assoc (car (pop s)) s) recipients))))
5862
5863       ;; Remove hierarchical lists that are contained within each other,
5864       ;; if message-hierarchical-addresses is defined.
5865       (when message-hierarchical-addresses
5866         (let ((plain-addrs (mapcar 'car recipients))
5867               subaddrs recip)
5868           (while plain-addrs
5869             (setq subaddrs (assoc (car plain-addrs)
5870                                   message-hierarchical-addresses)
5871                   plain-addrs (cdr plain-addrs))
5872             (when subaddrs
5873               (setq subaddrs (cdr subaddrs))
5874               (while subaddrs
5875                 (setq recip (assoc (car subaddrs) recipients)
5876                       subaddrs (cdr subaddrs))
5877                 (if recip
5878                     (setq recipients (delq recip recipients))))))))
5879
5880       ;; Build the header alist.  Allow the user to be asked whether
5881       ;; or not to reply to all recipients in a wide reply.
5882       (setq follow-to (list (cons 'To (cdr (pop recipients)))))
5883       (when (and recipients
5884                  (or (not message-wide-reply-confirm-recipients)
5885                      (y-or-n-p "Reply to all recipients? ")))
5886         (setq recipients (mapconcat
5887                           (lambda (addr) (cdr addr)) recipients ", "))
5888         (if (string-match "^ +" recipients)
5889             (setq recipients (substring recipients (match-end 0))))
5890         (push (cons 'Cc recipients) follow-to)))
5891     follow-to))
5892
5893 ;;;###autoload
5894 (defun message-reply (&optional to-address wide)
5895   "Start editing a reply to the article in the current buffer."
5896   (interactive)
5897   (require 'gnus-sum)                   ; for gnus-list-identifiers
5898   (let ((cur (current-buffer))
5899         from subject date reply-to to cc
5900         references message-id follow-to
5901         (inhibit-point-motion-hooks t)
5902         (message-this-is-mail t)
5903         gnus-warning)
5904     (save-restriction
5905       (message-narrow-to-head-1)
5906       ;; Allow customizations to have their say.
5907       (if (not wide)
5908           ;; This is a regular reply.
5909           (when (functionp message-reply-to-function)
5910             (save-excursion
5911               (setq follow-to (funcall message-reply-to-function))))
5912         ;; This is a followup.
5913         (when (functionp message-wide-reply-to-function)
5914           (save-excursion
5915             (setq follow-to
5916                   (funcall message-wide-reply-to-function)))))
5917       (setq message-id (message-fetch-field "message-id" t)
5918             references (message-fetch-field "references")
5919             date (message-fetch-field "date")
5920             from (message-fetch-field "from")
5921             subject (or (message-fetch-field "subject") "none"))
5922       (when gnus-list-identifiers
5923         (setq subject (message-strip-list-identifiers subject)))
5924       (setq subject (concat "Re: " (message-strip-subject-re subject)))
5925       (when message-subject-trailing-was-query
5926         (setq subject (message-strip-subject-trailing-was subject)))
5927
5928       (when (and (setq gnus-warning (message-fetch-field "gnus-warning"))
5929                  (string-match "<[^>]+>" gnus-warning))
5930         (setq message-id (match-string 0 gnus-warning)))
5931
5932       (unless follow-to
5933         (setq follow-to (message-get-reply-headers wide to-address))))
5934
5935     (unless (message-mail-user-agent)
5936       (message-pop-to-buffer
5937        (message-buffer-name
5938         (if wide "wide reply" "reply") from
5939         (if wide to-address nil))))
5940
5941     (setq message-reply-headers
5942           (vector 0 subject from date message-id references 0 0 ""))
5943
5944     (message-setup
5945      `((Subject . ,subject)
5946        ,@follow-to)
5947      cur)))
5948
5949 ;;;###autoload
5950 (defun message-wide-reply (&optional to-address)
5951   "Make a \"wide\" reply to the message in the current buffer."
5952   (interactive)
5953   (message-reply to-address t))
5954
5955 ;;;###autoload
5956 (defun message-followup (&optional to-newsgroups)
5957   "Follow up to the message in the current buffer.
5958 If TO-NEWSGROUPS, use that as the new Newsgroups line."
5959   (interactive)
5960   (require 'gnus-sum)                   ; for gnus-list-identifiers
5961   (let ((cur (current-buffer))
5962         from subject date reply-to mrt mct
5963         references message-id follow-to
5964         (inhibit-point-motion-hooks t)
5965         (message-this-is-news t)
5966         followup-to distribution newsgroups gnus-warning posted-to)
5967     (save-restriction
5968       (narrow-to-region
5969        (goto-char (point-min))
5970        (if (search-forward "\n\n" nil t)
5971            (1- (point))
5972          (point-max)))
5973       (when (functionp message-followup-to-function)
5974         (setq follow-to
5975               (funcall message-followup-to-function)))
5976       (setq from (message-fetch-field "from")
5977             date (message-fetch-field "date")
5978             subject (or (message-fetch-field "subject") "none")
5979             references (message-fetch-field "references")
5980             message-id (message-fetch-field "message-id" t)
5981             followup-to (message-fetch-field "followup-to")
5982             newsgroups (message-fetch-field "newsgroups")
5983             posted-to (message-fetch-field "posted-to")
5984             reply-to (message-fetch-field "reply-to")
5985             mrt (message-fetch-field "mail-reply-to")
5986             distribution (message-fetch-field "distribution")
5987             mct (message-fetch-field "mail-copies-to"))
5988       (when (and (setq gnus-warning (message-fetch-field "gnus-warning"))
5989                  (string-match "<[^>]+>" gnus-warning))
5990         (setq message-id (match-string 0 gnus-warning)))
5991       ;; Remove bogus distribution.
5992       (when (and (stringp distribution)
5993                  (let ((case-fold-search t))
5994                    (string-match "world" distribution)))
5995         (setq distribution nil))
5996       (if gnus-list-identifiers
5997           (setq subject (message-strip-list-identifiers subject)))
5998       (setq subject (concat "Re: " (message-strip-subject-re subject)))
5999       (when message-subject-trailing-was-query
6000         (setq subject (message-strip-subject-trailing-was subject)))
6001       (widen))
6002
6003     (message-pop-to-buffer (message-buffer-name "followup" from newsgroups))
6004
6005     (setq message-reply-headers
6006           (vector 0 subject from date message-id references 0 0 ""))
6007
6008     (message-setup
6009      `((Subject . ,subject)
6010        ,@(cond
6011           (to-newsgroups
6012            (list (cons 'Newsgroups to-newsgroups)))
6013           (follow-to follow-to)
6014           ((and followup-to message-use-followup-to)
6015            (list
6016             (cond
6017              ((equal (downcase followup-to) "poster")
6018               (if (or (eq message-use-followup-to 'use)
6019                       (message-y-or-n-p "Obey Followup-To: poster? " t "\
6020 You should normally obey the Followup-To: header.
6021
6022 `Followup-To: poster' sends your response via e-mail instead of news.
6023
6024 A typical situation where `Followup-To: poster' is used is when the poster
6025 does not read the newsgroup, so he wouldn't see any replies sent to it.
6026
6027 You may customize the variable `message-use-followup-to', if you
6028 want to get rid of this query permanently."))
6029                   (progn
6030                     (setq message-this-is-news nil)
6031                     (cons 'To (or mrt reply-to from "")))
6032                 (cons 'Newsgroups newsgroups)))
6033              (t
6034               (if (or (equal followup-to newsgroups)
6035                       (not (eq message-use-followup-to 'ask))
6036                       (message-y-or-n-p
6037                        (concat "Obey Followup-To: " followup-to "? ") t "\
6038 You should normally obey the Followup-To: header.
6039
6040         `Followup-To: " followup-to "'
6041 directs your response to " (if (string-match "," followup-to)
6042                                "the specified newsgroups"
6043                              "that newsgroup only") ".
6044
6045 If a message is posted to several newsgroups, Followup-To is often
6046 used to direct the following discussion to one newsgroup only,
6047 because discussions that are spread over several newsgroup tend to
6048 be fragmented and very difficult to follow.
6049
6050 Also, some source/announcement newsgroups are not intended for discussion;
6051 responses here are directed to other newsgroups.
6052
6053 You may customize the variable `message-use-followup-to', if you
6054 want to get rid of this query permanently."))
6055                   (cons 'Newsgroups followup-to)
6056                 (cons 'Newsgroups newsgroups))))))
6057           (posted-to
6058            `((Newsgroups . ,posted-to)))
6059           (t
6060            `((Newsgroups . ,newsgroups))))
6061        ,@(and distribution (list (cons 'Distribution distribution)))
6062        ,@(when (and mct
6063                     (not (or (equal (downcase mct) "never")
6064                              (equal (downcase mct) "nobody"))))
6065            (list (cons 'Cc (if (or (equal (downcase mct) "always")
6066                                    (equal (downcase mct) "poster"))
6067                                (or mrt reply-to from "")
6068                              mct)))))
6069
6070      cur)))
6071
6072 (defun message-is-yours-p ()
6073   "Non-nil means current article is yours.
6074 If you have added 'cancel-messages to `message-shoot-gnksa-feet', all articles
6075 are yours except those that have Cancel-Lock header not belonging to you.
6076 Instead of shooting GNKSA feet, you should modify `message-alternative-emails'
6077 regexp to match all of yours addresses."
6078   ;; Canlock-logic as suggested by Per Abrahamsen
6079   ;; <abraham@dina.kvl.dk>
6080   ;;
6081   ;; IF article has cancel-lock THEN
6082   ;;   IF we can verify it THEN
6083   ;;     issue cancel
6084   ;;   ELSE
6085   ;;     error: cancellock: article is not yours
6086   ;; ELSE
6087   ;;   Use old rules, comparing sender...
6088   (save-excursion
6089     (save-restriction
6090       (message-narrow-to-head-1)
6091       (if (message-fetch-field "Cancel-Lock")
6092           (if (null (canlock-verify))
6093               t
6094             (error "Failed to verify Cancel-lock: This article is not yours"))
6095         (let (sender from)
6096           (or
6097            (message-gnksa-enable-p 'cancel-messages)
6098            (and (setq sender (message-fetch-field "sender"))
6099                 (string-equal (downcase sender)
6100                               (downcase (message-make-sender))))
6101            ;; Email address in From field equals to our address
6102            (and (setq from (message-fetch-field "from"))
6103                 (string-equal
6104                  (downcase (cadr (mail-extract-address-components from)))
6105                  (downcase (cadr (mail-extract-address-components
6106                                   (message-make-from))))))
6107            ;; Email address in From field matches
6108            ;; 'message-alternative-emails' regexp
6109            (and from
6110                 message-alternative-emails
6111                 (string-match
6112                  message-alternative-emails
6113                  (cadr (mail-extract-address-components from))))))))))
6114
6115 ;;;###autoload
6116 (defun message-cancel-news (&optional arg)
6117   "Cancel an article you posted.
6118 If ARG, allow editing of the cancellation message."
6119   (interactive "P")
6120   (unless (message-news-p)
6121     (error "This is not a news article; canceling is impossible"))
6122   (let (from newsgroups message-id distribution buf)
6123     (save-excursion
6124       ;; Get header info from original article.
6125       (save-restriction
6126         (message-narrow-to-head-1)
6127         (setq from (message-fetch-field "from")
6128               newsgroups (message-fetch-field "newsgroups")
6129               message-id (message-fetch-field "message-id" t)
6130               distribution (message-fetch-field "distribution")))
6131       ;; Make sure that this article was written by the user.
6132       (unless (message-is-yours-p)
6133         (error "This article is not yours"))
6134       (when (yes-or-no-p "Do you really want to cancel this article? ")
6135         ;; Make control message.
6136         (if arg
6137             (message-news)
6138           (setq buf (set-buffer (get-buffer-create " *message cancel*"))))
6139         (erase-buffer)
6140         (insert "Newsgroups: " newsgroups "\n"
6141                 "From: " from "\n"
6142                 "Subject: cmsg cancel " message-id "\n"
6143                 "Control: cancel " message-id "\n"
6144                 (if distribution
6145                     (concat "Distribution: " distribution "\n")
6146                   "")
6147                 mail-header-separator "\n"
6148                 message-cancel-message)
6149         (run-hooks 'message-cancel-hook)
6150         (unless arg
6151           (message "Canceling your article...")
6152           (if (let ((message-syntax-checks
6153                      'dont-check-for-anything-just-trust-me))
6154                 (funcall message-send-news-function))
6155               (message "Canceling your article...done"))
6156           (kill-buffer buf))))))
6157
6158 ;;;###autoload
6159 (defun message-supersede ()
6160   "Start composing a message to supersede the current message.
6161 This is done simply by taking the old article and adding a Supersedes
6162 header line with the old Message-ID."
6163   (interactive)
6164   (let ((cur (current-buffer)))
6165     ;; Check whether the user owns the article that is to be superseded.
6166     (unless (message-is-yours-p)
6167       (error "This article is not yours"))
6168     ;; Get a normal message buffer.
6169     (message-pop-to-buffer (message-buffer-name "supersede"))
6170     (insert-buffer-substring cur)
6171     (mime-to-mml)
6172     (message-narrow-to-head-1)
6173     ;; Remove unwanted headers.
6174     (when message-ignored-supersedes-headers
6175       (message-remove-header message-ignored-supersedes-headers t))
6176     (goto-char (point-min))
6177     (if (not (re-search-forward "^Message-ID: " nil t))
6178         (error "No Message-ID in this article")
6179       (replace-match "Supersedes: " t t))
6180     (goto-char (point-max))
6181     (insert mail-header-separator)
6182     (widen)
6183     (forward-line 1)))
6184
6185 ;;;###autoload
6186 (defun message-recover ()
6187   "Reread contents of current buffer from its last auto-save file."
6188   (interactive)
6189   (let ((file-name (make-auto-save-file-name)))
6190     (cond ((save-window-excursion
6191              (if (not (eq system-type 'vax-vms))
6192                  (with-output-to-temp-buffer "*Directory*"
6193                    (with-current-buffer standard-output
6194                      (fundamental-mode)) ; for Emacs 20.4+
6195                    (buffer-disable-undo standard-output)
6196                    (let ((default-directory "/"))
6197                      (call-process
6198                       "ls" nil standard-output nil "-l" file-name))))
6199              (yes-or-no-p (format "Recover auto save file %s? " file-name)))
6200            (let ((buffer-read-only nil))
6201              (erase-buffer)
6202              (insert-file-contents file-name nil)))
6203           (t (error "message-recover cancelled")))))
6204
6205 ;;; Washing Subject:
6206
6207 (defun message-wash-subject (subject)
6208   "Remove junk like \"Re:\", \"(fwd)\", etc. added to subject string SUBJECT.
6209 Previous forwarders, replyers, etc. may add it."
6210   (with-temp-buffer
6211     (insert subject)
6212     (goto-char (point-min))
6213     ;; strip Re/Fwd stuff off the beginning
6214     (while (re-search-forward
6215             "\\([Rr][Ee]:\\|[Ff][Ww][Dd]\\(\\[[0-9]*\\]\\)?:\\|[Ff][Ww]:\\)" nil t)
6216       (replace-match ""))
6217
6218     ;; and gnus-style forwards [foo@bar.com] subject
6219     (goto-char (point-min))
6220     (while (re-search-forward "\\[[^ \t]*\\(@\\|\\.\\)[^ \t]*\\]" nil t)
6221       (replace-match ""))
6222
6223     ;; and off the end
6224     (goto-char (point-max))
6225     (while (re-search-backward "([Ff][Ww][Dd])" nil t)
6226       (replace-match ""))
6227
6228     ;; and finally, any whitespace that was left-over
6229     (goto-char (point-min))
6230     (while (re-search-forward "^[ \t]+" nil t)
6231       (replace-match ""))
6232     (goto-char (point-max))
6233     (while (re-search-backward "[ \t]+$" nil t)
6234       (replace-match ""))
6235
6236     (buffer-string)))
6237
6238 ;;; Forwarding messages.
6239
6240 (defvar message-forward-decoded-p nil
6241   "Non-nil means the original message is decoded.")
6242
6243 (defun message-forward-subject-name-subject (subject)
6244   "Generate a SUBJECT for a forwarded message.
6245 The form is: [Source] Subject, where if the original message was mail,
6246 Source is the name of the sender, and if the original message was
6247 news, Source is the list of newsgroups is was posted to."
6248   (let* ((group (message-fetch-field "newsgroups"))
6249          (from (message-fetch-field "from"))
6250          (prefix
6251           (if group
6252               (gnus-group-decoded-name group)
6253             (or (and from (car (gnus-extract-address-components from)))
6254                 "(nowhere)"))))
6255     (concat "["
6256             (if message-forward-decoded-p
6257                 prefix
6258               (mail-decode-encoded-word-string prefix))
6259             "] " subject)))
6260
6261 (defun message-forward-subject-author-subject (subject)
6262   "Generate a SUBJECT for a forwarded message.
6263 The form is: [Source] Subject, where if the original message was mail,
6264 Source is the sender, and if the original message was news, Source is
6265 the list of newsgroups is was posted to."
6266   (let* ((group (message-fetch-field "newsgroups"))
6267          (prefix
6268           (if group
6269               (gnus-group-decoded-name group)
6270             (or (message-fetch-field "from")
6271                 "(nowhere)"))))
6272     (concat "["
6273             (if message-forward-decoded-p
6274                 prefix
6275               (mail-decode-encoded-word-string prefix))
6276             "] " subject)))
6277
6278 (defun message-forward-subject-fwd (subject)
6279   "Generate a SUBJECT for a forwarded message.
6280 The form is: Fwd: Subject, where Subject is the original subject of
6281 the message."
6282   (if (string-match "^Fwd: " subject)
6283       subject
6284     (concat "Fwd: " subject)))
6285
6286 (defun message-make-forward-subject ()
6287   "Return a Subject header suitable for the message in the current buffer."
6288   (save-excursion
6289     (save-restriction
6290       (message-narrow-to-head-1)
6291       (let ((funcs message-make-forward-subject-function)
6292             (subject (message-fetch-field "Subject")))
6293         (setq subject
6294               (if subject
6295                   (if message-forward-decoded-p
6296                       subject
6297                     (mail-decode-encoded-word-string subject))
6298                 ""))
6299         (when message-wash-forwarded-subjects
6300           (setq subject (message-wash-subject subject)))
6301         ;; Make sure funcs is a list.
6302         (and funcs
6303              (not (listp funcs))
6304              (setq funcs (list funcs)))
6305         ;; Apply funcs in order, passing subject generated by previous
6306         ;; func to the next one.
6307         (dolist (func funcs)
6308           (when (functionp func)
6309             (setq subject (funcall func subject))))
6310         subject))))
6311
6312 (eval-when-compile
6313   (defvar gnus-article-decoded-p))
6314
6315
6316 ;;;###autoload
6317 (defun message-forward (&optional news digest)
6318   "Forward the current message via mail.
6319 Optional NEWS will use news to forward instead of mail.
6320 Optional DIGEST will use digest to forward."
6321   (interactive "P")
6322   (let* ((cur (current-buffer))
6323          (message-forward-decoded-p
6324           (if (local-variable-p 'gnus-article-decoded-p (current-buffer))
6325               gnus-article-decoded-p ;; In an article buffer.
6326             message-forward-decoded-p))
6327          (subject (message-make-forward-subject)))
6328     (if news
6329         (message-news nil subject)
6330       (message-mail nil subject))
6331     (message-forward-make-body cur digest)))
6332
6333 (defun message-forward-make-body-plain (forward-buffer)
6334   (insert
6335    "\n-------------------- Start of forwarded message --------------------\n")
6336   (let ((b (point)) e)
6337     (insert
6338      (with-temp-buffer
6339        (mm-disable-multibyte)
6340        (insert
6341         (with-current-buffer forward-buffer
6342           (mm-with-unibyte-current-buffer (buffer-string))))
6343        (mm-enable-multibyte)
6344        (mime-to-mml)
6345        (goto-char (point-min))
6346        (when (looking-at "From ")
6347          (replace-match "X-From-Line: "))
6348        (buffer-string)))
6349     (setq e (point))
6350     (insert
6351      "\n-------------------- End of forwarded message --------------------\n")
6352     (when message-forward-ignored-headers
6353       (save-restriction
6354         (narrow-to-region b e)
6355         (goto-char b)
6356         (narrow-to-region (point)
6357                           (or (search-forward "\n\n" nil t) (point)))
6358         (message-remove-header message-forward-ignored-headers t)))))
6359
6360 (defun message-forward-make-body-mime (forward-buffer)
6361   (insert "\n\n<#part type=message/rfc822 disposition=inline raw=t>\n")
6362   (let ((b (point)) e)
6363     (save-restriction
6364       (narrow-to-region (point) (point))
6365       (mml-insert-buffer forward-buffer)
6366       (goto-char (point-min))
6367       (when (looking-at "From ")
6368         (replace-match "X-From-Line: "))
6369       (goto-char (point-max)))
6370     (setq e (point))
6371     (insert "<#/part>\n")))
6372
6373 (defun message-forward-make-body-mml (forward-buffer)
6374   (insert "\n\n<#mml type=message/rfc822 disposition=inline>\n")
6375   (let ((b (point)) e)
6376     (if (not message-forward-decoded-p)
6377         (insert
6378          (with-temp-buffer
6379            (mm-disable-multibyte)
6380            (insert
6381             (with-current-buffer forward-buffer
6382               (mm-with-unibyte-current-buffer (buffer-string))))
6383            (mm-enable-multibyte)
6384            (mime-to-mml)
6385            (goto-char (point-min))
6386            (when (looking-at "From ")
6387              (replace-match "X-From-Line: "))
6388            (buffer-string)))
6389       (save-restriction
6390         (narrow-to-region (point) (point))
6391         (mml-insert-buffer forward-buffer)
6392         (goto-char (point-min))
6393         (when (looking-at "From ")
6394           (replace-match "X-From-Line: "))
6395         (goto-char (point-max))))
6396     (setq e (point))
6397     (insert "<#/mml>\n")
6398     (when (and (not message-forward-decoded-p)
6399                message-forward-ignored-headers)
6400       (save-restriction
6401         (narrow-to-region b e)
6402         (goto-char b)
6403         (narrow-to-region (point)
6404                           (or (search-forward "\n\n" nil t) (point)))
6405         (message-remove-header message-forward-ignored-headers t)))))
6406
6407 (defun message-forward-make-body-digest-plain (forward-buffer)
6408   (insert
6409    "\n-------------------- Start of forwarded message --------------------\n")
6410   (let ((b (point)) e)
6411     (mml-insert-buffer forward-buffer)
6412     (setq e (point))
6413     (insert
6414      "\n-------------------- End of forwarded message --------------------\n")))
6415
6416 (defun message-forward-make-body-digest-mime (forward-buffer)
6417   (insert "\n<#multipart type=digest>\n")
6418   (let ((b (point)) e)
6419     (insert-buffer-substring forward-buffer)
6420     (setq e (point))
6421     (insert "<#/multipart>\n")
6422     (save-restriction
6423       (narrow-to-region b e)
6424       (goto-char b)
6425       (narrow-to-region (point)
6426                         (or (search-forward "\n\n" nil t) (point)))
6427       (delete-region (point-min) (point-max)))))
6428
6429 (defun message-forward-make-body-digest (forward-buffer)
6430   (if message-forward-as-mime
6431       (message-forward-make-body-digest-mime forward-buffer)
6432     (message-forward-make-body-digest-plain forward-buffer)))
6433
6434 ;;;###autoload
6435 (defun message-forward-make-body (forward-buffer &optional digest)
6436   ;; Put point where we want it before inserting the forwarded
6437   ;; message.
6438   (if message-forward-before-signature
6439       (message-goto-body)
6440     (goto-char (point-max)))
6441   (if digest
6442       (message-forward-make-body-digest forward-buffer)
6443     (if message-forward-as-mime
6444         (if (and message-forward-show-mml
6445                  (not (and (eq message-forward-show-mml 'best)
6446                            (with-current-buffer forward-buffer
6447                              (goto-char (point-min))
6448                              (re-search-forward
6449                               "Content-Type: *multipart/\\(signed\\|encrypted\\)"
6450                               nil t)))))
6451             (message-forward-make-body-mml forward-buffer)
6452           (message-forward-make-body-mime forward-buffer))
6453       (message-forward-make-body-plain forward-buffer)))
6454   (message-position-point))
6455
6456 ;;;###autoload
6457 (defun message-forward-rmail-make-body (forward-buffer)
6458   (save-window-excursion
6459     (set-buffer forward-buffer)
6460     (if (rmail-msg-is-pruned)
6461         (rmail-msg-restore-non-pruned-header)))
6462   (message-forward-make-body forward-buffer))
6463
6464 (eval-when-compile (defvar rmail-enable-mime-composing))
6465
6466 ;; Fixme: Should have defcustom.
6467 ;;;###autoload
6468 (defun message-insinuate-rmail ()
6469   "Let RMAIL use message to forward."
6470   (interactive)
6471   (setq rmail-enable-mime-composing t)
6472   (setq rmail-insert-mime-forwarded-message-function
6473         'message-forward-rmail-make-body))
6474
6475 ;;;###autoload
6476 (defun message-resend (address)
6477   "Resend the current article to ADDRESS."
6478   (interactive
6479    (list (message-read-from-minibuffer "Resend message to: ")))
6480   (message "Resending message to %s..." address)
6481   (save-excursion
6482     (let ((cur (current-buffer))
6483           beg)
6484       ;; We first set up a normal mail buffer.
6485       (unless (message-mail-user-agent)
6486         (set-buffer (get-buffer-create " *message resend*"))
6487         (erase-buffer))
6488       (let ((message-this-is-mail t)
6489             message-setup-hook)
6490         (message-setup `((To . ,address))))
6491       ;; Insert our usual headers.
6492       (message-generate-headers '(From Date To Message-ID))
6493       (message-narrow-to-headers)
6494       ;; Remove X-Draft-From header etc.
6495       (message-remove-header message-ignored-mail-headers t)
6496       ;; Rename them all to "Resent-*".
6497       (goto-char (point-min))
6498       (while (re-search-forward "^[A-Za-z]" nil t)
6499         (forward-char -1)
6500         (insert "Resent-"))
6501       (widen)
6502       (forward-line)
6503       (delete-region (point) (point-max))
6504       (setq beg (point))
6505       ;; Insert the message to be resent.
6506       (insert-buffer-substring cur)
6507       (goto-char (point-min))
6508       (search-forward "\n\n")
6509       (forward-char -1)
6510       (save-restriction
6511         (narrow-to-region beg (point))
6512         (message-remove-header message-ignored-resent-headers t)
6513         (goto-char (point-max)))
6514       (insert mail-header-separator)
6515       ;; Rename all old ("Also-")Resent headers.
6516       (while (re-search-backward "^\\(Also-\\)*Resent-" beg t)
6517         (beginning-of-line)
6518         (insert "Also-"))
6519       ;; Quote any "From " lines at the beginning.
6520       (goto-char beg)
6521       (when (looking-at "From ")
6522         (replace-match "X-From-Line: "))
6523       ;; Send it.
6524       (let ((message-inhibit-body-encoding t)
6525             message-required-mail-headers
6526             rfc2047-encode-encoded-words)
6527         (message-send-mail))
6528       (kill-buffer (current-buffer)))
6529     (message "Resending message to %s...done" address)))
6530
6531 ;;;###autoload
6532 (defun message-bounce ()
6533   "Re-mail the current message.
6534 This only makes sense if the current message is a bounce message that
6535 contains some mail you have written which has been bounced back to
6536 you."
6537   (interactive)
6538   (let ((handles (mm-dissect-buffer t))
6539         boundary)
6540     (message-pop-to-buffer (message-buffer-name "bounce"))
6541     (if (stringp (car handles))
6542         ;; This is a MIME bounce.
6543         (mm-insert-part (car (last handles)))
6544       ;; This is a non-MIME bounce, so we try to remove things
6545       ;; manually.
6546       (mm-insert-part handles)
6547       (undo-boundary)
6548       (goto-char (point-min))
6549       (re-search-forward "\n\n+" nil t)
6550       (setq boundary (point))
6551       ;; We remove everything before the bounced mail.
6552       (if (or (re-search-forward message-unsent-separator nil t)
6553               (progn
6554                 (search-forward "\n\n" nil 'move)
6555                 (re-search-backward "^Return-Path:.*\n" boundary t)))
6556           (progn
6557             (forward-line 1)
6558             (delete-region (point-min)
6559                            (if (re-search-forward "^[^ \n\t]+:" nil t)
6560                                (match-beginning 0)
6561                              (point))))
6562         (goto-char boundary)
6563         (when (re-search-backward "^.?From .*\n" nil t)
6564           (delete-region (match-beginning 0) (match-end 0)))))
6565     (mm-enable-multibyte)
6566     (save-restriction
6567       (message-narrow-to-head-1)
6568       (message-remove-header message-ignored-bounced-headers t)
6569       (goto-char (point-max))
6570       (insert mail-header-separator))
6571     (message-position-point)))
6572
6573 ;;;
6574 ;;; Interactive entry points for new message buffers.
6575 ;;;
6576
6577 ;;;###autoload
6578 (defun message-mail-other-window (&optional to subject)
6579   "Like `message-mail' command, but display mail buffer in another window."
6580   (interactive)
6581   (unless (message-mail-user-agent)
6582     (let ((pop-up-windows t)
6583           (special-display-buffer-names nil)
6584           (special-display-regexps nil)
6585           (same-window-buffer-names nil)
6586           (same-window-regexps nil))
6587       (message-pop-to-buffer (message-buffer-name "mail" to))))
6588   (let ((message-this-is-mail t))
6589     (message-setup `((To . ,(or to "")) (Subject . ,(or subject "")))
6590                    nil nil 'switch-to-buffer-other-window)))
6591
6592 ;;;###autoload
6593 (defun message-mail-other-frame (&optional to subject)
6594   "Like `message-mail' command, but display mail buffer in another frame."
6595   (interactive)
6596   (unless (message-mail-user-agent)
6597     (let ((pop-up-frames t)
6598           (special-display-buffer-names nil)
6599           (special-display-regexps nil)
6600           (same-window-buffer-names nil)
6601           (same-window-regexps nil))
6602       (message-pop-to-buffer (message-buffer-name "mail" to))))
6603   (let ((message-this-is-mail t))
6604     (message-setup `((To . ,(or to "")) (Subject . ,(or subject "")))
6605                    nil nil 'switch-to-buffer-other-frame)))
6606
6607 ;;;###autoload
6608 (defun message-news-other-window (&optional newsgroups subject)
6609   "Start editing a news article to be sent."
6610   (interactive)
6611   (let ((pop-up-windows t)
6612         (special-display-buffer-names nil)
6613         (special-display-regexps nil)
6614         (same-window-buffer-names nil)
6615         (same-window-regexps nil))
6616     (message-pop-to-buffer (message-buffer-name "posting" nil newsgroups)))
6617   (let ((message-this-is-news t))
6618     (message-setup `((Newsgroups . ,(or newsgroups ""))
6619                      (Subject . ,(or subject ""))))))
6620
6621 ;;;###autoload
6622 (defun message-news-other-frame (&optional newsgroups subject)
6623   "Start editing a news article to be sent."
6624   (interactive)
6625   (let ((pop-up-frames t)
6626         (special-display-buffer-names nil)
6627         (special-display-regexps nil)
6628         (same-window-buffer-names nil)
6629         (same-window-regexps nil))
6630     (message-pop-to-buffer (message-buffer-name "posting" nil newsgroups)))
6631   (let ((message-this-is-news t))
6632     (message-setup `((Newsgroups . ,(or newsgroups ""))
6633                      (Subject . ,(or subject ""))))))
6634
6635 ;;; underline.el
6636
6637 ;; This code should be moved to underline.el (from which it is stolen).
6638
6639 ;;;###autoload
6640 (defun message-bold-region (start end)
6641   "Bold all nonblank characters in the region.
6642 Works by overstriking characters.
6643 Called from program, takes two arguments START and END
6644 which specify the range to operate on."
6645   (interactive "r")
6646   (save-excursion
6647     (let ((end1 (make-marker)))
6648       (move-marker end1 (max start end))
6649       (goto-char (min start end))
6650       (while (< (point) end1)
6651         (or (looking-at "[_\^@- ]")
6652             (insert (char-after) "\b"))
6653         (forward-char 1)))))
6654
6655 ;;;###autoload
6656 (defun message-unbold-region (start end)
6657   "Remove all boldness (overstruck characters) in the region.
6658 Called from program, takes two arguments START and END
6659 which specify the range to operate on."
6660   (interactive "r")
6661   (save-excursion
6662     (let ((end1 (make-marker)))
6663       (move-marker end1 (max start end))
6664       (goto-char (min start end))
6665       (while (search-forward "\b" end1 t)
6666         (if (eq (char-after) (char-after (- (point) 2)))
6667             (delete-char -2))))))
6668
6669 (defun message-exchange-point-and-mark ()
6670   "Exchange point and mark, but don't activate region if it was inactive."
6671   (unless (prog1
6672               (message-mark-active-p)
6673             (exchange-point-and-mark))
6674     (setq mark-active nil)))
6675
6676 (defalias 'message-make-overlay 'make-overlay)
6677 (defalias 'message-delete-overlay 'delete-overlay)
6678 (defalias 'message-overlay-put 'overlay-put)
6679 (defun message-kill-all-overlays ()
6680   (if (featurep 'xemacs)
6681       (map-extents (lambda (extent ignore) (delete-extent extent)))
6682     (mapcar #'delete-overlay (overlays-in (point-min) (point-max)))))
6683
6684 ;; Support for toolbar
6685 (eval-when-compile
6686   (defvar tool-bar-map)
6687   (defvar tool-bar-mode))
6688
6689 (defun message-tool-bar-local-item-from-menu (command icon in-map &optional from-map &rest props)
6690   ;; We need to make tool bar entries in local keymaps with
6691   ;; `tool-bar-local-item-from-menu' in Emacs > 21.3
6692   (if (fboundp 'tool-bar-local-item-from-menu)
6693       ;; This is for Emacs 21.3
6694       (tool-bar-local-item-from-menu command icon in-map from-map props)
6695     (tool-bar-add-item-from-menu command icon from-map props)))
6696
6697 (defun message-tool-bar-map ()
6698   (or message-tool-bar-map
6699       (setq message-tool-bar-map
6700             (and
6701              (condition-case nil (require 'tool-bar) (error nil))
6702              (fboundp 'tool-bar-add-item-from-menu)
6703              tool-bar-mode
6704              (let ((tool-bar-map (copy-keymap tool-bar-map))
6705                    (load-path (mm-image-load-path)))
6706                ;; Zap some items which aren't so relevant and take
6707                ;; up space.
6708                (dolist (key '(print-buffer kill-buffer save-buffer
6709                                            write-file dired open-file))
6710                  (define-key tool-bar-map (vector key) nil))
6711                (message-tool-bar-local-item-from-menu
6712                 'message-send-and-exit "mail_send" tool-bar-map message-mode-map)
6713                (message-tool-bar-local-item-from-menu
6714                 'message-kill-buffer "close" tool-bar-map message-mode-map)
6715                (message-tool-bar-local-item-from-menu
6716                     'message-dont-send "cancel" tool-bar-map message-mode-map)
6717                (message-tool-bar-local-item-from-menu
6718                 'mml-attach-file "attach" tool-bar-map mml-mode-map)
6719                (message-tool-bar-local-item-from-menu
6720                 'ispell-message "spell" tool-bar-map message-mode-map)
6721                (message-tool-bar-local-item-from-menu
6722                 'mml-preview "preview"
6723                 tool-bar-map mml-mode-map)
6724                (message-tool-bar-local-item-from-menu
6725                 'message-insert-importance-high "important"
6726                 tool-bar-map message-mode-map)
6727                (message-tool-bar-local-item-from-menu
6728                 'message-insert-importance-low "unimportant"
6729                 tool-bar-map message-mode-map)
6730                (message-tool-bar-local-item-from-menu
6731                 'message-insert-disposition-notification-to "receipt"
6732                 tool-bar-map message-mode-map)
6733                tool-bar-map)))))
6734
6735 ;;; Group name completion.
6736
6737 (defcustom message-newgroups-header-regexp
6738   "^\\(Newsgroups\\|Followup-To\\|Posted-To\\|Gcc\\):"
6739   "Regexp that match headers that lists groups."
6740   :group 'message
6741   :type 'regexp)
6742
6743 (defcustom message-completion-alist
6744   (list (cons message-newgroups-header-regexp 'message-expand-group)
6745         '("^\\(Resent-\\)?\\(To\\|B?Cc\\):" . message-expand-name)
6746         '("^\\(Reply-To\\|From\\|Mail-Followup-To\\|Mail-Copies-To\\):"
6747           . message-expand-name)
6748         '("^\\(Disposition-Notification-To\\|Return-Receipt-To\\):"
6749           . message-expand-name))
6750   "Alist of (RE . FUN).  Use FUN for completion on header lines matching RE."
6751   :version "22.1"
6752   :group 'message
6753   :type '(alist :key-type regexp :value-type function))
6754
6755 (defcustom message-expand-name-databases
6756   (list 'bbdb 'eudc)
6757   "List of databases to try for name completion (`message-expand-name').
6758 Each element is a symbol and can be `bbdb' or `eudc'."
6759   :group 'message
6760   :type '(set (const bbdb) (const eudc)))
6761
6762 (defcustom message-tab-body-function nil
6763   "*Function to execute when `message-tab' (TAB) is executed in the body.
6764 If nil, the function bound in `text-mode-map' or `global-map' is executed."
6765   :version "22.1"
6766   :group 'message
6767   :link '(custom-manual "(message)Various Commands")
6768   :type '(choice (const nil)
6769                  function))
6770
6771 (defun message-tab ()
6772   "Complete names according to `message-completion-alist'.
6773 Execute function specified by `message-tab-body-function' when not in
6774 those headers."
6775   (interactive)
6776   (let ((alist message-completion-alist))
6777     (while (and alist
6778                 (let ((mail-abbrev-mode-regexp (caar alist)))
6779                   (not (mail-abbrev-in-expansion-header-p))))
6780       (setq alist (cdr alist)))
6781     (funcall (or (cdar alist) message-tab-body-function
6782                  (lookup-key text-mode-map "\t")
6783                  (lookup-key global-map "\t")
6784                  'indent-relative))))
6785
6786 (defun message-expand-group ()
6787   "Expand the group name under point."
6788   (let* ((b (save-excursion
6789               (save-restriction
6790                 (narrow-to-region
6791                  (save-excursion
6792                    (beginning-of-line)
6793                    (skip-chars-forward "^:")
6794                    (1+ (point)))
6795                  (point))
6796                 (skip-chars-backward "^, \t\n") (point))))
6797          (completion-ignore-case t)
6798          (string (buffer-substring b (progn (skip-chars-forward "^,\t\n ")
6799                                             (point))))
6800          (hashtb (and (boundp 'gnus-active-hashtb) gnus-active-hashtb))
6801          (completions (all-completions string hashtb))
6802          comp)
6803     (delete-region b (point))
6804     (cond
6805      ((= (length completions) 1)
6806       (if (string= (car completions) string)
6807           (progn
6808             (insert string)
6809             (message "Only matching group"))
6810         (insert (car completions))))
6811      ((and (setq comp (try-completion string hashtb))
6812            (not (string= comp string)))
6813       (insert comp))
6814      (t
6815       (insert string)
6816       (if (not comp)
6817           (message "No matching groups")
6818         (save-selected-window
6819           (pop-to-buffer "*Completions*")
6820           (buffer-disable-undo)
6821           (let ((buffer-read-only nil))
6822             (erase-buffer)
6823             (let ((standard-output (current-buffer)))
6824               (display-completion-list (sort completions 'string<)))
6825             (goto-char (point-min))
6826             (delete-region (point) (progn (forward-line 3) (point))))))))))
6827
6828 (defun message-expand-name ()
6829   (cond ((and (memq 'eudc message-expand-name-databases)
6830                     (boundp 'eudc-protocol)
6831                     eudc-protocol)
6832          (eudc-expand-inline))
6833         ((and (memq 'bbdb message-expand-name-databases)
6834               (fboundp 'bbdb-complete-name))
6835          (bbdb-complete-name))
6836         (t
6837          (expand-abbrev))))
6838
6839 ;;; Help stuff.
6840
6841 (defun message-talkative-question (ask question show &rest text)
6842   "Call FUNCTION with argument QUESTION; optionally display TEXT... args.
6843 If SHOW is non-nil, the arguments TEXT... are displayed in a temp buffer.
6844 The following arguments may contain lists of values."
6845   (if (and show
6846            (setq text (message-flatten-list text)))
6847       (save-window-excursion
6848         (save-excursion
6849           (with-output-to-temp-buffer " *MESSAGE information message*"
6850             (set-buffer " *MESSAGE information message*")
6851             (fundamental-mode)          ; for Emacs 20.4+
6852             (mapcar 'princ text)
6853             (goto-char (point-min))))
6854         (funcall ask question))
6855     (funcall ask question)))
6856
6857 (defun message-flatten-list (list)
6858   "Return a new, flat list that contains all elements of LIST.
6859
6860 \(message-flatten-list '(1 (2 3 (4 5 (6))) 7))
6861 => (1 2 3 4 5 6 7)"
6862   (cond ((consp list)
6863          (apply 'append (mapcar 'message-flatten-list list)))
6864         (list
6865          (list list))))
6866
6867 (defun message-generate-new-buffer-clone-locals (name &optional varstr)
6868   "Create and return a buffer with name based on NAME using `generate-new-buffer'.
6869 Then clone the local variables and values from the old buffer to the
6870 new one, cloning only the locals having a substring matching the
6871 regexp VARSTR."
6872   (let ((oldbuf (current-buffer)))
6873     (save-excursion
6874       (set-buffer (generate-new-buffer name))
6875       (message-clone-locals oldbuf varstr)
6876       (current-buffer))))
6877
6878 (defun message-clone-locals (buffer &optional varstr)
6879   "Clone the local variables from BUFFER to the current buffer."
6880   (let ((locals (save-excursion
6881                   (set-buffer buffer)
6882                   (buffer-local-variables)))
6883         (regexp "^gnus\\|^nn\\|^message\\|^sendmail\\|^smtp\\|^user-mail-address"))
6884     (mapcar
6885      (lambda (local)
6886        (when (and (consp local)
6887                   (car local)
6888                   (string-match regexp (symbol-name (car local)))
6889                   (or (null varstr)
6890                       (string-match varstr (symbol-name (car local)))))
6891          (ignore-errors
6892            (set (make-local-variable (car local))
6893                 (cdr local)))))
6894      locals)))
6895
6896 ;;;
6897 ;;; MIME functions
6898 ;;;
6899
6900 (defvar message-inhibit-body-encoding nil)
6901
6902 (defun message-encode-message-body ()
6903   (unless message-inhibit-body-encoding
6904     (let ((mail-parse-charset (or mail-parse-charset
6905                                   message-default-charset))
6906           (case-fold-search t)
6907           lines content-type-p)
6908       (message-goto-body)
6909       (save-restriction
6910         (narrow-to-region (point) (point-max))
6911         (let ((new (mml-generate-mime)))
6912           (when new
6913             (delete-region (point-min) (point-max))
6914             (insert new)
6915             (goto-char (point-min))
6916             (if (eq (aref new 0) ?\n)
6917                 (delete-char 1)
6918               (search-forward "\n\n")
6919               (setq lines (buffer-substring (point-min) (1- (point))))
6920               (delete-region (point-min) (point))))))
6921       (save-restriction
6922         (message-narrow-to-headers-or-head)
6923         (message-remove-header "Mime-Version")
6924         (goto-char (point-max))
6925         (insert "MIME-Version: 1.0\n")
6926         (when lines
6927           (insert lines))
6928         (setq content-type-p
6929               (or mml-boundary
6930                   (re-search-backward "^Content-Type:" nil t))))
6931       (save-restriction
6932         (message-narrow-to-headers-or-head)
6933         (message-remove-first-header "Content-Type")
6934         (message-remove-first-header "Content-Transfer-Encoding"))
6935       ;; We always make sure that the message has a Content-Type
6936       ;; header.  This is because some broken MTAs and MUAs get
6937       ;; awfully confused when confronted with a message with a
6938       ;; MIME-Version header and without a Content-Type header.  For
6939       ;; instance, Solaris' /usr/bin/mail.
6940       (unless content-type-p
6941         (goto-char (point-min))
6942         ;; For unknown reason, MIME-Version doesn't exist.
6943         (when (re-search-forward "^MIME-Version:" nil t)
6944           (forward-line 1)
6945           (insert "Content-Type: text/plain; charset=us-ascii\n"))))))
6946
6947 (defun message-read-from-minibuffer (prompt &optional initial-contents)
6948   "Read from the minibuffer while providing abbrev expansion."
6949   (if (fboundp 'mail-abbrevs-setup)
6950       (let ((mail-abbrev-mode-regexp "")
6951             (minibuffer-setup-hook 'mail-abbrevs-setup)
6952             (minibuffer-local-map message-minibuffer-local-map))
6953         (read-from-minibuffer prompt initial-contents))
6954     (let ((minibuffer-setup-hook 'mail-abbrev-minibuffer-setup-hook)
6955           (minibuffer-local-map message-minibuffer-local-map))
6956       (read-string prompt initial-contents))))
6957
6958 (defun message-use-alternative-email-as-from ()
6959   "Set From field of the outgoing message to the first matching
6960 address in `message-alternative-emails', looking at To, Cc and
6961 From headers in the original article."
6962   (require 'mail-utils)
6963   (let* ((fields '("To" "Cc" "From"))
6964          (emails
6965           (split-string
6966            (mail-strip-quoted-names
6967             (mapconcat 'message-fetch-reply-field fields ","))
6968            "[ \f\t\n\r\v,]+"))
6969          email)
6970     (while emails
6971       (if (string-match message-alternative-emails (car emails))
6972           (setq email (car emails)
6973                 emails nil))
6974       (pop emails))
6975     (unless (or (not email) (equal email user-mail-address))
6976       (message-remove-header "From")
6977       (goto-char (point-max))
6978       (insert "From: " (let ((user-mail-address email)) (message-make-from))
6979               "\n"))))
6980
6981 (defun message-options-get (symbol)
6982   (cdr (assq symbol message-options)))
6983
6984 (defun message-options-set (symbol value)
6985   (let ((the-cons (assq symbol message-options)))
6986     (if the-cons
6987         (if value
6988             (setcdr the-cons value)
6989           (setq message-options (delq the-cons message-options)))
6990       (and value
6991            (push (cons symbol value) message-options))))
6992   value)
6993
6994 (defun message-options-set-recipient ()
6995   (save-restriction
6996     (message-narrow-to-headers-or-head)
6997     (message-options-set 'message-sender
6998                          (mail-strip-quoted-names
6999                           (message-fetch-field "from")))
7000     (message-options-set 'message-recipients
7001                          (mail-strip-quoted-names
7002                           (let ((to (message-fetch-field "to"))
7003                                 (cc (message-fetch-field "cc"))
7004                                 (bcc (message-fetch-field "bcc")))
7005                             (concat
7006                              (or to "")
7007                              (if (and to cc) ", ")
7008                              (or cc "")
7009                              (if (and (or to cc) bcc) ", ")
7010                              (or bcc "")))))))
7011
7012 (defun message-hide-headers ()
7013   "Hide headers based on the `message-hidden-headers' variable."
7014   (let ((regexps (if (stringp message-hidden-headers)
7015                      (list message-hidden-headers)
7016                    message-hidden-headers))
7017         (inhibit-point-motion-hooks t)
7018         (after-change-functions nil)
7019         (end-of-headers 0))
7020     (when regexps
7021       (save-excursion
7022         (save-restriction
7023           (message-narrow-to-headers)
7024           (goto-char (point-min))
7025           (while (not (eobp))
7026             (if (not (message-hide-header-p regexps))
7027                 (message-next-header)
7028               (let ((begin (point))
7029                     header header-len)
7030                 (message-next-header)
7031                 (setq header (buffer-substring begin (point))
7032                       header-len (- (point) begin))
7033                 (delete-region begin (point))
7034                 (goto-char (1+ end-of-headers))
7035                 (insert header)
7036                 (setq end-of-headers
7037                       (+ end-of-headers header-len))))))))
7038     (narrow-to-region (1+ end-of-headers) (point-max))))
7039
7040 (defun message-hide-header-p (regexps)
7041   (let ((result nil)
7042         (reverse nil))
7043     (when (eq (car regexps) 'not)
7044       (setq reverse t)
7045       (pop regexps))
7046     (dolist (regexp regexps)
7047       (setq result (or result (looking-at regexp))))
7048     (if reverse
7049         (not result)
7050       result)))
7051
7052 (when (featurep 'xemacs)
7053   (require 'messagexmas)
7054   (message-xmas-redefine))
7055
7056 (provide 'message)
7057
7058 (run-hooks 'message-load-hook)
7059
7060 ;; Local Variables:
7061 ;; coding: iso-8859-1
7062 ;; End:
7063
7064 ;; arch-tag: 94b32cac-4504-4b6c-8181-030ebf380ee0
7065 ;;; message.el ends here