(message-remove-blank-cited-lines): Fix if remove is given.
[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 3, or (at your option)
14 ;; any later version.
15
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 ;; GNU General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
25
26 ;;; Commentary:
27
28 ;; This mode provides mail-sending facilities from within Emacs.  It
29 ;; consists mainly of large chunks of code from the sendmail.el,
30 ;; gnus-msg.el and rnewspost.el files.
31
32 ;;; Code:
33
34 (eval-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 "DarkOliveGreen1" :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 "chartreuse1" :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 "OliveDrab1"))
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 "VioletRed1"))
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 "green"))
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 "DeepSkyBlue1"))
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 "LightSkyBlue1"))
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 "LightPink1"))
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 "MediumSpringGreen"))
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    (if (re-search-forward (concat "\\(\n\\)\n\\|^\\("
2375                                   (regexp-quote mail-header-separator)
2376                                   "\n\\)")
2377                           nil t)
2378        (or (match-end 1) (match-beginning 2))
2379      (point-max)))
2380   (goto-char (point-min)))
2381
2382 (defun message-news-p ()
2383   "Say whether the current buffer contains a news message."
2384   (and (not message-this-is-mail)
2385        (or message-this-is-news
2386            (save-excursion
2387              (save-restriction
2388                (message-narrow-to-headers)
2389                (and (message-fetch-field "newsgroups")
2390                     (not (message-fetch-field "posted-to"))))))))
2391
2392 (defun message-mail-p ()
2393   "Say whether the current buffer contains a mail message."
2394   (and (not message-this-is-news)
2395        (or message-this-is-mail
2396            (save-excursion
2397              (save-restriction
2398                (message-narrow-to-headers)
2399                (or (message-fetch-field "to")
2400                    (message-fetch-field "cc")
2401                    (message-fetch-field "bcc")))))))
2402
2403 (defun message-subscribed-p ()
2404   "Say whether we need to insert a MFT header."
2405   (or message-subscribed-regexps
2406       message-subscribed-addresses
2407       message-subscribed-address-file
2408       message-subscribed-address-functions))
2409
2410 (defun message-next-header ()
2411   "Go to the beginning of the next header."
2412   (beginning-of-line)
2413   (or (eobp) (forward-char 1))
2414   (not (if (re-search-forward "^[^ \t]" nil t)
2415            (beginning-of-line)
2416          (goto-char (point-max)))))
2417
2418 (defun message-sort-headers-1 ()
2419   "Sort the buffer as headers using `message-rank' text props."
2420   (goto-char (point-min))
2421   (require 'sort)
2422   (sort-subr
2423    nil 'message-next-header
2424    (lambda ()
2425      (message-next-header)
2426      (unless (bobp)
2427        (forward-char -1)))
2428    (lambda ()
2429      (or (get-text-property (point) 'message-rank)
2430          10000))))
2431
2432 (defun message-sort-headers ()
2433   "Sort the headers of the current message according to `message-header-format-alist'."
2434   (interactive)
2435   (save-excursion
2436     (save-restriction
2437       (let ((max (1+ (length message-header-format-alist)))
2438             rank)
2439         (message-narrow-to-headers)
2440         (while (re-search-forward "^[^ \n]+:" nil t)
2441           (put-text-property
2442            (match-beginning 0) (1+ (match-beginning 0))
2443            'message-rank
2444            (if (setq rank (length (memq (assq (intern (buffer-substring
2445                                                        (match-beginning 0)
2446                                                        (1- (match-end 0))))
2447                                               message-header-format-alist)
2448                                         message-header-format-alist)))
2449                (- max rank)
2450              (1+ max)))))
2451       (message-sort-headers-1))))
2452
2453 (defun message-kill-address ()
2454   "Kill the address under point."
2455   (interactive)
2456   (let ((start (point)))
2457     (message-skip-to-next-address)
2458     (kill-region start (point))))
2459
2460
2461 (defun message-info (&optional arg)
2462   "Display the Message manual.
2463
2464 Prefixed with one \\[universal-argument], display the Emacs MIME manual.
2465 Prefixed with two \\[universal-argument]'s, display the PGG manual."
2466   (interactive "p")
2467   (cond ((eq arg 16) (Info-goto-node "(pgg)Top"))
2468         ((eq arg  4) (Info-goto-node "(emacs-mime)Top"))
2469         (t           (Info-goto-node "(message)Top"))))
2470
2471 \f
2472
2473 ;;;
2474 ;;; Message mode
2475 ;;;
2476
2477 ;;; Set up keymap.
2478
2479 (defvar message-mode-map nil)
2480
2481 (unless message-mode-map
2482   (setq message-mode-map (make-keymap))
2483   (set-keymap-parent message-mode-map text-mode-map)
2484   (define-key message-mode-map "\C-c?" 'describe-mode)
2485
2486   (define-key message-mode-map "\C-c\C-f\C-t" 'message-goto-to)
2487   (define-key message-mode-map "\C-c\C-f\C-o" 'message-goto-from)
2488   (define-key message-mode-map "\C-c\C-f\C-b" 'message-goto-bcc)
2489   (define-key message-mode-map "\C-c\C-f\C-w" 'message-goto-fcc)
2490   (define-key message-mode-map "\C-c\C-f\C-c" 'message-goto-cc)
2491   (define-key message-mode-map "\C-c\C-f\C-s" 'message-goto-subject)
2492   (define-key message-mode-map "\C-c\C-f\C-r" 'message-goto-reply-to)
2493   (define-key message-mode-map "\C-c\C-f\C-n" 'message-goto-newsgroups)
2494   (define-key message-mode-map "\C-c\C-f\C-d" 'message-goto-distribution)
2495   (define-key message-mode-map "\C-c\C-f\C-f" 'message-goto-followup-to)
2496   (define-key message-mode-map "\C-c\C-f\C-m" 'message-goto-mail-followup-to)
2497   (define-key message-mode-map "\C-c\C-f\C-k" 'message-goto-keywords)
2498   (define-key message-mode-map "\C-c\C-f\C-u" 'message-goto-summary)
2499   (define-key message-mode-map "\C-c\C-f\C-i"
2500     'message-insert-or-toggle-importance)
2501   (define-key message-mode-map "\C-c\C-f\C-a"
2502     'message-generate-unsubscribed-mail-followup-to)
2503
2504   ;; modify headers (and insert notes in body)
2505   (define-key message-mode-map "\C-c\C-fs"    'message-change-subject)
2506   ;;
2507   (define-key message-mode-map "\C-c\C-fx"    'message-cross-post-followup-to)
2508   ;; prefix+message-cross-post-followup-to = same w/o cross-post
2509   (define-key message-mode-map "\C-c\C-ft"    'message-reduce-to-to-cc)
2510   (define-key message-mode-map "\C-c\C-fa"    'message-add-archive-header)
2511   ;; mark inserted text
2512   (define-key message-mode-map "\C-c\M-m" 'message-mark-inserted-region)
2513   (define-key message-mode-map "\C-c\M-f" 'message-mark-insert-file)
2514
2515   (define-key message-mode-map "\C-c\C-b" 'message-goto-body)
2516   (define-key message-mode-map "\C-c\C-i" 'message-goto-signature)
2517
2518   (define-key message-mode-map "\C-c\C-t" 'message-insert-to)
2519   (define-key message-mode-map "\C-c\C-fw" 'message-insert-wide-reply)
2520   (define-key message-mode-map "\C-c\C-n" 'message-insert-newsgroups)
2521   (define-key message-mode-map "\C-c\C-l" 'message-to-list-only)
2522   (define-key message-mode-map "\C-c\C-f\C-e" 'message-insert-expires)
2523
2524   (define-key message-mode-map "\C-c\C-u" 'message-insert-or-toggle-importance)
2525   (define-key message-mode-map "\C-c\M-n"
2526     'message-insert-disposition-notification-to)
2527
2528   (define-key message-mode-map "\C-c\C-y" 'message-yank-original)
2529   (define-key message-mode-map "\C-c\M-\C-y" 'message-yank-buffer)
2530   (define-key message-mode-map "\C-c\C-q" 'message-fill-yanked-message)
2531   (define-key message-mode-map "\C-c\C-w" 'message-insert-signature)
2532   (define-key message-mode-map "\C-c\M-h" 'message-insert-headers)
2533   (define-key message-mode-map "\C-c\C-r" 'message-caesar-buffer-body)
2534   (define-key message-mode-map "\C-c\C-o" 'message-sort-headers)
2535   (define-key message-mode-map "\C-c\M-r" 'message-rename-buffer)
2536
2537   (define-key message-mode-map "\C-c\C-c" 'message-send-and-exit)
2538   (define-key message-mode-map "\C-c\C-s" 'message-send)
2539   (define-key message-mode-map "\C-c\C-k" 'message-kill-buffer)
2540   (define-key message-mode-map "\C-c\C-d" 'message-dont-send)
2541   (define-key message-mode-map "\C-c\n" 'gnus-delay-article)
2542
2543   (define-key message-mode-map "\C-c\M-k" 'message-kill-address)
2544   (define-key message-mode-map "\C-c\C-e" 'message-elide-region)
2545   (define-key message-mode-map "\C-c\C-v" 'message-delete-not-region)
2546   (define-key message-mode-map "\C-c\C-z" 'message-kill-to-signature)
2547   (define-key message-mode-map "\M-\r" 'message-newline-and-reformat)
2548   (define-key message-mode-map [remap split-line]  'message-split-line)
2549
2550   (define-key message-mode-map "\C-c\C-a" 'mml-attach-file)
2551
2552   (define-key message-mode-map "\C-a" 'message-beginning-of-line)
2553   (define-key message-mode-map "\t" 'message-tab)
2554   (define-key message-mode-map "\M-;" 'comment-region)
2555
2556   (define-key message-mode-map "\M-n" 'message-display-abbrev))
2557
2558 (easy-menu-define
2559   message-mode-menu message-mode-map "Message Menu."
2560   `("Message"
2561     ["Yank Original" message-yank-original message-reply-buffer]
2562     ["Fill Yanked Message" message-fill-yanked-message t]
2563     ["Insert Signature" message-insert-signature t]
2564     ["Caesar (rot13) Message" message-caesar-buffer-body t]
2565     ["Caesar (rot13) Region" message-caesar-region (message-mark-active-p)]
2566     ["Elide Region" message-elide-region
2567      :active (message-mark-active-p)
2568      ,@(if (featurep 'xemacs) nil
2569          '(:help "Replace text in region with an ellipsis"))]
2570     ["Delete Outside Region" message-delete-not-region
2571      :active (message-mark-active-p)
2572      ,@(if (featurep 'xemacs) nil
2573          '(:help "Delete all quoted text outside region"))]
2574     ["Kill To Signature" message-kill-to-signature t]
2575     ["Newline and Reformat" message-newline-and-reformat t]
2576     ["Rename buffer" message-rename-buffer t]
2577     ["Spellcheck" ispell-message
2578      ,@(if (featurep 'xemacs) '(t)
2579          '(:help "Spellcheck this message"))]
2580     "----"
2581     ["Insert Region Marked" message-mark-inserted-region
2582      :active (message-mark-active-p)
2583      ,@(if (featurep 'xemacs) nil
2584          '(:help "Mark region with enclosing tags"))]
2585     ["Insert File Marked..." message-mark-insert-file
2586      ,@(if (featurep 'xemacs) '(t)
2587          '(:help "Insert file at point marked with enclosing tags"))]
2588     "----"
2589     ["Send Message" message-send-and-exit
2590      ,@(if (featurep 'xemacs) '(t)
2591          '(:help "Send this message"))]
2592     ["Postpone Message" message-dont-send
2593      ,@(if (featurep 'xemacs) '(t)
2594          '(:help "File this draft message and exit"))]
2595     ["Send at Specific Time..." gnus-delay-article
2596      ,@(if (featurep 'xemacs) '(t)
2597          '(:help "Ask, then arrange to send message at that time"))]
2598     ["Kill Message" message-kill-buffer
2599      ,@(if (featurep 'xemacs) '(t)
2600          '(:help "Delete this message without sending"))]
2601     "----"
2602     ["Message manual" message-info
2603      ,@(if (featurep 'xemacs) '(t)
2604          '(:help "Display the Message manual"))]))
2605
2606 (easy-menu-define
2607   message-mode-field-menu message-mode-map ""
2608   `("Field"
2609     ["To" message-goto-to t]
2610     ["From" message-goto-from t]
2611     ["Subject" message-goto-subject t]
2612     ["Change subject..." message-change-subject t]
2613     ["Cc" message-goto-cc t]
2614     ["Bcc" message-goto-bcc t]
2615     ["Fcc" message-goto-fcc t]
2616     ["Reply-To" message-goto-reply-to t]
2617     ["Flag As Important" message-insert-importance-high
2618      ,@(if (featurep 'xemacs) '(t)
2619          '(:help "Mark this message as important"))]
2620     ["Flag As Unimportant" message-insert-importance-low
2621      ,@(if (featurep 'xemacs) '(t)
2622          '(:help "Mark this message as unimportant"))]
2623     ["Request Receipt"
2624      message-insert-disposition-notification-to
2625      ,@(if (featurep 'xemacs) '(t)
2626          '(:help "Request a receipt notification"))]
2627     "----"
2628     ;; (typical) news stuff
2629     ["Summary" message-goto-summary t]
2630     ["Keywords" message-goto-keywords t]
2631     ["Newsgroups" message-goto-newsgroups t]
2632     ["Fetch Newsgroups" message-insert-newsgroups t]
2633     ["Followup-To" message-goto-followup-to t]
2634     ;; ["Followup-To (with note in body)" message-cross-post-followup-to t]
2635     ["Crosspost / Followup-To..." message-cross-post-followup-to t]
2636     ["Distribution" message-goto-distribution t]
2637     ["Expires" message-insert-expires t ]
2638     ["X-No-Archive" message-add-archive-header t ]
2639     "----"
2640     ;; (typical) mailing-lists stuff
2641     ["Fetch To" message-insert-to
2642      ,@(if (featurep 'xemacs) '(t)
2643          '(:help "Insert a To header that points to the author."))]
2644     ["Fetch To and Cc" message-insert-wide-reply
2645      ,@(if (featurep 'xemacs) '(t)
2646          '(:help
2647            "Insert To and Cc headers as if you were doing a wide reply."))]
2648     "----"
2649     ["Send to list only" message-to-list-only t]
2650     ["Mail-Followup-To" message-goto-mail-followup-to t]
2651     ["Unsubscribed list post" message-generate-unsubscribed-mail-followup-to
2652      ,@(if (featurep 'xemacs) '(t)
2653          '(:help "Insert a reasonable `Mail-Followup-To:' header."))]
2654     ["Reduce To: to Cc:" message-reduce-to-to-cc t]
2655     "----"
2656     ["Sort Headers" message-sort-headers t]
2657     ["Encode non-ASCII domain names" message-idna-to-ascii-rhs t]
2658     ;; We hide `message-hidden-headers' by narrowing the buffer.
2659     ["Show Hidden Headers" widen t]
2660     ["Goto Body" message-goto-body t]
2661     ["Goto Signature" message-goto-signature t]))
2662
2663 (defvar message-tool-bar-map nil)
2664
2665 (eval-when-compile
2666   (defvar facemenu-add-face-function)
2667   (defvar facemenu-remove-face-function))
2668
2669 ;;; Forbidden properties
2670 ;;
2671 ;; We use `after-change-functions' to keep special text properties
2672 ;; that interfer with the normal function of message mode out of the
2673 ;; buffer.
2674
2675 (defcustom message-strip-special-text-properties t
2676   "Strip special properties from the message buffer.
2677
2678 Emacs has a number of special text properties which can break message
2679 composing in various ways.  If this option is set, message will strip
2680 these properties from the message composition buffer.  However, some
2681 packages requires these properties to be present in order to work.
2682 If you use one of these packages, turn this option off, and hope the
2683 message composition doesn't break too bad."
2684   :version "22.1"
2685   :group 'message-various
2686   :link '(custom-manual "(message)Various Message Variables")
2687   :type 'boolean)
2688
2689 (defconst message-forbidden-properties
2690   ;; No reason this should be clutter up customize.  We make it a
2691   ;; property list (rather than a list of property symbols), to be
2692   ;; directly useful for `remove-text-properties'.
2693   '(field nil read-only nil invisible nil intangible nil
2694           mouse-face nil modification-hooks nil insert-in-front-hooks nil
2695           insert-behind-hooks nil point-entered nil point-left nil)
2696   ;; Other special properties:
2697   ;; category, face, display: probably doesn't do any harm.
2698   ;; fontified: is used by font-lock.
2699   ;; syntax-table, local-map: I dunno.
2700   ;; We need to add XEmacs names to the list.
2701   "Property list of with properties forbidden in message buffers.
2702 The values of the properties are ignored, only the property names are used.")
2703
2704 (defun message-tamago-not-in-use-p (pos)
2705   "Return t when tamago version 4 is not in use at the cursor position.
2706 Tamago version 4 is a popular input method for writing Japanese text.
2707 It uses the properties `intangible', `invisible', `modification-hooks'
2708 and `read-only' when translating ascii or kana text to kanji text.
2709 These properties are essential to work, so we should never strip them."
2710   (not (and (boundp 'egg-modefull-mode)
2711             (symbol-value 'egg-modefull-mode)
2712             (or (memq (get-text-property pos 'intangible)
2713                       '(its-part-1 its-part-2))
2714                 (get-text-property pos 'egg-end)
2715                 (get-text-property pos 'egg-lang)
2716                 (get-text-property pos 'egg-start)))))
2717
2718 (defsubst message-mail-alias-type-p (type)
2719   (if (atom message-mail-alias-type)
2720       (eq message-mail-alias-type type)
2721     (memq type message-mail-alias-type)))
2722
2723 (defun message-strip-forbidden-properties (begin end &optional old-length)
2724   "Strip forbidden properties between BEGIN and END, ignoring the third arg.
2725 This function is intended to be called from `after-change-functions'.
2726 See also `message-forbidden-properties'."
2727   (when (and (message-mail-alias-type-p 'ecomplete)
2728              (memq this-command message-self-insert-commands))
2729     (message-display-abbrev))
2730   (when (and message-strip-special-text-properties
2731              (message-tamago-not-in-use-p begin))
2732     (let ((buffer-read-only nil)
2733           (inhibit-read-only t))
2734       (remove-text-properties begin end message-forbidden-properties))))
2735
2736 ;;;###autoload
2737 (define-derived-mode message-mode text-mode "Message"
2738   "Major mode for editing mail and news to be sent.
2739 Like Text Mode but with these additional commands:\\<message-mode-map>
2740 C-c C-s  `message-send' (send the message)  C-c C-c  `message-send-and-exit'
2741 C-c C-d  Postpone sending the message       C-c C-k  Kill the message
2742 C-c C-f  move to a header field (and create it if there isn't):
2743          C-c C-f C-t  move to To        C-c C-f C-s  move to Subject
2744          C-c C-f C-c  move to Cc        C-c C-f C-b  move to Bcc
2745          C-c C-f C-w  move to Fcc       C-c C-f C-r  move to Reply-To
2746          C-c C-f C-u  move to Summary   C-c C-f C-n  move to Newsgroups
2747          C-c C-f C-k  move to Keywords  C-c C-f C-d  move to Distribution
2748          C-c C-f C-o  move to From (\"Originator\")
2749          C-c C-f C-f  move to Followup-To
2750          C-c C-f C-m  move to Mail-Followup-To
2751          C-c C-f C-e  move to Expires
2752          C-c C-f C-i  cycle through Importance values
2753          C-c C-f s    change subject and append \"(was: <Old Subject>)\"
2754          C-c C-f x    crossposting with FollowUp-To header and note in body
2755          C-c C-f t    replace To: header with contents of Cc: or Bcc:
2756          C-c C-f a    Insert X-No-Archive: header and a note in the body
2757 C-c C-t  `message-insert-to' (add a To header to a news followup)
2758 C-c C-l  `message-to-list-only' (removes all but list address in to/cc)
2759 C-c C-n  `message-insert-newsgroups' (add a Newsgroup header to a news reply)
2760 C-c C-b  `message-goto-body' (move to beginning of message text).
2761 C-c C-i  `message-goto-signature' (move to the beginning of the signature).
2762 C-c C-w  `message-insert-signature' (insert `message-signature-file' file).
2763 C-c C-y  `message-yank-original' (insert current message, if any).
2764 C-c C-q  `message-fill-yanked-message' (fill what was yanked).
2765 C-c C-e  `message-elide-region' (elide the text between point and mark).
2766 C-c C-v  `message-delete-not-region' (remove the text outside the region).
2767 C-c C-z  `message-kill-to-signature' (kill the text up to the signature).
2768 C-c C-r  `message-caesar-buffer-body' (rot13 the message body).
2769 C-c C-a  `mml-attach-file' (attach a file as MIME).
2770 C-c C-u  `message-insert-or-toggle-importance'  (insert or cycle importance).
2771 C-c M-n  `message-insert-disposition-notification-to'  (request receipt).
2772 C-c M-m  `message-mark-inserted-region' (mark region with enclosing tags).
2773 C-c M-f  `message-mark-insert-file' (insert file marked with enclosing tags).
2774 M-RET    `message-newline-and-reformat' (break the line and reformat)."
2775   (setq local-abbrev-table text-mode-abbrev-table)
2776   (set (make-local-variable 'message-reply-buffer) nil)
2777   (set (make-local-variable 'message-inserted-headers) nil)
2778   (set (make-local-variable 'message-send-actions) nil)
2779   (set (make-local-variable 'message-exit-actions) nil)
2780   (set (make-local-variable 'message-kill-actions) nil)
2781   (set (make-local-variable 'message-postpone-actions) nil)
2782   (set (make-local-variable 'message-draft-article) nil)
2783   (setq buffer-offer-save t)
2784   (set (make-local-variable 'facemenu-add-face-function)
2785        (lambda (face end)
2786          (let ((face-fun (cdr (assq face message-face-alist))))
2787            (if face-fun
2788                (funcall face-fun (point) end)
2789              (error "Face %s not configured for %s mode" face mode-name)))
2790          ""))
2791   (set (make-local-variable 'facemenu-remove-face-function) t)
2792   (set (make-local-variable 'message-reply-headers) nil)
2793   (make-local-variable 'message-newsreader)
2794   (make-local-variable 'message-mailer)
2795   (make-local-variable 'message-post-method)
2796   (set (make-local-variable 'message-sent-message-via) nil)
2797   (set (make-local-variable 'message-checksum) nil)
2798   (set (make-local-variable 'message-mime-part) 0)
2799   (message-setup-fill-variables)
2800   (when message-fill-column
2801     (setq fill-column message-fill-column)
2802     (turn-on-auto-fill))
2803   ;; Allow using comment commands to add/remove quoting.
2804   ;; (set (make-local-variable 'comment-start) message-yank-prefix)
2805   (when message-yank-prefix
2806     (set (make-local-variable 'comment-start) message-yank-prefix)
2807     (set (make-local-variable 'comment-start-skip)
2808          (concat "^" (regexp-quote message-yank-prefix) "[ \t]*")))
2809   (if (featurep 'xemacs)
2810       (message-setup-toolbar)
2811     (set (make-local-variable 'font-lock-defaults)
2812          '(message-font-lock-keywords t))
2813     (if (boundp 'tool-bar-map)
2814         (set (make-local-variable 'tool-bar-map) (message-make-tool-bar))))
2815   (easy-menu-add message-mode-menu message-mode-map)
2816   (easy-menu-add message-mode-field-menu message-mode-map)
2817   (gnus-make-local-hook 'after-change-functions)
2818   ;; Mmmm... Forbidden properties...
2819   (add-hook 'after-change-functions 'message-strip-forbidden-properties
2820             nil 'local)
2821   ;; Allow mail alias things.
2822   (cond
2823    ((message-mail-alias-type-p 'abbrev)
2824     (if (fboundp 'mail-abbrevs-setup)
2825         (mail-abbrevs-setup)
2826       (if (fboundp 'mail-aliases-setup) ; warning avoidance
2827           (mail-aliases-setup))))
2828    ((message-mail-alias-type-p 'ecomplete)
2829     (ecomplete-setup)))
2830   (unless buffer-file-name
2831     (message-set-auto-save-file-name))
2832   (unless (buffer-base-buffer)
2833     ;; Don't enable multibyte on an indirect buffer.  Maybe enabling
2834     ;; multibyte is not necessary at all. -- zsh
2835     (mm-enable-multibyte))
2836   (set (make-local-variable 'indent-tabs-mode) nil) ;No tabs for indentation.
2837   (mml-mode))
2838
2839 (defun message-setup-fill-variables ()
2840   "Setup message fill variables."
2841   (set (make-local-variable 'fill-paragraph-function)
2842        'message-fill-paragraph)
2843   (make-local-variable 'paragraph-separate)
2844   (make-local-variable 'paragraph-start)
2845   (make-local-variable 'adaptive-fill-regexp)
2846   (unless (boundp 'adaptive-fill-first-line-regexp)
2847     (setq adaptive-fill-first-line-regexp nil))
2848   (make-local-variable 'adaptive-fill-first-line-regexp)
2849   (let ((quote-prefix-regexp
2850          ;; User should change message-cite-prefix-regexp if
2851          ;; message-yank-prefix is set to an abnormal value.
2852          (concat "\\(" message-cite-prefix-regexp "\\)[ \t]*")))
2853     (setq paragraph-start
2854           (concat
2855            (regexp-quote mail-header-separator) "$\\|"
2856            "[ \t]*$\\|"                 ; blank lines
2857            "-- $\\|"                    ; signature delimiter
2858            "---+$\\|"              ; delimiters for forwarded messages
2859            page-delimiter "$\\|"        ; spoiler warnings
2860            ".*wrote:$\\|"               ; attribution lines
2861            quote-prefix-regexp "$\\|"   ; empty lines in quoted text
2862                                         ; mml tags
2863            "<#!*/?\\(multipart\\|part\\|external\\|mml\\|secure\\)"))
2864     (setq paragraph-separate paragraph-start)
2865     (setq adaptive-fill-regexp
2866           (concat quote-prefix-regexp "\\|" adaptive-fill-regexp))
2867     (setq adaptive-fill-first-line-regexp
2868           (concat quote-prefix-regexp "\\|"
2869                   adaptive-fill-first-line-regexp)))
2870   (make-local-variable 'auto-fill-inhibit-regexp)
2871   ;;(setq auto-fill-inhibit-regexp "^[A-Z][^: \n\t]+:")
2872   (setq auto-fill-inhibit-regexp nil)
2873   (make-local-variable 'normal-auto-fill-function)
2874   (setq normal-auto-fill-function 'message-do-auto-fill)
2875   ;; KLUDGE: auto fill might already be turned on in `text-mode-hook'.
2876   ;; In that case, ensure that it uses the right function.  The real
2877   ;; solution would be not to use `define-derived-mode', and run
2878   ;; `text-mode-hook' ourself at the end of the mode.
2879   ;; -- Per Abrahamsen <abraham@dina.kvl.dk> Date: 2001-10-19.
2880   (when auto-fill-function
2881     (setq auto-fill-function normal-auto-fill-function)))
2882
2883 \f
2884
2885 ;;;
2886 ;;; Message mode commands
2887 ;;;
2888
2889 ;;; Movement commands
2890
2891 (defun message-goto-to ()
2892   "Move point to the To header."
2893   (interactive)
2894   (message-position-on-field "To"))
2895
2896 (defun message-goto-from ()
2897   "Move point to the From header."
2898   (interactive)
2899   (message-position-on-field "From"))
2900
2901 (defun message-goto-subject ()
2902   "Move point to the Subject header."
2903   (interactive)
2904   (message-position-on-field "Subject"))
2905
2906 (defun message-goto-cc ()
2907   "Move point to the Cc header."
2908   (interactive)
2909   (message-position-on-field "Cc" "To"))
2910
2911 (defun message-goto-bcc ()
2912   "Move point to the Bcc  header."
2913   (interactive)
2914   (message-position-on-field "Bcc" "Cc" "To"))
2915
2916 (defun message-goto-fcc ()
2917   "Move point to the Fcc header."
2918   (interactive)
2919   (message-position-on-field "Fcc" "To" "Newsgroups"))
2920
2921 (defun message-goto-reply-to ()
2922   "Move point to the Reply-To header."
2923   (interactive)
2924   (message-position-on-field "Reply-To" "Subject"))
2925
2926 (defun message-goto-newsgroups ()
2927   "Move point to the Newsgroups header."
2928   (interactive)
2929   (message-position-on-field "Newsgroups"))
2930
2931 (defun message-goto-distribution ()
2932   "Move point to the Distribution header."
2933   (interactive)
2934   (message-position-on-field "Distribution"))
2935
2936 (defun message-goto-followup-to ()
2937   "Move point to the Followup-To header."
2938   (interactive)
2939   (message-position-on-field "Followup-To" "Newsgroups"))
2940
2941 (defun message-goto-mail-followup-to ()
2942   "Move point to the Mail-Followup-To header."
2943   (interactive)
2944   (message-position-on-field "Mail-Followup-To" "To"))
2945
2946 (defun message-goto-keywords ()
2947   "Move point to the Keywords header."
2948   (interactive)
2949   (message-position-on-field "Keywords" "Subject"))
2950
2951 (defun message-goto-summary ()
2952   "Move point to the Summary header."
2953   (interactive)
2954   (message-position-on-field "Summary" "Subject"))
2955
2956 (defun message-goto-body (&optional interactivep)
2957   "Move point to the beginning of the message body."
2958   (interactive (list t))
2959   (when (and interactivep
2960              (looking-at "[ \t]*\n"))
2961     (expand-abbrev))
2962   (goto-char (point-min))
2963   (or (search-forward (concat "\n" mail-header-separator "\n") nil t)
2964       (search-forward-regexp "[^:]+:\\([^\n]\\|\n[ \t]\\)+\n\n" nil t)))
2965
2966 (defun message-in-body-p ()
2967   "Return t if point is in the message body."
2968   (let ((body (save-excursion (message-goto-body) (point))))
2969     (>= (point) body)))
2970
2971 (defun message-goto-eoh ()
2972   "Move point to the end of the headers."
2973   (interactive)
2974   (message-goto-body)
2975   (forward-line -1))
2976
2977 (defun message-goto-signature ()
2978   "Move point to the beginning of the message signature.
2979 If there is no signature in the article, go to the end and
2980 return nil."
2981   (interactive)
2982   (goto-char (point-min))
2983   (if (re-search-forward message-signature-separator nil t)
2984       (forward-line 1)
2985     (goto-char (point-max))
2986     nil))
2987
2988 (defun message-generate-unsubscribed-mail-followup-to (&optional include-cc)
2989   "Insert a reasonable MFT header in a post to an unsubscribed list.
2990 When making original posts to a mailing list you are not subscribed to,
2991 you have to type in a MFT header by hand.  The contents, usually, are
2992 the addresses of the list and your own address.  This function inserts
2993 such a header automatically.  It fetches the contents of the To: header
2994 in the current mail buffer, and appends the current `user-mail-address'.
2995
2996 If the optional argument INCLUDE-CC is non-nil, the addresses in the
2997 Cc: header are also put into the MFT."
2998
2999   (interactive "P")
3000   (let* (cc tos)
3001     (save-restriction
3002       (message-narrow-to-headers)
3003       (message-remove-header "Mail-Followup-To")
3004       (setq cc (and include-cc (message-fetch-field "Cc")))
3005       (setq tos (if cc
3006                     (concat (message-fetch-field "To") "," cc)
3007                   (message-fetch-field "To"))))
3008     (message-goto-mail-followup-to)
3009     (insert (concat tos ", " user-mail-address))))
3010
3011 \f
3012
3013 (defun message-insert-to (&optional force)
3014   "Insert a To header that points to the author of the article being replied to.
3015 If the original author requested not to be sent mail, don't insert unless the
3016 prefix FORCE is given."
3017   (interactive "P")
3018   (let* ((mct (message-fetch-reply-field "mail-copies-to"))
3019          (dont (and mct (or (equal (downcase mct) "never")
3020                             (equal (downcase mct) "nobody"))))
3021          (to (or (message-fetch-reply-field "mail-reply-to")
3022                  (message-fetch-reply-field "reply-to")
3023                  (message-fetch-reply-field "from"))))
3024     (when (and dont to)
3025       (message
3026        (if force
3027            "Ignoring the user request not to have copies sent via mail"
3028          "Complying with the user request not to have copies sent via mail")))
3029     (when (and force (not to))
3030       (error "No mail address in the article"))
3031     (when (and to (or force (not dont)))
3032       (message-carefully-insert-headers (list (cons 'To to))))))
3033
3034 (defun message-insert-wide-reply ()
3035   "Insert To and Cc headers as if you were doing a wide reply."
3036   (interactive)
3037   (let ((headers (message-with-reply-buffer
3038                    (message-get-reply-headers t))))
3039     (message-carefully-insert-headers headers)))
3040
3041 (defcustom message-header-synonyms
3042   '((To Cc Bcc)
3043     (Original-To))
3044   "List of lists of header synonyms.
3045 E.g., if this list contains a member list with elements `Cc' and `To',
3046 then `message-carefully-insert-headers' will not insert a `To' header
3047 when the message is already `Cc'ed to the recipient."
3048   :version "22.1"
3049   :group 'message-headers
3050   :link '(custom-manual "(message)Message Headers")
3051   :type '(repeat sexp))
3052
3053 (defun message-carefully-insert-headers (headers)
3054   "Insert the HEADERS, an alist, into the message buffer.
3055 Does not insert the headers when they are already present there
3056 or in the synonym headers, defined by `message-header-synonyms'."
3057   ;; FIXME: Should compare only the address and not the full name.  Comparison
3058   ;; should be done case-folded (and with `string=' rather than
3059   ;; `string-match').
3060   ;; (mail-strip-quoted-names "Foo Bar <foo@bar>, bla@fasel (Bla Fasel)")
3061   (dolist (header headers)
3062     (let* ((header-name (symbol-name (car header)))
3063            (new-header (cdr header))
3064            (synonyms (loop for synonym in message-header-synonyms
3065                            when (memq (car header) synonym) return synonym))
3066            (old-header
3067             (loop for synonym in synonyms
3068                   for old-header = (mail-fetch-field (symbol-name synonym))
3069                   when (and old-header (string-match new-header old-header))
3070                   return synonym)))
3071       (if old-header
3072           (message "already have `%s' in `%s'" new-header old-header)
3073         (when (and (message-position-on-field header-name)
3074                    (setq old-header (mail-fetch-field header-name))
3075                    (not (string-match "\\` *\\'" old-header)))
3076           (insert ", "))
3077         (insert new-header)))))
3078
3079 (defun message-widen-reply ()
3080   "Widen the reply to include maximum recipients."
3081   (interactive)
3082   (let ((follow-to
3083          (and message-reply-buffer
3084               (buffer-name message-reply-buffer)
3085               (save-excursion
3086                 (set-buffer message-reply-buffer)
3087                 (message-get-reply-headers t)))))
3088     (save-excursion
3089       (save-restriction
3090         (message-narrow-to-headers)
3091         (dolist (elem follow-to)
3092           (message-remove-header (symbol-name (car elem)))
3093           (goto-char (point-min))
3094           (insert (symbol-name (car elem)) ": "
3095                   (cdr elem) "\n"))))))
3096
3097 (defun message-insert-newsgroups ()
3098   "Insert the Newsgroups header from the article being replied to."
3099   (interactive)
3100   (when (and (message-position-on-field "Newsgroups")
3101              (mail-fetch-field "newsgroups")
3102              (not (string-match "\\` *\\'" (mail-fetch-field "newsgroups"))))
3103     (insert ","))
3104   (insert (or (message-fetch-reply-field "newsgroups") "")))
3105
3106 \f
3107
3108 ;;; Various commands
3109
3110 (defun message-delete-not-region (beg end)
3111   "Delete everything in the body of the current message outside of the region."
3112   (interactive "r")
3113   (let (citeprefix)
3114     (save-excursion
3115       (goto-char beg)
3116       ;; snarf citation prefix, if appropriate
3117       (unless (eq (point) (progn (beginning-of-line) (point)))
3118         (when (looking-at message-cite-prefix-regexp)
3119           (setq citeprefix (match-string 0))))
3120       (goto-char end)
3121       (delete-region (point) (if (not (message-goto-signature))
3122                                  (point)
3123                                (forward-line -2)
3124                                (point)))
3125       (insert "\n")
3126       (goto-char beg)
3127       (delete-region beg (progn (message-goto-body)
3128                                 (forward-line 2)
3129                                 (point)))
3130       (when citeprefix
3131         (insert citeprefix))))
3132   (when (message-goto-signature)
3133     (forward-line -2)))
3134
3135 (defun message-kill-to-signature (&optional arg)
3136   "Kill all text up to the signature.
3137 If a numberic argument or prefix arg is given, leave that number
3138 of lines before the signature intact."
3139   (interactive "P")
3140   (save-excursion
3141     (save-restriction
3142       (let ((point (point)))
3143         (narrow-to-region point (point-max))
3144         (message-goto-signature)
3145         (unless (eobp)
3146           (if (and arg (numberp arg))
3147               (forward-line (- -1 arg))
3148             (end-of-line -1)))
3149         (unless (= point (point))
3150           (kill-region point (point))
3151           (unless (bolp)
3152             (insert "\n")))))))
3153
3154 (defun message-newline-and-reformat (&optional arg not-break)
3155   "Insert four newlines, and then reformat if inside quoted text.
3156 Prefix arg means justify as well."
3157   (interactive (list (if current-prefix-arg 'full)))
3158   (let (quoted point beg end leading-space bolp fill-paragraph-function)
3159     (setq point (point))
3160     (beginning-of-line)
3161     (setq beg (point))
3162     (setq bolp (= beg point))
3163     ;; Find first line of the paragraph.
3164     (if not-break
3165         (while (and (not (eobp))
3166                     (not (looking-at message-cite-prefix-regexp))
3167                     (looking-at paragraph-start))
3168           (forward-line 1)))
3169     ;; Find the prefix
3170     (when (looking-at message-cite-prefix-regexp)
3171       (setq quoted (match-string 0))
3172       (goto-char (match-end 0))
3173       (looking-at "[ \t]*")
3174       (setq leading-space (match-string 0)))
3175     (if (and quoted
3176              (not not-break)
3177              (not bolp)
3178              (< (- point beg) (length quoted)))
3179         ;; break inside the cite prefix.
3180         (setq quoted nil
3181               end nil))
3182     (if quoted
3183         (progn
3184           (forward-line 1)
3185           (while (and (not (eobp))
3186                       (not (looking-at paragraph-separate))
3187                       (looking-at message-cite-prefix-regexp)
3188                       (equal quoted (match-string 0)))
3189             (goto-char (match-end 0))
3190             (looking-at "[ \t]*")
3191             (if (> (length leading-space) (length (match-string 0)))
3192                 (setq leading-space (match-string 0)))
3193             (forward-line 1))
3194           (setq end (point))
3195           (goto-char beg)
3196           (while (and (if (bobp) nil (forward-line -1) t)
3197                       (not (looking-at paragraph-start))
3198                       (looking-at message-cite-prefix-regexp)
3199                       (equal quoted (match-string 0)))
3200             (setq beg (point))
3201             (goto-char (match-end 0))
3202             (looking-at "[ \t]*")
3203             (if (> (length leading-space) (length (match-string 0)))
3204                 (setq leading-space (match-string 0)))))
3205       (while (and (not (eobp))
3206                   (not (looking-at paragraph-separate))
3207                   (not (looking-at message-cite-prefix-regexp)))
3208         (forward-line 1))
3209       (setq end (point))
3210       (goto-char beg)
3211       (while (and (if (bobp) nil (forward-line -1) t)
3212                   (not (looking-at paragraph-start))
3213                   (not (looking-at message-cite-prefix-regexp)))
3214         (setq beg (point))))
3215     (goto-char point)
3216     (save-restriction
3217       (narrow-to-region beg end)
3218       (if not-break
3219           (setq point nil)
3220         (if bolp
3221             (newline)
3222           (newline)
3223           (newline))
3224         (setq point (point))
3225         ;; (newline 2) doesn't mark both newline's as hard, so call
3226         ;; newline twice. -jas
3227         (newline)
3228         (newline)
3229         (delete-region (point) (re-search-forward "[ \t]*"))
3230         (when (and quoted (not bolp))
3231           (insert quoted leading-space)))
3232       (undo-boundary)
3233       (if quoted
3234           (let* ((adaptive-fill-regexp
3235                   (regexp-quote (concat quoted leading-space)))
3236                  (adaptive-fill-first-line-regexp
3237                   adaptive-fill-regexp ))
3238             (fill-paragraph arg))
3239         (fill-paragraph arg))
3240       (if point (goto-char point)))))
3241
3242 (defun message-fill-paragraph (&optional arg)
3243   "Message specific function to fill a paragraph.
3244 This function is used as the value of `fill-paragraph-function' in
3245 Message buffers and is not meant to be called directly."
3246   (interactive (list (if current-prefix-arg 'full)))
3247   (if (if (boundp 'filladapt-mode) filladapt-mode)
3248       nil
3249     (if (message-point-in-header-p)
3250         (message-fill-field)
3251       (message-newline-and-reformat arg t))
3252     t))
3253
3254 (defun message-point-in-header-p ()
3255   "Return t if point is in the header."
3256   (save-excursion
3257     (not (re-search-backward
3258           (concat "^" (regexp-quote mail-header-separator) "\n") nil t))))
3259
3260 (defun message-do-auto-fill ()
3261   "Like `do-auto-fill', but don't fill in message header."
3262   (unless (message-point-in-header-p)
3263     (do-auto-fill)))
3264
3265 (defun message-insert-signature (&optional force)
3266   "Insert a signature.  See documentation for variable `message-signature'."
3267   (interactive (list 0))
3268   (let* ((signature
3269           (cond
3270            ((and (null message-signature)
3271                  (eq force 0))
3272             (save-excursion
3273               (goto-char (point-max))
3274               (not (re-search-backward message-signature-separator nil t))))
3275            ((and (null message-signature)
3276                  force)
3277             t)
3278            ((functionp message-signature)
3279             (funcall message-signature))
3280            ((listp message-signature)
3281             (eval message-signature))
3282            (t message-signature)))
3283          signature-file)
3284     (setq signature
3285           (cond ((stringp signature)
3286                  signature)
3287                 ((and (eq t signature) message-signature-file)
3288                  (setq signature-file
3289                        (if (and message-signature-directory
3290                                 ;; don't actually use the signature directory
3291                                 ;; if message-signature-file contains a path.
3292                                 (not (file-name-directory
3293                                       message-signature-file)))
3294                            (nnheader-concat message-signature-directory
3295                                             message-signature-file)
3296                          message-signature-file))
3297                  (file-exists-p signature-file))))
3298     (when signature
3299       (goto-char (point-max))
3300       ;; Insert the signature.
3301       (unless (bolp)
3302         (insert "\n"))
3303       (when message-signature-insert-empty-line
3304         (insert "\n"))
3305       (insert "-- \n")
3306       (if (eq signature t)
3307           (insert-file-contents signature-file)
3308         (insert signature))
3309       (goto-char (point-max))
3310       (or (bolp) (insert "\n")))))
3311
3312 (defun message-insert-importance-high ()
3313   "Insert header to mark message as important."
3314   (interactive)
3315   (save-excursion
3316     (save-restriction
3317       (message-narrow-to-headers)
3318       (message-remove-header "Importance"))
3319     (message-goto-eoh)
3320     (insert "Importance: high\n")))
3321
3322 (defun message-insert-importance-low ()
3323   "Insert header to mark message as unimportant."
3324   (interactive)
3325   (save-excursion
3326     (save-restriction
3327       (message-narrow-to-headers)
3328       (message-remove-header "Importance"))
3329     (message-goto-eoh)
3330     (insert "Importance: low\n")))
3331
3332 (defun message-insert-or-toggle-importance ()
3333   "Insert a \"Importance: high\" header, or cycle through the header values.
3334 The three allowed values according to RFC 1327 are `high', `normal'
3335 and `low'."
3336   (interactive)
3337   (save-excursion
3338     (let ((valid '("high" "normal" "low"))
3339           (new "high")
3340           cur)
3341       (save-restriction
3342         (message-narrow-to-headers)
3343         (when (setq cur (message-fetch-field "Importance"))
3344           (message-remove-header "Importance")
3345           (setq new (cond ((string= cur "high")
3346                            "low")
3347                           ((string= cur "low")
3348                            "normal")
3349                           (t
3350                            "high")))))
3351       (message-goto-eoh)
3352       (insert (format "Importance: %s\n" new)))))
3353
3354 (defun message-insert-disposition-notification-to ()
3355   "Request a disposition notification (return receipt) to this message.
3356 Note that this should not be used in newsgroups."
3357   (interactive)
3358   (save-excursion
3359     (save-restriction
3360       (message-narrow-to-headers)
3361       (message-remove-header "Disposition-Notification-To"))
3362     (message-goto-eoh)
3363     (insert (format "Disposition-Notification-To: %s\n"
3364                     (or (message-field-value "Reply-to")
3365                         (message-field-value "From")
3366                         (message-make-from))))))
3367
3368 (defun message-elide-region (b e)
3369   "Elide the text in the region.
3370 An ellipsis (from `message-elide-ellipsis') will be inserted where the
3371 text was killed."
3372   (interactive "r")
3373   (kill-region b e)
3374   (insert message-elide-ellipsis))
3375
3376 (defvar message-caesar-translation-table nil)
3377
3378 (defun message-caesar-region (b e &optional n)
3379   "Caesar rotate region B to E by N, default 13, for decrypting netnews."
3380   (interactive
3381    (list
3382     (min (point) (or (mark t) (point)))
3383     (max (point) (or (mark t) (point)))
3384     (when current-prefix-arg
3385       (prefix-numeric-value current-prefix-arg))))
3386
3387   (setq n (if (numberp n) (mod n 26) 13)) ;canonize N
3388   (unless (or (zerop n)                 ; no action needed for a rot of 0
3389               (= b e))                  ; no region to rotate
3390     ;; We build the table, if necessary.
3391     (when (or (not message-caesar-translation-table)
3392               (/= (aref message-caesar-translation-table ?a) (+ ?a n)))
3393       (setq message-caesar-translation-table
3394             (message-make-caesar-translation-table n)))
3395     (translate-region b e message-caesar-translation-table)))
3396
3397 (defun message-make-caesar-translation-table (n)
3398   "Create a rot table with offset N."
3399   (let ((i -1)
3400         (table (make-string 256 0)))
3401     (while (< (incf i) 256)
3402       (aset table i i))
3403     (concat
3404      (substring table 0 ?A)
3405      (substring table (+ ?A n) (+ ?A n (- 26 n)))
3406      (substring table ?A (+ ?A n))
3407      (substring table (+ ?A 26) ?a)
3408      (substring table (+ ?a n) (+ ?a n (- 26 n)))
3409      (substring table ?a (+ ?a n))
3410      (substring table (+ ?a 26) 255))))
3411
3412 (defun message-caesar-buffer-body (&optional rotnum wide)
3413   "Caesar rotate all letters in the current buffer by 13 places.
3414 Used to encode/decode possibly offensive messages (commonly in rec.humor).
3415 With prefix arg, specifies the number of places to rotate each letter forward.
3416 Mail and USENET news headers are not rotated unless WIDE is non-nil."
3417   (interactive (if current-prefix-arg
3418                    (list (prefix-numeric-value current-prefix-arg))
3419                  (list nil)))
3420   (save-excursion
3421     (save-restriction
3422       (when (and (not wide) (message-goto-body))
3423         (narrow-to-region (point) (point-max)))
3424       (message-caesar-region (point-min) (point-max) rotnum))))
3425
3426 (defun message-pipe-buffer-body (program)
3427   "Pipe the message body in the current buffer through PROGRAM."
3428   (save-excursion
3429     (save-restriction
3430       (when (message-goto-body)
3431         (narrow-to-region (point) (point-max)))
3432       (shell-command-on-region
3433        (point-min) (point-max) program nil t))))
3434
3435 (defun message-rename-buffer (&optional enter-string)
3436   "Rename the *message* buffer to \"*message* RECIPIENT\".
3437 If the function is run with a prefix, it will ask for a new buffer
3438 name, rather than giving an automatic name."
3439   (interactive "Pbuffer name: ")
3440   (save-excursion
3441     (save-restriction
3442       (goto-char (point-min))
3443       (narrow-to-region (point)
3444                         (search-forward mail-header-separator nil 'end))
3445       (let* ((mail-to (or
3446                        (if (message-news-p) (message-fetch-field "Newsgroups")
3447                          (message-fetch-field "To"))
3448                        ""))
3449              (mail-trimmed-to
3450               (if (string-match "," mail-to)
3451                   (concat (substring mail-to 0 (match-beginning 0)) ", ...")
3452                 mail-to))
3453              (name-default (concat "*message* " mail-trimmed-to))
3454              (name (if enter-string
3455                        (read-string "New buffer name: " name-default)
3456                      name-default)))
3457         (rename-buffer name t)))))
3458
3459 (defun message-fill-yanked-message (&optional justifyp)
3460   "Fill the paragraphs of a message yanked into this one.
3461 Numeric argument means justify as well."
3462   (interactive "P")
3463   (save-excursion
3464     (goto-char (point-min))
3465     (search-forward (concat "\n" mail-header-separator "\n") nil t)
3466     (let ((fill-prefix message-yank-prefix))
3467       (fill-individual-paragraphs (point) (point-max) justifyp))))
3468
3469 (defun message-indent-citation (&optional start end yank-only)
3470   "Modify text just inserted from a message to be cited.
3471 The inserted text should be the region.
3472 When this function returns, the region is again around the modified text.
3473
3474 Normally, indent each nonblank line `message-indentation-spaces' spaces.
3475 However, if `message-yank-prefix' is non-nil, insert that prefix on each line."
3476   (unless start (setq start (point)))
3477   (unless yank-only
3478     ;; Remove unwanted headers.
3479     (when message-ignored-cited-headers
3480       (let (all-removed)
3481         (save-restriction
3482           (narrow-to-region
3483            (goto-char start)
3484            (if (search-forward "\n\n" nil t)
3485                (1- (point))
3486              (point)))
3487           (message-remove-header message-ignored-cited-headers t)
3488           (when (= (point-min) (point-max))
3489             (setq all-removed t))
3490           (goto-char (point-max)))
3491         (if all-removed
3492             (goto-char start)
3493           (forward-line 1))))
3494     ;; Delete blank lines at the start of the buffer.
3495     (while (and (point-min)
3496                 (eolp)
3497                 (not (eobp)))
3498       (message-delete-line))
3499     ;; Delete blank lines at the end of the buffer.
3500     (goto-char (point-max))
3501     (unless (eolp)
3502       (insert "\n"))
3503     (while (and (zerop (forward-line -1))
3504                 (looking-at "$"))
3505       (message-delete-line)))
3506   ;; Do the indentation.
3507   (if (null message-yank-prefix)
3508       (indent-rigidly start (or end (mark t)) message-indentation-spaces)
3509     (save-excursion
3510       (goto-char start)
3511       (while (< (point) (or end (mark t)))
3512         (cond ((looking-at ">")
3513                (insert message-yank-cited-prefix))
3514               ((looking-at "^$")
3515                (insert message-yank-empty-prefix))
3516               (t
3517                (insert message-yank-prefix)))
3518         (forward-line 1))))
3519   (goto-char start))
3520
3521 (defun message-remove-blank-cited-lines (&optional remove)
3522   "Remove cited lines containing only blanks.
3523 If REMOVE is non-nil, remove newlines, too.
3524
3525 To use this automatically, you may add this function to
3526 `gnus-message-setup-hook'."
3527   (interactive "P")
3528   (let ((citexp
3529          (concat
3530           "^\\("
3531           (when (boundp 'message-yank-cited-prefix)
3532             (concat message-yank-cited-prefix "\\|"))
3533           message-yank-prefix
3534           "\\)+ *\n"
3535           )))
3536     (gnus-message 8 "removing `%s'" citexp)
3537     (save-excursion
3538       (message-goto-body)
3539       (while (re-search-forward citexp nil t)
3540         (replace-match (if remove "" "\n"))))))
3541
3542 (defvar message-cite-reply-above nil
3543   "If non-nil, start own text above the quote.
3544
3545 Note: Top posting is bad netiquette.  Don't use it unless you
3546 really must.  You probably want to set variable only for specific
3547 groups, e.g. using `gnus-posting-styles':
3548
3549   (eval (set (make-local-variable 'message-cite-reply-above) t))
3550
3551 This variable has no effect in news postings.")
3552
3553 (defun message-yank-original (&optional arg)
3554   "Insert the message being replied to, if any.
3555 Puts point before the text and mark after.
3556 Normally indents each nonblank line ARG spaces (default 3).  However,
3557 if `message-yank-prefix' is non-nil, insert that prefix on each line.
3558
3559 This function uses `message-cite-function' to do the actual citing.
3560
3561 Just \\[universal-argument] as argument means don't indent, insert no
3562 prefix, and don't delete any headers."
3563   (interactive "P")
3564   (let ((modified (buffer-modified-p))
3565         body-text)
3566     (when (and message-reply-buffer
3567                message-cite-function)
3568       (when message-cite-reply-above
3569         (if (and (not (message-news-p))
3570                  (or (eq message-cite-reply-above 'is-evil)
3571                      (y-or-n-p "\
3572 Top posting is bad netiquette.  Please don't top post unless you really must.
3573 Really top post? ")))
3574             (save-excursion
3575               (setq body-text
3576                     (buffer-substring (message-goto-body)
3577                                       (point-max)))
3578               (delete-region (message-goto-body) (point-max)))
3579           (set (make-local-variable 'message-cite-reply-above) nil)))
3580       (delete-windows-on message-reply-buffer t)
3581       (push-mark (save-excursion
3582                    (insert-buffer-substring message-reply-buffer)
3583                    (unless (bolp)
3584                      (insert ?\n))
3585                    (point)))
3586       (unless arg
3587         (funcall message-cite-function)
3588         (unless (eq (char-before (mark t)) ?\n)
3589           (let ((pt (point)))
3590             (goto-char (mark t))
3591             (insert-before-markers ?\n)
3592             (goto-char pt))))
3593       (when message-cite-reply-above
3594         (message-goto-body)
3595         (insert body-text)
3596         (insert (if (bolp) "\n" "\n\n"))
3597         (message-goto-body))
3598       ;; Add a `message-setup-very-last-hook' here?
3599       ;; Add `gnus-article-highlight-citation' here?
3600       (unless modified
3601         (setq message-checksum (message-checksum))))))
3602
3603 (defun message-yank-buffer (buffer)
3604   "Insert BUFFER into the current buffer and quote it."
3605   (interactive "bYank buffer: ")
3606   (let ((message-reply-buffer (get-buffer buffer)))
3607     (save-window-excursion
3608       (message-yank-original))))
3609
3610 (defun message-buffers ()
3611   "Return a list of active message buffers."
3612   (let (buffers)
3613     (save-excursion
3614       (dolist (buffer (buffer-list t))
3615         (set-buffer buffer)
3616         (when (and (eq major-mode 'message-mode)
3617                    (null message-sent-message-via))
3618           (push (buffer-name buffer) buffers))))
3619     (nreverse buffers)))
3620
3621 (eval-when-compile (defvar mail-citation-hook)) ; Compiler directive
3622
3623 (defun message-cite-original-1 (strip-signature)
3624   "Cite an original message.
3625 If STRIP-SIGNATURE is non-nil, strips off the signature from the
3626 original message.
3627
3628 This function uses `mail-citation-hook' if that is non-nil."
3629   (if (and (boundp 'mail-citation-hook)
3630            mail-citation-hook)
3631       (run-hooks 'mail-citation-hook)
3632     (let* ((start (point))
3633            (end (mark t))
3634            (x-no-archive nil)
3635            (functions
3636             (when message-indent-citation-function
3637               (if (listp message-indent-citation-function)
3638                   message-indent-citation-function
3639                 (list message-indent-citation-function))))
3640            ;; This function may be called by `gnus-summary-yank-message' and
3641            ;; may insert a different article from the original.  So, we will
3642            ;; modify the value of `message-reply-headers' with that article.
3643            (message-reply-headers
3644             (save-restriction
3645               (narrow-to-region start end)
3646               (message-narrow-to-head-1)
3647               (setq x-no-archive (message-fetch-field "x-no-archive"))
3648               (vector 0
3649                       (or (message-fetch-field "subject") "none")
3650                       (or (message-fetch-field "from") "nobody")
3651                       (message-fetch-field "date")
3652                       (message-fetch-field "message-id" t)
3653                       (message-fetch-field "references")
3654                       0 0 ""))))
3655       (mml-quote-region start end)
3656       (when strip-signature
3657         ;; Allow undoing.
3658         (undo-boundary)
3659         (goto-char end)
3660         (when (re-search-backward message-signature-separator start t)
3661           ;; Also peel off any blank lines before the signature.
3662           (forward-line -1)
3663           (while (looking-at "^[ \t]*$")
3664             (forward-line -1))
3665           (forward-line 1)
3666           (delete-region (point) end)
3667           (unless (search-backward "\n\n" start t)
3668             ;; Insert a blank line if it is peeled off.
3669             (insert "\n"))))
3670       (goto-char start)
3671       (mapc 'funcall functions)
3672       (when message-citation-line-function
3673         (unless (bolp)
3674           (insert "\n"))
3675         (funcall message-citation-line-function))
3676       (when (and x-no-archive
3677                  (not message-cite-articles-with-x-no-archive)
3678                  (string-match "yes" x-no-archive))
3679         (undo-boundary)
3680         (delete-region (point) (mark t))
3681         (insert "> [Quoted text removed due to X-No-Archive]\n")
3682         (push-mark)
3683         (forward-line -1)))))
3684
3685 (defun message-cite-original ()
3686   "Cite function in the standard Message manner."
3687   (message-cite-original-1 nil))
3688
3689 (defun message-insert-formated-citation-line (&optional from date)
3690   "Function that inserts a formated citation line.
3691
3692 See `message-citation-line-format'."
3693   ;; The optional args are for testing/debugging.  They will disappear later.
3694   ;; Example:
3695   ;; (with-temp-buffer
3696   ;;   (message-insert-formated-citation-line
3697   ;;    "John Doe <john.doe@example.invalid>"
3698   ;;    (current-time))
3699   ;;   (buffer-string))
3700   (when (or message-reply-headers (and from date))
3701     (unless from
3702       (setq from (mail-header-from message-reply-headers)))
3703     (let* ((data (condition-case ()
3704                      (funcall (if (boundp gnus-extract-address-components)
3705                                   gnus-extract-address-components
3706                                 'mail-extract-address-components)
3707                               from)
3708                    (error nil)))
3709            (name (car data))
3710            (fname name)
3711            (lname name)
3712            (net (car (cdr data)))
3713            (name-or-net (or (car data)
3714                             (car (cdr data)) from))
3715            (replydate
3716             (or
3717              date
3718              ;; We need Gnus functionality if the user wants date or time from
3719              ;; the original article:
3720              (when (string-match "%[^fnNFL]" message-citation-line-format)
3721                (autoload 'gnus-date-get-time "gnus-util")
3722                (gnus-date-get-time (mail-header-date message-reply-headers)))))
3723            (flist
3724             (let ((i ?A) lst)
3725               (when (stringp name)
3726                 ;; Guess first name and last name:
3727                 (cond ((string-match
3728                         "\\`\\(\\w\\|[-.]\\)+ \\(\\w\\|[-.]\\)+\\'" name)
3729                        (setq fname (nth 0 (split-string name "[ \t]+"))
3730                              lname (nth 1 (split-string name "[ \t]+"))))
3731                       ((string-match
3732                         "\\`\\(\\w\\|[-.]\\)+, \\(\\w\\|[-.]\\)+\\'" name)
3733                        (setq fname (nth 1 (split-string name "[ \t,]+"))
3734                              lname (nth 0 (split-string name "[ \t,]+"))))
3735                       ((string-match
3736                         "\\`\\(\\w\\|[-.]\\)+\\'" name)
3737                        (setq fname name
3738                              lname ""))))
3739               ;; The following letters are not used in `format-time-string':
3740               (push ?E lst) (push "<E>" lst)
3741               (push ?F lst) (push fname lst)
3742               ;; We might want to use "" instead of "<X>" later.
3743               (push ?J lst) (push "<J>" lst)
3744               (push ?K lst) (push "<K>" lst)
3745               (push ?L lst) (push lname lst)
3746               (push ?N lst) (push name-or-net lst)
3747               (push ?O lst) (push "<O>" lst)
3748               (push ?P lst) (push "<P>" lst)
3749               (push ?Q lst) (push "<Q>" lst)
3750               (push ?f lst) (push from lst)
3751               (push ?i lst) (push "<i>" lst)
3752               (push ?n lst) (push net lst)
3753               (push ?o lst) (push "<o>" lst)
3754               (push ?q lst) (push "<q>" lst)
3755               (push ?t lst) (push "<t>" lst)
3756               (push ?v lst) (push "<v>" lst)
3757               ;; Delegate the rest to `format-time-string':
3758               (while (<= i ?z)
3759                 (when (and (not (memq i lst))
3760                            ;; Skip (Z,a)
3761                            (or (<= i ?Z)
3762                                (>= i ?a)))
3763                   (push i lst)
3764                   (push (condition-case nil
3765                             (progn (format-time-string (format "%%%c" i)
3766                                                        replydate))
3767                           (format ">%c<" i))
3768                         lst))
3769                 (setq i (1+ i)))
3770               (reverse lst)))
3771            (spec (apply 'format-spec-make flist)))
3772       (insert (format-spec message-citation-line-format spec)))
3773     (newline)))
3774
3775 (defun message-cite-original-without-signature ()
3776   "Cite function in the standard Message manner.
3777 This function strips off the signature from the original message."
3778   (message-cite-original-1 t))
3779
3780 (defun message-insert-citation-line ()
3781   "Insert a simple citation line."
3782   (when message-reply-headers
3783     (insert (mail-header-from message-reply-headers) " writes:")
3784     (newline)
3785     (newline)))
3786
3787 (defun message-position-on-field (header &rest afters)
3788   (let ((case-fold-search t))
3789     (save-restriction
3790       (narrow-to-region
3791        (goto-char (point-min))
3792        (progn
3793          (re-search-forward
3794           (concat "^" (regexp-quote mail-header-separator) "$"))
3795          (match-beginning 0)))
3796       (goto-char (point-min))
3797       (if (re-search-forward (concat "^" (regexp-quote header) ":") nil t)
3798           (progn
3799             (re-search-forward "^[^ \t]" nil 'move)
3800             (beginning-of-line)
3801             (skip-chars-backward "\n")
3802             t)
3803         (while (and afters
3804                     (not (re-search-forward
3805                           (concat "^" (regexp-quote (car afters)) ":")
3806                           nil t)))
3807           (pop afters))
3808         (when afters
3809           (re-search-forward "^[^ \t]" nil 'move)
3810           (beginning-of-line))
3811         (insert header ": \n")
3812         (forward-char -1)
3813         nil))))
3814
3815 (defun message-remove-signature ()
3816   "Remove the signature from the text between point and mark.
3817 The text will also be indented the normal way."
3818   (save-excursion
3819     (let ((start (point))
3820           mark)
3821       (if (not (re-search-forward message-signature-separator (mark t) t))
3822           ;; No signature here, so we just indent the cited text.
3823           (message-indent-citation)
3824         ;; Find the last non-empty line.
3825         (forward-line -1)
3826         (while (looking-at "[ \t]*$")
3827           (forward-line -1))
3828         (forward-line 1)
3829         (setq mark (set-marker (make-marker) (point)))
3830         (goto-char start)
3831         (message-indent-citation)
3832         ;; Enable undoing the deletion.
3833         (undo-boundary)
3834         (delete-region mark (mark t))
3835         (set-marker mark nil)))))
3836
3837 \f
3838
3839 ;;;
3840 ;;; Sending messages
3841 ;;;
3842
3843 (defun message-send-and-exit (&optional arg)
3844   "Send message like `message-send', then, if no errors, exit from mail buffer."
3845   (interactive "P")
3846   (let ((buf (current-buffer))
3847         (actions message-exit-actions))
3848     (when (and (message-send arg)
3849                (buffer-name buf))
3850       (if message-kill-buffer-on-exit
3851           (kill-buffer buf)
3852         (bury-buffer buf)
3853         (when (eq buf (current-buffer))
3854           (message-bury buf)))
3855       (message-do-actions actions)
3856       t)))
3857
3858 (defun message-dont-send ()
3859   "Don't send the message you have been editing.
3860 Instead, just auto-save the buffer and then bury it."
3861   (interactive)
3862   (set-buffer-modified-p t)
3863   (save-buffer)
3864   (let ((actions message-postpone-actions))
3865     (message-bury (current-buffer))
3866     (message-do-actions actions)))
3867
3868 (defun message-kill-buffer ()
3869   "Kill the current buffer."
3870   (interactive)
3871   (when (or (not (buffer-modified-p))
3872             (not message-kill-buffer-query)
3873             (yes-or-no-p "Message modified; kill anyway? "))
3874     (let ((actions message-kill-actions)
3875           (draft-article message-draft-article)
3876           (auto-save-file-name buffer-auto-save-file-name)
3877           (file-name buffer-file-name)
3878           (modified (buffer-modified-p)))
3879       (setq buffer-file-name nil)
3880       (kill-buffer (current-buffer))
3881       (when (and (or (and auto-save-file-name
3882                           (file-exists-p auto-save-file-name))
3883                      (and file-name
3884                           (file-exists-p file-name)))
3885                  (progn
3886                    ;; If the message buffer has lived in a dedicated window,
3887                    ;; `kill-buffer' has killed the frame.  Thus the
3888                    ;; `yes-or-no-p' may show up in a lowered frame.  Make sure
3889                    ;; that the user can see the question by raising the
3890                    ;; current frame:
3891                    (raise-frame)
3892                    (yes-or-no-p (format "Remove the backup file%s? "
3893                                         (if modified " too" "")))))
3894         (ignore-errors
3895           (delete-file auto-save-file-name))
3896         (let ((message-draft-article draft-article))
3897           (message-disassociate-draft)))
3898       (message-do-actions actions))))
3899
3900 (defun message-bury (buffer)
3901   "Bury this mail BUFFER."
3902   (let ((newbuf (other-buffer buffer)))
3903     (bury-buffer buffer)
3904     (if (and (window-dedicated-p (selected-window))
3905              (not (null (delq (selected-frame) (visible-frame-list)))))
3906         (delete-frame (selected-frame))
3907       (switch-to-buffer newbuf))))
3908
3909 (defun message-send (&optional arg)
3910   "Send the message in the current buffer.
3911 If `message-interactive' is non-nil, wait for success indication or
3912 error messages, and inform user.
3913 Otherwise any failure is reported in a message back to the user from
3914 the mailer.
3915 The usage of ARG is defined by the instance that called Message.
3916 It should typically alter the sending method in some way or other."
3917   (interactive "P")
3918   ;; Make it possible to undo the coming changes.
3919   (undo-boundary)
3920   (let ((inhibit-read-only t))
3921     (put-text-property (point-min) (point-max) 'read-only nil))
3922   (message-fix-before-sending)
3923   (run-hooks 'message-send-hook)
3924   (message message-sending-message)
3925   (let ((alist message-send-method-alist)
3926         (success t)
3927         elem sent dont-barf-on-no-method
3928         (message-options message-options))
3929     (message-options-set-recipient)
3930     (while (and success
3931                 (setq elem (pop alist)))
3932       (when (funcall (cadr elem))
3933         (when (and (or (not (memq (car elem)
3934                                   message-sent-message-via))
3935                        (message-fetch-field "supersedes")
3936                        (if (or (message-gnksa-enable-p 'multiple-copies)
3937                                (not (eq (car elem) 'news)))
3938                            (y-or-n-p
3939                             (format
3940                              "Already sent message via %s; resend? "
3941                              (car elem)))
3942                          (error "Denied posting -- multiple copies")))
3943                    (setq success (funcall (caddr elem) arg)))
3944           (setq sent t))))
3945     (unless (or sent
3946                 (not success)
3947                 (let ((fcc (message-fetch-field "Fcc"))
3948                       (gcc (message-fetch-field "Gcc")))
3949                   (when (or fcc gcc)
3950                     (or (eq message-allow-no-recipients 'always)
3951                         (and (not (eq message-allow-no-recipients 'never))
3952                              (setq dont-barf-on-no-method
3953                                    (gnus-y-or-n-p
3954                                     (format "No receiver, perform %s anyway? "
3955                                             (cond ((and fcc gcc) "Fcc and Gcc")
3956                                                   (fcc "Fcc")
3957                                                   (t "Gcc"))))))))))
3958       (error "No methods specified to send by"))
3959     (when (or dont-barf-on-no-method
3960               (and success sent))
3961       (message-do-fcc)
3962       (save-excursion
3963         (run-hooks 'message-sent-hook))
3964       (message "Sending...done")
3965       ;; Do ecomplete address snarfing.
3966       (when (message-mail-alias-type-p 'ecomplete)
3967         (message-put-addresses-in-ecomplete))
3968       ;; Mark the buffer as unmodified and delete auto-save.
3969       (set-buffer-modified-p nil)
3970       (delete-auto-save-file-if-necessary t)
3971       (message-disassociate-draft)
3972       ;; Delete other mail buffers and stuff.
3973       (message-do-send-housekeeping)
3974       (message-do-actions message-send-actions)
3975       ;; Return success.
3976       t)))
3977
3978 (defun message-send-via-mail (arg)
3979   "Send the current message via mail."
3980   (message-send-mail arg))
3981
3982 (defun message-send-via-news (arg)
3983   "Send the current message via news."
3984   (funcall message-send-news-function arg))
3985
3986 (defmacro message-check (type &rest forms)
3987   "Eval FORMS if TYPE is to be checked."
3988   `(or (message-check-element ,type)
3989        (save-excursion
3990          ,@forms)))
3991
3992 (put 'message-check 'lisp-indent-function 1)
3993 (put 'message-check 'edebug-form-spec '(form body))
3994
3995 (defun message-text-with-property (prop &optional start end reverse)
3996   "Return a list of start and end positions where the text has PROP.
3997 START and END bound the search, they default to `point-min' and
3998 `point-max' respectively.  If REVERSE is non-nil, find text which does
3999 not have PROP."
4000   (unless start
4001     (setq start (point-min)))
4002   (unless end
4003     (setq end (point-max)))
4004   (let (next regions)
4005     (if reverse
4006         (while (and start
4007                     (setq start (text-property-any start end prop nil)))
4008           (setq next (next-single-property-change start prop nil end))
4009           (push (cons start (or next end)) regions)
4010           (setq start next))
4011       (while (and start
4012                   (or (get-text-property start prop)
4013                       (and (setq start (next-single-property-change
4014                                         start prop nil end))
4015                            (get-text-property start prop))))
4016         (setq next (text-property-any start end prop nil))
4017         (push (cons start (or next end)) regions)
4018         (setq start next)))
4019     (nreverse regions)))
4020
4021 (defun message-fix-before-sending ()
4022   "Do various things to make the message nice before sending it."
4023   ;; Make sure there's a newline at the end of the message.
4024   (goto-char (point-max))
4025   (unless (bolp)
4026     (insert "\n"))
4027   ;; Make the hidden headers visible.
4028   (widen)
4029   ;; Sort headers before sending the message.
4030   (message-sort-headers)
4031   ;; Make invisible text visible.
4032   ;; It doesn't seem as if this is useful, since the invisible property
4033   ;; is clobbered by an after-change hook anyhow.
4034   (message-check 'invisible-text
4035     (let ((regions (message-text-with-property 'invisible))
4036           from to)
4037       (when regions
4038         (while regions
4039           (setq from (caar regions)
4040                 to (cdar regions)
4041                 regions (cdr regions))
4042           (put-text-property from to 'invisible nil)
4043           (message-overlay-put (message-make-overlay from to)
4044                                'face 'highlight))
4045         (unless (yes-or-no-p
4046                  "Invisible text found and made visible; continue sending? ")
4047           (error "Invisible text found and made visible")))))
4048   (message-check 'illegible-text
4049     (let (char found choice)
4050       (message-goto-body)
4051       (while (progn
4052                (skip-chars-forward mm-7bit-chars)
4053                (when (get-text-property (point) 'no-illegible-text)
4054                  ;; There is a signed or encrypted raw message part
4055                  ;; that is considered to be safe.
4056                  (goto-char (or (next-single-property-change
4057                                  (point) 'no-illegible-text)
4058                                 (point-max))))
4059                (setq char (char-after)))
4060         (when (or (< (mm-char-int char) 128)
4061                   (and (mm-multibyte-p)
4062                        (memq (char-charset char)
4063                              '(eight-bit-control eight-bit-graphic
4064                                                  control-1))
4065                        (not (get-text-property
4066                              (point) 'untranslated-utf-8))))
4067           (message-overlay-put (message-make-overlay (point) (1+ (point)))
4068                                'face 'highlight)
4069           (setq found t))
4070         (forward-char))
4071       (when found
4072         (setq choice
4073               (gnus-multiple-choice
4074                "Non-printable characters found.  Continue sending?"
4075                `((?d "Remove non-printable characters and send")
4076                  (?r ,(format
4077                        "Replace non-printable characters with \"%s\" and send"
4078                        message-replacement-char))
4079                  (?i "Ignore non-printable characters and send")
4080                  (?e "Continue editing"))))
4081         (if (eq choice ?e)
4082           (error "Non-printable characters"))
4083         (message-goto-body)
4084         (skip-chars-forward mm-7bit-chars)
4085         (while (not (eobp))
4086           (when (let ((char (char-after)))
4087                   (or (< (mm-char-int char) 128)
4088                       (and (mm-multibyte-p)
4089                            ;; FIXME: Wrong for Emacs 23 (unicode) and for
4090                            ;; things like undecable utf-8.  Should at least
4091                            ;; use find-coding-systems-region.
4092                            (memq (char-charset char)
4093                                  '(eight-bit-control eight-bit-graphic
4094                                                      control-1))
4095                            (not (get-text-property
4096                                  (point) 'untranslated-utf-8)))))
4097             (if (eq choice ?i)
4098                 (message-kill-all-overlays)
4099               (delete-char 1)
4100               (when (eq choice ?r)
4101                 (insert message-replacement-char))))
4102           (forward-char)
4103           (skip-chars-forward mm-7bit-chars))))))
4104
4105 (defun message-add-action (action &rest types)
4106   "Add ACTION to be performed when doing an exit of type TYPES."
4107   (while types
4108     (add-to-list (intern (format "message-%s-actions" (pop types)))
4109                  action)))
4110
4111 (defun message-delete-action (action &rest types)
4112   "Delete ACTION from lists of actions performed when doing an exit of type TYPES."
4113   (let (var)
4114     (while types
4115       (set (setq var (intern (format "message-%s-actions" (pop types))))
4116            (delq action (symbol-value var))))))
4117
4118 (defun message-do-actions (actions)
4119   "Perform all actions in ACTIONS."
4120   ;; Now perform actions on successful sending.
4121   (dolist (action actions)
4122     (ignore-errors
4123       (cond
4124        ;; A simple function.
4125        ((functionp action)
4126         (funcall action))
4127        ;; Something to be evaled.
4128        (t
4129         (eval action))))))
4130
4131 (defun message-send-mail-partially ()
4132   "Send mail as message/partial."
4133   ;; replace the header delimiter with a blank line
4134   (goto-char (point-min))
4135   (re-search-forward
4136    (concat "^" (regexp-quote mail-header-separator) "\n"))
4137   (replace-match "\n")
4138   (run-hooks 'message-send-mail-hook)
4139   (let ((p (goto-char (point-min)))
4140         (tembuf (message-generate-new-buffer-clone-locals " message temp"))
4141         (curbuf (current-buffer))
4142         (id (message-make-message-id)) (n 1)
4143         plist total  header required-mail-headers)
4144     (while (not (eobp))
4145       (if (< (point-max) (+ p message-send-mail-partially-limit))
4146           (goto-char (point-max))
4147         (goto-char (+ p message-send-mail-partially-limit))
4148         (beginning-of-line)
4149         (if (<= (point) p) (forward-line 1))) ;; In case of bad message.
4150       (push p plist)
4151       (setq p (point)))
4152     (setq total (length plist))
4153     (push (point-max) plist)
4154     (setq plist (nreverse plist))
4155     (unwind-protect
4156         (save-excursion
4157           (setq p (pop plist))
4158           (while plist
4159             (set-buffer curbuf)
4160             (copy-to-buffer tembuf p (car plist))
4161             (set-buffer tembuf)
4162             (goto-char (point-min))
4163             (if header
4164                 (progn
4165                   (goto-char (point-min))
4166                   (narrow-to-region (point) (point))
4167                   (insert header))
4168               (message-goto-eoh)
4169               (setq header (buffer-substring (point-min) (point)))
4170               (goto-char (point-min))
4171               (narrow-to-region (point) (point))
4172               (insert header)
4173               (message-remove-header "Mime-Version")
4174               (message-remove-header "Content-Type")
4175               (message-remove-header "Content-Transfer-Encoding")
4176               (message-remove-header "Message-ID")
4177               (message-remove-header "Lines")
4178               (goto-char (point-max))
4179               (insert "Mime-Version: 1.0\n")
4180               (setq header (buffer-string)))
4181             (goto-char (point-max))
4182             (insert (format "Content-Type: message/partial; id=\"%s\"; number=%d; total=%d\n\n"
4183                             id n total))
4184             (forward-char -1)
4185             (let ((mail-header-separator ""))
4186               (when (memq 'Message-ID message-required-mail-headers)
4187                 (insert "Message-ID: " (message-make-message-id) "\n"))
4188               (when (memq 'Lines message-required-mail-headers)
4189                 (insert "Lines: " (message-make-lines) "\n"))
4190               (message-goto-subject)
4191               (end-of-line)
4192               (insert (format " (%d/%d)" n total))
4193               (widen)
4194               (mm-with-unibyte-current-buffer
4195                 (funcall (or message-send-mail-real-function
4196                              message-send-mail-function))))
4197             (setq n (+ n 1))
4198             (setq p (pop plist))
4199             (erase-buffer)))
4200       (kill-buffer tembuf))))
4201
4202 (defun message-send-mail (&optional arg)
4203   (require 'mail-utils)
4204   (let* ((tembuf (message-generate-new-buffer-clone-locals " message temp"))
4205          (case-fold-search nil)
4206          (news (message-news-p))
4207          (mailbuf (current-buffer))
4208          (message-this-is-mail t)
4209          (message-posting-charset
4210           (if (fboundp 'gnus-setup-posting-charset)
4211               (gnus-setup-posting-charset nil)
4212             message-posting-charset))
4213          (headers message-required-mail-headers))
4214     (when (and message-generate-hashcash
4215                (not (eq message-generate-hashcash 'opportunistic)))
4216       (message "Generating hashcash...")
4217       ;; Wait for calculations already started to finish...
4218       (hashcash-wait-async)
4219       ;; ...and do calculations not already done.  mail-add-payment
4220       ;; will leave existing X-Hashcash headers alone.
4221       (mail-add-payment)
4222       (message "Generating hashcash...done"))
4223     (save-restriction
4224       (message-narrow-to-headers)
4225       ;; Generate the Mail-Followup-To header if the header is not there...
4226       (if (and (message-subscribed-p)
4227                (not (mail-fetch-field "mail-followup-to")))
4228           (setq headers
4229                 (cons
4230                  (cons "Mail-Followup-To" (message-make-mail-followup-to))
4231                  message-required-mail-headers))
4232         ;; otherwise, delete the MFT header if the field is empty
4233         (when (equal "" (mail-fetch-field "mail-followup-to"))
4234           (message-remove-header "^Mail-Followup-To:")))
4235       ;; Insert some headers.
4236       (let ((message-deletable-headers
4237              (if news nil message-deletable-headers)))
4238         (message-generate-headers headers))
4239       ;; Check continuation headers.
4240       (message-check 'continuation-headers
4241         (goto-char (point-min))
4242         (while (re-search-forward "^[^ \t\n][^ \t\n:]*[ \t\n]" nil t)
4243           (goto-char (match-beginning 0))
4244           (if (y-or-n-p "Fix continuation lines? ")
4245               (insert " ")
4246             (forward-line 1)
4247             (unless (y-or-n-p "Send anyway? ")
4248               (error "Failed to send the message")))))
4249       ;; Let the user do all of the above.
4250       (run-hooks 'message-header-hook))
4251     (unwind-protect
4252         (save-excursion
4253           (set-buffer tembuf)
4254           (erase-buffer)
4255           ;; Avoid copying text props (except hard newlines).
4256           (insert (with-current-buffer mailbuf
4257                     (mml-buffer-substring-no-properties-except-hard-newlines
4258                      (point-min) (point-max))))
4259           ;; Remove some headers.
4260           (message-encode-message-body)
4261           (save-restriction
4262             (message-narrow-to-headers)
4263             ;; We (re)generate the Lines header.
4264             (when (memq 'Lines message-required-mail-headers)
4265               (message-generate-headers '(Lines)))
4266             ;; Remove some headers.
4267             (message-remove-header message-ignored-mail-headers t)
4268             (let ((mail-parse-charset message-default-charset))
4269               (mail-encode-encoded-word-buffer)))
4270           (goto-char (point-max))
4271           ;; require one newline at the end.
4272           (or (= (preceding-char) ?\n)
4273               (insert ?\n))
4274           (message-cleanup-headers)
4275           ;; FIXME: we're inserting the courtesy copy after encoding.
4276           ;; This is wrong if the courtesy copy string contains
4277           ;; non-ASCII characters. -- jh
4278           (when
4279               (save-restriction
4280                 (message-narrow-to-headers)
4281                 (and news
4282                      (or (message-fetch-field "cc")
4283                          (message-fetch-field "bcc")
4284                          (message-fetch-field "to"))
4285                      (let ((content-type (message-fetch-field
4286                                           "content-type")))
4287                        (and
4288                         (or
4289                          (not content-type)
4290                          (string= "text/plain"
4291                                   (car
4292                                    (mail-header-parse-content-type
4293                                     content-type))))
4294                         (not
4295                          (string= "base64"
4296                                   (message-fetch-field
4297                                    "content-transfer-encoding")))))))
4298             (message-insert-courtesy-copy))
4299           (if (or (not message-send-mail-partially-limit)
4300                   (< (buffer-size) message-send-mail-partially-limit)
4301                   (not (message-y-or-n-p
4302                         "The message size is too large, split? "
4303                         t
4304                         "\
4305 The message size, "
4306                         (/ (buffer-size) 1000) "KB, is too large.
4307
4308 Some mail gateways (MTA's) bounce large messages.  To avoid the
4309 problem, answer `y', and the message will be split into several
4310 smaller pieces, the size of each is about "
4311                         (/ message-send-mail-partially-limit 1000)
4312                         "KB except the last
4313 one.
4314
4315 However, some mail readers (MUA's) can't read split messages, i.e.,
4316 mails in message/partially format. Answer `n', and the message will be
4317 sent in one piece.
4318
4319 The size limit is controlled by `message-send-mail-partially-limit'.
4320 If you always want Gnus to send messages in one piece, set
4321 `message-send-mail-partially-limit' to nil.
4322 ")))
4323               (mm-with-unibyte-current-buffer
4324                 (message "Sending via mail...")
4325                 (funcall (or message-send-mail-real-function
4326                              message-send-mail-function)))
4327             (message-send-mail-partially)))
4328       (kill-buffer tembuf))
4329     (set-buffer mailbuf)
4330     (push 'mail message-sent-message-via)))
4331
4332 (defun message-send-mail-with-sendmail ()
4333   "Send off the prepared buffer with sendmail."
4334   (let ((errbuf (if message-interactive
4335                     (message-generate-new-buffer-clone-locals
4336                      " sendmail errors")
4337                   0))
4338         resend-to-addresses delimline)
4339     (unwind-protect
4340         (progn
4341           (let ((case-fold-search t))
4342             (save-restriction
4343               (message-narrow-to-headers)
4344               (setq resend-to-addresses (message-fetch-field "resent-to")))
4345             ;; Change header-delimiter to be what sendmail expects.
4346             (goto-char (point-min))
4347             (re-search-forward
4348              (concat "^" (regexp-quote mail-header-separator) "\n"))
4349             (replace-match "\n")
4350             (backward-char 1)
4351             (setq delimline (point-marker))
4352             (run-hooks 'message-send-mail-hook)
4353             ;; Insert an extra newline if we need it to work around
4354             ;; Sun's bug that swallows newlines.
4355             (goto-char (1+ delimline))
4356             (when (eval message-mailer-swallows-blank-line)
4357               (newline))
4358             (when message-interactive
4359               (with-current-buffer errbuf
4360                 (erase-buffer))))
4361           (let* ((default-directory "/")
4362                  (coding-system-for-write message-send-coding-system)
4363                  (cpr (apply
4364                        'call-process-region
4365                        (append
4366                         (list (point-min) (point-max)
4367                               (cond ((boundp 'sendmail-program)
4368                                      sendmail-program)
4369                                     ((file-exists-p "/usr/sbin/sendmail")
4370                                      "/usr/sbin/sendmail")
4371                                     ((file-exists-p "/usr/lib/sendmail")
4372                                      "/usr/lib/sendmail")
4373                                     ((file-exists-p "/usr/ucblib/sendmail")
4374                                      "/usr/ucblib/sendmail")
4375                                     (t "fakemail"))
4376                               nil errbuf nil "-oi")
4377                         message-sendmail-extra-arguments
4378                         ;; Always specify who from,
4379                         ;; since some systems have broken sendmails.
4380                         ;; But some systems are more broken with -f, so
4381                         ;; we'll let users override this.
4382                         (if (null message-sendmail-f-is-evil)
4383                             (list "-f" (message-sendmail-envelope-from)))
4384                         ;; These mean "report errors by mail"
4385                         ;; and "deliver in background".
4386                         (if (null message-interactive) '("-oem" "-odb"))
4387                         ;; Get the addresses from the message
4388                         ;; unless this is a resend.
4389                         ;; We must not do that for a resend
4390                         ;; because we would find the original addresses.
4391                         ;; For a resend, include the specific addresses.
4392                         (if resend-to-addresses
4393                             (list resend-to-addresses)
4394                           '("-t"))))))
4395             (unless (or (null cpr) (and (numberp cpr) (zerop cpr)))
4396               (error "Sending...failed with exit value %d" cpr)))
4397           (when message-interactive
4398             (save-excursion
4399               (set-buffer errbuf)
4400               (goto-char (point-min))
4401               (while (re-search-forward "\n+ *" nil t)
4402                 (replace-match "; "))
4403               (if (not (zerop (buffer-size)))
4404                   (error "Sending...failed to %s"
4405                          (buffer-string))))))
4406       (when (bufferp errbuf)
4407         (kill-buffer errbuf)))))
4408
4409 (defun message-send-mail-with-qmail ()
4410   "Pass the prepared message buffer to qmail-inject.
4411 Refer to the documentation for the variable `message-send-mail-function'
4412 to find out how to use this."
4413   ;; replace the header delimiter with a blank line
4414   (goto-char (point-min))
4415   (re-search-forward
4416    (concat "^" (regexp-quote mail-header-separator) "\n"))
4417   (replace-match "\n")
4418   (run-hooks 'message-send-mail-hook)
4419   ;; send the message
4420   (case
4421       (let ((coding-system-for-write message-send-coding-system))
4422         (apply
4423          'call-process-region (point-min) (point-max)
4424          message-qmail-inject-program nil nil nil
4425          ;; qmail-inject's default behaviour is to look for addresses on the
4426          ;; command line; if there're none, it scans the headers.
4427          ;; yes, it does The Right Thing w.r.t. Resent-To and it's kin.
4428          ;;
4429          ;; in general, ALL of qmail-inject's defaults are perfect for simply
4430          ;; reading a formatted (i. e., at least a To: or Resent-To header)
4431          ;; message from stdin.
4432          ;;
4433          ;; qmail also has the advantage of not having been raped by
4434          ;; various vendors, so we don't have to allow for that, either --
4435          ;; compare this with message-send-mail-with-sendmail and weep
4436          ;; for sendmail's lost innocence.
4437          ;;
4438          ;; all this is way cool coz it lets us keep the arguments entirely
4439          ;; free for -inject-arguments -- a big win for the user and for us
4440          ;; since we don't have to play that double-guessing game and the user
4441          ;; gets full control (no gestapo'ish -f's, for instance).  --sj
4442          (if (functionp message-qmail-inject-args)
4443              (funcall message-qmail-inject-args)
4444            message-qmail-inject-args)))
4445     ;; qmail-inject doesn't say anything on it's stdout/stderr,
4446     ;; we have to look at the retval instead
4447     (0 nil)
4448     (100 (error "qmail-inject reported permanent failure"))
4449     (111 (error "qmail-inject reported transient failure"))
4450     ;; should never happen
4451     (t   (error "qmail-inject reported unknown failure"))))
4452
4453 (defun message-send-mail-with-mh ()
4454   "Send the prepared message buffer with mh."
4455   (let ((mh-previous-window-config nil)
4456         (name (mh-new-draft-name)))
4457     (setq buffer-file-name name)
4458     ;; MH wants to generate these headers itself.
4459     (when message-mh-deletable-headers
4460       (let ((headers message-mh-deletable-headers))
4461         (while headers
4462           (goto-char (point-min))
4463           (and (re-search-forward
4464                 (concat "^" (symbol-name (car headers)) ": *") nil t)
4465                (message-delete-line))
4466           (pop headers))))
4467     (run-hooks 'message-send-mail-hook)
4468     ;; Pass it on to mh.
4469     (mh-send-letter)))
4470
4471 (defun message-smtpmail-send-it ()
4472   "Send the prepared message buffer with `smtpmail-send-it'.
4473 This only differs from `smtpmail-send-it' that this command evaluates
4474 `message-send-mail-hook' just before sending a message.  It is useful
4475 if your ISP requires the POP-before-SMTP authentication.  See the Gnus
4476 manual for details."
4477   (run-hooks 'message-send-mail-hook)
4478   (smtpmail-send-it))
4479
4480 (defun message-canlock-generate ()
4481   "Return a string that is non-trivial to guess.
4482 Do not use this for anything important, it is cryptographically weak."
4483   (require 'sha1)
4484   (let (sha1-maximum-internal-length)
4485     (sha1 (concat (message-unique-id)
4486                   (format "%x%x%x" (random) (random t) (random))
4487                   (prin1-to-string (recent-keys))
4488                   (prin1-to-string (garbage-collect))))))
4489
4490 (defun message-canlock-password ()
4491   "The password used by message for cancel locks.
4492 This is the value of `canlock-password', if that option is non-nil.
4493 Otherwise, generate and save a value for `canlock-password' first."
4494   (unless canlock-password
4495     (customize-save-variable 'canlock-password (message-canlock-generate))
4496     (setq canlock-password-for-verify canlock-password))
4497   canlock-password)
4498
4499 (defun message-insert-canlock ()
4500   (when message-insert-canlock
4501     (message-canlock-password)
4502     (canlock-insert-header)))
4503
4504 (defun message-send-news (&optional arg)
4505   (let* ((tembuf (message-generate-new-buffer-clone-locals " *message temp*"))
4506          (case-fold-search nil)
4507          (method (if (functionp message-post-method)
4508                      (funcall message-post-method arg)
4509                    message-post-method))
4510          (newsgroups-field (save-restriction
4511                             (message-narrow-to-headers-or-head)
4512                             (message-fetch-field "Newsgroups")))
4513          (followup-field (save-restriction
4514                            (message-narrow-to-headers-or-head)
4515                            (message-fetch-field "Followup-To")))
4516          ;; BUG: We really need to get the charset for each name in the
4517          ;; Newsgroups and Followup-To lines to allow crossposting
4518          ;; between group namess with incompatible character sets.
4519          ;; -- Per Abrahamsen <abraham@dina.kvl.dk> 2001-10-08.
4520          (group-field-charset
4521           (gnus-group-name-charset method newsgroups-field))
4522          (followup-field-charset
4523           (gnus-group-name-charset method (or followup-field "")))
4524          (rfc2047-header-encoding-alist
4525           (append (when group-field-charset
4526                     (list (cons "Newsgroups" group-field-charset)))
4527                   (when followup-field-charset
4528                     (list (cons "Followup-To" followup-field-charset)))
4529                   rfc2047-header-encoding-alist))
4530          (messbuf (current-buffer))
4531          (message-syntax-checks
4532           (if (and arg
4533                    (listp message-syntax-checks))
4534               (cons '(existing-newsgroups . disabled)
4535                     message-syntax-checks)
4536             message-syntax-checks))
4537          (message-this-is-news t)
4538          (message-posting-charset
4539           (gnus-setup-posting-charset newsgroups-field))
4540          result)
4541     (if (not (message-check-news-body-syntax))
4542         nil
4543       (save-restriction
4544         (message-narrow-to-headers)
4545         ;; Insert some headers.
4546         (message-generate-headers message-required-news-headers)
4547         (message-insert-canlock)
4548         ;; Let the user do all of the above.
4549         (run-hooks 'message-header-hook))
4550       ;; Note: This check will be disabled by the ".*" default value for
4551       ;; gnus-group-name-charset-group-alist. -- Pa 2001-10-07.
4552       (when (and group-field-charset
4553                  (listp message-syntax-checks))
4554         (setq message-syntax-checks
4555               (cons '(valid-newsgroups . disabled)
4556                     message-syntax-checks)))
4557       (message-cleanup-headers)
4558       (if (not (let ((message-post-method method))
4559                  (message-check-news-syntax)))
4560           nil
4561         (unwind-protect
4562             (save-excursion
4563               (set-buffer tembuf)
4564               (buffer-disable-undo)
4565               (erase-buffer)
4566               ;; Avoid copying text props (except hard newlines).
4567               (insert
4568                (with-current-buffer messbuf
4569                  (mml-buffer-substring-no-properties-except-hard-newlines
4570                   (point-min) (point-max))))
4571               (message-encode-message-body)
4572               ;; Remove some headers.
4573               (save-restriction
4574                 (message-narrow-to-headers)
4575                 ;; We (re)generate the Lines header.
4576                 (when (memq 'Lines message-required-mail-headers)
4577                   (message-generate-headers '(Lines)))
4578                 ;; Remove some headers.
4579                 (message-remove-header message-ignored-news-headers t)
4580                 (let ((mail-parse-charset message-default-charset))
4581                   (mail-encode-encoded-word-buffer)))
4582               (goto-char (point-max))
4583               ;; require one newline at the end.
4584               (or (= (preceding-char) ?\n)
4585                   (insert ?\n))
4586               (let ((case-fold-search t))
4587                 ;; Remove the delimiter.
4588                 (goto-char (point-min))
4589                 (re-search-forward
4590                  (concat "^" (regexp-quote mail-header-separator) "\n"))
4591                 (replace-match "\n")
4592                 (backward-char 1))
4593               (run-hooks 'message-send-news-hook)
4594               (gnus-open-server method)
4595               (message "Sending news via %s..." (gnus-server-string method))
4596               (setq result (let ((mail-header-separator ""))
4597                              (gnus-request-post method))))
4598           (kill-buffer tembuf))
4599         (set-buffer messbuf)
4600         (if result
4601             (push 'news message-sent-message-via)
4602           (message "Couldn't send message via news: %s"
4603                    (nnheader-get-report (car method)))
4604           nil)))))
4605
4606 ;;;
4607 ;;; Header generation & syntax checking.
4608 ;;;
4609
4610 (defun message-check-element (type)
4611   "Return non-nil if this TYPE is not to be checked."
4612   (if (eq message-syntax-checks 'dont-check-for-anything-just-trust-me)
4613       t
4614     (let ((able (assq type message-syntax-checks)))
4615       (and (consp able)
4616            (eq (cdr able) 'disabled)))))
4617
4618 (defun message-check-news-syntax ()
4619   "Check the syntax of the message."
4620   (save-excursion
4621     (save-restriction
4622       (widen)
4623       ;; We narrow to the headers and check them first.
4624       (save-excursion
4625         (save-restriction
4626           (message-narrow-to-headers)
4627           (message-check-news-header-syntax))))))
4628
4629 (defun message-check-news-header-syntax ()
4630   (and
4631    ;; Check Newsgroups header.
4632    (message-check 'newsgroups
4633      (let ((group (message-fetch-field "newsgroups")))
4634        (or
4635         (and group
4636              (not (string-match "\\`[ \t]*\\'" group)))
4637         (ignore
4638          (message
4639           "The newsgroups field is empty or missing.  Posting is denied.")))))
4640    ;; Check the Subject header.
4641    (message-check 'subject
4642      (let* ((case-fold-search t)
4643             (subject (message-fetch-field "subject")))
4644        (or
4645         (and subject
4646              (not (string-match "\\`[ \t]*\\'" subject)))
4647         (ignore
4648          (message
4649           "The subject field is empty or missing.  Posting is denied.")))))
4650    ;; Check for commands in Subject.
4651    (message-check 'subject-cmsg
4652      (if (string-match "^cmsg " (message-fetch-field "subject"))
4653          (y-or-n-p
4654           "The control code \"cmsg\" is in the subject.  Really post? ")
4655        t))
4656    ;; Check long header lines.
4657    (message-check 'long-header-lines
4658      (let ((start (point))
4659            (header nil)
4660            (length 0)
4661            found)
4662        (while (and (not found)
4663                    (re-search-forward "^\\([^ \t:]+\\): " nil t))
4664          (if (> (- (point) (match-beginning 0)) 998)
4665              (setq found t
4666                    length (- (point) (match-beginning 0)))
4667            (setq header (match-string-no-properties 1)))
4668          (setq start (match-beginning 0))
4669          (forward-line 1))
4670        (if found
4671            (y-or-n-p (format "Your %s header is too long (%d).  Really post? "
4672                              header length))
4673          t)))
4674    ;; Check for multiple identical headers.
4675    (message-check 'multiple-headers
4676      (let (found)
4677        (while (and (not found)
4678                    (re-search-forward "^[^ \t:]+: " nil t))
4679          (save-excursion
4680            (or (re-search-forward
4681                 (concat "^"
4682                         (regexp-quote
4683                          (setq found
4684                                (buffer-substring
4685                                 (match-beginning 0) (- (match-end 0) 2))))
4686                         ":")
4687                 nil t)
4688                (setq found nil))))
4689        (if found
4690            (y-or-n-p (format "Multiple %s headers.  Really post? " found))
4691          t)))
4692    ;; Check for Version and Sendsys.
4693    (message-check 'sendsys
4694      (if (re-search-forward "^Sendsys:\\|^Version:" nil t)
4695          (y-or-n-p
4696           (format "The article contains a %s command.  Really post? "
4697                   (buffer-substring (match-beginning 0)
4698                                     (1- (match-end 0)))))
4699        t))
4700    ;; See whether we can shorten Followup-To.
4701    (message-check 'shorten-followup-to
4702      (let ((newsgroups (message-fetch-field "newsgroups"))
4703            (followup-to (message-fetch-field "followup-to"))
4704            to)
4705        (when (and newsgroups
4706                   (string-match "," newsgroups)
4707                   (not followup-to)
4708                   (not
4709                    (zerop
4710                     (length
4711                      (setq to (completing-read
4712                                "Followups to (default no Followup-To header): "
4713                                (mapcar #'list
4714                                        (cons "poster"
4715                                              (message-tokenize-header
4716                                               newsgroups)))))))))
4717          (goto-char (point-min))
4718          (insert "Followup-To: " to "\n"))
4719        t))
4720    ;; Check "Shoot me".
4721    (message-check 'shoot
4722      (if (re-search-forward
4723           "Message-ID.*.i-did-not-set--mail-host-address--so-tickle-me" nil t)
4724          (y-or-n-p "You appear to have a misconfigured system.  Really post? ")
4725        t))
4726    ;; Check for Approved.
4727    (message-check 'approved
4728      (if (re-search-forward "^Approved:" nil t)
4729          (y-or-n-p "The article contains an Approved header.  Really post? ")
4730        t))
4731    ;; Check the Message-ID header.
4732    (message-check 'message-id
4733      (let* ((case-fold-search t)
4734             (message-id (message-fetch-field "message-id" t)))
4735        (or (not message-id)
4736            ;; Is there an @ in the ID?
4737            (and (string-match "@" message-id)
4738                 ;; Is there a dot in the ID?
4739                 (string-match "@[^.]*\\." message-id)
4740                 ;; Does the ID end with a dot?
4741                 (not (string-match "\\.>" message-id)))
4742            (y-or-n-p
4743             (format "The Message-ID looks strange: \"%s\".  Really post? "
4744                     message-id)))))
4745    ;; Check the Newsgroups & Followup-To headers.
4746    (message-check 'existing-newsgroups
4747      (let* ((case-fold-search t)
4748             (newsgroups (message-fetch-field "newsgroups"))
4749             (followup-to (message-fetch-field "followup-to"))
4750             (groups (message-tokenize-header
4751                      (if followup-to
4752                          (concat newsgroups "," followup-to)
4753                        newsgroups)))
4754             (post-method (if (functionp message-post-method)
4755                              (funcall message-post-method)
4756                            message-post-method))
4757             ;; KLUDGE to handle nnvirtual groups.  Doing this right
4758             ;; would probably involve a new nnoo function.
4759             ;; -- Per Abrahamsen <abraham@dina.kvl.dk>, 2001-10-17.
4760             (method (if (and (consp post-method)
4761                              (eq (car post-method) 'nnvirtual)
4762                              gnus-message-group-art)
4763                         (let ((group (car (nnvirtual-find-group-art
4764                                            (car gnus-message-group-art)
4765                                            (cdr gnus-message-group-art)))))
4766                           (gnus-find-method-for-group group))
4767                       post-method))
4768             (known-groups
4769              (mapcar (lambda (n)
4770                        (gnus-group-name-decode
4771                         (gnus-group-real-name n)
4772                         (gnus-group-name-charset method n)))
4773                      (gnus-groups-from-server method)))
4774             errors)
4775        (while groups
4776          (when (and (not (equal (car groups) "poster"))
4777                     (not (member (car groups) known-groups))
4778                     (not (member (car groups) errors)))
4779            (push (car groups) errors))
4780          (pop groups))
4781        (cond
4782         ;; Gnus is not running.
4783         ((or (not (and (boundp 'gnus-active-hashtb)
4784                        gnus-active-hashtb))
4785              (not (boundp 'gnus-read-active-file)))
4786          t)
4787         ;; We don't have all the group names.
4788         ((and (or (not gnus-read-active-file)
4789                   (eq gnus-read-active-file 'some))
4790               errors)
4791          (y-or-n-p
4792           (format
4793            "Really use %s possibly unknown group%s: %s? "
4794            (if (= (length errors) 1) "this" "these")
4795            (if (= (length errors) 1) "" "s")
4796            (mapconcat 'identity errors ", "))))
4797         ;; There were no errors.
4798         ((not errors)
4799          t)
4800         ;; There are unknown groups.
4801         (t
4802          (y-or-n-p
4803           (format
4804            "Really post to %s unknown group%s: %s? "
4805            (if (= (length errors) 1) "this" "these")
4806            (if (= (length errors) 1) "" "s")
4807            (mapconcat 'identity errors ", ")))))))
4808    ;; Check continuation headers.
4809    (message-check 'continuation-headers
4810      (goto-char (point-min))
4811      (let ((do-posting t))
4812        (while (re-search-forward "^[^ \t\n][^ \t\n:]*[ \t\n]" nil t)
4813          (goto-char (match-beginning 0))
4814          (if (y-or-n-p "Fix continuation lines? ")
4815              (insert " ")
4816            (forward-line 1)
4817            (unless (y-or-n-p "Send anyway? ")
4818              (setq do-posting nil))))
4819        do-posting))
4820    ;; Check the Newsgroups & Followup-To headers for syntax errors.
4821    (message-check 'valid-newsgroups
4822      (let ((case-fold-search t)
4823            (headers '("Newsgroups" "Followup-To"))
4824            header error)
4825        (while (and headers (not error))
4826          (when (setq header (mail-fetch-field (car headers)))
4827            (if (or
4828                 (not
4829                  (string-match
4830                   "\\`\\([-+_&.a-zA-Z0-9]+\\)?\\(,[-+_&.a-zA-Z0-9]+\\)*\\'"
4831                   header))
4832                 (memq
4833                  nil (mapcar
4834                       (lambda (g)
4835                         (not (string-match "\\.\\'\\|\\.\\." g)))
4836                       (message-tokenize-header header ","))))
4837                (setq error t)))
4838          (unless error
4839            (pop headers)))
4840        (if (not error)
4841            t
4842          (y-or-n-p
4843           (format "The %s header looks odd: \"%s\".  Really post? "
4844                   (car headers) header)))))
4845    (message-check 'repeated-newsgroups
4846      (let ((case-fold-search t)
4847            (headers '("Newsgroups" "Followup-To"))
4848            header error groups group)
4849        (while (and headers
4850                    (not error))
4851          (when (setq header (mail-fetch-field (pop headers)))
4852            (setq groups (message-tokenize-header header ","))
4853            (while (setq group (pop groups))
4854              (when (member group groups)
4855                (setq error group
4856                      groups nil)))))
4857        (if (not error)
4858            t
4859          (y-or-n-p
4860           (format "Group %s is repeated in headers.  Really post? " error)))))
4861    ;; Check the From header.
4862    (message-check 'from
4863      (let* ((case-fold-search t)
4864             (from (message-fetch-field "from"))
4865             ad)
4866        (cond
4867         ((not from)
4868          (message "There is no From line.  Posting is denied.")
4869          nil)
4870         ((or (not (string-match
4871                    "@[^\\.]*\\."
4872                    (setq ad (nth 1 (mail-extract-address-components
4873                                     from))))) ;larsi@ifi
4874              (string-match "\\.\\." ad) ;larsi@ifi..uio
4875              (string-match "@\\." ad)   ;larsi@.ifi.uio
4876              (string-match "\\.$" ad)   ;larsi@ifi.uio.
4877              (not (string-match "^[^@]+@[^@]+$" ad)) ;larsi.ifi.uio
4878              (string-match "(.*).*(.*)" from)) ;(lars) (lars)
4879          (message
4880           "Denied posting -- the From looks strange: \"%s\"." from)
4881          nil)
4882         ((let ((addresses (rfc822-addresses from)))
4883            (while (and addresses
4884                        (not (eq (string-to-char (car addresses)) ?\()))
4885              (setq addresses (cdr addresses)))
4886            addresses)
4887          (message
4888           "Denied posting -- bad From address: \"%s\"." from)
4889          nil)
4890         (t t))))
4891    ;; Check the Reply-To header.
4892    (message-check 'reply-to
4893      (let* ((case-fold-search t)
4894             (reply-to (message-fetch-field "reply-to"))
4895             ad)
4896        (cond
4897         ((not reply-to)
4898          t)
4899         ((string-match "," reply-to)
4900          (y-or-n-p
4901           (format "Multiple Reply-To addresses: \"%s\". Really post? "
4902                   reply-to)))
4903         ((or (not (string-match
4904                    "@[^\\.]*\\."
4905                    (setq ad (nth 1 (mail-extract-address-components
4906                                     reply-to))))) ;larsi@ifi
4907              (string-match "\\.\\." ad) ;larsi@ifi..uio
4908              (string-match "@\\." ad)   ;larsi@.ifi.uio
4909              (string-match "\\.$" ad)   ;larsi@ifi.uio.
4910              (not (string-match "^[^@]+@[^@]+$" ad)) ;larsi.ifi.uio
4911              (string-match "(.*).*(.*)" reply-to)) ;(lars) (lars)
4912          (y-or-n-p
4913           (format
4914            "The Reply-To looks strange: \"%s\". Really post? "
4915            reply-to)))
4916         (t t))))))
4917
4918 (defun message-check-news-body-syntax ()
4919   (and
4920    ;; Check for long lines.
4921    (message-check 'long-lines
4922      (goto-char (point-min))
4923      (re-search-forward
4924       (concat "^" (regexp-quote mail-header-separator) "$"))
4925      (forward-line 1)
4926      (while (and
4927              (or (looking-at
4928                   "<#\\(/\\)?\\(multipart\\|part\\|external\\|mml\\)")
4929                  (let ((p (point)))
4930                    (end-of-line)
4931                    (< (- (point) p) 80)))
4932              (zerop (forward-line 1))))
4933      (or (bolp)
4934          (eobp)
4935          (y-or-n-p
4936           "You have lines longer than 79 characters.  Really post? ")))
4937    ;; Check whether the article is empty.
4938    (message-check 'empty
4939      (goto-char (point-min))
4940      (re-search-forward
4941       (concat "^" (regexp-quote mail-header-separator) "$"))
4942      (forward-line 1)
4943      (let ((b (point)))
4944        (goto-char (point-max))
4945        (re-search-backward message-signature-separator nil t)
4946        (beginning-of-line)
4947        (or (re-search-backward "[^ \n\t]" b t)
4948            (if (message-gnksa-enable-p 'empty-article)
4949                (y-or-n-p "Empty article.  Really post? ")
4950              (message "Denied posting -- Empty article.")
4951              nil))))
4952    ;; Check for control characters.
4953    (message-check 'control-chars
4954      (if (re-search-forward
4955           (mm-string-as-multibyte "[\000-\007\013\015-\032\034-\037\200-\237]")
4956           nil t)
4957          (y-or-n-p
4958           "The article contains control characters.  Really post? ")
4959        t))
4960    ;; Check excessive size.
4961    (message-check 'size
4962      (if (> (buffer-size) 60000)
4963          (y-or-n-p
4964           (format "The article is %d octets long.  Really post? "
4965                   (buffer-size)))
4966        t))
4967    ;; Check whether any new text has been added.
4968    (message-check 'new-text
4969      (or
4970       (not message-checksum)
4971       (not (eq (message-checksum) message-checksum))
4972       (if (message-gnksa-enable-p 'quoted-text-only)
4973           (y-or-n-p
4974            "It looks like no new text has been added.  Really post? ")
4975         (message "Denied posting -- no new text has been added.")
4976         nil)))
4977    ;; Check the length of the signature.
4978    (message-check 'signature
4979      (goto-char (point-max))
4980      (if (> (count-lines (point) (point-max)) 5)
4981          (y-or-n-p
4982           (format
4983            "Your .sig is %d lines; it should be max 4.  Really post? "
4984            (1- (count-lines (point) (point-max)))))
4985        t))
4986    ;; Ensure that text follows last quoted portion.
4987    (message-check 'quoting-style
4988      (goto-char (point-max))
4989      (let ((no-problem t))
4990        (when (search-backward-regexp "^>[^\n]*\n" nil t)
4991          (setq no-problem (search-forward-regexp "^[ \t]*[^>\n]" nil t)))
4992        (if no-problem
4993            t
4994          (if (message-gnksa-enable-p 'quoted-text-only)
4995              (y-or-n-p "Your text should follow quoted text.  Really post? ")
4996            ;; Ensure that
4997            (goto-char (point-min))
4998            (re-search-forward
4999             (concat "^" (regexp-quote mail-header-separator) "$"))
5000            (if (search-forward-regexp "^[ \t]*[^>\n]" nil t)
5001                (y-or-n-p "Your text should follow quoted text.  Really post? ")
5002              (message "Denied posting -- only quoted text.")
5003              nil)))))))
5004
5005 (defun message-checksum ()
5006   "Return a \"checksum\" for the current buffer."
5007   (let ((sum 0))
5008     (save-excursion
5009       (goto-char (point-min))
5010       (re-search-forward
5011        (concat "^" (regexp-quote mail-header-separator) "$"))
5012       (while (not (eobp))
5013         (when (not (looking-at "[ \t\n]"))
5014           (setq sum (logxor (ash sum 1) (if (natnump sum) 0 1)
5015                             (char-after))))
5016         (forward-char 1)))
5017     sum))
5018
5019 (defun message-do-fcc ()
5020   "Process Fcc headers in the current buffer."
5021   (let ((case-fold-search t)
5022         (buf (current-buffer))
5023         list file
5024         (mml-externalize-attachments message-fcc-externalize-attachments))
5025     (save-excursion
5026       (save-restriction
5027         (message-narrow-to-headers)
5028         (setq file (message-fetch-field "fcc" t)))
5029       (when file
5030         (set-buffer (get-buffer-create " *message temp*"))
5031         (erase-buffer)
5032         (insert-buffer-substring buf)
5033         (message-encode-message-body)
5034         (save-restriction
5035           (message-narrow-to-headers)
5036           (while (setq file (message-fetch-field "fcc" t))
5037             (push file list)
5038             (message-remove-header "fcc" nil t))
5039           (let ((mail-parse-charset message-default-charset)
5040                 (rfc2047-header-encoding-alist
5041                  (cons '("Newsgroups" . default)
5042                        rfc2047-header-encoding-alist)))
5043             (mail-encode-encoded-word-buffer)))
5044         (goto-char (point-min))
5045         (when (re-search-forward
5046                (concat "^" (regexp-quote mail-header-separator) "$")
5047                nil t)
5048           (replace-match "" t t ))
5049         ;; Process FCC operations.
5050         (while list
5051           (setq file (pop list))
5052           (if (string-match "^[ \t]*|[ \t]*\\(.*\\)[ \t]*$" file)
5053               ;; Pipe the article to the program in question.
5054               (call-process-region (point-min) (point-max) shell-file-name
5055                                    nil nil nil shell-command-switch
5056                                    (match-string 1 file))
5057             ;; Save the article.
5058             (setq file (expand-file-name file))
5059             (unless (file-exists-p (file-name-directory file))
5060               (make-directory (file-name-directory file) t))
5061             (if (and message-fcc-handler-function
5062                      (not (eq message-fcc-handler-function 'rmail-output)))
5063                 (funcall message-fcc-handler-function file)
5064               (if (and (file-readable-p file) (mail-file-babyl-p file))
5065                   (rmail-output file 1 nil t)
5066                 (let ((mail-use-rfc822 t))
5067                   (rmail-output file 1 t t))))))
5068         (kill-buffer (current-buffer))))))
5069
5070 (defun message-output (filename)
5071   "Append this article to Unix/babyl mail file FILENAME."
5072   (if (and (file-readable-p filename)
5073            (mail-file-babyl-p filename))
5074       (gnus-output-to-rmail filename t)
5075     (gnus-output-to-mail filename t)))
5076
5077 (defun message-cleanup-headers ()
5078   "Do various automatic cleanups of the headers."
5079   ;; Remove empty lines in the header.
5080   (save-restriction
5081     (message-narrow-to-headers)
5082     ;; Remove blank lines.
5083     (while (re-search-forward "^[ \t]*\n" nil t)
5084       (replace-match "" t t))
5085
5086     ;; Correct Newsgroups and Followup-To headers:  Change sequence of
5087     ;; spaces to comma and eliminate spaces around commas.  Eliminate
5088     ;; embedded line breaks.
5089     (goto-char (point-min))
5090     (while (re-search-forward "^\\(Newsgroups\\|Followup-To\\): +" nil t)
5091       (save-restriction
5092         (narrow-to-region
5093          (point)
5094          (if (re-search-forward "^[^ \t]" nil t)
5095              (match-beginning 0)
5096            (forward-line 1)
5097            (point)))
5098         (goto-char (point-min))
5099         (while (re-search-forward "\n[ \t]+" nil t)
5100           (replace-match " " t t))     ;No line breaks (too confusing)
5101         (goto-char (point-min))
5102         (while (re-search-forward "[ \t\n]*,[ \t\n]*\\|[ \t]+" nil t)
5103           (replace-match "," t t))
5104         (goto-char (point-min))
5105         ;; Remove trailing commas.
5106         (when (re-search-forward ",+$" nil t)
5107           (replace-match "" t t))))))
5108
5109 (defun message-make-date (&optional now)
5110   "Make a valid data header.
5111 If NOW, use that time instead."
5112   (let ((system-time-locale "C"))
5113     (format-time-string "%a, %d %b %Y %T %z" now)))
5114
5115 (defun message-insert-expires (days)
5116   "Insert the Expires header.  Expiry in DAYS days."
5117   (interactive "NExpire article in how many days? ")
5118   (save-excursion
5119     (message-position-on-field "Expires" "X-Draft-From")
5120     (insert (message-make-expires-date days))))
5121
5122 (defun message-make-expires-date (days)
5123   "Make date string for the Expires header.  Expiry in DAYS days.
5124
5125 In posting styles use `(\"Expires\" (make-expires-date 30))'."
5126   (let* ((cur (decode-time (current-time)))
5127          (nday (+ days (nth 3 cur))))
5128     (setf (nth 3 cur) nday)
5129     (message-make-date (apply 'encode-time cur))))
5130
5131 (defun message-make-message-id ()
5132   "Make a unique Message-ID."
5133   (concat "<" (message-unique-id)
5134           (let ((psubject (save-excursion (message-fetch-field "subject")))
5135                 (psupersedes
5136                  (save-excursion (message-fetch-field "supersedes"))))
5137             (if (or
5138                  (and message-reply-headers
5139                       (mail-header-references message-reply-headers)
5140                       (mail-header-subject message-reply-headers)
5141                       psubject
5142                       (not (string=
5143                             (message-strip-subject-re
5144                              (mail-header-subject message-reply-headers))
5145                             (message-strip-subject-re psubject))))
5146                  (and psupersedes
5147                       (string-match "_-_@" psupersedes)))
5148                 "_-_" ""))
5149           "@" (message-make-fqdn) ">"))
5150
5151 (defvar message-unique-id-char nil)
5152
5153 ;; If you ever change this function, make sure the new version
5154 ;; cannot generate IDs that the old version could.
5155 ;; You might for example insert a "." somewhere (not next to another dot
5156 ;; or string boundary), or modify the "fsf" string.
5157 (defun message-unique-id ()
5158   ;; Don't use microseconds from (current-time), they may be unsupported.
5159   ;; Instead we use this randomly inited counter.
5160   (setq message-unique-id-char
5161         (% (1+ (or message-unique-id-char (logand (random t) (1- (lsh 1 20)))))
5162            ;; (current-time) returns 16-bit ints,
5163            ;; and 2^16*25 just fits into 4 digits i base 36.
5164            (* 25 25)))
5165   (let ((tm (current-time)))
5166     (concat
5167      (if (or (memq system-type '(ms-dos emx vax-vms))
5168              ;; message-number-base36 doesn't handle bigints.
5169              (floatp (user-uid)))
5170          (let ((user (downcase (user-login-name))))
5171            (while (string-match "[^a-z0-9_]" user)
5172              (aset user (match-beginning 0) ?_))
5173            user)
5174        (message-number-base36 (user-uid) -1))
5175      (message-number-base36 (+ (car tm)
5176                                (lsh (% message-unique-id-char 25) 16)) 4)
5177      (message-number-base36 (+ (nth 1 tm)
5178                                (lsh (/ message-unique-id-char 25) 16)) 4)
5179      ;; Append a given name, because while the generated ID is unique
5180      ;; to this newsreader, other newsreaders might otherwise generate
5181      ;; the same ID via another algorithm.
5182      ".fsf")))
5183
5184 (defun message-number-base36 (num len)
5185   (if (if (< len 0)
5186           (<= num 0)
5187         (= len 0))
5188       ""
5189     (concat (message-number-base36 (/ num 36) (1- len))
5190             (char-to-string (aref "zyxwvutsrqponmlkjihgfedcba9876543210"
5191                                   (% num 36))))))
5192
5193 (defun message-make-organization ()
5194   "Make an Organization header."
5195   (let* ((organization
5196           (when message-user-organization
5197             (if (functionp message-user-organization)
5198                 (funcall message-user-organization)
5199               message-user-organization))))
5200     (with-temp-buffer
5201       (mm-enable-multibyte)
5202       (cond ((stringp organization)
5203              (insert organization))
5204             ((and (eq t organization)
5205                   message-user-organization-file
5206                   (file-exists-p message-user-organization-file))
5207              (insert-file-contents message-user-organization-file)))
5208       (goto-char (point-min))
5209       (while (re-search-forward "[\t\n]+" nil t)
5210         (replace-match "" t t))
5211       (unless (zerop (buffer-size))
5212         (buffer-string)))))
5213
5214 (defun message-make-lines ()
5215   "Count the number of lines and return numeric string."
5216   (save-excursion
5217     (save-restriction
5218       (widen)
5219       (message-goto-body)
5220       (int-to-string (count-lines (point) (point-max))))))
5221
5222 (defun message-make-references ()
5223   "Return the References header for this message."
5224   (when message-reply-headers
5225     (let ((message-id (mail-header-message-id message-reply-headers))
5226           (references (mail-header-references message-reply-headers))
5227           new-references)
5228       (if (or references message-id)
5229           (concat (or references "") (and references " ")
5230                   (or message-id ""))
5231         nil))))
5232
5233 (defun message-make-in-reply-to ()
5234   "Return the In-Reply-To header for this message."
5235   (when message-reply-headers
5236     (let ((from (mail-header-from message-reply-headers))
5237           (date (mail-header-date message-reply-headers))
5238           (msg-id (mail-header-message-id message-reply-headers)))
5239       (when from
5240         (let ((name (mail-extract-address-components from)))
5241           (concat
5242            msg-id (if msg-id " (")
5243            (if (car name)
5244                (if (string-match "[^\000-\177]" (car name))
5245                    ;; Quote a string containing non-ASCII characters.
5246                    ;; It will make the RFC2047 encoder cause an error
5247                    ;; if there are special characters.
5248                    (let ((default-enable-multibyte-characters t))
5249                      (with-temp-buffer
5250                        (insert (car name))
5251                        (goto-char (point-min))
5252                        (while (search-forward "\"" nil t)
5253                          (when (prog2
5254                                    (backward-char)
5255                                    (zerop (% (skip-chars-backward "\\\\") 2))
5256                                  (goto-char (match-beginning 0)))
5257                            (insert "\\"))
5258                          (forward-char))
5259                        ;; Those quotes will be removed by the RFC2047 encoder.
5260                        (concat "\"" (buffer-string) "\"")))
5261                  (car name))
5262              (nth 1 name))
5263            "'s message of \""
5264            (if (or (not date) (string= date ""))
5265                "(unknown date)" date)
5266            "\"" (if msg-id ")")))))))
5267
5268 (defun message-make-distribution ()
5269   "Make a Distribution header."
5270   (let ((orig-distribution (message-fetch-reply-field "distribution")))
5271     (cond ((functionp message-distribution-function)
5272            (funcall message-distribution-function))
5273           (t orig-distribution))))
5274
5275 (defun message-make-expires ()
5276   "Return an Expires header based on `message-expires'."
5277   (let ((current (current-time))
5278         (future (* 1.0 message-expires 60 60 24)))
5279     ;; Add the future to current.
5280     (setcar current (+ (car current) (round (/ future (expt 2 16)))))
5281     (setcar (cdr current) (+ (nth 1 current) (% (round future) (expt 2 16))))
5282     (message-make-date current)))
5283
5284 (defun message-make-path ()
5285   "Return uucp path."
5286   (let ((login-name (user-login-name)))
5287     (cond ((null message-user-path)
5288            (concat (system-name) "!" login-name))
5289           ((stringp message-user-path)
5290            ;; Support GENERICPATH.  Suggested by vixie@decwrl.dec.com.
5291            (concat message-user-path "!" login-name))
5292           (t login-name))))
5293
5294 (defun message-make-from (&optional name address )
5295   "Make a From header."
5296   (let* ((style message-from-style)
5297          (login (or address (message-make-address)))
5298          (fullname (or name
5299                        (and (boundp 'user-full-name)
5300                             user-full-name)
5301                        (user-full-name))))
5302     (when (string= fullname "&")
5303       (setq fullname (user-login-name)))
5304     (with-temp-buffer
5305       (mm-enable-multibyte)
5306       (cond
5307        ((or (null style)
5308             (equal fullname ""))
5309         (insert login))
5310        ((or (eq style 'angles)
5311             (and (not (eq style 'parens))
5312                  ;; Use angles if no quoting is needed, or if parens would
5313                  ;; need quoting too.
5314                  (or (not (string-match "[^- !#-'*+/-9=?A-Z^-~]" fullname))
5315                      (let ((tmp (concat fullname nil)))
5316                        (while (string-match "([^()]*)" tmp)
5317                          (aset tmp (match-beginning 0) ?-)
5318                          (aset tmp (1- (match-end 0)) ?-))
5319                        (string-match "[\\()]" tmp)))))
5320         (insert fullname)
5321         (goto-char (point-min))
5322         ;; Look for a character that cannot appear unquoted
5323         ;; according to RFC 822.
5324         (when (re-search-forward "[^- !#-'*+/-9=?A-Z^-~]" nil 1)
5325           ;; Quote fullname, escaping specials.
5326           (goto-char (point-min))
5327           (insert "\"")
5328           (while (re-search-forward "[\"\\]" nil 1)
5329             (replace-match "\\\\\\&" t))
5330           (insert "\""))
5331         (insert " <" login ">"))
5332        (t                               ; 'parens or default
5333         (insert login " (")
5334         (let ((fullname-start (point)))
5335           (insert fullname)
5336           (goto-char fullname-start)
5337           ;; RFC 822 says \ and nonmatching parentheses
5338           ;; must be escaped in comments.
5339           ;; Escape every instance of ()\ ...
5340           (while (re-search-forward "[()\\]" nil 1)
5341             (replace-match "\\\\\\&" t))
5342           ;; ... then undo escaping of matching parentheses,
5343           ;; including matching nested parentheses.
5344           (goto-char fullname-start)
5345           (while (re-search-forward
5346                   "\\(\\=\\|[^\\]\\(\\\\\\\\\\)*\\)\\\\(\\(\\([^\\]\\|\\\\\\\\\\)*\\)\\\\)"
5347                   nil 1)
5348             (replace-match "\\1(\\3)" t)
5349             (goto-char fullname-start)))
5350         (insert ")")))
5351       (buffer-string))))
5352
5353 (defun message-make-sender ()
5354   "Return the \"real\" user address.
5355 This function tries to ignore all user modifications, and
5356 give as trustworthy answer as possible."
5357   (concat (user-login-name) "@" (system-name)))
5358
5359 (defun message-make-address ()
5360   "Make the address of the user."
5361   (or (message-user-mail-address)
5362       (concat (user-login-name) "@" (message-make-domain))))
5363
5364 (defun message-user-mail-address ()
5365   "Return the pertinent part of `user-mail-address'."
5366   (when (and user-mail-address
5367              (string-match "@.*\\." user-mail-address))
5368     (if (string-match " " user-mail-address)
5369         (nth 1 (mail-extract-address-components user-mail-address))
5370       user-mail-address)))
5371
5372 (defun message-sendmail-envelope-from ()
5373   "Return the envelope from."
5374   (cond ((eq message-sendmail-envelope-from 'header)
5375          (nth 1 (mail-extract-address-components
5376                  (message-fetch-field "from"))))
5377         ((stringp message-sendmail-envelope-from)
5378          message-sendmail-envelope-from)
5379         (t
5380          (message-make-address))))
5381
5382 (defun message-make-fqdn ()
5383   "Return user's fully qualified domain name."
5384   (let* ((system-name (system-name))
5385          (user-mail (message-user-mail-address))
5386          (user-domain
5387           (if (and user-mail
5388                    (string-match "@\\(.*\\)\\'" user-mail))
5389               (match-string 1 user-mail)))
5390          (case-fold-search t))
5391     (cond
5392      ((and message-user-fqdn
5393            (stringp message-user-fqdn)
5394            (string-match message-valid-fqdn-regexp message-user-fqdn)
5395            (not (string-match message-bogus-system-names message-user-fqdn)))
5396       ;; `message-user-fqdn' seems to be valid
5397       message-user-fqdn)
5398      ((and (string-match message-valid-fqdn-regexp system-name)
5399            (not (string-match message-bogus-system-names system-name)))
5400       ;; `system-name' returned the right result.
5401       system-name)
5402      ;; Try `mail-host-address'.
5403      ((and (boundp 'mail-host-address)
5404            (stringp mail-host-address)
5405            (string-match message-valid-fqdn-regexp mail-host-address)
5406            (not (string-match message-bogus-system-names mail-host-address)))
5407       mail-host-address)
5408      ;; We try `user-mail-address' as a backup.
5409      ((and user-domain
5410            (stringp user-domain)
5411            (string-match message-valid-fqdn-regexp user-domain)
5412            (not (string-match message-bogus-system-names user-domain)))
5413       user-domain)
5414      ;; Default to this bogus thing.
5415      (t
5416       (concat system-name
5417               ".i-did-not-set--mail-host-address--so-tickle-me")))))
5418
5419 (defun message-make-host-name ()
5420   "Return the name of the host."
5421   (let ((fqdn (message-make-fqdn)))
5422     (string-match "^[^.]+\\." fqdn)
5423     (substring fqdn 0 (1- (match-end 0)))))
5424
5425 (defun message-make-domain ()
5426   "Return the domain name."
5427   (or mail-host-address
5428       (message-make-fqdn)))
5429
5430 (defun message-to-list-only ()
5431   "Send a message to the list only.
5432 Remove all addresses but the list address from To and Cc headers."
5433   (interactive)
5434   (let ((listaddr (message-make-mail-followup-to t)))
5435     (when listaddr
5436       (save-excursion
5437         (message-remove-header "to")
5438         (message-remove-header "cc")
5439         (message-position-on-field "To" "X-Draft-From")
5440         (insert listaddr)))))
5441
5442 (defun message-make-mail-followup-to (&optional only-show-subscribed)
5443   "Return the Mail-Followup-To header.
5444 If passed the optional argument ONLY-SHOW-SUBSCRIBED only return the
5445 subscribed address (and not the additional To and Cc header contents)."
5446   (let* ((case-fold-search t)
5447          (to (message-fetch-field "To"))
5448          (cc (message-fetch-field "cc"))
5449          (msg-recipients (concat to (and to cc ", ") cc))
5450          (recipients
5451           (mapcar 'mail-strip-quoted-names
5452                   (message-tokenize-header msg-recipients)))
5453          (file-regexps
5454           (if message-subscribed-address-file
5455               (let (begin end item re)
5456                 (save-excursion
5457                   (with-temp-buffer
5458                     (insert-file-contents message-subscribed-address-file)
5459                     (while (not (eobp))
5460                       (setq begin (point))
5461                       (forward-line 1)
5462                       (setq end (point))
5463                       (if (bolp) (setq end (1- end)))
5464                       (setq item (regexp-quote (buffer-substring begin end)))
5465                       (if re (setq re (concat re "\\|" item))
5466                         (setq re (concat "\\`\\(" item))))
5467                     (and re (list (concat re "\\)\\'"))))))))
5468          (mft-regexps (apply 'append message-subscribed-regexps
5469                              (mapcar 'regexp-quote
5470                                      message-subscribed-addresses)
5471                              file-regexps
5472                              (mapcar 'funcall
5473                                      message-subscribed-address-functions))))
5474     (save-match-data
5475       (let ((subscribed-lists nil)
5476             (list
5477              (loop for recipient in recipients
5478                when (loop for regexp in mft-regexps
5479                       when (string-match regexp recipient) return t)
5480                return recipient)))
5481         (when list
5482           (if only-show-subscribed
5483               list
5484             msg-recipients))))))
5485
5486 (defun message-idna-to-ascii-rhs-1 (header)
5487   "Interactively potentially IDNA encode domain names in HEADER."
5488   (let ((field (message-fetch-field header))
5489         rhs ace  address)
5490     (when field
5491       (dolist (rhs
5492                (mm-delete-duplicates
5493                 (mapcar (lambda (rhs) (or (cadr (split-string rhs "@")) ""))
5494                         (mapcar 'downcase
5495                                 (mapcar
5496                                  'car (mail-header-parse-addresses field))))))
5497         (setq ace (downcase (idna-to-ascii rhs)))
5498         (when (and (not (equal rhs ace))
5499                    (or (not (eq message-use-idna 'ask))
5500                        (y-or-n-p (format "Replace %s with %s in %s:? "
5501                                          rhs ace header))))
5502           (goto-char (point-min))
5503           (while (re-search-forward (concat "^" header ":") nil t)
5504             (message-narrow-to-field)
5505             (while (search-forward (concat "@" rhs) nil t)
5506               (replace-match (concat "@" ace) t t))
5507             (goto-char (point-max))
5508             (widen)))))))
5509
5510 (defun message-idna-to-ascii-rhs ()
5511   "Possibly IDNA encode non-ASCII domain names in From:, To: and Cc: headers.
5512 See `message-idna-encode'."
5513   (interactive)
5514   (when message-use-idna
5515     (save-excursion
5516       (save-restriction
5517         (message-narrow-to-head)
5518         (message-idna-to-ascii-rhs-1 "From")
5519         (message-idna-to-ascii-rhs-1 "To")
5520         (message-idna-to-ascii-rhs-1 "Reply-To")
5521         (message-idna-to-ascii-rhs-1 "Mail-Reply-To")
5522         (message-idna-to-ascii-rhs-1 "Mail-Followup-To")
5523         (message-idna-to-ascii-rhs-1 "Cc")))))
5524
5525 (defun message-generate-headers (headers)
5526   "Prepare article HEADERS.
5527 Headers already prepared in the buffer are not modified."
5528   (setq headers (append headers message-required-headers))
5529   (save-restriction
5530     (message-narrow-to-headers)
5531     (let* ((Date (message-make-date))
5532            (Message-ID (message-make-message-id))
5533            (Organization (message-make-organization))
5534            (From (message-make-from))
5535            (Path (message-make-path))
5536            (Subject nil)
5537            (Newsgroups nil)
5538            (In-Reply-To (message-make-in-reply-to))
5539            (References (message-make-references))
5540            (To nil)
5541            (Distribution (message-make-distribution))
5542            (Lines (message-make-lines))
5543            (User-Agent message-newsreader)
5544            (Expires (message-make-expires))
5545            (case-fold-search t)
5546            (optionalp nil)
5547            header value elem header-string)
5548       ;; First we remove any old generated headers.
5549       (let ((headers message-deletable-headers))
5550         (unless (buffer-modified-p)
5551           (setq headers (delq 'Message-ID (copy-sequence headers))))
5552         (while headers
5553           (goto-char (point-min))
5554           (and (re-search-forward
5555                 (concat "^" (symbol-name (car headers)) ": *") nil t)
5556                (get-text-property (1+ (match-beginning 0)) 'message-deletable)
5557                (message-delete-line))
5558           (pop headers)))
5559       ;; Go through all the required headers and see if they are in the
5560       ;; articles already.  If they are not, or are empty, they are
5561       ;; inserted automatically - except for Subject, Newsgroups and
5562       ;; Distribution.
5563       (while headers
5564         (goto-char (point-min))
5565         (setq elem (pop headers))
5566         (if (consp elem)
5567             (if (eq (car elem) 'optional)
5568                 (setq header (cdr elem)
5569                       optionalp t)
5570               (setq header (car elem)))
5571           (setq header elem))
5572         (setq header-string  (if (stringp header)
5573                                  header
5574                                (symbol-name header)))
5575         (when (or (not (re-search-forward
5576                         (concat "^"
5577                                 (regexp-quote (downcase header-string))
5578                                 ":")
5579                         nil t))
5580                   (progn
5581                     ;; The header was found.  We insert a space after the
5582                     ;; colon, if there is none.
5583                     (if (/= (char-after) ? ) (insert " ") (forward-char 1))
5584                     ;; Find out whether the header is empty.
5585                     (looking-at "[ \t]*\n[^ \t]")))
5586           ;; So we find out what value we should insert.
5587           (setq value
5588                 (cond
5589                  ((and (consp elem)
5590                        (eq (car elem) 'optional)
5591                        (not (member header-string message-inserted-headers)))
5592                   ;; This is an optional header.  If the cdr of this
5593                   ;; is something that is nil, then we do not insert
5594                   ;; this header.
5595                   (setq header (cdr elem))
5596                   (or (and (functionp (cdr elem))
5597                            (funcall (cdr elem)))
5598                       (and (boundp (cdr elem))
5599                            (symbol-value (cdr elem)))))
5600                  ((consp elem)
5601                   ;; The element is a cons.  Either the cdr is a
5602                   ;; string to be inserted verbatim, or it is a
5603                   ;; function, and we insert the value returned from
5604                   ;; this function.
5605                   (or (and (stringp (cdr elem))
5606                            (cdr elem))
5607                       (and (functionp (cdr elem))
5608                            (funcall (cdr elem)))))
5609                  ((and (boundp header)
5610                        (symbol-value header))
5611                   ;; The element is a symbol.  We insert the value
5612                   ;; of this symbol, if any.
5613                   (symbol-value header))
5614                  ((not (message-check-element
5615                         (intern (downcase (symbol-name header)))))
5616                   ;; We couldn't generate a value for this header,
5617                   ;; so we just ask the user.
5618                   (read-from-minibuffer
5619                    (format "Empty header for %s; enter value: " header)))))
5620           ;; Finally insert the header.
5621           (when (and value
5622                      (not (equal value "")))
5623             (save-excursion
5624               (if (bolp)
5625                   (progn
5626                     ;; This header didn't exist, so we insert it.
5627                     (goto-char (point-max))
5628                     (let ((formatter
5629                            (cdr (assq header message-header-format-alist))))
5630                       (if formatter
5631                           (funcall formatter header value)
5632                         (insert header-string ": " value))
5633                       (goto-char (message-fill-field))
5634                       ;; We check whether the value was ended by a
5635                       ;; newline.  If not, we insert one.
5636                       (unless (bolp)
5637                         (insert "\n"))
5638                       (forward-line -1)))
5639                 ;; The value of this header was empty, so we clear
5640                 ;; totally and insert the new value.
5641                 (delete-region (point) (point-at-eol))
5642                 ;; If the header is optional, and the header was
5643                 ;; empty, we can't insert it anyway.
5644                 (unless optionalp
5645                   (push header-string message-inserted-headers)
5646                   (insert value)
5647                   (message-fill-field)))
5648               ;; Add the deletable property to the headers that require it.
5649               (and (memq header message-deletable-headers)
5650                    (progn (beginning-of-line) (looking-at "[^:]+: "))
5651                    (add-text-properties
5652                     (point) (match-end 0)
5653                     '(message-deletable t face italic) (current-buffer)))))))
5654       ;; Insert new Sender if the From is strange.
5655       (let ((from (message-fetch-field "from"))
5656             (sender (message-fetch-field "sender"))
5657             (secure-sender (message-make-sender)))
5658         (when (and from
5659                    (not (message-check-element 'sender))
5660                    (not (string=
5661                          (downcase
5662                           (cadr (mail-extract-address-components from)))
5663                          (downcase secure-sender)))
5664                    (or (null sender)
5665                        (not
5666                         (string=
5667                          (downcase
5668                           (cadr (mail-extract-address-components sender)))
5669                          (downcase secure-sender)))))
5670           (goto-char (point-min))
5671           ;; Rename any old Sender headers to Original-Sender.
5672           (when (re-search-forward "^\\(Original-\\)*Sender:" nil t)
5673             (beginning-of-line)
5674             (insert "Original-")
5675             (beginning-of-line))
5676           (when (or (message-news-p)
5677                     (string-match "@.+\\.." secure-sender))
5678             (insert "Sender: " secure-sender "\n"))))
5679       ;; Check for IDNA
5680       (message-idna-to-ascii-rhs))))
5681
5682 (defun message-insert-courtesy-copy ()
5683   "Insert a courtesy message in mail copies of combined messages."
5684   (let (newsgroups)
5685     (save-excursion
5686       (save-restriction
5687         (message-narrow-to-headers)
5688         (when (setq newsgroups (message-fetch-field "newsgroups"))
5689           (goto-char (point-max))
5690           (insert "Posted-To: " newsgroups "\n")))
5691       (forward-line 1)
5692       (when message-courtesy-message
5693         (cond
5694          ((string-match "%s" message-courtesy-message)
5695           (insert (format message-courtesy-message newsgroups)))
5696          (t
5697           (insert message-courtesy-message)))))))
5698
5699 ;;;
5700 ;;; Setting up a message buffer
5701 ;;;
5702
5703 (defun message-skip-to-next-address ()
5704   (let ((end (save-excursion
5705                (message-next-header)
5706                (point)))
5707         quoted char)
5708     (when (looking-at ",")
5709       (forward-char 1))
5710     (while (and (not (= (point) end))
5711                 (or (not (eq char ?,))
5712                     quoted))
5713       (skip-chars-forward "^,\"" (point-max))
5714       (when (eq (setq char (following-char)) ?\")
5715         (setq quoted (not quoted)))
5716       (unless (= (point) end)
5717         (forward-char 1)))
5718     (skip-chars-forward " \t\n")))
5719
5720 (defun message-fill-address (header value)
5721   (insert (capitalize (symbol-name header))
5722           ": "
5723           (if (consp value) (car value) value)
5724           "\n")
5725   (message-fill-field-address))
5726
5727 (defun message-split-line ()
5728   "Split current line, moving portion beyond point vertically down.
5729 If the current line has `message-yank-prefix', insert it on the new line."
5730   (interactive "*")
5731   (condition-case nil
5732       (split-line message-yank-prefix) ;; Emacs 22.1+ supports arg.
5733     (error
5734      (split-line))))
5735
5736 (defun message-insert-header (header value)
5737   (insert (capitalize (symbol-name header))
5738           ": "
5739           (if (consp value) (car value) value)))
5740
5741 (defun message-field-name ()
5742   (save-excursion
5743     (goto-char (point-min))
5744     (when (looking-at "\\([^:]+\\):")
5745       (intern (capitalize (match-string 1))))))
5746
5747 (defun message-fill-field ()
5748   (save-excursion
5749     (save-restriction
5750       (message-narrow-to-field)
5751       (let ((field-name (message-field-name)))
5752         (funcall (or (cadr (assq field-name message-field-fillers))
5753                      'message-fill-field-general)))
5754       (point-max))))
5755
5756 (defun message-fill-field-address ()
5757   (while (not (eobp))
5758     (message-skip-to-next-address)
5759     (let (last)
5760       (if (and (> (current-column) 78)
5761                last)
5762           (progn
5763             (save-excursion
5764               (goto-char last)
5765               (insert "\n\t"))
5766             (setq last (1+ (point))))
5767         (setq last (1+ (point)))))))
5768
5769 (defun message-fill-field-general ()
5770   (let ((begin (point))
5771         (fill-column 78)
5772         (fill-prefix "\t"))
5773     (while (and (search-forward "\n" nil t)
5774                 (not (eobp)))
5775       (replace-match " " t t))
5776     (fill-region-as-paragraph begin (point-max))
5777     ;; Tapdance around looong Message-IDs.
5778     (forward-line -1)
5779     (when (looking-at "[ \t]*$")
5780       (message-delete-line))
5781     (goto-char begin)
5782     (search-forward ":" nil t)
5783     (when (looking-at "\n[ \t]+")
5784       (replace-match " " t t))
5785     (goto-char (point-max))))
5786
5787 (defun message-shorten-1 (list cut surplus)
5788   "Cut SURPLUS elements out of LIST, beginning with CUTth one."
5789   (setcdr (nthcdr (- cut 2) list)
5790           (nthcdr (+ (- cut 2) surplus 1) list)))
5791
5792 (defun message-shorten-references (header references)
5793   "Trim REFERENCES to be 21 Message-ID long or less, and fold them.
5794 When sending via news, also check that the REFERENCES are less
5795 than 988 characters long, and if they are not, trim them until
5796 they are."
5797   (let ((maxcount 21)
5798         (count 0)
5799         (cut 2)
5800         refs)
5801     (with-temp-buffer
5802       (insert references)
5803       (goto-char (point-min))
5804       ;; Cons a list of valid references.
5805       (while (re-search-forward "<[^>]+>" nil t)
5806         (push (match-string 0) refs))
5807       (setq refs (nreverse refs)
5808             count (length refs)))
5809
5810     ;; If the list has more than MAXCOUNT elements, trim it by
5811     ;; removing the CUTth element and the required number of
5812     ;; elements that follow.
5813     (when (> count maxcount)
5814       (let ((surplus (- count maxcount)))
5815         (message-shorten-1 refs cut surplus)
5816         (decf count surplus)))
5817
5818     ;; When sending via news, make sure the total folded length will
5819     ;; be less than 998 characters.  This is to cater to broken INN
5820     ;; 2.3 which counts the total number of characters in a header
5821     ;; rather than the physical line length of each line, as it should.
5822     ;;
5823     ;; This hack should be removed when it's believed than INN 2.3 is
5824     ;; no longer widely used.
5825     ;;
5826     ;; At this point the headers have not been generated, thus we use
5827     ;; message-this-is-news directly.
5828     (when message-this-is-news
5829       (while (< 998
5830                 (with-temp-buffer
5831                   (message-insert-header
5832                    header (mapconcat #'identity refs " "))
5833                   (buffer-size)))
5834         (message-shorten-1 refs cut 1)))
5835     ;; Finally, collect the references back into a string and insert
5836     ;; it into the buffer.
5837     (message-insert-header header (mapconcat #'identity refs " "))))
5838
5839 (defun message-position-point ()
5840   "Move point to where the user probably wants to find it."
5841   (message-narrow-to-headers)
5842   (cond
5843    ((re-search-forward "^[^:]+:[ \t]*$" nil t)
5844     (search-backward ":" )
5845     (widen)
5846     (forward-char 1)
5847     (if (eq (char-after) ? )
5848         (forward-char 1)
5849       (insert " ")))
5850    (t
5851     (goto-char (point-max))
5852     (widen)
5853     (forward-line 1)
5854     (unless (looking-at "$")
5855       (forward-line 2)))
5856    (sit-for 0)))
5857
5858 (defcustom message-beginning-of-line t
5859   "Whether \\<message-mode-map>\\[message-beginning-of-line]\
5860  goes to beginning of header values."
5861   :version "22.1"
5862   :group 'message-buffers
5863   :link '(custom-manual "(message)Movement")
5864   :type 'boolean)
5865
5866 (defun message-beginning-of-line (&optional n)
5867   "Move point to beginning of header value or to beginning of line.
5868 The prefix argument N is passed directly to `beginning-of-line'.
5869
5870 This command is identical to `beginning-of-line' if point is
5871 outside the message header or if the option `message-beginning-of-line'
5872 is nil.
5873
5874 If point is in the message header and on a (non-continued) header
5875 line, move point to the beginning of the header value or the beginning of line,
5876 whichever is closer.  If point is already at beginning of line, move point to
5877 beginning of header value.  Therefore, repeated calls will toggle point
5878 between beginning of field and beginning of line."
5879   (interactive "p")
5880   (let ((zrs 'zmacs-region-stays))
5881     (when (and (interactive-p) (boundp zrs))
5882       (set zrs t)))
5883   (if (and message-beginning-of-line
5884            (message-point-in-header-p))
5885       (let* ((here (point))
5886              (bol (progn (beginning-of-line n) (point)))
5887              (eol (point-at-eol))
5888              (eoh (re-search-forward ": *" eol t)))
5889         (goto-char
5890          (if (and eoh (or (< eoh here) (= bol here)))
5891              eoh bol)))
5892     (beginning-of-line n)))
5893
5894 (defun message-buffer-name (type &optional to group)
5895   "Return a new (unique) buffer name based on TYPE and TO."
5896   (cond
5897    ;; Generate a new buffer name The Message Way.
5898    ((memq message-generate-new-buffers '(unique t))
5899     (generate-new-buffer-name
5900      (concat "*" type
5901              (if to
5902                  (concat " to "
5903                          (or (car (mail-extract-address-components to))
5904                              to) "")
5905                "")
5906              (if (and group (not (string= group ""))) (concat " on " group) "")
5907              "*")))
5908    ;; Check whether `message-generate-new-buffers' is a function,
5909    ;; and if so, call it.
5910    ((functionp message-generate-new-buffers)
5911     (funcall message-generate-new-buffers type to group))
5912    ((eq message-generate-new-buffers 'unsent)
5913     (generate-new-buffer-name
5914      (concat "*unsent " type
5915              (if to
5916                  (concat " to "
5917                          (or (car (mail-extract-address-components to))
5918                              to) "")
5919                "")
5920              (if (and group (not (string= group ""))) (concat " on " group) "")
5921              "*")))
5922    ;; Search for the existing message buffer with the specified name.
5923    (t
5924     (let* ((new (if (eq message-generate-new-buffers 'standard)
5925                     (generate-new-buffer-name (concat "*" type " message*"))
5926                   (let ((message-generate-new-buffers 'unique))
5927                     (message-buffer-name type to group))))
5928            (regexp (concat "\\`"
5929                            (regexp-quote
5930                             (if (string-match "<[0-9]+>\\'" new)
5931                                 (substring new 0 (match-beginning 0))
5932                               new))
5933                            "\\(?:<\\([0-9]+\\)>\\)?\\'"))
5934            (case-fold-search nil))
5935       (or (cdar
5936            (last
5937             (sort
5938              (delq nil
5939                    (mapcar
5940                     (lambda (b)
5941                       (when (and (string-match regexp (setq b (buffer-name b)))
5942                                  (eq (with-current-buffer b major-mode)
5943                                      'message-mode))
5944                         (cons (string-to-number (or (match-string 1 b) "1"))
5945                               b)))
5946                     (buffer-list)))
5947              'car-less-than-car)))
5948           new)))))
5949
5950 (defun message-pop-to-buffer (name &optional switch-function)
5951   "Pop to buffer NAME, and warn if it already exists and is modified."
5952   (let ((buffer (get-buffer name)))
5953     (if (and buffer
5954              (buffer-name buffer))
5955         (let ((window (get-buffer-window buffer 0)))
5956           (if window
5957               ;; Raise the frame already displaying the message buffer.
5958               (progn
5959                 (gnus-select-frame-set-input-focus (window-frame window))
5960                 (select-window window))
5961             (funcall (or switch-function 'pop-to-buffer) buffer)
5962             (set-buffer buffer))
5963           (when (and (buffer-modified-p)
5964                      (not (prog1
5965                               (y-or-n-p
5966                                "Message already being composed; erase? ")
5967                             (message nil))))
5968             (error "Message being composed")))
5969       (funcall (or switch-function 'pop-to-buffer) name)
5970       (set-buffer name))
5971     (erase-buffer)
5972     (message-mode)))
5973
5974 (defun message-do-send-housekeeping ()
5975   "Kill old message buffers."
5976   ;; We might have sent this buffer already.  Delete it from the
5977   ;; list of buffers.
5978   (setq message-buffer-list (delq (current-buffer) message-buffer-list))
5979   (while (and message-max-buffers
5980               message-buffer-list
5981               (>= (length message-buffer-list) message-max-buffers))
5982     ;; Kill the oldest buffer -- unless it has been changed.
5983     (let ((buffer (pop message-buffer-list)))
5984       (when (and (buffer-name buffer)
5985                  (not (buffer-modified-p buffer)))
5986         (kill-buffer buffer))))
5987   ;; Rename the buffer.
5988   (if message-send-rename-function
5989       (funcall message-send-rename-function)
5990     ;; Note: mail-abbrevs of XEmacs renames buffer name behind Gnus.
5991     (when (string-match
5992            "\\`\\*\\(sent \\|unsent \\)?\\(.+\\)\\*[^\\*]*\\|\\`mail to "
5993            (buffer-name))
5994       (let ((name (match-string 2 (buffer-name)))
5995             to group)
5996         (if (not (or (null name)
5997                      (string-equal name "mail")
5998                      (string-equal name "posting")))
5999             (setq name (concat "*sent " name "*"))
6000           (message-narrow-to-headers)
6001           (setq to (message-fetch-field "to"))
6002           (setq group (message-fetch-field "newsgroups"))
6003           (widen)
6004           (setq name
6005                 (cond
6006                  (to (concat "*sent mail to "
6007                              (or (car (mail-extract-address-components to))
6008                                  to) "*"))
6009                  ((and group (not (string= group "")))
6010                   (concat "*sent posting on " group "*"))
6011                  (t "*sent mail*"))))
6012         (unless (string-equal name (buffer-name))
6013           (rename-buffer name t)))))
6014   ;; Push the current buffer onto the list.
6015   (when message-max-buffers
6016     (setq message-buffer-list
6017           (nconc message-buffer-list (list (current-buffer))))))
6018
6019 (defun message-mail-user-agent ()
6020   (let ((mua (cond
6021               ((not message-mail-user-agent) nil)
6022               ((eq message-mail-user-agent t) mail-user-agent)
6023               (t message-mail-user-agent))))
6024     (if (memq mua '(message-user-agent gnus-user-agent))
6025         nil
6026       mua)))
6027
6028 (defun message-setup (headers &optional replybuffer actions
6029                               continue switch-function)
6030   (let ((mua (message-mail-user-agent))
6031         subject to field yank-action)
6032     (if (not (and message-this-is-mail mua))
6033         (message-setup-1 headers replybuffer actions)
6034       (if replybuffer
6035           (setq yank-action (list 'insert-buffer replybuffer)))
6036       (setq headers (copy-sequence headers))
6037       (setq field (assq 'Subject headers))
6038       (when field
6039         (setq subject (cdr field))
6040         (setq headers (delq field headers)))
6041       (setq field (assq 'To headers))
6042       (when field
6043         (setq to (cdr field))
6044         (setq headers (delq field headers)))
6045       (let ((mail-user-agent mua))
6046         (compose-mail to subject
6047                       (mapcar (lambda (item)
6048                                 (cons
6049                                  (format "%s" (car item))
6050                                  (cdr item)))
6051                               headers)
6052                       continue switch-function yank-action actions)))))
6053
6054 (defun message-headers-to-generate (headers included-headers excluded-headers)
6055   "Return a list that includes all headers from HEADERS.
6056 If INCLUDED-HEADERS is a list, just include those headers.  If it is
6057 t, include all headers.  In any case, headers from EXCLUDED-HEADERS
6058 are not included."
6059   (let ((result nil)
6060         header-name)
6061     (dolist (header headers)
6062       (setq header-name (cond
6063                          ((and (consp header)
6064                                (eq (car header) 'optional))
6065                           ;; On the form (optional . Header)
6066                           (cdr header))
6067                          ((consp header)
6068                           ;; On the form (Header . function)
6069                           (car header))
6070                          (t
6071                           ;; Just a Header.
6072                           header)))
6073       (when (and (not (memq header-name excluded-headers))
6074                  (or (eq included-headers t)
6075                      (memq header-name included-headers)))
6076         (push header result)))
6077     (nreverse result)))
6078
6079 (defun message-setup-1 (headers &optional replybuffer actions)
6080   (dolist (action actions)
6081     (condition-case nil
6082         (add-to-list 'message-send-actions
6083                      `(apply ',(car action) ',(cdr action)))))
6084   (setq message-reply-buffer replybuffer)
6085   (goto-char (point-min))
6086   ;; Insert all the headers.
6087   (mail-header-format
6088    (let ((h headers)
6089          (alist message-header-format-alist))
6090      (while h
6091        (unless (assq (caar h) message-header-format-alist)
6092          (push (list (caar h)) alist))
6093        (pop h))
6094      alist)
6095    headers)
6096   (delete-region (point) (progn (forward-line -1) (point)))
6097   (when message-default-headers
6098     (insert message-default-headers)
6099     (or (bolp) (insert ?\n)))
6100   (insert mail-header-separator "\n")
6101   (forward-line -1)
6102   (when (message-news-p)
6103     (when message-default-news-headers
6104       (insert message-default-news-headers)
6105       (or (bolp) (insert ?\n)))
6106     (when message-generate-headers-first
6107       (message-generate-headers
6108        (message-headers-to-generate
6109         (append message-required-news-headers
6110                 message-required-headers)
6111         message-generate-headers-first
6112         '(Lines Subject)))))
6113   (when (message-mail-p)
6114     (when message-default-mail-headers
6115       (insert message-default-mail-headers)
6116       (or (bolp) (insert ?\n)))
6117     (when message-generate-headers-first
6118       (message-generate-headers
6119        (message-headers-to-generate
6120         (append message-required-mail-headers
6121                 message-required-headers)
6122         message-generate-headers-first
6123         '(Lines Subject)))))
6124   (run-hooks 'message-signature-setup-hook)
6125   (message-insert-signature)
6126   (save-restriction
6127     (message-narrow-to-headers)
6128     (run-hooks 'message-header-setup-hook))
6129   (set-buffer-modified-p nil)
6130   (setq buffer-undo-list nil)
6131   (when message-generate-hashcash
6132     ;; Generate hashcash headers for recipients already known
6133     (mail-add-payment-async))
6134   (run-hooks 'message-setup-hook)
6135   ;; Do this last to give it precedence over posting styles, etc.
6136   (when (message-mail-p)
6137     (save-restriction
6138       (message-narrow-to-headers)
6139       (if message-alternative-emails
6140           (message-use-alternative-email-as-from))))
6141   (message-position-point)
6142   (undo-boundary))
6143
6144 (defun message-set-auto-save-file-name ()
6145   "Associate the message buffer with a file in the drafts directory."
6146   (when message-auto-save-directory
6147     (unless (file-directory-p
6148              (directory-file-name message-auto-save-directory))
6149       (make-directory message-auto-save-directory t))
6150     (if (gnus-alive-p)
6151         (setq message-draft-article
6152               (nndraft-request-associate-buffer "drafts"))
6153       (setq buffer-file-name (expand-file-name
6154                               (if (memq system-type
6155                                         '(ms-dos ms-windows windows-nt
6156                                                  cygwin cygwin32 win32 w32
6157                                                  mswindows))
6158                                   "message"
6159                                 "*message*")
6160                               message-auto-save-directory))
6161       (setq buffer-auto-save-file-name (make-auto-save-file-name)))
6162     (clear-visited-file-modtime)
6163     (setq buffer-file-coding-system message-draft-coding-system)))
6164
6165 (defun message-disassociate-draft ()
6166   "Disassociate the message buffer from the drafts directory."
6167   (when message-draft-article
6168     (nndraft-request-expire-articles
6169      (list message-draft-article) "drafts" nil t)))
6170
6171 (defun message-insert-headers ()
6172   "Generate the headers for the article."
6173   (interactive)
6174   (save-excursion
6175     (save-restriction
6176       (message-narrow-to-headers)
6177       (when (message-news-p)
6178         (message-generate-headers
6179          (delq 'Lines
6180                (delq 'Subject
6181                      (copy-sequence message-required-news-headers)))))
6182       (when (message-mail-p)
6183         (message-generate-headers
6184          (delq 'Lines
6185                (delq 'Subject
6186                      (copy-sequence message-required-mail-headers))))))))
6187
6188 \f
6189
6190 ;;;
6191 ;;; Commands for interfacing with message
6192 ;;;
6193
6194 ;;;###autoload
6195 (defun message-mail (&optional to subject
6196                                other-headers continue switch-function
6197                                yank-action send-actions)
6198   "Start editing a mail message to be sent.
6199 OTHER-HEADERS is an alist of header/value pairs.  CONTINUE says whether
6200 to continue editing a message already being composed.  SWITCH-FUNCTION
6201 is a function used to switch to and display the mail buffer."
6202   (interactive)
6203   (let ((message-this-is-mail t) replybuffer)
6204     (unless (message-mail-user-agent)
6205       (message-pop-to-buffer
6206        ;; Search for the existing message buffer if `continue' is non-nil.
6207        (let ((message-generate-new-buffers
6208               (when (or (not continue)
6209                         (eq message-generate-new-buffers 'standard)
6210                         (functionp message-generate-new-buffers))
6211                 message-generate-new-buffers)))
6212          (message-buffer-name "mail" to))
6213        switch-function))
6214     ;; FIXME: message-mail should do something if YANK-ACTION is not
6215     ;; insert-buffer.
6216     (and (consp yank-action) (eq (car yank-action) 'insert-buffer)
6217          (setq replybuffer (nth 1 yank-action)))
6218     (message-setup
6219      (nconc
6220       `((To . ,(or to "")) (Subject . ,(or subject "")))
6221       (when other-headers other-headers))
6222      replybuffer send-actions continue switch-function)
6223     ;; FIXME: Should return nil if failure.
6224     t))
6225
6226 ;;;###autoload
6227 (defun message-news (&optional newsgroups subject)
6228   "Start editing a news article to be sent."
6229   (interactive)
6230   (let ((message-this-is-news t))
6231     (message-pop-to-buffer (message-buffer-name "posting" nil newsgroups))
6232     (message-setup `((Newsgroups . ,(or newsgroups ""))
6233                      (Subject . ,(or subject ""))))))
6234
6235 (defun message-get-reply-headers (wide &optional to-address address-headers)
6236   (let (follow-to mct never-mct to cc author mft recipients extra)
6237   ;; Find all relevant headers we need.
6238     (save-restriction
6239       (message-narrow-to-headers-or-head)
6240       ;; Gmane renames "To".  Look at "Original-To", too, if it is present in
6241       ;; message-header-synonyms.
6242       (setq to (or (message-fetch-field "to")
6243                    (and (loop for synonym in message-header-synonyms
6244                               when (memq 'Original-To synonym)
6245                               return t)
6246                         (message-fetch-field "original-to")))
6247             cc (message-fetch-field "cc")
6248             extra (when message-extra-wide-headers
6249                     (mapconcat 'identity
6250                                (mapcar 'message-fetch-field
6251                                        message-extra-wide-headers)
6252                                ", "))
6253             mct (message-fetch-field "mail-copies-to")
6254             author (or (message-fetch-field "mail-reply-to")
6255                        (message-fetch-field "reply-to")
6256                        (message-fetch-field "from")
6257                        "")
6258             mft (and message-use-mail-followup-to
6259                      (message-fetch-field "mail-followup-to"))))
6260
6261     ;; Handle special values of Mail-Copies-To.
6262     (when mct
6263       (cond ((or (equal (downcase mct) "never")
6264                  (equal (downcase mct) "nobody"))
6265              (setq never-mct t)
6266              (setq mct nil))
6267             ((or (equal (downcase mct) "always")
6268                  (equal (downcase mct) "poster"))
6269              (setq mct author))))
6270
6271     (save-match-data
6272       ;; Build (textual) list of new recipient addresses.
6273       (cond
6274        ((not wide)
6275         (setq recipients (concat ", " author)))
6276        (address-headers
6277         (dolist (header address-headers)
6278           (let ((value (message-fetch-field header)))
6279             (when value
6280               (setq recipients (concat recipients ", " value))))))
6281        ((and mft
6282              (string-match "[^ \t,]" mft)
6283              (or (not (eq message-use-mail-followup-to 'ask))
6284                  (message-y-or-n-p "Obey Mail-Followup-To? " t "\
6285 You should normally obey the Mail-Followup-To: header.  In this
6286 article, it has the value of
6287
6288 " mft "
6289
6290 which directs your response to " (if (string-match "," mft)
6291                                      "the specified addresses"
6292                                    "that address only") ".
6293
6294 Most commonly, Mail-Followup-To is used by a mailing list poster to
6295 express that responses should be sent to just the list, and not the
6296 poster as well.
6297
6298 If a message is posted to several mailing lists, Mail-Followup-To may
6299 also be used to direct the following discussion to one list only,
6300 because discussions that are spread over several lists tend to be
6301 fragmented and very difficult to follow.
6302
6303 Also, some source/announcement lists are not intended for discussion;
6304 responses here are directed to other addresses.
6305
6306 You may customize the variable `message-use-mail-followup-to', if you
6307 want to get rid of this query permanently.")))
6308         (setq recipients (concat ", " mft)))
6309        (to-address
6310         (setq recipients (concat ", " to-address))
6311         ;; If the author explicitly asked for a copy, we don't deny it to them.
6312         (if mct (setq recipients (concat recipients ", " mct))))
6313        (t
6314         (setq recipients (if never-mct "" (concat ", " author)))
6315         (if to (setq recipients (concat recipients ", " to)))
6316         (if cc (setq recipients (concat recipients ", " cc)))
6317         (if extra (setq recipients (concat recipients ", " extra)))
6318         (if mct (setq recipients (concat recipients ", " mct)))))
6319       (if (>= (length recipients) 2)
6320           ;; Strip the leading ", ".
6321           (setq recipients (substring recipients 2)))
6322       ;; Squeeze whitespace.
6323       (while (string-match "[ \t][ \t]+" recipients)
6324         (setq recipients (replace-match " " t t recipients)))
6325       ;; Remove addresses that match `rmail-dont-reply-to-names'.
6326       (let ((rmail-dont-reply-to-names (message-dont-reply-to-names)))
6327         (setq recipients (rmail-dont-reply-to recipients)))
6328       ;; Perhaps "Mail-Copies-To: never" removed the only address?
6329       (if (string-equal recipients "")
6330           (setq recipients author))
6331       ;; Convert string to a list of (("foo@bar" . "Name <Foo@BAR>") ...).
6332       (setq recipients
6333             (mapcar
6334              (lambda (addr)
6335                (cons (downcase (mail-strip-quoted-names addr)) addr))
6336              (message-tokenize-header recipients)))
6337       ;; Remove first duplicates.  (Why not all duplicates?  Is this a bug?)
6338       (let ((s recipients))
6339         (while s
6340           (setq recipients (delq (assoc (car (pop s)) s) recipients))))
6341
6342       ;; Remove hierarchical lists that are contained within each other,
6343       ;; if message-hierarchical-addresses is defined.
6344       (when message-hierarchical-addresses
6345         (let ((plain-addrs (mapcar 'car recipients))
6346               subaddrs recip)
6347           (while plain-addrs
6348             (setq subaddrs (assoc (car plain-addrs)
6349                                   message-hierarchical-addresses)
6350                   plain-addrs (cdr plain-addrs))
6351             (when subaddrs
6352               (setq subaddrs (cdr subaddrs))
6353               (while subaddrs
6354                 (setq recip (assoc (car subaddrs) recipients)
6355                       subaddrs (cdr subaddrs))
6356                 (if recip
6357                     (setq recipients (delq recip recipients))))))))
6358
6359       ;; Build the header alist.  Allow the user to be asked whether
6360       ;; or not to reply to all recipients in a wide reply.
6361       (setq follow-to (list (cons 'To (cdr (pop recipients)))))
6362       (when (and recipients
6363                  (or (not message-wide-reply-confirm-recipients)
6364                      (y-or-n-p "Reply to all recipients? ")))
6365         (setq recipients (mapconcat
6366                           (lambda (addr) (cdr addr)) recipients ", "))
6367         (if (string-match "^ +" recipients)
6368             (setq recipients (substring recipients (match-end 0))))
6369         (push (cons 'Cc recipients) follow-to)))
6370     follow-to))
6371
6372 (defcustom message-simplify-subject-functions
6373   '(message-strip-list-identifiers
6374     message-strip-subject-re
6375     message-strip-subject-trailing-was
6376     message-strip-subject-encoded-words)
6377   "List of functions taking a string argument that simplify subjects.
6378 The functions are applied when replying to a message.
6379
6380 Useful functions to put in this list include:
6381 `message-strip-list-identifiers', `message-strip-subject-re',
6382 `message-strip-subject-trailing-was', and
6383 `message-strip-subject-encoded-words'."
6384   :version "22.1" ;; Gnus 5.10.9
6385   :group 'message-various
6386   :type '(repeat function))
6387
6388 (defun message-simplify-subject (subject &optional functions)
6389   "Return simplified SUBJECT."
6390   (unless functions
6391     ;; Simplify fully:
6392     (setq functions message-simplify-subject-functions))
6393   (when (and (memq 'message-strip-list-identifiers functions)
6394              gnus-list-identifiers)
6395     (setq subject (message-strip-list-identifiers subject)))
6396   (when (memq 'message-strip-subject-re functions)
6397     (setq subject (concat "Re: " (message-strip-subject-re subject))))
6398   (when (and (memq 'message-strip-subject-trailing-was functions)
6399              message-subject-trailing-was-query)
6400     (setq subject (message-strip-subject-trailing-was subject)))
6401   (when (memq 'message-strip-subject-encoded-words functions)
6402     (setq subject (message-strip-subject-encoded-words subject)))
6403   subject)
6404
6405 ;;;###autoload
6406 (defun message-reply (&optional to-address wide)
6407   "Start editing a reply to the article in the current buffer."
6408   (interactive)
6409   (require 'gnus-sum)                   ; for gnus-list-identifiers
6410   (let ((cur (current-buffer))
6411         from subject date reply-to to cc
6412         references message-id follow-to
6413         (inhibit-point-motion-hooks t)
6414         (message-this-is-mail t)
6415         gnus-warning)
6416     (save-restriction
6417       (message-narrow-to-head-1)
6418       ;; Allow customizations to have their say.
6419       (if (not wide)
6420           ;; This is a regular reply.
6421           (when (functionp message-reply-to-function)
6422             (save-excursion
6423               (setq follow-to (funcall message-reply-to-function))))
6424         ;; This is a followup.
6425         (when (functionp message-wide-reply-to-function)
6426           (save-excursion
6427             (setq follow-to
6428                   (funcall message-wide-reply-to-function)))))
6429       (setq message-id (message-fetch-field "message-id" t)
6430             references (message-fetch-field "references")
6431             date (message-fetch-field "date")
6432             from (or (message-fetch-field "from") "nobody")
6433             subject (or (message-fetch-field "subject") "none"))
6434
6435       ;; Strip list identifiers, "Re: ", and "was:"
6436       (setq subject (message-simplify-subject subject))
6437
6438       (when (and (setq gnus-warning (message-fetch-field "gnus-warning"))
6439                  (string-match "<[^>]+>" gnus-warning))
6440         (setq message-id (match-string 0 gnus-warning)))
6441
6442       (unless follow-to
6443         (setq follow-to (message-get-reply-headers wide to-address))))
6444
6445     (unless (message-mail-user-agent)
6446       (message-pop-to-buffer
6447        (message-buffer-name
6448         (if wide "wide reply" "reply") from
6449         (if wide to-address nil))))
6450
6451     (setq message-reply-headers
6452           (vector 0 subject from date message-id references 0 0 ""))
6453
6454     (message-setup
6455      `((Subject . ,subject)
6456        ,@follow-to)
6457      cur)))
6458
6459 ;;;###autoload
6460 (defun message-wide-reply (&optional to-address)
6461   "Make a \"wide\" reply to the message in the current buffer."
6462   (interactive)
6463   (message-reply to-address t))
6464
6465 ;;;###autoload
6466 (defun message-followup (&optional to-newsgroups)
6467   "Follow up to the message in the current buffer.
6468 If TO-NEWSGROUPS, use that as the new Newsgroups line."
6469   (interactive)
6470   (require 'gnus-sum)                   ; for gnus-list-identifiers
6471   (let ((cur (current-buffer))
6472         from subject date reply-to mrt mct
6473         references message-id follow-to
6474         (inhibit-point-motion-hooks t)
6475         (message-this-is-news t)
6476         followup-to distribution newsgroups gnus-warning posted-to)
6477     (save-restriction
6478       (narrow-to-region
6479        (goto-char (point-min))
6480        (if (search-forward "\n\n" nil t)
6481            (1- (point))
6482          (point-max)))
6483       (when (functionp message-followup-to-function)
6484         (setq follow-to
6485               (funcall message-followup-to-function)))
6486       (setq from (message-fetch-field "from")
6487             date (message-fetch-field "date")
6488             subject (or (message-fetch-field "subject") "none")
6489             references (message-fetch-field "references")
6490             message-id (message-fetch-field "message-id" t)
6491             followup-to (message-fetch-field "followup-to")
6492             newsgroups (message-fetch-field "newsgroups")
6493             posted-to (message-fetch-field "posted-to")
6494             reply-to (message-fetch-field "reply-to")
6495             mrt (message-fetch-field "mail-reply-to")
6496             distribution (message-fetch-field "distribution")
6497             mct (message-fetch-field "mail-copies-to"))
6498       (when (and (setq gnus-warning (message-fetch-field "gnus-warning"))
6499                  (string-match "<[^>]+>" gnus-warning))
6500         (setq message-id (match-string 0 gnus-warning)))
6501       ;; Remove bogus distribution.
6502       (when (and (stringp distribution)
6503                  (let ((case-fold-search t))
6504                    (string-match "world" distribution)))
6505         (setq distribution nil))
6506       ;; Strip list identifiers, "Re: ", and "was:"
6507       (setq subject (message-simplify-subject subject))
6508       (widen))
6509
6510     (message-pop-to-buffer (message-buffer-name "followup" from newsgroups))
6511
6512     (setq message-reply-headers
6513           (vector 0 subject from date message-id references 0 0 ""))
6514
6515     (message-setup
6516      `((Subject . ,subject)
6517        ,@(cond
6518           (to-newsgroups
6519            (list (cons 'Newsgroups to-newsgroups)))
6520           (follow-to follow-to)
6521           ((and followup-to message-use-followup-to)
6522            (list
6523             (cond
6524              ((equal (downcase followup-to) "poster")
6525               (if (or (eq message-use-followup-to 'use)
6526                       (message-y-or-n-p "Obey Followup-To: poster? " t "\
6527 You should normally obey the Followup-To: header.
6528
6529 `Followup-To: poster' sends your response via e-mail instead of news.
6530
6531 A typical situation where `Followup-To: poster' is used is when the poster
6532 does not read the newsgroup, so he wouldn't see any replies sent to it.
6533
6534 You may customize the variable `message-use-followup-to', if you
6535 want to get rid of this query permanently."))
6536                   (progn
6537                     (setq message-this-is-news nil)
6538                     (cons 'To (or mrt reply-to from "")))
6539                 (cons 'Newsgroups newsgroups)))
6540              (t
6541               (if (or (equal followup-to newsgroups)
6542                       (not (eq message-use-followup-to 'ask))
6543                       (message-y-or-n-p
6544                        (concat "Obey Followup-To: " followup-to "? ") t "\
6545 You should normally obey the Followup-To: header.
6546
6547         `Followup-To: " followup-to "'
6548 directs your response to " (if (string-match "," followup-to)
6549                                "the specified newsgroups"
6550                              "that newsgroup only") ".
6551
6552 If a message is posted to several newsgroups, Followup-To is often
6553 used to direct the following discussion to one newsgroup only,
6554 because discussions that are spread over several newsgroup tend to
6555 be fragmented and very difficult to follow.
6556
6557 Also, some source/announcement newsgroups are not intended for discussion;
6558 responses here are directed to other newsgroups.
6559
6560 You may customize the variable `message-use-followup-to', if you
6561 want to get rid of this query permanently."))
6562                   (cons 'Newsgroups followup-to)
6563                 (cons 'Newsgroups newsgroups))))))
6564           (posted-to
6565            `((Newsgroups . ,posted-to)))
6566           (t
6567            `((Newsgroups . ,newsgroups))))
6568        ,@(and distribution (list (cons 'Distribution distribution)))
6569        ,@(when (and mct
6570                     (not (or (equal (downcase mct) "never")
6571                              (equal (downcase mct) "nobody"))))
6572            (list (cons 'Cc (if (or (equal (downcase mct) "always")
6573                                    (equal (downcase mct) "poster"))
6574                                (or mrt reply-to from "")
6575                              mct)))))
6576
6577      cur)))
6578
6579 (defun message-is-yours-p ()
6580   "Non-nil means current article is yours.
6581 If you have added 'cancel-messages to `message-shoot-gnksa-feet', all articles
6582 are yours except those that have Cancel-Lock header not belonging to you.
6583 Instead of shooting GNKSA feet, you should modify `message-alternative-emails'
6584 regexp to match all of yours addresses."
6585   ;; Canlock-logic as suggested by Per Abrahamsen
6586   ;; <abraham@dina.kvl.dk>
6587   ;;
6588   ;; IF article has cancel-lock THEN
6589   ;;   IF we can verify it THEN
6590   ;;     issue cancel
6591   ;;   ELSE
6592   ;;     error: cancellock: article is not yours
6593   ;; ELSE
6594   ;;   Use old rules, comparing sender...
6595   (save-excursion
6596     (save-restriction
6597       (message-narrow-to-head-1)
6598       (if (message-fetch-field "Cancel-Lock")
6599           (if (null (canlock-verify))
6600               t
6601             (error "Failed to verify Cancel-lock: This article is not yours"))
6602         (let (sender from)
6603           (or
6604            (message-gnksa-enable-p 'cancel-messages)
6605            (and (setq sender (message-fetch-field "sender"))
6606                 (string-equal (downcase sender)
6607                               (downcase (message-make-sender))))
6608            ;; Email address in From field equals to our address
6609            (and (setq from (message-fetch-field "from"))
6610                 (string-equal
6611                  (downcase (car (mail-header-parse-address from)))
6612                  (downcase (car (mail-header-parse-address
6613                                  (message-make-from))))))
6614            ;; Email address in From field matches
6615            ;; 'message-alternative-emails' regexp
6616            (and from
6617                 message-alternative-emails
6618                 (string-match
6619                  message-alternative-emails
6620                  (car (mail-header-parse-address from))))))))))
6621
6622 ;;;###autoload
6623 (defun message-cancel-news (&optional arg)
6624   "Cancel an article you posted.
6625 If ARG, allow editing of the cancellation message."
6626   (interactive "P")
6627   (unless (message-news-p)
6628     (error "This is not a news article; canceling is impossible"))
6629   (let (from newsgroups message-id distribution buf)
6630     (save-excursion
6631       ;; Get header info from original article.
6632       (save-restriction
6633         (message-narrow-to-head-1)
6634         (setq from (message-fetch-field "from")
6635               newsgroups (message-fetch-field "newsgroups")
6636               message-id (message-fetch-field "message-id" t)
6637               distribution (message-fetch-field "distribution")))
6638       ;; Make sure that this article was written by the user.
6639       (unless (message-is-yours-p)
6640         (error "This article is not yours"))
6641       (when (yes-or-no-p "Do you really want to cancel this article? ")
6642         ;; Make control message.
6643         (if arg
6644             (message-news)
6645           (setq buf (set-buffer (get-buffer-create " *message cancel*"))))
6646         (erase-buffer)
6647         (insert "Newsgroups: " newsgroups "\n"
6648                 "From: " from "\n"
6649                 "Subject: cmsg cancel " message-id "\n"
6650                 "Control: cancel " message-id "\n"
6651                 (if distribution
6652                     (concat "Distribution: " distribution "\n")
6653                   "")
6654                 mail-header-separator "\n"
6655                 message-cancel-message)
6656         (run-hooks 'message-cancel-hook)
6657         (unless arg
6658           (message "Canceling your article...")
6659           (if (let ((message-syntax-checks
6660                      'dont-check-for-anything-just-trust-me))
6661                 (funcall message-send-news-function))
6662               (message "Canceling your article...done"))
6663           (kill-buffer buf))))))
6664
6665 ;;;###autoload
6666 (defun message-supersede ()
6667   "Start composing a message to supersede the current message.
6668 This is done simply by taking the old article and adding a Supersedes
6669 header line with the old Message-ID."
6670   (interactive)
6671   (let ((cur (current-buffer)))
6672     ;; Check whether the user owns the article that is to be superseded.
6673     (unless (message-is-yours-p)
6674       (error "This article is not yours"))
6675     ;; Get a normal message buffer.
6676     (message-pop-to-buffer (message-buffer-name "supersede"))
6677     (insert-buffer-substring cur)
6678     (mime-to-mml)
6679     (message-narrow-to-head-1)
6680     ;; Remove unwanted headers.
6681     (when message-ignored-supersedes-headers
6682       (message-remove-header message-ignored-supersedes-headers t))
6683     (goto-char (point-min))
6684     (if (not (re-search-forward "^Message-ID: " nil t))
6685         (error "No Message-ID in this article")
6686       (replace-match "Supersedes: " t t))
6687     (goto-char (point-max))
6688     (insert mail-header-separator)
6689     (widen)
6690     (forward-line 1)))
6691
6692 ;;;###autoload
6693 (defun message-recover ()
6694   "Reread contents of current buffer from its last auto-save file."
6695   (interactive)
6696   (let ((file-name (make-auto-save-file-name)))
6697     (cond ((save-window-excursion
6698              (if (not (eq system-type 'vax-vms))
6699                  (with-output-to-temp-buffer "*Directory*"
6700                    (with-current-buffer standard-output
6701                      (fundamental-mode)) ; for Emacs 20.4+
6702                    (buffer-disable-undo standard-output)
6703                    (let ((default-directory "/"))
6704                      (call-process
6705                       "ls" nil standard-output nil "-l" file-name))))
6706              (yes-or-no-p (format "Recover auto save file %s? " file-name)))
6707            (let ((buffer-read-only nil))
6708              (erase-buffer)
6709              (insert-file-contents file-name nil)))
6710           (t (error "message-recover cancelled")))))
6711
6712 ;;; Washing Subject:
6713
6714 (defun message-wash-subject (subject)
6715   "Remove junk like \"Re:\", \"(fwd)\", etc. added to subject string SUBJECT.
6716 Previous forwarders, replyers, etc. may add it."
6717   (with-temp-buffer
6718     (insert subject)
6719     (goto-char (point-min))
6720     ;; strip Re/Fwd stuff off the beginning
6721     (while (re-search-forward
6722             "\\([Rr][Ee]:\\|[Ff][Ww][Dd]\\(\\[[0-9]*\\]\\)?:\\|[Ff][Ww]:\\)" nil t)
6723       (replace-match ""))
6724
6725     ;; and gnus-style forwards [foo@bar.com] subject
6726     (goto-char (point-min))
6727     (while (re-search-forward "\\[[^ \t]*\\(@\\|\\.\\)[^ \t]*\\]" nil t)
6728       (replace-match ""))
6729
6730     ;; and off the end
6731     (goto-char (point-max))
6732     (while (re-search-backward "([Ff][Ww][Dd])" nil t)
6733       (replace-match ""))
6734
6735     ;; and finally, any whitespace that was left-over
6736     (goto-char (point-min))
6737     (while (re-search-forward "^[ \t]+" nil t)
6738       (replace-match ""))
6739     (goto-char (point-max))
6740     (while (re-search-backward "[ \t]+$" nil t)
6741       (replace-match ""))
6742
6743     (buffer-string)))
6744
6745 ;;; Forwarding messages.
6746
6747 (defvar message-forward-decoded-p nil
6748   "Non-nil means the original message is decoded.")
6749
6750 (defun message-forward-subject-name-subject (subject)
6751   "Generate a SUBJECT for a forwarded message.
6752 The form is: [Source] Subject, where if the original message was mail,
6753 Source is the name of the sender, and if the original message was
6754 news, Source is the list of newsgroups is was posted to."
6755   (let* ((group (message-fetch-field "newsgroups"))
6756          (from (message-fetch-field "from"))
6757          (prefix
6758           (if group
6759               (gnus-group-decoded-name group)
6760             (or (and from (or
6761                            (car (gnus-extract-address-components from))
6762                            (cadr (gnus-extract-address-components from))))
6763                 "(nowhere)"))))
6764     (concat "["
6765             (if message-forward-decoded-p
6766                 prefix
6767               (mail-decode-encoded-word-string prefix))
6768             "] " subject)))
6769
6770 (defun message-forward-subject-author-subject (subject)
6771   "Generate a SUBJECT for a forwarded message.
6772 The form is: [Source] Subject, where if the original message was mail,
6773 Source is the sender, and if the original message was news, Source is
6774 the list of newsgroups is was posted to."
6775   (let* ((group (message-fetch-field "newsgroups"))
6776          (prefix
6777           (if group
6778               (gnus-group-decoded-name group)
6779             (or (message-fetch-field "from")
6780                 "(nowhere)"))))
6781     (concat "["
6782             (if message-forward-decoded-p
6783                 prefix
6784               (mail-decode-encoded-word-string prefix))
6785             "] " subject)))
6786
6787 (defun message-forward-subject-fwd (subject)
6788   "Generate a SUBJECT for a forwarded message.
6789 The form is: Fwd: Subject, where Subject is the original subject of
6790 the message."
6791   (if (string-match "^Fwd: " subject)
6792       subject
6793     (concat "Fwd: " subject)))
6794
6795 (defun message-make-forward-subject ()
6796   "Return a Subject header suitable for the message in the current buffer."
6797   (save-excursion
6798     (save-restriction
6799       (message-narrow-to-head-1)
6800       (let ((funcs message-make-forward-subject-function)
6801             (subject (message-fetch-field "Subject")))
6802         (setq subject
6803               (if subject
6804                   (if message-forward-decoded-p
6805                       subject
6806                     (mail-decode-encoded-word-string subject))
6807                 ""))
6808         (when message-wash-forwarded-subjects
6809           (setq subject (message-wash-subject subject)))
6810         ;; Make sure funcs is a list.
6811         (and funcs
6812              (not (listp funcs))
6813              (setq funcs (list funcs)))
6814         ;; Apply funcs in order, passing subject generated by previous
6815         ;; func to the next one.
6816         (dolist (func funcs)
6817           (when (functionp func)
6818             (setq subject (funcall func subject))))
6819         subject))))
6820
6821 (eval-when-compile
6822   (defvar gnus-article-decoded-p))
6823
6824
6825 ;;;###autoload
6826 (defun message-forward (&optional news digest)
6827   "Forward the current message via mail.
6828 Optional NEWS will use news to forward instead of mail.
6829 Optional DIGEST will use digest to forward."
6830   (interactive "P")
6831   (let* ((cur (current-buffer))
6832          (message-forward-decoded-p
6833           (if (local-variable-p 'gnus-article-decoded-p (current-buffer))
6834               gnus-article-decoded-p ;; In an article buffer.
6835             message-forward-decoded-p))
6836          (subject (message-make-forward-subject)))
6837     (if news
6838         (message-news nil subject)
6839       (message-mail nil subject))
6840     (message-forward-make-body cur digest)))
6841
6842 (defun message-forward-make-body-plain (forward-buffer)
6843   (insert
6844    "\n-------------------- Start of forwarded message --------------------\n")
6845   (let ((b (point)) e)
6846     (insert
6847      (with-temp-buffer
6848        (mm-disable-multibyte)
6849        (insert
6850         (with-current-buffer forward-buffer
6851           (mm-with-unibyte-current-buffer (buffer-string))))
6852        (mm-enable-multibyte)
6853        (mime-to-mml)
6854        (goto-char (point-min))
6855        (when (looking-at "From ")
6856          (replace-match "X-From-Line: "))
6857        (buffer-string)))
6858     (setq e (point))
6859     (insert
6860      "\n-------------------- End of forwarded message --------------------\n")
6861     (message-remove-ignored-headers b e)))
6862
6863 (defun message-remove-ignored-headers (b e)
6864   (when message-forward-ignored-headers
6865     (save-restriction
6866       (narrow-to-region b e)
6867       (goto-char b)
6868       (narrow-to-region (point)
6869                         (or (search-forward "\n\n" nil t) (point)))
6870       (let ((ignored (if (stringp message-forward-ignored-headers)
6871                          (list message-forward-ignored-headers)
6872                        message-forward-ignored-headers)))
6873         (dolist (elem ignored)
6874           (message-remove-header elem t))))))
6875
6876 (defun message-forward-make-body-mime (forward-buffer)
6877   (let ((b (point)))
6878     (insert "\n\n<#part type=message/rfc822 disposition=inline raw=t>\n")
6879     (save-restriction
6880       (narrow-to-region (point) (point))
6881       (mml-insert-buffer forward-buffer)
6882       (goto-char (point-min))
6883       (when (looking-at "From ")
6884         (replace-match "X-From-Line: "))
6885       (goto-char (point-max)))
6886     (insert "<#/part>\n")
6887     ;; Consider there is no illegible text.
6888     (add-text-properties
6889      b (point)
6890      `(no-illegible-text t rear-nonsticky t start-open t))))
6891
6892 (defun message-forward-make-body-mml (forward-buffer)
6893   (insert "\n\n<#mml type=message/rfc822 disposition=inline>\n")
6894   (let ((b (point)) e)
6895     (if (not message-forward-decoded-p)
6896         (insert
6897          (with-temp-buffer
6898            (mm-disable-multibyte)
6899            (insert
6900             (with-current-buffer forward-buffer
6901               (mm-with-unibyte-current-buffer (buffer-string))))
6902            (mm-enable-multibyte)
6903            (mime-to-mml)
6904            (goto-char (point-min))
6905            (when (looking-at "From ")
6906              (replace-match "X-From-Line: "))
6907            (buffer-string)))
6908       (save-restriction
6909         (narrow-to-region (point) (point))
6910         (mml-insert-buffer forward-buffer)
6911         (goto-char (point-min))
6912         (when (looking-at "From ")
6913           (replace-match "X-From-Line: "))
6914         (goto-char (point-max))))
6915     (setq e (point))
6916     (insert "<#/mml>\n")
6917     (when (and (not message-forward-decoded-p)
6918                message-forward-ignored-headers)
6919       (message-remove-ignored-headers b e))))
6920
6921 (defun message-forward-make-body-digest-plain (forward-buffer)
6922   (insert
6923    "\n-------------------- Start of forwarded message --------------------\n")
6924   (let ((b (point)) e)
6925     (mml-insert-buffer forward-buffer)
6926     (setq e (point))
6927     (insert
6928      "\n-------------------- End of forwarded message --------------------\n")))
6929
6930 (defun message-forward-make-body-digest-mime (forward-buffer)
6931   (insert "\n<#multipart type=digest>\n")
6932   (let ((b (point)) e)
6933     (insert-buffer-substring forward-buffer)
6934     (setq e (point))
6935     (insert "<#/multipart>\n")
6936     (save-restriction
6937       (narrow-to-region b e)
6938       (goto-char b)
6939       (narrow-to-region (point)
6940                         (or (search-forward "\n\n" nil t) (point)))
6941       (delete-region (point-min) (point-max)))))
6942
6943 (defun message-forward-make-body-digest (forward-buffer)
6944   (if message-forward-as-mime
6945       (message-forward-make-body-digest-mime forward-buffer)
6946     (message-forward-make-body-digest-plain forward-buffer)))
6947
6948 (eval-and-compile
6949   (autoload 'mm-uu-dissect-text-parts "mm-uu")
6950   (autoload 'mm-uu-dissect "mm-uu"))
6951
6952 (defun message-signed-or-encrypted-p (&optional dont-emulate-mime handles)
6953   "Say whether the current buffer contains signed or encrypted message.
6954 If DONT-EMULATE-MIME is nil, this function does the MIME emulation on
6955 messages that don't conform to PGP/MIME described in RFC2015.  HANDLES
6956 is for the internal use."
6957   (unless handles
6958     (let ((mm-decrypt-option 'never)
6959           (mm-verify-option 'never))
6960       (if (setq handles (mm-dissect-buffer nil t))
6961           (unless dont-emulate-mime
6962             (mm-uu-dissect-text-parts handles))
6963         (unless dont-emulate-mime
6964           (setq handles (mm-uu-dissect))))))
6965   ;; Check text/plain message in which there is a signed or encrypted
6966   ;; body that has been encoded by B or Q.
6967   (unless (or handles dont-emulate-mime)
6968     (let ((cur (current-buffer))
6969           (mm-decrypt-option 'never)
6970           (mm-verify-option 'never))
6971       (with-temp-buffer
6972         (insert-buffer-substring cur)
6973         (when (setq handles (mm-dissect-buffer t t))
6974           (if (and (prog1
6975                        (bufferp (car handles))
6976                      (mm-destroy-parts handles))
6977                    (equal (mm-handle-media-type handles) "text/plain"))
6978               (progn
6979                 (mm-decode-content-transfer-encoding
6980                  (mm-handle-encoding handles))
6981                 (setq handles (mm-uu-dissect)))
6982             (setq handles nil))))))
6983   (when handles
6984     (prog1
6985         (catch 'found
6986           (dolist (handle (if (stringp (car handles))
6987                               (if (member (car handles)
6988                                           '("multipart/signed"
6989                                             "multipart/encrypted"))
6990                                   (throw 'found t)
6991                                 (cdr handles))
6992                             (list handles)))
6993             (if (stringp (car handle))
6994                 (when (message-signed-or-encrypted-p dont-emulate-mime handle)
6995                   (throw 'found t))
6996               (when (and (bufferp (car handle))
6997                          (equal (mm-handle-media-type handle)
6998                                 "message/rfc822"))
6999                 (with-current-buffer (mm-handle-buffer handle)
7000                   (when (message-signed-or-encrypted-p dont-emulate-mime)
7001                     (throw 'found t)))))))
7002       (mm-destroy-parts handles))))
7003
7004 ;;;###autoload
7005 (defun message-forward-make-body (forward-buffer &optional digest)
7006   ;; Put point where we want it before inserting the forwarded
7007   ;; message.
7008   (if message-forward-before-signature
7009       (message-goto-body)
7010     (goto-char (point-max)))
7011   (if digest
7012       (message-forward-make-body-digest forward-buffer)
7013     (if message-forward-as-mime
7014         (if (and message-forward-show-mml
7015                  (not (and (eq message-forward-show-mml 'best)
7016                            ;; Use the raw form in the body if it contains
7017                            ;; signed or encrypted message so as not to be
7018                            ;; destroyed by re-encoding.
7019                            (with-current-buffer forward-buffer
7020                              (condition-case nil
7021                                  (message-signed-or-encrypted-p)
7022                                (error t))))))
7023             (message-forward-make-body-mml forward-buffer)
7024           (message-forward-make-body-mime forward-buffer))
7025       (message-forward-make-body-plain forward-buffer)))
7026   (message-position-point))
7027
7028 ;;;###autoload
7029 (defun message-forward-rmail-make-body (forward-buffer)
7030   (save-window-excursion
7031     (set-buffer forward-buffer)
7032     (if (rmail-msg-is-pruned)
7033         (rmail-msg-restore-non-pruned-header)))
7034   (message-forward-make-body forward-buffer))
7035
7036 (eval-when-compile (defvar rmail-enable-mime-composing))
7037
7038 ;; Fixme: Should have defcustom.
7039 ;;;###autoload
7040 (defun message-insinuate-rmail ()
7041   "Let RMAIL use message to forward."
7042   (interactive)
7043   (setq rmail-enable-mime-composing t)
7044   (setq rmail-insert-mime-forwarded-message-function
7045         'message-forward-rmail-make-body))
7046
7047 ;;;###autoload
7048 (defun message-resend (address)
7049   "Resend the current article to ADDRESS."
7050   (interactive
7051    (list (message-read-from-minibuffer "Resend message to: ")))
7052   (message "Resending message to %s..." address)
7053   (save-excursion
7054     (let ((cur (current-buffer))
7055           beg)
7056       ;; We first set up a normal mail buffer.
7057       (unless (message-mail-user-agent)
7058         (set-buffer (get-buffer-create " *message resend*"))
7059         (erase-buffer))
7060       (let ((message-this-is-mail t)
7061             message-generate-hashcash
7062             message-setup-hook)
7063         (message-setup `((To . ,address))))
7064       ;; Insert our usual headers.
7065       (message-generate-headers '(From Date To Message-ID))
7066       (message-narrow-to-headers)
7067       ;; Remove X-Draft-From header etc.
7068       (message-remove-header message-ignored-mail-headers t)
7069       ;; Rename them all to "Resent-*".
7070       (goto-char (point-min))
7071       (while (re-search-forward "^[A-Za-z]" nil t)
7072         (forward-char -1)
7073         (insert "Resent-"))
7074       (widen)
7075       (forward-line)
7076       (delete-region (point) (point-max))
7077       (setq beg (point))
7078       ;; Insert the message to be resent.
7079       (insert-buffer-substring cur)
7080       (goto-char (point-min))
7081       (search-forward "\n\n")
7082       (forward-char -1)
7083       (save-restriction
7084         (narrow-to-region beg (point))
7085         (message-remove-header message-ignored-resent-headers t)
7086         (goto-char (point-max)))
7087       (insert mail-header-separator)
7088       ;; Rename all old ("Also-")Resent headers.
7089       (while (re-search-backward "^\\(Also-\\)*Resent-" beg t)
7090         (beginning-of-line)
7091         (insert "Also-"))
7092       ;; Quote any "From " lines at the beginning.
7093       (goto-char beg)
7094       (when (looking-at "From ")
7095         (replace-match "X-From-Line: "))
7096       ;; Send it.
7097       (let ((message-inhibit-body-encoding t)
7098             message-required-mail-headers
7099             message-generate-hashcash
7100             rfc2047-encode-encoded-words)
7101         (message-send-mail))
7102       (kill-buffer (current-buffer)))
7103     (message "Resending message to %s...done" address)))
7104
7105 ;;;###autoload
7106 (defun message-bounce ()
7107   "Re-mail the current message.
7108 This only makes sense if the current message is a bounce message that
7109 contains some mail you have written which has been bounced back to
7110 you."
7111   (interactive)
7112   (let ((handles (mm-dissect-buffer t))
7113         boundary)
7114     (message-pop-to-buffer (message-buffer-name "bounce"))
7115     (if (stringp (car handles))
7116         ;; This is a MIME bounce.
7117         (mm-insert-part (car (last handles)))
7118       ;; This is a non-MIME bounce, so we try to remove things
7119       ;; manually.
7120       (mm-insert-part handles)
7121       (undo-boundary)
7122       (goto-char (point-min))
7123       (re-search-forward "\n\n+" nil t)
7124       (setq boundary (point))
7125       ;; We remove everything before the bounced mail.
7126       (if (or (re-search-forward message-unsent-separator nil t)
7127               (progn
7128                 (search-forward "\n\n" nil 'move)
7129                 (re-search-backward "^Return-Path:.*\n" boundary t)))
7130           (progn
7131             (forward-line 1)
7132             (delete-region (point-min)
7133                            (if (re-search-forward "^[^ \n\t]+:" nil t)
7134                                (match-beginning 0)
7135                              (point))))
7136         (goto-char boundary)
7137         (when (re-search-backward "^.?From .*\n" nil t)
7138           (delete-region (match-beginning 0) (match-end 0)))))
7139     (mime-to-mml)
7140     (save-restriction
7141       (message-narrow-to-head-1)
7142       (message-remove-header message-ignored-bounced-headers t)
7143       (goto-char (point-max))
7144       (insert mail-header-separator))
7145     (message-position-point)))
7146
7147 ;;;
7148 ;;; Interactive entry points for new message buffers.
7149 ;;;
7150
7151 ;;;###autoload
7152 (defun message-mail-other-window (&optional to subject)
7153   "Like `message-mail' command, but display mail buffer in another window."
7154   (interactive)
7155   (unless (message-mail-user-agent)
7156     (let ((pop-up-windows t)
7157           (special-display-buffer-names nil)
7158           (special-display-regexps nil)
7159           (same-window-buffer-names nil)
7160           (same-window-regexps nil))
7161       (message-pop-to-buffer (message-buffer-name "mail" to))))
7162   (let ((message-this-is-mail t))
7163     (message-setup `((To . ,(or to "")) (Subject . ,(or subject "")))
7164                    nil nil nil 'switch-to-buffer-other-window)))
7165
7166 ;;;###autoload
7167 (defun message-mail-other-frame (&optional to subject)
7168   "Like `message-mail' command, but display mail buffer in another frame."
7169   (interactive)
7170   (unless (message-mail-user-agent)
7171     (let ((pop-up-frames t)
7172           (special-display-buffer-names nil)
7173           (special-display-regexps nil)
7174           (same-window-buffer-names nil)
7175           (same-window-regexps nil))
7176       (message-pop-to-buffer (message-buffer-name "mail" to))))
7177   (let ((message-this-is-mail t))
7178     (message-setup `((To . ,(or to "")) (Subject . ,(or subject "")))
7179                    nil nil nil 'switch-to-buffer-other-frame)))
7180
7181 ;;;###autoload
7182 (defun message-news-other-window (&optional newsgroups subject)
7183   "Start editing a news article to be sent."
7184   (interactive)
7185   (let ((pop-up-windows t)
7186         (special-display-buffer-names nil)
7187         (special-display-regexps nil)
7188         (same-window-buffer-names nil)
7189         (same-window-regexps nil))
7190     (message-pop-to-buffer (message-buffer-name "posting" nil newsgroups)))
7191   (let ((message-this-is-news t))
7192     (message-setup `((Newsgroups . ,(or newsgroups ""))
7193                      (Subject . ,(or subject ""))))))
7194
7195 ;;;###autoload
7196 (defun message-news-other-frame (&optional newsgroups subject)
7197   "Start editing a news article to be sent."
7198   (interactive)
7199   (let ((pop-up-frames t)
7200         (special-display-buffer-names nil)
7201         (special-display-regexps nil)
7202         (same-window-buffer-names nil)
7203         (same-window-regexps nil))
7204     (message-pop-to-buffer (message-buffer-name "posting" nil newsgroups)))
7205   (let ((message-this-is-news t))
7206     (message-setup `((Newsgroups . ,(or newsgroups ""))
7207                      (Subject . ,(or subject ""))))))
7208
7209 ;;; underline.el
7210
7211 ;; This code should be moved to underline.el (from which it is stolen).
7212
7213 ;;;###autoload
7214 (defun message-bold-region (start end)
7215   "Bold all nonblank characters in the region.
7216 Works by overstriking characters.
7217 Called from program, takes two arguments START and END
7218 which specify the range to operate on."
7219   (interactive "r")
7220   (save-excursion
7221     (let ((end1 (make-marker)))
7222       (move-marker end1 (max start end))
7223       (goto-char (min start end))
7224       (while (< (point) end1)
7225         (or (looking-at "[_\^@- ]")
7226             (insert (char-after) "\b"))
7227         (forward-char 1)))))
7228
7229 ;;;###autoload
7230 (defun message-unbold-region (start end)
7231   "Remove all boldness (overstruck characters) in the region.
7232 Called from program, takes two arguments START and END
7233 which specify the range to operate on."
7234   (interactive "r")
7235   (save-excursion
7236     (let ((end1 (make-marker)))
7237       (move-marker end1 (max start end))
7238       (goto-char (min start end))
7239       (while (search-forward "\b" end1 t)
7240         (if (eq (char-after) (char-after (- (point) 2)))
7241             (delete-char -2))))))
7242
7243 (defun message-exchange-point-and-mark ()
7244   "Exchange point and mark, but don't activate region if it was inactive."
7245   (unless (prog1
7246               (message-mark-active-p)
7247             (exchange-point-and-mark))
7248     (setq mark-active nil)))
7249
7250 (defalias 'message-make-overlay 'make-overlay)
7251 (defalias 'message-delete-overlay 'delete-overlay)
7252 (defalias 'message-overlay-put 'overlay-put)
7253 (defun message-kill-all-overlays ()
7254   (if (featurep 'xemacs)
7255       (map-extents (lambda (extent ignore) (delete-extent extent)))
7256     (mapcar #'delete-overlay (overlays-in (point-min) (point-max)))))
7257
7258 ;; Support for toolbar
7259 (eval-when-compile
7260   (defvar tool-bar-mode))
7261
7262 ;; Note: The :set function in the `message-tool-bar*' variables will only
7263 ;; affect _new_ message buffers.  We might add a function that walks thru all
7264 ;; message-mode buffers and force the update.
7265 (defun message-tool-bar-update (&optional symbol value)
7266   "Update message mode toolbar.
7267 Setter function for custom variables."
7268   (setq-default message-tool-bar-map nil)
7269   (when symbol
7270     ;; When used as ":set" function:
7271     (set-default symbol value)))
7272
7273 (defcustom message-tool-bar (if (eq gmm-tool-bar-style 'gnome)
7274                                 'message-tool-bar-gnome
7275                               'message-tool-bar-retro)
7276   "Specifies the message mode tool bar.
7277
7278 It can be either a list or a symbol refering to a list.  See
7279 `gmm-tool-bar-from-list' for the format of the list.  The
7280 default key map is `message-mode-map'.
7281
7282 Pre-defined symbols include `message-tool-bar-gnome' and
7283 `message-tool-bar-retro'."
7284   :type '(repeat gmm-tool-bar-list-item)
7285   :type '(choice (const :tag "GNOME style" message-tool-bar-gnome)
7286                  (const :tag "Retro look"  message-tool-bar-retro)
7287                  (repeat :tag "User defined list" gmm-tool-bar-item)
7288                  (symbol))
7289   :version "23.0" ;; No Gnus
7290   :initialize 'custom-initialize-default
7291   :set 'message-tool-bar-update
7292   :group 'message)
7293
7294 (defcustom message-tool-bar-gnome
7295   '((ispell-message "spell" nil
7296                     :visible (or (not (boundp 'flyspell-mode))
7297                                  (not flyspell-mode)))
7298     (flyspell-buffer "spell" t
7299                      :visible (and (boundp 'flyspell-mode)
7300                                    flyspell-mode)
7301                      :help "Flyspell whole buffer")
7302     (gmm-ignore "separator")
7303     (message-send-and-exit "mail/send")
7304     (message-dont-send "mail/save-draft")
7305     (message-kill-buffer "close") ;; stock_cancel
7306     (mml-attach-file "attach" mml-mode-map)
7307     (mml-preview "mail/preview" mml-mode-map)
7308     (mml-secure-message-sign-encrypt "lock" mml-mode-map :visible nil)
7309     (message-insert-importance-high "important" nil :visible nil)
7310     (message-insert-importance-low "unimportant" nil :visible nil)
7311     (message-insert-disposition-notification-to "receipt" nil :visible nil)
7312     (gmm-customize-mode "preferences" t :help "Edit mode preferences")
7313     (message-info "help" t :help "Message manual"))
7314   "List of items for the message tool bar (GNOME style).
7315
7316 See `gmm-tool-bar-from-list' for details on the format of the list."
7317   :type '(repeat gmm-tool-bar-item)
7318   :version "23.0" ;; No Gnus
7319   :initialize 'custom-initialize-default
7320   :set 'message-tool-bar-update
7321   :group 'message)
7322
7323 (defcustom message-tool-bar-retro
7324   '(;; Old Emacs 21 icon for consistency.
7325     (message-send-and-exit "gnus/mail_send")
7326     (message-kill-buffer "close")
7327     (message-dont-send "cancel")
7328     (mml-attach-file "attach" mml-mode-map)
7329     (ispell-message "spell")
7330     (mml-preview "preview" mml-mode-map)
7331     (message-insert-importance-high "gnus/important")
7332     (message-insert-importance-low "gnus/unimportant")
7333     (message-insert-disposition-notification-to "gnus/receipt"))
7334   "List of items for the message tool bar (retro style).
7335
7336 See `gmm-tool-bar-from-list' for details on the format of the list."
7337   :type '(repeat gmm-tool-bar-item)
7338   :version "23.0" ;; No Gnus
7339   :initialize 'custom-initialize-default
7340   :set 'message-tool-bar-update
7341   :group 'message)
7342
7343 (defcustom message-tool-bar-zap-list
7344   '(new-file open-file dired kill-buffer write-file
7345              print-buffer customize help)
7346   "List of icon items from the global tool bar.
7347 These items are not displayed on the message mode tool bar.
7348
7349 See `gmm-tool-bar-from-list' for the format of the list."
7350   :type 'gmm-tool-bar-zap-list
7351   :version "23.0" ;; No Gnus
7352   :initialize 'custom-initialize-default
7353   :set 'message-tool-bar-update
7354   :group 'message)
7355
7356 (defvar image-load-path)
7357
7358 (defun message-make-tool-bar (&optional force)
7359   "Make a message mode tool bar from `message-tool-bar-list'.
7360 When FORCE, rebuild the tool bar."
7361   (when (and (not (featurep 'xemacs))
7362              (boundp 'tool-bar-mode)
7363              tool-bar-mode
7364              (or (not message-tool-bar-map) force))
7365     (setq message-tool-bar-map
7366           (let* ((load-path
7367                   (gmm-image-load-path-for-library "message"
7368                                                    "mail/save-draft.xpm"
7369                                                    nil t))
7370                  (image-load-path (cons (car load-path)
7371                                         (when (boundp 'image-load-path)
7372                                           image-load-path))))
7373             (gmm-tool-bar-from-list message-tool-bar
7374                                     message-tool-bar-zap-list
7375                                     'message-mode-map))))
7376   message-tool-bar-map)
7377
7378 ;;; Group name completion.
7379
7380 (defcustom message-newgroups-header-regexp
7381   "^\\(Newsgroups\\|Followup-To\\|Posted-To\\|Gcc\\):"
7382   "Regexp that match headers that lists groups."
7383   :group 'message
7384   :type 'regexp)
7385
7386 (defcustom message-completion-alist
7387   (list (cons message-newgroups-header-regexp 'message-expand-group)
7388         '("^\\(Resent-\\)?\\(To\\|B?Cc\\):" . message-expand-name)
7389         '("^\\(Reply-To\\|From\\|Mail-Followup-To\\|Mail-Copies-To\\):"
7390           . message-expand-name)
7391         '("^\\(Disposition-Notification-To\\|Return-Receipt-To\\):"
7392           . message-expand-name))
7393   "Alist of (RE . FUN).  Use FUN for completion on header lines matching RE."
7394   :version "22.1"
7395   :group 'message
7396   :type '(alist :key-type regexp :value-type function))
7397
7398 (defcustom message-expand-name-databases
7399   (list 'bbdb 'eudc)
7400   "List of databases to try for name completion (`message-expand-name').
7401 Each element is a symbol and can be `bbdb' or `eudc'."
7402   :group 'message
7403   :type '(set (const bbdb) (const eudc)))
7404
7405 (defcustom message-tab-body-function nil
7406   "*Function to execute when `message-tab' (TAB) is executed in the body.
7407 If nil, the function bound in `text-mode-map' or `global-map' is executed."
7408   :version "22.1"
7409   :group 'message
7410   :link '(custom-manual "(message)Various Commands")
7411   :type '(choice (const nil)
7412                  function))
7413
7414 (defun message-tab ()
7415   "Complete names according to `message-completion-alist'.
7416 Execute function specified by `message-tab-body-function' when not in
7417 those headers."
7418   (interactive)
7419   (let ((alist message-completion-alist))
7420     (while (and alist
7421                 (let ((mail-abbrev-mode-regexp (caar alist)))
7422                   (not (mail-abbrev-in-expansion-header-p))))
7423       (setq alist (cdr alist)))
7424     (funcall (or (cdar alist) message-tab-body-function
7425                  (lookup-key text-mode-map "\t")
7426                  (lookup-key global-map "\t")
7427                  'indent-relative))))
7428
7429 (eval-and-compile
7430   (condition-case nil
7431       (with-temp-buffer
7432         (let ((standard-output (current-buffer)))
7433           (eval '(display-completion-list nil "")))
7434         (defalias 'message-display-completion-list 'display-completion-list))
7435     (error ;; Don't use `wrong-number-of-arguments' here because of XEmacs.
7436      (defun message-display-completion-list (completions &optional ignore)
7437        "Display the list of completions, COMPLETIONS, using `standard-output'."
7438        (display-completion-list completions)))))
7439
7440 (defun message-expand-group ()
7441   "Expand the group name under point."
7442   (let* ((b (save-excursion
7443               (save-restriction
7444                 (narrow-to-region
7445                  (save-excursion
7446                    (beginning-of-line)
7447                    (skip-chars-forward "^:")
7448                    (1+ (point)))
7449                  (point))
7450                 (skip-chars-backward "^, \t\n") (point))))
7451          (completion-ignore-case t)
7452          (string (buffer-substring b (progn (skip-chars-forward "^,\t\n ")
7453                                             (point))))
7454          (hashtb (and (boundp 'gnus-active-hashtb) gnus-active-hashtb))
7455          (completions (all-completions string hashtb))
7456          comp)
7457     (delete-region b (point))
7458     (cond
7459      ((= (length completions) 1)
7460       (if (string= (car completions) string)
7461           (progn
7462             (insert string)
7463             (message "Only matching group"))
7464         (insert (car completions))))
7465      ((and (setq comp (try-completion string hashtb))
7466            (not (string= comp string)))
7467       (insert comp))
7468      (t
7469       (insert string)
7470       (if (not comp)
7471           (message "No matching groups")
7472         (save-selected-window
7473           (pop-to-buffer "*Completions*")
7474           (buffer-disable-undo)
7475           (let ((buffer-read-only nil))
7476             (erase-buffer)
7477             (let ((standard-output (current-buffer)))
7478               (message-display-completion-list (sort completions 'string<)
7479                                                string))
7480             (setq buffer-read-only nil)
7481             (goto-char (point-min))
7482             (delete-region (point) (progn (forward-line 3) (point))))))))))
7483
7484 (defun message-expand-name ()
7485   (cond ((and (memq 'eudc message-expand-name-databases)
7486                     (boundp 'eudc-protocol)
7487                     eudc-protocol)
7488          (eudc-expand-inline))
7489         ((and (memq 'bbdb message-expand-name-databases)
7490               (fboundp 'bbdb-complete-name))
7491          (bbdb-complete-name))
7492         (t
7493          (expand-abbrev))))
7494
7495 ;;; Help stuff.
7496
7497 (defun message-talkative-question (ask question show &rest text)
7498   "Call FUNCTION with argument QUESTION; optionally display TEXT... args.
7499 If SHOW is non-nil, the arguments TEXT... are displayed in a temp buffer.
7500 The following arguments may contain lists of values."
7501   (if (and show
7502            (setq text (message-flatten-list text)))
7503       (save-window-excursion
7504         (save-excursion
7505           (with-output-to-temp-buffer " *MESSAGE information message*"
7506             (set-buffer " *MESSAGE information message*")
7507             (fundamental-mode)          ; for Emacs 20.4+
7508             (mapc 'princ text)
7509             (goto-char (point-min))))
7510         (funcall ask question))
7511     (funcall ask question)))
7512
7513 (defun message-flatten-list (list)
7514   "Return a new, flat list that contains all elements of LIST.
7515
7516 \(message-flatten-list '(1 (2 3 (4 5 (6))) 7))
7517 => (1 2 3 4 5 6 7)"
7518   (cond ((consp list)
7519          (apply 'append (mapcar 'message-flatten-list list)))
7520         (list
7521          (list list))))
7522
7523 (defun message-generate-new-buffer-clone-locals (name &optional varstr)
7524   "Create and return a buffer with name based on NAME using `generate-new-buffer'.
7525 Then clone the local variables and values from the old buffer to the
7526 new one, cloning only the locals having a substring matching the
7527 regexp VARSTR."
7528   (let ((oldbuf (current-buffer)))
7529     (save-excursion
7530       (set-buffer (generate-new-buffer name))
7531       (message-clone-locals oldbuf varstr)
7532       (current-buffer))))
7533
7534 (defun message-clone-locals (buffer &optional varstr)
7535   "Clone the local variables from BUFFER to the current buffer."
7536   (let ((locals (save-excursion
7537                   (set-buffer buffer)
7538                   (buffer-local-variables)))
7539         (regexp "^gnus\\|^nn\\|^message\\|^sendmail\\|^smtp\\|^user-mail-address"))
7540     (mapcar
7541      (lambda (local)
7542        (when (and (consp local)
7543                   (car local)
7544                   (string-match regexp (symbol-name (car local)))
7545                   (or (null varstr)
7546                       (string-match varstr (symbol-name (car local)))))
7547          (ignore-errors
7548            (set (make-local-variable (car local))
7549                 (cdr local)))))
7550      locals)))
7551
7552 ;;;
7553 ;;; MIME functions
7554 ;;;
7555
7556 (defvar message-inhibit-body-encoding nil)
7557
7558 (defun message-encode-message-body ()
7559   (unless message-inhibit-body-encoding
7560     (let ((mail-parse-charset (or mail-parse-charset
7561                                   message-default-charset))
7562           (case-fold-search t)
7563           lines content-type-p)
7564       (message-goto-body)
7565       (save-restriction
7566         (narrow-to-region (point) (point-max))
7567         (let ((new (mml-generate-mime)))
7568           (when new
7569             (delete-region (point-min) (point-max))
7570             (insert new)
7571             (goto-char (point-min))
7572             (if (eq (aref new 0) ?\n)
7573                 (delete-char 1)
7574               (search-forward "\n\n")
7575               (setq lines (buffer-substring (point-min) (1- (point))))
7576               (delete-region (point-min) (point))))))
7577       (save-restriction
7578         (message-narrow-to-headers-or-head)
7579         (message-remove-header "Mime-Version")
7580         (goto-char (point-max))
7581         (insert "MIME-Version: 1.0\n")
7582         (when lines
7583           (insert lines))
7584         (setq content-type-p
7585               (or mml-boundary
7586                   (re-search-backward "^Content-Type:" nil t))))
7587       (save-restriction
7588         (message-narrow-to-headers-or-head)
7589         (message-remove-first-header "Content-Type")
7590         (message-remove-first-header "Content-Transfer-Encoding"))
7591       ;; We always make sure that the message has a Content-Type
7592       ;; header.  This is because some broken MTAs and MUAs get
7593       ;; awfully confused when confronted with a message with a
7594       ;; MIME-Version header and without a Content-Type header.  For
7595       ;; instance, Solaris' /usr/bin/mail.
7596       (unless content-type-p
7597         (goto-char (point-min))
7598         ;; For unknown reason, MIME-Version doesn't exist.
7599         (when (re-search-forward "^MIME-Version:" nil t)
7600           (forward-line 1)
7601           (insert "Content-Type: text/plain; charset=us-ascii\n"))))))
7602
7603 (defun message-read-from-minibuffer (prompt &optional initial-contents)
7604   "Read from the minibuffer while providing abbrev expansion."
7605   (if (fboundp 'mail-abbrevs-setup)
7606       (let ((mail-abbrev-mode-regexp "")
7607             (minibuffer-setup-hook 'mail-abbrevs-setup)
7608             (minibuffer-local-map message-minibuffer-local-map))
7609         (read-from-minibuffer prompt initial-contents))
7610     (let ((minibuffer-setup-hook 'mail-abbrev-minibuffer-setup-hook)
7611           (minibuffer-local-map message-minibuffer-local-map))
7612       (read-string prompt initial-contents))))
7613
7614 (defun message-use-alternative-email-as-from ()
7615   "Set From field of the outgoing message to the first matching
7616 address in `message-alternative-emails', looking at To, Cc and
7617 From headers in the original article."
7618   (require 'mail-utils)
7619   (let* ((fields '("To" "Cc" "From"))
7620          (emails
7621           (split-string
7622            (mail-strip-quoted-names
7623             (mapconcat 'message-fetch-reply-field fields ","))
7624            "[ \f\t\n\r\v,]+"))
7625          email)
7626     (while emails
7627       (if (string-match message-alternative-emails (car emails))
7628           (setq email (car emails)
7629                 emails nil))
7630       (pop emails))
7631     (unless (or (not email) (equal email user-mail-address))
7632       (message-remove-header "From")
7633       (goto-char (point-max))
7634       (insert "From: " (let ((user-mail-address email)) (message-make-from))
7635               "\n"))))
7636
7637 (defun message-options-get (symbol)
7638   (cdr (assq symbol message-options)))
7639
7640 (defun message-options-set (symbol value)
7641   (let ((the-cons (assq symbol message-options)))
7642     (if the-cons
7643         (if value
7644             (setcdr the-cons value)
7645           (setq message-options (delq the-cons message-options)))
7646       (and value
7647            (push (cons symbol value) message-options))))
7648   value)
7649
7650 (defun message-options-set-recipient ()
7651   (save-restriction
7652     (message-narrow-to-headers-or-head)
7653     (message-options-set 'message-sender
7654                          (mail-strip-quoted-names
7655                           (message-fetch-field "from")))
7656     (message-options-set 'message-recipients
7657                          (mail-strip-quoted-names
7658                           (let ((to (message-fetch-field "to"))
7659                                 (cc (message-fetch-field "cc"))
7660                                 (bcc (message-fetch-field "bcc")))
7661                             (concat
7662                              (or to "")
7663                              (if (and to cc) ", ")
7664                              (or cc "")
7665                              (if (and (or to cc) bcc) ", ")
7666                              (or bcc "")))))))
7667
7668 (defun message-hide-headers ()
7669   "Hide headers based on the `message-hidden-headers' variable."
7670   (let ((regexps (if (stringp message-hidden-headers)
7671                      (list message-hidden-headers)
7672                    message-hidden-headers))
7673         (inhibit-point-motion-hooks t)
7674         (after-change-functions nil)
7675         (end-of-headers 0))
7676     (when regexps
7677       (save-excursion
7678         (save-restriction
7679           (message-narrow-to-headers)
7680           (goto-char (point-min))
7681           (while (not (eobp))
7682             (if (not (message-hide-header-p regexps))
7683                 (message-next-header)
7684               (let ((begin (point))
7685                     header header-len)
7686                 (message-next-header)
7687                 (setq header (buffer-substring begin (point))
7688                       header-len (- (point) begin))
7689                 (delete-region begin (point))
7690                 (goto-char (1+ end-of-headers))
7691                 (insert header)
7692                 (setq end-of-headers
7693                       (+ end-of-headers header-len))))))))
7694     (narrow-to-region (1+ end-of-headers) (point-max))))
7695
7696 (defun message-hide-header-p (regexps)
7697   (let ((result nil)
7698         (reverse nil))
7699     (when (eq (car regexps) 'not)
7700       (setq reverse t)
7701       (pop regexps))
7702     (dolist (regexp regexps)
7703       (setq result (or result (looking-at regexp))))
7704     (if reverse
7705         (not result)
7706       result)))
7707
7708 (defun message-put-addresses-in-ecomplete ()
7709   (dolist (header '("to" "cc" "from" "reply-to"))
7710     (let ((value (message-field-value header)))
7711       (dolist (string (mail-header-parse-addresses value 'raw))
7712         (setq string
7713               (gnus-replace-in-string
7714                (gnus-replace-in-string string "^ +\\| +$" "") "\n" ""))
7715         (ecomplete-add-item 'mail (car (mail-header-parse-address string))
7716                             string))))
7717   (ecomplete-save))
7718
7719 (defun message-display-abbrev (&optional choose)
7720   "Display the next possible abbrev for the text before point."
7721   (interactive (list t))
7722   (when (and (memq (char-after (point-at-bol)) '(?C ?T ?\t ? ))
7723              (message-point-in-header-p)
7724              (save-excursion
7725                (beginning-of-line)
7726                (while (and (memq (char-after) '(?\t ? ))
7727                            (zerop (forward-line -1))))
7728                (looking-at "To:\\|Cc:")))
7729     (let* ((end (point))
7730            (start (save-excursion
7731                     (and (re-search-backward "[\n\t ]" nil t)
7732                          (1+ (point)))))
7733            (word (when start (buffer-substring start end)))
7734            (match (when (and word
7735                              (not (zerop (length word))))
7736                     (ecomplete-display-matches 'mail word choose))))
7737       (when (and choose match)
7738         (delete-region start end)
7739         (insert match)))))
7740
7741 (when (featurep 'xemacs)
7742   (require 'messagexmas)
7743   (message-xmas-redefine))
7744
7745 (provide 'message)
7746
7747 (run-hooks 'message-load-hook)
7748
7749 ;; Local Variables:
7750 ;; coding: iso-8859-1
7751 ;; End:
7752
7753 ;; arch-tag: 94b32cac-4504-4b6c-8181-030ebf380ee0
7754 ;;; message.el ends here