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