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