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