cf7926a268cf57bb6cbecbe41a6f0341ce99afe6
[gnus] / lisp / message.el
1 ;;; message.el --- composing mail and news messages
2
3 ;; Copyright (C) 1996-2015 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 (eval-when-compile
32   (require 'cl))
33
34 (require 'mailheader)
35 (require 'gmm-utils)
36 (require 'mail-utils)
37 ;; Only for the trivial macros mail-header-from, mail-header-date
38 ;; mail-header-references, mail-header-subject, mail-header-id
39 (eval-when-compile (require 'nnheader))
40 ;; This is apparently necessary even though things are autoloaded.
41 ;; Because we dynamically bind mail-abbrev-mode-regexp, we'd better
42 ;; require mailabbrev here.
43 (if (featurep 'xemacs)
44     (require 'mail-abbrevs)
45   (require 'mailabbrev))
46 (require 'mail-parse)
47 (require 'mml)
48 (require 'rfc822)
49 (require 'format-spec)
50 (require 'dired)
51
52 (autoload 'mailclient-send-it "mailclient") ;; Emacs 22 or contrib/
53
54 (defvar gnus-message-group-art)
55 (defvar gnus-list-identifiers) ; gnus-sum is required where necessary
56 (defvar rmail-enable-mime-composing)
57
58 (defgroup message '((user-mail-address custom-variable)
59                     (user-full-name custom-variable))
60   "Mail and news message composing."
61   :link '(custom-manual "(message)Top")
62   :group 'mail
63   :group 'news)
64
65 (put 'user-mail-address 'custom-type 'string)
66 (put 'user-full-name 'custom-type 'string)
67
68 (defgroup message-various nil
69   "Various Message Variables."
70   :link '(custom-manual "(message)Various Message Variables")
71   :group 'message)
72
73 (defgroup message-buffers nil
74   "Message Buffers."
75   :link '(custom-manual "(message)Message Buffers")
76   :group 'message)
77
78 (defgroup message-sending nil
79   "Message Sending."
80   :link '(custom-manual "(message)Sending Variables")
81   :group 'message)
82
83 (defgroup message-interface nil
84   "Message Interface."
85   :link '(custom-manual "(message)Interface")
86   :group 'message)
87
88 (defgroup message-forwarding nil
89   "Message Forwarding."
90   :link '(custom-manual "(message)Forwarding")
91   :group 'message-interface)
92
93 (defgroup message-insertion nil
94   "Message Insertion."
95   :link '(custom-manual "(message)Insertion")
96   :group 'message)
97
98 (defgroup message-headers nil
99   "Message Headers."
100   :link '(custom-manual "(message)Message Headers")
101   :group 'message)
102
103 (defgroup message-news nil
104   "Composing News Messages."
105   :group 'message)
106
107 (defgroup message-mail nil
108   "Composing Mail Messages."
109   :group 'message)
110
111 (defgroup message-faces nil
112   "Faces used for message composing."
113   :group 'message
114   :group 'faces)
115
116 (defcustom message-directory "~/Mail/"
117   "*Directory from which all other mail file variables are derived."
118   :group 'message-various
119   :type 'directory)
120
121 (defcustom message-max-buffers 10
122   "*How many buffers to keep before starting to kill them off."
123   :group 'message-buffers
124   :type 'integer)
125
126 (defcustom message-send-rename-function nil
127   "Function called to rename the buffer after sending it."
128   :group 'message-buffers
129   :type '(choice function (const nil)))
130
131 (defcustom message-fcc-handler-function 'message-output
132   "*A function called to save outgoing articles.
133 This function will be called with the name of the file to store the
134 article in.  The default function is `message-output' which saves in Unix
135 mailbox format."
136   :type '(radio (function-item message-output)
137                 (function :tag "Other"))
138   :group 'message-sending)
139
140 (defcustom message-fcc-externalize-attachments nil
141   "If non-nil, attachments are included as external parts in Fcc copies."
142   :version "22.1"
143   :type 'boolean
144   :group 'message-sending)
145
146 (defcustom message-courtesy-message
147   "The following message is a courtesy copy of an article\nthat has been posted to %s as well.\n\n"
148   "*This is inserted at the start of a mailed copy of a posted message.
149 If the string contains the format spec \"%s\", the Newsgroups
150 the article has been posted to will be inserted there.
151 If this variable is nil, no such courtesy message will be added."
152   :group 'message-sending
153   :type '(radio string (const nil)))
154
155 (defcustom message-ignored-bounced-headers
156   "^\\(Received\\|Return-Path\\|Delivered-To\\):"
157   "*Regexp that matches headers to be removed in resent bounced mail."
158   :group 'message-interface
159   :type 'regexp)
160
161 (defcustom message-from-style 'default
162   ;; In Emacs 24.1 this defaults to the value of `mail-from-style'
163   ;; that defaults to:
164   ;; `angles' in Emacs 22.1~23.1, XEmacs 21.4, 21.5, and SXEmacs 22.1;
165   ;; `system-default' in Emacs 23.2, and 24.1
166   "Specifies how \"From\" headers look.
167
168 If nil, they contain just the return address like:
169         king@grassland.com
170 If `parens', they look like:
171         king@grassland.com (Elvis Parsley)
172 If `angles', they look like:
173         Elvis Parsley <king@grassland.com>
174
175 Otherwise, most addresses look like `angles', but they look like
176 `parens' if `angles' would need quoting and `parens' would not."
177   :version "23.2"
178   :type '(choice (const :tag "simple" nil)
179                  (const parens)
180                  (const angles)
181                  (const default))
182   :group 'message-headers)
183
184 (defcustom message-insert-canlock t
185   "Whether to insert a Cancel-Lock header in news postings."
186   :version "22.1"
187   :group 'message-headers
188   :type 'boolean)
189
190 (defcustom message-syntax-checks
191   (if message-insert-canlock '((sender . disabled)) nil)
192   ;; Guess this one shouldn't be easy to customize...
193   "*Controls what syntax checks should not be performed on outgoing posts.
194 To disable checking of long signatures, for instance, add
195  `(signature . disabled)' to this list.
196
197 Don't touch this variable unless you really know what you're doing.
198
199 Checks include `approved', `bogus-recipient', `continuation-headers',
200 `control-chars', `empty', `existing-newsgroups', `from', `illegible-text',
201 `invisible-text', `long-header-lines', `long-lines', `message-id',
202 `multiple-headers', `new-text', `newsgroups', `quoting-style',
203 `repeated-newsgroups', `reply-to', `sender', `sendsys', `shoot',
204 `shorten-followup-to', `signature', `size', `subject', `subject-cmsg'
205 and `valid-newsgroups'."
206   :group 'message-news
207   :type '(repeat sexp))                 ; Fixme: improve this
208
209 (defcustom message-required-headers '((optional . References)
210                                       From)
211   "*Headers to be generated or prompted for when sending a message.
212 Also see `message-required-news-headers' and
213 `message-required-mail-headers'."
214   :version "22.1"
215   :group 'message-news
216   :group 'message-headers
217   :link '(custom-manual "(message)Message Headers")
218   :type '(repeat sexp))
219
220 (defcustom message-draft-headers '(References From Date)
221   "*Headers to be generated when saving a draft message."
222   :version "22.1"
223   :group 'message-news
224   :group 'message-headers
225   :link '(custom-manual "(message)Message Headers")
226   :type '(repeat sexp))
227
228 (defcustom message-required-news-headers
229   '(From Newsgroups Subject Date Message-ID
230          (optional . Organization)
231          (optional . User-Agent))
232   "*Headers to be generated or prompted for when posting an article.
233 RFC977 and RFC1036 require From, Date, Newsgroups, Subject,
234 Message-ID.  Organization, Lines, In-Reply-To, Expires, and
235 User-Agent are optional.  If you don't want message to insert some
236 header, remove it from this list."
237   :group 'message-news
238   :group 'message-headers
239   :link '(custom-manual "(message)Message Headers")
240   :type '(repeat sexp))
241
242 (defcustom message-required-mail-headers
243   '(From Subject Date (optional . In-Reply-To) Message-ID
244          (optional . User-Agent))
245   "*Headers to be generated or prompted for when mailing a message.
246 It is recommended that From, Date, To, Subject and Message-ID be
247 included.  Organization and User-Agent are optional."
248   :group 'message-mail
249   :group 'message-headers
250   :link '(custom-manual "(message)Message Headers")
251   :type '(repeat sexp))
252
253 (defcustom message-prune-recipient-rules nil
254   "Rules for how to prune the list of recipients when doing wide replies.
255 This is a list of regexps and regexp matches."
256   :version "24.1"
257   :group 'message-mail
258   :group 'message-headers
259   :link '(custom-manual "(message)Wide Reply")
260   :type '(repeat regexp))
261
262 (defcustom message-deletable-headers '(Message-ID Date Lines)
263   "Headers to be deleted if they already exist and were generated by message previously."
264   :group 'message-headers
265   :link '(custom-manual "(message)Message Headers")
266   :type 'sexp)
267
268 (defcustom message-ignored-news-headers
269   "^NNTP-Posting-Host:\\|^Xref:\\|^[BGF]cc:\\|^Resent-Fcc:\\|^X-Draft-From:\\|^X-Gnus-Agent-Meta-Information:\\|^X-Message-SMTP-Method:\\|^X-Gnus-Delayed:"
270   "*Regexp of headers to be removed unconditionally before posting."
271   :group 'message-news
272   :group 'message-headers
273   :link '(custom-manual "(message)Message Headers")
274   :type '(repeat :value-to-internal (lambda (widget value)
275                                       (custom-split-regexp-maybe value))
276                  :match (lambda (widget value)
277                           (or (stringp value)
278                               (widget-editable-list-match widget value)))
279                  regexp))
280
281 (defcustom message-ignored-mail-headers
282   "^\\([GF]cc\\|Resent-Fcc\\|Xref\\|X-Draft-From\\|X-Gnus-Agent-Meta-Information\\):"
283   "*Regexp of headers to be removed unconditionally before mailing."
284   :group 'message-mail
285   :group 'message-headers
286   :link '(custom-manual "(message)Mail Headers")
287   :type 'regexp)
288
289 (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:"
290   "*Header lines matching this regexp will be deleted before posting.
291 It's best to delete old Path and Date headers before posting to avoid
292 any confusion."
293   :group 'message-interface
294   :link '(custom-manual "(message)Superseding")
295   :type '(repeat :value-to-internal (lambda (widget value)
296                                       (custom-split-regexp-maybe value))
297                  :match (lambda (widget value)
298                           (or (stringp value)
299                               (widget-editable-list-match widget value)))
300                  regexp))
301
302 (defcustom message-subject-re-regexp
303   "^[ \t]*\\([Rr][Ee]\\(\\[[0-9]*\\]\\)*:[ \t]*\\)*[ \t]*"
304   "*Regexp matching \"Re: \" in the subject line."
305   :group 'message-various
306   :link '(custom-manual "(message)Message Headers")
307   :type 'regexp)
308
309 ;;; Start of variables adopted from `message-utils.el'.
310
311 (defcustom message-subject-trailing-was-query t
312   "*What to do with trailing \"(was: <old subject>)\" in subject lines.
313 If nil, leave the subject unchanged.  If it is the symbol `ask', query
314 the user what do do.  In this case, the subject is matched against
315 `message-subject-trailing-was-ask-regexp'.  If
316 `message-subject-trailing-was-query' is t, always strip the trailing
317 old subject.  In this case, `message-subject-trailing-was-regexp' is
318 used."
319   :version "24.1"
320   :type '(choice (const :tag "never" nil)
321                  (const :tag "always strip" t)
322                  (const ask))
323   :link '(custom-manual "(message)Message Headers")
324   :group 'message-various)
325
326 (defcustom message-subject-trailing-was-ask-regexp
327   "[ \t]*\\([[(]+[Ww][Aa][Ss]:?[ \t]*.*[])]+\\)"
328   "*Regexp matching \"(was: <old subject>)\" in the subject line.
329
330 The function `message-strip-subject-trailing-was' uses this regexp if
331 `message-subject-trailing-was-query' is set to the symbol `ask'.  If
332 the variable is t instead of `ask', use
333 `message-subject-trailing-was-regexp' instead.
334
335 It is okay to create some false positives here, as the user is asked."
336   :version "22.1"
337   :group 'message-various
338   :link '(custom-manual "(message)Message Headers")
339   :type 'regexp)
340
341 (defcustom message-subject-trailing-was-regexp
342   "[ \t]*\\((*[Ww][Aa][Ss]:[ \t]*.*)\\)"
343   "*Regexp matching \"(was: <old subject>)\" in the subject line.
344
345 If `message-subject-trailing-was-query' is set to t, the subject is
346 matched against `message-subject-trailing-was-regexp' in
347 `message-strip-subject-trailing-was'.  You should use a regexp creating very
348 few false positives here."
349   :version "22.1"
350   :group 'message-various
351   :link '(custom-manual "(message)Message Headers")
352   :type 'regexp)
353
354 ;;; marking inserted text
355
356 (defcustom message-mark-insert-begin
357   "--8<---------------cut here---------------start------------->8---\n"
358   "How to mark the beginning of some inserted text."
359   :version "22.1"
360   :type 'string
361   :link '(custom-manual "(message)Insertion Variables")
362   :group 'message-various)
363
364 (defcustom message-mark-insert-end
365   "--8<---------------cut here---------------end--------------->8---\n"
366   "How to mark the end of some inserted text."
367   :version "22.1"
368   :type 'string
369   :link '(custom-manual "(message)Insertion Variables")
370   :group 'message-various)
371
372 (defcustom message-archive-header "X-No-Archive: Yes\n"
373   "Header to insert when you don't want your article to be archived.
374 Archives \(such as groups.google.com) respect this header."
375   :version "22.1"
376   :type 'string
377   :link '(custom-manual "(message)Header Commands")
378   :group 'message-various)
379
380 (defcustom message-archive-note
381   "X-No-Archive: Yes - save http://groups.google.com/"
382   "Note to insert why you wouldn't want this posting archived.
383 If nil, don't insert any text in the body."
384   :version "22.1"
385   :type '(radio string (const nil))
386   :link '(custom-manual "(message)Header Commands")
387   :group 'message-various)
388
389 ;;; Crossposts and Followups
390 ;; inspired by JoH-followup-to by Jochem Huhman <joh  at gmx.de>
391 ;; new suggestions by R. Weikusat <rw at another.de>
392
393 (defvar message-cross-post-old-target nil
394   "Old target for cross-posts or follow-ups.")
395 (make-variable-buffer-local 'message-cross-post-old-target)
396
397 (defcustom message-cross-post-default t
398   "When non-nil `message-cross-post-followup-to' will perform a crosspost.
399 If nil, `message-cross-post-followup-to' will only do a followup.  Note that
400 you can explicitly override this setting by calling
401 `message-cross-post-followup-to' with a prefix."
402   :version "22.1"
403   :type 'boolean
404   :group 'message-various)
405
406 (defcustom message-cross-post-note "Crosspost & Followup-To: "
407   "Note to insert before signature to notify of cross-post and follow-up."
408   :version "22.1"
409   :type 'string
410   :group 'message-various)
411
412 (defcustom message-followup-to-note "Followup-To: "
413   "Note to insert before signature to notify of follow-up only."
414   :version "22.1"
415   :type 'string
416   :group 'message-various)
417
418 (defcustom message-cross-post-note-function 'message-cross-post-insert-note
419   "Function to use to insert note about Crosspost or Followup-To.
420 The function will be called with four arguments.  The function should not only
421 insert a note, but also ensure old notes are deleted.  See the documentation
422 for `message-cross-post-insert-note'."
423   :version "22.1"
424   :type 'function
425   :group 'message-various)
426
427 ;;; End of variables adopted from `message-utils.el'.
428
429 (defcustom message-signature-separator "^-- $"
430   "Regexp matching the signature separator.
431 This variable is used to strip off the signature from quoted text
432 when `message-cite-function' is
433 `message-cite-original-without-signature'.  Most useful values
434 are \"^-- $\" (strict) and \"^-- *$\" (loose; allow missing
435 whitespace)."
436   :type '(choice (const :tag "strict" "^-- $")
437                  (const :tag "loose" "^-- *$")
438                  regexp)
439   :version "22.3" ;; Gnus 5.10.12 (changed default)
440   :link '(custom-manual "(message)Various Message Variables")
441   :group 'message-various)
442
443 (defcustom message-elide-ellipsis "\n[...]\n\n"
444   "*The string which is inserted for elided text.
445 This is a format-spec string, and you can use %l to say how many
446 lines were removed, and %c to say how many characters were
447 removed."
448   :type 'string
449   :link '(custom-manual "(message)Various Commands")
450   :group 'message-various)
451
452 (defcustom message-interactive t
453   ;; In Emacs 24.1 this defaults to the value of `mail-interactive'
454   ;; that defaults to:
455   ;; `nil' in Emacs 22.1~22.3, XEmacs 21.4, 21.5, and SXEmacs 22.1;
456   ;; `t' in Emacs 23.1~24.1
457   "Non-nil means when sending a message wait for and display errors.
458 A value of nil means let mailer mail back a message to report errors."
459   :version "23.2"
460   :group 'message-sending
461   :group 'message-mail
462   :link '(custom-manual "(message)Sending Variables")
463   :type 'boolean)
464
465 (defcustom message-confirm-send nil
466   "When non-nil, ask for confirmation when sending a message."
467   :group 'message-sending
468   :group 'message-mail
469   :version "23.1" ;; No Gnus
470   :link '(custom-manual "(message)Sending Variables")
471   :type 'boolean)
472
473 (defcustom message-generate-new-buffers 'unsent
474   "*Say whether to create a new message buffer to compose a message.
475 Valid values include:
476
477 nil
478   Generate the buffer name in the Message way (e.g., *mail*, *news*,
479   *mail to whom*, *news on group*, etc.) and continue editing in the
480   existing buffer of that name.  If there is no such buffer, it will
481   be newly created.
482
483 `unique' or t
484   Create the new buffer with the name generated in the Message way.
485
486 `unsent'
487   Similar to `unique' but the buffer name begins with \"*unsent \".
488
489 `standard'
490   Similar to nil but the buffer name is simpler like *mail message*.
491
492 function
493   If this is a function, call that function with three parameters:
494   The type, the To address and the group name (any of these may be nil).
495   The function should return the new buffer name."
496   :version "24.1"
497   :group 'message-buffers
498   :link '(custom-manual "(message)Message Buffers")
499   :type '(choice (const nil)
500                  (sexp :tag "unique" :format "unique\n" :value unique
501                        :match (lambda (widget value) (memq value '(unique t))))
502                  (const unsent)
503                  (const standard)
504                  (function :format "\n    %{%t%}: %v")))
505
506 (defcustom message-kill-buffer-on-exit nil
507   "*Non-nil means that the message buffer will be killed after sending a message."
508   :group 'message-buffers
509   :link '(custom-manual "(message)Message Buffers")
510   :type 'boolean)
511
512 (defcustom message-kill-buffer-query t
513   "*Non-nil means that killing a modified message buffer has to be confirmed.
514 This is used by `message-kill-buffer'."
515   :version "23.1" ;; No Gnus
516   :group 'message-buffers
517   :type 'boolean)
518
519 (defcustom message-user-organization
520   (or (getenv "ORGANIZATION") t)
521   "String to be used as an Organization header.
522 If t, use `message-user-organization-file'."
523   :group 'message-headers
524   :type '(choice string
525                  (const :tag "consult file" t)))
526
527 (defcustom message-user-organization-file
528   (let (orgfile)
529     (dolist (f (list "/etc/organization"
530                      "/etc/news/organization"
531                      "/usr/lib/news/organization"))
532       (when (file-readable-p f)
533         (setq orgfile f)))
534     orgfile)
535   "*Local news organization file."
536   :type '(choice (const nil) file)
537   :link '(custom-manual "(message)News Headers")
538   :group 'message-headers)
539
540 (defcustom message-make-forward-subject-function
541   #'message-forward-subject-name-subject
542   "*List of functions called to generate subject headers for forwarded messages.
543 The subject generated by the previous function is passed into each
544 successive function.
545
546 The provided functions are:
547
548 * `message-forward-subject-author-subject' Source of article (author or
549       newsgroup), in brackets followed by the subject
550 * `message-forward-subject-name-subject' Source of article (name of author
551       or newsgroup), in brackets followed by the subject
552 * `message-forward-subject-fwd' Subject of article with `Fwd:' prepended
553       to it."
554   :group 'message-forwarding
555   :link '(custom-manual "(message)Forwarding")
556   :type '(radio (function-item message-forward-subject-author-subject)
557                 (function-item message-forward-subject-fwd)
558                 (function-item message-forward-subject-name-subject)
559                 (repeat :tag "List of functions" function)))
560
561 (defcustom message-forward-as-mime t
562   "*Non-nil means forward messages as an inline/rfc822 MIME section.
563 Otherwise, directly inline the old message in the forwarded message."
564   :version "21.1"
565   :group 'message-forwarding
566   :link '(custom-manual "(message)Forwarding")
567   :type 'boolean)
568
569 (defcustom message-forward-show-mml 'best
570   "*Non-nil means show forwarded messages as MML (decoded from MIME).
571 Otherwise, forwarded messages are unchanged.
572 Can also be the symbol `best' to indicate that MML should be
573 used, except when it is a bad idea to use MML.  One example where
574 it is a bad idea is when forwarding a signed or encrypted
575 message, because converting MIME to MML would invalidate the
576 digital signature."
577   :version "21.1"
578   :group 'message-forwarding
579   :type '(choice (const :tag "use MML" t)
580                  (const :tag "don't use MML " nil)
581                  (const :tag "use MML when appropriate" best)))
582
583 (defcustom message-forward-before-signature t
584   "*Non-nil means put forwarded message before signature, else after."
585   :group 'message-forwarding
586   :type 'boolean)
587
588 (defcustom message-wash-forwarded-subjects nil
589   "*Non-nil means try to remove as much cruft as possible from the subject.
590 Done before generating the new subject of a forward."
591   :group 'message-forwarding
592   :link '(custom-manual "(message)Forwarding")
593   :type 'boolean)
594
595 (defcustom message-ignored-resent-headers
596   ;; `Delivered-To' needs to be removed because some mailers use it to
597   ;; detect loops, so if you resend a message to an address that ultimately
598   ;; comes back to you (e.g. a mailing-list to which you subscribe, in which
599   ;; case you may be removed from the list on the grounds that mail to you
600   ;; bounced with a "mailing loop" error).
601   "^Return-receipt\\|^X-Gnus\\|^Gnus-Warning:\\|^>?From \\|^Delivered-To:\
602 \\|^X-Content-Length:\\|^X-UIDL:"
603   "*All headers that match this regexp will be deleted when resending a message."
604   :version "24.4"
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 This may also be a list of regexps."
617   :version "21.1"
618   :group 'message-forwarding
619   :type '(repeat :value-to-internal (lambda (widget value)
620                                       (custom-split-regexp-maybe value))
621                  :match (lambda (widget value)
622                           (or (stringp value)
623                               (widget-editable-list-match widget value)))
624                  regexp))
625
626 (defcustom message-forward-included-headers nil
627   "If non-nil, delete non-matching headers when forwarding a message.
628 Only headers that match this regexp will be included.  This
629 variable should be a regexp or a list of regexps."
630   :version "25.1"
631   :group 'message-forwarding
632   :type '(repeat :value-to-internal (lambda (widget value)
633                                       (custom-split-regexp-maybe value))
634                  :match (lambda (widget value)
635                           (or (stringp value)
636                               (widget-editable-list-match widget value)))
637                  regexp))
638
639 (defcustom message-ignored-cited-headers "."
640   "*Delete these headers from the messages you yank."
641   :group 'message-insertion
642   :link '(custom-manual "(message)Insertion Variables")
643   :type 'regexp)
644
645 (defcustom message-cite-prefix-regexp
646   ;; In Emacs 24.1 this defaults to the value of
647   ;; `mail-citation-prefix-regexp'; the default value varies according
648   ;; to the Emacs version.  In XEmacs 21.4 and 21.5, sendmail.el
649   ;; provides it.
650   (if (string-match "[[:digit:]]" "1")
651       ;; Support POSIX?  XEmacs 21.5.27 doesn't.
652       "\\([ \t]*[_.[:word:]]+>+\\|[ \t]*[]>|]\\)+"
653     ;; ?-, ?_ or ?. MUST NOT be in syntax entry w.
654     (let (non-word-constituents)
655       (with-syntax-table text-mode-syntax-table
656         (setq non-word-constituents
657               (concat
658                (if (string-match "\\w" "_")  "" "_")
659                (if (string-match "\\w" ".")  "" "."))))
660       (if (equal non-word-constituents "")
661           "\\([ \t]*\\(\\w\\)+>+\\|[ \t]*[]>|]\\)+"
662         (concat "\\([ \t]*\\(\\w\\|["
663                 non-word-constituents
664                 "]\\)+>+\\|[ \t]*[]>|]\\)+"))))
665   "*Regexp matching the longest possible citation prefix on a line."
666   :version "24.1"
667   :group 'message-insertion
668   :link '(custom-manual "(message)Insertion Variables")
669   :type 'regexp
670   :set (lambda (symbol value)
671          (prog1
672              (custom-set-default symbol value)
673            (if (boundp 'gnus-message-cite-prefix-regexp)
674                (setq gnus-message-cite-prefix-regexp
675                      (concat "^\\(?:" value "\\)"))))))
676
677 (defcustom message-cancel-message "I am canceling my own article.\n"
678   "Message to be inserted in the cancel message."
679   :group 'message-interface
680   :link '(custom-manual "(message)Canceling News")
681   :type 'string)
682
683 (defun message-send-mail-function ()
684   "Return suitable value for the variable `message-send-mail-function'."
685   (cond ((and (require 'sendmail)
686               (boundp 'sendmail-program)
687               sendmail-program
688               (executable-find sendmail-program))
689          'message-send-mail-with-sendmail)
690         ((and (locate-library "smtpmail")
691               (boundp 'smtpmail-default-smtp-server)
692               smtpmail-default-smtp-server)
693          'message-smtpmail-send-it)
694         ((locate-library "mailclient")
695          'message-send-mail-with-mailclient)
696         (t
697          (error "Don't know how to send mail.  Please customize `message-send-mail-function'"))))
698
699 (defun message-default-send-mail-function ()
700   (cond ((eq send-mail-function 'smtpmail-send-it) 'message-smtpmail-send-it)
701         ((eq send-mail-function 'feedmail-send-it) 'feedmail-send-it)
702         ((eq send-mail-function 'sendmail-query-once) 'sendmail-query-once)
703         ((eq send-mail-function 'mailclient-send-it)
704          'message-send-mail-with-mailclient)
705         (t (message-send-mail-function))))
706
707 ;; Useful to set in site-init.el
708 (defcustom message-send-mail-function (message-default-send-mail-function)
709   "Function to call to send the current buffer as mail.
710 The headers should be delimited by a line whose contents match the
711 variable `mail-header-separator'.
712
713 Valid values include `message-send-mail-with-sendmail'
714 `message-send-mail-with-mh', `message-send-mail-with-qmail',
715 `message-smtpmail-send-it', `smtpmail-send-it',
716 `feedmail-send-it' and `message-send-mail-with-mailclient'.  The
717 default is system dependent and determined by the function
718 `message-send-mail-function'.
719
720 See also `send-mail-function'."
721   :type '(radio (function-item message-send-mail-with-sendmail)
722                 (function-item message-send-mail-with-mh)
723                 (function-item message-send-mail-with-qmail)
724                 (function-item message-smtpmail-send-it)
725                 (function-item smtpmail-send-it)
726                 (function-item feedmail-send-it)
727                 (function-item message-send-mail-with-mailclient
728                                :tag "Use Mailclient package")
729                 (function :tag "Other"))
730   :group 'message-sending
731   :version "23.2"
732   :initialize 'custom-initialize-default
733   :link '(custom-manual "(message)Mail Variables")
734   :group 'message-mail)
735
736 (defcustom message-send-news-function 'message-send-news
737   "Function to call to send the current buffer as news.
738 The headers should be delimited by a line whose contents match the
739 variable `mail-header-separator'."
740   :group 'message-sending
741   :group 'message-news
742   :link '(custom-manual "(message)News Variables")
743   :type 'function)
744
745 (defcustom message-reply-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)Reply")
751   :type '(choice function (const nil)))
752
753 (defcustom message-wide-reply-to-function nil
754   "If non-nil, function that should return a list of headers.
755 This function should pick out addresses from the To, Cc, and From headers
756 and respond with new To and Cc headers."
757   :group 'message-interface
758   :link '(custom-manual "(message)Wide Reply")
759   :type '(choice function (const nil)))
760
761 (defcustom message-followup-to-function nil
762   "If non-nil, function that should return a list of headers.
763 This function should pick out addresses from the To, Cc, and From headers
764 and respond with new To and Cc headers."
765   :group 'message-interface
766   :link '(custom-manual "(message)Followup")
767   :type '(choice function (const nil)))
768
769 (defcustom message-extra-wide-headers nil
770   "If non-nil, a list of additional address headers.
771 These are used when composing a wide reply."
772   :group 'message-sending
773   :type '(repeat string))
774
775 (defcustom message-use-followup-to 'ask
776   "*Specifies what to do with Followup-To header.
777 If nil, always ignore the header.  If it is t, use its value, but
778 query before using the \"poster\" value.  If it is the symbol `ask',
779 always query the user whether to use the value.  If it is the symbol
780 `use', always use the value."
781   :group 'message-interface
782   :link '(custom-manual "(message)Followup")
783   :type '(choice (const :tag "ignore" nil)
784                  (const :tag "use & query" t)
785                  (const use)
786                  (const ask)))
787
788 (defcustom message-use-mail-followup-to 'use
789   "*Specifies what to do with Mail-Followup-To header.
790 If nil, always ignore the header.  If it is the symbol `ask', always
791 query the user whether to use the value.  If it is the symbol `use',
792 always use the value."
793   :version "22.1"
794   :group 'message-interface
795   :link '(custom-manual "(message)Mailing Lists")
796   :type '(choice (const :tag "ignore" nil)
797                  (const use)
798                  (const ask)))
799
800 (defcustom message-subscribed-address-functions nil
801   "*Specifies functions for determining list subscription.
802 If nil, do not attempt to determine list subscription with functions.
803 If non-nil, this variable contains a list of functions which return
804 regular expressions to match lists.  These functions can be used in
805 conjunction with `message-subscribed-regexps' and
806 `message-subscribed-addresses'."
807   :version "22.1"
808   :group 'message-interface
809   :link '(custom-manual "(message)Mailing Lists")
810   :type '(repeat sexp))
811
812 (defcustom message-subscribed-address-file nil
813   "*A file containing addresses the user is subscribed to.
814 If nil, do not look at any files to determine list subscriptions.  If
815 non-nil, each line of this file should be a mailing list address."
816   :version "22.1"
817   :group 'message-interface
818   :link '(custom-manual "(message)Mailing Lists")
819   :type '(radio file (const nil)))
820
821 (defcustom message-subscribed-addresses nil
822   "*Specifies a list of addresses the user is subscribed to.
823 If nil, do not use any predefined list subscriptions.  This list of
824 addresses can be used in conjunction with
825 `message-subscribed-address-functions' and `message-subscribed-regexps'."
826   :version "22.1"
827   :group 'message-interface
828   :link '(custom-manual "(message)Mailing Lists")
829   :type '(repeat string))
830
831 (defcustom message-subscribed-regexps nil
832   "*Specifies a list of addresses the user is subscribed to.
833 If nil, do not use any predefined list subscriptions.  This list of
834 regular expressions can be used in conjunction with
835 `message-subscribed-address-functions' and `message-subscribed-addresses'."
836   :version "22.1"
837   :group 'message-interface
838   :link '(custom-manual "(message)Mailing Lists")
839   :type '(repeat regexp))
840
841 (defcustom message-allow-no-recipients 'ask
842   "Specifies what to do when there are no recipients other than Gcc/Fcc.
843 If it is the symbol `always', the posting is allowed.  If it is the
844 symbol `never', the posting is not allowed.  If it is the symbol
845 `ask', you are prompted."
846   :version "22.1"
847   :group 'message-interface
848   :link '(custom-manual "(message)Message Headers")
849   :type '(choice (const always)
850                  (const never)
851                  (const ask)))
852
853 (defcustom message-sendmail-f-is-evil nil
854   "*Non-nil means don't add \"-f username\" to the sendmail command line.
855 Doing so would be even more evil than leaving it out."
856   :group 'message-sending
857   :link '(custom-manual "(message)Mail Variables")
858   :type 'boolean)
859
860 (defcustom message-sendmail-envelope-from nil
861   ;; In Emacs 24.1 this defaults to the value of `mail-envelope-from'
862   ;; if it is available, or defaults to nil.  sendmail.el provides it;
863   ;; the default value is nil in all (X)Emacsen that Gnus supports.
864   "*Envelope-from when sending mail with sendmail.
865 If this is nil, use `user-mail-address'.  If it is the symbol
866 `header', use the From: header of the message."
867   :version "23.2"
868   :type '(choice (string :tag "From name")
869                  (const :tag "Use From: header from message" header)
870                  (const :tag "Use `user-mail-address'" nil))
871   :link '(custom-manual "(message)Mail Variables")
872   :group 'message-sending)
873
874 (defcustom message-sendmail-extra-arguments nil
875   "Additional arguments to `sendmail-program'."
876   ;; E.g. '("-a" "account") for msmtp
877   :version "23.1" ;; No Gnus
878   :type '(repeat string)
879   ;; :link '(custom-manual "(message)Mail Variables")
880   :group 'message-sending)
881
882 ;; qmail-related stuff
883 (defcustom message-qmail-inject-program "/var/qmail/bin/qmail-inject"
884   "Location of the qmail-inject program."
885   :group 'message-sending
886   :link '(custom-manual "(message)Mail Variables")
887   :type 'file)
888
889 (defcustom message-qmail-inject-args nil
890   "Arguments passed to qmail-inject programs.
891 This should be a list of strings, one string for each argument.
892 It may also be a function.
893
894 For e.g., if you wish to set the envelope sender address so that bounces
895 go to the right place or to deal with listserv's usage of that address, you
896 might set this variable to (\"-f\" \"you@some.where\")."
897   :group 'message-sending
898   :link '(custom-manual "(message)Mail Variables")
899   :type '(choice (function)
900                  (repeat string)))
901
902 (defvar gnus-post-method)
903 (defvar gnus-select-method)
904 (defcustom message-post-method
905   (cond ((and (boundp 'gnus-post-method)
906               (listp gnus-post-method)
907               gnus-post-method)
908          gnus-post-method)
909         ((boundp 'gnus-select-method)
910          gnus-select-method)
911         (t '(nnspool "")))
912   "*Method used to post news.
913 Note that when posting from inside Gnus, for instance, this
914 variable isn't used."
915   :group 'message-news
916   :group 'message-sending
917   ;; This should be the `gnus-select-method' widget, but that might
918   ;; create a dependence to `gnus.el'.
919   :type 'sexp)
920
921 (defcustom message-generate-headers-first nil
922   "Which headers should be generated before starting to compose a message.
923 If t, generate all required headers.  This can also be a list of headers to
924 generate.  The variables `message-required-news-headers' and
925 `message-required-mail-headers' specify which headers to generate.
926
927 Note that the variable `message-deletable-headers' specifies headers which
928 are to be deleted and then re-generated before sending, so this variable
929 will not have a visible effect for those headers."
930   :group 'message-headers
931   :link '(custom-manual "(message)Message Headers")
932   :type '(choice (const :tag "None" nil)
933                  (const :tag "All" t)
934                  (repeat (sexp :tag "Header"))))
935
936 (defcustom message-fill-column 72
937   "Column beyond which automatic line-wrapping should happen.
938 Local value for message buffers.  If non-nil, also turn on
939 auto-fill in message buffers."
940   :group 'message-various
941   ;; :link '(custom-manual "(message)Message Headers")
942   :type '(choice (const :tag "Don't turn on auto fill" nil)
943                  (integer)))
944
945 (defcustom message-setup-hook nil
946   "Normal hook, run each time a new outgoing message is initialized.
947 The function `message-setup' runs this hook."
948   :group 'message-various
949   :link '(custom-manual "(message)Various Message Variables")
950   :type 'hook)
951
952 (defcustom message-cancel-hook nil
953   "Hook run when canceling articles."
954   :group 'message-various
955   :link '(custom-manual "(message)Various Message Variables")
956   :type 'hook)
957
958 (defcustom message-signature-setup-hook nil
959   "Normal hook, run each time a new outgoing message is initialized.
960 It is run after the headers have been inserted and before
961 the signature is inserted."
962   :group 'message-various
963   :link '(custom-manual "(message)Various Message Variables")
964   :type 'hook)
965
966 (defcustom message-mode-hook nil
967   "Hook run in message mode buffers."
968   :group 'message-various
969   :type 'hook)
970
971 (defcustom message-header-hook nil
972   "Hook run in a message mode buffer narrowed to the headers."
973   :group 'message-various
974   :type 'hook)
975
976 (defcustom message-header-setup-hook nil
977   "Hook called narrowed to the headers when setting up a message buffer."
978   :group 'message-various
979   :link '(custom-manual "(message)Various Message Variables")
980   :type 'hook)
981
982 (defcustom message-minibuffer-local-map
983   (let ((map (make-sparse-keymap 'message-minibuffer-local-map)))
984     (set-keymap-parent map minibuffer-local-map)
985     map)
986   "Keymap for `message-read-from-minibuffer'."
987   ;; FIXME improve type.
988   :type '(restricted-sexp :match-alternatives (symbolp keymapp))
989   :version "22.1"
990   :group 'message-various)
991
992 (defcustom message-citation-line-function 'message-insert-citation-line
993   "*Function called to insert the \"Whomever writes:\" line.
994
995 Predefined functions include `message-insert-citation-line' and
996 `message-insert-formatted-citation-line' (see the variable
997 `message-citation-line-format').
998
999 Note that Gnus provides a feature where the reader can click on
1000 `writes:' to hide the cited text.  If you change this line too much,
1001 people who read your message will have to change their Gnus
1002 configuration.  See the variable `gnus-cite-attribution-suffix'."
1003   :type '(choice
1004           (function-item :tag "plain" message-insert-citation-line)
1005           (function-item :tag "formatted" message-insert-formatted-citation-line)
1006           (function :tag "Other"))
1007   :link '(custom-manual "(message)Insertion Variables")
1008   :group 'message-insertion)
1009
1010 (defcustom message-citation-line-format "On %a, %b %d %Y, %N wrote:\n"
1011   "Format of the \"Whomever writes:\" line.
1012
1013 The string is formatted using `format-spec'.  The following constructs
1014 are replaced:
1015
1016   %f   The full From, e.g. \"John Doe <john.doe@example.invalid>\".
1017   %n   The mail address, e.g. \"john.doe@example.invalid\".
1018   %N   The real name if present, e.g.: \"John Doe\", else fall
1019        back to the mail address.
1020   %F   The first name if present, e.g.: \"John\", else fall
1021        back to the mail address.
1022   %L   The last name if present, e.g.: \"Doe\".
1023   %Z, %z   The time zone in the numeric form, e.g.:\"+0000\".
1024
1025 All other format specifiers are passed to `format-time-string'
1026 which is called using the date from the article your replying to, but
1027 the date in the formatted string will be expressed in the author's
1028 time zone as much as possible.
1029 Extracting the first (%F) and last name (%L) is done heuristically,
1030 so you should always check it yourself.
1031
1032 Please also read the note in the documentation of
1033 `message-citation-line-function'."
1034   :type '(choice (const :tag "Plain" "%f writes:")
1035                  (const :tag "Include date" "On %a, %b %d %Y, %n wrote:")
1036                  string)
1037   :link '(custom-manual "(message)Insertion Variables")
1038   :version "23.1" ;; No Gnus
1039   :group 'message-insertion)
1040
1041 (defcustom message-yank-prefix "> "
1042   ;; In Emacs 24.1 this defaults to the value of `mail-yank-prefix'
1043   ;; that defaults to:
1044   ;; `nil' in Emacs 22.1~23.1;
1045   ;; "> " in Emacs 23.2, 24.1, XEmacs 21.4, 21.5, and SXEmacs 22.1
1046   "*Prefix inserted on the lines of yanked messages.
1047 Fix `message-cite-prefix-regexp' if it is set to an abnormal value.
1048 See also `message-yank-cited-prefix' and `message-yank-empty-prefix'."
1049   :version "23.2"
1050   :type 'string
1051   :link '(custom-manual "(message)Insertion Variables")
1052   :group 'message-insertion)
1053
1054 (defcustom message-yank-cited-prefix ">"
1055   "*Prefix inserted on cited lines of yanked messages.
1056 Fix `message-cite-prefix-regexp' if it is set to an abnormal value.
1057 See also `message-yank-prefix' and `message-yank-empty-prefix'."
1058   :version "22.1"
1059   :type 'string
1060   :link '(custom-manual "(message)Insertion Variables")
1061   :group 'message-insertion)
1062
1063 (defcustom message-yank-empty-prefix ">"
1064   "*Prefix inserted on empty lines of yanked messages.
1065 See also `message-yank-prefix' and `message-yank-cited-prefix'."
1066   :version "22.1"
1067   :type 'string
1068   :link '(custom-manual "(message)Insertion Variables")
1069   :group 'message-insertion)
1070
1071 (defcustom message-indentation-spaces 3
1072   ;; In Emacs 24.1 this defaults to the value of
1073   ;; `mail-indentation-spaces' that defaults to `3' in Emacs 22.1~24.1,
1074   ;; and SXEmacs 22.1.  In XEmacs 21.4 and 21.5, sendmail.el provides
1075   ;; it; the defalut value is `3'.
1076   "*Number of spaces to insert at the beginning of each cited line.
1077 Used by `message-yank-original' via `message-yank-cite'."
1078   :version "23.2"
1079   :group 'message-insertion
1080   :link '(custom-manual "(message)Insertion Variables")
1081   :type 'integer)
1082
1083 (defcustom message-cite-function 'message-cite-original-without-signature
1084   "*Function for citing an original message.
1085 Predefined functions include `message-cite-original' and
1086 `message-cite-original-without-signature'.
1087 Note that these functions use `mail-citation-hook' if that is non-nil."
1088   :type '(radio (function-item message-cite-original)
1089                 (function-item message-cite-original-without-signature)
1090                 (function-item sc-cite-original)
1091                 (function :tag "Other"))
1092   :link '(custom-manual "(message)Insertion Variables")
1093   :version "22.3" ;; Gnus 5.10.12 (changed default)
1094   :group 'message-insertion)
1095
1096 (defcustom message-indent-citation-function 'message-indent-citation
1097   "*Function for modifying a citation just inserted in the mail buffer.
1098 This can also be a list of functions.  Each function can find the
1099 citation between (point) and (mark t).  And each function should leave
1100 point and mark around the citation text as modified."
1101   :type 'function
1102   :link '(custom-manual "(message)Insertion Variables")
1103   :group 'message-insertion)
1104
1105 (defcustom message-signature t
1106   ;; In Emacs 24.1 this defaults to the value of `mail-signature' that
1107   ;; defaults to:
1108   ;; `nil' in Emacs 22.1~23.1, XEmacs 21.4, 21.5, and SXEmacs 22.1;
1109   ;; `t' in Emacs 23.2, and 24.1
1110   "*String to be inserted at the end of the message buffer.
1111 If t, the `message-signature-file' file will be inserted instead.
1112 If a function, the result from the function will be used instead.
1113 If a form, the result from the form will be used instead."
1114   :version "23.2"
1115   :type 'sexp
1116   :link '(custom-manual "(message)Insertion Variables")
1117   :group 'message-insertion)
1118
1119 (defcustom message-signature-file "~/.signature"
1120   ;; In Emacs 24.1 this defaults to the value of `mail-signature-file'
1121   ;; that defaults to "~/.signature" in Emacs 22.1~24.1, and SXEmacs
1122   ;; 22.1.  In XEmacs 21.4 and 21.5, sendmail.el provides it;
1123   ;; the defalut value is "~/.signature".
1124   "*Name of file containing the text inserted at end of message buffer.
1125 Ignored if the named file doesn't exist.
1126 If nil, don't insert a signature.
1127 If a path is specified, the value of `message-signature-directory' is ignored,
1128 even if set."
1129   :version "23.2"
1130   :type '(choice file (const :tags "None" nil))
1131   :link '(custom-manual "(message)Insertion Variables")
1132   :group 'message-insertion)
1133
1134 (defcustom message-signature-directory nil
1135   "*Name of directory containing signature files.
1136 Comes in handy if you have many such files, handled via posting styles for
1137 instance.
1138 If nil, `message-signature-file' is expected to specify the directory if
1139 needed."
1140   :type '(choice string (const :tags "None" nil))
1141   :link '(custom-manual "(message)Insertion Variables")
1142   :group 'message-insertion)
1143
1144 (defcustom message-signature-insert-empty-line t
1145   "*If non-nil, insert an empty line before the signature separator."
1146   :version "22.1"
1147   :type 'boolean
1148   :link '(custom-manual "(message)Insertion Variables")
1149   :group 'message-insertion)
1150
1151 (defcustom message-cite-reply-position 'traditional
1152   "*Where the reply should be positioned.
1153 If `traditional', reply inline.
1154 If `above', reply above quoted text.
1155 If `below', reply below quoted text.
1156
1157 Note: Many newsgroups frown upon nontraditional reply styles. You
1158 probably want to set this variable only for specific groups,
1159 e.g. using `gnus-posting-styles':
1160
1161   (eval (set (make-local-variable \\='message-cite-reply-position) \\='above))"
1162   :version "24.1"
1163   :type '(choice (const :tag "Reply inline" traditional)
1164                  (const :tag "Reply above" above)
1165                  (const :tag "Reply below" below))
1166   :group 'message-insertion)
1167
1168 (defcustom message-cite-style nil
1169   "*The overall style to be used when yanking cited text.
1170 Value is either nil (no variable overrides) or a let-style list
1171 of pairs (VARIABLE VALUE) that will be bound in
1172 `message-yank-original' to do the quoting.
1173
1174 Presets to impersonate popular mail agents are found in the
1175 message-cite-style-* variables.  This variable is intended for
1176 use in `gnus-posting-styles', such as:
1177
1178   ((posting-from-work-p) (eval (set (make-local-variable \\='message-cite-style) message-cite-style-outlook)))"
1179   :version "24.1"
1180   :group 'message-insertion
1181   :type '(choice (const :tag "Do not override variables" :value nil)
1182                  (const :tag "MS Outlook" :value message-cite-style-outlook)
1183                  (const :tag "Mozilla Thunderbird" :value message-cite-style-thunderbird)
1184                  (const :tag "Gmail" :value message-cite-style-gmail)
1185                  (variable :tag "User-specified")))
1186
1187 (defconst message-cite-style-outlook
1188   '((message-cite-function  'message-cite-original)
1189     (message-citation-line-function  'message-insert-formatted-citation-line)
1190     (message-cite-reply-position 'above)
1191     (message-yank-prefix  "")
1192     (message-yank-cited-prefix  "")
1193     (message-yank-empty-prefix  "")
1194     (message-citation-line-format  "\n\n-----------------------\nOn %a, %b %d %Y, %N wrote:\n"))
1195   "Message citation style used by MS Outlook. Use with message-cite-style.")
1196
1197 (defconst message-cite-style-thunderbird
1198   '((message-cite-function  'message-cite-original)
1199     (message-citation-line-function  'message-insert-formatted-citation-line)
1200     (message-cite-reply-position 'above)
1201     (message-yank-prefix  "> ")
1202     (message-yank-cited-prefix  ">")
1203     (message-yank-empty-prefix  ">")
1204     (message-citation-line-format "On %D %R %p, %N wrote:"))
1205   "Message citation style used by Mozilla Thunderbird. Use with message-cite-style.")
1206
1207 (defconst message-cite-style-gmail
1208   '((message-cite-function  'message-cite-original)
1209     (message-citation-line-function  'message-insert-formatted-citation-line)
1210     (message-cite-reply-position 'above)
1211     (message-yank-prefix  "    ")
1212     (message-yank-cited-prefix  "    ")
1213     (message-yank-empty-prefix  "    ")
1214     (message-citation-line-format "On %e %B %Y %R, %f wrote:\n"))
1215   "Message citation style used by Gmail. Use with message-cite-style.")
1216
1217 (defcustom message-distribution-function nil
1218   "*Function called to return a Distribution header."
1219   :group 'message-news
1220   :group 'message-headers
1221   :link '(custom-manual "(message)News Headers")
1222   :type '(choice function (const nil)))
1223
1224 (defcustom message-expires 14
1225   "Number of days before your article expires."
1226   :group 'message-news
1227   :group 'message-headers
1228   :link '(custom-manual "(message)News Headers")
1229   :type 'integer)
1230
1231 (defcustom message-user-path nil
1232   "If nil, use the NNTP server name in the Path header.
1233 If stringp, use this; if non-nil, use no host name (user name only)."
1234   :group 'message-news
1235   :group 'message-headers
1236   :link '(custom-manual "(message)News Headers")
1237   :type '(choice (const :tag "nntp" nil)
1238                  (string :tag "name")
1239                  (sexp :tag "none" :format "%t" t)))
1240
1241 ;; This can be the name of a buffer, or a cons cell (FUNCTION . ARGS)
1242 ;; for yanking the original buffer.
1243 (defvar message-reply-buffer nil)
1244 (defvar message-reply-headers nil
1245   "The headers of the current replied article.
1246 It is a vector of the following headers:
1247 [number subject from date id references chars lines xref extra].")
1248 (defvar message-newsreader nil)
1249 (defvar message-mailer nil)
1250 (defvar message-sent-message-via nil)
1251 (defvar message-checksum nil)
1252 (defvar message-send-actions nil
1253   "A list of actions to be performed upon successful sending of a message.")
1254 (defvar message-return-action nil
1255   "Action to return to the caller after sending or postponing a message.")
1256 (defvar message-exit-actions nil
1257   "A list of actions to be performed upon exiting after sending a message.")
1258 (defvar message-kill-actions nil
1259   "A list of actions to be performed before killing a message buffer.")
1260 (defvar message-postpone-actions nil
1261   "A list of actions to be performed after postponing a message.")
1262
1263 (define-widget 'message-header-lines 'text
1264   "All header lines must be LFD terminated."
1265   :format "%{%t%}:%n%v"
1266   :valid-regexp "^\\'"
1267   :error "All header lines must be newline terminated")
1268
1269 (defcustom message-default-headers ""
1270   "Header lines to be inserted in outgoing messages.
1271 This can be set to a string containing or a function returning
1272 header lines to be inserted before you edit the message, so you
1273 can edit or delete these lines.  If set to a function, it is
1274 called and its result is inserted."
1275   :version "23.2"
1276   :group 'message-headers
1277   :link '(custom-manual "(message)Message Headers")
1278   :type '(choice
1279           (message-header-lines :tag "String")
1280           (function :tag "Function")))
1281
1282 (defcustom message-default-mail-headers
1283   ;; Ease the transition from mail-mode to message-mode.  See bugs#4431, 5555.
1284   (concat (if (and (boundp 'mail-default-reply-to)
1285                    (stringp mail-default-reply-to))
1286               (format "Reply-to: %s\n" mail-default-reply-to))
1287           (if (and (boundp 'mail-self-blind)
1288                    mail-self-blind)
1289               (format "BCC: %s\n" user-mail-address))
1290           (if (and (boundp 'mail-archive-file-name)
1291                    (stringp mail-archive-file-name))
1292               (format "FCC: %s\n" mail-archive-file-name))
1293           ;; Use the value of `mail-default-headers' if available.
1294           ;; Note: as for XEmacs 21.4 and 21.5, it is unavailable
1295           ;; unless sendmail.el is loaded.
1296           (if (boundp 'mail-default-headers)
1297               mail-default-headers))
1298   "*A string of header lines to be inserted in outgoing mails."
1299   :version "23.2"
1300   :group 'message-headers
1301   :group 'message-mail
1302   :link '(custom-manual "(message)Mail Headers")
1303   :type 'message-header-lines)
1304
1305 (defcustom message-default-news-headers ""
1306   "*A string of header lines to be inserted in outgoing news articles."
1307   :group 'message-headers
1308   :group 'message-news
1309   :link '(custom-manual "(message)News Headers")
1310   :type 'message-header-lines)
1311
1312 ;; Note: could use /usr/ucb/mail instead of sendmail;
1313 ;; options -t, and -v if not interactive.
1314 (defcustom message-mailer-swallows-blank-line
1315   (if (and (string-match "sparc-sun-sunos\\(\\'\\|[^5]\\)"
1316                          system-configuration)
1317            (file-readable-p "/etc/sendmail.cf")
1318            (with-temp-buffer
1319              (insert-file-contents "/etc/sendmail.cf")
1320              (goto-char (point-min))
1321              (let ((case-fold-search nil))
1322                (re-search-forward "^OR\\>" nil t))))
1323       ;; According to RFC822, "The field-name must be composed of printable
1324       ;; ASCII characters (i. e., characters that have decimal values between
1325       ;; 33 and 126, except colon)", i. e., any chars except ctl chars,
1326       ;; space, or colon.
1327       '(looking-at "[ \t]\\|[][!\"#$%&'()*+,-./0-9;<=>?@A-Z\\\\^_`a-z{|}~]+:"))
1328   "*Set this non-nil if the system's mailer runs the header and body together.
1329 \(This problem exists on Sunos 4 when sendmail is run in remote mode.)
1330 The value should be an expression to test whether the problem will
1331 actually occur."
1332   :group 'message-sending
1333   :link '(custom-manual "(message)Mail Variables")
1334   :type 'sexp)
1335
1336 ;;;###autoload
1337 (define-mail-user-agent 'message-user-agent
1338   'message-mail 'message-send-and-exit
1339   'message-kill-buffer 'message-send-hook)
1340
1341 (defvar message-mh-deletable-headers '(Message-ID Date Lines Sender)
1342   "If non-nil, delete the deletable headers before feeding to mh.")
1343
1344 (defvar message-send-method-alist
1345   '((news message-news-p message-send-via-news)
1346     (mail message-mail-p message-send-via-mail))
1347   "Alist of ways to send outgoing messages.
1348 Each element has the form
1349
1350   (TYPE PREDICATE FUNCTION)
1351
1352 where TYPE is a symbol that names the method; PREDICATE is a function
1353 called without any parameters to determine whether the message is
1354 a message of type TYPE; and FUNCTION is a function to be called if
1355 PREDICATE returns non-nil.  FUNCTION is called with one parameter --
1356 the prefix.")
1357
1358 (defcustom message-mail-alias-type 'abbrev
1359   "*What alias expansion type to use in Message buffers.
1360 The default is `abbrev', which uses mailabbrev.  `ecomplete' uses
1361 an electric completion mode.  nil switches mail aliases off.
1362 This can also be a list of values."
1363   :group 'message
1364   :link '(custom-manual "(message)Mail Aliases")
1365   :type '(choice (const :tag "Use Mailabbrev" abbrev)
1366                  (const :tag "Use ecomplete" ecomplete)
1367                  (const :tag "No expansion" nil)))
1368
1369 (defcustom message-self-insert-commands '(self-insert-command)
1370   "List of `self-insert-command's used to trigger ecomplete.
1371 When one of those commands is invoked to enter a character in To or Cc
1372 header, ecomplete will suggest the candidates of recipients (see also
1373 `message-mail-alias-type').  If you use some tool to enter non-ASCII
1374 text and it replaces `self-insert-command' with the other command, e.g.
1375 `egg-self-insert-command', you may want to add it to this list."
1376   :group 'message-various
1377   :type '(repeat function))
1378
1379 (defcustom message-auto-save-directory
1380   (if (file-writable-p message-directory)
1381       (file-name-as-directory (expand-file-name "drafts" message-directory))
1382     "~/")
1383   "*Directory where Message auto-saves buffers if Gnus isn't running.
1384 If nil, Message won't auto-save."
1385   :group 'message-buffers
1386   :link '(custom-manual "(message)Various Message Variables")
1387   :type '(choice directory (const :tag "Don't auto-save" nil)))
1388
1389 (defcustom message-default-charset
1390   (and (not (mm-multibyte-p)) 'iso-8859-1)
1391   "Default charset used in non-MULE Emacsen.
1392 If nil, you might be asked to input the charset."
1393   :version "21.1"
1394   :group 'message
1395   :link '(custom-manual "(message)Various Message Variables")
1396   :type 'symbol)
1397
1398 (defcustom message-dont-reply-to-names
1399   (and (boundp 'mail-dont-reply-to-names) mail-dont-reply-to-names)
1400   "*Addresses to prune when doing wide replies.
1401 This can be a regexp or a list of regexps.  Also, a value of nil means
1402 exclude your own user name only."
1403   :version "24.3"
1404   :group 'message
1405   :link '(custom-manual "(message)Wide Reply")
1406   :type '(choice (const :tag "Yourself" nil)
1407                  regexp
1408                  (repeat :tag "Regexp List" regexp)))
1409
1410 (defsubst message-dont-reply-to-names ()
1411   (gmm-regexp-concat message-dont-reply-to-names))
1412
1413 (defvar message-shoot-gnksa-feet nil
1414   "*A list of GNKSA feet you are allowed to shoot.
1415 Gnus gives you all the opportunity you could possibly want for
1416 shooting yourself in the foot.  Also, Gnus allows you to shoot the
1417 feet of Good Net-Keeping Seal of Approval.  The following are foot
1418 candidates:
1419 `empty-article'     Allow you to post an empty article;
1420 `quoted-text-only'  Allow you to post quoted text only;
1421 `multiple-copies'   Allow you to post multiple copies;
1422 `cancel-messages'   Allow you to cancel or supersede messages from
1423                     your other email addresses;
1424 `canlock-verify'    Allow you to cancel messages without verifying canlock.")
1425
1426 (defsubst message-gnksa-enable-p (feature)
1427   (or (not (listp message-shoot-gnksa-feet))
1428       (memq feature message-shoot-gnksa-feet)))
1429
1430 (defcustom message-hidden-headers '("^References:" "^Face:" "^X-Face:"
1431                                     "^X-Draft-From:")
1432   "Regexp of headers to be hidden when composing new messages.
1433 This can also be a list of regexps to match headers.  Or a list
1434 starting with `not' and followed by regexps."
1435   :version "22.1"
1436   :group 'message
1437   :link '(custom-manual "(message)Message Headers")
1438   :type '(choice
1439           :format "%{%t%}: %[Value Type%] %v"
1440           (regexp :menu-tag "regexp" :format "regexp\n%t: %v")
1441           (repeat :menu-tag "(regexp ...)" :format "(regexp ...)\n%v%i"
1442                   (regexp :format "%t: %v"))
1443           (cons :menu-tag "(not regexp ...)" :format "(not regexp ...)\n%v"
1444                 (const not)
1445                 (repeat :format "%v%i"
1446                         (regexp :format "%t: %v")))))
1447
1448 (defcustom message-cite-articles-with-x-no-archive t
1449   "If non-nil, cite text from articles that has X-No-Archive set."
1450   :group 'message
1451   :type 'boolean)
1452
1453 ;;; Internal variables.
1454 ;;; Well, not really internal.
1455
1456 (defvar message-mode-syntax-table
1457   (let ((table (copy-syntax-table text-mode-syntax-table)))
1458     (modify-syntax-entry ?% ". " table)
1459     (modify-syntax-entry ?> ". " table)
1460     (modify-syntax-entry ?< ". " table)
1461     table)
1462   "Syntax table used while in Message mode.")
1463
1464 (defface message-header-to
1465   '((((class color)
1466       (background dark))
1467      (:foreground "DarkOliveGreen1" :bold t))
1468     (((class color)
1469       (background light))
1470      (:foreground "MidnightBlue" :bold t))
1471     (t
1472      (:bold t :italic t)))
1473   "Face used for displaying From headers."
1474   :group 'message-faces)
1475 ;; backward-compatibility alias
1476 (put 'message-header-to-face 'face-alias 'message-header-to)
1477 (put 'message-header-to-face 'obsolete-face "22.1")
1478
1479 (defface message-header-cc
1480   '((((class color)
1481       (background dark))
1482      (:foreground "chartreuse1" :bold t))
1483     (((class color)
1484       (background light))
1485      (:foreground "MidnightBlue"))
1486     (t
1487      (:bold t)))
1488   "Face used for displaying Cc headers."
1489   :group 'message-faces)
1490 ;; backward-compatibility alias
1491 (put 'message-header-cc-face 'face-alias 'message-header-cc)
1492 (put 'message-header-cc-face 'obsolete-face "22.1")
1493
1494 (defface message-header-subject
1495   '((((class color)
1496       (background dark))
1497      (:foreground "OliveDrab1"))
1498     (((class color)
1499       (background light))
1500      (:foreground "navy blue" :bold t))
1501     (t
1502      (:bold t)))
1503   "Face used for displaying subject headers."
1504   :group 'message-faces)
1505 ;; backward-compatibility alias
1506 (put 'message-header-subject-face 'face-alias 'message-header-subject)
1507 (put 'message-header-subject-face 'obsolete-face "22.1")
1508
1509 (defface message-header-newsgroups
1510   '((((class color)
1511       (background dark))
1512      (:foreground "yellow" :bold t :italic t))
1513     (((class color)
1514       (background light))
1515      (:foreground "blue4" :bold t :italic t))
1516     (t
1517      (:bold t :italic t)))
1518   "Face used for displaying newsgroups headers."
1519   :group 'message-faces)
1520 ;; backward-compatibility alias
1521 (put 'message-header-newsgroups-face 'face-alias 'message-header-newsgroups)
1522 (put 'message-header-newsgroups-face 'obsolete-face "22.1")
1523
1524 (defface message-header-other
1525   '((((class color)
1526       (background dark))
1527      (:foreground "VioletRed1"))
1528     (((class color)
1529       (background light))
1530      (:foreground "steel blue"))
1531     (t
1532      (:bold t :italic t)))
1533   "Face used for displaying newsgroups headers."
1534   :group 'message-faces)
1535 ;; backward-compatibility alias
1536 (put 'message-header-other-face 'face-alias 'message-header-other)
1537 (put 'message-header-other-face 'obsolete-face "22.1")
1538
1539 (defface message-header-name
1540   '((((class color)
1541       (background dark))
1542      (:foreground "green"))
1543     (((class color)
1544       (background light))
1545      (:foreground "cornflower blue"))
1546     (t
1547      (:bold t)))
1548   "Face used for displaying header names."
1549   :group 'message-faces)
1550 ;; backward-compatibility alias
1551 (put 'message-header-name-face 'face-alias 'message-header-name)
1552 (put 'message-header-name-face 'obsolete-face "22.1")
1553
1554 (defface message-header-xheader
1555   '((((class color)
1556       (background dark))
1557      (:foreground "DeepSkyBlue1"))
1558     (((class color)
1559       (background light))
1560      (:foreground "blue"))
1561     (t
1562      (:bold t)))
1563   "Face used for displaying X-Header headers."
1564   :group 'message-faces)
1565 ;; backward-compatibility alias
1566 (put 'message-header-xheader-face 'face-alias 'message-header-xheader)
1567 (put 'message-header-xheader-face 'obsolete-face "22.1")
1568
1569 (defface message-separator
1570   '((((class color)
1571       (background dark))
1572      (:foreground "LightSkyBlue1"))
1573     (((class color)
1574       (background light))
1575      (:foreground "brown"))
1576     (t
1577      (:bold t)))
1578   "Face used for displaying the separator."
1579   :group 'message-faces)
1580 ;; backward-compatibility alias
1581 (put 'message-separator-face 'face-alias 'message-separator)
1582 (put 'message-separator-face 'obsolete-face "22.1")
1583
1584 (defface message-cited-text
1585   '((((class color)
1586       (background dark))
1587      (:foreground "LightPink1"))
1588     (((class color)
1589       (background light))
1590      (:foreground "red"))
1591     (t
1592      (:bold t)))
1593   "Face used for displaying cited text names."
1594   :group 'message-faces)
1595 ;; backward-compatibility alias
1596 (put 'message-cited-text-face 'face-alias 'message-cited-text)
1597 (put 'message-cited-text-face 'obsolete-face "22.1")
1598
1599 (defface message-mml
1600   '((((class color)
1601       (background dark))
1602      (:foreground "MediumSpringGreen"))
1603     (((class color)
1604       (background light))
1605      (:foreground "ForestGreen"))
1606     (t
1607      (:bold t)))
1608   "Face used for displaying MML."
1609   :group 'message-faces)
1610 ;; backward-compatibility alias
1611 (put 'message-mml-face 'face-alias 'message-mml)
1612 (put 'message-mml-face 'obsolete-face "22.1")
1613
1614 (defun message-font-lock-make-header-matcher (regexp)
1615   (let ((form
1616          `(lambda (limit)
1617             (let ((start (point)))
1618               (save-restriction
1619                 (widen)
1620                 (goto-char (point-min))
1621                 (if (re-search-forward
1622                      (concat "^" (regexp-quote mail-header-separator) "$")
1623                      nil t)
1624                     (setq limit (min limit (match-beginning 0))))
1625                 (goto-char start))
1626               (and (< start limit)
1627                    (re-search-forward ,regexp limit t))))))
1628     (if (featurep 'bytecomp)
1629         (byte-compile form)
1630       form)))
1631
1632 (defvar message-font-lock-keywords
1633   (let ((content "[ \t]*\\(.+\\(\n[ \t].*\\)*\\)\n?"))
1634     `((,(message-font-lock-make-header-matcher
1635          (concat "^\\([Tt]o:\\)" content))
1636        (1 'message-header-name)
1637        (2 'message-header-to nil t))
1638       (,(message-font-lock-make-header-matcher
1639          (concat "^\\(^[GBF]?[Cc][Cc]:\\|^[Rr]eply-[Tt]o:\\)" content))
1640        (1 'message-header-name)
1641        (2 'message-header-cc nil t))
1642       (,(message-font-lock-make-header-matcher
1643          (concat "^\\([Ss]ubject:\\)" content))
1644        (1 'message-header-name)
1645        (2 'message-header-subject nil t))
1646       (,(message-font-lock-make-header-matcher
1647          (concat "^\\([Nn]ewsgroups:\\|Followup-[Tt]o:\\)" content))
1648        (1 'message-header-name)
1649        (2 'message-header-newsgroups nil t))
1650       (,(message-font-lock-make-header-matcher
1651          (concat "^\\(X-[A-Za-z0-9-]+:\\|In-Reply-To:\\)" content))
1652        (1 'message-header-name)
1653        (2 'message-header-xheader))
1654       (,(message-font-lock-make-header-matcher
1655          (concat "^\\([A-Z][^: \n\t]+:\\)" content))
1656        (1 'message-header-name)
1657        (2 'message-header-other nil t))
1658       ,@(if (and mail-header-separator
1659                  (not (equal mail-header-separator "")))
1660             `((,(concat "^\\(" (regexp-quote mail-header-separator) "\\)$")
1661                1 'message-separator))
1662           nil)
1663       ((lambda (limit)
1664          (re-search-forward (concat "^\\("
1665                                     message-cite-prefix-regexp
1666                                     "\\).*")
1667                             limit t))
1668        (0 'message-cited-text))
1669       ("<#/?\\(multipart\\|part\\|external\\|mml\\|secure\\)[^>]*>"
1670        (0 'message-mml))))
1671   "Additional expressions to highlight in Message mode.")
1672
1673
1674 ;; XEmacs does it like this.  For Emacs, we have to set the
1675 ;; `font-lock-defaults' buffer-local variable.
1676 (put 'message-mode 'font-lock-defaults '(message-font-lock-keywords t))
1677
1678 (defvar message-face-alist
1679   '((bold . message-bold-region)
1680     (underline . underline-region)
1681     (default . (lambda (b e)
1682                  (message-unbold-region b e)
1683                  (ununderline-region b e))))
1684   "Alist of mail and news faces for facemenu.
1685 The cdr of each entry is a function for applying the face to a region.")
1686
1687 (defcustom message-send-hook nil
1688   "Hook run before sending messages.
1689 This hook is run quite early when sending."
1690   :group 'message-various
1691   :options '(ispell-message)
1692   :link '(custom-manual "(message)Various Message Variables")
1693   :type 'hook)
1694
1695 (defcustom message-send-mail-hook nil
1696   "Hook run before sending mail messages.
1697 This hook is run very late -- just before the message is sent as
1698 mail."
1699   :group 'message-various
1700   :link '(custom-manual "(message)Various Message Variables")
1701   :type 'hook)
1702
1703 (defcustom message-send-news-hook nil
1704   "Hook run before sending news messages.
1705 This hook is run very late -- just before the message is sent as
1706 news."
1707   :group 'message-various
1708   :link '(custom-manual "(message)Various Message Variables")
1709   :type 'hook)
1710
1711 (defcustom message-sent-hook nil
1712   "Hook run after sending messages."
1713   :group 'message-various
1714   :type 'hook)
1715
1716 (defvar message-send-coding-system 'binary
1717   "Coding system to encode outgoing mail.")
1718
1719 (defvar message-draft-coding-system
1720   mm-auto-save-coding-system
1721   "*Coding system to compose mail.
1722 If you'd like to make it possible to share draft files between XEmacs
1723 and Emacs, you may use `iso-2022-7bit' for this value at your own risk.
1724 Note that the coding-system `iso-2022-7bit' isn't suitable to all data.")
1725
1726 (defcustom message-send-mail-partially-limit nil
1727   "The limitation of messages sent as message/partial.
1728 The lower bound of message size in characters, beyond which the message
1729 should be sent in several parts.  If it is nil, the size is unlimited."
1730   :version "24.1"
1731   :group 'message-buffers
1732   :link '(custom-manual "(message)Mail Variables")
1733   :type '(choice (const :tag "unlimited" nil)
1734                  (integer 1000000)))
1735
1736 (defcustom message-alternative-emails nil
1737   "*Regexp matching alternative email addresses.
1738 The first address in the To, Cc or From headers of the original
1739 article matching this variable is used as the From field of
1740 outgoing messages.
1741
1742 This variable has precedence over posting styles and anything that runs
1743 off `message-setup-hook'."
1744   :group 'message-headers
1745   :link '(custom-manual "(message)Message Headers")
1746   :type '(choice (const :tag "Always use primary" nil)
1747                  regexp))
1748
1749 (defcustom message-hierarchical-addresses nil
1750   "A list of hierarchical mail address definitions.
1751
1752 Inside each entry, the first address is the \"top\" address, and
1753 subsequent addresses are subaddresses; this is used to indicate that
1754 mail sent to the first address will automatically be delivered to the
1755 subaddresses.  So if the first address appears in the recipient list
1756 for a message, the subaddresses will be removed (if present) before
1757 the mail is sent.  All addresses in this structure should be
1758 downcased."
1759   :version "22.1"
1760   :group 'message-headers
1761   :type '(repeat (repeat string)))
1762
1763 (defcustom message-mail-user-agent nil
1764   "Like `mail-user-agent'.
1765 Except if it is nil, use Gnus native MUA; if it is t, use
1766 `mail-user-agent'."
1767   :version "22.1"
1768   :type '(radio (const :tag "Gnus native"
1769                        :format "%t\n"
1770                        nil)
1771                 (const :tag "`mail-user-agent'"
1772                        :format "%t\n"
1773                        t)
1774                 (function-item :tag "Default Emacs mail"
1775                                :format "%t\n"
1776                                sendmail-user-agent)
1777                 (function-item :tag "Emacs interface to MH"
1778                                :format "%t\n"
1779                                mh-e-user-agent)
1780                 (function :tag "Other"))
1781   :version "21.1"
1782   :group 'message)
1783
1784 (defcustom message-wide-reply-confirm-recipients nil
1785   "Whether to confirm a wide reply to multiple email recipients.
1786 If this variable is nil, don't ask whether to reply to all recipients.
1787 If this variable is non-nil, pose the question \"Reply to all
1788 recipients?\" before a wide reply to multiple recipients.  If the user
1789 answers yes, reply to all recipients as usual.  If the user answers
1790 no, only reply back to the author."
1791   :version "22.1"
1792   :group 'message-headers
1793   :link '(custom-manual "(message)Wide Reply")
1794   :type 'boolean)
1795
1796 (defcustom message-user-fqdn nil
1797   "*Domain part of Message-Ids."
1798   :version "22.1"
1799   :group 'message-headers
1800   :link '(custom-manual "(message)News Headers")
1801   :type '(radio (const :format "%v  " nil)
1802                 (string :format "FQDN: %v")))
1803
1804 (defcustom message-use-idna
1805   (and (or (mm-coding-system-p 'utf-8)
1806            (condition-case nil
1807                (let (mucs-ignore-version-incompatibilities)
1808                  (require 'un-define))
1809              (error)))
1810        (condition-case nil
1811            (require 'idna)
1812          (file-error)
1813          (invalid-operation))
1814        idna-program
1815        (executable-find idna-program)
1816        (string= (idna-to-ascii "räksmörgås") "xn--rksmrgs-5wao1o")
1817        t)
1818   "Whether to encode non-ASCII in domain names into ASCII according to IDNA.
1819 GNU Libidn, and in particular the elisp package \"idna.el\" and
1820 the external program \"idn\", must be installed for this
1821 functionality to work."
1822   :version "22.1"
1823   :group 'message-headers
1824   :link '(custom-manual "(message)IDNA")
1825   :type '(choice (const :tag "Ask" ask)
1826                  (const :tag "Never" nil)
1827                  (const :tag "Always" t)))
1828
1829 (defcustom message-generate-hashcash (if (executable-find "hashcash") 'opportunistic)
1830   "*Whether to generate X-Hashcash: headers.
1831 If t, always generate hashcash headers.  If `opportunistic',
1832 only generate hashcash headers if it can be done without the user
1833 waiting (i.e., only asynchronously).
1834
1835 You must have the \"hashcash\" binary installed, see `hashcash-path'."
1836   :version "24.1"
1837   :group 'message-headers
1838   :link '(custom-manual "(message)Mail Headers")
1839   :type '(choice (const :tag "Always" t)
1840                  (const :tag "Never" nil)
1841                  (const :tag "Opportunistic" opportunistic)))
1842
1843 ;;; Internal variables.
1844
1845 (defvar message-sending-message "Sending...")
1846 (defvar message-buffer-list nil)
1847 (defvar message-this-is-news nil)
1848 (defvar message-this-is-mail nil)
1849 (defvar message-draft-article nil)
1850 (defvar message-mime-part nil)
1851 (defvar message-posting-charset nil)
1852 (defvar message-inserted-headers nil)
1853 (defvar message-inhibit-ecomplete nil)
1854
1855 ;; Byte-compiler warning
1856 (defvar gnus-active-hashtb)
1857 (defvar gnus-read-active-file)
1858
1859 ;;; Regexp matching the delimiter of messages in UNIX mail format
1860 ;;; (UNIX From lines), minus the initial ^.  It should be a copy
1861 ;;; of rmail.el's rmail-unix-mail-delimiter.
1862 (defvar message-unix-mail-delimiter
1863   (let ((time-zone-regexp
1864          (concat "\\([A-Z]?[A-Z]?[A-Z][A-Z]\\( DST\\)?"
1865                  "\\|[-+]?[0-9][0-9][0-9][0-9]"
1866                  "\\|"
1867                  "\\) *")))
1868     (concat
1869      "From "
1870
1871      ;; Many things can happen to an RFC 822 mailbox before it is put into
1872      ;; a `From' line.  The leading phrase can be stripped, e.g.
1873      ;; `Joe <@w.x:joe@y.z>' -> `<@w.x:joe@y.z>'.  The <> can be stripped, e.g.
1874      ;; `<@x.y:joe@y.z>' -> `@x.y:joe@y.z'.  Everything starting with a CRLF
1875      ;; can be removed, e.g.
1876      ;;         From: joe@y.z (Joe      K
1877      ;;                 User)
1878      ;; can yield `From joe@y.z (Joe    K Fri Mar 22 08:11:15 1996', and
1879      ;;         From: Joe User
1880      ;;                 <joe@y.z>
1881      ;; can yield `From Joe User Fri Mar 22 08:11:15 1996'.
1882      ;; The mailbox can be removed or be replaced by white space, e.g.
1883      ;;         From: "Joe User"{space}{tab}
1884      ;;                 <joe@y.z>
1885      ;; can yield `From {space}{tab} Fri Mar 22 08:11:15 1996',
1886      ;; where {space} and {tab} represent the Ascii space and tab characters.
1887      ;; We want to match the results of any of these manglings.
1888      ;; The following regexp rejects names whose first characters are
1889      ;; obviously bogus, but after that anything goes.
1890      "\\([^\0-\b\n-\r\^?].*\\)?"
1891
1892      ;; The time the message was sent.
1893      "\\([^\0-\r \^?]+\\) +"            ; day of the week
1894      "\\([^\0-\r \^?]+\\) +"            ; month
1895      "\\([0-3]?[0-9]\\) +"              ; day of month
1896      "\\([0-2][0-9]:[0-5][0-9]\\(:[0-6][0-9]\\)?\\) *" ; time of day
1897
1898      ;; Perhaps a time zone, specified by an abbreviation, or by a
1899      ;; numeric offset.
1900      time-zone-regexp
1901
1902      ;; The year.
1903      " \\([0-9][0-9]+\\) *"
1904
1905      ;; On some systems the time zone can appear after the year, too.
1906      time-zone-regexp
1907
1908      ;; Old uucp cruft.
1909      "\\(remote from .*\\)?"
1910
1911      "\n"))
1912   "Regexp matching the delimiter of messages in UNIX mail format.")
1913
1914 (defvar message-unsent-separator
1915   (concat "^ *---+ +Unsent message follows +---+ *$\\|"
1916           "^ *---+ +Returned message +---+ *$\\|"
1917           "^Start of returned message$\\|"
1918           "^ *---+ +Original message +---+ *$\\|"
1919           "^ *--+ +begin message +--+ *$\\|"
1920           "^ *---+ +Original message follows +---+ *$\\|"
1921           "^ *---+ +Undelivered message follows +---+ *$\\|"
1922           "^------ This is a copy of the message, including all the headers. ------ *$\\|"
1923           "^|? *---+ +Message text follows: +---+ *|?$")
1924   "A regexp that matches the separator before the text of a failed message.")
1925
1926 (defvar message-field-fillers
1927   '((To message-fill-field-address)
1928     (Cc message-fill-field-address)
1929     (From message-fill-field-address))
1930   "Alist of header names/filler functions.")
1931
1932 (defvar message-header-format-alist
1933   `((From)
1934     (Newsgroups)
1935     (To)
1936     (Cc)
1937     (Subject)
1938     (In-Reply-To)
1939     (Fcc)
1940     (Bcc)
1941     (Date)
1942     (Organization)
1943     (Distribution)
1944     (Lines)
1945     (Expires)
1946     (Message-ID)
1947     (References . message-shorten-references)
1948     (User-Agent))
1949   "Alist used for formatting headers.")
1950
1951 (defvar message-options nil
1952   "Some saved answers when sending message.")
1953 ;; FIXME: On XEmacs this causes problems since let-binding like:
1954 ;; (let ((message-options message-options)) ...)
1955 ;; as in `message-send' and `mml-preview' loses to buffer-local
1956 ;; variable initialization.
1957 (unless (featurep 'xemacs)
1958   (make-variable-buffer-local 'message-options))
1959
1960 (defvar message-send-mail-real-function nil
1961   "Internal send mail function.")
1962
1963 (defvar message-bogus-system-names "\\`localhost\\.\\|\\.local\\'"
1964   "The regexp of bogus system names.")
1965
1966 (defcustom message-valid-fqdn-regexp
1967   (concat "[a-z0-9][-.a-z0-9]+\\." ;; [hostname.subdomain.]domain.
1968           ;; valid TLDs:
1969           "\\([a-z][a-z]\\|" ;; two letter country TDLs
1970           "aero\\|arpa\\|asia\\|bitnet\\|biz\\|bofh\\|"
1971           "cat\\|com\\|coop\\|edu\\|gov\\|"
1972           "info\\|int\\|jobs\\|"
1973           "mil\\|mobi\\|museum\\|name\\|net\\|"
1974           "org\\|pro\\|tel\\|travel\\|uucp\\|"
1975           ;; ICANN-era generic top-level domains
1976           "academy\\|actor\\|agency\\|airforce\\|archi\\|associates\\|axa\\|"
1977           "bar\\|bargains\\|bayern\\|beer\\|berlin\\|best\\|bid\\|bike\\|"
1978           "biz\\|black\\|blackfriday\\|blue\\|boutique\\|build\\|builders\\|"
1979           "buzz\\|cab\\|camera\\|camp\\|capital\\|cards\\|care\\|career\\|"
1980           "careers\\|cash\\|catering\\|center\\|ceo\\|cheap\\|christmas\\|"
1981           "church\\|citic\\|cleaning\\|clinic\\|clothing\\|club\\|codes\\|"
1982           "coffee\\|college\\|cologne\\|com\\|community\\|company\\|computer\\|"
1983           "construction\\|contractors\\|cooking\\|cool\\|country\\|creditcard\\|"
1984           "cruises\\|dance\\|dating\\|democrat\\|dental\\|desi\\|design\\|"
1985           "diamonds\\|directory\\|discount\\|domains\\|education\\|email\\|"
1986           "engineering\\|enterprises\\|equipment\\|estate\\|eus\\|events\\|"
1987           "exchange\\|expert\\|exposed\\|fail\\|farm\\|feedback\\|finance\\|"
1988           "financial\\|fish\\|fishing\\|fitness\\|flights\\|florist\\|foo\\|"
1989           "foundation\\|frogans\\|fund\\|furniture\\|futbol\\|gal\\|"
1990           "gallery\\|gift\\|glass\\|globo\\|gmo\\|gop\\|graphics\\|gratis\\|"
1991           "gripe\\|guide\\|guitars\\|guru\\|hamburg\\|haus\\|hiphop\\|"
1992           "holdings\\|holiday\\|homes\\|horse\\|house\\|immobilien\\|"
1993           "industries\\|info\\|ink\\|institute\\|insure\\|international\\|"
1994           "investments\\|jetzt\\|juegos\\|kaufen\\|kim\\|kitchen\\|kiwi\\|"
1995           "koeln\\|kred\\|land\\|lat\\|latino\\|lease\\|life\\|lighting\\|"
1996           "limited\\|limo\\|link\\|loans\\|london\\|luxe\\|luxury\\|"
1997           "management\\|mango\\|marketing\\|media\\|meet\\|menu\\|miami\\|"
1998           "moda\\|moe\\|monash\\|moscow\\|motorcycles\\|nagoya\\|name\\|"
1999           "net\\|neustar\\|ninja\\|nyc\\|okinawa\\|onl\\|org\\|paris\\|"
2000           "partners\\|parts\\|photo\\|photography\\|photos\\|pics\\|"
2001           "pictures\\|pink\\|plumbing\\|pro\\|productions\\|properties\\|"
2002           "pub\\|qpon\\|quebec\\|recipes\\|red\\|reisen\\|ren\\|rentals\\|"
2003           "repair\\|report\\|rest\\|reviews\\|rich\\|rocks\\|rodeo\\|"
2004           "ruhr\\|ryukyu\\|saarland\\|schule\\|scot\\|services\\|sexy\\|"
2005           "shiksha\\|shoes\\|singles\\|social\\|sohu\\|solar\\|solutions\\|"
2006           "soy\\|supplies\\|supply\\|support\\|surgery\\|systems\\|tattoo\\|"
2007           "tax\\|technology\\|tienda\\|tips\\|today\\|tokyo\\|tools\\|"
2008           "town\\|toys\\|trade\\|training\\|university\\|uno\\|vacations\\|"
2009           "vegas\\|ventures\\|viajes\\|villas\\|vision\\|vodka\\|vote\\|"
2010           "voting\\|voto\\|voyage\\|wang\\|watch\\|webcam\\|wed\\|wien\\|"
2011           "wiki\\|works\\|wtc\\|wtf\\|xyz\\|yachts\\|yokohama\\|you\\|"
2012           "zone\\)")
2013   ;; http://en.wikipedia.org/wiki/List_of_Internet_top-level_domains
2014   ;; http://en.wikipedia.org/wiki/GTLD
2015   ;; `approved, but not yet in operation': .xxx
2016   ;; "dead" nato bitnet uucp
2017   "Regular expression that matches a valid FQDN."
2018   ;; see also: gnus-button-valid-fqdn-regexp
2019   :version "25.1"
2020   :group 'message-headers
2021   :type 'regexp)
2022
2023 (autoload 'gnus-alive-p "gnus-util")
2024 (autoload 'gnus-delay-article "gnus-delay")
2025 (autoload 'gnus-extract-address-components "gnus-util")
2026 (autoload 'gnus-find-method-for-group "gnus")
2027 (autoload 'gnus-group-decoded-name "gnus-group")
2028 (autoload 'gnus-group-name-charset "gnus-group")
2029 (autoload 'gnus-group-name-decode "gnus-group")
2030 (autoload 'gnus-groups-from-server "gnus")
2031 (autoload 'gnus-make-local-hook "gnus-util")
2032 (autoload 'gnus-open-server "gnus-int")
2033 (autoload 'gnus-output-to-mail "gnus-util")
2034 (autoload 'gnus-output-to-rmail "gnus-util")
2035 (autoload 'gnus-request-post "gnus-int")
2036 (autoload 'gnus-select-frame-set-input-focus "gnus-util")
2037 (autoload 'gnus-server-string "gnus")
2038 (autoload 'idna-to-ascii "idna")
2039 (autoload 'message-setup-toolbar "messagexmas")
2040 (autoload 'mh-new-draft-name "mh-comp")
2041 (autoload 'mh-send-letter "mh-comp")
2042 (autoload 'nndraft-request-associate-buffer "nndraft")
2043 (autoload 'nndraft-request-expire-articles "nndraft")
2044 (autoload 'nnvirtual-find-group-art "nnvirtual")
2045 (autoload 'rmail-msg-is-pruned "rmail")
2046 (autoload 'rmail-output "rmailout")
2047
2048 ;; Emacs < 24.1 do not have mail-dont-reply-to
2049 (unless (fboundp 'mail-dont-reply-to)
2050   (defalias 'mail-dont-reply-to 'rmail-dont-reply-to))
2051
2052 (eval-and-compile
2053   (if (featurep 'emacs)
2054       (progn
2055         (defun message-kill-all-overlays ()
2056           (mapcar #'delete-overlay (overlays-in (point-min) (point-max))))
2057         (defalias 'message-window-inside-pixel-edges
2058           'window-inside-pixel-edges))
2059     (defun message-kill-all-overlays ()
2060       (map-extents (lambda (extent ignore) (delete-extent extent))))
2061     (defalias 'message-window-inside-pixel-edges 'ignore)))
2062
2063 \f
2064
2065 ;;;
2066 ;;; Utility functions.
2067 ;;;
2068
2069 (defmacro message-y-or-n-p (question show &rest text)
2070   "Ask QUESTION, displaying remaining args in a temporary buffer if SHOW."
2071   `(message-talkative-question 'y-or-n-p ,question ,show ,@text))
2072
2073 (defmacro message-delete-line (&optional n)
2074   "Delete the current line (and the next N lines)."
2075   `(delete-region (progn (beginning-of-line) (point))
2076                   (progn (forward-line ,(or n 1)) (point))))
2077
2078 (defun message-mark-active-p ()
2079   "Non-nil means the mark and region are currently active in this buffer."
2080   mark-active)
2081
2082 (defun message-unquote-tokens (elems)
2083   "Remove double quotes (\") from strings in list ELEMS."
2084   (mapcar (lambda (item)
2085             (while (string-match "^\\(.*\\)\"\\(.*\\)$" item)
2086               (setq item (concat (match-string 1 item)
2087                                  (match-string 2 item))))
2088             item)
2089           elems))
2090
2091 (defun message-tokenize-header (header &optional separator)
2092   "Split HEADER into a list of header elements.
2093 SEPARATOR is a string of characters to be used as separators.  \",\"
2094 is used by default."
2095   (if (not header)
2096       nil
2097     (let ((regexp (format "[%s]+" (or separator ",")))
2098           (first t)
2099           beg quoted elems paren)
2100       (with-temp-buffer
2101         (mm-enable-multibyte)
2102         (setq beg (point-min))
2103         (insert header)
2104         (goto-char (point-min))
2105         (while (not (eobp))
2106           (if first
2107               (setq first nil)
2108             (forward-char 1))
2109           (cond ((and (> (point) beg)
2110                       (or (eobp)
2111                           (and (looking-at regexp)
2112                                (not quoted)
2113                                (not paren))))
2114                  (push (buffer-substring beg (point)) elems)
2115                  (setq beg (match-end 0)))
2116                 ((eq (char-after) ?\")
2117                  (setq quoted (not quoted)))
2118                 ((and (eq (char-after) ?\()
2119                       (not quoted))
2120                  (setq paren t))
2121                 ((and (eq (char-after) ?\))
2122                       (not quoted))
2123                  (setq paren nil))))
2124         (nreverse elems)))))
2125
2126 (autoload 'nnheader-insert-file-contents "nnheader")
2127
2128 (defun message-mail-file-mbox-p (file)
2129   "Say whether FILE looks like a Unix mbox file."
2130   (when (and (file-exists-p file)
2131              (file-readable-p file)
2132              (file-regular-p file))
2133     (with-temp-buffer
2134       (nnheader-insert-file-contents file)
2135       (goto-char (point-min))
2136       (looking-at message-unix-mail-delimiter))))
2137
2138 (defun message-fetch-field (header &optional not-all)
2139   "The same as `mail-fetch-field', only remove all newlines.
2140 The buffer is expected to be narrowed to just the header of the message;
2141 see `message-narrow-to-headers-or-head'."
2142   (let* ((inhibit-point-motion-hooks t)
2143          (value (mail-fetch-field header nil (not not-all))))
2144     (when value
2145       (while (string-match "\n[\t ]+" value)
2146         (setq value (replace-match " " t t value)))
2147       value)))
2148
2149 (defun message-field-value (header &optional not-all)
2150   "The same as `message-fetch-field', only narrow to the headers first."
2151   (save-excursion
2152     (save-restriction
2153       (message-narrow-to-headers-or-head)
2154       (message-fetch-field header not-all))))
2155
2156 (defun message-narrow-to-field ()
2157   "Narrow the buffer to the header on the current line."
2158   (beginning-of-line)
2159   (while (looking-at "[ \t]")
2160     (forward-line -1))
2161   (narrow-to-region
2162    (point)
2163    (progn
2164      (forward-line 1)
2165      (if (re-search-forward "^[^ \n\t]" nil t)
2166          (point-at-bol)
2167        (point-max))))
2168   (goto-char (point-min)))
2169
2170 (defun message-add-header (&rest headers)
2171   "Add the HEADERS to the message header, skipping those already present."
2172   (while headers
2173     (let (hclean)
2174       (unless (string-match "^\\([^:]+\\):[ \t]*[^ \t]" (car headers))
2175         (error "Invalid header `%s'" (car headers)))
2176       (setq hclean (match-string 1 (car headers)))
2177       (save-restriction
2178         (message-narrow-to-headers)
2179         (unless (re-search-forward (concat "^" (regexp-quote hclean) ":") nil t)
2180           (goto-char (point-max))
2181           (if (string-match "\n$" (car headers))
2182               (insert (car headers))
2183             (insert (car headers) ?\n)))))
2184     (setq headers (cdr headers))))
2185
2186 (defmacro message-with-reply-buffer (&rest forms)
2187   "Evaluate FORMS in the reply buffer, if it exists."
2188   `(when (and (bufferp message-reply-buffer)
2189               (buffer-name message-reply-buffer))
2190      (with-current-buffer message-reply-buffer
2191        ,@forms)))
2192
2193 (put 'message-with-reply-buffer 'lisp-indent-function 0)
2194 (put 'message-with-reply-buffer 'edebug-form-spec '(body))
2195
2196 (defun message-fetch-reply-field (header)
2197   "Fetch field HEADER from the message we're replying to."
2198   (message-with-reply-buffer
2199     (save-restriction
2200       (mail-narrow-to-head)
2201       (message-fetch-field header))))
2202
2203 (defun message-strip-list-identifiers (subject)
2204   "Remove list identifiers in `gnus-list-identifiers' from string SUBJECT."
2205   (require 'gnus-sum)                   ; for gnus-list-identifiers
2206   (let ((regexp (if (stringp gnus-list-identifiers)
2207                     gnus-list-identifiers
2208                   (mapconcat 'identity gnus-list-identifiers " *\\|"))))
2209     (if (string-match (concat "\\(\\(\\(Re: +\\)?\\(" regexp
2210                               " *\\)\\)+\\(Re: +\\)?\\)") subject)
2211         (concat (substring subject 0 (match-beginning 1))
2212                 (or (match-string 3 subject)
2213                     (match-string 5 subject))
2214                 (substring subject
2215                            (match-end 1)))
2216       subject)))
2217
2218 (defun message-strip-subject-re (subject)
2219   "Remove \"Re:\" from subject lines in string SUBJECT."
2220   (if (string-match message-subject-re-regexp subject)
2221       (substring subject (match-end 0))
2222     subject))
2223
2224 (defcustom message-replacement-char "."
2225   "Replacement character used instead of unprintable or not decodable chars."
2226   :group 'message-various
2227   :version "22.1" ;; Gnus 5.10.9
2228   :type '(choice string
2229                  (const ".")
2230                  (const "?")))
2231
2232 ;; FIXME: We also should call `message-strip-subject-encoded-words'
2233 ;; when forwarding.  Probably in `message-make-forward-subject' and
2234 ;; `message-forward-make-body'.
2235
2236 (defun message-strip-subject-encoded-words (subject)
2237   "Fix non-decodable words in SUBJECT."
2238   ;; Cf. `gnus-simplify-subject-fully'.
2239   (let* ((case-fold-search t)
2240          (replacement-chars (format "[%s%s%s]"
2241                                     message-replacement-char
2242                                     message-replacement-char
2243                                     message-replacement-char))
2244          (enc-word-re "=\\?\\([^?]+\\)\\?\\([QB]\\)\\?\\([^?]+\\)\\(\\?=\\)")
2245          cs-string
2246          (have-marker
2247           (with-temp-buffer
2248             (insert subject)
2249             (goto-char (point-min))
2250             (when (re-search-forward enc-word-re nil t)
2251               (setq cs-string (match-string 1)))))
2252          cs-coding q-or-b word-beg word-end)
2253     (if (or (not have-marker) ;; No encoded word found...
2254             ;; ... or double encoding was correct:
2255             (and (stringp cs-string)
2256                  (setq cs-string (downcase cs-string))
2257                  (mm-coding-system-p (intern cs-string))
2258                  (not (prog1
2259                           (y-or-n-p
2260                            (format "\
2261 Decoded Subject \"%s\"
2262 contains a valid encoded word.  Decode again? "
2263                                    subject))
2264                         (setq cs-coding (intern cs-string))))))
2265         subject
2266       (with-temp-buffer
2267         (insert subject)
2268         (goto-char (point-min))
2269         (while (re-search-forward enc-word-re nil t)
2270           (setq cs-string (downcase (match-string 1))
2271                 q-or-b    (match-string 2)
2272                 word-beg (match-beginning 0)
2273                 word-end (match-end 0))
2274           (setq cs-coding
2275                 (if (mm-coding-system-p (intern cs-string))
2276                     (setq cs-coding (intern cs-string))
2277                   nil))
2278           ;; No double encoded subject? => bogus charset.
2279           (unless cs-coding
2280             (setq cs-coding
2281                   (mm-read-coding-system
2282                    (gnus-format-message "\
2283 Decoded Subject \"%s\"
2284 contains an encoded word.  The charset `%s' is unknown or invalid.
2285 Hit RET to replace non-decodable characters with \"%s\" or enter replacement
2286 charset: "
2287                            subject cs-string message-replacement-char)))
2288             (if cs-coding
2289                 (replace-match (concat "=?" (symbol-name cs-coding)
2290                                        "?\\2?\\3\\4\\5"))
2291               (save-excursion
2292                 (goto-char word-beg)
2293                 (re-search-forward "=\\?\\([^?]+\\)\\?\\([QB]\\)\\?" word-end t)
2294                 (replace-match "")
2295                 ;; QP or base64
2296                 (if (string-match "\\`Q\\'" q-or-b)
2297                     ;; QP
2298                     (progn
2299                       (message "Replacing non-decodable characters with \"%s\"."
2300                                message-replacement-char)
2301                       (while (re-search-forward "\\(=[A-F0-9][A-F0-9]\\)+"
2302                                                 word-end t)
2303                         (replace-match message-replacement-char)))
2304                   ;; base64
2305                   (message "Replacing non-decodable characters with \"%s\"."
2306                            replacement-chars)
2307                   (re-search-forward "[^?]+" word-end t)
2308                   (replace-match replacement-chars))
2309                 (re-search-forward "\\?=")
2310                 (replace-match "")))))
2311         (rfc2047-decode-region (point-min) (point-max))
2312         (buffer-string)))))
2313
2314 ;;; Start of functions adopted from `message-utils.el'.
2315
2316 (defun message-strip-subject-trailing-was (subject)
2317   "Remove trailing \"(was: <old subject>)\" from SUBJECT lines.
2318 Leading \"Re: \" is not stripped by this function.  Use the function
2319 `message-strip-subject-re' for this."
2320   (let* ((query message-subject-trailing-was-query)
2321          (new) (found))
2322     (setq found
2323           (string-match
2324            (if (eq query 'ask)
2325                message-subject-trailing-was-ask-regexp
2326              message-subject-trailing-was-regexp)
2327            subject))
2328     (if found
2329         (setq new (substring subject 0 (match-beginning 0))))
2330     (if (or (not found) (eq query nil))
2331         subject
2332       (if (eq query 'ask)
2333           (if (message-y-or-n-p
2334                "Strip `(was: <old subject>)' in subject? " t
2335                (concat
2336                 "Strip `(was: <old subject>)' in subject "
2337                 "and use the new one instead?\n\n"
2338                 "Current subject is:   \""
2339                 subject "\"\n\n"
2340                 "New subject would be: \""
2341                 new "\"\n\n"
2342                 "See the variable `message-subject-trailing-was-query' "
2343                 "to get rid of this query."
2344                 ))
2345               new subject)
2346         new))))
2347
2348 ;;; Suggested by Jonas Steverud  @  www.dtek.chalmers.se/~d4jonas/
2349
2350 (defun message-change-subject (new-subject)
2351   "Ask for NEW-SUBJECT header, append (was: <Old Subject>)."
2352   (interactive
2353    (list
2354     (read-from-minibuffer "New subject: ")))
2355   (cond ((and (not (or (null new-subject) ; new subject not empty
2356                        (zerop (string-width new-subject))
2357                        (string-match "^[ \t]*$" new-subject))))
2358          (save-excursion
2359            (let ((old-subject
2360                   (save-restriction
2361                     (message-narrow-to-headers)
2362                     (message-fetch-field "Subject"))))
2363              (cond ((not old-subject)
2364                     (error "No current subject"))
2365                    ((not (string-match
2366                           (concat "^[ \t]*"
2367                                   (regexp-quote new-subject)
2368                                   "[ \t]*$")
2369                           old-subject))  ; yes, it really is a new subject
2370                     ;; delete eventual Re: prefix
2371                     (setq old-subject
2372                           (message-strip-subject-re old-subject))
2373                     (message-goto-subject)
2374                     (message-delete-line)
2375                     (insert (concat "Subject: "
2376                                     new-subject
2377                                     " (was: "
2378                                     old-subject ")\n")))))))))
2379
2380 (defun message-mark-inserted-region (beg end &optional verbatim)
2381   "Mark some region in the current article with enclosing tags.
2382 See `message-mark-insert-begin' and `message-mark-insert-end'.
2383 If VERBATIM, use slrn style verbatim marks (\"#v+\" and \"#v-\")."
2384   (interactive "r\nP")
2385   (save-excursion
2386     ;; add to the end of the region first, otherwise end would be invalid
2387     (goto-char end)
2388     (insert (if verbatim "#v-\n" message-mark-insert-end))
2389     (goto-char beg)
2390     (insert (if verbatim "#v+\n" message-mark-insert-begin))))
2391
2392 (defun message-mark-insert-file (file &optional verbatim)
2393   "Insert FILE at point, marking it with enclosing tags.
2394 See `message-mark-insert-begin' and `message-mark-insert-end'.
2395 If VERBATIM, use slrn style verbatim marks (\"#v+\" and \"#v-\")."
2396   (interactive "fFile to insert: \nP")
2397     ;; reverse insertion to get correct result.
2398   (let ((p (point)))
2399     (insert (if verbatim "#v-\n" message-mark-insert-end))
2400     (goto-char p)
2401     (insert-file-contents file)
2402     (goto-char p)
2403     (insert (if verbatim "#v+\n" message-mark-insert-begin))))
2404
2405 (defun message-add-archive-header ()
2406   "Insert \"X-No-Archive: Yes\" in the header and a note in the body.
2407 The note can be customized using `message-archive-note'.  When called with a
2408 prefix argument, ask for a text to insert.  If you don't want the note in the
2409 body, set  `message-archive-note' to nil."
2410   (interactive)
2411   (if current-prefix-arg
2412       (setq message-archive-note
2413             (read-from-minibuffer "Reason for No-Archive: "
2414                                   (cons message-archive-note 0))))
2415     (save-excursion
2416       (if (message-goto-signature)
2417           (re-search-backward message-signature-separator))
2418       (when message-archive-note
2419         (insert message-archive-note)
2420         (newline))
2421       (message-add-header message-archive-header)
2422       (message-sort-headers)))
2423
2424 (defun message-cross-post-followup-to-header (target-group)
2425   "Mangles FollowUp-To and Newsgroups header to point to TARGET-GROUP.
2426 With prefix-argument just set Follow-Up, don't cross-post."
2427   (interactive
2428    (list ; Completion based on Gnus
2429     (completing-read "Followup To: "
2430                      (if (boundp 'gnus-newsrc-alist)
2431                          gnus-newsrc-alist)
2432                      nil nil '("poster" . 0)
2433                      (if (boundp 'gnus-group-history)
2434                          'gnus-group-history))))
2435   (message-remove-header "Follow[Uu]p-[Tt]o" t)
2436   (message-goto-newsgroups)
2437   (beginning-of-line)
2438   ;; if we already did a crosspost before, kill old target
2439   (if (and message-cross-post-old-target
2440            (re-search-forward
2441             (regexp-quote (concat "," message-cross-post-old-target))
2442             nil t))
2443       (replace-match ""))
2444   ;; unless (followup is to poster or user explicitly asked not
2445   ;; to cross-post, or target-group is already in Newsgroups)
2446   ;; add target-group to Newsgroups line.
2447   (cond ((and (or
2448                ;; def: cross-post, req:no
2449                (and message-cross-post-default (not current-prefix-arg))
2450                ;; def: no-cross-post, req:yes
2451                (and (not message-cross-post-default) current-prefix-arg))
2452               (not (string-match "poster" target-group))
2453               (not (string-match (regexp-quote target-group)
2454                                  (message-fetch-field "Newsgroups"))))
2455          (end-of-line)
2456          (insert (concat "," target-group))))
2457   (end-of-line) ; ensure Followup: comes after Newsgroups:
2458   ;; unless new followup would be identical to Newsgroups line
2459   ;; make a new Followup-To line
2460   (if (not (string-match (concat "^[ \t]*"
2461                                  target-group
2462                                  "[ \t]*$")
2463                          (message-fetch-field "Newsgroups")))
2464       (insert (concat "\nFollowup-To: " target-group)))
2465   (setq message-cross-post-old-target target-group))
2466
2467 (defun message-cross-post-insert-note (target-group cross-post in-old
2468                                                     old-groups)
2469   "Insert a in message body note about a set Followup or Crosspost.
2470 If there have been previous notes, delete them.  TARGET-GROUP specifies the
2471 group to Followup-To.  When CROSS-POST is t, insert note about
2472 crossposting.  IN-OLD specifies whether TARGET-GROUP is a member of
2473 OLD-GROUPS.  OLD-GROUPS lists the old-groups the posting would have
2474 been made to before the user asked for a Crosspost."
2475   ;; start scanning body for previous uses
2476   (message-goto-signature)
2477   (let ((head (re-search-backward
2478                (concat "^" mail-header-separator)
2479                nil t))) ; just search in body
2480     (message-goto-signature)
2481     (while (re-search-backward
2482             (concat "^" (regexp-quote message-cross-post-note) ".*")
2483             head t)
2484       (message-delete-line))
2485     (message-goto-signature)
2486     (while (re-search-backward
2487             (concat "^" (regexp-quote message-followup-to-note) ".*")
2488             head t)
2489       (message-delete-line))
2490     ;; insert new note
2491     (if (message-goto-signature)
2492         (re-search-backward message-signature-separator))
2493     (if (or in-old
2494             (not cross-post)
2495             (string-match "^[ \t]*poster[ \t]*$" target-group))
2496         (insert (concat message-followup-to-note target-group "\n"))
2497       (insert (concat message-cross-post-note target-group "\n")))))
2498
2499 (defun message-cross-post-followup-to (target-group)
2500   "Crossposts message and set Followup-To to TARGET-GROUP.
2501 With prefix-argument just set Follow-Up, don't cross-post."
2502   (interactive
2503    (list ; Completion based on Gnus
2504     (completing-read "Followup To: "
2505                      (if (boundp 'gnus-newsrc-alist)
2506                          gnus-newsrc-alist)
2507                      nil nil '("poster" . 0)
2508                      (if (boundp 'gnus-group-history)
2509                          'gnus-group-history))))
2510   (cond ((not (or (null target-group) ; new subject not empty
2511                   (zerop (string-width target-group))
2512                   (string-match "^[ \t]*$" target-group)))
2513          (save-excursion
2514            (let* ((old-groups (message-fetch-field "Newsgroups"))
2515                   (in-old (string-match
2516                            (regexp-quote target-group)
2517                            (or old-groups ""))))
2518              ;; check whether target exactly matches old Newsgroups
2519              (cond ((not old-groups)
2520                     (error "No current newsgroup"))
2521                    ((or (not in-old)
2522                         (not (string-match
2523                               (concat "^[ \t]*"
2524                                       (regexp-quote target-group)
2525                                       "[ \t]*$")
2526                               old-groups)))
2527                     ;; yes, Newsgroups line must change
2528                     (message-cross-post-followup-to-header target-group)
2529                     ;; insert note whether we do cross-post or followup-to
2530                     (funcall message-cross-post-note-function
2531                              target-group
2532                              (if (or (and message-cross-post-default
2533                                           (not current-prefix-arg))
2534                                      (and (not message-cross-post-default)
2535                                           current-prefix-arg)) t)
2536                              in-old old-groups))))))))
2537
2538 ;;; Reduce To: to Cc: or Bcc: header
2539
2540 (defun message-reduce-to-to-cc ()
2541  "Replace contents of To: header with contents of Cc: or Bcc: header."
2542  (interactive)
2543  (let ((cc-content
2544         (save-restriction (message-narrow-to-headers)
2545                           (message-fetch-field "cc")))
2546        (bcc nil))
2547    (if (and (not cc-content)
2548             (setq cc-content
2549                   (save-restriction
2550                     (message-narrow-to-headers)
2551                     (message-fetch-field "bcc"))))
2552        (setq bcc t))
2553    (cond (cc-content
2554           (save-excursion
2555             (message-goto-to)
2556             (message-delete-line)
2557             (insert (concat "To: " cc-content "\n"))
2558             (save-restriction
2559               (message-narrow-to-headers)
2560               (message-remove-header (if bcc
2561                                          "bcc"
2562                                        "cc"))))))))
2563
2564 ;;; End of functions adopted from `message-utils.el'.
2565
2566 (defun message-remove-header (header &optional is-regexp first reverse)
2567   "Remove HEADER in the narrowed buffer.
2568 If IS-REGEXP, HEADER is a regular expression.
2569 If FIRST, only remove the first instance of the header.
2570 If REVERSE, remove headers that doesn't match HEADER.
2571 Return the number of headers removed."
2572   (goto-char (point-min))
2573   (let ((regexp (if is-regexp header (concat "^" (regexp-quote header) ":")))
2574         (number 0)
2575         (case-fold-search t)
2576         last)
2577     (while (and (not (eobp))
2578                 (not last))
2579       (if (if reverse
2580               (not (looking-at regexp))
2581             (looking-at regexp))
2582           (progn
2583             (incf number)
2584             (when first
2585               (setq last t))
2586             (delete-region
2587              (point)
2588              ;; There might be a continuation header, so we have to search
2589              ;; until we find a new non-continuation line.
2590              (progn
2591                (forward-line 1)
2592                (if (re-search-forward "^[^ \t]" nil t)
2593                    (goto-char (match-beginning 0))
2594                  (point-max)))))
2595         (forward-line 1)
2596         (if (re-search-forward "^[^ \t]" nil t)
2597             (goto-char (match-beginning 0))
2598           (goto-char (point-max)))))
2599     number))
2600
2601 (defun message-remove-first-header (header)
2602   "Remove the first instance of HEADER if there is more than one."
2603   (let ((count 0)
2604         (regexp (concat "^" (regexp-quote header) ":")))
2605     (save-excursion
2606       (goto-char (point-min))
2607       (while (re-search-forward regexp nil t)
2608         (incf count)))
2609     (while (> count 1)
2610       (message-remove-header header nil t)
2611       (decf count))))
2612
2613 (defun message-narrow-to-headers ()
2614   "Narrow the buffer to the head of the message."
2615   (widen)
2616   (narrow-to-region
2617    (goto-char (point-min))
2618    (if (re-search-forward
2619         (concat "^" (regexp-quote mail-header-separator) "\n") nil t)
2620        (match-beginning 0)
2621      (point-max)))
2622   (goto-char (point-min)))
2623
2624 (defun message-narrow-to-head-1 ()
2625   "Like `message-narrow-to-head'.  Don't widen."
2626   (narrow-to-region
2627    (goto-char (point-min))
2628    (if (search-forward "\n\n" nil 1)
2629        (1- (point))
2630      (point-max)))
2631   (goto-char (point-min)))
2632
2633 ;; FIXME: clarify difference: message-narrow-to-head,
2634 ;; message-narrow-to-headers-or-head, message-narrow-to-headers
2635 (defun message-narrow-to-head ()
2636   "Narrow the buffer to the head of the message.
2637 Point is left at the beginning of the narrowed-to region."
2638   (widen)
2639   (message-narrow-to-head-1))
2640
2641 (defun message-narrow-to-headers-or-head ()
2642   "Narrow the buffer to the head of the message."
2643   (widen)
2644   (narrow-to-region
2645    (goto-char (point-min))
2646    (if (re-search-forward (concat "\\(\n\\)\n\\|^\\("
2647                                   (regexp-quote mail-header-separator)
2648                                   "\n\\)")
2649                           nil t)
2650        (or (match-end 1) (match-beginning 2))
2651      (point-max)))
2652   (goto-char (point-min)))
2653
2654 (defun message-news-p ()
2655   "Say whether the current buffer contains a news message."
2656   (and (not message-this-is-mail)
2657        (or message-this-is-news
2658            (save-excursion
2659              (save-restriction
2660                (message-narrow-to-headers)
2661                (and (message-fetch-field "newsgroups")
2662                     (not (message-fetch-field "posted-to"))))))))
2663
2664 (defun message-mail-p ()
2665   "Say whether the current buffer contains a mail message."
2666   (and (not message-this-is-news)
2667        (or message-this-is-mail
2668            (save-excursion
2669              (save-restriction
2670                (message-narrow-to-headers)
2671                (or (message-fetch-field "to")
2672                    (message-fetch-field "cc")
2673                    (message-fetch-field "bcc")))))))
2674
2675 (defun message-subscribed-p ()
2676   "Say whether we need to insert a MFT header."
2677   (or message-subscribed-regexps
2678       message-subscribed-addresses
2679       message-subscribed-address-file
2680       message-subscribed-address-functions))
2681
2682 (defun message-next-header ()
2683   "Go to the beginning of the next header."
2684   (beginning-of-line)
2685   (or (eobp) (forward-char 1))
2686   (not (if (re-search-forward "^[^ \t]" nil t)
2687            (beginning-of-line)
2688          (goto-char (point-max)))))
2689
2690 (defun message-sort-headers-1 ()
2691   "Sort the buffer as headers using `message-rank' text props."
2692   (goto-char (point-min))
2693   (require 'sort)
2694   (sort-subr
2695    nil 'message-next-header
2696    (lambda ()
2697      (message-next-header)
2698      (unless (bobp)
2699        (forward-char -1)))
2700    (lambda ()
2701      (or (get-text-property (point) 'message-rank)
2702          10000))))
2703
2704 (defun message-sort-headers ()
2705   "Sort the headers of the current message according to `message-header-format-alist'."
2706   (interactive)
2707   (save-excursion
2708     (save-restriction
2709       (let ((max (1+ (length message-header-format-alist)))
2710             rank)
2711         (message-narrow-to-headers)
2712         (while (re-search-forward "^[^ \n]+:" nil t)
2713           (put-text-property
2714            (match-beginning 0) (1+ (match-beginning 0))
2715            'message-rank
2716            (if (setq rank (length (memq (assq (intern (buffer-substring
2717                                                        (match-beginning 0)
2718                                                        (1- (match-end 0))))
2719                                               message-header-format-alist)
2720                                         message-header-format-alist)))
2721                (- max rank)
2722              (1+ max)))))
2723       (message-sort-headers-1))))
2724
2725 (defun message-kill-address ()
2726   "Kill the address under point."
2727   (interactive)
2728   (let ((start (point)))
2729     (message-skip-to-next-address)
2730     (kill-region start (if (bolp) (1- (point)) (point)))))
2731
2732
2733 (autoload 'Info-goto-node "info")
2734 (defvar mml2015-use)
2735
2736 (defun message-info (&optional arg)
2737   "Display the Message manual.
2738
2739 Prefixed with one \\[universal-argument], display the Emacs MIME
2740 manual.  With two \\[universal-argument]'s, display the EasyPG or
2741 PGG manual, depending on the value of `mml2015-use'."
2742   (interactive "p")
2743   ;; Don't use `info' because support for `(filename)nodename' is not
2744   ;; available in XEmacs < 21.5.12.
2745   (Info-goto-node (format "(%s)Top"
2746                           (cond ((eq arg 16)
2747                                  (require 'mml2015)
2748                                  mml2015-use)
2749                                 ((eq arg  4) 'emacs-mime)
2750                                 ;; `booleanp' only available in Emacs 22+
2751                                 ((and (not (memq arg '(nil t)))
2752                                       (symbolp arg))
2753                                  arg)
2754                                 (t
2755                                  'message)))))
2756
2757 \f
2758
2759 ;;;
2760 ;;; Message mode
2761 ;;;
2762
2763 ;;; Set up keymap.
2764
2765 (defvar message-mode-map nil)
2766
2767 (unless message-mode-map
2768   (setq message-mode-map (make-keymap))
2769   (set-keymap-parent message-mode-map text-mode-map)
2770   (define-key message-mode-map "\C-c?" 'describe-mode)
2771
2772   (define-key message-mode-map "\C-c\C-f\C-t" 'message-goto-to)
2773   (define-key message-mode-map "\C-c\C-f\C-o" 'message-goto-from)
2774   (define-key message-mode-map "\C-c\C-f\C-b" 'message-goto-bcc)
2775   (define-key message-mode-map "\C-c\C-f\C-w" 'message-goto-fcc)
2776   (define-key message-mode-map "\C-c\C-f\C-c" 'message-goto-cc)
2777   (define-key message-mode-map "\C-c\C-f\C-s" 'message-goto-subject)
2778   (define-key message-mode-map "\C-c\C-f\C-r" 'message-goto-reply-to)
2779   (define-key message-mode-map "\C-c\C-f\C-n" 'message-goto-newsgroups)
2780   (define-key message-mode-map "\C-c\C-f\C-d" 'message-goto-distribution)
2781   (define-key message-mode-map "\C-c\C-f\C-f" 'message-goto-followup-to)
2782   (define-key message-mode-map "\C-c\C-f\C-m" 'message-goto-mail-followup-to)
2783   (define-key message-mode-map "\C-c\C-f\C-k" 'message-goto-keywords)
2784   (define-key message-mode-map "\C-c\C-f\C-u" 'message-goto-summary)
2785   (define-key message-mode-map "\C-c\C-f\C-i"
2786     'message-insert-or-toggle-importance)
2787   (define-key message-mode-map "\C-c\C-f\C-a"
2788     'message-generate-unsubscribed-mail-followup-to)
2789
2790   ;; modify headers (and insert notes in body)
2791   (define-key message-mode-map "\C-c\C-fs"    'message-change-subject)
2792   ;;
2793   (define-key message-mode-map "\C-c\C-fx"    'message-cross-post-followup-to)
2794   ;; prefix+message-cross-post-followup-to = same w/o cross-post
2795   (define-key message-mode-map "\C-c\C-ft"    'message-reduce-to-to-cc)
2796   (define-key message-mode-map "\C-c\C-fa"    'message-add-archive-header)
2797   ;; mark inserted text
2798   (define-key message-mode-map "\C-c\M-m" 'message-mark-inserted-region)
2799   (define-key message-mode-map "\C-c\M-f" 'message-mark-insert-file)
2800
2801   (define-key message-mode-map "\C-c\C-b" 'message-goto-body)
2802   (define-key message-mode-map "\C-c\C-i" 'message-goto-signature)
2803
2804   (define-key message-mode-map "\C-c\C-t" 'message-insert-to)
2805   (define-key message-mode-map "\C-c\C-fw" 'message-insert-wide-reply)
2806   (define-key message-mode-map "\C-c\C-n" 'message-insert-newsgroups)
2807   (define-key message-mode-map "\C-c\C-l" 'message-to-list-only)
2808   (define-key message-mode-map "\C-c\C-f\C-e" 'message-insert-expires)
2809
2810   (define-key message-mode-map "\C-c\C-u" 'message-insert-or-toggle-importance)
2811   (define-key message-mode-map "\C-c\M-n"
2812     'message-insert-disposition-notification-to)
2813
2814   (define-key message-mode-map "\C-c\C-y" 'message-yank-original)
2815   (define-key message-mode-map "\C-c\M-\C-y" 'message-yank-buffer)
2816   (define-key message-mode-map "\C-c\C-q" 'message-fill-yanked-message)
2817   (define-key message-mode-map "\C-c\C-w" 'message-insert-signature)
2818   (define-key message-mode-map "\C-c\M-h" 'message-insert-headers)
2819   (define-key message-mode-map "\C-c\C-r" 'message-caesar-buffer-body)
2820   (define-key message-mode-map "\C-c\C-o" 'message-sort-headers)
2821   (define-key message-mode-map "\C-c\M-r" 'message-rename-buffer)
2822
2823   (define-key message-mode-map "\C-c\C-c" 'message-send-and-exit)
2824   (define-key message-mode-map "\C-c\C-s" 'message-send)
2825   (define-key message-mode-map "\C-c\C-k" 'message-kill-buffer)
2826   (define-key message-mode-map "\C-c\C-d" 'message-dont-send)
2827   (define-key message-mode-map "\C-c\n" 'gnus-delay-article)
2828
2829   (define-key message-mode-map "\C-c\M-k" 'message-kill-address)
2830   (define-key message-mode-map "\C-c\C-e" 'message-elide-region)
2831   (define-key message-mode-map "\C-c\C-v" 'message-delete-not-region)
2832   (define-key message-mode-map "\C-c\C-z" 'message-kill-to-signature)
2833   (define-key message-mode-map "\M-\r" 'message-newline-and-reformat)
2834   (define-key message-mode-map [remap split-line]  'message-split-line)
2835
2836   (define-key message-mode-map "\C-c\C-a" 'mml-attach-file)
2837
2838   (define-key message-mode-map "\C-a" 'message-beginning-of-line)
2839   (define-key message-mode-map "\t" 'message-tab)
2840
2841   (define-key message-mode-map "\M-n" 'message-display-abbrev))
2842
2843 (easy-menu-define
2844   message-mode-menu message-mode-map "Message Menu."
2845   `("Message"
2846     ["Yank Original" message-yank-original message-reply-buffer]
2847     ["Fill Yanked Message" message-fill-yanked-message t]
2848     ["Insert Signature" message-insert-signature t]
2849     ["Caesar (rot13) Message" message-caesar-buffer-body t]
2850     ["Caesar (rot13) Region" message-caesar-region (message-mark-active-p)]
2851     ["Elide Region" message-elide-region
2852      :active (message-mark-active-p)
2853      ,@(if (featurep 'xemacs) nil
2854          '(:help "Replace text in region with an ellipsis"))]
2855     ["Delete Outside Region" message-delete-not-region
2856      :active (message-mark-active-p)
2857      ,@(if (featurep 'xemacs) nil
2858          '(:help "Delete all quoted text outside region"))]
2859     ["Kill To Signature" message-kill-to-signature t]
2860     ["Newline and Reformat" message-newline-and-reformat t]
2861     ["Rename buffer" message-rename-buffer t]
2862     ["Spellcheck" ispell-message
2863      ,@(if (featurep 'xemacs) '(t)
2864          '(:help "Spellcheck this message"))]
2865     "----"
2866     ["Insert Region Marked" message-mark-inserted-region
2867      :active (message-mark-active-p)
2868      ,@(if (featurep 'xemacs) nil
2869          '(:help "Mark region with enclosing tags"))]
2870     ["Insert File Marked..." message-mark-insert-file
2871      ,@(if (featurep 'xemacs) '(t)
2872          '(:help "Insert file at point marked with enclosing tags"))]
2873     "----"
2874     ["Send Message" message-send-and-exit
2875      ,@(if (featurep 'xemacs) '(t)
2876          '(:help "Send this message"))]
2877     ["Postpone Message" message-dont-send
2878      ,@(if (featurep 'xemacs) '(t)
2879          '(:help "File this draft message and exit"))]
2880     ["Send at Specific Time..." gnus-delay-article
2881      ,@(if (featurep 'xemacs) '(t)
2882          '(:help "Ask, then arrange to send message at that time"))]
2883     ["Kill Message" message-kill-buffer
2884      ,@(if (featurep 'xemacs) '(t)
2885          '(:help "Delete this message without sending"))]
2886     "----"
2887     ["Message manual" message-info
2888      ,@(if (featurep 'xemacs) '(t)
2889          '(:help "Display the Message manual"))]))
2890
2891 (easy-menu-define
2892   message-mode-field-menu message-mode-map ""
2893   `("Field"
2894     ["To" message-goto-to t]
2895     ["From" message-goto-from t]
2896     ["Subject" message-goto-subject t]
2897     ["Change subject..." message-change-subject t]
2898     ["Cc" message-goto-cc t]
2899     ["Bcc" message-goto-bcc t]
2900     ["Fcc" message-goto-fcc t]
2901     ["Reply-To" message-goto-reply-to t]
2902     ["Flag As Important" message-insert-importance-high
2903      ,@(if (featurep 'xemacs) '(t)
2904          '(:help "Mark this message as important"))]
2905     ["Flag As Unimportant" message-insert-importance-low
2906      ,@(if (featurep 'xemacs) '(t)
2907          '(:help "Mark this message as unimportant"))]
2908     ["Request Receipt"
2909      message-insert-disposition-notification-to
2910      ,@(if (featurep 'xemacs) '(t)
2911          '(:help "Request a receipt notification"))]
2912     "----"
2913     ;; (typical) news stuff
2914     ["Summary" message-goto-summary t]
2915     ["Keywords" message-goto-keywords t]
2916     ["Newsgroups" message-goto-newsgroups t]
2917     ["Fetch Newsgroups" message-insert-newsgroups t]
2918     ["Followup-To" message-goto-followup-to t]
2919     ;; ["Followup-To (with note in body)" message-cross-post-followup-to t]
2920     ["Crosspost / Followup-To..." message-cross-post-followup-to t]
2921     ["Distribution" message-goto-distribution t]
2922     ["Expires" message-insert-expires t ]
2923     ["X-No-Archive" message-add-archive-header t ]
2924     "----"
2925     ;; (typical) mailing-lists stuff
2926     ["Fetch To" message-insert-to
2927      ,@(if (featurep 'xemacs) '(t)
2928          '(:help "Insert a To header that points to the author."))]
2929     ["Fetch To and Cc" message-insert-wide-reply
2930      ,@(if (featurep 'xemacs) '(t)
2931          '(:help
2932            "Insert To and Cc headers as if you were doing a wide reply."))]
2933     "----"
2934     ["Send to list only" message-to-list-only t]
2935     ["Mail-Followup-To" message-goto-mail-followup-to t]
2936     ["Unsubscribed list post" message-generate-unsubscribed-mail-followup-to
2937      ,@(if (featurep 'xemacs) '(t)
2938          '(:help "Insert a reasonable `Mail-Followup-To:' header."))]
2939     ["Reduce To: to Cc:" message-reduce-to-to-cc t]
2940     "----"
2941     ["Sort Headers" message-sort-headers t]
2942     ["Encode non-ASCII domain names" message-idna-to-ascii-rhs t]
2943     ;; We hide `message-hidden-headers' by narrowing the buffer.
2944     ["Show Hidden Headers" widen t]
2945     ["Goto Body" message-goto-body t]
2946     ["Goto Signature" message-goto-signature t]))
2947
2948 (defvar message-tool-bar-map nil)
2949
2950 (defvar facemenu-add-face-function)
2951 (defvar facemenu-remove-face-function)
2952
2953 ;;; Forbidden properties
2954 ;;
2955 ;; We use `after-change-functions' to keep special text properties
2956 ;; that interfere with the normal function of message mode out of the
2957 ;; buffer.
2958
2959 (defcustom message-strip-special-text-properties t
2960   "Strip special properties from the message buffer.
2961
2962 Emacs has a number of special text properties which can break message
2963 composing in various ways.  If this option is set, message will strip
2964 these properties from the message composition buffer.  However, some
2965 packages requires these properties to be present in order to work.
2966 If you use one of these packages, turn this option off, and hope the
2967 message composition doesn't break too bad."
2968   :version "22.1"
2969   :group 'message-various
2970   :link '(custom-manual "(message)Various Message Variables")
2971   :type 'boolean)
2972
2973 (defvar message-forbidden-properties
2974   ;; No reason this should be clutter up customize.  We make it a
2975   ;; property list (rather than a list of property symbols), to be
2976   ;; directly useful for `remove-text-properties'.
2977   '(field nil read-only nil invisible nil intangible nil
2978           mouse-face nil modification-hooks nil insert-in-front-hooks nil
2979           insert-behind-hooks nil point-entered nil point-left nil)
2980   ;; Other special properties:
2981   ;; category, face, display: probably doesn't do any harm.
2982   ;; fontified: is used by font-lock.
2983   ;; syntax-table, local-map: I dunno.
2984   ;; We need to add XEmacs names to the list.
2985   "Property list of with properties forbidden in message buffers.
2986 The values of the properties are ignored, only the property names are used.")
2987
2988 (defun message-tamago-not-in-use-p (pos)
2989   "Return t when tamago version 4 is not in use at the cursor position.
2990 Tamago version 4 is a popular input method for writing Japanese text.
2991 It uses the properties `intangible', `invisible', `modification-hooks'
2992 and `read-only' when translating ascii or kana text to kanji text.
2993 These properties are essential to work, so we should never strip them."
2994   (not (and (boundp 'egg-modefull-mode)
2995             (symbol-value 'egg-modefull-mode)
2996             (or (memq (get-text-property pos 'intangible)
2997                       '(its-part-1 its-part-2))
2998                 (get-text-property pos 'egg-end)
2999                 (get-text-property pos 'egg-lang)
3000                 (get-text-property pos 'egg-start)))))
3001
3002 (defsubst message-mail-alias-type-p (type)
3003   (if (atom message-mail-alias-type)
3004       (eq message-mail-alias-type type)
3005     (memq type message-mail-alias-type)))
3006
3007 (defun message-strip-forbidden-properties (begin end &optional old-length)
3008   "Strip forbidden properties between BEGIN and END, ignoring the third arg.
3009 This function is intended to be called from `after-change-functions'.
3010 See also `message-forbidden-properties'."
3011   (when (and (message-mail-alias-type-p 'ecomplete)
3012              (memq this-command message-self-insert-commands))
3013     (message-display-abbrev))
3014   (when (and message-strip-special-text-properties
3015              (message-tamago-not-in-use-p begin))
3016     (let ((buffer-read-only nil)
3017           (inhibit-read-only t))
3018       (remove-text-properties begin end message-forbidden-properties))))
3019
3020 (autoload 'ecomplete-setup "ecomplete") ;; for Emacs <23.
3021
3022 (defvar message-smileys '(":-)" ":)"
3023                           ":-(" ":("
3024                           ";-)" ";)")
3025   "A list of recognized smiley faces in `message-mode'.")
3026
3027 (defun message--syntax-propertize (beg end)
3028   "Syntax-propertize certain message text specially."
3029   (let ((citation-regexp (concat "^" message-cite-prefix-regexp ".*$"))
3030         (smiley-regexp (regexp-opt message-smileys)))
3031     (goto-char beg)
3032     (while (search-forward-regexp citation-regexp
3033                                   end 'noerror)
3034       (let ((start (match-beginning 0))
3035             (end (match-end 0)))
3036         (add-text-properties start (1+ start)
3037                              `(syntax-table ,(string-to-syntax "<")))
3038         (add-text-properties end (min (1+ end) (point-max))
3039                              `(syntax-table ,(string-to-syntax ">")))))
3040     (goto-char beg)
3041     (while (search-forward-regexp smiley-regexp
3042             end 'noerror)
3043       (add-text-properties (match-beginning 0) (match-end 0)
3044                            `(syntax-table ,(string-to-syntax "."))))))
3045
3046 ;;;###autoload
3047 (define-derived-mode message-mode text-mode "Message"
3048   "Major mode for editing mail and news to be sent.
3049 Like Text Mode but with these additional commands:\\<message-mode-map>
3050 C-c C-s  `message-send' (send the message)  C-c C-c  `message-send-and-exit'
3051 C-c C-d  Postpone sending the message       C-c C-k  Kill the message
3052 C-c C-f  move to a header field (and create it if there isn't):
3053          C-c C-f C-t  move to To        C-c C-f C-s  move to Subject
3054          C-c C-f C-c  move to Cc        C-c C-f C-b  move to Bcc
3055          C-c C-f C-w  move to Fcc       C-c C-f C-r  move to Reply-To
3056          C-c C-f C-u  move to Summary   C-c C-f C-n  move to Newsgroups
3057          C-c C-f C-k  move to Keywords  C-c C-f C-d  move to Distribution
3058          C-c C-f C-o  move to From (\"Originator\")
3059          C-c C-f C-f  move to Followup-To
3060          C-c C-f C-m  move to Mail-Followup-To
3061          C-c C-f C-e  move to Expires
3062          C-c C-f C-i  cycle through Importance values
3063          C-c C-f s    change subject and append \"(was: <Old Subject>)\"
3064          C-c C-f x    crossposting with FollowUp-To header and note in body
3065          C-c C-f t    replace To: header with contents of Cc: or Bcc:
3066          C-c C-f a    Insert X-No-Archive: header and a note in the body
3067 C-c C-t  `message-insert-to' (add a To header to a news followup)
3068 C-c C-l  `message-to-list-only' (removes all but list address in to/cc)
3069 C-c C-n  `message-insert-newsgroups' (add a Newsgroup header to a news reply)
3070 C-c C-b  `message-goto-body' (move to beginning of message text).
3071 C-c C-i  `message-goto-signature' (move to the beginning of the signature).
3072 C-c C-w  `message-insert-signature' (insert `message-signature-file' file).
3073 C-c C-y  `message-yank-original' (insert current message, if any).
3074 C-c C-q  `message-fill-yanked-message' (fill what was yanked).
3075 C-c C-e  `message-elide-region' (elide the text between point and mark).
3076 C-c C-v  `message-delete-not-region' (remove the text outside the region).
3077 C-c C-z  `message-kill-to-signature' (kill the text up to the signature).
3078 C-c C-r  `message-caesar-buffer-body' (rot13 the message body).
3079 C-c C-a  `mml-attach-file' (attach a file as MIME).
3080 C-c C-u  `message-insert-or-toggle-importance'  (insert or cycle importance).
3081 C-c M-n  `message-insert-disposition-notification-to'  (request receipt).
3082 C-c M-m  `message-mark-inserted-region' (mark region with enclosing tags).
3083 C-c M-f  `message-mark-insert-file' (insert file marked with enclosing tags).
3084 M-RET    `message-newline-and-reformat' (break the line and reformat)."
3085   (set (make-local-variable 'message-reply-buffer) nil)
3086   (set (make-local-variable 'message-inserted-headers) nil)
3087   (set (make-local-variable 'message-send-actions) nil)
3088   (set (make-local-variable 'message-return-action) nil)
3089   (set (make-local-variable 'message-exit-actions) nil)
3090   (set (make-local-variable 'message-kill-actions) nil)
3091   (set (make-local-variable 'message-postpone-actions) nil)
3092   (set (make-local-variable 'message-draft-article) nil)
3093   (setq buffer-offer-save t)
3094   (set (make-local-variable 'facemenu-add-face-function)
3095        (lambda (face end)
3096          (let ((face-fun (cdr (assq face message-face-alist))))
3097            (if face-fun
3098                (funcall face-fun (point) end)
3099              (error "Face %s not configured for %s mode" face mode-name)))
3100          ""))
3101   (set (make-local-variable 'facemenu-remove-face-function) t)
3102   (set (make-local-variable 'message-reply-headers) nil)
3103   (make-local-variable 'message-newsreader)
3104   (make-local-variable 'message-mailer)
3105   (make-local-variable 'message-post-method)
3106   (set (make-local-variable 'message-sent-message-via) nil)
3107   (set (make-local-variable 'message-checksum) nil)
3108   (set (make-local-variable 'message-mime-part) 0)
3109   (message-setup-fill-variables)
3110   (when message-fill-column
3111     (setq fill-column message-fill-column)
3112     (turn-on-auto-fill))
3113   ;; Allow using comment commands to add/remove quoting.
3114   ;; (set (make-local-variable 'comment-start) message-yank-prefix)
3115   (when message-yank-prefix
3116     (set (make-local-variable 'comment-start) message-yank-prefix)
3117     (set (make-local-variable 'comment-start-skip)
3118          (concat "^" (regexp-quote message-yank-prefix) "[ \t]*")))
3119   (if (featurep 'xemacs)
3120       (message-setup-toolbar)
3121     (set (make-local-variable 'font-lock-defaults)
3122          '(message-font-lock-keywords t))
3123     (if (boundp 'tool-bar-map)
3124         (set (make-local-variable 'tool-bar-map) (message-make-tool-bar))))
3125   (easy-menu-add message-mode-menu message-mode-map)
3126   (easy-menu-add message-mode-field-menu message-mode-map)
3127   (gnus-make-local-hook 'after-change-functions)
3128   ;; Mmmm... Forbidden properties...
3129   (add-hook 'after-change-functions 'message-strip-forbidden-properties
3130             nil 'local)
3131   ;; Allow mail alias things.
3132   (cond
3133    ((message-mail-alias-type-p 'abbrev)
3134     (if (fboundp 'mail-abbrevs-setup)
3135         (mail-abbrevs-setup)
3136       (if (fboundp 'mail-aliases-setup) ; warning avoidance
3137           (mail-aliases-setup))))
3138    ((message-mail-alias-type-p 'ecomplete)
3139     (ecomplete-setup)))
3140   (add-hook 'completion-at-point-functions 'message-completion-function nil t)
3141   (unless buffer-file-name
3142     (message-set-auto-save-file-name))
3143   (unless (buffer-base-buffer)
3144     ;; Don't enable multibyte on an indirect buffer.  Maybe enabling
3145     ;; multibyte is not necessary at all. -- zsh
3146     (mm-enable-multibyte))
3147   (set (make-local-variable 'indent-tabs-mode) nil) ;No tabs for indentation.
3148   (mml-mode)
3149   ;; Syntactic fontification. Helps `show-paren-mode',
3150   ;; `electric-pair-mode', and C-M-* navigation by syntactically
3151   ;; excluding citations and other artifacts.
3152   ;;
3153   (set (make-local-variable 'syntax-propertize-function) 'message--syntax-propertize)
3154   (set (make-local-variable 'parse-sexp-ignore-comments) t))
3155
3156 (defun message-setup-fill-variables ()
3157   "Setup message fill variables."
3158   (set (make-local-variable 'fill-paragraph-function)
3159        'message-fill-paragraph)
3160   (make-local-variable 'paragraph-separate)
3161   (make-local-variable 'paragraph-start)
3162   (make-local-variable 'adaptive-fill-regexp)
3163   (unless (boundp 'adaptive-fill-first-line-regexp)
3164     (setq adaptive-fill-first-line-regexp nil))
3165   (make-local-variable 'adaptive-fill-first-line-regexp)
3166   (let ((quote-prefix-regexp
3167          ;; User should change message-cite-prefix-regexp if
3168          ;; message-yank-prefix is set to an abnormal value.
3169          (concat "\\(" message-cite-prefix-regexp "\\)[ \t]*")))
3170     (setq paragraph-start
3171           (concat
3172            (regexp-quote mail-header-separator) "$\\|"
3173            "[ \t]*$\\|"                 ; blank lines
3174            "-- $\\|"                    ; signature delimiter
3175            "---+$\\|"              ; delimiters for forwarded messages
3176            page-delimiter "$\\|"        ; spoiler warnings
3177            ".*wrote:$\\|"               ; attribution lines
3178            quote-prefix-regexp "$\\|"   ; empty lines in quoted text
3179                                         ; mml tags
3180            "<#!*/?\\(multipart\\|part\\|external\\|mml\\|secure\\)"))
3181     (setq paragraph-separate paragraph-start)
3182     (setq adaptive-fill-regexp
3183           (concat quote-prefix-regexp "\\|" adaptive-fill-regexp))
3184     (setq adaptive-fill-first-line-regexp
3185           (concat quote-prefix-regexp "\\|"
3186                   adaptive-fill-first-line-regexp)))
3187   (make-local-variable 'auto-fill-inhibit-regexp)
3188   ;;(setq auto-fill-inhibit-regexp "^[A-Z][^: \n\t]+:")
3189   (setq auto-fill-inhibit-regexp nil)
3190   (make-local-variable 'normal-auto-fill-function)
3191   (setq normal-auto-fill-function 'message-do-auto-fill)
3192   ;; KLUDGE: auto fill might already be turned on in `text-mode-hook'.
3193   ;; In that case, ensure that it uses the right function.  The real
3194   ;; solution would be not to use `define-derived-mode', and run
3195   ;; `text-mode-hook' ourself at the end of the mode.
3196   ;; -- Per Abrahamsen <abraham@dina.kvl.dk> Date: 2001-10-19.
3197   ;; This kludge is unneeded in Emacs>=21 since define-derived-mode is
3198   ;; now careful to run parent hooks after the body.  --Stef
3199   (when auto-fill-function
3200     (setq auto-fill-function normal-auto-fill-function)))
3201
3202 \f
3203
3204 ;;;
3205 ;;; Message mode commands
3206 ;;;
3207
3208 ;;; Movement commands
3209
3210 (defun message-goto-to ()
3211   "Move point to the To header."
3212   (interactive)
3213   (push-mark)
3214   (message-position-on-field "To"))
3215
3216 (defun message-goto-from ()
3217   "Move point to the From header."
3218   (interactive)
3219   (push-mark)
3220   (message-position-on-field "From"))
3221
3222 (defun message-goto-subject ()
3223   "Move point to the Subject header."
3224   (interactive)
3225   (push-mark)
3226   (message-position-on-field "Subject"))
3227
3228 (defun message-goto-cc ()
3229   "Move point to the Cc header."
3230   (interactive)
3231   (push-mark)
3232   (message-position-on-field "Cc" "To"))
3233
3234 (defun message-goto-bcc ()
3235   "Move point to the Bcc  header."
3236   (interactive)
3237   (push-mark)
3238   (message-position-on-field "Bcc" "Cc" "To"))
3239
3240 (defun message-goto-fcc ()
3241   "Move point to the Fcc header."
3242   (interactive)
3243   (push-mark)
3244   (message-position-on-field "Fcc" "To" "Newsgroups"))
3245
3246 (defun message-goto-reply-to ()
3247   "Move point to the Reply-To header."
3248   (interactive)
3249   (push-mark)
3250   (message-position-on-field "Reply-To" "Subject"))
3251
3252 (defun message-goto-newsgroups ()
3253   "Move point to the Newsgroups header."
3254   (interactive)
3255   (push-mark)
3256   (message-position-on-field "Newsgroups"))
3257
3258 (defun message-goto-distribution ()
3259   "Move point to the Distribution header."
3260   (interactive)
3261   (push-mark)
3262   (message-position-on-field "Distribution"))
3263
3264 (defun message-goto-followup-to ()
3265   "Move point to the Followup-To header."
3266   (interactive)
3267   (push-mark)
3268   (message-position-on-field "Followup-To" "Newsgroups"))
3269
3270 (defun message-goto-mail-followup-to ()
3271   "Move point to the Mail-Followup-To header."
3272   (interactive)
3273   (push-mark)
3274   (message-position-on-field "Mail-Followup-To" "To"))
3275
3276 (defun message-goto-keywords ()
3277   "Move point to the Keywords header."
3278   (interactive)
3279   (push-mark)
3280   (message-position-on-field "Keywords" "Subject"))
3281
3282 (defun message-goto-summary ()
3283   "Move point to the Summary header."
3284   (interactive)
3285   (push-mark)
3286   (message-position-on-field "Summary" "Subject"))
3287
3288 (defun message-goto-body ()
3289   "Move point to the beginning of the message body."
3290   (interactive)
3291   (when (and (gmm-called-interactively-p 'any)
3292              (looking-at "[ \t]*\n"))
3293     (expand-abbrev))
3294   (push-mark)
3295   (goto-char (point-min))
3296   (or (search-forward (concat "\n" mail-header-separator "\n") nil t)
3297       (search-forward-regexp "[^:]+:\\([^\n]\\|\n[ \t]\\)+\n\n" nil t)))
3298
3299 (defun message-in-body-p ()
3300   "Return t if point is in the message body."
3301   (>= (point)
3302       (save-excursion
3303         (goto-char (point-min))
3304         (or (search-forward (concat "\n" mail-header-separator "\n") nil t)
3305             (search-forward-regexp "[^:]+:\\([^\n]\\|\n[ \t]\\)+\n\n" nil t))
3306         (point))))
3307
3308 (defun message-goto-eoh ()
3309   "Move point to the end of the headers."
3310   (interactive)
3311   (message-goto-body)
3312   (forward-line -1))
3313
3314 (defun message-goto-signature ()
3315   "Move point to the beginning of the message signature.
3316 If there is no signature in the article, go to the end and
3317 return nil."
3318   (interactive)
3319   (push-mark)
3320   (goto-char (point-min))
3321   (if (re-search-forward message-signature-separator nil t)
3322       (forward-line 1)
3323     (goto-char (point-max))
3324     nil))
3325
3326 (defun message-generate-unsubscribed-mail-followup-to (&optional include-cc)
3327   "Insert a reasonable MFT header in a post to an unsubscribed list.
3328 When making original posts to a mailing list you are not subscribed to,
3329 you have to type in a MFT header by hand.  The contents, usually, are
3330 the addresses of the list and your own address.  This function inserts
3331 such a header automatically.  It fetches the contents of the To: header
3332 in the current mail buffer, and appends the current `user-mail-address'.
3333
3334 If the optional argument INCLUDE-CC is non-nil, the addresses in the
3335 Cc: header are also put into the MFT."
3336
3337   (interactive "P")
3338   (let* (cc tos)
3339     (save-restriction
3340       (message-narrow-to-headers)
3341       (message-remove-header "Mail-Followup-To")
3342       (setq cc (and include-cc (message-fetch-field "Cc")))
3343       (setq tos (if cc
3344                     (concat (message-fetch-field "To") "," cc)
3345                   (message-fetch-field "To"))))
3346     (message-goto-mail-followup-to)
3347     (insert (concat tos ", " user-mail-address))))
3348
3349 \f
3350
3351 (defun message-insert-to (&optional force)
3352   "Insert a To header that points to the author of the article being replied to.
3353 If the original author requested not to be sent mail, don't insert unless the
3354 prefix FORCE is given."
3355   (interactive "P")
3356   (let* ((mct (message-fetch-reply-field "mail-copies-to"))
3357          (dont (and mct (or (equal (downcase mct) "never")
3358                             (equal (downcase mct) "nobody"))))
3359          (to (or (message-fetch-reply-field "mail-reply-to")
3360                  (message-fetch-reply-field "reply-to")
3361                  (message-fetch-reply-field "from"))))
3362     (when (and dont to)
3363       (message
3364        (if force
3365            "Ignoring the user request not to have copies sent via mail"
3366          "Complying with the user request not to have copies sent via mail")))
3367     (when (and force (not to))
3368       (error "No mail address in the article"))
3369     (when (and to (or force (not dont)))
3370       (message-carefully-insert-headers (list (cons 'To to))))))
3371
3372 (defun message-insert-wide-reply ()
3373   "Insert To and Cc headers as if you were doing a wide reply."
3374   (interactive)
3375   (let ((headers (message-with-reply-buffer
3376                    (message-get-reply-headers t))))
3377     (message-carefully-insert-headers headers)))
3378
3379 (defcustom message-header-synonyms
3380   '((To Cc Bcc)
3381     (Original-To))
3382   "List of lists of header synonyms.
3383 E.g., if this list contains a member list with elements `Cc' and `To',
3384 then `message-carefully-insert-headers' will not insert a `To' header
3385 when the message is already `Cc'ed to the recipient."
3386   :version "22.1"
3387   :group 'message-headers
3388   :link '(custom-manual "(message)Message Headers")
3389   :type '(repeat sexp))
3390
3391 (defun message-carefully-insert-headers (headers)
3392   "Insert the HEADERS, an alist, into the message buffer.
3393 Does not insert the headers when they are already present there
3394 or in the synonym headers, defined by `message-header-synonyms'."
3395   ;; FIXME: Should compare only the address and not the full name.  Comparison
3396   ;; should be done case-folded (and with `string=' rather than
3397   ;; `string-match').
3398   ;; (mail-strip-quoted-names "Foo Bar <foo@bar>, bla@fasel (Bla Fasel)")
3399   (dolist (header headers)
3400     (let* ((header-name (symbol-name (car header)))
3401            (new-header (cdr header))
3402            (synonyms (loop for synonym in message-header-synonyms
3403                            when (memq (car header) synonym) return synonym))
3404            (old-header
3405             (loop for synonym in synonyms
3406                   for old-header = (mail-fetch-field (symbol-name synonym))
3407                   when (and old-header (string-match new-header old-header))
3408                   return synonym)))
3409       (if old-header
3410           (message "already have `%s' in `%s'" new-header old-header)
3411         (when (and (message-position-on-field header-name)
3412                    (setq old-header (mail-fetch-field header-name))
3413                    (not (string-match "\\` *\\'" old-header)))
3414           (insert ", "))
3415         (insert new-header)))))
3416
3417 (defun message-widen-reply ()
3418   "Widen the reply to include maximum recipients."
3419   (interactive)
3420   (let ((follow-to
3421          (and (bufferp message-reply-buffer)
3422               (buffer-name message-reply-buffer)
3423               (with-current-buffer message-reply-buffer
3424                 (message-get-reply-headers t)))))
3425     (save-excursion
3426       (save-restriction
3427         (message-narrow-to-headers)
3428         (dolist (elem follow-to)
3429           (message-remove-header (symbol-name (car elem)))
3430           (goto-char (point-min))
3431           (insert (symbol-name (car elem)) ": "
3432                   (cdr elem) "\n"))))))
3433
3434 (defun message-insert-newsgroups ()
3435   "Insert the Newsgroups header from the article being replied to."
3436   (interactive)
3437   (let ((old-newsgroups (mail-fetch-field "newsgroups"))
3438         (new-newsgroups (message-fetch-reply-field "newsgroups"))
3439         (first t)
3440         insert-newsgroups)
3441     (message-position-on-field "Newsgroups")
3442     (cond
3443      ((not new-newsgroups)
3444       (error "No Newsgroups to insert"))
3445      ((not old-newsgroups)
3446       (insert new-newsgroups))
3447      (t
3448       (setq new-newsgroups (split-string new-newsgroups "[, ]+")
3449             old-newsgroups (split-string old-newsgroups "[, ]+"))
3450       (dolist (group new-newsgroups)
3451         (unless (member group old-newsgroups)
3452           (push group insert-newsgroups)))
3453       (if (null insert-newsgroups)
3454           (error "Newgroup%s already in the header"
3455                  (if (> (length new-newsgroups) 1)
3456                      "s" ""))
3457         (when old-newsgroups
3458           (setq first nil))
3459         (dolist (group insert-newsgroups)
3460           (unless first
3461             (insert ","))
3462           (setq first nil)
3463           (insert group)))))))
3464
3465 \f
3466
3467 ;;; Various commands
3468
3469 (defun message-delete-not-region (beg end)
3470   "Delete everything in the body of the current message outside of the region."
3471   (interactive "r")
3472   (let (citeprefix)
3473     (save-excursion
3474       (goto-char beg)
3475       ;; snarf citation prefix, if appropriate
3476       (unless (eq (point) (progn (beginning-of-line) (point)))
3477         (when (looking-at message-cite-prefix-regexp)
3478           (setq citeprefix (match-string 0))))
3479       (goto-char end)
3480       (delete-region (point) (if (not (message-goto-signature))
3481                                  (point)
3482                                (forward-line -2)
3483                                (point)))
3484       (insert "\n")
3485       (goto-char beg)
3486       (delete-region beg (progn (message-goto-body)
3487                                 (forward-line 2)
3488                                 (point)))
3489       (when citeprefix
3490         (insert citeprefix))))
3491   (when (message-goto-signature)
3492     (forward-line -2)))
3493
3494 (defun message-kill-to-signature (&optional arg)
3495   "Kill all text up to the signature.
3496 If a numeric argument or prefix arg is given, leave that number
3497 of lines before the signature intact."
3498   (interactive "P")
3499   (save-excursion
3500     (save-restriction
3501       (let ((point (point)))
3502         (narrow-to-region point (point-max))
3503         (message-goto-signature)
3504         (unless (eobp)
3505           (if (and arg (numberp arg))
3506               (forward-line (- -1 arg))
3507             (end-of-line -1)))
3508         (unless (= point (point))
3509           (kill-region point (point))
3510           (unless (bolp)
3511             (insert "\n")))))))
3512
3513 (defun message-newline-and-reformat (&optional arg not-break)
3514   "Insert four newlines, and then reformat if inside quoted text.
3515 Prefix arg means justify as well."
3516   (interactive (list (if current-prefix-arg 'full)))
3517   (let (quoted point beg end leading-space bolp fill-paragraph-function)
3518     (setq point (point))
3519     (beginning-of-line)
3520     (setq beg (point))
3521     (setq bolp (= beg point))
3522     ;; Find first line of the paragraph.
3523     (if not-break
3524         (while (and (not (eobp))
3525                     (not (looking-at message-cite-prefix-regexp))
3526                     (looking-at paragraph-start))
3527           (forward-line 1)))
3528     ;; Find the prefix
3529     (when (looking-at message-cite-prefix-regexp)
3530       (setq quoted (match-string 0))
3531       (goto-char (match-end 0))
3532       (looking-at "[ \t]*")
3533       (setq leading-space (match-string 0)))
3534     (if (and quoted
3535              (not not-break)
3536              (not bolp)
3537              (< (- point beg) (length quoted)))
3538         ;; break inside the cite prefix.
3539         (setq quoted nil
3540               end nil))
3541     (if quoted
3542         (progn
3543           (forward-line 1)
3544           (while (and (not (eobp))
3545                       (not (looking-at paragraph-separate))
3546                       (looking-at message-cite-prefix-regexp)
3547                       (equal quoted (match-string 0)))
3548             (goto-char (match-end 0))
3549             (looking-at "[ \t]*")
3550             (if (> (length leading-space) (length (match-string 0)))
3551                 (setq leading-space (match-string 0)))
3552             (forward-line 1))
3553           (setq end (point))
3554           (goto-char beg)
3555           (while (and (if (bobp) nil (forward-line -1) t)
3556                       (not (looking-at paragraph-start))
3557                       (looking-at message-cite-prefix-regexp)
3558                       (equal quoted (match-string 0)))
3559             (setq beg (point))
3560             (goto-char (match-end 0))
3561             (looking-at "[ \t]*")
3562             (if (> (length leading-space) (length (match-string 0)))
3563                 (setq leading-space (match-string 0)))))
3564       (while (and (not (eobp))
3565                   (not (looking-at paragraph-separate))
3566                   (not (looking-at message-cite-prefix-regexp)))
3567         (forward-line 1))
3568       (setq end (point))
3569       (goto-char beg)
3570       (while (and (if (bobp) nil (forward-line -1) t)
3571                   (not (looking-at paragraph-start))
3572                   (not (looking-at message-cite-prefix-regexp)))
3573         (setq beg (point))))
3574     (goto-char point)
3575     (save-restriction
3576       (narrow-to-region beg end)
3577       (if not-break
3578           (setq point nil)
3579         (if bolp
3580             (newline)
3581           (newline)
3582           (newline))
3583         (setq point (point))
3584         ;; (newline 2) doesn't mark both newline's as hard, so call
3585         ;; newline twice. -jas
3586         (newline)
3587         (newline)
3588         (delete-region (point) (re-search-forward "[ \t]*"))
3589         (when (and quoted (not bolp))
3590           (insert quoted leading-space)))
3591       (undo-boundary)
3592       (if quoted
3593           (let* ((adaptive-fill-regexp
3594                   (regexp-quote (concat quoted leading-space)))
3595                  (adaptive-fill-first-line-regexp
3596                   adaptive-fill-regexp ))
3597             (fill-paragraph arg))
3598         (fill-paragraph arg))
3599       (if point (goto-char point)))))
3600
3601 (defun message-fill-paragraph (&optional arg)
3602   "Message specific function to fill a paragraph.
3603 This function is used as the value of `fill-paragraph-function' in
3604 Message buffers and is not meant to be called directly."
3605   (interactive (list (if current-prefix-arg 'full)))
3606   (if (if (boundp 'filladapt-mode) filladapt-mode)
3607       nil
3608     (if (message-point-in-header-p)
3609         (message-fill-field)
3610       (message-newline-and-reformat arg t))
3611     t))
3612
3613 (defun message-point-in-header-p ()
3614   "Return t if point is in the header."
3615   (save-excursion
3616     (and
3617      (not
3618       (re-search-backward
3619        (concat "^" (regexp-quote mail-header-separator) "\n") nil t))
3620      (re-search-forward
3621       (concat "^" (regexp-quote mail-header-separator) "\n") nil t))))
3622
3623 (defun message-do-auto-fill ()
3624   "Like `do-auto-fill', but don't fill in message header."
3625   (unless (message-point-in-header-p)
3626     (do-auto-fill)))
3627
3628 (defun message-insert-signature (&optional force)
3629   "Insert a signature.  See documentation for variable `message-signature'."
3630   (interactive (list 0))
3631   (let* ((signature
3632           (cond
3633            ((and (null message-signature)
3634                  (eq force 0))
3635             (save-excursion
3636               (goto-char (point-max))
3637               (not (re-search-backward message-signature-separator nil t))))
3638            ((and (null message-signature)
3639                  force)
3640             t)
3641            ((functionp message-signature)
3642             (funcall message-signature))
3643            ((listp message-signature)
3644             (eval message-signature))
3645            (t message-signature)))
3646          signature-file)
3647     (setq signature
3648           (cond ((stringp signature)
3649                  signature)
3650                 ((and (eq t signature) message-signature-file)
3651                  (setq signature-file
3652                        (if (and message-signature-directory
3653                                 ;; don't actually use the signature directory
3654                                 ;; if message-signature-file contains a path.
3655                                 (not (file-name-directory
3656                                       message-signature-file)))
3657                            (expand-file-name message-signature-file
3658                                              message-signature-directory)
3659                          message-signature-file))
3660                  (file-exists-p signature-file))))
3661     (when signature
3662       (goto-char (point-max))
3663       ;; Insert the signature.
3664       (unless (bolp)
3665         (newline))
3666       (when message-signature-insert-empty-line
3667         (newline))
3668       (insert "-- ")
3669       (newline)
3670       (if (eq signature t)
3671           (insert-file-contents signature-file)
3672         (insert signature))
3673       (goto-char (point-max))
3674       (or (bolp) (newline)))))
3675
3676 (defun message-insert-importance-high ()
3677   "Insert header to mark message as important."
3678   (interactive)
3679   (save-excursion
3680     (save-restriction
3681       (message-narrow-to-headers)
3682       (message-remove-header "Importance"))
3683     (message-goto-eoh)
3684     (insert "Importance: high\n")))
3685
3686 (defun message-insert-importance-low ()
3687   "Insert header to mark message as unimportant."
3688   (interactive)
3689   (save-excursion
3690     (save-restriction
3691       (message-narrow-to-headers)
3692       (message-remove-header "Importance"))
3693     (message-goto-eoh)
3694     (insert "Importance: low\n")))
3695
3696 (defun message-insert-or-toggle-importance ()
3697   "Insert a \"Importance: high\" header, or cycle through the header values.
3698 The three allowed values according to RFC 1327 are `high', `normal'
3699 and `low'."
3700   (interactive)
3701   (save-excursion
3702     (let ((new "high")
3703           cur)
3704       (save-restriction
3705         (message-narrow-to-headers)
3706         (when (setq cur (message-fetch-field "Importance"))
3707           (message-remove-header "Importance")
3708           (setq new (cond ((string= cur "high")
3709                            "low")
3710                           ((string= cur "low")
3711                            "normal")
3712                           (t
3713                            "high")))))
3714       (message-goto-eoh)
3715       (insert (format "Importance: %s\n" new)))))
3716
3717 (defun message-insert-disposition-notification-to ()
3718   "Request a disposition notification (return receipt) to this message.
3719 Note that this should not be used in newsgroups."
3720   (interactive)
3721   (save-excursion
3722     (save-restriction
3723       (message-narrow-to-headers)
3724       (message-remove-header "Disposition-Notification-To"))
3725     (message-goto-eoh)
3726     (insert (format "Disposition-Notification-To: %s\n"
3727                     (or (message-field-value "Reply-to")
3728                         (message-field-value "From")
3729                         (message-make-from))))))
3730
3731 (defun message-elide-region (b e)
3732   "Elide the text in the region.
3733 An ellipsis (from `message-elide-ellipsis') will be inserted where the
3734 text was killed."
3735   (interactive "r")
3736   (let ((lines (count-lines b e))
3737         (chars (- e b)))
3738     (kill-region b e)
3739     (insert (format-spec message-elide-ellipsis
3740                          `((?l . ,lines)
3741                            (?c . ,chars))))))
3742
3743 (defvar message-caesar-translation-table nil)
3744
3745 (defun message-caesar-region (b e &optional n)
3746   "Caesar rotate region B to E by N, default 13, for decrypting netnews."
3747   (interactive
3748    (list
3749     (min (point) (or (mark t) (point)))
3750     (max (point) (or (mark t) (point)))
3751     (when current-prefix-arg
3752       (prefix-numeric-value current-prefix-arg))))
3753
3754   (setq n (if (numberp n) (mod n 26) 13)) ;canonize N
3755   (unless (or (zerop n)                 ; no action needed for a rot of 0
3756               (= b e))                  ; no region to rotate
3757     ;; We build the table, if necessary.
3758     (when (or (not message-caesar-translation-table)
3759               (/= (aref message-caesar-translation-table ?a) (+ ?a n)))
3760       (setq message-caesar-translation-table
3761             (message-make-caesar-translation-table n)))
3762     (translate-region b e message-caesar-translation-table)))
3763
3764 (defun message-make-caesar-translation-table (n)
3765   "Create a rot table with offset N."
3766   (let ((i -1)
3767         (table (make-string 256 0)))
3768     (while (< (incf i) 256)
3769       (aset table i i))
3770     (concat
3771      (substring table 0 ?A)
3772      (substring table (+ ?A n) (+ ?A n (- 26 n)))
3773      (substring table ?A (+ ?A n))
3774      (substring table (+ ?A 26) ?a)
3775      (substring table (+ ?a n) (+ ?a n (- 26 n)))
3776      (substring table ?a (+ ?a n))
3777      (substring table (+ ?a 26) 255))))
3778
3779 (defun message-caesar-buffer-body (&optional rotnum wide)
3780   "Caesar rotate all letters in the current buffer by 13 places.
3781 Used to encode/decode possibly offensive messages (commonly in rec.humor).
3782 With prefix arg, specifies the number of places to rotate each letter forward.
3783 Mail and USENET news headers are not rotated unless WIDE is non-nil."
3784   (interactive (if current-prefix-arg
3785                    (list (prefix-numeric-value current-prefix-arg))
3786                  (list nil)))
3787   (save-excursion
3788     (save-restriction
3789       (when (and (not wide) (message-goto-body))
3790         (narrow-to-region (point) (point-max)))
3791       (message-caesar-region (point-min) (point-max) rotnum))))
3792
3793 (defun message-pipe-buffer-body (program)
3794   "Pipe the message body in the current buffer through PROGRAM."
3795   (save-excursion
3796     (save-restriction
3797       (when (message-goto-body)
3798         (narrow-to-region (point) (point-max)))
3799       (shell-command-on-region
3800        (point-min) (point-max) program nil t))))
3801
3802 (defun message-rename-buffer (&optional enter-string)
3803   "Rename the *message* buffer to \"*message* RECIPIENT\".
3804 If the function is run with a prefix, it will ask for a new buffer
3805 name, rather than giving an automatic name."
3806   (interactive "Pbuffer name: ")
3807   (save-excursion
3808     (save-restriction
3809       (goto-char (point-min))
3810       (narrow-to-region (point)
3811                         (search-forward mail-header-separator nil 'end))
3812       (let* ((mail-to (or
3813                        (if (message-news-p) (message-fetch-field "Newsgroups")
3814                          (message-fetch-field "To"))
3815                        ""))
3816              (mail-trimmed-to
3817               (if (string-match "," mail-to)
3818                   (concat (substring mail-to 0 (match-beginning 0)) ", ...")
3819                 mail-to))
3820              (name-default (concat "*message* " mail-trimmed-to))
3821              (name (if enter-string
3822                        (read-string "New buffer name: " name-default)
3823                      name-default)))
3824         (rename-buffer name t)))))
3825
3826 (defun message-fill-yanked-message (&optional justifyp)
3827   "Fill the paragraphs of a message yanked into this one.
3828 Numeric argument means justify as well."
3829   (interactive "P")
3830   (save-excursion
3831     (goto-char (point-min))
3832     (search-forward (concat "\n" mail-header-separator "\n") nil t)
3833     (let ((fill-prefix message-yank-prefix))
3834       (fill-individual-paragraphs (point) (point-max) justifyp))))
3835
3836 (defun message-indent-citation (&optional start end yank-only)
3837   "Modify text just inserted from a message to be cited.
3838 The inserted text should be the region.
3839 When this function returns, the region is again around the modified text.
3840
3841 Normally, indent each nonblank line `message-indentation-spaces' spaces.
3842 However, if `message-yank-prefix' is non-nil, insert that prefix on each line."
3843   (unless start (setq start (point)))
3844   (unless yank-only
3845     ;; Remove unwanted headers.
3846     (when message-ignored-cited-headers
3847       (let (all-removed)
3848         (save-restriction
3849           (narrow-to-region
3850            (goto-char start)
3851            (if (search-forward "\n\n" nil t)
3852                (1- (point))
3853              (point)))
3854           (message-remove-header message-ignored-cited-headers t)
3855           (when (= (point-min) (point-max))
3856             (setq all-removed t))
3857           (goto-char (point-max)))
3858         (if all-removed
3859             (goto-char start)
3860           (forward-line 1))))
3861     ;; Delete blank lines at the start of the buffer.
3862     (while (and (point-min)
3863                 (eolp)
3864                 (not (eobp)))
3865       (message-delete-line))
3866     ;; Delete blank lines at the end of the buffer.
3867     (goto-char (point-max))
3868     (unless (eq (preceding-char) ?\n)
3869       (insert "\n"))
3870     (while (and (zerop (forward-line -1))
3871                 (looking-at "$"))
3872       (message-delete-line)))
3873   ;; Do the indentation.
3874   (if (null message-yank-prefix)
3875       (indent-rigidly start (or end (mark t)) message-indentation-spaces)
3876     (save-excursion
3877       (goto-char start)
3878       (while (< (point) (or end (mark t)))
3879         (cond ((looking-at ">")
3880                (insert message-yank-cited-prefix))
3881               ((looking-at "^$")
3882                (insert message-yank-empty-prefix))
3883               (t
3884                (insert message-yank-prefix)))
3885         (forward-line 1))))
3886   (goto-char start))
3887
3888 (defun message-remove-blank-cited-lines (&optional remove)
3889   "Remove cited lines containing only blanks.
3890 If REMOVE is non-nil, remove newlines, too.
3891
3892 To use this automatically, you may add this function to
3893 `gnus-message-setup-hook'."
3894   (interactive "P")
3895   (let ((citexp
3896          (concat
3897           "^\\("
3898           (when (boundp 'message-yank-cited-prefix)
3899             (concat message-yank-cited-prefix "\\|"))
3900           message-yank-prefix
3901           "\\)+ *\n"
3902           )))
3903     (gnus-message 8 "removing `%s'" citexp)
3904     (save-excursion
3905       (message-goto-body)
3906       (while (re-search-forward citexp nil t)
3907         (replace-match (if remove "" "\n"))))))
3908
3909 (defun message--yank-original-internal (arg)
3910   (let ((modified (buffer-modified-p))
3911         body-text)
3912         (when (and message-reply-buffer
3913                    message-cite-function)
3914           (when (equal message-cite-reply-position 'above)
3915             (save-excursion
3916               (setq body-text
3917                     (buffer-substring (message-goto-body)
3918                                       (point-max)))
3919               (delete-region (message-goto-body) (point-max))))
3920           (if (bufferp message-reply-buffer)
3921               (delete-windows-on message-reply-buffer t))
3922           (push-mark (save-excursion
3923                        (cond
3924                         ((bufferp message-reply-buffer)
3925                          (insert-buffer-substring message-reply-buffer))
3926                         ((and (consp message-reply-buffer)
3927                               (functionp (car message-reply-buffer)))
3928                          (apply (car message-reply-buffer)
3929                                 (cdr message-reply-buffer))))
3930                        (unless (bolp)
3931                          (insert ?\n))
3932                        (point)))
3933           (unless arg
3934             (funcall message-cite-function)
3935             (unless (eq (char-before (mark t)) ?\n)
3936               (let ((pt (point)))
3937                 (goto-char (mark t))
3938                 (insert-before-markers ?\n)
3939                 (goto-char pt))))
3940           (case message-cite-reply-position
3941             (above
3942              (message-goto-body)
3943              (insert body-text)
3944              (insert (if (bolp) "\n" "\n\n"))
3945              (message-goto-body))
3946             (below
3947              (message-goto-signature)))
3948           ;; Add a `message-setup-very-last-hook' here?
3949           ;; Add `gnus-article-highlight-citation' here?
3950           (unless modified
3951         (setq message-checksum (message-checksum))))))
3952
3953 (defun message-yank-original (&optional arg)
3954   "Insert the message being replied to, if any.
3955 Puts point before the text and mark after.
3956 Normally indents each nonblank line ARG spaces (default 3).  However,
3957 if `message-yank-prefix' is non-nil, insert that prefix on each line.
3958
3959 This function uses `message-cite-function' to do the actual citing.
3960
3961 Just \\[universal-argument] as argument means don't indent, insert no
3962 prefix, and don't delete any headers."
3963   (interactive "P")
3964   ;; eval the let forms contained in message-cite-style
3965   (eval
3966    `(let ,(if (symbolp message-cite-style)
3967               (symbol-value message-cite-style)
3968             message-cite-style)
3969       (message--yank-original-internal ',arg))))
3970
3971 (defun message-yank-buffer (buffer)
3972   "Insert BUFFER into the current buffer and quote it."
3973   (interactive "bYank buffer: ")
3974   (let ((message-reply-buffer (get-buffer buffer)))
3975     (save-window-excursion
3976       (message-yank-original))))
3977
3978 (defun message-buffers ()
3979   "Return a list of active message buffers."
3980   (let (buffers)
3981     (save-current-buffer
3982       (dolist (buffer (buffer-list t))
3983         (set-buffer buffer)
3984         (when (and (derived-mode-p 'message-mode)
3985                    (null message-sent-message-via))
3986           (push (buffer-name buffer) buffers))))
3987     (nreverse buffers)))
3988
3989 (defun message-cite-original-1 (strip-signature)
3990   "Cite an original message.
3991 If STRIP-SIGNATURE is non-nil, strips off the signature from the
3992 original message.
3993
3994 This function uses `mail-citation-hook' if that is non-nil."
3995   (if (and (boundp 'mail-citation-hook)
3996            mail-citation-hook)
3997       (run-hooks 'mail-citation-hook)
3998     (let* ((start (point))
3999            (end (mark t))
4000            (x-no-archive nil)
4001            (functions
4002             (when message-indent-citation-function
4003               (if (listp message-indent-citation-function)
4004                   message-indent-citation-function
4005                 (list message-indent-citation-function))))
4006            ;; This function may be called by `gnus-summary-yank-message' and
4007            ;; may insert a different article from the original.  So, we will
4008            ;; modify the value of `message-reply-headers' with that article.
4009            (message-reply-headers
4010             (save-restriction
4011               (narrow-to-region start end)
4012               (message-narrow-to-head-1)
4013               (setq x-no-archive (message-fetch-field "x-no-archive"))
4014               (vector 0
4015                       (or (message-fetch-field "subject") "none")
4016                       (or (message-fetch-field "from") "nobody")
4017                       (message-fetch-field "date")
4018                       (message-fetch-field "message-id" t)
4019                       (message-fetch-field "references")
4020                       0 0 ""))))
4021       (mml-quote-region start end)
4022       (when strip-signature
4023         ;; Allow undoing.
4024         (undo-boundary)
4025         (goto-char end)
4026         (when (re-search-backward message-signature-separator start t)
4027           ;; Also peel off any blank lines before the signature.
4028           (forward-line -1)
4029           (while (looking-at "^[ \t]*$")
4030             (forward-line -1))
4031           (forward-line 1)
4032           (delete-region (point) end)
4033           (unless (search-backward "\n\n" start t)
4034             ;; Insert a blank line if it is peeled off.
4035             (insert "\n"))))
4036       (goto-char start)
4037       (mapc 'funcall functions)
4038       (when message-citation-line-function
4039         (unless (bolp)
4040           (insert "\n"))
4041         (funcall message-citation-line-function))
4042       (when (and x-no-archive
4043                  (not message-cite-articles-with-x-no-archive)
4044                  (string-match "yes" x-no-archive))
4045         (undo-boundary)
4046         (delete-region (point) (mark t))
4047         (insert "> [Quoted text removed due to X-No-Archive]\n")
4048         (push-mark)
4049         (forward-line -1)))))
4050
4051 (defun message-cite-original ()
4052   "Cite function in the standard Message manner."
4053   (message-cite-original-1 nil))
4054
4055 (autoload 'format-spec "format-spec")
4056 (autoload 'gnus-date-get-time "gnus-util")
4057
4058 (defun message-insert-formatted-citation-line (&optional from date tz)
4059   "Function that inserts a formatted citation line.
4060 The optional FROM, and DATE are strings containing the contents of
4061 the From header and the Date header respectively.  The optional TZ
4062 is a number of seconds, overrides the time zone of DATE.
4063
4064 See `message-citation-line-format'."
4065   ;; The optional args are for testing/debugging.  They will disappear later.
4066   ;; Example:
4067   ;; (with-temp-buffer
4068   ;;   (message-insert-formatted-citation-line
4069   ;;    "John Doe <john.doe@example.invalid>"
4070   ;;    (message-make-date))
4071   ;;   (buffer-string))
4072   (when (or message-reply-headers (and from date))
4073     (unless from
4074       (setq from (mail-header-from message-reply-headers)))
4075     (let* ((data (condition-case ()
4076                      (funcall (if (boundp 'gnus-extract-address-components)
4077                                   gnus-extract-address-components
4078                                 'mail-extract-address-components)
4079                               from)
4080                    (error nil)))
4081            (name (car data))
4082            (fname name)
4083            (lname name)
4084            (net (car (cdr data)))
4085            (name-or-net (or (car data)
4086                             (car (cdr data)) from))
4087            (time
4088             (when (string-match "%[^fnNFL]" message-citation-line-format)
4089               (cond ((numberp (car-safe date)) date) ;; backward compatibility
4090                     (date (gnus-date-get-time date))
4091                     (t
4092                      (gnus-date-get-time
4093                       (setq date (mail-header-date message-reply-headers)))))))
4094            (tz (or tz
4095                    (when (stringp date)
4096                      (nth 8 (parse-time-string date)))))
4097            (flist
4098             (let ((i ?A) lst)
4099               (when (stringp name)
4100                 ;; Guess first name and last name:
4101                 (let* ((names (delq
4102                                nil
4103                                (mapcar
4104                                 (lambda (x)
4105                                   (if (string-match "\\`\\(\\w\\|[-.]\\)+\\'"
4106                                                     x)
4107                                       x
4108                                     nil))
4109                                 (split-string name "[ \t]+"))))
4110                        (count (length names)))
4111                   (cond ((= count 1)
4112                          (setq fname (car names)
4113                                lname ""))
4114                         ((or (= count 2) (= count 3))
4115                          (setq fname (car names)
4116                                lname (mapconcat 'identity (cdr names) " ")))
4117                         ((> count 3)
4118                          (setq fname (mapconcat 'identity
4119                                                 (butlast names (- count 2))
4120                                                 " ")
4121                                lname (mapconcat 'identity
4122                                                 (nthcdr 2 names)
4123                                                 " "))))
4124                   (when (string-match "\\(.*\\),\\'" fname)
4125                     (let ((newlname (match-string 1 fname)))
4126                       (setq fname lname lname newlname)))))
4127               ;; The following letters are not used in `format-time-string':
4128               (push ?E lst) (push "<E>" lst)
4129               (push ?F lst) (push (or fname name-or-net) lst)
4130               ;; We might want to use "" instead of "<X>" later.
4131               (push ?J lst) (push "<J>" lst)
4132               (push ?K lst) (push "<K>" lst)
4133               (push ?L lst) (push lname lst)
4134               (push ?N lst) (push name-or-net lst)
4135               (push ?O lst) (push "<O>" lst)
4136               (push ?P lst) (push "<P>" lst)
4137               (push ?Q lst) (push "<Q>" lst)
4138               (push ?f lst) (push from lst)
4139               (push ?i lst) (push "<i>" lst)
4140               (push ?n lst) (push net lst)
4141               (push ?o lst) (push "<o>" lst)
4142               (push ?q lst) (push "<q>" lst)
4143               (push ?t lst) (push "<t>" lst)
4144               (push ?v lst) (push "<v>" lst)
4145               ;; Delegate the rest to `format-time-string':
4146               (while (<= i ?z)
4147                 (when (and (not (memq i lst))
4148                            ;; Skip (Z,a)
4149                            (or (<= i ?Z)
4150                                (>= i ?a)))
4151                   (push i lst)
4152                   (push (condition-case nil
4153                             (gmm-format-time-string (format "%%%c" i) time tz)
4154                           (error (format ">%c<" i)))
4155                         lst))
4156                 (setq i (1+ i)))
4157               (reverse lst)))
4158            (spec (apply 'format-spec-make flist)))
4159       (insert (format-spec message-citation-line-format spec)))
4160     (newline)))
4161
4162 (defun message-cite-original-without-signature ()
4163   "Cite function in the standard Message manner.
4164 This function strips off the signature from the original message."
4165   (message-cite-original-1 t))
4166
4167 (defun message-insert-citation-line ()
4168   "Insert a simple citation line."
4169   (when message-reply-headers
4170     (insert (mail-header-from message-reply-headers) " writes:")
4171     (newline)
4172     (newline)))
4173
4174 (defun message-position-on-field (header &rest afters)
4175   (let ((case-fold-search t))
4176     (save-restriction
4177       (narrow-to-region
4178        (goto-char (point-min))
4179        (progn
4180          (re-search-forward
4181           (concat "^" (regexp-quote mail-header-separator) "$"))
4182          (match-beginning 0)))
4183       (goto-char (point-min))
4184       (if (re-search-forward (concat "^" (regexp-quote header) ":") nil t)
4185           (progn
4186             (re-search-forward "^[^ \t]" nil 'move)
4187             (beginning-of-line)
4188             (skip-chars-backward "\n")
4189             t)
4190         (while (and afters
4191                     (not (re-search-forward
4192                           (concat "^" (regexp-quote (car afters)) ":")
4193                           nil t)))
4194           (pop afters))
4195         (when afters
4196           (re-search-forward "^[^ \t]" nil 'move)
4197           (beginning-of-line))
4198         (insert header ": \n")
4199         (forward-char -1)
4200         nil))))
4201
4202 \f
4203
4204 ;;;
4205 ;;; Sending messages
4206 ;;;
4207
4208 (defun message-send-and-exit (&optional arg)
4209   "Send message like `message-send', then, if no errors, exit from mail buffer.
4210 The usage of ARG is defined by the instance that called Message.
4211 It should typically alter the sending method in some way or other."
4212   (interactive "P")
4213   (let ((buf (current-buffer))
4214         (actions message-exit-actions))
4215     (when (and (message-send arg)
4216                (buffer-name buf))
4217       (message-bury buf)
4218       (if message-kill-buffer-on-exit
4219           (kill-buffer buf))
4220       (message-do-actions actions)
4221       t)))
4222
4223 (defun message-dont-send ()
4224   "Don't send the message you have been editing.
4225 Instead, just auto-save the buffer and then bury it."
4226   (interactive)
4227   (set-buffer-modified-p t)
4228   (save-buffer)
4229   (let ((actions message-postpone-actions))
4230     (message-bury (current-buffer))
4231     (message-do-actions actions)))
4232
4233 (defun message-kill-buffer ()
4234   "Kill the current buffer."
4235   (interactive)
4236   (when (or (not (buffer-modified-p))
4237             (not message-kill-buffer-query)
4238             (yes-or-no-p "Message modified; kill anyway? "))
4239     (let ((actions message-kill-actions)
4240           (draft-article message-draft-article)
4241           (auto-save-file-name buffer-auto-save-file-name)
4242           (file-name buffer-file-name)
4243           (modified (buffer-modified-p)))
4244       (setq buffer-file-name nil)
4245       (kill-buffer (current-buffer))
4246       (when (and (or (and auto-save-file-name
4247                           (file-exists-p auto-save-file-name))
4248                      (and file-name
4249                           (file-exists-p file-name)))
4250                  (progn
4251                    ;; If the message buffer has lived in a dedicated window,
4252                    ;; `kill-buffer' has killed the frame.  Thus the
4253                    ;; `yes-or-no-p' may show up in a lowered frame.  Make sure
4254                    ;; that the user can see the question by raising the
4255                    ;; current frame:
4256                    (raise-frame)
4257                    (yes-or-no-p (format "Remove the backup file%s? "
4258                                         (if modified " too" "")))))
4259         (ignore-errors
4260           (delete-file auto-save-file-name))
4261         (let ((message-draft-article draft-article))
4262           (message-disassociate-draft)))
4263       (message-do-actions actions))))
4264
4265 (defun message-bury (buffer)
4266   "Bury this mail BUFFER."
4267   ;; Note that this is not quite the same as (bury-buffer buffer),
4268   ;; since bury-buffer does extra stuff with a nil argument.
4269   ;; Eg http://lists.gnu.org/archive/html/emacs-devel/2014-01/msg00539.html
4270   (with-current-buffer buffer (bury-buffer))
4271   (if message-return-action
4272       (apply (car message-return-action) (cdr message-return-action))))
4273
4274 (defun message-send (&optional arg)
4275   "Send the message in the current buffer.
4276 If `message-interactive' is non-nil, wait for success indication or
4277 error messages, and inform user.
4278 Otherwise any failure is reported in a message back to the user from
4279 the mailer.
4280 The usage of ARG is defined by the instance that called Message.
4281 It should typically alter the sending method in some way or other."
4282   (interactive "P")
4283   ;; Make it possible to undo the coming changes.
4284   (undo-boundary)
4285   (let ((inhibit-read-only t))
4286     (put-text-property (point-min) (point-max) 'read-only nil))
4287   (message-fix-before-sending)
4288   (run-hooks 'message-send-hook)
4289   (when message-confirm-send
4290     (or (y-or-n-p "Send message? ")
4291         (keyboard-quit)))
4292   (message message-sending-message)
4293   (let ((alist message-send-method-alist)
4294         (success t)
4295         elem sent dont-barf-on-no-method
4296         (message-options message-options))
4297     (message-options-set-recipient)
4298     (while (and success
4299                 (setq elem (pop alist)))
4300       (when (funcall (cadr elem))
4301         (when (and (or (not (memq (car elem)
4302                                   message-sent-message-via))
4303                        (message-fetch-field "supersedes")
4304                        (if (or (message-gnksa-enable-p 'multiple-copies)
4305                                (not (eq (car elem) 'news)))
4306                            (y-or-n-p
4307                             (format
4308                              "Already sent message via %s; resend? "
4309                              (car elem)))
4310                          (error "Denied posting -- multiple copies")))
4311                    (setq success (funcall (caddr elem) arg)))
4312           (setq sent t))))
4313     (unless (or sent
4314                 (not success)
4315                 (let ((fcc (message-fetch-field "Fcc"))
4316                       (gcc (message-fetch-field "Gcc")))
4317                   (when (or fcc gcc)
4318                     (or (eq message-allow-no-recipients 'always)
4319                         (and (not (eq message-allow-no-recipients 'never))
4320                              (setq dont-barf-on-no-method
4321                                    (gnus-y-or-n-p
4322                                     (format "No receiver, perform %s anyway? "
4323                                             (cond ((and fcc gcc) "Fcc and Gcc")
4324                                                   (fcc "Fcc")
4325                                                   (t "Gcc"))))))))))
4326       (error "No methods specified to send by"))
4327     (when (or dont-barf-on-no-method
4328               (and success sent))
4329       (message-do-fcc)
4330       (save-excursion
4331         (run-hooks 'message-sent-hook))
4332       (message "Sending...done")
4333       ;; Do ecomplete address snarfing.
4334       (when (and (message-mail-alias-type-p 'ecomplete)
4335                  (not message-inhibit-ecomplete))
4336         (message-put-addresses-in-ecomplete))
4337       ;; Mark the buffer as unmodified and delete auto-save.
4338       (set-buffer-modified-p nil)
4339       (delete-auto-save-file-if-necessary t)
4340       (message-disassociate-draft)
4341       ;; Delete other mail buffers and stuff.
4342       (message-do-send-housekeeping)
4343       (message-do-actions message-send-actions)
4344       ;; Return success.
4345       t)))
4346
4347 (defun message-send-via-mail (arg)
4348   "Send the current message via mail."
4349   (message-send-mail arg))
4350
4351 (defun message-send-via-news (arg)
4352   "Send the current message via news."
4353   (funcall message-send-news-function arg))
4354
4355 (defmacro message-check (type &rest forms)
4356   "Eval FORMS if TYPE is to be checked."
4357   `(or (message-check-element ,type)
4358        (save-excursion
4359          ,@forms)))
4360
4361 (put 'message-check 'lisp-indent-function 1)
4362 (put 'message-check 'edebug-form-spec '(form body))
4363
4364 (defun message-text-with-property (prop &optional start end reverse)
4365   "Return a list of start and end positions where the text has PROP.
4366 START and END bound the search, they default to `point-min' and
4367 `point-max' respectively.  If REVERSE is non-nil, find text which does
4368 not have PROP."
4369   (unless start
4370     (setq start (point-min)))
4371   (unless end
4372     (setq end (point-max)))
4373   (let (next regions)
4374     (if reverse
4375         (while (and start
4376                     (setq start (text-property-any start end prop nil)))
4377           (setq next (next-single-property-change start prop nil end))
4378           (push (cons start (or next end)) regions)
4379           (setq start next))
4380       (while (and start
4381                   (or (get-text-property start prop)
4382                       (and (setq start (next-single-property-change
4383                                         start prop nil end))
4384                            (get-text-property start prop))))
4385         (setq next (text-property-any start end prop nil))
4386         (push (cons start (or next end)) regions)
4387         (setq start next)))
4388     (nreverse regions)))
4389
4390 (defcustom message-bogus-addresses
4391   '("noreply" "nospam" "invalid" "@@" "[^[:ascii:]].*@" "[ \t]")
4392   "List of regexps of potentially bogus mail addresses.
4393 See `message-check-recipients' how to setup checking.
4394
4395 This list should make it possible to catch typos or warn about
4396 spam-trap addresses.  It doesn't aim to verify strict RFC
4397 conformance."
4398   :version "23.1" ;; No Gnus
4399   :group 'message-headers
4400   :type '(choice
4401           (const :tag "None" nil)
4402           (list
4403            (set :inline t
4404                 (const "noreply")