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