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