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