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