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