message: fix indent citation
[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 diffference: 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     (beginning-of-line)
3727     (while (and (looking-at "$")
3728                 (zerop (forward-line -1)))
3729       (message-delete-line)))
3730   ;; Do the indentation.
3731   (if (null message-yank-prefix)
3732       (indent-rigidly start (or end (mark t)) message-indentation-spaces)
3733     (save-excursion
3734       (goto-char start)
3735       (while (< (point) (or end (mark t)))
3736         (cond ((looking-at ">")
3737                (insert message-yank-cited-prefix))
3738               ((looking-at "^$")
3739                (insert message-yank-empty-prefix))
3740               (t
3741                (insert message-yank-prefix)))
3742         (forward-line 1))))
3743   (goto-char start))
3744
3745 (defun message-remove-blank-cited-lines (&optional remove)
3746   "Remove cited lines containing only blanks.
3747 If REMOVE is non-nil, remove newlines, too.
3748
3749 To use this automatically, you may add this function to
3750 `gnus-message-setup-hook'."
3751   (interactive "P")
3752   (let ((citexp
3753          (concat
3754           "^\\("
3755           (when (boundp 'message-yank-cited-prefix)
3756             (concat message-yank-cited-prefix "\\|"))
3757           message-yank-prefix
3758           "\\)+ *\n"
3759           )))
3760     (gnus-message 8 "removing `%s'" citexp)
3761     (save-excursion
3762       (message-goto-body)
3763       (while (re-search-forward citexp nil t)
3764         (replace-match (if remove "" "\n"))))))
3765
3766 (defun message--yank-original-internal (arg)
3767   (let ((modified (buffer-modified-p))
3768         body-text)
3769         (when (and message-reply-buffer
3770                    message-cite-function)
3771           (when (equal message-cite-reply-position 'above)
3772             (save-excursion
3773               (setq body-text
3774                     (buffer-substring (message-goto-body)
3775                                       (point-max)))
3776               (delete-region (message-goto-body) (point-max))))
3777           (if (bufferp message-reply-buffer)
3778               (delete-windows-on message-reply-buffer t))
3779           (push-mark (save-excursion
3780                        (cond
3781                         ((bufferp message-reply-buffer)
3782                          (insert-buffer-substring message-reply-buffer))
3783                         ((and (consp message-reply-buffer)
3784                               (functionp (car message-reply-buffer)))
3785                          (apply (car message-reply-buffer)
3786                                 (cdr message-reply-buffer))))
3787                        (unless (bolp)
3788                          (insert ?\n))
3789                        (point)))
3790           (unless arg
3791             (funcall message-cite-function)
3792             (unless (eq (char-before (mark t)) ?\n)
3793               (let ((pt (point)))
3794                 (goto-char (mark t))
3795                 (insert-before-markers ?\n)
3796                 (goto-char pt))))
3797           (case message-cite-reply-position
3798             (above
3799              (message-goto-body)
3800              (insert body-text)
3801              (insert (if (bolp) "\n" "\n\n"))
3802              (message-goto-body))
3803             (below
3804              (message-goto-signature)))
3805           ;; Add a `message-setup-very-last-hook' here?
3806           ;; Add `gnus-article-highlight-citation' here?
3807           (unless modified
3808         (setq message-checksum (message-checksum))))))
3809
3810 (defun message-yank-original (&optional arg)
3811   "Insert the message being replied to, if any.
3812 Puts point before the text and mark after.
3813 Normally indents each nonblank line ARG spaces (default 3).  However,
3814 if `message-yank-prefix' is non-nil, insert that prefix on each line.
3815
3816 This function uses `message-cite-function' to do the actual citing.
3817
3818 Just \\[universal-argument] as argument means don't indent, insert no
3819 prefix, and don't delete any headers."
3820   (interactive "P")
3821   ;; eval the let forms contained in message-cite-style
3822   (eval
3823    `(let ,message-cite-style
3824       (message--yank-original-internal ',arg))))
3825
3826 (defun message-yank-buffer (buffer)
3827   "Insert BUFFER into the current buffer and quote it."
3828   (interactive "bYank buffer: ")
3829   (let ((message-reply-buffer (get-buffer buffer)))
3830     (save-window-excursion
3831       (message-yank-original))))
3832
3833 (defun message-buffers ()
3834   "Return a list of active message buffers."
3835   (let (buffers)
3836     (save-current-buffer
3837       (dolist (buffer (buffer-list t))
3838         (set-buffer buffer)
3839         (when (and (eq major-mode 'message-mode)
3840                    (null message-sent-message-via))
3841           (push (buffer-name buffer) buffers))))
3842     (nreverse buffers)))
3843
3844 (defun message-cite-original-1 (strip-signature)
3845   "Cite an original message.
3846 If STRIP-SIGNATURE is non-nil, strips off the signature from the
3847 original message.
3848
3849 This function uses `mail-citation-hook' if that is non-nil."
3850   (if (and (boundp 'mail-citation-hook)
3851            mail-citation-hook)
3852       (run-hooks 'mail-citation-hook)
3853     (let* ((start (point))
3854            (end (mark t))
3855            (x-no-archive nil)
3856            (functions
3857             (when message-indent-citation-function
3858               (if (listp message-indent-citation-function)
3859                   message-indent-citation-function
3860                 (list message-indent-citation-function))))
3861            ;; This function may be called by `gnus-summary-yank-message' and
3862            ;; may insert a different article from the original.  So, we will
3863            ;; modify the value of `message-reply-headers' with that article.
3864            (message-reply-headers
3865             (save-restriction
3866               (narrow-to-region start end)
3867               (message-narrow-to-head-1)
3868               (setq x-no-archive (message-fetch-field "x-no-archive"))
3869               (vector 0
3870                       (or (message-fetch-field "subject") "none")
3871                       (or (message-fetch-field "from") "nobody")
3872                       (message-fetch-field "date")
3873                       (message-fetch-field "message-id" t)
3874                       (message-fetch-field "references")
3875                       0 0 ""))))
3876       (mml-quote-region start end)
3877       (when strip-signature
3878         ;; Allow undoing.
3879         (undo-boundary)
3880         (goto-char end)
3881         (when (re-search-backward message-signature-separator start t)
3882           ;; Also peel off any blank lines before the signature.
3883           (forward-line -1)
3884           (while (looking-at "^[ \t]*$")
3885             (forward-line -1))
3886           (forward-line 1)
3887           (delete-region (point) end)
3888           (unless (search-backward "\n\n" start t)
3889             ;; Insert a blank line if it is peeled off.
3890             (insert "\n"))))
3891       (goto-char start)
3892       (mapc 'funcall functions)
3893       (when message-citation-line-function
3894         (unless (bolp)
3895           (insert "\n"))
3896         (funcall message-citation-line-function))
3897       (when (and x-no-archive
3898                  (not message-cite-articles-with-x-no-archive)
3899                  (string-match "yes" x-no-archive))
3900         (undo-boundary)
3901         (delete-region (point) (mark t))
3902         (insert "> [Quoted text removed due to X-No-Archive]\n")
3903         (push-mark)
3904         (forward-line -1)))))
3905
3906 (defun message-cite-original ()
3907   "Cite function in the standard Message manner."
3908   (message-cite-original-1 nil))
3909
3910 (defvar gnus-extract-address-components)
3911
3912 (autoload 'format-spec "format-spec")
3913
3914 (defun message-insert-formatted-citation-line (&optional from date)
3915   "Function that inserts a formatted citation line.
3916
3917 See `message-citation-line-format'."
3918   ;; The optional args are for testing/debugging.  They will disappear later.
3919   ;; Example:
3920   ;; (with-temp-buffer
3921   ;;   (message-insert-formatted-citation-line
3922   ;;    "John Doe <john.doe@example.invalid>"
3923   ;;    (current-time))
3924   ;;   (buffer-string))
3925   (when (or message-reply-headers (and from date))
3926     (unless from
3927       (setq from (mail-header-from message-reply-headers)))
3928     (let* ((data (condition-case ()
3929                      (funcall (if (boundp gnus-extract-address-components)
3930                                   gnus-extract-address-components
3931                                 'mail-extract-address-components)
3932                               from)
3933                    (error nil)))
3934            (name (car data))
3935            (fname name)
3936            (lname name)
3937            (net (car (cdr data)))
3938            (name-or-net (or (car data)
3939                             (car (cdr data)) from))
3940            (replydate
3941             (or
3942              date
3943              ;; We need Gnus functionality if the user wants date or time from
3944              ;; the original article:
3945              (when (string-match "%[^fnNFL]" message-citation-line-format)
3946                (autoload 'gnus-date-get-time "gnus-util")
3947                (gnus-date-get-time (mail-header-date message-reply-headers)))))
3948            (flist
3949             (let ((i ?A) lst)
3950               (when (stringp name)
3951                 ;; Guess first name and last name:
3952                 (cond ((string-match
3953                         "\\`\\(\\w\\|[-.]\\)+ \\(\\w\\|[-.]\\)+\\'" name)
3954                        (setq fname (nth 0 (split-string name "[ \t]+"))
3955                              lname (nth 1 (split-string name "[ \t]+"))))
3956                       ((string-match
3957                         "\\`\\(\\w\\|[-.]\\)+, \\(\\w\\|[-.]\\)+\\'" name)
3958                        (setq fname (nth 1 (split-string name "[ \t,]+"))
3959                              lname (nth 0 (split-string name "[ \t,]+"))))
3960                       ((string-match
3961                         "\\`\\(\\w\\|[-.]\\)+\\'" name)
3962                        (setq fname name
3963                              lname ""))))
3964               ;; The following letters are not used in `format-time-string':
3965               (push ?E lst) (push "<E>" lst)
3966               (push ?F lst) (push fname lst)
3967               ;; We might want to use "" instead of "<X>" later.
3968               (push ?J lst) (push "<J>" lst)
3969               (push ?K lst) (push "<K>" lst)
3970               (push ?L lst) (push lname lst)
3971               (push ?N lst) (push name-or-net lst)
3972               (push ?O lst) (push "<O>" lst)
3973               (push ?P lst) (push "<P>" lst)
3974               (push ?Q lst) (push "<Q>" lst)
3975               (push ?f lst) (push from lst)
3976               (push ?i lst) (push "<i>" lst)
3977               (push ?n lst) (push net lst)
3978               (push ?o lst) (push "<o>" lst)
3979               (push ?q lst) (push "<q>" lst)
3980               (push ?t lst) (push "<t>" lst)
3981               (push ?v lst) (push "<v>" lst)
3982               ;; Delegate the rest to `format-time-string':
3983               (while (<= i ?z)
3984                 (when (and (not (memq i lst))
3985                            ;; Skip (Z,a)
3986                            (or (<= i ?Z)
3987                                (>= i ?a)))
3988                   (push i lst)
3989                   (push (condition-case nil
3990                             (format-time-string (format "%%%c" i) replydate)
3991                           (error (format ">%c<" i)))
3992                         lst))
3993                 (setq i (1+ i)))
3994               (reverse lst)))
3995            (spec (apply 'format-spec-make flist)))
3996       (insert (format-spec message-citation-line-format spec)))
3997     (newline)))
3998
3999 (defun message-cite-original-without-signature ()
4000   "Cite function in the standard Message manner.
4001 This function strips off the signature from the original message."
4002   (message-cite-original-1 t))
4003
4004 (defun message-insert-citation-line ()
4005   "Insert a simple citation line."
4006   (when message-reply-headers
4007     (insert (mail-header-from message-reply-headers) " writes:")
4008     (newline)
4009     (newline)))
4010
4011 (defun message-position-on-field (header &rest afters)
4012   (let ((case-fold-search t))
4013     (save-restriction
4014       (narrow-to-region
4015        (goto-char (point-min))
4016        (progn
4017          (re-search-forward
4018           (concat "^" (regexp-quote mail-header-separator) "$"))
4019          (match-beginning 0)))
4020       (goto-char (point-min))
4021       (if (re-search-forward (concat "^" (regexp-quote header) ":") nil t)
4022           (progn
4023             (re-search-forward "^[^ \t]" nil 'move)
4024             (beginning-of-line)
4025             (skip-chars-backward "\n")
4026             t)
4027         (while (and afters
4028                     (not (re-search-forward
4029                           (concat "^" (regexp-quote (car afters)) ":")
4030                           nil t)))
4031           (pop afters))
4032         (when afters
4033           (re-search-forward "^[^ \t]" nil 'move)
4034           (beginning-of-line))
4035         (insert header ": \n")
4036         (forward-char -1)
4037         nil))))
4038
4039 (defun message-remove-signature ()
4040   "Remove the signature from the text between point and mark.
4041 The text will also be indented the normal way."
4042   (save-excursion
4043     (let ((start (point))
4044           mark)
4045       (if (not (re-search-forward message-signature-separator (mark t) t))
4046           ;; No signature here, so we just indent the cited text.
4047           (message-indent-citation)
4048         ;; Find the last non-empty line.
4049         (forward-line -1)
4050         (while (looking-at "[ \t]*$")
4051           (forward-line -1))
4052         (forward-line 1)
4053         (setq mark (set-marker (make-marker) (point)))
4054         (goto-char start)
4055         (message-indent-citation)
4056         ;; Enable undoing the deletion.
4057         (undo-boundary)
4058         (delete-region mark (mark t))
4059         (set-marker mark nil)))))
4060
4061 \f
4062
4063 ;;;
4064 ;;; Sending messages
4065 ;;;
4066
4067 (defun message-send-and-exit (&optional arg)
4068   "Send message like `message-send', then, if no errors, exit from mail buffer."
4069   (interactive "P")
4070   (let ((buf (current-buffer))
4071         (actions message-exit-actions))
4072     (when (and (message-send arg)
4073                (buffer-name buf))
4074       (message-bury buf)
4075       (if message-kill-buffer-on-exit
4076           (kill-buffer buf))
4077       (message-do-actions actions)
4078       t)))
4079
4080 (defun message-dont-send ()
4081   "Don't send the message you have been editing.
4082 Instead, just auto-save the buffer and then bury it."
4083   (interactive)
4084   (set-buffer-modified-p t)
4085   (save-buffer)
4086   (let ((actions message-postpone-actions))
4087     (message-bury (current-buffer))
4088     (message-do-actions actions)))
4089
4090 (defun message-kill-buffer ()
4091   "Kill the current buffer."
4092   (interactive)
4093   (when (or (not (buffer-modified-p))
4094             (not message-kill-buffer-query)
4095             (yes-or-no-p "Message modified; kill anyway? "))
4096     (let ((actions message-kill-actions)
4097           (draft-article message-draft-article)
4098           (auto-save-file-name buffer-auto-save-file-name)
4099           (file-name buffer-file-name)
4100           (modified (buffer-modified-p)))
4101       (setq buffer-file-name nil)
4102       (kill-buffer (current-buffer))
4103       (when (and (or (and auto-save-file-name
4104                           (file-exists-p auto-save-file-name))
4105                      (and file-name
4106                           (file-exists-p file-name)))
4107                  (progn
4108                    ;; If the message buffer has lived in a dedicated window,
4109                    ;; `kill-buffer' has killed the frame.  Thus the
4110                    ;; `yes-or-no-p' may show up in a lowered frame.  Make sure
4111                    ;; that the user can see the question by raising the
4112                    ;; current frame:
4113                    (raise-frame)
4114                    (yes-or-no-p (format "Remove the backup file%s? "
4115                                         (if modified " too" "")))))
4116         (ignore-errors
4117           (delete-file auto-save-file-name))
4118         (let ((message-draft-article draft-article))
4119           (message-disassociate-draft)))
4120       (message-do-actions actions))))
4121
4122 (defun message-bury (buffer)
4123   "Bury this mail BUFFER."
4124   (if message-return-action
4125       (progn
4126         (bury-buffer buffer)
4127         (apply (car message-return-action) (cdr message-return-action)))
4128     (with-current-buffer buffer (bury-buffer))))
4129
4130 (defun message-send (&optional arg)
4131   "Send the message in the current buffer.
4132 If `message-interactive' is non-nil, wait for success indication or
4133 error messages, and inform user.
4134 Otherwise any failure is reported in a message back to the user from
4135 the mailer.
4136 The usage of ARG is defined by the instance that called Message.
4137 It should typically alter the sending method in some way or other."
4138   (interactive "P")
4139   ;; Make it possible to undo the coming changes.
4140   (undo-boundary)
4141   (let ((inhibit-read-only t))
4142     (put-text-property (point-min) (point-max) 'read-only nil))
4143   (message-fix-before-sending)
4144   (run-hooks 'message-send-hook)
4145   (when message-confirm-send
4146     (or (y-or-n-p "Send message? ")
4147         (keyboard-quit)))
4148   (message message-sending-message)
4149   (let ((alist message-send-method-alist)
4150         (success t)
4151         elem sent dont-barf-on-no-method
4152         (message-options message-options))
4153     (message-options-set-recipient)
4154     (while (and success
4155                 (setq elem (pop alist)))
4156       (when (funcall (cadr elem))
4157         (when (and (or (not (memq (car elem)
4158                                   message-sent-message-via))
4159                        (message-fetch-field "supersedes")
4160                        (if (or (message-gnksa-enable-p 'multiple-copies)
4161                                (not (eq (car elem) 'news)))
4162                            (y-or-n-p
4163                             (format
4164                              "Already sent message via %s; resend? "
4165                              (car elem)))
4166                          (error "Denied posting -- multiple copies")))
4167                    (setq success (funcall (caddr elem) arg)))
4168           (setq sent t))))
4169     (unless (or sent
4170                 (not success)
4171                 (let ((fcc (message-fetch-field "Fcc"))
4172                       (gcc (message-fetch-field "Gcc")))
4173                   (when (or fcc gcc)
4174                     (or (eq message-allow-no-recipients 'always)
4175                         (and (not (eq message-allow-no-recipients 'never))
4176                              (setq dont-barf-on-no-method
4177                                    (gnus-y-or-n-p
4178                                     (format "No receiver, perform %s anyway? "
4179                                             (cond ((and fcc gcc) "Fcc and Gcc")
4180                                                   (fcc "Fcc")
4181                                                   (t "Gcc"))))))))))
4182       (error "No methods specified to send by"))
4183     (when (or dont-barf-on-no-method
4184               (and success sent))
4185       (message-do-fcc)
4186       (save-excursion
4187         (run-hooks 'message-sent-hook))
4188       (message "Sending...done")
4189       ;; Do ecomplete address snarfing.
4190       (when (and (message-mail-alias-type-p 'ecomplete)
4191                  (not message-inhibit-ecomplete))
4192         (message-put-addresses-in-ecomplete))
4193       ;; Mark the buffer as unmodified and delete auto-save.
4194       (set-buffer-modified-p nil)
4195       (delete-auto-save-file-if-necessary t)
4196       (message-disassociate-draft)
4197       ;; Delete other mail buffers and stuff.
4198       (message-do-send-housekeeping)
4199       (message-do-actions message-send-actions)
4200       ;; Return success.
4201       t)))
4202
4203 (defun message-send-via-mail (arg)
4204   "Send the current message via mail."
4205   (message-send-mail arg))
4206
4207 (defun message-send-via-news (arg)
4208   "Send the current message via news."
4209   (funcall message-send-news-function arg))
4210
4211 (defmacro message-check (type &rest forms)
4212   "Eval FORMS if TYPE is to be checked."
4213   `(or (message-check-element ,type)
4214        (save-excursion
4215          ,@forms)))
4216
4217 (put 'message-check 'lisp-indent-function 1)
4218 (put 'message-check 'edebug-form-spec '(form body))
4219
4220 (defun message-text-with-property (prop &optional start end reverse)
4221   "Return a list of start and end positions where the text has PROP.
4222 START and END bound the search, they default to `point-min' and
4223 `point-max' respectively.  If REVERSE is non-nil, find text which does
4224 not have PROP."
4225   (unless start
4226     (setq start (point-min)))
4227   (unless end
4228     (setq end (point-max)))
4229   (let (next regions)
4230     (if reverse
4231         (while (and start
4232                     (setq start (text-property-any start end prop nil)))
4233           (setq next (next-single-property-change start prop nil end))
4234           (push (cons start (or next end)) regions)
4235           (setq start next))
4236       (while (and start
4237                   (or (get-text-property start prop)
4238                       (and (setq start (next-single-property-change
4239                                         start prop nil end))
4240                            (get-text-property start prop))))
4241         (setq next (text-property-any start end prop nil))
4242         (push (cons start (or next end)) regions)
4243         (setq start next)))
4244     (nreverse regions)))
4245
4246 (defcustom message-bogus-addresses
4247   '("noreply" "nospam" "invalid" "@@" "[^[:ascii:]].*@" "[ \t]")
4248   "List of regexps of potentially bogus mail addresses.
4249 See `message-check-recipients' how to setup checking.
4250
4251 This list should make it possible to catch typos or warn about
4252 spam-trap addresses.  It doesn't aim to verify strict RFC
4253 conformance."
4254   :version "23.1" ;; No Gnus
4255   :group 'message-headers
4256   :type '(choice
4257           (const :tag "None" nil)
4258           (list
4259            (set :inline t
4260                 (const "noreply")
4261                 (const "nospam")
4262                 (const "invalid")
4263                 (const :tag "duplicate @" "@@")
4264                 (const :tag "non-ascii local part" "[^[:ascii:]].*@")
4265                 ;; Already caught by `message-valid-fqdn-regexp'
4266                 ;; (const :tag "`_' in domain part" "@.*_")
4267                 (const :tag "whitespace" "[ \t]"))
4268            (repeat :inline t
4269                    :tag "Other"
4270                    (regexp)))))
4271
4272 (defun message-fix-before-sending ()
4273   "Do various things to make the message nice before sending it."
4274   ;; Make sure there's a newline at the end of the message.
4275   (goto-char (point-max))
4276   (unless (bolp)
4277     (insert "\n"))
4278   ;; Make the hidden headers visible.
4279   (widen)
4280   ;; Sort headers before sending the message.
4281   (message-sort-headers)
4282   ;; Make invisible text visible.
4283   ;; It doesn't seem as if this is useful, since the invisible property
4284   ;; is clobbered by an after-change hook anyhow.
4285   (message-check 'invisible-text
4286     (let ((regions (message-text-with-property 'invisible))
4287           from to)
4288       (when regions
4289         (while regions
4290           (setq from (caar regions)
4291                 to (cdar regions)
4292                 regions (cdr regions))
4293           (put-text-property from to 'invisible nil)
4294           (message-overlay-put (message-make-overlay from to)
4295                                'face 'highlight))
4296         (unless (yes-or-no-p
4297                  "Invisible text found and made visible; continue sending? ")
4298           (error "Invisible text found and made visible")))))
4299   (message-check 'illegible-text
4300     (let (char found choice nul-chars)
4301       (message-goto-body)
4302       (setq nul-chars (save-excursion
4303                         (search-forward "\000" nil t)))
4304       (while (progn
4305                (skip-chars-forward mm-7bit-chars)
4306                (when (get-text-property (point) 'no-illegible-text)
4307                  ;; There is a signed or encrypted raw message part
4308                  ;; that is considered to be safe.
4309                  (goto-char (or (next-single-property-change
4310                                  (point) 'no-illegible-text)
4311                                 (point-max))))
4312                (setq char (char-after)))
4313         (when (or (< (mm-char-int char) 128)
4314                   (and (mm-multibyte-p)
4315                        (memq (char-charset char)
4316                              '(eight-bit-control eight-bit-graphic
4317                                                  ;; Emacs 23, Bug#1770:
4318                                                  eight-bit
4319                                                  control-1))
4320                        (not (get-text-property
4321                              (point) 'untranslated-utf-8))))
4322           (message-overlay-put (message-make-overlay (point) (1+ (point)))
4323                                'face 'highlight)
4324           (setq found t))
4325         (forward-char))
4326       (when found
4327         (setq choice
4328               (gnus-multiple-choice
4329                (if nul-chars
4330                    "NUL characters found, which may cause problems.  Continue sending?"
4331                  "Non-printable characters found.  Continue sending?")
4332                `((?d "Remove non-printable characters and send")
4333                  (?r ,(format
4334                        "Replace non-printable characters with \"%s\" and send"
4335                        message-replacement-char))
4336                  (?s "Send as is without removing anything")
4337                  (?e "Continue editing"))))
4338         (if (eq choice ?e)
4339           (error "Non-printable characters"))
4340         (message-goto-body)
4341         (skip-chars-forward mm-7bit-chars)
4342         (while (not (eobp))
4343           (when (let ((char (char-after)))
4344                   (or (< (mm-char-int char) 128)
4345                       (and (mm-multibyte-p)
4346                            ;; FIXME: Wrong for Emacs 23 (unicode) and for
4347                            ;; things like undecodable utf-8 (in Emacs 21?).
4348                            ;; Should at least use find-coding-systems-region.
4349                            ;; -- fx
4350                            (memq (char-charset char)
4351                                  '(eight-bit-control eight-bit-graphic
4352                                                      ;; Emacs 23, Bug#1770:
4353                                                      eight-bit
4354                                                      control-1))
4355                            (not (get-text-property
4356                                  (point) 'untranslated-utf-8)))))
4357             (if (eq choice ?i)
4358                 (message-kill-all-overlays)
4359               (delete-char 1)
4360               (when (eq choice ?r)
4361                 (insert message-replacement-char))))
4362           (forward-char)
4363           (skip-chars-forward mm-7bit-chars)))))
4364   (message-check 'bogus-recipient
4365     ;; Warn before sending a mail to an invalid address.
4366     (message-check-recipients)))
4367
4368 (defun message-bogus-recipient-p (recipients)
4369   "Check if a mail address in RECIPIENTS looks bogus.
4370
4371 RECIPIENTS is a mail header.  Return a list of potentially bogus
4372 addresses.  If none is found, return nil.
4373
4374 An address might be bogus if the domain part is not fully
4375 qualified, see `message-valid-fqdn-regexp', or if there's a
4376 matching entry in `message-bogus-addresses'."
4377   ;; FIXME: How about "foo@subdomain", when the MTA adds ".domain.tld"?
4378   (let (found)
4379     (mapc (lambda (address)
4380             (setq address (or (cadr address) ""))
4381             (when
4382                 (or (string= "" address)
4383                     (not
4384                      (or
4385                       (not (string-match "@" address))
4386                       (string-match
4387                        (concat ".@.*\\("
4388                                message-valid-fqdn-regexp "\\)\\'") address)))
4389                     (and message-bogus-addresses
4390                          (let ((re
4391                                 (if (listp message-bogus-addresses)
4392                                     (mapconcat 'identity
4393                                                message-bogus-addresses
4394                                                "\\|")
4395                                   message-bogus-addresses)))
4396                            (string-match re address))))
4397               (push address found)))
4398           ;;
4399           (mail-extract-address-components recipients t))
4400     found))
4401
4402 (defun message-check-recipients ()
4403   "Warn before composing or sending a mail to an invalid address.
4404
4405 This function could be useful in `message-setup-hook'."
4406   (interactive)
4407   (save-restriction
4408     (message-narrow-to-headers)
4409     (dolist (hdr '("To" "Cc" "Bcc"))
4410       (let ((addr (message-fetch-field hdr)))
4411         (when (stringp addr)
4412           (dolist (bog (message-bogus-recipient-p addr))
4413             (and bog
4414                  (not (y-or-n-p
4415                        (format
4416                         "Address `%s'%s might be bogus.  Continue? "
4417                         bog
4418                         ;; If the encoded version of the email address
4419                         ;; is different from the unencoded version,
4420                         ;; then we likely have invisible characters or
4421                         ;; the like.  Display the encoded version,
4422                         ;; too.
4423                         (let ((encoded (rfc2047-encode-string bog)))
4424                           (if (string= encoded bog)
4425                               ""
4426                             (format " (%s)" encoded))))))
4427                  (error "Bogus address"))))))))
4428
4429 (custom-add-option 'message-setup-hook 'message-check-recipients)
4430
4431 (defun message-add-action (action &rest types)
4432   "Add ACTION to be performed when doing an exit of type TYPES."
4433   (while types
4434     (add-to-list (intern (format "message-%s-actions" (pop types)))
4435                  action)))
4436
4437 (defun message-delete-action (action &rest types)
4438   "Delete ACTION from lists of actions performed when doing an exit of type TYPES."
4439   (let (var)
4440     (while types
4441       (set (setq var (intern (format "message-%s-actions" (pop types))))
4442            (delq action (symbol-value var))))))
4443
4444 (defun message-do-actions (actions)
4445   "Perform all actions in ACTIONS."
4446   ;; Now perform actions on successful sending.
4447   (dolist (action actions)
4448     (ignore-errors
4449       (cond
4450        ;; A simple function.
4451        ((functionp action)
4452         (funcall action))
4453        ;; Something to be evaled.
4454        (t
4455         (eval action))))))
4456
4457 (defun message-send-mail-partially ()
4458   "Send mail as message/partial."
4459   ;; replace the header delimiter with a blank line
4460   (goto-char (point-min))
4461   (re-search-forward
4462    (concat "^" (regexp-quote mail-header-separator) "\n"))
4463   (replace-match "\n")
4464   (run-hooks 'message-send-mail-hook)
4465   (let ((p (goto-char (point-min)))
4466         (tembuf (message-generate-new-buffer-clone-locals " message temp"))
4467         (curbuf (current-buffer))
4468         (id (message-make-message-id)) (n 1)
4469         plist total header)
4470     (while (not (eobp))
4471       (if (< (point-max) (+ p message-send-mail-partially-limit))
4472           (goto-char (point-max))
4473         (goto-char (+ p message-send-mail-partially-limit))
4474         (beginning-of-line)
4475         (if (<= (point) p) (forward-line 1))) ;; In case of bad message.
4476       (push p plist)
4477       (setq p (point)))
4478     (setq total (length plist))
4479     (push (point-max) plist)
4480     (setq plist (nreverse plist))
4481     (unwind-protect
4482         (save-excursion
4483           (setq p (pop plist))
4484           (while plist
4485             (set-buffer curbuf)
4486             (copy-to-buffer tembuf p (car plist))
4487             (set-buffer tembuf)
4488             (goto-char (point-min))
4489             (if header
4490                 (progn
4491                   (goto-char (point-min))
4492                   (narrow-to-region (point) (point))
4493                   (insert header))
4494               (message-goto-eoh)
4495               (setq header (buffer-substring (point-min) (point)))
4496               (goto-char (point-min))
4497               (narrow-to-region (point) (point))
4498               (insert header)
4499               (message-remove-header "Mime-Version")
4500               (message-remove-header "Content-Type")
4501               (message-remove-header "Content-Transfer-Encoding")
4502               (message-remove-header "Message-ID")
4503               (message-remove-header "Lines")
4504               (goto-char (point-max))
4505               (insert "Mime-Version: 1.0\n")
4506               (setq header (buffer-string)))
4507             (goto-char (point-max))
4508             (insert (format "Content-Type: message/partial; id=\"%s\"; number=%d; total=%d\n\n"
4509                             id n total))
4510             (forward-char -1)
4511             (let ((mail-header-separator ""))
4512               (when (memq 'Message-ID message-required-mail-headers)
4513                 (insert "Message-ID: " (message-make-message-id) "\n"))
4514               (when (memq 'Lines message-required-mail-headers)
4515                 (insert "Lines: " (message-make-lines) "\n"))
4516               (message-goto-subject)
4517               (end-of-line)
4518               (insert (format " (%d/%d)" n total))
4519               (widen)
4520               (funcall (or message-send-mail-real-function
4521                            message-send-mail-function)))
4522             (setq n (+ n 1))
4523             (setq p (pop plist))
4524             (erase-buffer)))
4525       (kill-buffer tembuf))))
4526
4527 (declare-function hashcash-wait-async "hashcash" (&optional buffer))
4528
4529 (defun message-send-mail (&optional arg)
4530   (require 'mail-utils)
4531   (let* ((tembuf (message-generate-new-buffer-clone-locals " message temp"))
4532          (case-fold-search nil)
4533          (news (message-news-p))
4534          (mailbuf (current-buffer))
4535          (message-this-is-mail t)
4536          ;; gnus-setup-posting-charset is autoloaded in mml.el (FIXME
4537          ;; maybe it should not be), which this file requires.  Hence
4538          ;; the fboundp test is always true.  Loading it from gnus-msg
4539          ;; loads many Gnus files (Bug#5642).  If
4540          ;; gnus-group-posting-charset-alist hasn't been customized,
4541          ;; this is just going to return nil anyway.  FIXME it would
4542          ;; be good to improve this further, because even if g-g-p-c-a
4543          ;; has been customized, that is likely to just be for news.
4544          ;; Eg either move the definition from gnus-msg, or separate out
4545          ;; the mail and news parts.
4546          (message-posting-charset
4547           (if (and (fboundp 'gnus-setup-posting-charset)
4548                    (boundp 'gnus-group-posting-charset-alist))
4549               (gnus-setup-posting-charset nil)
4550             message-posting-charset))
4551          (headers message-required-mail-headers))
4552     (when (and message-generate-hashcash
4553                (not (eq message-generate-hashcash 'opportunistic)))
4554       (message "Generating hashcash...")
4555       (require 'hashcash)
4556       ;; Wait for calculations already started to finish...
4557       (hashcash-wait-async)
4558       ;; ...and do calculations not already done.  mail-add-payment
4559       ;; will leave existing X-Hashcash headers alone.
4560       (mail-add-payment)
4561       (message "Generating hashcash...done"))
4562     (save-restriction
4563       (message-narrow-to-headers)
4564       ;; Generate the Mail-Followup-To header if the header is not there...
4565       (if (and (message-subscribed-p)
4566                (not (mail-fetch-field "mail-followup-to")))
4567           (setq headers
4568                 (cons
4569                  (cons "Mail-Followup-To" (message-make-mail-followup-to))
4570                  message-required-mail-headers))
4571         ;; otherwise, delete the MFT header if the field is empty
4572         (when (equal "" (mail-fetch-field "mail-followup-to"))
4573           (message-remove-header "^Mail-Followup-To:")))
4574       ;; Insert some headers.
4575       (let ((message-deletable-headers
4576              (if news nil message-deletable-headers)))
4577         (message-generate-headers headers))
4578       ;; Check continuation headers.
4579       (message-check 'continuation-headers
4580         (goto-char (point-min))
4581         (while (re-search-forward "^[^ \t\n][^ \t\n:]*[ \t\n]" nil t)
4582           (goto-char (match-beginning 0))
4583           (if (y-or-n-p "Fix continuation lines? ")
4584               (insert " ")
4585             (forward-line 1)
4586             (unless (y-or-n-p "Send anyway? ")
4587               (error "Failed to send the message")))))
4588       ;; Let the user do all of the above.
4589       (run-hooks 'message-header-hook))
4590     (unwind-protect
4591         (with-current-buffer tembuf
4592           (erase-buffer)
4593           ;; Avoid copying text props (except hard newlines).
4594           (insert (with-current-buffer mailbuf
4595                     (mml-buffer-substring-no-properties-except-hard-newlines
4596                      (point-min) (point-max))))
4597           ;; Remove some headers.
4598           (message-encode-message-body)
4599           (save-restriction
4600             (message-narrow-to-headers)
4601             ;; We (re)generate the Lines header.
4602             (when (memq 'Lines message-required-mail-headers)
4603               (message-generate-headers '(Lines)))
4604             ;; Remove some headers.
4605             (message-remove-header message-ignored-mail-headers t)
4606             (let ((mail-parse-charset message-default-charset))
4607               (mail-encode-encoded-word-buffer)))
4608           (goto-char (point-max))
4609           ;; require one newline at the end.
4610           (or (= (preceding-char) ?\n)
4611               (insert ?\n))
4612           (message-cleanup-headers)
4613           ;; FIXME: we're inserting the courtesy copy after encoding.
4614           ;; This is wrong if the courtesy copy string contains
4615           ;; non-ASCII characters. -- jh
4616           (when
4617               (save-restriction
4618                 (message-narrow-to-headers)
4619                 (and news
4620                      (not (message-fetch-field "List-Post"))
4621                      (not (message-fetch-field "List-ID"))
4622                      (or (message-fetch-field "cc")
4623                          (message-fetch-field "bcc")
4624                          (message-fetch-field "to"))
4625                      (let ((content-type (message-fetch-field
4626                                           "content-type")))
4627                        (and
4628                         (or
4629                          (not content-type)
4630                          (string= "text/plain"
4631                                   (car
4632                                    (mail-header-parse-content-type
4633                                     content-type))))
4634                         (not
4635                          (string= "base64"
4636                                   (message-fetch-field
4637                                    "content-transfer-encoding")))))))
4638             (message-insert-courtesy-copy
4639              (with-current-buffer mailbuf
4640                message-courtesy-message)))
4641           ;; Let's make sure we encoded all the body.
4642           (assert (save-excursion
4643                     (goto-char (point-min))
4644                     (not (re-search-forward "[^\000-\377]" nil t))))
4645           (mm-disable-multibyte)
4646           (if (or (not message-send-mail-partially-limit)
4647                   (< (buffer-size) message-send-mail-partially-limit)
4648                   (not (message-y-or-n-p
4649                         "The message size is too large, split? "
4650                         t
4651                         "\
4652 The message size, "
4653                         (/ (buffer-size) 1000) "KB, is too large.
4654
4655 Some mail gateways (MTA's) bounce large messages.  To avoid the
4656 problem, answer `y', and the message will be split into several
4657 smaller pieces, the size of each is about "
4658                         (/ message-send-mail-partially-limit 1000)
4659                         "KB except the last
4660 one.
4661
4662 However, some mail readers (MUA's) can't read split messages, i.e.,
4663 mails in message/partially format. Answer `n', and the message will be
4664 sent in one piece.
4665
4666 The size limit is controlled by `message-send-mail-partially-limit'.
4667 If you always want Gnus to send messages in one piece, set
4668 `message-send-mail-partially-limit' to nil.
4669 ")))
4670               (progn
4671                 (message "Sending via mail...")
4672                 (funcall (or message-send-mail-real-function
4673                              message-send-mail-function)))
4674             (message-send-mail-partially)))
4675       (kill-buffer tembuf))
4676     (set-buffer mailbuf)
4677     (push 'mail message-sent-message-via)))
4678
4679 (defvar sendmail-program)
4680
4681 (defun message-send-mail-with-sendmail ()
4682   "Send off the prepared buffer with sendmail."
4683   (require 'sendmail)
4684   (let ((errbuf (if message-interactive
4685                     (message-generate-new-buffer-clone-locals
4686                      " sendmail errors")
4687                   0))
4688         resend-to-addresses delimline)
4689     (unwind-protect
4690         (progn
4691           (let ((case-fold-search t))
4692             (save-restriction
4693               (message-narrow-to-headers)
4694               (setq resend-to-addresses (message-fetch-field "resent-to")))
4695             ;; Change header-delimiter to be what sendmail expects.
4696             (goto-char (point-min))
4697             (re-search-forward
4698              (concat "^" (regexp-quote mail-header-separator) "\n"))
4699             (replace-match "\n")
4700             (backward-char 1)
4701             (setq delimline (point-marker))
4702             (run-hooks 'message-send-mail-hook)
4703             ;; Insert an extra newline if we need it to work around
4704             ;; Sun's bug that swallows newlines.
4705             (goto-char (1+ delimline))
4706             (when (eval message-mailer-swallows-blank-line)
4707               (newline))
4708             (when message-interactive
4709               (with-current-buffer errbuf
4710                 (erase-buffer))))
4711           (let* ((default-directory "/")
4712                  (coding-system-for-write message-send-coding-system)
4713                  (cpr (apply
4714                        'call-process-region
4715                        (append
4716                         (list (point-min) (point-max) sendmail-program
4717                               nil errbuf nil "-oi")
4718                         message-sendmail-extra-arguments
4719                         ;; Always specify who from,
4720                         ;; since some systems have broken sendmails.
4721                         ;; But some systems are more broken with -f, so
4722                         ;; we'll let users override this.
4723                         (and (null message-sendmail-f-is-evil)
4724                              (list "-f" (message-sendmail-envelope-from)))
4725                         ;; These mean "report errors by mail"
4726                         ;; and "deliver in background".
4727                         (if (null message-interactive) '("-oem" "-odb"))
4728                         ;; Get the addresses from the message
4729                         ;; unless this is a resend.
4730                         ;; We must not do that for a resend
4731                         ;; because we would find the original addresses.
4732                         ;; For a resend, include the specific addresses.
4733                         (if resend-to-addresses
4734                             (list resend-to-addresses)
4735                           '("-t"))))))
4736             (unless (or (null cpr) (and (numberp cpr) (zerop cpr)))
4737               (if errbuf (pop-to-buffer errbuf))
4738               (error "Sending...failed with exit value %d" cpr)))
4739           (when message-interactive
4740             (with-current-buffer errbuf
4741               (goto-char (point-min))
4742               (while (re-search-forward "\n+ *" nil t)
4743                 (replace-match "; "))
4744               (if (not (zerop (buffer-size)))
4745                   (error "Sending...failed to %s"
4746                          (buffer-string))))))
4747       (when (bufferp errbuf)
4748         (kill-buffer errbuf)))))
4749
4750 (defun message-send-mail-with-qmail ()
4751   "Pass the prepared message buffer to qmail-inject.
4752 Refer to the documentation for the variable `message-send-mail-function'
4753 to find out how to use this."
4754   ;; replace the header delimiter with a blank line
4755   (goto-char (point-min))
4756   (re-search-forward
4757    (concat "^" (regexp-quote mail-header-separator) "\n"))
4758   (replace-match "\n")
4759   (run-hooks 'message-send-mail-hook)
4760   ;; send the message
4761   (case
4762       (let ((coding-system-for-write message-send-coding-system))
4763         (apply
4764          'call-process-region (point-min) (point-max)
4765          message-qmail-inject-program nil nil nil
4766          ;; qmail-inject's default behavior is to look for addresses on the
4767          ;; command line; if there're none, it scans the headers.
4768          ;; yes, it does The Right Thing w.r.t. Resent-To and it's kin.
4769          ;;
4770          ;; in general, ALL of qmail-inject's defaults are perfect for simply
4771          ;; reading a formatted (i. e., at least a To: or Resent-To header)
4772          ;; message from stdin.
4773          ;;
4774          ;; qmail also has the advantage of not having been raped by
4775          ;; various vendors, so we don't have to allow for that, either --
4776          ;; compare this with message-send-mail-with-sendmail and weep
4777          ;; for sendmail's lost innocence.
4778          ;;
4779          ;; all this is way cool coz it lets us keep the arguments entirely
4780          ;; free for -inject-arguments -- a big win for the user and for us
4781          ;; since we don't have to play that double-guessing game and the user
4782          ;; gets full control (no gestapo'ish -f's, for instance).  --sj
4783          (if (functionp message-qmail-inject-args)
4784              (funcall message-qmail-inject-args)
4785            message-qmail-inject-args)))
4786     ;; qmail-inject doesn't say anything on it's stdout/stderr,
4787     ;; we have to look at the retval instead
4788     (0 nil)
4789     (100 (error "qmail-inject reported permanent failure"))
4790     (111 (error "qmail-inject reported transient failure"))
4791     ;; should never happen
4792     (t   (error "qmail-inject reported unknown failure"))))
4793
4794 (defvar mh-previous-window-config)
4795
4796 (defun message-send-mail-with-mh ()
4797   "Send the prepared message buffer with mh."
4798   (let ((mh-previous-window-config nil)
4799         (name (mh-new-draft-name)))
4800     (setq buffer-file-name name)
4801     ;; MH wants to generate these headers itself.
4802     (when message-mh-deletable-headers
4803       (let ((headers message-mh-deletable-headers))
4804         (while headers
4805           (goto-char (point-min))
4806           (and (re-search-forward
4807                 (concat "^" (symbol-name (car headers)) ": *") nil t)
4808                (message-delete-line))
4809           (pop headers))))
4810     (run-hooks 'message-send-mail-hook)
4811     ;; Pass it on to mh.
4812     (mh-send-letter)))
4813
4814 (defun message-smtpmail-send-it ()
4815   "Send the prepared message buffer with `smtpmail-send-it'.
4816 The only difference from `smtpmail-send-it' is that this command
4817 evaluates `message-send-mail-hook' just before sending a message.
4818 It is useful if your ISP requires the POP-before-SMTP
4819 authentication.  See the Gnus manual for details."
4820   (run-hooks 'message-send-mail-hook)
4821   (smtpmail-send-it))
4822
4823 (defun message-send-mail-with-mailclient ()
4824   "Send the prepared message buffer with `mailclient-send-it'.
4825 The only difference from `mailclient-send-it' is that this
4826 command evaluates `message-send-mail-hook' just before sending a message."
4827   (run-hooks 'message-send-mail-hook)
4828   (mailclient-send-it))
4829
4830 (defun message-canlock-generate ()
4831   "Return a string that is non-trivial to guess.
4832 Do not use this for anything important, it is cryptographically weak."
4833   (require 'sha1)
4834   (let (sha1-maximum-internal-length)
4835     (sha1 (concat (message-unique-id)
4836                   (format "%x%x%x" (random)
4837                           (progn (random t) (random))
4838                           (random))
4839                   (prin1-to-string (recent-keys))
4840                   (prin1-to-string (garbage-collect))))))
4841
4842 (defvar canlock-password)
4843 (defvar canlock-password-for-verify)
4844
4845 (defun message-canlock-password ()
4846   "The password used by message for cancel locks.
4847 This is the value of `canlock-password', if that option is non-nil.
4848 Otherwise, generate and save a value for `canlock-password' first."
4849   (require 'canlock)
4850   (unless canlock-password
4851     (customize-save-variable 'canlock-password (message-canlock-generate))
4852     (setq canlock-password-for-verify canlock-password))
4853   canlock-password)
4854
4855 (defun message-insert-canlock ()
4856   (when message-insert-canlock
4857     (message-canlock-password)
4858     (canlock-insert-header)))
4859
4860 (autoload 'nnheader-get-report "nnheader")
4861
4862 (declare-function gnus-setup-posting-charset "gnus-msg" (group))
4863
4864 (defun message-send-news (&optional arg)
4865   (require 'gnus-msg)
4866   (let* ((tembuf (message-generate-new-buffer-clone-locals " *message temp*"))
4867          (case-fold-search nil)
4868          (method (if (functionp message-post-method)
4869                      (funcall message-post-method arg)
4870                    message-post-method))
4871          (newsgroups-field (save-restriction
4872                             (message-narrow-to-headers-or-head)
4873                             (message-fetch-field "Newsgroups")))
4874          (followup-field (save-restriction
4875                            (message-narrow-to-headers-or-head)
4876                            (message-fetch-field "Followup-To")))
4877          ;; BUG: We really need to get the charset for each name in the
4878          ;; Newsgroups and Followup-To lines to allow crossposting
4879          ;; between group namess with incompatible character sets.
4880          ;; -- Per Abrahamsen <abraham@dina.kvl.dk> 2001-10-08.
4881          (group-field-charset
4882           (gnus-group-name-charset method newsgroups-field))
4883          (followup-field-charset
4884           (gnus-group-name-charset method (or followup-field "")))
4885          (rfc2047-header-encoding-alist
4886           (append (when group-field-charset
4887                     (list (cons "Newsgroups" group-field-charset)))
4888                   (when followup-field-charset
4889                     (list (cons "Followup-To" followup-field-charset)))
4890                   rfc2047-header-encoding-alist))
4891          (messbuf (current-buffer))
4892          (message-syntax-checks
4893           (if (and arg
4894                    (listp message-syntax-checks))
4895               (cons '(existing-newsgroups . disabled)
4896                     message-syntax-checks)
4897             message-syntax-checks))
4898          (message-this-is-news t)
4899          (message-posting-charset
4900           (gnus-setup-posting-charset newsgroups-field))
4901          result)
4902     (if (not (message-check-news-body-syntax))
4903         nil
4904       (save-restriction
4905         (message-narrow-to-headers)
4906         ;; Insert some headers.
4907         (message-generate-headers message-required-news-headers)
4908         (message-insert-canlock)
4909         ;; Let the user do all of the above.
4910         (run-hooks 'message-header-hook))
4911       ;; Note: This check will be disabled by the ".*" default value for
4912       ;; gnus-group-name-charset-group-alist. -- Pa 2001-10-07.
4913       (when (and group-field-charset
4914                  (listp message-syntax-checks))
4915         (setq message-syntax-checks
4916               (cons '(valid-newsgroups . disabled)
4917                     message-syntax-checks)))
4918       (message-cleanup-headers)
4919       (if (not (let ((message-post-method method))
4920                  (message-check-news-syntax)))
4921           nil
4922         (unwind-protect
4923             (with-current-buffer tembuf
4924               (buffer-disable-undo)
4925               (erase-buffer)
4926               ;; Avoid copying text props (except hard newlines).
4927               (insert
4928                (with-current-buffer messbuf
4929                  (mml-buffer-substring-no-properties-except-hard-newlines
4930                   (point-min) (point-max))))
4931               (message-encode-message-body)
4932               ;; Remove some headers.
4933               (save-restriction
4934                 (message-narrow-to-headers)
4935                 ;; We (re)generate the Lines header.
4936                 (when (memq 'Lines message-required-mail-headers)
4937                   (message-generate-headers '(Lines)))
4938                 ;; Remove some headers.
4939                 (message-remove-header message-ignored-news-headers t)
4940                 (let ((mail-parse-charset message-default-charset))
4941                   (mail-encode-encoded-word-buffer)))
4942               (goto-char (point-max))
4943               ;; require one newline at the end.
4944               (or (= (preceding-char) ?\n)
4945                   (insert ?\n))
4946               (let ((case-fold-search t))
4947                 ;; Remove the delimiter.
4948                 (goto-char (point-min))
4949                 (re-search-forward
4950                  (concat "^" (regexp-quote mail-header-separator) "\n"))
4951                 (replace-match "\n")
4952                 (backward-char 1))
4953               (run-hooks 'message-send-news-hook)
4954               (gnus-open-server method)
4955               (message "Sending news via %s..." (gnus-server-string method))
4956               (setq result (let ((mail-header-separator ""))
4957                              (gnus-request-post method))))
4958           (kill-buffer tembuf))
4959         (set-buffer messbuf)
4960         (if result
4961             (push 'news message-sent-message-via)
4962           (message "Couldn't send message via news: %s"
4963                    (nnheader-get-report (car method)))
4964           nil)))))
4965
4966 ;;;
4967 ;;; Header generation & syntax checking.
4968 ;;;
4969
4970 (defun message-check-element (type)
4971   "Return non-nil if this TYPE is not to be checked."
4972   (if (eq message-syntax-checks 'dont-check-for-anything-just-trust-me)
4973       t
4974     (let ((able (assq type message-syntax-checks)))
4975       (and (consp able)
4976            (eq (cdr able) 'disabled)))))
4977
4978 (defun message-check-news-syntax ()
4979   "Check the syntax of the message."
4980   (save-excursion
4981     (save-restriction
4982       (widen)
4983       ;; We narrow to the headers and check them first.
4984       (save-excursion
4985         (save-restriction
4986           (message-narrow-to-headers)
4987           (message-check-news-header-syntax))))))
4988
4989 (defun message-check-news-header-syntax ()
4990   (and
4991    ;; Check Newsgroups header.
4992    (message-check 'newsgroups
4993      (let ((group (message-fetch-field "newsgroups")))
4994        (or
4995         (and group
4996              (not (string-match "\\`[ \t]*\\'" group)))
4997         (ignore
4998          (message
4999           "The newsgroups field is empty or missing.  Posting is denied.")))))
5000    ;; Check the Subject header.
5001    (message-check 'subject
5002      (let* ((case-fold-search t)
5003             (subject (message-fetch-field "subject")))
5004        (or
5005         (and subject
5006              (not (string-match "\\`[ \t]*\\'" subject)))
5007         (ignore
5008          (message
5009           "The subject field is empty or missing.  Posting is denied.")))))
5010    ;; Check for commands in Subject.
5011    (message-check 'subject-cmsg
5012      (if (string-match "^cmsg " (message-fetch-field "subject"))
5013          (y-or-n-p
5014           "The control code \"cmsg\" is in the subject.  Really post? ")
5015        t))
5016    ;; Check long header lines.
5017    (message-check 'long-header-lines
5018      (let ((header nil)
5019            (length 0)
5020            found)
5021        (while (and (not found)
5022                    (re-search-forward "^\\([^ \t:]+\\): " nil t))
5023          (if (> (- (point) (match-beginning 0)) 998)
5024              (setq found t
5025                    length (- (point) (match-beginning 0)))
5026            (setq header (match-string-no-properties 1)))
5027          (forward-line 1))
5028        (if found
5029            (y-or-n-p (format "Your %s header is too long (%d).  Really post? "
5030                              header length))
5031          t)))
5032    ;; Check for multiple identical headers.
5033    (message-check 'multiple-headers
5034      (let (found)
5035        (while (and (not found)
5036                    (re-search-forward "^[^ \t:]+: " nil t))
5037          (save-excursion
5038            (or (re-search-forward
5039                 (concat "^"
5040                         (regexp-quote
5041                          (setq found
5042                                (buffer-substring
5043                                 (match-beginning 0) (- (match-end 0) 2))))
5044                         ":")
5045                 nil t)
5046                (setq found nil))))
5047        (if found
5048            (y-or-n-p (format "Multiple %s headers.  Really post? " found))
5049          t)))
5050    ;; Check for Version and Sendsys.
5051    (message-check 'sendsys
5052      (if (re-search-forward "^Sendsys:\\|^Version:" nil t)
5053          (y-or-n-p
5054           (format "The article contains a %s command.  Really post? "
5055                   (buffer-substring (match-beginning 0)
5056                                     (1- (match-end 0)))))
5057        t))
5058    ;; See whether we can shorten Followup-To.
5059    (message-check 'shorten-followup-to
5060      (let ((newsgroups (message-fetch-field "newsgroups"))
5061            (followup-to (message-fetch-field "followup-to"))
5062            to)
5063        (when (and newsgroups
5064                   (string-match "," newsgroups)
5065                   (not followup-to)
5066                   (not
5067                    (zerop
5068                     (length
5069                      (setq to (completing-read
5070                                "Followups to (default no Followup-To header): "
5071                                (mapcar #'list
5072                                        (cons "poster"
5073                                              (message-tokenize-header
5074                                               newsgroups)))))))))
5075          (goto-char (point-min))
5076          (insert "Followup-To: " to "\n"))
5077        t))
5078    ;; Check "Shoot me".
5079    (message-check 'shoot
5080      (if (re-search-forward
5081           "Message-ID.*.i-did-not-set--mail-host-address--so-tickle-me" nil t)
5082          (y-or-n-p "You appear to have a misconfigured system.  Really post? ")
5083        t))
5084    ;; Check for Approved.
5085    (message-check 'approved
5086      (if (re-search-forward "^Approved:" nil t)
5087          (y-or-n-p "The article contains an Approved header.  Really post? ")
5088        t))
5089    ;; Check the Message-ID header.
5090    (message-check 'message-id
5091      (let* ((case-fold-search t)
5092             (message-id (message-fetch-field "message-id" t)))
5093        (or (not message-id)
5094            ;; Is there an @ in the ID?
5095            (and (string-match "@" message-id)
5096                 ;; Is there a dot in the ID?
5097                 (string-match "@[^.]*\\." message-id)
5098                 ;; Does the ID end with a dot?
5099                 (not (string-match "\\.>" message-id)))
5100            (y-or-n-p
5101             (format "The Message-ID looks strange: \"%s\".  Really post? "
5102                     message-id)))))
5103    ;; Check the Newsgroups & Followup-To headers.
5104    (message-check 'existing-newsgroups
5105      (let* ((case-fold-search t)
5106             (newsgroups (message-fetch-field "newsgroups"))
5107             (followup-to (message-fetch-field "followup-to"))
5108             (groups (message-tokenize-header
5109                      (if followup-to
5110                          (concat newsgroups "," followup-to)
5111                        newsgroups)))
5112             (post-method (if (functionp message-post-method)
5113                              (funcall message-post-method)
5114                            message-post-method))
5115             ;; KLUDGE to handle nnvirtual groups.  Doing this right
5116             ;; would probably involve a new nnoo function.
5117             ;; -- Per Abrahamsen <abraham@dina.kvl.dk>, 2001-10-17.
5118             (method (if (and (consp post-method)
5119                              (eq (car post-method) 'nnvirtual)
5120                              gnus-message-group-art)
5121                         (let ((group (car (nnvirtual-find-group-art
5122                                            (car gnus-message-group-art)
5123                                            (cdr gnus-message-group-art)))))
5124                           (gnus-find-method-for-group group))
5125                       post-method))
5126             (known-groups
5127              (mapcar (lambda (n)
5128                        (gnus-group-name-decode
5129                         (gnus-group-real-name n)
5130                         (gnus-group-name-charset method n)))
5131                      (gnus-groups-from-server method)))
5132             errors)
5133        (while groups
5134          (when (and (not (equal (car groups) "poster"))
5135                     (not (member (car groups) known-groups))
5136                     (not (member (car groups) errors)))
5137            (push (car groups) errors))
5138          (pop groups))
5139        (cond
5140         ;; Gnus is not running.
5141         ((or (not (and (boundp 'gnus-active-hashtb)
5142                        gnus-active-hashtb))
5143              (not (boundp 'gnus-read-active-file)))
5144          t)
5145         ;; We don't have all the group names.
5146         ((and (or (not gnus-read-active-file)
5147                   (eq gnus-read-active-file 'some))
5148               errors)
5149          (y-or-n-p
5150           (format
5151            "Really use %s possibly unknown group%s: %s? "
5152            (if (= (length errors) 1) "this" "these")
5153            (if (= (length errors) 1) "" "s")
5154            (mapconcat 'identity errors ", "))))
5155         ;; There were no errors.
5156         ((not errors)
5157          t)
5158         ;; There are unknown groups.
5159         (t
5160          (y-or-n-p
5161           (format
5162            "Really post to %s unknown group%s: %s? "
5163            (if (= (length errors) 1) "this" "these")
5164            (if (= (length errors) 1) "" "s")
5165            (mapconcat 'identity errors ", ")))))))
5166    ;; Check continuation headers.
5167    (message-check 'continuation-headers
5168      (goto-char (point-min))
5169      (let ((do-posting t))
5170        (while (re-search-forward "^[^ \t\n][^ \t\n:]*[ \t\n]" nil t)
5171          (goto-char (match-beginning 0))
5172          (if (y-or-n-p "Fix continuation lines? ")
5173              (insert " ")
5174            (forward-line 1)
5175            (unless (y-or-n-p "Send anyway? ")
5176              (setq do-posting nil))))
5177        do-posting))
5178    ;; Check the Newsgroups & Followup-To headers for syntax errors.
5179    (message-check 'valid-newsgroups
5180      (let ((case-fold-search t)
5181            (headers '("Newsgroups" "Followup-To"))
5182            header error)
5183        (while (and headers (not error))
5184          (when (setq header (mail-fetch-field (car headers)))
5185            (if (or
5186                 (not
5187                  (string-match
5188                   "\\`\\([-+_&.a-zA-Z0-9]+\\)?\\(,[-+_&.a-zA-Z0-9]+\\)*\\'"
5189                   header))
5190                 (memq
5191                  nil (mapcar
5192                       (lambda (g)
5193                         (not (string-match "\\.\\'\\|\\.\\." g)))
5194                       (message-tokenize-header header ","))))
5195                (setq error t)))
5196          (unless error
5197            (pop headers)))
5198        (if (not error)
5199            t
5200          (y-or-n-p
5201           (format "The %s header looks odd: \"%s\".  Really post? "
5202                   (car headers) header)))))
5203    (message-check 'repeated-newsgroups
5204      (let ((case-fold-search t)
5205            (headers '("Newsgroups" "Followup-To"))
5206            header error groups group)
5207        (while (and headers
5208                    (not error))
5209          (when (setq header (mail-fetch-field (pop headers)))
5210            (setq groups (message-tokenize-header header ","))
5211            (while (setq group (pop groups))
5212              (when (member group groups)
5213                (setq error group
5214                      groups nil)))))
5215        (if (not error)
5216            t
5217          (y-or-n-p
5218           (format "Group %s is repeated in headers.  Really post? " error)))))
5219    ;; Check the From header.
5220    (message-check 'from
5221      (let* ((case-fold-search t)
5222             (from (message-fetch-field "from"))
5223             ad)
5224        (cond
5225         ((not from)
5226          (message "There is no From line.  Posting is denied.")
5227          nil)
5228         ((or (not (string-match
5229                    "@[^\\.]*\\."
5230                    (setq ad (nth 1 (mail-extract-address-components
5231                                     from))))) ;larsi@ifi
5232              (string-match "\\.\\." ad) ;larsi@ifi..uio
5233              (string-match "@\\." ad)   ;larsi@.ifi.uio
5234              (string-match "\\.$" ad)   ;larsi@ifi.uio.
5235              (not (string-match "^[^@]+@[^@]+$" ad)) ;larsi.ifi.uio
5236              (string-match "(.*).*(.*)" from)) ;(lars) (lars)
5237          (message
5238           "Denied posting -- the From looks strange: \"%s\"." from)
5239          nil)
5240         ((let ((addresses (rfc822-addresses from)))
5241            ;; `rfc822-addresses' returns a string if parsing fails.
5242            (while (and (consp addresses)
5243                        (not (eq (string-to-char (car addresses)) ?\()))
5244              (setq addresses (cdr addresses)))
5245            addresses)
5246          (message
5247           "Denied posting -- bad From address: \"%s\"." from)
5248          nil)
5249         (t t))))
5250    ;; Check the Reply-To header.
5251    (message-check 'reply-to
5252      (let* ((case-fold-search t)
5253             (reply-to (message-fetch-field "reply-to"))
5254             ad)
5255        (cond
5256         ((not reply-to)
5257          t)
5258         ((string-match "," reply-to)
5259          (y-or-n-p
5260           (format "Multiple Reply-To addresses: \"%s\". Really post? "
5261                   reply-to)))
5262         ((or (not (string-match
5263                    "@[^\\.]*\\."
5264                    (setq ad (nth 1 (mail-extract-address-components
5265                                     reply-to))))) ;larsi@ifi
5266              (string-match "\\.\\." ad) ;larsi@ifi..uio
5267              (string-match "@\\." ad)   ;larsi@.ifi.uio
5268              (string-match "\\.$" ad)   ;larsi@ifi.uio.
5269              (not (string-match "^[^@]+@[^@]+$" ad)) ;larsi.ifi.uio
5270              (string-match "(.*).*(.*)" reply-to)) ;(lars) (lars)
5271          (y-or-n-p
5272           (format
5273            "The Reply-To looks strange: \"%s\". Really post? "
5274            reply-to)))
5275         (t t))))))
5276
5277 (defun message-check-news-body-syntax ()
5278   (and
5279    ;; Check for long lines.
5280    (message-check 'long-lines
5281      (goto-char (point-min))
5282      (re-search-forward
5283       (concat "^" (regexp-quote mail-header-separator) "$"))
5284      (forward-line 1)
5285      (while (and
5286              (or (looking-at
5287                   "<#\\(/\\)?\\(multipart\\|part\\|external\\|mml\\)")
5288                  (let ((p (point)))
5289                    (end-of-line)
5290                    (< (- (point) p) 80)))
5291              (zerop (forward-line 1))))
5292      (or (bolp)
5293          (eobp)
5294          (y-or-n-p
5295           "You have lines longer than 79 characters.  Really post? ")))
5296    ;; Check whether the article is empty.
5297    (message-check 'empty
5298      (goto-char (point-min))
5299      (re-search-forward
5300       (concat "^" (regexp-quote mail-header-separator) "$"))
5301      (forward-line 1)
5302      (let ((b (point)))
5303        (goto-char (point-max))
5304        (re-search-backward message-signature-separator nil t)
5305        (beginning-of-line)
5306        (or (re-search-backward "[^ \n\t]" b t)
5307            (if (message-gnksa-enable-p 'empty-article)
5308                (y-or-n-p "Empty article.  Really post? ")
5309              (message "Denied posting -- Empty article.")
5310              nil))))
5311    ;; Check for control characters.
5312    (message-check 'control-chars
5313      (if (re-search-forward
5314           (mm-string-to-multibyte "[\000-\007\013\015-\032\034-\037\200-\237]")
5315           nil t)
5316          (y-or-n-p
5317           "The article contains control characters.  Really post? ")
5318        t))
5319    ;; Check excessive size.
5320    (message-check 'size
5321      (if (> (buffer-size) 60000)
5322          (y-or-n-p
5323           (format "The article is %d octets long.  Really post? "
5324                   (buffer-size)))
5325        t))
5326    ;; Check whether any new text has been added.
5327    (message-check 'new-text
5328      (or
5329       (not message-checksum)
5330       (not (eq (message-checksum) message-checksum))
5331       (if (message-gnksa-enable-p 'quoted-text-only)
5332           (y-or-n-p
5333            "It looks like no new text has been added.  Really post? ")
5334         (message "Denied posting -- no new text has been added.")
5335         nil)))
5336    ;; Check the length of the signature.
5337    (message-check 'signature
5338      (let (sig-start sig-end)
5339        (goto-char (point-max))
5340        (if (not (re-search-backward message-signature-separator nil t))
5341            t
5342          (setq sig-start (1+ (point-at-eol)))
5343          (setq sig-end
5344                (if (re-search-forward
5345                     "<#/?\\(multipart\\|part\\|external\\|mml\\)" nil t)
5346                    (- (point-at-bol) 1)
5347                  (point-max)))
5348          (if (>= (count-lines sig-start sig-end) 5)
5349              (if (message-gnksa-enable-p 'signature)
5350                  (y-or-n-p
5351                   (format "Signature is excessively long (%d lines).  Really post? "
5352                           (count-lines sig-start sig-end)))
5353                (message "Denied posting -- Excessive signature.")
5354                nil)
5355            t))))
5356    ;; Ensure that text follows last quoted portion.
5357    (message-check 'quoting-style
5358      (goto-char (point-max))
5359      (let ((no-problem t))
5360        (when (search-backward-regexp "^>[^\n]*\n" nil t)
5361          (setq no-problem (search-forward-regexp "^[ \t]*[^>\n]" nil t)))
5362        (if no-problem
5363            t
5364          (if (message-gnksa-enable-p 'quoted-text-only)
5365              (y-or-n-p "Your text should follow quoted text.  Really post? ")
5366            ;; Ensure that
5367            (goto-char (point-min))
5368            (re-search-forward
5369             (concat "^" (regexp-quote mail-header-separator) "$"))
5370            (if (search-forward-regexp "^[ \t]*[^>\n]" nil t)
5371                (y-or-n-p "Your text should follow quoted text.  Really post? ")
5372              (message "Denied posting -- only quoted text.")
5373              nil)))))))
5374
5375 (defun message-checksum ()
5376   "Return a \"checksum\" for the current buffer."
5377   (let ((sum 0))
5378     (save-excursion
5379       (goto-char (point-min))
5380       (re-search-forward
5381        (concat "^" (regexp-quote mail-header-separator) "$"))
5382       (while (not (eobp))
5383         (when (not (looking-at "[ \t\n]"))
5384           (setq sum (logxor (ash sum 1) (if (natnump sum) 0 1)
5385                             (char-after))))
5386         (forward-char 1)))
5387     sum))
5388
5389 (defun message-do-fcc ()
5390   "Process Fcc headers in the current buffer."
5391   (let ((case-fold-search t)
5392         (buf (current-buffer))
5393         list file
5394         (mml-externalize-attachments message-fcc-externalize-attachments))
5395     (save-excursion
5396       (save-restriction
5397         (message-narrow-to-headers)
5398         (setq file (message-fetch-field "fcc" t)))
5399       (when file
5400         (set-buffer (get-buffer-create " *message temp*"))
5401         (erase-buffer)
5402         (insert-buffer-substring buf)
5403         (message-encode-message-body)
5404         (save-restriction
5405           (message-narrow-to-headers)
5406           (while (setq file (message-fetch-field "fcc" t))
5407             (push file list)
5408             (message-remove-header "fcc" nil t))
5409           (let ((mail-parse-charset message-default-charset)
5410                 (rfc2047-header-encoding-alist
5411                  (cons '("Newsgroups" . default)
5412                        rfc2047-header-encoding-alist)))
5413             (mail-encode-encoded-word-buffer)))
5414         (goto-char (point-min))
5415         (when (re-search-forward
5416                (concat "^" (regexp-quote mail-header-separator) "$")
5417                nil t)
5418           (replace-match "" t t ))
5419         ;; Process FCC operations.
5420         (while list
5421           (setq file (pop list))
5422           (if (string-match "^[ \t]*|[ \t]*\\(.*\\)[ \t]*$" file)
5423               ;; Pipe the article to the program in question.
5424               (call-process-region (point-min) (point-max) shell-file-name
5425                                    nil nil nil shell-command-switch
5426                                    (match-string 1 file))
5427             ;; Save the article.
5428             (setq file (expand-file-name file))
5429             (unless (file-exists-p (file-name-directory file))
5430               (make-directory (file-name-directory file) t))
5431             (if (and message-fcc-handler-function
5432                      (not (eq message-fcc-handler-function 'rmail-output)))
5433                 (funcall message-fcc-handler-function file)
5434               ;; FIXME this option, rmail-output (also used if
5435               ;; message-fcc-handler-function is nil) is not
5436               ;; documented anywhere AFAICS.  It should work in Emacs
5437               ;; 23; I suspect it does not work in Emacs 22.
5438               ;; FIXME I don't see the need for the two different cases here.
5439               ;; mail-use-rfc822 makes no difference (in Emacs 23),and
5440               ;; the third argument just controls \"Wrote file\" message.
5441               (if (and (file-readable-p file) (mail-file-babyl-p file))
5442                   (rmail-output file 1 nil t)
5443                 (let ((mail-use-rfc822 t))
5444                   (rmail-output file 1 t t))))))
5445         (kill-buffer (current-buffer))))))
5446
5447 (defun message-output (filename)
5448   "Append this article to Unix/babyl mail file FILENAME."
5449   (if (or (and (file-readable-p filename)
5450                (mail-file-babyl-p filename))
5451           ;; gnus-output-to-mail does the wrong thing with live, mbox
5452           ;; Rmail buffers in Emacs 23.
5453           ;; http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=597255
5454           (let ((buff (find-buffer-visiting filename)))
5455             (and buff (with-current-buffer buff
5456                         (eq major-mode 'rmail-mode)))))
5457       (gnus-output-to-rmail filename t)
5458     (gnus-output-to-mail filename t)))
5459
5460 (defun message-cleanup-headers ()
5461   "Do various automatic cleanups of the headers."
5462   ;; Remove empty lines in the header.
5463   (save-restriction
5464     (message-narrow-to-headers)
5465     ;; Remove blank lines.
5466     (while (re-search-forward "^[ \t]*\n" nil t)
5467       (replace-match "" t t))
5468
5469     ;; Correct Newsgroups and Followup-To headers:  Change sequence of
5470     ;; spaces to comma and eliminate spaces around commas.  Eliminate
5471     ;; embedded line breaks.
5472     (goto-char (point-min))
5473     (while (re-search-forward "^\\(Newsgroups\\|Followup-To\\): +" nil t)
5474       (save-restriction
5475         (narrow-to-region
5476          (point)
5477          (if (re-search-forward "^[^ \t]" nil t)
5478              (match-beginning 0)
5479            (forward-line 1)
5480            (point)))
5481         (goto-char (point-min))
5482         (while (re-search-forward "\n[ \t]+" nil t)
5483           (replace-match " " t t))     ;No line breaks (too confusing)
5484         (goto-char (point-min))
5485         (while (re-search-forward "[ \t\n]*,[ \t\n]*\\|[ \t]+" nil t)
5486           (replace-match "," t t))
5487         (goto-char (point-min))
5488         ;; Remove trailing commas.
5489         (when (re-search-forward ",+$" nil t)
5490           (replace-match "" t t))))))
5491
5492 (defun message-make-date (&optional now)
5493   "Make a valid data header.
5494 If NOW, use that time instead."
5495   (let ((system-time-locale "C"))
5496     (format-time-string "%a, %d %b %Y %T %z" now)))
5497
5498 (defun message-insert-expires (days)
5499   "Insert the Expires header.  Expiry in DAYS days."
5500   (interactive "NExpire article in how many days? ")
5501   (save-excursion
5502     (message-position-on-field "Expires" "X-Draft-From")
5503     (insert (message-make-expires-date days))))
5504
5505 (defun message-make-expires-date (days)
5506   "Make date string for the Expires header.  Expiry in DAYS days.
5507
5508 In posting styles use `(\"Expires\" (make-expires-date 30))'."
5509   (let* ((cur (decode-time (current-time)))
5510          (nday (+ days (nth 3 cur))))
5511     (setf (nth 3 cur) nday)
5512     (message-make-date (apply 'encode-time cur))))
5513
5514 (defun message-make-message-id ()
5515   "Make a unique Message-ID."
5516   (concat "<" (message-unique-id)
5517           (let ((psubject (save-excursion (message-fetch-field "subject")))
5518                 (psupersedes
5519                  (save-excursion (message-fetch-field "supersedes"))))
5520             (if (or
5521                  (and message-reply-headers
5522                       (mail-header-references message-reply-headers)
5523                       (mail-header-subject message-reply-headers)
5524                       psubject
5525                       (not (string=
5526                             (message-strip-subject-re
5527                              (mail-header-subject message-reply-headers))
5528                             (message-strip-subject-re psubject))))
5529                  (and psupersedes
5530                       (string-match "_-_@" psupersedes)))
5531                 "_-_" ""))
5532           "@" (message-make-fqdn) ">"))
5533
5534 (defvar message-unique-id-char nil)
5535
5536 ;; If you ever change this function, make sure the new version
5537 ;; cannot generate IDs that the old version could.
5538 ;; You might for example insert a "." somewhere (not next to another dot
5539 ;; or string boundary), or modify the "fsf" string.
5540 (defun message-unique-id ()
5541   (random t)
5542   ;; Don't use microseconds from (current-time), they may be unsupported.
5543   ;; Instead we use this randomly inited counter.
5544   (setq message-unique-id-char
5545         (% (1+ (or message-unique-id-char
5546                    (logand (random most-positive-fixnum) (1- (lsh 1 20)))))
5547            ;; (current-time) returns 16-bit ints,
5548            ;; and 2^16*25 just fits into 4 digits i base 36.
5549            (* 25 25)))
5550   (let ((tm (current-time)))
5551     (concat
5552      (if (or (eq system-type 'ms-dos)
5553              ;; message-number-base36 doesn't handle bigints.
5554              (floatp (user-uid)))
5555          (let ((user (downcase (user-login-name))))
5556            (while (string-match "[^a-z0-9_]" user)
5557              (aset user (match-beginning 0) ?_))
5558            user)
5559        (message-number-base36 (user-uid) -1))
5560      (message-number-base36 (+ (car tm)
5561                                (lsh (% message-unique-id-char 25) 16)) 4)
5562      (message-number-base36 (+ (nth 1 tm)
5563                                (lsh (/ message-unique-id-char 25) 16)) 4)
5564      ;; Append a given name, because while the generated ID is unique
5565      ;; to this newsreader, other newsreaders might otherwise generate
5566      ;; the same ID via another algorithm.
5567      ".fsf")))
5568
5569 (defun message-number-base36 (num len)
5570   (if (if (< len 0)
5571           (<= num 0)
5572         (= len 0))
5573       ""
5574     (concat (message-number-base36 (/ num 36) (1- len))
5575             (char-to-string (aref "zyxwvutsrqponmlkjihgfedcba9876543210"
5576                                   (% num 36))))))
5577
5578 (defun message-make-organization ()
5579   "Make an Organization header."
5580   (let* ((organization
5581           (when message-user-organization
5582             (if (functionp message-user-organization)
5583                 (funcall message-user-organization)
5584               message-user-organization))))
5585     (with-temp-buffer
5586       (mm-enable-multibyte)
5587       (cond ((stringp organization)
5588              (insert organization))
5589             ((and (eq t organization)
5590                   message-user-organization-file
5591                   (file-exists-p message-user-organization-file))
5592              (insert-file-contents message-user-organization-file)))
5593       (goto-char (point-min))
5594       (while (re-search-forward "[\t\n]+" nil t)
5595         (replace-match "" t t))
5596       (unless (zerop (buffer-size))
5597         (buffer-string)))))
5598
5599 (defun message-make-lines ()
5600   "Count the number of lines and return numeric string."
5601   (save-excursion
5602     (save-restriction
5603       (widen)
5604       (message-goto-body)
5605       (int-to-string (count-lines (point) (point-max))))))
5606
5607 (defun message-make-references ()
5608   "Return the References header for this message."
5609   (when message-reply-headers
5610     (let ((message-id (mail-header-id message-reply-headers))
5611           (references (mail-header-references message-reply-headers)))
5612       (if (or references message-id)
5613           (concat (or references "") (and references " ")
5614                   (or message-id ""))
5615         nil))))
5616
5617 (defun message-make-in-reply-to ()
5618   "Return the In-Reply-To header for this message."
5619   (when message-reply-headers
5620     (let ((from (mail-header-from message-reply-headers))
5621           (date (mail-header-date message-reply-headers))
5622           (msg-id (mail-header-id message-reply-headers)))
5623       (when from
5624         (let ((name (mail-extract-address-components from)))
5625           (concat
5626            msg-id (if msg-id " (")
5627            (if (car name)
5628                (if (string-match "[^\000-\177]" (car name))
5629                    ;; Quote a string containing non-ASCII characters.
5630                    ;; It will make the RFC2047 encoder cause an error
5631                    ;; if there are special characters.
5632                    (mm-with-multibyte-buffer
5633                      (insert (car name))
5634                      (goto-char (point-min))
5635                      (while (search-forward "\"" nil t)
5636                        (when (prog2
5637                                  (backward-char)
5638                                  (zerop (% (skip-chars-backward "\\\\") 2))
5639                                (goto-char (match-beginning 0)))
5640                          (insert "\\"))
5641                        (forward-char))
5642                      ;; Those quotes will be removed by the RFC2047 encoder.
5643                      (concat "\"" (buffer-string) "\""))
5644                  (car name))
5645              (nth 1 name))
5646            "'s message of \""
5647            (if (or (not date) (string= date ""))
5648                "(unknown date)" date)
5649            "\"" (if msg-id ")")))))))
5650
5651 (defun message-make-distribution ()
5652   "Make a Distribution header."
5653   (let ((orig-distribution (message-fetch-reply-field "distribution")))
5654     (cond ((functionp message-distribution-function)
5655            (funcall message-distribution-function))
5656           (t orig-distribution))))
5657
5658 (defun message-make-expires ()
5659   "Return an Expires header based on `message-expires'."
5660   (let ((current (current-time))
5661         (future (* 1.0 message-expires 60 60 24)))
5662     ;; Add the future to current.
5663     (setcar current (+ (car current) (round (/ future (expt 2 16)))))
5664     (setcar (cdr current) (+ (nth 1 current) (% (round future) (expt 2 16))))
5665     (message-make-date current)))
5666
5667 (defun message-make-path ()
5668   "Return uucp path."
5669   (let ((login-name (user-login-name)))
5670     (cond ((null message-user-path)
5671            (concat (system-name) "!" login-name))
5672           ((stringp message-user-path)
5673            ;; Support GENERICPATH.  Suggested by vixie@decwrl.dec.com.
5674            (concat message-user-path "!" login-name))
5675           (t login-name))))
5676
5677 (defun message-make-from (&optional name address)
5678   "Make a From header."
5679   (let* ((style message-from-style)
5680          (login (or address (message-make-address)))
5681          (fullname (or name
5682                        (and (boundp 'user-full-name)
5683                             user-full-name)
5684                        (user-full-name))))
5685     (when (string= fullname "&")
5686       (setq fullname (user-login-name)))
5687     (with-temp-buffer
5688       (mm-enable-multibyte)
5689       (cond
5690        ((or (null style)
5691             (equal fullname ""))
5692         (insert login))
5693        ((or (eq style 'angles)
5694             (and (not (eq style 'parens))
5695                  ;; Use angles if no quoting is needed, or if parens would
5696                  ;; need quoting too.
5697                  (or (not (string-match "[^- !#-'*+/-9=?A-Z^-~]" fullname))
5698                      (let ((tmp (concat fullname nil)))
5699                        (while (string-match "([^()]*)" tmp)
5700                          (aset tmp (match-beginning 0) ?-)
5701                          (aset tmp (1- (match-end 0)) ?-))
5702                        (string-match "[\\()]" tmp)))))
5703         (insert fullname)
5704         (goto-char (point-min))
5705         ;; Look for a character that cannot appear unquoted
5706         ;; according to RFC 822.
5707         (when (re-search-forward "[^- !#-'*+/-9=?A-Z^-~]" nil 1)
5708           ;; Quote fullname, escaping specials.
5709           (goto-char (point-min))
5710           (insert "\"")
5711           (while (re-search-forward "[\"\\]" nil 1)
5712             (replace-match "\\\\\\&" t))
5713           (insert "\""))
5714         (insert " <" login ">"))
5715        (t                               ; 'parens or default
5716         (insert login " (")
5717         (let ((fullname-start (point)))
5718           (insert fullname)
5719           (goto-char fullname-start)
5720           ;; RFC 822 says \ and nonmatching parentheses
5721           ;; must be escaped in comments.
5722           ;; Escape every instance of ()\ ...
5723           (while (re-search-forward "[()\\]" nil 1)
5724             (replace-match "\\\\\\&" t))
5725           ;; ... then undo escaping of matching parentheses,
5726           ;; including matching nested parentheses.
5727           (goto-char fullname-start)
5728           (while (re-search-forward
5729                   "\\(\\=\\|[^\\]\\(\\\\\\\\\\)*\\)\\\\(\\(\\([^\\]\\|\\\\\\\\\\)*\\)\\\\)"
5730                   nil 1)
5731             (replace-match "\\1(\\3)" t)
5732             (goto-char fullname-start)))
5733         (insert ")")))
5734       (buffer-string))))
5735
5736 (defun message-make-sender ()
5737   "Return the \"real\" user address.
5738 This function tries to ignore all user modifications, and
5739 give as trustworthy answer as possible."
5740   (concat (user-login-name) "@" (system-name)))
5741
5742 (defun message-make-address ()
5743   "Make the address of the user."
5744   (or (message-user-mail-address)
5745       (concat (user-login-name) "@" (message-make-domain))))
5746
5747 (defun message-user-mail-address ()
5748   "Return the pertinent part of `user-mail-address'."
5749   (when (and user-mail-address
5750              (string-match "@.*\\." user-mail-address))
5751     (if (string-match " " user-mail-address)
5752         (nth 1 (mail-extract-address-components user-mail-address))
5753       user-mail-address)))
5754
5755 (defun message-sendmail-envelope-from ()
5756   "Return the envelope from."
5757   (cond ((eq message-sendmail-envelope-from 'header)
5758          (nth 1 (mail-extract-address-components
5759                  (message-fetch-field "from"))))
5760         ((stringp message-sendmail-envelope-from)
5761          message-sendmail-envelope-from)
5762         (t
5763          (message-make-address))))
5764
5765 (defun message-make-fqdn ()
5766   "Return user's fully qualified domain name."
5767   (let* ((system-name (system-name))
5768          (user-mail (message-user-mail-address))
5769          (user-domain
5770           (if (and user-mail
5771                    (string-match "@\\(.*\\)\\'" user-mail))
5772               (match-string 1 user-mail)))
5773          (case-fold-search t))
5774     (cond
5775      ((and message-user-fqdn
5776            (stringp message-user-fqdn)
5777            (string-match message-valid-fqdn-regexp message-user-fqdn)
5778            (not (string-match message-bogus-system-names message-user-fqdn)))
5779       ;; `message-user-fqdn' seems to be valid
5780       message-user-fqdn)
5781      ((and (string-match message-valid-fqdn-regexp system-name)
5782            (not (string-match message-bogus-system-names system-name)))
5783       ;; `system-name' returned the right result.
5784       system-name)
5785      ;; Try `mail-host-address'.
5786      ((and (boundp 'mail-host-address)
5787            (stringp mail-host-address)
5788            (string-match message-valid-fqdn-regexp mail-host-address)
5789            (not (string-match message-bogus-system-names mail-host-address)))
5790       mail-host-address)
5791      ;; We try `user-mail-address' as a backup.
5792      ((and user-domain
5793            (stringp user-domain)
5794            (string-match message-valid-fqdn-regexp user-domain)
5795            (not (string-match message-bogus-system-names user-domain)))
5796       user-domain)
5797      ;; Default to this bogus thing.
5798      (t
5799       (concat system-name
5800               ".i-did-not-set--mail-host-address--so-tickle-me")))))
5801
5802 (defun message-make-host-name ()
5803   "Return the name of the host."
5804   (let ((fqdn (message-make-fqdn)))
5805     (string-match "^[^.]+\\." fqdn)
5806     (substring fqdn 0 (1- (match-end 0)))))
5807
5808 (defun message-make-domain ()
5809   "Return the domain name."
5810   (or mail-host-address
5811       (message-make-fqdn)))
5812
5813 (defun message-to-list-only ()
5814   "Send a message to the list only.
5815 Remove all addresses but the list address from To and Cc headers."
5816   (interactive)
5817   (let ((listaddr (message-make-mail-followup-to t)))
5818     (when listaddr
5819       (save-excursion
5820         (message-remove-header "to")
5821         (message-remove-header "cc")
5822         (message-position-on-field "To" "X-Draft-From")
5823         (insert listaddr)))))
5824
5825 (defun message-make-mail-followup-to (&optional only-show-subscribed)
5826   "Return the Mail-Followup-To header.
5827 If passed the optional argument ONLY-SHOW-SUBSCRIBED only return the
5828 subscribed address (and not the additional To and Cc header contents)."
5829   (let* ((case-fold-search t)
5830          (to (message-fetch-field "To"))
5831          (cc (message-fetch-field "cc"))
5832          (msg-recipients (concat to (and to cc ", ") cc))
5833          (recipients
5834           (mapcar 'mail-strip-quoted-names
5835                   (message-tokenize-header msg-recipients)))
5836          (file-regexps
5837           (if message-subscribed-address-file
5838               (let (begin end item re)
5839                 (save-excursion
5840                   (with-temp-buffer
5841                     (insert-file-contents message-subscribed-address-file)
5842                     (while (not (eobp))
5843                       (setq begin (point))
5844                       (forward-line 1)
5845                       (setq end (point))
5846                       (if (bolp) (setq end (1- end)))
5847                       (setq item (regexp-quote (buffer-substring begin end)))
5848                       (if re (setq re (concat re "\\|" item))
5849                         (setq re (concat "\\`\\(" item))))
5850                     (and re (list (concat re "\\)\\'"))))))))
5851          (mft-regexps (apply 'append message-subscribed-regexps
5852                              (mapcar 'regexp-quote
5853                                      message-subscribed-addresses)
5854                              file-regexps
5855                              (mapcar 'funcall
5856                                      message-subscribed-address-functions))))
5857     (save-match-data
5858       (let ((list
5859              (loop for recipient in recipients
5860                when (loop for regexp in mft-regexps
5861                       when (string-match regexp recipient) return t)
5862                return recipient)))
5863         (when list
5864           (if only-show-subscribed
5865               list
5866             msg-recipients))))))
5867
5868 (defun message-idna-to-ascii-rhs-1 (header)
5869   "Interactively potentially IDNA encode domain names in HEADER."
5870   (let ((field (message-fetch-field header))
5871         ace)
5872     (when field
5873       (dolist (rhs
5874                (mm-delete-duplicates
5875                 (mapcar (lambda (rhs) (or (cadr (split-string rhs "@")) ""))
5876                         (mapcar 'downcase
5877                                 (mapcar
5878                                  (lambda (elem)
5879                                    (or (cadr elem)
5880                                        ""))
5881                                  (mail-extract-address-components field t))))))
5882         ;; Note that `rhs' will be "" if the address does not have
5883         ;; the domain part, i.e., if it is a local user's address.
5884         (setq ace (if (string-match "\\`[[:ascii:]]*\\'" rhs)
5885                       rhs
5886                     (downcase (idna-to-ascii rhs))))
5887         (when (and (not (equal rhs ace))
5888                    (or (not (eq message-use-idna 'ask))
5889                        (y-or-n-p (format "Replace %s with %s in %s:? "
5890                                          rhs ace header))))
5891           (goto-char (point-min))
5892           (while (re-search-forward (concat "^" header ":") nil t)
5893             (message-narrow-to-field)
5894             (while (search-forward (concat "@" rhs) nil t)
5895               (replace-match (concat "@" ace) t t))
5896             (goto-char (point-max))
5897             (widen)))))))
5898
5899 (defun message-idna-to-ascii-rhs ()
5900   "Possibly IDNA encode non-ASCII domain names in From:, To: and Cc: headers.
5901 See `message-idna-encode'."
5902   (interactive)
5903   (when message-use-idna
5904     (save-excursion
5905       (save-restriction
5906         ;; `message-narrow-to-head' that recognizes only the first empty
5907         ;; line as the message header separator used to be used here.
5908         ;; However, since there is the "--text follows this line--" line
5909         ;; normally, it failed in narrowing to the headers and potentially
5910         ;; caused the IDNA encoding on lines that look like headers in
5911         ;; the message body.
5912         (message-narrow-to-headers-or-head)
5913         (message-idna-to-ascii-rhs-1 "From")
5914         (message-idna-to-ascii-rhs-1 "To")
5915         (message-idna-to-ascii-rhs-1 "Reply-To")
5916         (message-idna-to-ascii-rhs-1 "Mail-Reply-To")
5917         (message-idna-to-ascii-rhs-1 "Mail-Followup-To")
5918         (message-idna-to-ascii-rhs-1 "Cc")))))
5919
5920 (defvar Date)
5921 (defvar Message-ID)
5922 (defvar Organization)
5923 (defvar From)
5924 (defvar Path)
5925 (defvar Subject)
5926 (defvar Newsgroups)
5927 (defvar In-Reply-To)
5928 (defvar References)
5929 (defvar To)
5930 (defvar Distribution)
5931 (defvar Lines)
5932 (defvar User-Agent)
5933 (defvar Expires)
5934
5935 (defun message-generate-headers (headers)
5936   "Prepare article HEADERS.
5937 Headers already prepared in the buffer are not modified."
5938   (setq headers (append headers message-required-headers))
5939   (save-restriction
5940     (message-narrow-to-headers)
5941     (let* ((Date (message-make-date))
5942            (Message-ID (message-make-message-id))
5943            (Organization (message-make-organization))
5944            (From (message-make-from))
5945            (Path (message-make-path))
5946            (Subject nil)
5947            (Newsgroups nil)
5948            (In-Reply-To (message-make-in-reply-to))
5949            (References (message-make-references))
5950            (To nil)
5951            (Distribution (message-make-distribution))
5952            (Lines (message-make-lines))
5953            (User-Agent message-newsreader)
5954            (Expires (message-make-expires))
5955            (case-fold-search t)
5956            (optionalp nil)
5957            header value elem header-string)
5958       ;; First we remove any old generated headers.
5959       (let ((headers message-deletable-headers))
5960         (unless (buffer-modified-p)
5961           (setq headers (delq 'Message-ID (copy-sequence headers))))
5962         (while headers
5963           (goto-char (point-min))
5964           (and (re-search-forward
5965                 (concat "^" (symbol-name (car headers)) ": *") nil t)
5966                (get-text-property (1+ (match-beginning 0)) 'message-deletable)
5967                (message-delete-line))
5968           (pop headers)))
5969       ;; Go through all the required headers and see if they are in the
5970       ;; articles already.  If they are not, or are empty, they are
5971       ;; inserted automatically - except for Subject, Newsgroups and
5972       ;; Distribution.
5973       (while headers
5974         (goto-char (point-min))
5975         (setq elem (pop headers))
5976         (if (consp elem)
5977             (if (eq (car elem) 'optional)
5978                 (setq header (cdr elem)
5979                       optionalp t)
5980               (setq header (car elem)))
5981           (setq header elem))
5982         (setq header-string  (if (stringp header)
5983                                  header
5984                                (symbol-name header)))
5985         (when (or (not (re-search-forward
5986                         (concat "^"
5987                                 (regexp-quote (downcase header-string))
5988                                 ":")
5989                         nil t))
5990                   (progn
5991                     ;; The header was found.  We insert a space after the
5992                     ;; colon, if there is none.
5993                     (if (/= (char-after) ? ) (insert " ") (forward-char 1))
5994                     ;; Find out whether the header is empty.
5995                     (looking-at "[ \t]*\n[^ \t]")))
5996           ;; So we find out what value we should insert.
5997           (setq value
5998                 (cond
5999                  ((and (consp elem)
6000                        (eq (car elem) 'optional)
6001                        (not (member header-string message-inserted-headers)))
6002                   ;; This is an optional header.  If the cdr of this
6003                   ;; is something that is nil, then we do not insert
6004                   ;; this header.
6005                   (setq header (cdr elem))
6006                   (or (and (functionp (cdr elem))
6007                            (funcall (cdr elem)))
6008                       (and (boundp (cdr elem))
6009                            (symbol-value (cdr elem)))))
6010                  ((consp elem)
6011                   ;; The element is a cons.  Either the cdr is a
6012                   ;; string to be inserted verbatim, or it is a
6013                   ;; function, and we insert the value returned from
6014                   ;; this function.
6015                   (or (and (stringp (cdr elem))
6016                            (cdr elem))
6017                       (and (functionp (cdr elem))
6018                            (funcall (cdr elem)))))
6019                  ((and (boundp header)
6020                        (symbol-value header))
6021                   ;; The element is a symbol.  We insert the value
6022                   ;; of this symbol, if any.
6023                   (symbol-value header))
6024                  ((not (message-check-element
6025                         (intern (downcase (symbol-name header)))))
6026                   ;; We couldn't generate a value for this header,
6027                   ;; so we just ask the user.
6028                   (read-from-minibuffer
6029                    (format "Empty header for %s; enter value: " header)))))
6030           ;; Finally insert the header.
6031           (when (and value
6032                      (not (equal value "")))
6033             (save-excursion
6034               (if (bolp)
6035                   (progn
6036                     ;; This header didn't exist, so we insert it.
6037                     (goto-char (point-max))
6038                     (let ((formatter
6039                            (cdr (assq header message-header-format-alist))))
6040                       (if formatter
6041                           (funcall formatter header value)
6042                         (insert header-string ": " value))
6043                       (push header-string message-inserted-headers)
6044                       (goto-char (message-fill-field))
6045                       ;; We check whether the value was ended by a
6046                       ;; newline.  If not, we insert one.
6047                       (unless (bolp)
6048                         (insert "\n"))
6049                       (forward-line -1)))
6050                 ;; The value of this header was empty, so we clear
6051                 ;; totally and insert the new value.
6052                 (delete-region (point) (point-at-eol))
6053                 ;; If the header is optional, and the header was
6054                 ;; empty, we can't insert it anyway.
6055                 (unless optionalp
6056                   (push header-string message-inserted-headers)
6057                   (insert value)
6058                   (message-fill-field)))
6059               ;; Add the deletable property to the headers that require it.
6060               (and (memq header message-deletable-headers)
6061                    (progn (beginning-of-line) (looking-at "[^:]+: "))
6062                    (add-text-properties
6063                     (point) (match-end 0)
6064                     '(message-deletable t face italic) (current-buffer)))))))
6065       ;; Insert new Sender if the From is strange.
6066       (let ((from (message-fetch-field "from"))
6067             (sender (message-fetch-field "sender"))
6068             (secure-sender (message-make-sender)))
6069         (when (and from
6070                    (not (message-check-element 'sender))
6071                    (not (string=
6072                          (downcase
6073                           (cadr (mail-extract-address-components from)))
6074                          (downcase secure-sender)))
6075                    (or (null sender)
6076                        (not
6077                         (string=
6078                          (downcase
6079                           (cadr (mail-extract-address-components sender)))
6080                          (downcase secure-sender)))))
6081           (goto-char (point-min))
6082           ;; Rename any old Sender headers to Original-Sender.
6083           (when (re-search-forward "^\\(Original-\\)*Sender:" nil t)
6084             (beginning-of-line)
6085             (insert "Original-")
6086             (beginning-of-line))
6087           (when (or (message-news-p)
6088                     (string-match "@.+\\.." secure-sender))
6089             (insert "Sender: " secure-sender "\n"))))
6090       ;; Check for IDNA
6091       (message-idna-to-ascii-rhs))))
6092
6093 (defun message-insert-courtesy-copy (message)
6094   "Insert a courtesy message in mail copies of combined messages."
6095   (let (newsgroups)
6096     (save-excursion
6097       (save-restriction
6098         (message-narrow-to-headers)
6099         (when (setq newsgroups (message-fetch-field "newsgroups"))
6100           (goto-char (point-max))
6101           (insert "Posted-To: " newsgroups "\n")))
6102       (forward-line 1)
6103       (when message
6104         (cond
6105          ((string-match "%s" message)
6106           (insert (format message newsgroups)))
6107          (t
6108           (insert message)))))))
6109
6110 ;;;
6111 ;;; Setting up a message buffer
6112 ;;;
6113
6114 (defun message-skip-to-next-address ()
6115   (let ((end (save-excursion
6116                (message-next-header)
6117                (point)))
6118         quoted char)
6119     (when (looking-at ",")
6120       (forward-char 1))
6121     (while (and (not (= (point) end))
6122                 (or (not (eq char ?,))
6123                     quoted))
6124       (skip-chars-forward "^,\"" (point-max))
6125       (when (eq (setq char (following-char)) ?\")
6126         (setq quoted (not quoted)))
6127       (unless (= (point) end)
6128         (forward-char 1)))
6129     (skip-chars-forward " \t\n")))
6130
6131 (defun message-fill-address (header value)
6132   (insert (capitalize (symbol-name header))
6133           ": "
6134           (if (consp value) (car value) value)
6135           "\n")
6136   (message-fill-field-address))
6137
6138 (defun message-split-line ()
6139   "Split current line, moving portion beyond point vertically down.
6140 If the current line has `message-yank-prefix', insert it on the new line."
6141   (interactive "*")
6142   (condition-case nil
6143       (split-line message-yank-prefix) ;; Emacs 22.1+ supports arg.
6144     (error
6145      (split-line))))
6146
6147 (defun message-insert-header (header value)
6148   (insert (capitalize (symbol-name header))
6149           ": "
6150           (if (consp value) (car value) value)))
6151
6152 (defun message-field-name ()
6153   (save-excursion
6154     (goto-char (point-min))
6155     (when (looking-at "\\([^:]+\\):")
6156       (intern (capitalize (match-string 1))))))
6157
6158 (defun message-fill-field ()
6159   (save-excursion
6160     (save-restriction
6161       (message-narrow-to-field)
6162       (let ((field-name (message-field-name)))
6163         (funcall (or (cadr (assq field-name message-field-fillers))
6164                      'message-fill-field-general)))
6165       (point-max))))
6166
6167 (defun message-fill-field-address ()
6168   (while (not (eobp))
6169     (message-skip-to-next-address)
6170     (let (last)
6171       (if (and (> (current-column) 78)
6172                last)
6173           (progn
6174             (save-excursion
6175               (goto-char last)
6176               (insert "\n\t"))
6177             (setq last (1+ (point))))
6178         (setq last (1+ (point)))))))
6179
6180 (defun message-fill-field-general ()
6181   (let ((begin (point))
6182         (fill-column 78)
6183         (fill-prefix "\t"))
6184     (while (and (search-forward "\n" nil t)
6185                 (not (eobp)))
6186       (replace-match " " t t))
6187     (fill-region-as-paragraph begin (point-max))
6188     ;; Tapdance around looong Message-IDs.
6189     (forward-line -1)
6190     (when (looking-at "[ \t]*$")
6191       (message-delete-line))
6192     (goto-char begin)
6193     (search-forward ":" nil t)
6194     (when (looking-at "\n[ \t]+")
6195       (replace-match " " t t))
6196     (goto-char (point-max))))
6197
6198 (defun message-shorten-1 (list cut surplus)
6199   "Cut SURPLUS elements out of LIST, beginning with CUTth one."
6200   (setcdr (nthcdr (- cut 2) list)
6201           (nthcdr (+ (- cut 2) surplus 1) list)))
6202
6203 (defun message-shorten-references (header references)
6204   "Trim REFERENCES to be 21 Message-ID long or less, and fold them.
6205 When sending via news, also check that the REFERENCES are less
6206 than 988 characters long, and if they are not, trim them until
6207 they are."
6208   ;; 21 is the number suggested by USEAGE.
6209   (let ((maxcount 21)
6210         (count 0)
6211         (cut 2)
6212         refs)
6213     (with-temp-buffer
6214       (insert references)
6215       (goto-char (point-min))
6216       ;; Cons a list of valid references.  GNKSA says we must not include MIDs
6217       ;; with whitespace or missing brackets (7.a "Does not propagate broken
6218       ;; Message-IDs in original References").
6219       (while (re-search-forward "<[^ <]+@[^ <]+>" nil t)
6220         (push (match-string 0) refs))
6221       (setq refs (nreverse refs)
6222             count (length refs)))
6223
6224     ;; If the list has more than MAXCOUNT elements, trim it by
6225     ;; removing the CUTth element and the required number of
6226     ;; elements that follow.
6227     (when (> count maxcount)
6228       (let ((surplus (- count maxcount)))
6229         (message-shorten-1 refs cut surplus)
6230         (decf count surplus)))
6231
6232     ;; When sending via news, make sure the total folded length will
6233     ;; be less than 998 characters.  This is to cater to broken INN
6234     ;; 2.3 which counts the total number of characters in a header
6235     ;; rather than the physical line length of each line, as it should.
6236     ;;
6237     ;; This hack should be removed when it's believed than INN 2.3 is
6238     ;; no longer widely used.
6239     ;;
6240     ;; At this point the headers have not been generated, thus we use
6241     ;; message-this-is-news directly.
6242     (when message-this-is-news
6243       (while (< 998
6244                 (with-temp-buffer
6245                   (message-insert-header
6246                    header (mapconcat #'identity refs " "))
6247                   (buffer-size)))
6248         (message-shorten-1 refs cut 1)))
6249     ;; Finally, collect the references back into a string and insert
6250     ;; it into the buffer.
6251     (message-insert-header header (mapconcat #'identity refs " "))))
6252
6253 (defun message-position-point ()
6254   "Move point to where the user probably wants to find it."
6255   (message-narrow-to-headers)
6256   (cond
6257    ((re-search-forward "^[^:]+:[ \t]*$" nil t)
6258     (search-backward ":" )
6259     (widen)
6260     (forward-char 1)
6261     (if (eq (char-after) ? )
6262         (forward-char 1)
6263       (insert " ")))
6264    (t
6265     (goto-char (point-max))
6266     (widen)
6267     (forward-line 1)
6268     (unless (looking-at "$")
6269       (forward-line 2)))
6270    (sit-for 0)))
6271
6272 (defcustom message-beginning-of-line t
6273   "Whether \\<message-mode-map>\\[message-beginning-of-line]\
6274  goes to beginning of header values."
6275   :version "22.1"
6276   :group 'message-buffers
6277   :link '(custom-manual "(message)Movement")
6278   :type 'boolean)
6279
6280 (defun message-beginning-of-line (&optional n)
6281   "Move point to beginning of header value or to beginning of line.
6282 The prefix argument N is passed directly to `beginning-of-line'.
6283
6284 This command is identical to `beginning-of-line' if point is
6285 outside the message header or if the option `message-beginning-of-line'
6286 is nil.
6287
6288 If point is in the message header and on a (non-continued) header
6289 line, move point to the beginning of the header value or the beginning of line,
6290 whichever is closer.  If point is already at beginning of line, move point to
6291 beginning of header value.  Therefore, repeated calls will toggle point
6292 between beginning of field and beginning of line."
6293   (interactive "p")
6294   (let ((zrs 'zmacs-region-stays))
6295     (when (and (featurep 'xemacs) (interactive-p) (boundp zrs))
6296       (set zrs t)))
6297   (if (and message-beginning-of-line
6298            (message-point-in-header-p))
6299       (let* ((here (point))
6300              (bol (progn (beginning-of-line n) (point)))
6301              (eol (point-at-eol))
6302              (eoh (re-search-forward ": *" eol t)))
6303         (goto-char
6304          (if (and eoh (or (< eoh here) (= bol here)))
6305              eoh bol)))
6306     (beginning-of-line n)))
6307
6308 (defun message-buffer-name (type &optional to group)
6309   "Return a new (unique) buffer name based on TYPE and TO."
6310   (cond
6311    ;; Generate a new buffer name The Message Way.
6312    ((memq message-generate-new-buffers '(unique t))
6313     (generate-new-buffer-name
6314      (concat "*" type
6315              (if to
6316                  (concat " to "
6317                          (or (car (mail-extract-address-components to))
6318                              to) "")
6319                "")
6320              (if (and group (not (string= group ""))) (concat " on " group) "")
6321              "*")))
6322    ;; Check whether `message-generate-new-buffers' is a function,
6323    ;; and if so, call it.
6324    ((functionp message-generate-new-buffers)
6325     (funcall message-generate-new-buffers type to group))
6326    ((eq message-generate-new-buffers 'unsent)
6327     (generate-new-buffer-name
6328      (concat "*unsent " type
6329              (if to
6330                  (concat " to "
6331                          (or (car (mail-extract-address-components to))
6332                              to) "")
6333                "")
6334              (if (and group (not (string= group ""))) (concat " on " group) "")
6335              "*")))
6336    ;; Search for the existing message buffer with the specified name.
6337    (t
6338     (let* ((new (if (eq message-generate-new-buffers 'standard)
6339                     (generate-new-buffer-name (concat "*" type " message*"))
6340                   (let ((message-generate-new-buffers 'unique))
6341                     (message-buffer-name type to group))))
6342            (regexp (concat "\\`"
6343                            (regexp-quote
6344                             (if (string-match "<[0-9]+>\\'" new)
6345                                 (substring new 0 (match-beginning 0))
6346                               new))
6347                            "\\(?:<\\([0-9]+\\)>\\)?\\'"))
6348            (case-fold-search nil))
6349       (or (cdar
6350            (last
6351             (sort
6352              (delq nil
6353                    (mapcar
6354                     (lambda (b)
6355                       (when (and (string-match regexp (setq b (buffer-name b)))
6356                                  (eq (with-current-buffer b major-mode)
6357                                      'message-mode))
6358                         (cons (string-to-number (or (match-string 1 b) "1"))
6359                               b)))
6360                     (buffer-list)))
6361              'car-less-than-car)))
6362           new)))))
6363
6364 (defun message-pop-to-buffer (name &optional switch-function)
6365   "Pop to buffer NAME, and warn if it already exists and is modified."
6366   (let ((buffer (get-buffer name)))
6367     (if (and buffer
6368              (buffer-name buffer))
6369         (let ((window (get-buffer-window buffer 0)))
6370           (if window
6371               ;; Raise the frame already displaying the message buffer.
6372               (progn
6373                 (gnus-select-frame-set-input-focus (window-frame window))
6374                 (select-window window))
6375             (funcall (or switch-function 'switch-to-buffer) buffer)
6376             (set-buffer buffer))
6377           (when (and (buffer-modified-p)
6378                      (not (prog1
6379                               (y-or-n-p
6380                                "Message already being composed; erase? ")
6381                             (message nil))))
6382             (error "Message being composed")))
6383       (funcall (or switch-function 'switch-to-buffer) name)
6384       (set-buffer name))
6385     (erase-buffer)
6386     (message-mode)))
6387
6388 (defun message-do-send-housekeeping ()
6389   "Kill old message buffers."
6390   ;; We might have sent this buffer already.  Delete it from the
6391   ;; list of buffers.
6392   (setq message-buffer-list (delq (current-buffer) message-buffer-list))
6393   (while (and message-max-buffers
6394               message-buffer-list
6395               (>= (length message-buffer-list) message-max-buffers))
6396     ;; Kill the oldest buffer -- unless it has been changed.
6397     (let ((buffer (pop message-buffer-list)))
6398       (when (and (buffer-name buffer)
6399                  (not (buffer-modified-p buffer)))
6400         (kill-buffer buffer))))
6401   ;; Rename the buffer.
6402   (if message-send-rename-function
6403       (funcall message-send-rename-function)
6404     ;; Note: mail-abbrevs of XEmacs renames buffer name behind Gnus.
6405     (when (string-match
6406            "\\`\\*\\(sent \\|unsent \\)?\\(.+\\)\\*[^\\*]*\\|\\`mail to "
6407            (buffer-name))
6408       (let ((name (match-string 2 (buffer-name)))
6409             to group)
6410         (if (not (or (null name)
6411                      (string-equal name "mail")
6412                      (string-equal name "posting")))
6413             (setq name (concat "*sent " name "*"))
6414           (message-narrow-to-headers)
6415           (setq to (message-fetch-field "to"))
6416           (setq group (message-fetch-field "newsgroups"))
6417           (widen)
6418           (setq name
6419                 (cond
6420                  (to (concat "*sent mail to "
6421                              (or (car (mail-extract-address-components to))
6422                                  to) "*"))
6423                  ((and group (not (string= group "")))
6424                   (concat "*sent posting on " group "*"))
6425                  (t "*sent mail*"))))
6426         (unless (string-equal name (buffer-name))
6427           (rename-buffer name t)))))
6428   ;; Push the current buffer onto the list.
6429   (when message-max-buffers
6430     (setq message-buffer-list
6431           (nconc message-buffer-list (list (current-buffer))))))
6432
6433 (defun message-mail-user-agent ()
6434   (let ((mua (cond
6435               ((not message-mail-user-agent) nil)
6436               ((eq message-mail-user-agent t) mail-user-agent)
6437               (t message-mail-user-agent))))
6438     (if (memq mua '(message-user-agent gnus-user-agent))
6439         nil
6440       mua)))
6441
6442 ;; YANK-ACTION, if non-nil, can be a buffer or a yank action of the
6443 ;; form (FUNCTION . ARGS).
6444 (defun message-setup (headers &optional yank-action actions
6445                               continue switch-function return-action)
6446   (let ((mua (message-mail-user-agent))
6447         subject to field)
6448     (if (not (and message-this-is-mail mua))
6449         (message-setup-1 headers yank-action actions return-action)
6450       (setq headers (copy-sequence headers))
6451       (setq field (assq 'Subject headers))
6452       (when field
6453         (setq subject (cdr field))
6454         (setq headers (delq field headers)))
6455       (setq field (assq 'To headers))
6456       (when field
6457         (setq to (cdr field))
6458         (setq headers (delq field headers)))
6459       (let ((mail-user-agent mua))
6460         (compose-mail to subject
6461                       (mapcar (lambda (item)
6462                                 (cons
6463                                  (format "%s" (car item))
6464                                  (cdr item)))
6465                               headers)
6466                       continue switch-function
6467                       (if (bufferp yank-action)
6468                           (list 'insert-buffer yank-action)
6469                         yank-action)
6470                       actions)))))
6471
6472 (defun message-headers-to-generate (headers included-headers excluded-headers)
6473   "Return a list that includes all headers from HEADERS.
6474 If INCLUDED-HEADERS is a list, just include those headers.  If it is
6475 t, include all headers.  In any case, headers from EXCLUDED-HEADERS
6476 are not included."
6477   (let ((result nil)
6478         header-name)
6479     (dolist (header headers)
6480       (setq header-name (cond
6481                          ((and (consp header)
6482                                (eq (car header) 'optional))
6483                           ;; On the form (optional . Header)
6484                           (cdr header))
6485                          ((consp header)
6486                           ;; On the form (Header . function)
6487                           (car header))
6488                          (t
6489                           ;; Just a Header.
6490                           header)))
6491       (when (and (not (memq header-name excluded-headers))
6492                  (or (eq included-headers t)
6493                      (memq header-name included-headers)))
6494         (push header result)))
6495     (nreverse result)))
6496
6497 (defun message-setup-1 (headers &optional yank-action actions return-action)
6498   (dolist (action actions)
6499     (condition-case nil
6500         (add-to-list 'message-send-actions
6501                      `(apply ',(car action) ',(cdr action)))))
6502   (setq message-return-action return-action)
6503   (setq message-reply-buffer
6504         (if (and (consp yank-action)
6505                  (eq (car yank-action) 'insert-buffer))
6506             (nth 1 yank-action)
6507           yank-action))
6508   (goto-char (point-min))
6509   ;; Insert all the headers.
6510   (mail-header-format
6511    (let ((h headers)
6512          (alist message-header-format-alist))
6513      (while h
6514        (unless (assq (caar h) message-header-format-alist)
6515          (push (list (caar h)) alist))
6516        (pop h))
6517      alist)
6518    headers)
6519   (delete-region (point) (progn (forward-line -1) (point)))
6520   (when message-default-headers
6521     (insert
6522      (if (functionp message-default-headers)
6523          (funcall message-default-headers)
6524        message-default-headers))
6525     (or (bolp) (insert ?\n)))
6526   (insert (concat mail-header-separator "\n"))
6527   (forward-line -1)
6528   ;; If a crash happens while replying, the auto-save file would *not* have a
6529   ;; `References:' header if `message-generate-headers-first' was nil.
6530   ;; Therefore, always generate it first.
6531   (let ((message-generate-headers-first
6532          (if (eq message-generate-headers-first t)
6533              t
6534            (append message-generate-headers-first '(References)))))
6535     (when (message-news-p)
6536       (when message-default-news-headers
6537         (insert message-default-news-headers)
6538         (or (bolp) (insert ?\n)))
6539       (message-generate-headers
6540        (message-headers-to-generate
6541         (append message-required-news-headers
6542                 message-required-headers)
6543         message-generate-headers-first
6544         '(Lines Subject))))
6545     (when (message-mail-p)
6546       (when message-default-mail-headers
6547         (insert message-default-mail-headers)
6548         (or (bolp) (insert ?\n)))
6549       (message-generate-headers
6550        (message-headers-to-generate
6551         (append message-required-mail-headers
6552                 message-required-headers)
6553         message-generate-headers-first
6554         '(Lines Subject)))))
6555   (run-hooks 'message-signature-setup-hook)
6556   (message-insert-signature)
6557   (save-restriction
6558     (message-narrow-to-headers)
6559     (run-hooks 'message-header-setup-hook))
6560   (setq buffer-undo-list nil)
6561   (when message-generate-hashcash
6562     ;; Generate hashcash headers for recipients already known
6563     (mail-add-payment-async))
6564   ;; Gnus posting styles are applied via buffer-local `message-setup-hook'
6565   ;; values.
6566   (run-hooks 'message-setup-hook)
6567   ;; Do this last to give it precedence over posting styles, etc.
6568   (when (message-mail-p)
6569     (save-restriction
6570       (message-narrow-to-headers)
6571       (if message-alternative-emails
6572           (message-use-alternative-email-as-from))))
6573   (message-position-point)
6574   ;; Allow correct handling of `message-checksum' in `message-yank-original':
6575   (set-buffer-modified-p nil)
6576   (undo-boundary)
6577   ;; rmail-start-mail expects message-mail to return t (Bug#9392)
6578   t)
6579
6580 (defun message-set-auto-save-file-name ()
6581   "Associate the message buffer with a file in the drafts directory."
6582   (when message-auto-save-directory
6583     (unless (file-directory-p
6584              (directory-file-name message-auto-save-directory))
6585       (make-directory message-auto-save-directory t))
6586     (if (gnus-alive-p)
6587         (setq message-draft-article
6588               (nndraft-request-associate-buffer "drafts"))
6589
6590       ;; If Gnus were alive, draft messages would be saved in the drafts folder.
6591       ;; But Gnus is not alive, so arrange to save the draft message in a
6592       ;; regular file in message-auto-save-directory.  Append a unique
6593       ;; time-based suffix to the filename to allow multiple drafts to be saved
6594       ;; simultaneously without overwriting each other (which mimics the
6595       ;; functionality of the Gnus drafts folder).
6596       (setq buffer-file-name (expand-file-name
6597                               (concat
6598                               (if (memq system-type
6599                                         '(ms-dos windows-nt cygwin))
6600                                   "message"
6601                                 "*message*")
6602                                (format-time-string "-%Y%m%d-%H%M%S"))
6603                               message-auto-save-directory))
6604       (setq buffer-auto-save-file-name (make-auto-save-file-name)))
6605     (clear-visited-file-modtime)
6606     (setq buffer-file-coding-system message-draft-coding-system)))
6607
6608 (defun message-disassociate-draft ()
6609   "Disassociate the message buffer from the drafts directory."
6610   (when message-draft-article
6611     (nndraft-request-expire-articles
6612      (list message-draft-article) "drafts" nil t)))
6613
6614 (defun message-insert-headers ()
6615   "Generate the headers for the article."
6616   (interactive)
6617   (save-excursion
6618     (save-restriction
6619       (message-narrow-to-headers)
6620       (when (message-news-p)
6621         (message-generate-headers
6622          (delq 'Lines
6623                (delq 'Subject
6624                      (copy-sequence message-required-news-headers)))))
6625       (when (message-mail-p)
6626         (message-generate-headers
6627          (delq 'Lines
6628                (delq 'Subject
6629                      (copy-sequence message-required-mail-headers))))))))
6630
6631 \f
6632
6633 ;;;
6634 ;;; Commands for interfacing with message
6635 ;;;
6636
6637 ;;;###autoload
6638 (defun message-mail (&optional to subject other-headers continue
6639                                switch-function yank-action send-actions
6640                                return-action &rest ignored)
6641   "Start editing a mail message to be sent.
6642 OTHER-HEADERS is an alist of header/value pairs.  CONTINUE says whether
6643 to continue editing a message already being composed.  SWITCH-FUNCTION
6644 is a function used to switch to and display the mail buffer."
6645   (interactive)
6646   (let ((message-this-is-mail t))
6647     (unless (message-mail-user-agent)
6648       (message-pop-to-buffer
6649        ;; Search for the existing message buffer if `continue' is non-nil.
6650        (let ((message-generate-new-buffers
6651               (when (or (not continue)
6652                         (eq message-generate-new-buffers 'standard)
6653                         (functionp message-generate-new-buffers))
6654                 message-generate-new-buffers)))
6655          (message-buffer-name "mail" to))
6656        switch-function))
6657     (message-setup
6658      (nconc
6659       `((To . ,(or to "")) (Subject . ,(or subject "")))
6660       ;; C-h f compose-mail says that headers should be specified as
6661       ;; (string . value); however all the rest of message expects
6662       ;; headers to be symbols, not strings (eg message-header-format-alist).
6663       ;; http://lists.gnu.org/archive/html/emacs-devel/2011-01/msg00337.html
6664       ;; We need to convert any string input, eg from rmail-start-mail.
6665       (dolist (h other-headers other-headers)
6666         (if (stringp (car h)) (setcar h (intern (capitalize (car h)))))))
6667      yank-action send-actions continue switch-function
6668      return-action)))
6669
6670 ;;;###autoload
6671 (defun message-news (&optional newsgroups subject)
6672   "Start editing a news article to be sent."
6673   (interactive)
6674   (let ((message-this-is-news t))
6675     (message-pop-to-buffer (message-buffer-name "posting" nil newsgroups))
6676     (message-setup `((Newsgroups . ,(or newsgroups ""))
6677                      (Subject . ,(or subject ""))))))
6678
6679 (defun message-alter-recipients-discard-bogus-full-name (addrcell)
6680   "Discard mail address in full names.
6681 When the full name in reply headers contains the mail
6682 address (e.g. \"foo@bar <foo@bar>\"), discard full name.
6683 ADDRCELL is a cons cell where the car is the mail address and the
6684 cdr is the complete address (full name and mail address)."
6685   (if (string-match (concat (regexp-quote (car addrcell)) ".*"
6686                             (regexp-quote (car addrcell)))
6687                     (cdr addrcell))
6688       (cons (car addrcell) (car addrcell))
6689     addrcell))
6690
6691 (defcustom message-alter-recipients-function nil
6692   "Function called to allow alteration of reply header structures.
6693 It is called in `message-get-reply-headers' for each recipient.
6694 The function is called with one parameter, a cons cell ..."
6695   :type '(choice (const :tag "None" nil)
6696                  (const :tag "Discard bogus full name"
6697                         message-alter-recipients-discard-bogus-full-name)
6698                  function)
6699   :version "23.1" ;; No Gnus
6700   :group 'message-headers)
6701
6702 (defun message-get-reply-headers (wide &optional to-address address-headers)
6703   (let (follow-to mct never-mct to cc author mft recipients extra)
6704     ;; Find all relevant headers we need.
6705     (save-restriction
6706       (message-narrow-to-headers-or-head)
6707       ;; Gmane renames "To".  Look at "Original-To", too, if it is present in
6708       ;; message-header-synonyms.
6709       (setq to (or (message-fetch-field "to")
6710                    (and (loop for synonym in message-header-synonyms
6711                               when (memq 'Original-To synonym)
6712                               return t)
6713                         (message-fetch-field "original-to")))
6714             cc (message-fetch-field "cc")
6715             extra (when message-extra-wide-headers
6716                     (mapconcat 'identity
6717                                (mapcar 'message-fetch-field
6718                                        message-extra-wide-headers)
6719                                ", "))
6720             mct (message-fetch-field "mail-copies-to")
6721             author (or (message-fetch-field "mail-reply-to")
6722                        (message-fetch-field "reply-to")
6723                        (message-fetch-field "from")
6724                        "")
6725             mft (and message-use-mail-followup-to
6726                      (message-fetch-field "mail-followup-to"))))
6727
6728     ;; Handle special values of Mail-Copies-To.
6729     (when mct
6730       (cond ((or (equal (downcase mct) "never")
6731                  (equal (downcase mct) "nobody"))
6732              (setq never-mct t)
6733              (setq mct nil))
6734             ((or (equal (downcase mct) "always")
6735                  (equal (downcase mct) "poster"))
6736              (setq mct author))))
6737
6738     (save-match-data
6739       ;; Build (textual) list of new recipient addresses.
6740       (cond
6741        (to-address
6742         (setq recipients (concat ", " to-address))
6743         ;; If the author explicitly asked for a copy, we don't deny it to them.
6744         (if mct (setq recipients (concat recipients ", " mct))))
6745        ((not wide)
6746         (setq recipients (concat ", " author)))
6747        (address-headers
6748         (dolist (header address-headers)
6749           (let ((value (message-fetch-field header)))
6750             (when value
6751               (setq recipients (concat recipients ", " value))))))
6752        ((and mft
6753              (string-match "[^ \t,]" mft)
6754              (or (not (eq message-use-mail-followup-to 'ask))
6755                  (message-y-or-n-p "Obey Mail-Followup-To? " t "\
6756 You should normally obey the Mail-Followup-To: header.  In this
6757 article, it has the value of
6758
6759 " mft "
6760
6761 which directs your response to " (if (string-match "," mft)
6762                                      "the specified addresses"
6763                                    "that address only") ".
6764
6765 Most commonly, Mail-Followup-To is used by a mailing list poster to
6766 express that responses should be sent to just the list, and not the
6767 poster as well.
6768
6769 If a message is posted to several mailing lists, Mail-Followup-To may
6770 also be used to direct the following discussion to one list only,
6771 because discussions that are spread over several lists tend to be
6772 fragmented and very difficult to follow.
6773
6774 Also, some source/announcement lists are not intended for discussion;
6775 responses here are directed to other addresses.
6776
6777 You may customize the variable `message-use-mail-followup-to', if you
6778 want to get rid of this query permanently.")))
6779         (setq recipients (concat ", " mft)))
6780        (t
6781         (setq recipients (if never-mct "" (concat ", " author)))
6782         (if to (setq recipients (concat recipients ", " to)))
6783         (if cc (setq recipients (concat recipients ", " cc)))
6784         (if extra (setq recipients (concat recipients ", " extra)))
6785         (if mct (setq recipients (concat recipients ", " mct)))))
6786       (if (>= (length recipients) 2)
6787           ;; Strip the leading ", ".
6788           (setq recipients (substring recipients 2)))
6789       ;; Squeeze whitespace.
6790       (while (string-match "[ \t][ \t]+" recipients)
6791         (setq recipients (replace-match " " t t recipients)))
6792       ;; Remove addresses that match `rmail-dont-reply-to-names'.
6793       (let ((rmail-dont-reply-to-names (message-dont-reply-to-names)))
6794         (setq recipients (rmail-dont-reply-to recipients)))
6795       ;; Perhaps "Mail-Copies-To: never" removed the only address?
6796       (if (string-equal recipients "")
6797           (setq recipients author))
6798       ;; Convert string to a list of (("foo@bar" . "Name <Foo@BAR>") ...).
6799       (setq recipients
6800             (mapcar
6801              (lambda (addr)
6802                (if message-alter-recipients-function
6803                    (funcall message-alter-recipients-function
6804                             (cons (downcase (mail-strip-quoted-names addr))
6805                                   addr))
6806                  (cons (downcase (mail-strip-quoted-names addr)) addr)))
6807              (message-tokenize-header recipients)))
6808       ;; Remove all duplicates.
6809       (let ((s recipients))
6810         (while s
6811           (let ((address (car (pop s))))
6812             (while (assoc address s)
6813               (setq recipients (delq (assoc address s) recipients)
6814                     s (delq (assoc address s) s))))))
6815
6816       ;; Remove hierarchical lists that are contained within each other,
6817       ;; if message-hierarchical-addresses is defined.
6818       (when message-hierarchical-addresses
6819         (let ((plain-addrs (mapcar 'car recipients))
6820               subaddrs recip)
6821           (while plain-addrs
6822             (setq subaddrs (assoc (car plain-addrs)
6823                                   message-hierarchical-addresses)
6824                   plain-addrs (cdr plain-addrs))
6825             (when subaddrs
6826               (setq subaddrs (cdr subaddrs))
6827               (while subaddrs
6828                 (setq recip (assoc (car subaddrs) recipients)
6829                       subaddrs (cdr subaddrs))
6830                 (if recip
6831                     (setq recipients (delq recip recipients))))))))
6832
6833       (setq recipients (message-prune-recipients recipients))
6834
6835       ;; Build the header alist.  Allow the user to be asked whether
6836       ;; or not to reply to all recipients in a wide reply.
6837       (setq follow-to (list (cons 'To (cdr (pop recipients)))))
6838       (when (and recipients
6839                  (or (not message-wide-reply-confirm-recipients)
6840                      (y-or-n-p "Reply to all recipients? ")))
6841         (setq recipients (mapconcat
6842                           (lambda (addr) (cdr addr)) recipients ", "))
6843         (if (string-match "^ +" recipients)
6844             (setq recipients (substring recipients (match-end 0))))
6845         (push (cons 'Cc recipients) follow-to)))
6846     follow-to))
6847
6848 (defun message-prune-recipients (recipients)
6849   (dolist (rule message-prune-recipient-rules)
6850     (let ((match (car rule))
6851           dup-match
6852           address)
6853       (dolist (recipient recipients)
6854         (setq address (car recipient))
6855         (when (string-match match address)
6856           (setq dup-match (replace-match (cadr rule) nil nil address))
6857           (dolist (recipient recipients)
6858             ;; Don't delete the address that triggered this.
6859             (when (and (not (eq address (car recipient)))
6860                        (string-match dup-match (car recipient)))
6861               (setq recipients (delq recipient recipients))))))))
6862   recipients)
6863
6864 (defcustom message-simplify-subject-functions
6865   '(message-strip-list-identifiers
6866     message-strip-subject-re
6867     message-strip-subject-trailing-was
6868     message-strip-subject-encoded-words)
6869   "List of functions taking a string argument that simplify subjects.
6870 The functions are applied when replying to a message.
6871
6872 Useful functions to put in this list include:
6873 `message-strip-list-identifiers', `message-strip-subject-re',
6874 `message-strip-subject-trailing-was', and
6875 `message-strip-subject-encoded-words'."
6876   :version "22.1" ;; Gnus 5.10.9
6877   :group 'message-various
6878   :type '(repeat function))
6879
6880 (defun message-simplify-subject (subject &optional functions)
6881   "Return simplified SUBJECT."
6882   (unless functions
6883     ;; Simplify fully:
6884     (setq functions message-simplify-subject-functions))
6885   (when (and (memq 'message-strip-list-identifiers functions)
6886              gnus-list-identifiers)
6887     (setq subject (message-strip-list-identifiers subject)))
6888   (when (memq 'message-strip-subject-re functions)
6889     (setq subject (concat "Re: " (message-strip-subject-re subject))))
6890   (when (and (memq 'message-strip-subject-trailing-was functions)
6891              message-subject-trailing-was-query)
6892     (setq subject (message-strip-subject-trailing-was subject)))
6893   (when (memq 'message-strip-subject-encoded-words functions)
6894     (setq subject (message-strip-subject-encoded-words subject)))
6895   subject)
6896
6897 ;;;###autoload
6898 (defun message-reply (&optional to-address wide switch-function)
6899   "Start editing a reply to the article in the current buffer."
6900   (interactive)
6901   (require 'gnus-sum)                   ; for gnus-list-identifiers
6902   (let ((cur (current-buffer))
6903         from subject date
6904         references message-id follow-to
6905         (inhibit-point-motion-hooks t)
6906         (message-this-is-mail t)
6907         gnus-warning)
6908     (save-restriction
6909       (message-narrow-to-head-1)
6910       ;; Allow customizations to have their say.
6911       (if (not wide)
6912           ;; This is a regular reply.
6913           (when (functionp message-reply-to-function)
6914             (save-excursion
6915               (setq follow-to (funcall message-reply-to-function))))
6916         ;; This is a followup.
6917         (when (functionp message-wide-reply-to-function)
6918           (save-excursion
6919             (setq follow-to
6920                   (funcall message-wide-reply-to-function)))))
6921       (setq message-id (message-fetch-field "message-id" t)
6922             references (message-fetch-field "references")
6923             date (message-fetch-field "date")
6924             from (or (message-fetch-field "from") "nobody")
6925             subject (or (message-fetch-field "subject") "none"))
6926
6927       ;; Strip list identifiers, "Re: ", and "was:"
6928       (setq subject (message-simplify-subject subject))
6929
6930       (when (and (setq gnus-warning (message-fetch-field "gnus-warning"))
6931                  (string-match "<[^>]+>" gnus-warning))
6932         (setq message-id (match-string 0 gnus-warning)))
6933
6934       (unless follow-to
6935         (setq follow-to (message-get-reply-headers wide to-address))))
6936
6937     (let ((headers
6938            `((Subject . ,subject)
6939              ,@follow-to)))
6940       (unless (message-mail-user-agent)
6941         (message-pop-to-buffer
6942          (message-buffer-name
6943           (if wide "wide reply" "reply") from
6944           (if wide to-address nil))
6945          switch-function))
6946       (setq message-reply-headers
6947             (vector 0 (cdr (assq 'Subject headers))
6948                     from date message-id references 0 0 ""))
6949       (message-setup headers cur))))
6950
6951 ;;;###autoload
6952 (defun message-wide-reply (&optional to-address)
6953   "Make a \"wide\" reply to the message in the current buffer."
6954   (interactive)
6955   (message-reply to-address t))
6956
6957 ;;;###autoload
6958 (defun message-followup (&optional to-newsgroups)
6959   "Follow up to the message in the current buffer.
6960 If TO-NEWSGROUPS, use that as the new Newsgroups line."
6961   (interactive)
6962   (require 'gnus-sum)                   ; for gnus-list-identifiers
6963   (let ((cur (current-buffer))
6964         from subject date reply-to mrt mct
6965         references message-id follow-to
6966         (inhibit-point-motion-hooks t)
6967         (message-this-is-news t)
6968         followup-to distribution newsgroups gnus-warning posted-to)
6969     (save-restriction
6970       (narrow-to-region
6971        (goto-char (point-min))
6972        (if (search-forward "\n\n" nil t)
6973            (1- (point))
6974          (point-max)))
6975       (when (functionp message-followup-to-function)
6976         (setq follow-to
6977               (funcall message-followup-to-function)))
6978       (setq from (message-fetch-field "from")
6979             date (message-fetch-field "date")
6980             subject (or (message-fetch-field "subject") "none")
6981             references (message-fetch-field "references")
6982             message-id (message-fetch-field "message-id" t)
6983             followup-to (message-fetch-field "followup-to")
6984             newsgroups (message-fetch-field "newsgroups")
6985             posted-to (message-fetch-field "posted-to")
6986             reply-to (message-fetch-field "reply-to")
6987             mrt (message-fetch-field "mail-reply-to")
6988             distribution (message-fetch-field "distribution")
6989             mct (message-fetch-field "mail-copies-to"))
6990       (when (and (setq gnus-warning (message-fetch-field "gnus-warning"))
6991                  (string-match "<[^>]+>" gnus-warning))
6992         (setq message-id (match-string 0 gnus-warning)))
6993       ;; Remove bogus distribution.
6994       (when (and (stringp distribution)
6995                  (let ((case-fold-search t))
6996                    (string-match "world" distribution)))
6997         (setq distribution nil))
6998       ;; Strip list identifiers, "Re: ", and "was:"
6999       (setq subject (message-simplify-subject subject))
7000       (widen))
7001
7002     (message-pop-to-buffer (message-buffer-name "followup" from newsgroups))
7003
7004     (setq message-reply-headers
7005           (vector 0 subject from date message-id references 0 0 ""))
7006
7007     (message-setup
7008      `((Subject . ,subject)
7009        ,@(cond
7010           (to-newsgroups
7011            (list (cons 'Newsgroups to-newsgroups)))
7012           (follow-to follow-to)
7013           ((and followup-to message-use-followup-to)
7014            (list
7015             (cond
7016              ((equal (downcase followup-to) "poster")
7017               (if (or (eq message-use-followup-to 'use)
7018                       (message-y-or-n-p "Obey Followup-To: poster? " t "\
7019 You should normally obey the Followup-To: header.
7020
7021 `Followup-To: poster' sends your response via e-mail instead of news.
7022
7023 A typical situation where `Followup-To: poster' is used is when the poster
7024 does not read the newsgroup, so he wouldn't see any replies sent to it.
7025
7026 You may customize the variable `message-use-followup-to', if you
7027 want to get rid of this query permanently."))
7028                   (progn
7029                     (setq message-this-is-news nil)
7030                     (cons 'To (or mrt reply-to from "")))
7031                 (cons 'Newsgroups newsgroups)))
7032              (t
7033               (if (or (equal followup-to newsgroups)
7034                       (not (eq message-use-followup-to 'ask))
7035                       (message-y-or-n-p
7036                        (concat "Obey Followup-To: " followup-to "? ") t "\
7037 You should normally obey the Followup-To: header.
7038
7039         `Followup-To: " followup-to "'
7040 directs your response to " (if (string-match "," followup-to)
7041                                "the specified newsgroups"
7042                              "that newsgroup only") ".
7043
7044 If a message is posted to several newsgroups, Followup-To is often
7045 used to direct the following discussion to one newsgroup only,
7046 because discussions that are spread over several newsgroup tend to
7047 be fragmented and very difficult to follow.
7048
7049 Also, some source/announcement newsgroups are not intended for discussion;
7050 responses here are directed to other newsgroups.
7051
7052 You may customize the variable `message-use-followup-to', if you
7053 want to get rid of this query permanently."))
7054                   (cons 'Newsgroups followup-to)
7055                 (cons 'Newsgroups newsgroups))))))
7056           (posted-to
7057            `((Newsgroups . ,posted-to)))
7058           (t
7059            `((Newsgroups . ,newsgroups))))
7060        ,@(and distribution (list (cons 'Distribution distribution)))
7061        ,@(when (and mct
7062                     (not (or (equal (downcase mct) "never")
7063                              (equal (downcase mct) "nobody"))))
7064            (list (cons 'Cc (if (or (equal (downcase mct) "always")
7065                                    (equal (downcase mct) "poster"))
7066                                (or mrt reply-to from "")
7067                              mct)))))
7068
7069      cur)))
7070
7071 (defun message-is-yours-p ()
7072   "Non-nil means current article is yours.
7073 If you have added 'cancel-messages to `message-shoot-gnksa-feet', all articles
7074 are yours except those that have Cancel-Lock header not belonging to you.
7075 Instead of shooting GNKSA feet, you should modify `message-alternative-emails'
7076 regexp to match all of yours addresses."
7077   ;; Canlock-logic as suggested by Per Abrahamsen
7078   ;; <abraham@dina.kvl.dk>
7079   ;;
7080   ;; IF article has cancel-lock THEN
7081   ;;   IF we can verify it THEN
7082   ;;     issue cancel
7083   ;;   ELSE
7084   ;;     error: cancellock: article is not yours
7085   ;; ELSE
7086   ;;   Use old rules, comparing sender...
7087   (save-excursion
7088     (save-restriction
7089       (message-narrow-to-head-1)
7090       (if (and (message-fetch-field "Cancel-Lock")
7091                (message-gnksa-enable-p 'canlock-verify))
7092           (if (null (canlock-verify))
7093               t
7094             (error "Failed to verify Cancel-lock: This article is not yours"))
7095         (let (sender from)
7096           (or
7097            (message-gnksa-enable-p 'cancel-messages)
7098            (and (setq sender (message-fetch-field "sender"))
7099                 (string-equal (downcase sender)
7100                               (downcase (message-make-sender))))
7101            ;; Email address in From field equals to our address
7102            (and (setq from (message-fetch-field "from"))
7103                 (string-equal
7104                  (downcase (car (mail-header-parse-address from)))
7105                  (downcase (car (mail-header-parse-address
7106                                  (message-make-from))))))
7107            ;; Email address in From field matches
7108            ;; 'message-alternative-emails' regexp
7109            (and from
7110                 message-alternative-emails
7111                 (string-match
7112                  message-alternative-emails
7113                  (car (mail-header-parse-address from))))))))))
7114
7115 ;;;###autoload
7116 (defun message-cancel-news (&optional arg)
7117   "Cancel an article you posted.
7118 If ARG, allow editing of the cancellation message."
7119   (interactive "P")
7120   (unless (message-news-p)
7121     (error "This is not a news article; canceling is impossible"))
7122   (let (from newsgroups message-id distribution buf)
7123     (save-excursion
7124       ;; Get header info from original article.
7125       (save-restriction
7126         (message-narrow-to-head-1)
7127         (setq from (message-fetch-field "from")
7128               newsgroups (message-fetch-field "newsgroups")
7129               message-id (message-fetch-field "message-id" t)
7130               distribution (message-fetch-field "distribution")))
7131       ;; Make sure that this article was written by the user.
7132       (unless (message-is-yours-p)
7133         (error "This article is not yours"))
7134       (when (yes-or-no-p "Do you really want to cancel this article? ")
7135         ;; Make control message.
7136         (if arg
7137             (message-news)
7138           (setq buf (set-buffer (get-buffer-create " *message cancel*"))))
7139         (erase-buffer)
7140         (insert "Newsgroups: " newsgroups "\n"
7141                 "From: " from "\n"
7142                 "Subject: cmsg cancel " message-id "\n"
7143                 "Control: cancel " message-id "\n"
7144                 (if distribution
7145                     (concat "Distribution: " distribution "\n")
7146                   "")
7147                 mail-header-separator "\n"
7148                 message-cancel-message)
7149         (run-hooks 'message-cancel-hook)
7150         (unless arg
7151           (message "Canceling your article...")
7152           (if (let ((message-syntax-checks
7153                      'dont-check-for-anything-just-trust-me))
7154                 (funcall message-send-news-function))
7155               (message "Canceling your article...done"))
7156           (kill-buffer buf))))))
7157
7158 ;;;###autoload
7159 (defun message-supersede ()
7160   "Start composing a message to supersede the current message.
7161 This is done simply by taking the old article and adding a Supersedes
7162 header line with the old Message-ID."
7163   (interactive)
7164   (let ((cur (current-buffer)))
7165     ;; Check whether the user owns the article that is to be superseded.
7166     (unless (message-is-yours-p)
7167       (error "This article is not yours"))
7168     ;; Get a normal message buffer.
7169     (message-pop-to-buffer (message-buffer-name "supersede"))
7170     (insert-buffer-substring cur)
7171     (mime-to-mml)
7172     (message-narrow-to-head-1)
7173     ;; Remove unwanted headers.
7174     (when message-ignored-supersedes-headers
7175       (message-remove-header message-ignored-supersedes-headers t))
7176     (goto-char (point-min))
7177     (if (not (re-search-forward "^Message-ID: " nil t))
7178         (error "No Message-ID in this article")
7179       (replace-match "Supersedes: " t t))
7180     (goto-char (point-max))
7181     (insert mail-header-separator)
7182     (widen)
7183     (forward-line 1)))
7184
7185 ;;;###autoload
7186 (defun message-recover ()
7187   "Reread contents of current buffer from its last auto-save file."
7188   (interactive)
7189   (let ((file-name (make-auto-save-file-name)))
7190     (cond ((save-window-excursion
7191              (with-output-to-temp-buffer "*Directory*"
7192                (with-current-buffer standard-output
7193                  (fundamental-mode))    ; for Emacs 20.4+
7194                (buffer-disable-undo standard-output)
7195                (let ((default-directory "/"))
7196                  (call-process
7197                   "ls" nil standard-output nil "-l" file-name)))
7198              (yes-or-no-p (format "Recover auto save file %s? " file-name)))
7199            (let ((buffer-read-only nil))
7200              (erase-buffer)
7201              (insert-file-contents file-name nil)))
7202           (t (error "message-recover cancelled")))))
7203
7204 ;;; Washing Subject:
7205
7206 (defun message-wash-subject (subject)
7207   "Remove junk like \"Re:\", \"(fwd)\", etc. added to subject string SUBJECT.
7208 Previous forwarders, replyers, etc. may add it."
7209   (with-temp-buffer
7210     (insert subject)
7211     (goto-char (point-min))
7212     ;; strip Re/Fwd stuff off the beginning
7213     (while (re-search-forward
7214             "\\([Rr][Ee]:\\|[Ff][Ww][Dd]\\(\\[[0-9]*\\]\\)?:\\|[Ff][Ww]:\\)" nil t)
7215       (replace-match ""))
7216
7217     ;; and gnus-style forwards [foo@bar.com] subject
7218     (goto-char (point-min))
7219     (while (re-search-forward "\\[[^ \t]*\\(@\\|\\.\\)[^ \t]*\\]" nil t)
7220       (replace-match ""))
7221
7222     ;; and off the end
7223     (goto-char (point-max))
7224     (while (re-search-backward "([Ff][Ww][Dd])" nil t)
7225       (replace-match ""))
7226
7227     ;; and finally, any whitespace that was left-over
7228     (goto-char (point-min))
7229     (while (re-search-forward "^[ \t]+" nil t)
7230       (replace-match ""))
7231     (goto-char (point-max))
7232     (while (re-search-backward "[ \t]+$" nil t)
7233       (replace-match ""))
7234
7235     (buffer-string)))
7236
7237 ;;; Forwarding messages.
7238
7239 (defvar message-forward-decoded-p nil
7240   "Non-nil means the original message is decoded.")
7241
7242 (defun message-forward-subject-name-subject (subject)
7243   "Generate a SUBJECT for a forwarded message.
7244 The form is: [Source] Subject, where if the original message was mail,
7245 Source is the name of the sender, and if the original message was
7246 news, Source is the list of newsgroups is was posted to."
7247   (let* ((group (message-fetch-field "newsgroups"))
7248          (from (message-fetch-field "from"))
7249          (prefix
7250           (if group
7251               (gnus-group-decoded-name group)
7252             (or (and from (or
7253                            (car (gnus-extract-address-components from))
7254                            (cadr (gnus-extract-address-components from))))
7255                 "(nowhere)"))))
7256     (concat "["
7257             (if message-forward-decoded-p
7258                 prefix
7259               (mail-decode-encoded-word-string prefix))
7260             "] " subject)))
7261
7262 (defun message-forward-subject-author-subject (subject)
7263   "Generate a SUBJECT for a forwarded message.
7264 The form is: [Source] Subject, where if the original message was mail,
7265 Source is the sender, and if the original message was news, Source is
7266 the list of newsgroups is was posted to."
7267   (let* ((group (message-fetch-field "newsgroups"))
7268          (prefix
7269           (if group
7270               (gnus-group-decoded-name group)
7271             (or (message-fetch-field "from")
7272                 "(nowhere)"))))
7273     (concat "["
7274             (if message-forward-decoded-p
7275                 prefix
7276               (mail-decode-encoded-word-string prefix))
7277             "] " subject)))
7278
7279 (defun message-forward-subject-fwd (subject)
7280   "Generate a SUBJECT for a forwarded message.
7281 The form is: Fwd: Subject, where Subject is the original subject of
7282 the message."
7283   (if (string-match "^Fwd: " subject)
7284       subject
7285     (concat "Fwd: " subject)))
7286
7287 (defun message-make-forward-subject ()
7288   "Return a Subject header suitable for the message in the current buffer."
7289   (save-excursion
7290     (save-restriction
7291       (message-narrow-to-head-1)
7292       (let ((funcs message-make-forward-subject-function)
7293             (subject (message-fetch-field "Subject")))
7294         (setq subject
7295               (if subject
7296                   (if message-forward-decoded-p
7297                       subject
7298                     (mail-decode-encoded-word-string subject))
7299                 ""))
7300         (when message-wash-forwarded-subjects
7301           (setq subject (message-wash-subject subject)))
7302         ;; Make sure funcs is a list.
7303         (and funcs
7304              (not (listp funcs))
7305              (setq funcs (list funcs)))
7306         ;; Apply funcs in order, passing subject generated by previous
7307         ;; func to the next one.
7308         (dolist (func funcs)
7309           (when (functionp func)
7310             (setq subject (funcall func subject))))
7311         subject))))
7312
7313 (defvar gnus-article-decoded-p)
7314
7315
7316 ;;;###autoload
7317 (defun message-forward (&optional news digest)
7318   "Forward the current message via mail.
7319 Optional NEWS will use news to forward instead of mail.
7320 Optional DIGEST will use digest to forward."
7321   (interactive "P")
7322   (let* ((cur (current-buffer))
7323          (message-forward-decoded-p
7324           (if (local-variable-p 'gnus-article-decoded-p (current-buffer))
7325               gnus-article-decoded-p ;; In an article buffer.
7326             message-forward-decoded-p))
7327          (subject (message-make-forward-subject)))
7328     (if news
7329         (message-news nil subject)
7330       (message-mail nil subject))
7331     (message-forward-make-body cur digest)))
7332
7333 (defun message-forward-make-body-plain (forward-buffer)
7334   (insert
7335    "\n-------------------- Start of forwarded message --------------------\n")
7336   (let ((b (point))
7337         (contents (with-current-buffer forward-buffer (buffer-string)))
7338         e)
7339     (unless (featurep 'xemacs)
7340       (unless (mm-multibyte-string-p contents)
7341         (error "Attempt to insert unibyte string from the buffer \"%s\"\
7342  to the multibyte buffer \"%s\""
7343                (if (bufferp forward-buffer)
7344                    (buffer-name forward-buffer)
7345                  forward-buffer)
7346                (buffer-name))))
7347     (insert (mm-with-multibyte-buffer
7348               (insert contents)
7349               (mime-to-mml)
7350               (goto-char (point-min))
7351               (when (looking-at "From ")
7352                 (replace-match "X-From-Line: "))
7353               (buffer-string)))
7354     (unless (bolp) (insert "\n"))
7355     (setq e (point))
7356     (insert
7357      "-------------------- End of forwarded message --------------------\n")
7358     (message-remove-ignored-headers b e)))
7359
7360 (defun message-remove-ignored-headers (b e)
7361   (when message-forward-ignored-headers
7362     (save-restriction
7363       (narrow-to-region b e)
7364       (goto-char b)
7365       (narrow-to-region (point)
7366                         (or (search-forward "\n\n" nil t) (point)))
7367       (let ((ignored (if (stringp message-forward-ignored-headers)
7368                          (list message-forward-ignored-headers)
7369                        message-forward-ignored-headers)))
7370         (dolist (elem ignored)
7371           (message-remove-header elem t))))))
7372
7373 (defun message-forward-make-body-mime (forward-buffer)
7374   (let ((b (point)))
7375     (insert "\n\n<#part type=message/rfc822 disposition=inline raw=t>\n")
7376     (save-restriction
7377       (narrow-to-region (point) (point))
7378       (mml-insert-buffer forward-buffer)
7379       (goto-char (point-min))
7380       (when (looking-at "From ")
7381         (replace-match "X-From-Line: "))
7382       (goto-char (point-max)))
7383     (insert "<#/part>\n")
7384     ;; Consider there is no illegible text.
7385     (add-text-properties
7386      b (point)
7387      `(no-illegible-text t rear-nonsticky t start-open t))))
7388
7389 (defun message-forward-make-body-mml (forward-buffer)
7390   (insert "\n\n<#mml type=message/rfc822 disposition=inline>\n")
7391   (let ((b (point)) e)
7392     (if (not message-forward-decoded-p)
7393         (let ((contents (with-current-buffer forward-buffer (buffer-string))))
7394           (unless (featurep 'xemacs)
7395             (unless (mm-multibyte-string-p contents)
7396               (error "Attempt to insert unibyte string from the buffer \"%s\"\
7397  to the multibyte buffer \"%s\""
7398                      (if (bufferp forward-buffer)
7399                          (buffer-name forward-buffer)
7400                        forward-buffer)
7401                      (buffer-name))))
7402           (insert (mm-with-multibyte-buffer
7403                     (insert contents)
7404                     (mime-to-mml)
7405                     (goto-char (point-min))
7406                     (when (looking-at "From ")
7407                       (replace-match "X-From-Line: "))
7408                     (buffer-string))))
7409       (save-restriction
7410         (narrow-to-region (point) (point))
7411         (mml-insert-buffer forward-buffer)
7412         (goto-char (point-min))
7413         (when (looking-at "From ")
7414           (replace-match "X-From-Line: "))
7415         (goto-char (point-max))))
7416     (setq e (point))
7417     (insert "<#/mml>\n")
7418     (when (and (not message-forward-decoded-p)
7419                message-forward-ignored-headers)
7420       (message-remove-ignored-headers b e))))
7421
7422 (defun message-forward-make-body-digest-plain (forward-buffer)
7423   (insert
7424    "\n-------------------- Start of forwarded message --------------------\n")
7425   (mml-insert-buffer forward-buffer)
7426   (insert
7427    "\n-------------------- End of forwarded message --------------------\n"))
7428
7429 (defun message-forward-make-body-digest-mime (forward-buffer)
7430   (insert "\n<#multipart type=digest>\n")
7431   (let ((b (point)) e)
7432     (insert-buffer-substring forward-buffer)
7433     (setq e (point))
7434     (insert "<#/multipart>\n")
7435     (save-restriction
7436       (narrow-to-region b e)
7437       (goto-char b)
7438       (narrow-to-region (point)
7439                         (or (search-forward "\n\n" nil t) (point)))
7440       (delete-region (point-min) (point-max)))))
7441
7442 (defun message-forward-make-body-digest (forward-buffer)
7443   (if message-forward-as-mime
7444       (message-forward-make-body-digest-mime forward-buffer)
7445     (message-forward-make-body-digest-plain forward-buffer)))
7446
7447 (autoload 'mm-uu-dissect-text-parts "mm-uu")
7448 (autoload 'mm-uu-dissect "mm-uu")
7449
7450 (defun message-signed-or-encrypted-p (&optional dont-emulate-mime handles)
7451   "Say whether the current buffer contains signed or encrypted message.
7452 If DONT-EMULATE-MIME is nil, this function does the MIME emulation on
7453 messages that don't conform to PGP/MIME described in RFC2015.  HANDLES
7454 is for the internal use."
7455   (unless handles
7456     (let ((mm-decrypt-option 'never)
7457           (mm-verify-option 'never))
7458       (if (setq handles (mm-dissect-buffer nil t))
7459           (unless dont-emulate-mime
7460             (mm-uu-dissect-text-parts handles))
7461         (unless dont-emulate-mime
7462           (setq handles (mm-uu-dissect))))))
7463   ;; Check text/plain message in which there is a signed or encrypted
7464   ;; body that has been encoded by B or Q.
7465   (unless (or handles dont-emulate-mime)
7466     (let ((cur (current-buffer))
7467           (mm-decrypt-option 'never)
7468           (mm-verify-option 'never))
7469       (with-temp-buffer
7470         (insert-buffer-substring cur)
7471         (when (setq handles (mm-dissect-buffer t t))
7472           (if (and (prog1
7473                        (bufferp (car handles))
7474                      (mm-destroy-parts handles))
7475                    (equal (mm-handle-media-type handles) "text/plain"))
7476               (progn
7477                 (mm-decode-content-transfer-encoding
7478                  (mm-handle-encoding handles))
7479                 (setq handles (mm-uu-dissect)))
7480             (setq handles nil))))))
7481   (when handles
7482     (prog1
7483         (catch 'found
7484           (dolist (handle (if (stringp (car handles))
7485                               (if (member (car handles)
7486                                           '("multipart/signed"
7487                                             "multipart/encrypted"))
7488                                   (throw 'found t)
7489                                 (cdr handles))
7490                             (list handles)))
7491             (if (stringp (car handle))
7492                 (when (message-signed-or-encrypted-p dont-emulate-mime handle)
7493                   (throw 'found t))
7494               (when (and (bufferp (car handle))
7495                          (equal (mm-handle-media-type handle)
7496                                 "message/rfc822"))
7497                 (with-current-buffer (mm-handle-buffer handle)
7498                   (when (message-signed-or-encrypted-p dont-emulate-mime)
7499                     (throw 'found t)))))))
7500       (mm-destroy-parts handles))))
7501
7502 ;;;###autoload
7503 (defun message-forward-make-body (forward-buffer &optional digest)
7504   ;; Put point where we want it before inserting the forwarded
7505   ;; message.
7506   (if message-forward-before-signature
7507       (message-goto-body)
7508     (goto-char (point-max)))
7509   (if digest
7510       (message-forward-make-body-digest forward-buffer)
7511     (if message-forward-as-mime
7512         (if (and message-forward-show-mml
7513                  (not (and (eq message-forward-show-mml 'best)
7514                            ;; Use the raw form in the body if it contains
7515                            ;; signed or encrypted message so as not to be
7516                            ;; destroyed by re-encoding.
7517                            (with-current-buffer forward-buffer
7518                              (condition-case nil
7519                                  (message-signed-or-encrypted-p)
7520                                (error t))))))
7521             (message-forward-make-body-mml forward-buffer)
7522           (message-forward-make-body-mime forward-buffer))
7523       (message-forward-make-body-plain forward-buffer)))
7524   (message-position-point))
7525
7526 (declare-function rmail-toggle-header "rmail" (&optional arg))
7527
7528 ;;;###autoload
7529 (defun message-forward-rmail-make-body (forward-buffer)
7530   (save-window-excursion
7531     (set-buffer forward-buffer)
7532     (if (rmail-msg-is-pruned)
7533         (if (fboundp 'rmail-msg-restore-non-pruned-header)
7534             (rmail-msg-restore-non-pruned-header) ; Emacs 22
7535           (rmail-toggle-header 0))))              ; Emacs 23
7536   (message-forward-make-body forward-buffer))
7537
7538 ;; Fixme: Should have defcustom.
7539 ;;;###autoload
7540 (defun message-insinuate-rmail ()
7541   "Let RMAIL use message to forward."
7542   (interactive)
7543   (setq rmail-enable-mime-composing t)
7544   (setq rmail-insert-mime-forwarded-message-function
7545         'message-forward-rmail-make-body))
7546
7547 (defvar message-inhibit-body-encoding nil)
7548
7549 ;;;###autoload
7550 (defun message-resend (address)
7551   "Resend the current article to ADDRESS."
7552   (interactive
7553    (list (message-read-from-minibuffer "Resend message to: ")))
7554   (message "Resending message to %s..." address)
7555   (save-excursion
7556     (let ((cur (current-buffer))
7557           beg)
7558       ;; We first set up a normal mail buffer.
7559       (unless (message-mail-user-agent)
7560         (set-buffer (get-buffer-create " *message resend*"))
7561         (let ((inhibit-read-only t))
7562           (erase-buffer)))
7563       (let ((message-this-is-mail t)
7564             message-generate-hashcash
7565             message-setup-hook)
7566         (message-setup `((To . ,address))))
7567       ;; Insert our usual headers.
7568       (message-generate-headers '(From Date To Message-ID))
7569       (message-narrow-to-headers)
7570       ;; Remove X-Draft-From header etc.
7571       (message-remove-header message-ignored-mail-headers t)
7572       ;; Rename them all to "Resent-*".
7573       (goto-char (point-min))
7574       (while (re-search-forward "^[A-Za-z]" nil t)
7575         (forward-char -1)
7576         (insert "Resent-"))
7577       (widen)
7578       (forward-line)
7579       (let ((inhibit-read-only t))
7580         (delete-region (point) (point-max)))
7581       (setq beg (point))
7582       ;; Insert the message to be resent.
7583       (insert-buffer-substring cur)
7584       (goto-char (point-min))
7585       (search-forward "\n\n")
7586       (forward-char -1)
7587       (save-restriction
7588         (narrow-to-region beg (point))
7589         (message-remove-header message-ignored-resent-headers t)
7590         (goto-char (point-max)))
7591       (insert mail-header-separator)
7592       ;; Rename all old ("Also-")Resent headers.
7593       (while (re-search-backward "^\\(Also-\\)*Resent-" beg t)
7594         (beginning-of-line)
7595         (insert "Also-"))
7596       ;; Quote any "From " lines at the beginning.
7597       (goto-char beg)
7598       (when (looking-at "From ")
7599         (replace-match "X-From-Line: "))
7600       ;; Send it.
7601       (let ((message-inhibit-body-encoding
7602              ;; Don't do any further encoding if it looks like the
7603              ;; message has already been encoded.
7604              (let ((case-fold-search t))
7605                (re-search-forward "^mime-version:" nil t)))
7606             (message-inhibit-ecomplete t)
7607             message-required-mail-headers
7608             message-generate-hashcash
7609             rfc2047-encode-encoded-words)
7610         (message-send-mail))
7611       (kill-buffer (current-buffer)))
7612     (message "Resending message to %s...done" address)))
7613
7614 ;;;###autoload
7615 (defun message-bounce ()
7616   "Re-mail the current message.
7617 This only makes sense if the current message is a bounce message that
7618 contains some mail you have written which has been bounced back to
7619 you."
7620   (interactive)
7621   (let ((handles (mm-dissect-buffer t))
7622         boundary)
7623     (message-pop-to-buffer (message-buffer-name "bounce"))
7624     (if (stringp (car handles))
7625         ;; This is a MIME bounce.
7626         (mm-insert-part (car (last handles)))
7627       ;; This is a non-MIME bounce, so we try to remove things
7628       ;; manually.
7629       (mm-insert-part handles)
7630       (undo-boundary)
7631       (goto-char (point-min))
7632       (re-search-forward "\n\n+" nil t)
7633       (setq boundary (point))
7634       ;; We remove everything before the bounced mail.
7635       (if (or (re-search-forward message-unsent-separator nil t)
7636               (progn
7637                 (search-forward "\n\n" nil 'move)
7638                 (re-search-backward "^Return-Path:.*\n" boundary t)))
7639           (progn
7640             (forward-line 1)
7641             (delete-region (point-min)
7642                            (if (re-search-forward "^[^ \n\t]+:" nil t)
7643                                (match-beginning 0)
7644                              (point))))
7645         (goto-char boundary)
7646         (when (re-search-backward "^.?From .*\n" nil t)
7647           (delete-region (match-beginning 0) (match-end 0)))))
7648     (mime-to-mml)
7649     (save-restriction
7650       (message-narrow-to-head-1)
7651       (message-remove-header message-ignored-bounced-headers t)
7652       (goto-char (point-max))
7653       (insert mail-header-separator))
7654     (message-position-point)))
7655
7656 ;;;
7657 ;;; Interactive entry points for new message buffers.
7658 ;;;
7659
7660 ;;;###autoload
7661 (defun message-mail-other-window (&optional to subject)
7662   "Like `message-mail' command, but display mail buffer in another window."
7663   (interactive)
7664   (unless (message-mail-user-agent)
7665     (message-pop-to-buffer (message-buffer-name "mail" to)
7666                            'switch-to-buffer-other-window))
7667   (let ((message-this-is-mail t))
7668     (message-setup `((To . ,(or to "")) (Subject . ,(or subject "")))
7669                    nil nil nil 'switch-to-buffer-other-window)))
7670
7671 ;;;###autoload
7672 (defun message-mail-other-frame (&optional to subject)
7673   "Like `message-mail' command, but display mail buffer in another frame."
7674   (interactive)
7675   (unless (message-mail-user-agent)
7676     (message-pop-to-buffer (message-buffer-name "mail" to)
7677                            'switch-to-buffer-other-frame))
7678   (let ((message-this-is-mail t))
7679     (message-setup `((To . ,(or to "")) (Subject . ,(or subject "")))
7680                    nil nil nil 'switch-to-buffer-other-frame)))
7681
7682 ;;;###autoload
7683 (defun message-news-other-window (&optional newsgroups subject)
7684   "Start editing a news article to be sent."
7685   (interactive)
7686   (message-pop-to-buffer (message-buffer-name "posting" nil newsgroups)
7687                          'switch-to-buffer-other-window)
7688   (let ((message-this-is-news t))
7689     (message-setup `((Newsgroups . ,(or newsgroups ""))
7690                      (Subject . ,(or subject ""))))))
7691
7692 ;;;###autoload
7693 (defun message-news-other-frame (&optional newsgroups subject)
7694   "Start editing a news article to be sent."
7695   (interactive)
7696   (message-pop-to-buffer (message-buffer-name "posting" nil newsgroups)
7697                          'switch-to-buffer-other-frame)
7698   (let ((message-this-is-news t))
7699     (message-setup `((Newsgroups . ,(or newsgroups ""))
7700                      (Subject . ,(or subject ""))))))
7701
7702 ;;; underline.el
7703
7704 ;; This code should be moved to underline.el (from which it is stolen).
7705
7706 ;;;###autoload
7707 (defun message-bold-region (start end)
7708   "Bold all nonblank characters in the region.
7709 Works by overstriking characters.
7710 Called from program, takes two arguments START and END
7711 which specify the range to operate on."
7712   (interactive "r")
7713   (save-excursion
7714     (let ((end1 (make-marker)))
7715       (move-marker end1 (max start end))
7716       (goto-char (min start end))
7717       (while (< (point) end1)
7718         (or (looking-at "[_\^@- ]")
7719             (insert (char-after) "\b"))
7720         (forward-char 1)))))
7721
7722 ;;;###autoload
7723 (defun message-unbold-region (start end)
7724   "Remove all boldness (overstruck characters) in the region.
7725 Called from program, takes two arguments START and END
7726 which specify the range to operate on."
7727   (interactive "r")
7728   (save-excursion
7729     (let ((end1 (make-marker)))
7730       (move-marker end1 (max start end))
7731       (goto-char (min start end))
7732       (while (search-forward "\b" end1 t)
7733         (if (eq (char-after) (char-after (- (point) 2)))
7734             (delete-char -2))))))
7735
7736 (defun message-exchange-point-and-mark ()
7737   "Exchange point and mark, but don't activate region if it was inactive."
7738   (goto-char (prog1 (mark t)
7739                (set-marker (mark-marker) (point)))))
7740
7741 (defalias 'message-make-overlay 'make-overlay)
7742 (defalias 'message-delete-overlay 'delete-overlay)
7743 (defalias 'message-overlay-put 'overlay-put)
7744 (defun message-kill-all-overlays ()
7745   (if (featurep 'xemacs)
7746       (map-extents (lambda (extent ignore) (delete-extent extent)))
7747     (mapcar #'delete-overlay (overlays-in (point-min) (point-max)))))
7748
7749 ;; Support for toolbar
7750 (defvar tool-bar-mode)
7751
7752 ;; Note: The :set function in the `message-tool-bar*' variables will only
7753 ;; affect _new_ message buffers.  We might add a function that walks thru all
7754 ;; message-mode buffers and force the update.
7755 (defun message-tool-bar-update (&optional symbol value)
7756   "Update message mode toolbar.
7757 Setter function for custom variables."
7758   (setq-default message-tool-bar-map nil)
7759   (when symbol
7760     ;; When used as ":set" function:
7761     (set-default symbol value)))
7762
7763 (defcustom message-tool-bar (if (eq gmm-tool-bar-style 'gnome)
7764                                 'message-tool-bar-gnome
7765                               'message-tool-bar-retro)
7766   "Specifies the message mode tool bar.
7767
7768 It can be either a list or a symbol refering to a list.  See
7769 `gmm-tool-bar-from-list' for the format of the list.  The
7770 default key map is `message-mode-map'.
7771
7772 Pre-defined symbols include `message-tool-bar-gnome' and
7773 `message-tool-bar-retro'."
7774   :type '(repeat gmm-tool-bar-list-item)
7775   :type '(choice (const :tag "GNOME style" message-tool-bar-gnome)
7776                  (const :tag "Retro look"  message-tool-bar-retro)
7777                  (repeat :tag "User defined list" gmm-tool-bar-item)
7778                  (symbol))
7779   :version "23.1" ;; No Gnus
7780   :initialize 'custom-initialize-default
7781   :set 'message-tool-bar-update
7782   :group 'message)
7783
7784 (defcustom message-tool-bar-gnome
7785   '((ispell-message "spell" nil
7786                     :vert-only t
7787                     :visible (or (not (boundp 'flyspell-mode))
7788                                  (not flyspell-mode)))
7789     (flyspell-buffer "spell" t
7790                      :vert-only t
7791                      :visible (and (boundp 'flyspell-mode)
7792                                    flyspell-mode)
7793                      :help "Flyspell whole buffer")
7794     (message-send-and-exit "mail/send" t :label "Send")
7795     (message-dont-send "mail/save-draft")
7796     (mml-attach-file "attach" mml-mode-map :vert-only t)
7797     (mml-preview "mail/preview" mml-mode-map)
7798     (mml-secure-message-sign-encrypt "lock" mml-mode-map :visible nil)
7799     (message-insert-importance-high "important" nil :visible nil)
7800     (message-insert-importance-low "unimportant" nil :visible nil)
7801     (message-insert-disposition-notification-to "receipt" nil :visible nil))
7802   "List of items for the message tool bar (GNOME style).
7803
7804 See `gmm-tool-bar-from-list' for details on the format of the list."
7805   :type '(repeat gmm-tool-bar-item)
7806   :version "23.1" ;; No Gnus
7807   :initialize 'custom-initialize-default
7808   :set 'message-tool-bar-update
7809   :group 'message)
7810
7811 (defcustom message-tool-bar-retro
7812   '(;; Old Emacs 21 icon for consistency.
7813     (message-send-and-exit "gnus/mail-send")
7814     (message-kill-buffer "close")
7815     (message-dont-send "cancel")
7816     (mml-attach-file "attach" mml-mode-map)
7817     (ispell-message "spell")
7818     (mml-preview "preview" mml-mode-map)
7819     (message-insert-importance-high "gnus/important")
7820     (message-insert-importance-low "gnus/unimportant")
7821     (message-insert-disposition-notification-to "gnus/receipt"))
7822   "List of items for the message tool bar (retro style).
7823
7824 See `gmm-tool-bar-from-list' for details on the format of the list."
7825   :type '(repeat gmm-tool-bar-item)
7826   :version "23.1" ;; No Gnus
7827   :initialize 'custom-initialize-default
7828   :set 'message-tool-bar-update
7829   :group 'message)
7830
7831 (defcustom message-tool-bar-zap-list
7832   '(new-file open-file dired kill-buffer write-file
7833              print-buffer customize help)
7834   "List of icon items from the global tool bar.
7835 These items are not displayed on the message mode tool bar.
7836
7837 See `gmm-tool-bar-from-list' for the format of the list."
7838   :type 'gmm-tool-bar-zap-list
7839   :version "23.1" ;; No Gnus
7840   :initialize 'custom-initialize-default
7841   :set 'message-tool-bar-update
7842   :group 'message)
7843
7844 (defvar image-load-path)
7845
7846 (defun message-make-tool-bar (&optional force)
7847   "Make a message mode tool bar from `message-tool-bar-list'.
7848 When FORCE, rebuild the tool bar."
7849   (when (and (not (featurep 'xemacs))
7850              (boundp 'tool-bar-mode)
7851              tool-bar-mode
7852              (or (not message-tool-bar-map) force))
7853     (setq message-tool-bar-map
7854           (let* ((load-path
7855                   (gmm-image-load-path-for-library "message"
7856                                                    "mail/save-draft.xpm"
7857                                                    nil t))
7858                  (image-load-path (cons (car load-path)
7859                                         (when (boundp 'image-load-path)
7860                                           image-load-path))))
7861             (gmm-tool-bar-from-list message-tool-bar
7862                                     message-tool-bar-zap-list
7863                                     'message-mode-map))))
7864   message-tool-bar-map)
7865
7866 ;;; Group name completion.
7867
7868 (defcustom message-newgroups-header-regexp
7869   "^\\(Newsgroups\\|Followup-To\\|Posted-To\\|Gcc\\):"
7870   "Regexp that match headers that lists groups."
7871   :group 'message
7872   :type 'regexp)
7873
7874 (defcustom message-completion-alist
7875   (list (cons message-newgroups-header-regexp 'message-expand-group)
7876         '("^\\(Resent-\\)?\\(To\\|B?Cc\\):" . message-expand-name)
7877         '("^\\(Reply-To\\|From\\|Mail-Followup-To\\|Mail-Copies-To\\):"
7878           . message-expand-name)
7879         '("^\\(Disposition-Notification-To\\|Return-Receipt-To\\):"
7880           . message-expand-name))
7881   "Alist of (RE . FUN).  Use FUN for completion on header lines matching RE."
7882   :version "22.1"
7883   :group 'message
7884   :type '(alist :key-type regexp :value-type function))
7885
7886 (defcustom message-expand-name-databases
7887   '(bbdb eudc)
7888   "List of databases to try for name completion (`message-expand-name').
7889 Each element is a symbol and can be `bbdb' or `eudc'."
7890   :group 'message
7891   :type '(set (const bbdb) (const eudc)))
7892
7893 (defcustom message-tab-body-function nil
7894   "*Function to execute when `message-tab' (TAB) is executed in the body.
7895 If nil, the function bound in `text-mode-map' or `global-map' is executed."
7896   :version "22.1"
7897   :group 'message
7898   :link '(custom-manual "(message)Various Commands")
7899   :type '(choice (const nil)
7900                  function))
7901
7902 (declare-function mail-abbrev-in-expansion-header-p "mailabbrev" ())
7903
7904 (defun message-tab ()
7905   "Complete names according to `message-completion-alist'.
7906 Execute function specified by `message-tab-body-function' when not in
7907 those headers."
7908   (interactive)
7909   (cond
7910    ((if (and (boundp 'completion-fail-discreetly)
7911              (fboundp 'completion-at-point))
7912         (let ((completion-fail-discreetly t)) (completion-at-point))
7913       (funcall (or (message-completion-function) #'ignore)))
7914     ;; Completion was performed; nothing else to do.
7915     nil)
7916    (message-tab-body-function (funcall message-tab-body-function))
7917    (t (funcall (or (lookup-key text-mode-map "\t")
7918                    (lookup-key global-map "\t")
7919                    'indent-relative)))))
7920
7921 (defvar mail-abbrev-mode-regexp)
7922
7923 (defun message-completion-function ()
7924   (let ((alist message-completion-alist))
7925     (while (and alist
7926                 (let ((mail-abbrev-mode-regexp (caar alist)))
7927                   (not (mail-abbrev-in-expansion-header-p))))
7928       (setq alist (cdr alist)))
7929     (cdar alist)))
7930
7931 (eval-and-compile
7932   (condition-case nil
7933       (with-temp-buffer
7934         (let ((standard-output (current-buffer)))
7935           (eval '(display-completion-list nil "")))
7936         (defalias 'message-display-completion-list 'display-completion-list))
7937     (error ;; Don't use `wrong-number-of-arguments' here because of XEmacs.
7938      (defun message-display-completion-list (completions &optional ignore)
7939        "Display the list of completions, COMPLETIONS, using `standard-output'."
7940        (display-completion-list completions)))))
7941
7942 (defun message-expand-group ()
7943   "Expand the group name under point."
7944   (let* ((b (save-excursion
7945               (save-restriction
7946                 (narrow-to-region
7947                  (save-excursion
7948                    (beginning-of-line)
7949                    (skip-chars-forward "^:")
7950                    (1+ (point)))
7951                  (point))
7952                 (skip-chars-backward "^, \t\n") (point))))
7953          (completion-ignore-case t)
7954          (e (progn (skip-chars-forward "^,\t\n ") (point)))
7955          (hashtb (and (boundp 'gnus-active-hashtb) gnus-active-hashtb)))
7956     (message-completion-in-region e b hashtb)))
7957
7958 (defalias 'message-completion-in-region
7959   (if (fboundp 'completion-in-region)
7960       'completion-in-region
7961     (lambda (e b hashtb)
7962       (let* ((string (buffer-substring b e))
7963              (completions (all-completions string hashtb))
7964              comp)
7965         (delete-region b (point))
7966         (cond
7967          ((= (length completions) 1)
7968           (if (string= (car completions) string)
7969               (progn
7970                 (insert string)
7971                 (message "Only matching group"))
7972             (insert (car completions))))
7973          ((and (setq comp (try-completion string hashtb))
7974                (not (string= comp string)))
7975           (insert comp))
7976          (t
7977           (insert string)
7978           (if (not comp)
7979               (message "No matching groups")
7980             (save-selected-window
7981               (pop-to-buffer "*Completions*")
7982               (buffer-disable-undo)
7983               (let ((buffer-read-only nil))
7984                 (erase-buffer)
7985                 (let ((standard-output (current-buffer)))
7986                   (message-display-completion-list (sort completions 'string<)
7987                                                    string))
7988                 (setq buffer-read-only nil)
7989                 (goto-char (point-min))
7990                 (delete-region (point)
7991                                (progn (forward-line 3) (point))))))))))))
7992
7993 (defun message-expand-name ()
7994   (cond ((and (memq 'eudc message-expand-name-databases)
7995                     (boundp 'eudc-protocol)
7996                     eudc-protocol)
7997          (eudc-expand-inline))
7998         ((and (memq 'bbdb message-expand-name-databases)
7999               (fboundp 'bbdb-complete-name))
8000          (let ((starttick (buffer-modified-tick)))
8001            (or (bbdb-complete-name)
8002                ;; Apparently, bbdb-complete-name can return nil even when
8003                ;; completion took place.  So let's double check the buffer was
8004                ;; not modified.
8005                (/= starttick (buffer-modified-tick)))))
8006         (t
8007          (expand-abbrev))))
8008
8009 ;;; Help stuff.
8010
8011 (defun message-talkative-question (ask question show &rest text)
8012   "Call FUNCTION with argument QUESTION; optionally display TEXT... args.
8013 If SHOW is non-nil, the arguments TEXT... are displayed in a temp buffer.
8014 The following arguments may contain lists of values."
8015   (if (and show
8016            (setq text (message-flatten-list text)))
8017       (save-window-excursion
8018         (with-output-to-temp-buffer " *MESSAGE information message*"
8019           (with-current-buffer " *MESSAGE information message*"
8020             (fundamental-mode)          ; for Emacs 20.4+
8021             (mapc 'princ text)
8022             (goto-char (point-min))))
8023         (funcall ask question))
8024     (funcall ask question)))
8025
8026 (defun message-flatten-list (list)
8027   "Return a new, flat list that contains all elements of LIST.
8028
8029 \(message-flatten-list '(1 (2 3 (4 5 (6))) 7))
8030 => (1 2 3 4 5 6 7)"
8031   (cond ((consp list)
8032          (apply 'append (mapcar 'message-flatten-list list)))
8033         (list
8034          (list list))))
8035
8036 (defun message-generate-new-buffer-clone-locals (name &optional varstr)
8037   "Create and return a buffer with name based on NAME using `generate-new-buffer'.
8038 Then clone the local variables and values from the old buffer to the
8039 new one, cloning only the locals having a substring matching the
8040 regexp VARSTR."
8041   (let ((oldbuf (current-buffer)))
8042     (with-current-buffer (generate-new-buffer name)
8043       (message-clone-locals oldbuf varstr)
8044       (current-buffer))))
8045
8046 (defun message-clone-locals (buffer &optional varstr)
8047   "Clone the local variables from BUFFER to the current buffer."
8048   (let ((locals (with-current-buffer buffer (buffer-local-variables)))
8049         (regexp "^gnus\\|^nn\\|^message\\|^sendmail\\|^smtp\\|^user-mail-address"))
8050     (mapcar
8051      (lambda (local)
8052        (when (and (consp local)
8053                   (car local)
8054                   (string-match regexp (symbol-name (car local)))
8055                   (or (null varstr)
8056                       (string-match varstr (symbol-name (car local)))))
8057          (ignore-errors
8058            (set (make-local-variable (car local))
8059                 (cdr local)))))
8060      locals)))
8061
8062 ;;;
8063 ;;; MIME functions
8064 ;;;
8065
8066 (defun message-encode-message-body ()
8067   (unless message-inhibit-body-encoding
8068     (let ((mail-parse-charset (or mail-parse-charset
8069                                   message-default-charset))
8070           (case-fold-search t)
8071           lines content-type-p)
8072       (message-goto-body)
8073       (save-restriction
8074         (narrow-to-region (point) (point-max))
8075         (let ((new (mml-generate-mime)))
8076           (when new
8077             (delete-region (point-min) (point-max))
8078             (insert new)
8079             (goto-char (point-min))
8080             (if (eq (aref new 0) ?\n)
8081                 (delete-char 1)
8082               (search-forward "\n\n")
8083               (setq lines (buffer-substring (point-min) (1- (point))))
8084               (delete-region (point-min) (point))))))
8085       (save-restriction
8086         (message-narrow-to-headers-or-head)
8087         (message-remove-header "Mime-Version")
8088         (goto-char (point-max))
8089         (insert "MIME-Version: 1.0\n")
8090         (when lines
8091           (insert lines))
8092         (setq content-type-p
8093               (or mml-boundary
8094                   (re-search-backward "^Content-Type:" nil t))))
8095       (save-restriction
8096         (message-narrow-to-headers-or-head)
8097         (message-remove-first-header "Content-Type")
8098         (message-remove-first-header "Content-Transfer-Encoding"))
8099       ;; We always make sure that the message has a Content-Type
8100       ;; header.  This is because some broken MTAs and MUAs get
8101       ;; awfully confused when confronted with a message with a
8102       ;; MIME-Version header and without a Content-Type header.  For
8103       ;; instance, Solaris' /usr/bin/mail.
8104       (unless content-type-p
8105         (goto-char (point-min))
8106         ;; For unknown reason, MIME-Version doesn't exist.
8107         (when (re-search-forward "^MIME-Version:" nil t)
8108           (forward-line 1)
8109           (insert "Content-Type: text/plain; charset=us-ascii\n"))))))
8110
8111 (defun message-read-from-minibuffer (prompt &optional initial-contents)
8112   "Read from the minibuffer while providing abbrev expansion."
8113   (if (fboundp 'mail-abbrevs-setup)
8114       (let ((minibuffer-setup-hook 'mail-abbrevs-setup)
8115             (minibuffer-local-map message-minibuffer-local-map))
8116         (flet ((mail-abbrev-in-expansion-header-p nil t))
8117           (read-from-minibuffer prompt initial-contents)))
8118     (let ((minibuffer-setup-hook 'mail-abbrev-minibuffer-setup-hook)
8119           (minibuffer-local-map message-minibuffer-local-map))
8120       (read-string prompt initial-contents))))
8121
8122 (defun message-use-alternative-email-as-from ()
8123   "Set From field of the outgoing message to the first matching
8124 address in `message-alternative-emails', looking at To, Cc and
8125 From headers in the original article."
8126   (require 'mail-utils)
8127   (let* ((fields '("To" "Cc" "From"))
8128          (emails
8129           (split-string
8130            (mail-strip-quoted-names
8131             (mapconcat 'message-fetch-reply-field fields ","))
8132            "[ \f\t\n\r\v,]+"))
8133          email)
8134     (while emails
8135       (if (string-match message-alternative-emails (car emails))
8136           (setq email (car emails)
8137                 emails nil))
8138       (pop emails))
8139     (unless (or (not email) (equal email user-mail-address))
8140       (message-remove-header "From")
8141       (goto-char (point-max))
8142       (insert "From: " (let ((user-mail-address email)) (message-make-from))
8143               "\n"))))
8144
8145 (defun message-options-get (symbol)
8146   (cdr (assq symbol message-options)))
8147
8148 (defun message-options-set (symbol value)
8149   (let ((the-cons (assq symbol message-options)))
8150     (if the-cons
8151         (if value
8152             (setcdr the-cons value)
8153           (setq message-options (delq the-cons message-options)))
8154       (and value
8155            (push (cons symbol value) message-options))))
8156   value)
8157
8158 (defun message-options-set-recipient ()
8159   (save-restriction
8160     (message-narrow-to-headers-or-head)
8161     (message-options-set 'message-sender
8162                          (mail-strip-quoted-names
8163                           (message-fetch-field "from")))
8164     (message-options-set 'message-recipients
8165                          (mail-strip-quoted-names
8166                           (let ((to (message-fetch-field "to"))
8167                                 (cc (message-fetch-field "cc"))
8168                                 (bcc (message-fetch-field "bcc")))
8169                             (concat
8170                              (or to "")
8171                              (if (and to cc) ", ")
8172                              (or cc "")
8173                              (if (and (or to cc) bcc) ", ")
8174                              (or bcc "")))))))
8175
8176 (defun message-hide-headers ()
8177   "Hide headers based on the `message-hidden-headers' variable."
8178   (let ((regexps (if (stringp message-hidden-headers)
8179                      (list message-hidden-headers)
8180                    message-hidden-headers))
8181         (inhibit-point-motion-hooks t)
8182         (after-change-functions nil)
8183         (end-of-headers (point-min)))
8184     (when regexps
8185       (save-excursion
8186         (save-restriction
8187           (message-narrow-to-headers)
8188           (goto-char (point-min))
8189           (while (not (eobp))
8190             (if (not (message-hide-header-p regexps))
8191                 (message-next-header)
8192               (let ((begin (point))
8193                     header header-len)
8194                 (message-next-header)
8195                 (setq header (buffer-substring begin (point))
8196                       header-len (- (point) begin))
8197                 (delete-region begin (point))
8198                 (goto-char end-of-headers)
8199                 (insert header)
8200                 (setq end-of-headers
8201                       (+ end-of-headers header-len))))))))
8202     (narrow-to-region end-of-headers (point-max))))
8203
8204 (defun message-hide-header-p (regexps)
8205   (let ((result nil)
8206         (reverse nil))
8207     (when (eq (car regexps) 'not)
8208       (setq reverse t)
8209       (pop regexps))
8210     (dolist (regexp regexps)
8211       (setq result (or result (looking-at regexp))))
8212     (if reverse
8213         (not result)
8214       result)))
8215
8216 (declare-function ecomplete-add-item "ecomplete" (type key text))
8217 (declare-function ecomplete-save "ecomplete" ())
8218
8219 (defun message-put-addresses-in-ecomplete ()
8220   (require 'ecomplete)
8221   (dolist (header '("to" "cc" "from" "reply-to"))
8222     (let ((value (message-field-value header)))
8223       (dolist (string (mail-header-parse-addresses value 'raw))
8224         (setq string
8225               (gnus-replace-in-string
8226                (gnus-replace-in-string string "^ +\\| +$" "") "\n" ""))
8227         (ecomplete-add-item 'mail (car (mail-header-parse-address string))
8228                             string))))
8229   (ecomplete-save))
8230
8231 (autoload 'ecomplete-display-matches "ecomplete")
8232
8233 (defun message-display-abbrev (&optional choose)
8234   "Display the next possible abbrev for the text before point."
8235   (interactive (list t))
8236   (when (and (memq (char-after (point-at-bol)) '(?C ?T ?\t ? ))
8237              (message-point-in-header-p)
8238              (save-excursion
8239                (beginning-of-line)
8240                (while (and (memq (char-after) '(?\t ? ))
8241                            (zerop (forward-line -1))))
8242                (looking-at "To:\\|Cc:")))
8243     (let* ((end (point))
8244            (start (save-excursion
8245                     (and (re-search-backward "[\n\t ]" nil t)
8246                          (1+ (point)))))
8247            (word (when start (buffer-substring start end)))
8248            (match (when (and word
8249                              (not (zerop (length word))))
8250                     (ecomplete-display-matches 'mail word choose))))
8251       (when (and choose match)
8252         (delete-region start end)
8253         (insert match)))))
8254
8255 ;; To send pre-formatted letters like the example below, you can use
8256 ;; `message-send-form-letter':
8257 ;; --8<---------------cut here---------------start------------->8---
8258 ;; To: alice@invalid.invalid
8259 ;; Subject: Verification of your contact information
8260 ;; From: Contact verification <admin@foo.invalid>
8261 ;; --text follows this line--
8262 ;; Hi Alice,
8263 ;; please verify that your contact information is still valid:
8264 ;; Alice A, A avenue 11, 1111 A town, Austria
8265 ;; ----------next form letter message follows this line----------
8266 ;; To: bob@invalid.invalid
8267 ;; Subject: Verification of your contact information
8268 ;; From: Contact verification <admin@foo.invalid>
8269 ;; --text follows this line--
8270 ;; Hi Bob,
8271 ;; please verify that your contact information is still valid:
8272 ;; Bob, B street 22, 22222 Be town, Belgium
8273 ;; ----------next form letter message follows this line----------
8274 ;; To: charlie@invalid.invalid
8275 ;; Subject: Verification of your contact information
8276 ;; From: Contact verification <admin@foo.invalid>
8277 ;; --text follows this line--
8278 ;; Hi Charlie,
8279 ;; please verify that your contact information is still valid:
8280 ;; Charlie Chaplin, C plaza 33, 33333 C town, Chile
8281 ;; --8<---------------cut here---------------end--------------->8---
8282
8283 ;; FIXME: What is the most common term (circular letter, form letter, serial
8284 ;; letter, standard letter) for such kind of letter?  See also
8285 ;; <http://en.wikipedia.org/wiki/Form_letter>
8286
8287 ;; FIXME: Maybe extent message-mode's font-lock support to recognize
8288 ;; `message-form-letter-separator', i.e. highlight each message like a single
8289 ;; message.
8290
8291 (defcustom message-form-letter-separator
8292   "\n----------next form letter message follows this line----------\n"
8293   "Separator for `message-send-form-letter'."
8294   ;; :group 'message-form-letter
8295   :group 'message-various
8296   :version "23.1" ;; No Gnus
8297   :type 'string)
8298
8299 (defcustom message-send-form-letter-delay 1
8300   "Delay in seconds when sending a message with `message-send-form-letter'.
8301 Only used when `message-send-form-letter' is called with non-nil
8302 argument `force'."
8303   ;; :group 'message-form-letter
8304   :group 'message-various
8305   :version "23.1" ;; No Gnus
8306   :type 'integer)
8307
8308 (defun message-send-form-letter (&optional force)
8309   "Sent all form letter messages from current buffer.
8310 Unless FORCE, prompt before sending.
8311
8312 The messages are separated by `message-form-letter-separator'.
8313 Header and body are separated by `mail-header-separator'."
8314   (interactive "P")
8315   (let ((sent 0) (skipped 0)
8316         start end text
8317         buff
8318         to done)
8319     (goto-char (point-min))
8320     (while (not done)
8321       (setq start (point)
8322             end (if (search-forward message-form-letter-separator nil t)
8323                     (- (point) (length message-form-letter-separator) -1)
8324                   (setq done t)
8325                   (point-max)))
8326       (setq text
8327             (buffer-substring-no-properties start end))
8328       (setq buff (generate-new-buffer "*mail - form letter*"))
8329       (with-current-buffer buff
8330         (insert text)
8331         (message-mode)
8332         (setq to (message-fetch-field "To"))
8333         (switch-to-buffer buff)
8334         (when force
8335           (sit-for message-send-form-letter-delay))
8336         (if (or force
8337                   (y-or-n-p (format "Send message to `%s'? " to)))
8338             (progn
8339               (setq sent (1+ sent))
8340               (message-send-and-exit))
8341           (message (format "Message to `%s' skipped." to))
8342           (setq skipped (1+ skipped)))
8343         (when (buffer-live-p buff)
8344           (kill-buffer buff))))
8345     (message "%s message(s) sent, %s skipped." sent skipped)))
8346
8347 (defun message-replace-header (header new-value &optional after force)
8348   "Remove HEADER and insert the NEW-VALUE.
8349 If AFTER, insert after this header.  If FORCE, insert new field
8350 even if NEW-VALUE is empty."
8351   ;; Similar to `nnheader-replace-header' but for message buffers.
8352   (save-excursion
8353     (save-restriction
8354       (message-narrow-to-headers)
8355       (message-remove-header header))
8356     (when (or force (> (length new-value) 0))
8357       (if after
8358           (message-position-on-field header after)
8359         (message-position-on-field header))
8360       (insert new-value))))
8361
8362 (defcustom message-recipients-without-full-name
8363   (list "ding@gnus.org"
8364         "bugs@gnus.org"
8365         "emacs-devel@gnu.org"
8366         "emacs-pretest-bug@gnu.org"
8367         "bug-gnu-emacs@gnu.org")
8368   "Mail addresses that have no full name.
8369 Used in `message-simplify-recipients'."
8370   ;; Maybe the addresses could be extracted from
8371   ;; `gnus-parameter-to-list-alist'?
8372   :type '(choice (const :tag "None" nil)
8373                  (repeat string))
8374   :version "23.1" ;; No Gnus
8375   :group 'message-headers)
8376
8377 (defun message-simplify-recipients ()
8378   (interactive)
8379   (dolist (hdr '("Cc" "To"))
8380     (message-replace-header
8381      hdr
8382      (mapconcat
8383       (lambda (addrcomp)
8384         (if (and message-recipients-without-full-name
8385                  (string-match
8386                   (regexp-opt message-recipients-without-full-name)
8387                   (cadr addrcomp)))
8388             (cadr addrcomp)
8389           (if (car addrcomp)
8390               (message-make-from (car addrcomp) (cadr addrcomp))
8391             (cadr addrcomp))))
8392       (when (message-fetch-field hdr)
8393         (mail-extract-address-components
8394          (message-fetch-field hdr) t))
8395       ", "))))
8396
8397 (when (featurep 'xemacs)
8398   (require 'messagexmas)
8399   (message-xmas-redefine))
8400
8401 (provide 'message)
8402
8403 (run-hooks 'message-load-hook)
8404
8405 ;; Local Variables:
8406 ;; coding: iso-8859-1
8407 ;; End:
8408
8409 ;;; message.el ends here