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