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