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