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