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