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