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