cgit.sxemacs.org Git - gnus/blob - lisp/message.el

   1 ;;; message.el --- composing mail and news messages
   2
   3 ;; Copyright (C) 1996-2012 Free Software Foundation, Inc.
   4
   5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   6 ;; Keywords: mail, news
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software: you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation, either version 3 of the License, or
  13 ;; (at your option) any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  22
  23 ;;; Commentary:
  24
  25 ;; This mode provides mail-sending facilities from within Emacs.  It
  26 ;; consists mainly of large chunks of code from the sendmail.el,
  27 ;; gnus-msg.el and rnewspost.el files.
  28
  29 ;;; Code:
  30
  31 ;; For Emacs <22.2 and XEmacs.
  32 (eval-and-compile
  33   (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
  34 (eval-when-compile
  35   (require 'cl))
  36
  37 (require 'mailheader)
  38 (require 'gmm-utils)
  39 (require 'mail-utils)
  40 ;; Only for the trivial macros mail-header-from, mail-header-date
  41 ;; mail-header-references, mail-header-subject, mail-header-id
  42 (eval-when-compile (require 'nnheader))
  43 ;; This is apparently necessary even though things are autoloaded.
  44 ;; Because we dynamically bind mail-abbrev-mode-regexp, we'd better
  45 ;; require mailabbrev here.
  46 (if (featurep 'xemacs)
  47     (require 'mail-abbrevs)
  48   (require 'mailabbrev))
  49 (require 'mail-parse)
  50 (require 'mml)
  51 (require 'rfc822)
  52 (require 'format-spec)
  53
  54 (autoload 'mailclient-send-it "mailclient") ;; Emacs 22 or contrib/
  55
  56 (defvar gnus-message-group-art)
  57 (defvar gnus-list-identifiers) ; gnus-sum is required where necessary
  58 (defvar rmail-enable-mime-composing)
  59
  60 (defgroup message '((user-mail-address custom-variable)
  61                     (user-full-name custom-variable))
  62   "Mail and news message composing."
  63   :link '(custom-manual "(message)Top")
  64   :group 'mail
  65   :group 'news)
  66
  67 (put 'user-mail-address 'custom-type 'string)
  68 (put 'user-full-name 'custom-type 'string)
  69
  70 (defgroup message-various nil
  71   "Various Message Variables."
  72   :link '(custom-manual "(message)Various Message Variables")
  73   :group 'message)
  74
  75 (defgroup message-buffers nil
  76   "Message Buffers."
  77   :link '(custom-manual "(message)Message Buffers")
  78   :group 'message)
  79
  80 (defgroup message-sending nil
  81   "Message Sending."
  82   :link '(custom-manual "(message)Sending Variables")
  83   :group 'message)
  84
  85 (defgroup message-interface nil
  86   "Message Interface."
  87   :link '(custom-manual "(message)Interface")
  88   :group 'message)
  89
  90 (defgroup message-forwarding nil
  91   "Message Forwarding."
  92   :link '(custom-manual "(message)Forwarding")
  93   :group 'message-interface)
  94
  95 (defgroup message-insertion nil
  96   "Message Insertion."
  97   :link '(custom-manual "(message)Insertion")
  98   :group 'message)
  99
 100 (defgroup message-headers nil
 101   "Message Headers."
 102   :link '(custom-manual "(message)Message Headers")
 103   :group 'message)
 104
 105 (defgroup message-news nil
 106   "Composing News Messages."
 107   :group 'message)
 108
 109 (defgroup message-mail nil
 110   "Composing Mail Messages."
 111   :group 'message)
 112
 113 (defgroup message-faces nil
 114   "Faces used for message composing."
 115   :group 'message
 116   :group 'faces)
 117
 118 (defcustom message-directory "~/Mail/"
 119   "*Directory from which all other mail file variables are derived."
 120   :group 'message-various
 121   :type 'directory)
 122
 123 (defcustom message-max-buffers 10
 124   "*How many buffers to keep before starting to kill them off."
 125   :group 'message-buffers
 126   :type 'integer)
 127
 128 (defcustom message-send-rename-function nil
 129   "Function called to rename the buffer after sending it."
 130   :group 'message-buffers
 131   :type '(choice function (const nil)))
 132
 133 (defcustom message-fcc-handler-function 'message-output
 134   "*A function called to save outgoing articles.
 135 This function will be called with the name of the file to store the
 136 article in.  The default function is `message-output' which saves in Unix
 137 mailbox format."
 138   :type '(radio (function-item message-output)
 139                 (function :tag "Other"))
 140   :group 'message-sending)
 141
 142 (defcustom message-fcc-externalize-attachments nil
 143   "If non-nil, attachments are included as external parts in Fcc copies."
 144   :version "22.1"
 145   :type 'boolean
 146   :group 'message-sending)
 147
 148 (defcustom message-courtesy-message
 149   "The following message is a courtesy copy of an article\nthat has been posted to %s as well.\n\n"
 150   "*This is inserted at the start of a mailed copy of a posted message.
 151 If the string contains the format spec \"%s\", the Newsgroups
 152 the article has been posted to will be inserted there.
 153 If this variable is nil, no such courtesy message will be added."
 154   :group 'message-sending
 155   :type '(radio string (const nil)))
 156
 157 (defcustom message-ignored-bounced-headers
 158   "^\\(Received\\|Return-Path\\|Delivered-To\\):"
 159   "*Regexp that matches headers to be removed in resent bounced mail."
 160   :group 'message-interface
 161   :type 'regexp)
 162
 163 (defcustom message-from-style 'default
 164   ;; In Emacs 24.1 this defaults to the value of `mail-from-style'
 165   ;; that defaults to:
 166   ;; `angles' in Emacs 22.1~23.1, XEmacs 21.4, 21.5, and SXEmacs 22.1;
 167   ;; `system-default' in Emacs 23.2, and 24.1
 168   "Specifies how \"From\" headers look.
 169
 170 If nil, they contain just the return address like:
 171         king@grassland.com
 172 If `parens', they look like:
 173         king@grassland.com (Elvis Parsley)
 174 If `angles', they look like:
 175         Elvis Parsley <king@grassland.com>
 176
 177 Otherwise, most addresses look like `angles', but they look like
 178 `parens' if `angles' would need quoting and `parens' would not."
 179   :version "23.2"
 180   :type '(choice (const :tag "simple" nil)
 181                  (const parens)
 182                  (const angles)
 183                  (const default))
 184   :group 'message-headers)
 185
 186 (defcustom message-insert-canlock t
 187   "Whether to insert a Cancel-Lock header in news postings."
 188   :version "22.1"
 189   :group 'message-headers
 190   :type 'boolean)
 191
 192 (defcustom message-syntax-checks
 193   (if message-insert-canlock '((sender . disabled)) nil)
 194   ;; Guess this one shouldn't be easy to customize...
 195   "*Controls what syntax checks should not be performed on outgoing posts.
 196 To disable checking of long signatures, for instance, add
 197  `(signature . disabled)' to this list.
 198
 199 Don't touch this variable unless you really know what you're doing.
 200
 201 Checks include `approved', `bogus-recipient', `continuation-headers',
 202 `control-chars', `empty', `existing-newsgroups', `from', `illegible-text',
 203 `invisible-text', `long-header-lines', `long-lines', `message-id',
 204 `multiple-headers', `new-text', `newsgroups', `quoting-style',
 205 `repeated-newsgroups', `reply-to', `sender', `sendsys', `shoot',
 206 `shorten-followup-to', `signature', `size', `subject', `subject-cmsg'
 207 and `valid-newsgroups'."
 208   :group 'message-news
 209   :type '(repeat sexp))                 ; Fixme: improve this
 210
 211 (defcustom message-required-headers '((optional . References)
 212                                       From)
 213   "*Headers to be generated or prompted for when sending a message.
 214 Also see `message-required-news-headers' and
 215 `message-required-mail-headers'."
 216   :version "22.1"
 217   :group 'message-news
 218   :group 'message-headers
 219   :link '(custom-manual "(message)Message Headers")
 220   :type '(repeat sexp))
 221
 222 (defcustom message-draft-headers '(References From Date)
 223   "*Headers to be generated when saving a draft message."
 224   :version "22.1"
 225   :group 'message-news
 226   :group 'message-headers
 227   :link '(custom-manual "(message)Message Headers")
 228   :type '(repeat sexp))
 229
 230 (defcustom message-required-news-headers
 231   '(From Newsgroups Subject Date Message-ID
 232          (optional . Organization)
 233          (optional . User-Agent))
 234   "*Headers to be generated or prompted for when posting an article.
 235 RFC977 and RFC1036 require From, Date, Newsgroups, Subject,
 236 Message-ID.  Organization, Lines, In-Reply-To, Expires, and
 237 User-Agent are optional.  If you don't want message to insert some
 238 header, remove it from this list."
 239   :group 'message-news
 240   :group 'message-headers
 241   :link '(custom-manual "(message)Message Headers")
 242   :type '(repeat sexp))
 243
 244 (defcustom message-required-mail-headers
 245   '(From Subject Date (optional . In-Reply-To) Message-ID
 246          (optional . User-Agent))
 247   "*Headers to be generated or prompted for when mailing a message.
 248 It is recommended that From, Date, To, Subject and Message-ID be
 249 included.  Organization and User-Agent are optional."
 250   :group 'message-mail
 251   :group 'message-headers
 252   :link '(custom-manual "(message)Message Headers")
 253   :type '(repeat sexp))
 254
 255 (defcustom message-prune-recipient-rules nil
 256   "Rules for how to prune the list of recipients when doing wide replies.
 257 This is a list of regexps and regexp matches."
 258   :version "24.1"
 259   :group 'message-mail
 260   :group 'message-headers
 261   :link '(custom-manual "(message)Wide Reply")
 262   :type '(repeat regexp))
 263
 264 (defcustom message-deletable-headers '(Message-ID Date Lines)
 265   "Headers to be deleted if they already exist and were generated by message previously."
 266   :group 'message-headers
 267   :link '(custom-manual "(message)Message Headers")
 268   :type 'sexp)
 269
 270 (defcustom message-ignored-news-headers
 271   "^NNTP-Posting-Host:\\|^Xref:\\|^[BGF]cc:\\|^Resent-Fcc:\\|^X-Draft-From:\\|^X-Gnus-Agent-Meta-Information:"
 272   "*Regexp of headers to be removed unconditionally before posting."
 273   :group 'message-news
 274   :group 'message-headers
 275   :link '(custom-manual "(message)Message Headers")
 276   :type '(repeat :value-to-internal (lambda (widget value)
 277                                       (custom-split-regexp-maybe value))
 278                  :match (lambda (widget value)
 279                           (or (stringp value)
 280                               (widget-editable-list-match widget value)))
 281                  regexp))
 282
 283 (defcustom message-ignored-mail-headers
 284   "^\\([GF]cc\\|Resent-Fcc\\|Xref\\|X-Draft-From\\|X-Gnus-Agent-Meta-Information\\):"
 285   "*Regexp of headers to be removed unconditionally before mailing."
 286   :group 'message-mail
 287   :group 'message-headers
 288   :link '(custom-manual "(message)Mail Headers")
 289   :type 'regexp)
 290
 291 (defcustom message-ignored-supersedes-headers "^Path:\\|^Date\\|^NNTP-Posting-Host:\\|^Xref:\\|^Lines:\\|^Received:\\|^X-From-Line:\\|^X-Trace:\\|^X-ID:\\|^X-Complaints-To:\\|Return-Path:\\|^Supersedes:\\|^NNTP-Posting-Date:\\|^X-Trace:\\|^X-Complaints-To:\\|^Cancel-Lock:\\|^Cancel-Key:\\|^X-Hashcash:\\|^X-Payment:\\|^Approved:\\|^Injection-Date:\\|^Injection-Info:"
 292   "*Header lines matching this regexp will be deleted before posting.
 293 It's best to delete old Path and Date headers before posting to avoid
 294 any confusion."
 295   :group 'message-interface
 296   :link '(custom-manual "(message)Superseding")
 297   :type '(repeat :value-to-internal (lambda (widget value)
 298                                       (custom-split-regexp-maybe value))
 299                  :match (lambda (widget value)
 300                           (or (stringp value)
 301                               (widget-editable-list-match widget value)))
 302                  regexp))
 303
 304 (defcustom message-subject-re-regexp
 305   "^[ \t]*\\([Rr][Ee]\\(\\[[0-9]*\\]\\)*:[ \t]*\\)*[ \t]*"
 306   "*Regexp matching \"Re: \" in the subject line."
 307   :group 'message-various
 308   :link '(custom-manual "(message)Message Headers")
 309   :type 'regexp)
 310
 311 ;;; Start of variables adopted from `message-utils.el'.
 312
 313 (defcustom message-subject-trailing-was-query t
 314   "*What to do with trailing \"(was: <old subject>)\" in subject lines.
 315 If nil, leave the subject unchanged.  If it is the symbol `ask', query
 316 the user what do do.  In this case, the subject is matched against
 317 `message-subject-trailing-was-ask-regexp'.  If
 318 `message-subject-trailing-was-query' is t, always strip the trailing
 319 old subject.  In this case, `message-subject-trailing-was-regexp' is
 320 used."
 321   :version "24.1"
 322   :type '(choice (const :tag "never" nil)
 323                  (const :tag "always strip" t)
 324                  (const ask))
 325   :link '(custom-manual "(message)Message Headers")
 326   :group 'message-various)
 327
 328 (defcustom message-subject-trailing-was-ask-regexp
 329   "[ \t]*\\([[(]+[Ww][Aa][Ss]:?[ \t]*.*[])]+\\)"
 330   "*Regexp matching \"(was: <old subject>)\" in the subject line.
 331
 332 The function `message-strip-subject-trailing-was' uses this regexp if
 333 `message-subject-trailing-was-query' is set to the symbol `ask'.  If
 334 the variable is t instead of `ask', use
 335 `message-subject-trailing-was-regexp' instead.
 336
 337 It is okay to create some false positives here, as the user is asked."
 338   :version "22.1"
 339   :group 'message-various
 340   :link '(custom-manual "(message)Message Headers")
 341   :type 'regexp)
 342
 343 (defcustom message-subject-trailing-was-regexp
 344   "[ \t]*\\((*[Ww][Aa][Ss]:[ \t]*.*)\\)"
 345   "*Regexp matching \"(was: <old subject>)\" in the subject line.
 346
 347 If `message-subject-trailing-was-query' is set to t, the subject is
 348 matched against `message-subject-trailing-was-regexp' in
 349 `message-strip-subject-trailing-was'.  You should use a regexp creating very
 350 few false positives here."
 351   :version "22.1"
 352   :group 'message-various
 353   :link '(custom-manual "(message)Message Headers")
 354   :type 'regexp)
 355
 356 ;;; marking inserted text
 357
 358 (defcustom message-mark-insert-begin
 359   "--8<---------------cut here---------------start------------->8---\n"
 360   "How to mark the beginning of some inserted text."
 361   :version "22.1"
 362   :type 'string
 363   :link '(custom-manual "(message)Insertion Variables")
 364   :group 'message-various)
 365
 366 (defcustom message-mark-insert-end
 367   "--8<---------------cut here---------------end--------------->8---\n"
 368   "How to mark the end of some inserted text."
 369   :version "22.1"
 370   :type 'string
 371   :link '(custom-manual "(message)Insertion Variables")
 372   :group 'message-various)
 373
 374 (defcustom message-archive-header "X-No-Archive: Yes\n"
 375   "Header to insert when you don't want your article to be archived.
 376 Archives \(such as groups.google.com\) respect this header."
 377   :version "22.1"
 378   :type 'string
 379   :link '(custom-manual "(message)Header Commands")
 380   :group 'message-various)
 381
 382 (defcustom message-archive-note
 383   "X-No-Archive: Yes - save http://groups.google.com/"
 384   "Note to insert why you wouldn't want this posting archived.
 385 If nil, don't insert any text in the body."
 386   :version "22.1"
 387   :type '(radio string (const nil))
 388   :link '(custom-manual "(message)Header Commands")
 389   :group 'message-various)
 390
 391 ;;; Crossposts and Followups
 392 ;; inspired by JoH-followup-to by Jochem Huhman <joh  at gmx.de>
 393 ;; new suggestions by R. Weikusat <rw at another.de>
 394
 395 (defvar message-cross-post-old-target nil
 396   "Old target for cross-posts or follow-ups.")
 397 (make-variable-buffer-local 'message-cross-post-old-target)
 398
 399 (defcustom message-cross-post-default t
 400   "When non-nil `message-cross-post-followup-to' will perform a crosspost.
 401 If nil, `message-cross-post-followup-to' will only do a followup.  Note that
 402 you can explicitly override this setting by calling
 403 `message-cross-post-followup-to' with a prefix."
 404   :version "22.1"
 405   :type 'boolean
 406   :group 'message-various)
 407
 408 (defcustom message-cross-post-note "Crosspost & Followup-To: "
 409   "Note to insert before signature to notify of cross-post and follow-up."
 410   :version "22.1"
 411   :type 'string
 412   :group 'message-various)
 413
 414 (defcustom message-followup-to-note "Followup-To: "
 415   "Note to insert before signature to notify of follow-up only."
 416   :version "22.1"
 417   :type 'string
 418   :group 'message-various)
 419
 420 (defcustom message-cross-post-note-function 'message-cross-post-insert-note
 421   "Function to use to insert note about Crosspost or Followup-To.
 422 The function will be called with four arguments.  The function should not only
 423 insert a note, but also ensure old notes are deleted.  See the documentation
 424 for `message-cross-post-insert-note'."
 425   :version "22.1"
 426   :type 'function
 427   :group 'message-various)
 428
 429 ;;; End of variables adopted from `message-utils.el'.
 430
 431 (defcustom message-signature-separator "^-- $"
 432   "Regexp matching the signature separator.
 433 This variable is used to strip off the signature from quoted text
 434 when `message-cite-function' is
 435 `message-cite-original-without-signature'.  Most useful values
 436 are \"^-- $\" (strict) and \"^-- *$\" (loose; allow missing
 437 whitespace)."
 438   :type '(choice (const :tag "strict" "^-- $")
 439                  (const :tag "loose" "^-- *$")
 440                  regexp)
 441   :version "22.3" ;; Gnus 5.10.12 (changed default)
 442   :link '(custom-manual "(message)Various Message Variables")
 443   :group 'message-various)
 444
 445 (defcustom message-elide-ellipsis "\n[...]\n\n"
 446   "*The string which is inserted for elided text.
 447 This is a format-spec string, and you can use %l to say how many
 448 lines were removed, and %c to say how many characters were
 449 removed."
 450   :type 'string
 451   :link '(custom-manual "(message)Various Commands")
 452   :group 'message-various)
 453
 454 (defcustom message-interactive t
 455   ;; In Emacs 24.1 this defaults to the value of `mail-interactive'
 456   ;; that defaults to:
 457   ;; `nil' in Emacs 22.1~22.3, XEmacs 21.4, 21.5, and SXEmacs 22.1;
 458   ;; `t' in Emacs 23.1~24.1
 459   "Non-nil means when sending a message wait for and display errors.
 460 A value of nil means let mailer mail back a message to report errors."
 461   :version "23.2"
 462   :group 'message-sending
 463   :group 'message-mail
 464   :link '(custom-manual "(message)Sending Variables")
 465   :type 'boolean)
 466
 467 (defcustom message-confirm-send nil
 468   "When non-nil, ask for confirmation when sending a message."
 469   :group 'message-sending
 470   :group 'message-mail
 471   :version "23.1" ;; No Gnus
 472   :link '(custom-manual "(message)Sending Variables")
 473   :type 'boolean)
 474
 475 (defcustom message-generate-new-buffers 'unsent
 476   "*Say whether to create a new message buffer to compose a message.
 477 Valid values include:
 478
 479 nil
 480   Generate the buffer name in the Message way (e.g., *mail*, *news*,
 481   *mail to whom*, *news on group*, etc.) and continue editing in the
 482   existing buffer of that name.  If there is no such buffer, it will
 483   be newly created.
 484
 485 `unique' or t
 486   Create the new buffer with the name generated in the Message way.
 487
 488 `unsent'
 489   Similar to `unique' but the buffer name begins with \"*unsent \".
 490
 491 `standard'
 492   Similar to nil but the buffer name is simpler like *mail message*.
 493
 494 function
 495   If this is a function, call that function with three parameters:
 496   The type, the To address and the group name (any of these may be nil).
 497   The function should return the new buffer name."
 498   :version "24.1"
 499   :group 'message-buffers
 500   :link '(custom-manual "(message)Message Buffers")
 501   :type '(choice (const nil)
 502                  (sexp :tag "unique" :format "unique\n" :value unique
 503                        :match (lambda (widget value) (memq value '(unique t))))
 504                  (const unsent)
 505                  (const standard)
 506                  (function :format "\n    %{%t%}: %v")))
 507
 508 (defcustom message-kill-buffer-on-exit nil
 509   "*Non-nil means that the message buffer will be killed after sending a message."
 510   :group 'message-buffers
 511   :link '(custom-manual "(message)Message Buffers")
 512   :type 'boolean)
 513
 514 (defcustom message-kill-buffer-query t
 515   "*Non-nil means that killing a modified message buffer has to be confirmed.
 516 This is used by `message-kill-buffer'."
 517   :version "23.1" ;; No Gnus
 518   :group 'message-buffers
 519   :type 'boolean)
 520
 521 (defcustom message-user-organization
 522   (or (getenv "ORGANIZATION") t)
 523   "String to be used as an Organization header.
 524 If t, use `message-user-organization-file'."
 525   :group 'message-headers
 526   :type '(choice string
 527                  (const :tag "consult file" t)))
 528
 529 (defcustom message-user-organization-file
 530   (let (orgfile)
 531     (dolist (f (list "/etc/organization"
 532                      "/etc/news/organization"
 533                      "/usr/lib/news/organization"))
 534       (when (file-readable-p f)
 535         (setq orgfile f)))
 536     orgfile)
 537   "*Local news organization file."
 538   :type 'file
 539   :link '(custom-manual "(message)News Headers")
 540   :group 'message-headers)
 541
 542 (defcustom message-make-forward-subject-function
 543   #'message-forward-subject-name-subject
 544   "*List of functions called to generate subject headers for forwarded messages.
 545 The subject generated by the previous function is passed into each
 546 successive function.
 547
 548 The provided functions are:
 549
 550 * `message-forward-subject-author-subject' Source of article (author or
 551       newsgroup), in brackets followed by the subject
 552 * `message-forward-subject-name-subject' Source of article (name of author
 553       or newsgroup), in brackets followed by the subject
 554 * `message-forward-subject-fwd' Subject of article with 'Fwd:' prepended
 555       to it."
 556   :group 'message-forwarding
 557   :link '(custom-manual "(message)Forwarding")
 558   :type '(radio (function-item message-forward-subject-author-subject)
 559                 (function-item message-forward-subject-fwd)
 560                 (function-item message-forward-subject-name-subject)
 561                 (repeat :tag "List of functions" function)))
 562
 563 (defcustom message-forward-as-mime t
 564   "*Non-nil means forward messages as an inline/rfc822 MIME section.
 565 Otherwise, directly inline the old message in the forwarded message."
 566   :version "21.1"
 567   :group 'message-forwarding
 568   :link '(custom-manual "(message)Forwarding")
 569   :type 'boolean)
 570
 571 (defcustom message-forward-show-mml 'best
 572   "*Non-nil means show forwarded messages as MML (decoded from MIME).
 573 Otherwise, forwarded messages are unchanged.
 574 Can also be the symbol `best' to indicate that MML should be
 575 used, except when it is a bad idea to use MML.  One example where
 576 it is a bad idea is when forwarding a signed or encrypted
 577 message, because converting MIME to MML would invalidate the
 578 digital signature."
 579   :version "21.1"
 580   :group 'message-forwarding
 581   :type '(choice (const :tag "use MML" t)
 582                  (const :tag "don't use MML " nil)
 583                  (const :tag "use MML when appropriate" best)))
 584
 585 (defcustom message-forward-before-signature t
 586   "*Non-nil means put forwarded message before signature, else after."
 587   :group 'message-forwarding
 588   :type 'boolean)
 589
 590 (defcustom message-wash-forwarded-subjects nil
 591   "*Non-nil means try to remove as much cruft as possible from the subject.
 592 Done before generating the new subject of a forward."
 593   :group 'message-forwarding
 594   :link '(custom-manual "(message)Forwarding")
 595   :type 'boolean)
 596
 597 (defcustom message-ignored-resent-headers
 598   ;; `Delivered-To' needs to be removed because some mailers use it to
 599   ;; detect loops, so if you resend a message to an address that ultimately
 600   ;; comes back to you (e.g. a mailing-list to which you subscribe, in which
 601   ;; case you may be removed from the list on the grounds that mail to you
 602   ;; bounced with a "mailing loop" error).
 603   "^Return-receipt\\|^X-Gnus\\|^Gnus-Warning:\\|^>?From \\|^Delivered-To:"
 604   "*All headers that match this regexp will be deleted when resending a message."
 605   :group 'message-interface
 606   :link '(custom-manual "(message)Resending")
 607   :type '(repeat :value-to-internal (lambda (widget value)
 608                                       (custom-split-regexp-maybe value))
 609                  :match (lambda (widget value)
 610                           (or (stringp value)
 611                               (widget-editable-list-match widget value)))
 612                  regexp))
 613
 614 (defcustom message-forward-ignored-headers "^Content-Transfer-Encoding:\\|^X-Gnus"
 615   "*All headers that match this regexp will be deleted when forwarding a message."
 616   :version "21.1"
 617   :group 'message-forwarding
 618   :type '(repeat :value-to-internal (lambda (widget value)
 619                                       (custom-split-regexp-maybe value))
 620                  :match (lambda (widget value)
 621                           (or (stringp value)
 622                               (widget-editable-list-match widget value)))
 623                  regexp))
 624
 625 (defcustom message-ignored-cited-headers "."
 626   "*Delete these headers from the messages you yank."
 627   :group 'message-insertion
 628   :link '(custom-manual "(message)Insertion Variables")
 629   :type 'regexp)
 630
 631 (defcustom message-cite-prefix-regexp
 632   ;; In Emacs 24.1 this defaults to the value of
 633   ;; `mail-citation-prefix-regexp'; the default value varies according
 634   ;; to the Emacs version.  In XEmacs 21.4 and 21.5, sendmail.el
 635   ;; provides it.
 636   (if (string-match "[[:digit:]]" "1")
 637       ;; Support POSIX?  XEmacs 21.5.27 doesn't.
 638       "\\([ \t]*[_.[:word:]]+>+\\|[ \t]*[]>|]\\)+"
 639     ;; ?-, ?_ or ?. MUST NOT be in syntax entry w.
 640     (let (non-word-constituents)
 641       (with-syntax-table text-mode-syntax-table
 642         (setq non-word-constituents
 643               (concat
 644                (if (string-match "\\w" "_")  "" "_")
 645                (if (string-match "\\w" ".")  "" "."))))
 646       (if (equal non-word-constituents "")
 647           "\\([ \t]*\\(\\w\\)+>+\\|[ \t]*[]>|]\\)+"
 648         (concat "\\([ \t]*\\(\\w\\|["
 649                 non-word-constituents
 650                 "]\\)+>+\\|[ \t]*[]>|]\\)+"))))
 651   "*Regexp matching the longest possible citation prefix on a line."
 652   :version "24.1"
 653   :group 'message-insertion
 654   :link '(custom-manual "(message)Insertion Variables")
 655   :type 'regexp
 656   :set (lambda (symbol value)
 657          (prog1
 658              (custom-set-default symbol value)
 659            (if (boundp 'gnus-message-cite-prefix-regexp)
 660                (setq gnus-message-cite-prefix-regexp
 661                      (concat "^\\(?:" value "\\)"))))))
 662
 663 (defcustom message-cancel-message "I am canceling my own article.\n"
 664   "Message to be inserted in the cancel message."
 665   :group 'message-interface
 666   :link '(custom-manual "(message)Canceling News")
 667   :type 'string)
 668
 669 (defun message-send-mail-function ()
 670   "Return suitable value for the variable `message-send-mail-function'."
 671   (cond ((and (require 'sendmail)
 672               (boundp 'sendmail-program)
 673               sendmail-program
 674               (executable-find sendmail-program))
 675          'message-send-mail-with-sendmail)
 676         ((and (locate-library "smtpmail")
 677               (boundp 'smtpmail-default-smtp-server)
 678               smtpmail-default-smtp-server)
 679          'message-smtpmail-send-it)
 680         ((locate-library "mailclient")
 681          'message-send-mail-with-mailclient)
 682         (t
 683          (error "Don't know how to send mail.  Please customize `message-send-mail-function'"))))
 684
 685 ;; Useful to set in site-init.el
 686 (defcustom message-send-mail-function
 687   (cond ((eq send-mail-function 'smtpmail-send-it) 'message-smtpmail-send-it)
 688         ((eq send-mail-function 'feedmail-send-it) 'feedmail-send-it)
 689         ((eq send-mail-function 'sendmail-query-once) 'sendmail-query-once)
 690         ((eq send-mail-function 'mailclient-send-it)
 691          'message-send-mail-with-mailclient)
 692         (t (message-send-mail-function)))
 693   "Function to call to send the current buffer as mail.
 694 The headers should be delimited by a line whose contents match the
 695 variable `mail-header-separator'.
 696
 697 Valid values include `message-send-mail-with-sendmail'
 698 `message-send-mail-with-mh', `message-send-mail-with-qmail',
 699 `message-smtpmail-send-it', `smtpmail-send-it',
 700 `feedmail-send-it' and `message-send-mail-with-mailclient'.  The
 701 default is system dependent and determined by the function
 702 `message-send-mail-function'.
 703
 704 See also `send-mail-function'."
 705   :type '(radio (function-item message-send-mail-with-sendmail)
 706                 (function-item message-send-mail-with-mh)
 707                 (function-item message-send-mail-with-qmail)
 708                 (function-item message-smtpmail-send-it)
 709                 (function-item smtpmail-send-it)
 710                 (function-item feedmail-send-it)
 711                 (function-item message-send-mail-with-mailclient
 712                                :tag "Use Mailclient package")
 713                 (function :tag "Other"))
 714   :group 'message-sending
 715   :version "23.2"
 716   :initialize 'custom-initialize-default
 717   :link '(custom-manual "(message)Mail Variables")
 718   :group 'message-mail)
 719
 720 (defcustom message-send-news-function 'message-send-news
 721   "Function to call to send the current buffer as news.
 722 The headers should be delimited by a line whose contents match the
 723 variable `mail-header-separator'."
 724   :group 'message-sending
 725   :group 'message-news
 726   :link '(custom-manual "(message)News Variables")
 727   :type 'function)
 728
 729 (defcustom message-reply-to-function nil
 730   "If non-nil, function that should return a list of headers.
 731 This function should pick out addresses from the To, Cc, and From headers
 732 and respond with new To and Cc headers."
 733   :group 'message-interface
 734   :link '(custom-manual "(message)Reply")
 735   :type '(choice function (const nil)))
 736
 737 (defcustom message-wide-reply-to-function nil
 738   "If non-nil, function that should return a list of headers.
 739 This function should pick out addresses from the To, Cc, and From headers
 740 and respond with new To and Cc headers."
 741   :group 'message-interface
 742   :link '(custom-manual "(message)Wide Reply")
 743   :type '(choice function (const nil)))
 744
 745 (defcustom message-followup-to-function nil
 746   "If non-nil, function that should return a list of headers.
 747 This function should pick out addresses from the To, Cc, and From headers
 748 and respond with new To and Cc headers."
 749   :group 'message-interface
 750   :link '(custom-manual "(message)Followup")
 751   :type '(choice function (const nil)))
 752
 753 (defcustom message-extra-wide-headers nil
 754   "If non-nil, a list of additional address headers.
 755 These are used when composing a wide reply."
 756   :group 'message-sending
 757   :type '(repeat string))
 758
 759 (defcustom message-use-followup-to 'ask
 760   "*Specifies what to do with Followup-To header.
 761 If nil, always ignore the header.  If it is t, use its value, but
 762 query before using the \"poster\" value.  If it is the symbol `ask',
 763 always query the user whether to use the value.  If it is the symbol
 764 `use', always use the value."
 765   :group 'message-interface
 766   :link '(custom-manual "(message)Followup")
 767   :type '(choice (const :tag "ignore" nil)
 768                  (const :tag "use & query" t)
 769                  (const use)
 770                  (const ask)))
 771
 772 (defcustom message-use-mail-followup-to 'use
 773   "*Specifies what to do with Mail-Followup-To header.
 774 If nil, always ignore the header.  If it is the symbol `ask', always
 775 query the user whether to use the value.  If it is the symbol `use',
 776 always use the value."
 777   :version "22.1"
 778   :group 'message-interface
 779   :link '(custom-manual "(message)Mailing Lists")
 780   :type '(choice (const :tag "ignore" nil)
 781                  (const use)
 782                  (const ask)))
 783
 784 (defcustom message-subscribed-address-functions nil
 785   "*Specifies functions for determining list subscription.
 786 If nil, do not attempt to determine list subscription with functions.
 787 If non-nil, this variable contains a list of functions which return
 788 regular expressions to match lists.  These functions can be used in
 789 conjunction with `message-subscribed-regexps' and
 790 `message-subscribed-addresses'."
 791   :version "22.1"
 792   :group 'message-interface
 793   :link '(custom-manual "(message)Mailing Lists")
 794   :type '(repeat sexp))
 795
 796 (defcustom message-subscribed-address-file nil
 797   "*A file containing addresses the user is subscribed to.
 798 If nil, do not look at any files to determine list subscriptions.  If
 799 non-nil, each line of this file should be a mailing list address."
 800   :version "22.1"
 801   :group 'message-interface
 802   :link '(custom-manual "(message)Mailing Lists")
 803   :type '(radio file (const nil)))
 804
 805 (defcustom message-subscribed-addresses nil
 806   "*Specifies a list of addresses the user is subscribed to.
 807 If nil, do not use any predefined list subscriptions.  This list of
 808 addresses can be used in conjunction with
 809 `message-subscribed-address-functions' and `message-subscribed-regexps'."
 810   :version "22.1"
 811   :group 'message-interface
 812   :link '(custom-manual "(message)Mailing Lists")
 813   :type '(repeat string))
 814
 815 (defcustom message-subscribed-regexps nil
 816   "*Specifies a list of addresses the user is subscribed to.
 817 If nil, do not use any predefined list subscriptions.  This list of
 818 regular expressions can be used in conjunction with
 819 `message-subscribed-address-functions' and `message-subscribed-addresses'."
 820   :version "22.1"
 821   :group 'message-interface
 822   :link '(custom-manual "(message)Mailing Lists")
 823   :type '(repeat regexp))
 824
 825 (defcustom message-allow-no-recipients 'ask
 826   "Specifies what to do when there are no recipients other than Gcc/Fcc.
 827 If it is the symbol `always', the posting is allowed.  If it is the
 828 symbol `never', the posting is not allowed.  If it is the symbol
 829 `ask', you are prompted."
 830   :version "22.1"
 831   :group 'message-interface
 832   :link '(custom-manual "(message)Message Headers")
 833   :type '(choice (const always)
 834                  (const never)
 835                  (const ask)))
 836
 837 (defcustom message-sendmail-f-is-evil nil
 838   "*Non-nil means don't add \"-f username\" to the sendmail command line.
 839 Doing so would be even more evil than leaving it out."
 840   :group 'message-sending
 841   :link '(custom-manual "(message)Mail Variables")
 842   :type 'boolean)
 843
 844 (defcustom message-sendmail-envelope-from nil
 845   ;; In Emacs 24.1 this defaults to the value of `mail-envelope-from'
 846   ;; if it is available, or defaults to nil.  sendmail.el provides it;
 847   ;; the default value is nil in all (X)Emacsen that Gnus supports.
 848   "*Envelope-from when sending mail with sendmail.
 849 If this is nil, use `user-mail-address'.  If it is the symbol
 850 `header', use the From: header of the message."
 851   :version "23.2"
 852   :type '(choice (string :tag "From name")
 853                  (const :tag "Use From: header from message" header)
 854                  (const :tag "Use `user-mail-address'" nil))
 855   :link '(custom-manual "(message)Mail Variables")
 856   :group 'message-sending)
 857
 858 (defcustom message-sendmail-extra-arguments nil
 859   "Additional arguments to `sendmail-program'."
 860   ;; E.g. '("-a" "account") for msmtp
 861   :version "23.1" ;; No Gnus
 862   :type '(repeat string)
 863   ;; :link '(custom-manual "(message)Mail Variables")
 864   :group 'message-sending)
 865
 866 ;; qmail-related stuff
 867 (defcustom message-qmail-inject-program "/var/qmail/bin/qmail-inject"
 868   "Location of the qmail-inject program."
 869   :group 'message-sending
 870   :link '(custom-manual "(message)Mail Variables")
 871   :type 'file)
 872
 873 (defcustom message-qmail-inject-args nil
 874   "Arguments passed to qmail-inject programs.
 875 This should be a list of strings, one string for each argument.
 876 It may also be a function.
 877
 878 For e.g., if you wish to set the envelope sender address so that bounces
 879 go to the right place or to deal with listserv's usage of that address, you
 880 might set this variable to '(\"-f\" \"you@some.where\")."
 881   :group 'message-sending
 882   :link '(custom-manual "(message)Mail Variables")
 883   :type '(choice (function)
 884                  (repeat string)))
 885
 886 (defvar gnus-post-method)
 887 (defvar gnus-select-method)
 888 (defcustom message-post-method
 889   (cond ((and (boundp 'gnus-post-method)
 890               (listp gnus-post-method)
 891               gnus-post-method)
 892          gnus-post-method)
 893         ((boundp 'gnus-select-method)
 894          gnus-select-method)
 895         (t '(nnspool "")))
 896   "*Method used to post news.
 897 Note that when posting from inside Gnus, for instance, this
 898 variable isn't used."
 899   :group 'message-news
 900   :group 'message-sending
 901   ;; This should be the `gnus-select-method' widget, but that might
 902   ;; create a dependence to `gnus.el'.
 903   :type 'sexp)
 904
 905 (defcustom message-generate-headers-first nil
 906   "Which headers should be generated before starting to compose a message.
 907 If t, generate all required headers.  This can also be a list of headers to
 908 generate.  The variables `message-required-news-headers' and
 909 `message-required-mail-headers' specify which headers to generate.
 910
 911 Note that the variable `message-deletable-headers' specifies headers which
 912 are to be deleted and then re-generated before sending, so this variable
 913 will not have a visible effect for those headers."
 914   :group 'message-headers
 915   :link '(custom-manual "(message)Message Headers")
 916   :type '(choice (const :tag "None" nil)
 917                  (const :tag "All" t)
 918                  (repeat (sexp :tag "Header"))))
 919
 920 (defcustom message-fill-column 72
 921   "Column beyond which automatic line-wrapping should happen.
 922 Local value for message buffers.  If non-nil, also turn on
 923 auto-fill in message buffers."
 924   :group 'message-various
 925   ;; :link '(custom-manual "(message)Message Headers")
 926   :type '(choice (const :tag "Don't turn on auto fill" nil)
 927                  (integer)))
 928
 929 (defcustom message-setup-hook nil
 930   "Normal hook, run each time a new outgoing message is initialized.
 931 The function `message-setup' runs this hook."
 932   :group 'message-various
 933   :link '(custom-manual "(message)Various Message Variables")
 934   :type 'hook)
 935
 936 (defcustom message-cancel-hook nil
 937   "Hook run when canceling articles."
 938   :group 'message-various
 939   :link '(custom-manual "(message)Various Message Variables")
 940   :type 'hook)
 941
 942 (defcustom message-signature-setup-hook nil
 943   "Normal hook, run each time a new outgoing message is initialized.
 944 It is run after the headers have been inserted and before
 945 the signature is inserted."
 946   :group 'message-various
 947   :link '(custom-manual "(message)Various Message Variables")
 948   :type 'hook)
 949
 950 (defcustom message-mode-hook nil
 951   "Hook run in message mode buffers."
 952   :group 'message-various
 953   :type 'hook)
 954
 955 (defcustom message-header-hook nil
 956   "Hook run in a message mode buffer narrowed to the headers."
 957   :group 'message-various
 958   :type 'hook)
 959
 960 (defcustom message-header-setup-hook nil
 961   "Hook called narrowed to the headers when setting up a message buffer."
 962   :group 'message-various
 963   :link '(custom-manual "(message)Various Message Variables")
 964   :type 'hook)
 965
 966 (defcustom message-minibuffer-local-map
 967   (let ((map (make-sparse-keymap 'message-minibuffer-local-map)))
 968     (set-keymap-parent map minibuffer-local-map)
 969     map)
 970   "Keymap for `message-read-from-minibuffer'."
 971   :version "22.1"
 972   :group 'message-various)
 973
 974 (defcustom message-citation-line-function 'message-insert-citation-line
 975   "*Function called to insert the \"Whomever writes:\" line.
 976
 977 Predefined functions include `message-insert-citation-line' and
 978 `message-insert-formatted-citation-line' (see the variable
 979 `message-citation-line-format').
 980
 981 Note that Gnus provides a feature where the reader can click on
 982 `writes:' to hide the cited text.  If you change this line too much,
 983 people who read your message will have to change their Gnus
 984 configuration.  See the variable `gnus-cite-attribution-suffix'."
 985   :type '(choice
 986           (function-item :tag "plain" message-insert-citation-line)
 987           (function-item :tag "formatted" message-insert-formatted-citation-line)
 988           (function :tag "Other"))
 989   :link '(custom-manual "(message)Insertion Variables")
 990   :group 'message-insertion)
 991
 992 (defcustom message-citation-line-format "On %a, %b %d %Y, %N wrote:\n"
 993   "Format of the \"Whomever writes:\" line.
 994
 995 The string is formatted using `format-spec'.  The following
 996 constructs are replaced:
 997
 998   %f   The full From, e.g. \"John Doe <john.doe@example.invalid>\".
 999   %n   The mail address, e.g. \"john.doe@example.invalid\".
1000   %N   The real name if present, e.g.: \"John Doe\", else fall
1001        back to the mail address.
1002   %F   The first name if present, e.g.: \"John\".
1003   %L   The last name if present, e.g.: \"Doe\".
1004
1005 All other format specifiers are passed to `format-time-string'
1006 which is called using the date from the article your replying to.
1007 Extracting the first (%F) and last name (%L) is done
1008 heuristically, so you should always check it yourself.
1009
1010 Please also read the note in the documentation of
1011 `message-citation-line-function'."
1012   :type '(choice (const :tag "Plain" "%f writes:")
1013                  (const :tag "Include date" "On %a, %b %d %Y, %n wrote:")
1014                  string)
1015   :link '(custom-manual "(message)Insertion Variables")
1016   :version "23.1" ;; No Gnus
1017   :group 'message-insertion)
1018
1019 (defcustom message-yank-prefix "> "
1020   ;; In Emacs 24.1 this defaults to the value of `mail-yank-prefix'
1021   ;; that defaults to:
1022   ;; `nil' in Emacs 22.1~23.1;
1023   ;; "> " in Emacs 23.2, 24.1, XEmacs 21.4, 21.5, and SXEmacs 22.1
1024   "*Prefix inserted on the lines of yanked messages.
1025 Fix `message-cite-prefix-regexp' if it is set to an abnormal value.
1026 See also `message-yank-cited-prefix' and `message-yank-empty-prefix'."
1027   :version "23.2"
1028   :type 'string
1029   :link '(custom-manual "(message)Insertion Variables")
1030   :group 'message-insertion)
1031
1032 (defcustom message-yank-cited-prefix ">"
1033   "*Prefix inserted on cited lines of yanked messages.
1034 Fix `message-cite-prefix-regexp' if it is set to an abnormal value.
1035 See also `message-yank-prefix' and `message-yank-empty-prefix'."
1036   :version "22.1"
1037   :type 'string
1038   :link '(custom-manual "(message)Insertion Variables")
1039   :group 'message-insertion)
1040
1041 (defcustom message-yank-empty-prefix ">"
1042   "*Prefix inserted on empty lines of yanked messages.
1043 See also `message-yank-prefix' and `message-yank-cited-prefix'."
1044   :version "22.1"
1045   :type 'string
1046   :link '(custom-manual "(message)Insertion Variables")
1047   :group 'message-insertion)
1048
1049 (defcustom message-indentation-spaces 3
1050   ;; In Emacs 24.1 this defaults to the value of
1051   ;; `mail-indentation-spaces' that defaults to `3' in Emacs 22.1~24.1,
1052   ;; and SXEmacs 22.1.  In XEmacs 21.4 and 21.5, sendmail.el provides
1053   ;; it; the defalut value is `3'.
1054   "*Number of spaces to insert at the beginning of each cited line.
1055 Used by `message-yank-original' via `message-yank-cite'."
1056   :version "23.2"
1057   :group 'message-insertion
1058   :link '(custom-manual "(message)Insertion Variables")
1059   :type 'integer)
1060
1061 (defcustom message-cite-function 'message-cite-original-without-signature
1062   "*Function for citing an original message.
1063 Predefined functions include `message-cite-original' and
1064 `message-cite-original-without-signature'.
1065 Note that these functions use `mail-citation-hook' if that is non-nil."
1066   :type '(radio (function-item message-cite-original)
1067                 (function-item message-cite-original-without-signature)
1068                 (function-item sc-cite-original)
1069                 (function :tag "Other"))
1070   :link '(custom-manual "(message)Insertion Variables")
1071   :version "22.3" ;; Gnus 5.10.12 (changed default)
1072   :group 'message-insertion)
1073
1074 (defcustom message-indent-citation-function 'message-indent-citation
1075   "*Function for modifying a citation just inserted in the mail buffer.
1076 This can also be a list of functions.  Each function can find the
1077 citation between (point) and (mark t).  And each function should leave
1078 point and mark around the citation text as modified."
1079   :type 'function
1080   :link '(custom-manual "(message)Insertion Variables")
1081   :group 'message-insertion)
1082
1083 (defcustom message-signature t
1084   ;; In Emacs 24.1 this defaults to the value of `mail-signature' that
1085   ;; defaults to:
1086   ;; `nil' in Emacs 22.1~23.1, XEmacs 21.4, 21.5, and SXEmacs 22.1;
1087   ;; `t' in Emacs 23.2, and 24.1
1088   "*String to be inserted at the end of the message buffer.
1089 If t, the `message-signature-file' file will be inserted instead.
1090 If a function, the result from the function will be used instead.
1091 If a form, the result from the form will be used instead."
1092   :version "23.2"
1093   :type 'sexp
1094   :link '(custom-manual "(message)Insertion Variables")
1095   :group 'message-insertion)
1096
1097 (defcustom message-signature-file "~/.signature"
1098   ;; In Emacs 24.1 this defaults to the value of `mail-signature-file'
1099   ;; that defaults to "~/.signature" in Emacs 22.1~24.1, and SXEmacs
1100   ;; 22.1.  In XEmacs 21.4 and 21.5, sendmail.el provides it;
1101   ;; the defalut value is "~/.signature".
1102   "*Name of file containing the text inserted at end of message buffer.
1103 Ignored if the named file doesn't exist.
1104 If nil, don't insert a signature.
1105 If a path is specified, the value of `message-signature-directory' is ignored,
1106 even if set."
1107   :version "23.2"
1108   :type '(choice file (const :tags "None" nil))
1109   :link '(custom-manual "(message)Insertion Variables")
1110   :group 'message-insertion)
1111
1112 (defcustom message-signature-directory nil
1113   "*Name of directory containing signature files.
1114 Comes in handy if you have many such files, handled via posting styles for
1115 instance.
1116 If nil, `message-signature-file' is expected to specify the directory if
1117 needed."
1118   :type '(choice string (const :tags "None" nil))
1119   :link '(custom-manual "(message)Insertion Variables")
1120   :group 'message-insertion)
1121
1122 (defcustom message-signature-insert-empty-line t
1123   "*If non-nil, insert an empty line before the signature separator."
1124   :version "22.1"
1125   :type 'boolean
1126   :link '(custom-manual "(message)Insertion Variables")
1127   :group 'message-insertion)
1128
1129 (defcustom message-cite-reply-position 'traditional
1130   "*Where the reply should be positioned.
1131 If `traditional', reply inline.
1132 If `above', reply above quoted text.
1133 If `below', reply below quoted text.
1134
1135 Note: Many newsgroups frown upon nontraditional reply styles. You
1136 probably want to set this variable only for specific groups,
1137 e.g. using `gnus-posting-styles':
1138
1139   (eval (set (make-local-variable 'message-cite-reply-position) 'above))"
1140   :type '(choice (const :tag "Reply inline" 'traditional)
1141                  (const :tag "Reply above" 'above)
1142                  (const :tag "Reply below" 'below))
1143   :group 'message-insertion)
1144
1145 (defcustom message-cite-style nil
1146   "*The overall style to be used when yanking cited text.
1147 Value is either `nil' (no variable overrides) or a let-style list
1148 of pairs (VARIABLE VALUE) that will be bound in
1149 `message-yank-original' to do the quoting.
1150
1151 Presets to impersonate popular mail agents are found in the
1152 message-cite-style-* variables.  This variable is intended for
1153 use in `gnus-posting-styles', such as:
1154
1155   ((posting-from-work-p) (eval (set (make-local-variable 'message-cite-style) message-cite-style-outlook)))"
1156   :version "24.1"
1157   :group 'message-insertion
1158   :type '(choice (const :tag "Do not override variables" :value nil)
1159                  (const :tag "MS Outlook" :value message-cite-style-outlook)
1160                  (const :tag "Mozilla Thunderbird" :value message-cite-style-thunderbird)
1161                  (const :tag "Gmail" :value message-cite-style-gmail)
1162                  (variable :tag "User-specified")))
1163
1164 (defconst message-cite-style-outlook
1165   '((message-cite-function  'message-cite-original)
1166     (message-citation-line-function  'message-insert-formatted-citation-line)
1167     (message-cite-reply-position 'above)
1168     (message-yank-prefix  "")
1169     (message-yank-cited-prefix  "")
1170     (message-yank-empty-prefix  "")
1171     (message-citation-line-format  "\n\n-----------------------\nOn %a, %b %d %Y, %N wrote:\n"))
1172   "Message citation style used by MS Outlook. Use with message-cite-style.")
1173
1174 (defconst message-cite-style-thunderbird
1175   '((message-cite-function  'message-cite-original)
1176     (message-citation-line-function  'message-insert-formatted-citation-line)
1177     (message-cite-reply-position 'above)
1178     (message-yank-prefix  "> ")
1179     (message-yank-cited-prefix  ">")
1180     (message-yank-empty-prefix  ">")
1181     (message-citation-line-format "On %D %R %p, %N wrote:"))
1182   "Message citation style used by Mozilla Thunderbird. Use with message-cite-style.")
1183
1184 (defconst message-cite-style-gmail
1185   '((message-cite-function  'message-cite-original)
1186     (message-citation-line-function  'message-insert-formatted-citation-line)
1187     (message-cite-reply-position 'above)
1188     (message-yank-prefix  "    ")
1189     (message-yank-cited-prefix  "    ")
1190     (message-yank-empty-prefix  "    ")
1191     (message-citation-line-format "On %e %B %Y %R, %f wrote:\n"))
1192   "Message citation style used by Gmail. Use with message-cite-style.")
1193
1194 (defcustom message-distribution-function nil
1195   "*Function called to return a Distribution header."
1196   :group 'message-news
1197   :group 'message-headers
1198   :link '(custom-manual "(message)News Headers")
1199   :type '(choice function (const nil)))
1200
1201 (defcustom message-expires 14
1202   "Number of days before your article expires."
1203   :group 'message-news
1204   :group 'message-headers
1205   :link '(custom-manual "(message)News Headers")
1206   :type 'integer)
1207
1208 (defcustom message-user-path nil
1209   "If nil, use the NNTP server name in the Path header.
1210 If stringp, use this; if non-nil, use no host name (user name only)."
1211   :group 'message-news
1212   :group 'message-headers
1213   :link '(custom-manual "(message)News Headers")
1214   :type '(choice (const :tag "nntp" nil)
1215                  (string :tag "name")
1216                  (sexp :tag "none" :format "%t" t)))
1217
1218 ;; This can be the name of a buffer, or a cons cell (FUNCTION . ARGS)
1219 ;; for yanking the original buffer.
1220 (defvar message-reply-buffer nil)
1221 (defvar message-reply-headers nil
1222   "The headers of the current replied article.
1223 It is a vector of the following headers:
1224 \[number subject from date id references chars lines xref extra].")
1225 (defvar message-newsreader nil)
1226 (defvar message-mailer nil)
1227 (defvar message-sent-message-via nil)
1228 (defvar message-checksum nil)
1229 (defvar message-send-actions nil
1230   "A list of actions to be performed upon successful sending of a message.")
1231 (defvar message-return-action nil
1232   "Action to return to the caller after sending or postponing a message.")
1233 (defvar message-exit-actions nil
1234   "A list of actions to be performed upon exiting after sending a message.")
1235 (defvar message-kill-actions nil
1236   "A list of actions to be performed before killing a message buffer.")
1237 (defvar message-postpone-actions nil
1238   "A list of actions to be performed after postponing a message.")
1239
1240 (define-widget 'message-header-lines 'text
1241   "All header lines must be LFD terminated."
1242   :format "%{%t%}:%n%v"
1243   :valid-regexp "^\\'"
1244   :error "All header lines must be newline terminated")
1245
1246 (defcustom message-default-headers ""
1247   "Header lines to be inserted in outgoing messages.
1248 This can be set to a string containing or a function returning
1249 header lines to be inserted before you edit the message, so you
1250 can edit or delete these lines.  If set to a function, it is
1251 called and its result is inserted."
1252   :version "23.2"
1253   :group 'message-headers
1254   :link '(custom-manual "(message)Message Headers")
1255   :type '(choice
1256           (message-header-lines :tag "String")
1257           (function :tag "Function")))
1258
1259 (defcustom message-default-mail-headers
1260   ;; Ease the transition from mail-mode to message-mode.  See bugs#4431, 5555.
1261   (concat (if (and (boundp 'mail-default-reply-to)
1262                    (stringp mail-default-reply-to))
1263               (format "Reply-to: %s\n" mail-default-reply-to))
1264           (if (and (boundp 'mail-self-blind)
1265                    mail-self-blind)
1266               (format "BCC: %s\n" user-mail-address))
1267           (if (and (boundp 'mail-archive-file-name)
1268                    (stringp mail-archive-file-name))
1269               (format "FCC: %s\n" mail-archive-file-name))
1270           ;; Use the value of `mail-default-headers' if available.
1271           ;; Note: as for XEmacs 21.4 and 21.5, it is unavailable
1272           ;; unless sendmail.el is loaded.
1273           (if (boundp 'mail-default-headers)
1274               mail-default-headers))
1275   "*A string of header lines to be inserted in outgoing mails."
1276   :version "23.2"
1277   :group 'message-headers
1278   :group 'message-mail
1279   :link '(custom-manual "(message)Mail Headers")
1280   :type 'message-header-lines)
1281
1282 (defcustom message-default-news-headers ""
1283   "*A string of header lines to be inserted in outgoing news articles."
1284   :group 'message-headers
1285   :group 'message-news
1286   :link '(custom-manual "(message)News Headers")
1287   :type 'message-header-lines)
1288
1289 ;; Note: could use /usr/ucb/mail instead of sendmail;
1290 ;; options -t, and -v if not interactive.
1291 (defcustom message-mailer-swallows-blank-line
1292   (if (and (string-match "sparc-sun-sunos\\(\\'\\|[^5]\\)"
1293                          system-configuration)
1294            (file-readable-p "/etc/sendmail.cf")
1295            (with-temp-buffer
1296              (insert-file-contents "/etc/sendmail.cf")
1297              (goto-char (point-min))
1298              (let ((case-fold-search nil))
1299                (re-search-forward "^OR\\>" nil t))))
1300       ;; According to RFC822, "The field-name must be composed of printable
1301       ;; ASCII characters (i. e., characters that have decimal values between
1302       ;; 33 and 126, except colon)", i. e., any chars except ctl chars,
1303       ;; space, or colon.
1304       '(looking-at "[ \t]\\|[][!\"#$%&'()*+,-./0-9;<=>?@A-Z\\\\^_`a-z{|}~]+:"))
1305   "*Set this non-nil if the system's mailer runs the header and body together.
1306 \(This problem exists on Sunos 4 when sendmail is run in remote mode.)
1307 The value should be an expression to test whether the problem will
1308 actually occur."
1309   :group 'message-sending
1310   :link '(custom-manual "(message)Mail Variables")
1311   :type 'sexp)
1312
1313 ;;;###autoload
1314 (define-mail-user-agent 'message-user-agent
1315   'message-mail 'message-send-and-exit
1316   'message-kill-buffer 'message-send-hook)
1317
1318 (defvar message-mh-deletable-headers '(Message-ID Date Lines Sender)
1319   "If non-nil, delete the deletable headers before feeding to mh.")
1320
1321 (defvar message-send-method-alist
1322   '((news message-news-p message-send-via-news)
1323     (mail message-mail-p message-send-via-mail))
1324   "Alist of ways to send outgoing messages.
1325 Each element has the form
1326
1327   \(TYPE PREDICATE FUNCTION)
1328
1329 where TYPE is a symbol that names the method; PREDICATE is a function
1330 called without any parameters to determine whether the message is
1331 a message of type TYPE; and FUNCTION is a function to be called if
1332 PREDICATE returns non-nil.  FUNCTION is called with one parameter --
1333 the prefix.")
1334
1335 (defcustom message-mail-alias-type 'abbrev
1336   "*What alias expansion type to use in Message buffers.
1337 The default is `abbrev', which uses mailabbrev.  `ecomplete' uses
1338 an electric completion mode.  nil switches mail aliases off.
1339 This can also be a list of values."
1340   :group 'message
1341   :link '(custom-manual "(message)Mail Aliases")
1342   :type '(choice (const :tag "Use Mailabbrev" abbrev)
1343                  (const :tag "Use ecomplete" ecomplete)
1344                  (const :tag "No expansion" nil)))
1345
1346 (defcustom message-self-insert-commands '(self-insert-command)
1347   "List of `self-insert-command's used to trigger ecomplete.
1348 When one of those commands is invoked to enter a character in To or Cc
1349 header, ecomplete will suggest the candidates of recipients (see also
1350 `message-mail-alias-type').  If you use some tool to enter non-ASCII
1351 text and it replaces `self-insert-command' with the other command, e.g.
1352 `egg-self-insert-command', you may want to add it to this list."
1353   :group 'message-various
1354   :type '(repeat function))
1355
1356 (defcustom message-auto-save-directory
1357   (if (file-writable-p message-directory)
1358       (file-name-as-directory (expand-file-name "drafts" message-directory))
1359     "~/")
1360   "*Directory where Message auto-saves buffers if Gnus isn't running.
1361 If nil, Message won't auto-save."
1362   :group 'message-buffers
1363   :link '(custom-manual "(message)Various Message Variables")
1364   :type '(choice directory (const :tag "Don't auto-save" nil)))
1365
1366 (defcustom message-default-charset
1367   (and (not (mm-multibyte-p)) 'iso-8859-1)
1368   "Default charset used in non-MULE Emacsen.
1369 If nil, you might be asked to input the charset."
1370   :version "21.1"
1371   :group 'message
1372   :link '(custom-manual "(message)Various Message Variables")
1373   :type 'symbol)
1374
1375 (defcustom message-dont-reply-to-names
1376   (and (boundp 'rmail-dont-reply-to-names) rmail-dont-reply-to-names)
1377   "*Addresses to prune when doing wide replies.
1378 This can be a regexp or a list of regexps.  Also, a value of nil means
1379 exclude your own user name only."
1380   :version "21.1"
1381   :group 'message
1382   :link '(custom-manual "(message)Wide Reply")
1383   :type '(choice (const :tag "Yourself" nil)
1384                  regexp
1385                  (repeat :tag "Regexp List" regexp)))
1386
1387 (defsubst message-dont-reply-to-names ()
1388   (gmm-regexp-concat message-dont-reply-to-names))
1389
1390 (defvar message-shoot-gnksa-feet nil
1391   "*A list of GNKSA feet you are allowed to shoot.
1392 Gnus gives you all the opportunity you could possibly want for
1393 shooting yourself in the foot.  Also, Gnus allows you to shoot the
1394 feet of Good Net-Keeping Seal of Approval.  The following are foot
1395 candidates:
1396 `empty-article'     Allow you to post an empty article;
1397 `quoted-text-only'  Allow you to post quoted text only;
1398 `multiple-copies'   Allow you to post multiple copies;
1399 `cancel-messages'   Allow you to cancel or supersede messages from
1400                     your other email addresses;
1401 `canlock-verify'    Allow you to cancel messages without verifying canlock.")
1402
1403 (defsubst message-gnksa-enable-p (feature)
1404   (or (not (listp message-shoot-gnksa-feet))
1405       (memq feature message-shoot-gnksa-feet)))
1406
1407 (defcustom message-hidden-headers '("^References:" "^Face:" "^X-Face:"
1408                                     "^X-Draft-From:")
1409   "Regexp of headers to be hidden when composing new messages.
1410 This can also be a list of regexps to match headers.  Or a list
1411 starting with `not' and followed by regexps."
1412   :version "22.1"
1413   :group 'message
1414   :link '(custom-manual "(message)Message Headers")
1415   :type '(choice
1416           :format "%{%t%}: %[Value Type%] %v"
1417           (regexp :menu-tag "regexp" :format "regexp\n%t: %v")
1418           (repeat :menu-tag "(regexp ...)" :format "(regexp ...)\n%v%i"
1419                   (regexp :format "%t: %v"))
1420           (cons :menu-tag "(not regexp ...)" :format "(not regexp ...)\n%v"
1421                 (const not)
1422                 (repeat :format "%v%i"
1423                         (regexp :format "%t: %v")))))
1424
1425 (defcustom message-cite-articles-with-x-no-archive t
1426   "If non-nil, cite text from articles that has X-No-Archive set."
1427   :group 'message
1428   :type 'boolean)
1429
1430 ;;; Internal variables.
1431 ;;; Well, not really internal.
1432
1433 (defvar message-mode-syntax-table
1434   (let ((table (copy-syntax-table text-mode-syntax-table)))
1435     (modify-syntax-entry ?% ". " table)
1436     (modify-syntax-entry ?> ". " table)
1437     (modify-syntax-entry ?< ". " table)
1438     table)
1439   "Syntax table used while in Message mode.")
1440
1441 (defface message-header-to
1442   '((((class color)
1443       (background dark))
1444      (:foreground "DarkOliveGreen1" :bold t))
1445     (((class color)
1446       (background light))
1447      (:foreground "MidnightBlue" :bold t))
1448     (t
1449      (:bold t :italic t)))
1450   "Face used for displaying From headers."
1451   :group 'message-faces)
1452 ;; backward-compatibility alias
1453 (put 'message-header-to-face 'face-alias 'message-header-to)
1454 (put 'message-header-to-face 'obsolete-face "22.1")
1455
1456 (defface message-header-cc
1457   '((((class color)
1458       (background dark))
1459      (:foreground "chartreuse1" :bold t))
1460     (((class color)
1461       (background light))
1462      (:foreground "MidnightBlue"))
1463     (t
1464      (:bold t)))
1465   "Face used for displaying Cc headers."
1466   :group 'message-faces)
1467 ;; backward-compatibility alias
1468 (put 'message-header-cc-face 'face-alias 'message-header-cc)
1469 (put 'message-header-cc-face 'obsolete-face "22.1")
1470
1471 (defface message-header-subject
1472   '((((class color)
1473       (background dark))
1474      (:foreground "OliveDrab1"))
1475     (((class color)
1476       (background light))
1477      (:foreground "navy blue" :bold t))
1478     (t
1479      (:bold t)))
1480   "Face used for displaying subject headers."
1481   :group 'message-faces)
1482 ;; backward-compatibility alias
1483 (put 'message-header-subject-face 'face-alias 'message-header-subject)
1484 (put 'message-header-subject-face 'obsolete-face "22.1")
1485
1486 (defface message-header-newsgroups
1487   '((((class color)
1488       (background dark))
1489      (:foreground "yellow" :bold t :italic t))
1490     (((class color)
1491       (background light))
1492      (:foreground "blue4" :bold t :italic t))
1493     (t
1494      (:bold t :italic t)))
1495   "Face used for displaying newsgroups headers."
1496   :group 'message-faces)
1497 ;; backward-compatibility alias
1498 (put 'message-header-newsgroups-face 'face-alias 'message-header-newsgroups)
1499 (put 'message-header-newsgroups-face 'obsolete-face "22.1")
1500
1501 (defface message-header-other
1502   '((((class color)
1503       (background dark))
1504      (:foreground "VioletRed1"))
1505     (((class color)
1506       (background light))
1507      (:foreground "steel blue"))
1508     (t
1509      (:bold t :italic t)))
1510   "Face used for displaying newsgroups headers."
1511   :group 'message-faces)
1512 ;; backward-compatibility alias
1513 (put 'message-header-other-face 'face-alias 'message-header-other)
1514 (put 'message-header-other-face 'obsolete-face "22.1")
1515
1516 (defface message-header-name
1517   '((((class color)
1518       (background dark))
1519      (:foreground "green"))
1520     (((class color)
1521       (background light))
1522      (:foreground "cornflower blue"))
1523     (t
1524      (:bold t)))
1525   "Face used for displaying header names."
1526   :group 'message-faces)
1527 ;; backward-compatibility alias
1528 (put 'message-header-name-face 'face-alias 'message-header-name)
1529 (put 'message-header-name-face 'obsolete-face "22.1")
1530
1531 (defface message-header-xheader
1532   '((((class color)
1533       (background dark))
1534      (:foreground "DeepSkyBlue1"))
1535     (((class color)
1536       (background light))
1537      (:foreground "blue"))
1538     (t
1539      (:bold t)))
1540   "Face used for displaying X-Header headers."
1541   :group 'message-faces)
1542 ;; backward-compatibility alias
1543 (put 'message-header-xheader-face 'face-alias 'message-header-xheader)
1544 (put 'message-header-xheader-face 'obsolete-face "22.1")
1545
1546 (defface message-separator
1547   '((((class color)
1548       (background dark))
1549      (:foreground "LightSkyBlue1"))
1550     (((class color)
1551       (background light))
1552      (:foreground "brown"))
1553     (t
1554      (:bold t)))
1555   "Face used for displaying the separator."
1556   :group 'message-faces)
1557 ;; backward-compatibility alias
1558 (put 'message-separator-face 'face-alias 'message-separator)
1559 (put 'message-separator-face 'obsolete-face "22.1")
1560
1561 (defface message-cited-text
1562   '((((class color)
1563       (background dark))
1564      (:foreground "LightPink1"))
1565     (((class color)
1566       (background light))
1567      (:foreground "red"))
1568     (t
1569      (:bold t)))
1570   "Face used for displaying cited text names."
1571   :group 'message-faces)
1572 ;; backward-compatibility alias
1573 (put 'message-cited-text-face 'face-alias 'message-cited-text)
1574 (put 'message-cited-text-face 'obsolete-face "22.1")
1575
1576 (defface message-mml
1577   '((((class color)
1578       (background dark))
1579      (:foreground "MediumSpringGreen"))
1580     (((class color)
1581       (background light))
1582      (:foreground "ForestGreen"))
1583     (t
1584      (:bold t)))
1585   "Face used for displaying MML."
1586   :group 'message-faces)
1587 ;; backward-compatibility alias
1588 (put 'message-mml-face 'face-alias 'message-mml)
1589 (put 'message-mml-face 'obsolete-face "22.1")
1590
1591 (defun message-font-lock-make-header-matcher (regexp)
1592   (let ((form
1593          `(lambda (limit)
1594             (let ((start (point)))
1595               (save-restriction
1596                 (widen)
1597                 (goto-char (point-min))
1598                 (if (re-search-forward
1599                      (concat "^" (regexp-quote mail-header-separator) "$")
1600                      nil t)
1601                     (setq limit (min limit (match-beginning 0))))
1602                 (goto-char start))
1603               (and (< start limit)
1604                    (re-search-forward ,regexp limit t))))))
1605     (if (featurep 'bytecomp)
1606         (byte-compile form)
1607       form)))
1608
1609 (defvar message-font-lock-keywords
1610   (let ((content "[ \t]*\\(.+\\(\n[ \t].*\\)*\\)\n?"))
1611     `((,(message-font-lock-make-header-matcher
1612          (concat "^\\([Tt]o:\\)" content))
1613        (1 'message-header-name)
1614        (2 'message-header-to nil t))
1615       (,(message-font-lock-make-header-matcher
1616          (concat "^\\(^[GBF]?[Cc][Cc]:\\|^[Rr]eply-[Tt]o:\\)" content))
1617        (1 'message-header-name)
1618        (2 'message-header-cc nil t))
1619       (,(message-font-lock-make-header-matcher
1620          (concat "^\\([Ss]ubject:\\)" content))
1621        (1 'message-header-name)
1622        (2 'message-header-subject nil t))
1623       (,(message-font-lock-make-header-matcher
1624          (concat "^\\([Nn]ewsgroups:\\|Followup-[Tt]o:\\)" content))
1625        (1 'message-header-name)
1626        (2 'message-header-newsgroups nil t))
1627       (,(message-font-lock-make-header-matcher
1628          (concat "^\\(X-[A-Za-z0-9-]+:\\|In-Reply-To:\\)" content))
1629        (1 'message-header-name)
1630        (2 'message-header-xheader))
1631       (,(message-font-lock-make-header-matcher
1632          (concat "^\\([A-Z][^: \n\t]+:\\)" content))
1633        (1 'message-header-name)
1634        (2 'message-header-other nil t))
1635       ,@(if (and mail-header-separator
1636                  (not (equal mail-header-separator "")))
1637             `((,(concat "^\\(" (regexp-quote mail-header-separator) "\\)$")
1638                1 'message-separator))
1639           nil)
1640       ((lambda (limit)
1641          (re-search-forward (concat "^\\("
1642                                     message-cite-prefix-regexp
1643                                     "\\).*")
1644                             limit t))
1645        (0 'message-cited-text))
1646       ("<#/?\\(multipart\\|part\\|external\\|mml\\|secure\\)[^>]*>"
1647        (0 'message-mml))))
1648   "Additional expressions to highlight in Message mode.")
1649
1650
1651 ;; XEmacs does it like this.  For Emacs, we have to set the
1652 ;; `font-lock-defaults' buffer-local variable.
1653 (put 'message-mode 'font-lock-defaults '(message-font-lock-keywords t))
1654
1655 (defvar message-face-alist
1656   '((bold . message-bold-region)
1657     (underline . underline-region)
1658     (default . (lambda (b e)
1659                  (message-unbold-region b e)
1660                  (ununderline-region b e))))
1661   "Alist of mail and news faces for facemenu.
1662 The cdr of each entry is a function for applying the face to a region.")
1663
1664 (defcustom message-send-hook nil
1665   "Hook run before sending messages.
1666 This hook is run quite early when sending."
1667   :group 'message-various
1668   :options '(ispell-message)
1669   :link '(custom-manual "(message)Various Message Variables")
1670   :type 'hook)
1671
1672 (defcustom message-send-mail-hook nil
1673   "Hook run before sending mail messages.
1674 This hook is run very late -- just before the message is sent as
1675 mail."
1676   :group 'message-various
1677   :link '(custom-manual "(message)Various Message Variables")
1678   :type 'hook)
1679
1680 (defcustom message-send-news-hook nil
1681   "Hook run before sending news messages.
1682 This hook is run very late -- just before the message is sent as
1683 news."
1684   :group 'message-various
1685   :link '(custom-manual "(message)Various Message Variables")
1686   :type 'hook)
1687
1688 (defcustom message-sent-hook nil
1689   "Hook run after sending messages."
1690   :group 'message-various
1691   :type 'hook)
1692
1693 (defvar message-send-coding-system 'binary
1694   "Coding system to encode outgoing mail.")
1695
1696 (defvar message-draft-coding-system
1697   mm-auto-save-coding-system
1698   "*Coding system to compose mail.
1699 If you'd like to make it possible to share draft files between XEmacs
1700 and Emacs, you may use `iso-2022-7bit' for this value at your own risk.
1701 Note that the coding-system `iso-2022-7bit' isn't suitable to all data.")
1702
1703 (defcustom message-send-mail-partially-limit nil
1704   "The limitation of messages sent as message/partial.
1705 The lower bound of message size in characters, beyond which the message
1706 should be sent in several parts.  If it is nil, the size is unlimited."
1707   :version "24.1"
1708   :group 'message-buffers
1709   :link '(custom-manual "(message)Mail Variables")
1710   :type '(choice (const :tag "unlimited" nil)
1711                  (integer 1000000)))
1712
1713 (defcustom message-alternative-emails nil
1714   "*Regexp matching alternative email addresses.
1715 The first address in the To, Cc or From headers of the original
1716 article matching this variable is used as the From field of
1717 outgoing messages.
1718
1719 This variable has precedence over posting styles and anything that runs
1720 off `message-setup-hook'."
1721   :group 'message-headers
1722   :link '(custom-manual "(message)Message Headers")
1723   :type '(choice (const :tag "Always use primary" nil)
1724                  regexp))
1725
1726 (defcustom message-hierarchical-addresses nil
1727   "A list of hierarchical mail address definitions.
1728
1729 Inside each entry, the first address is the \"top\" address, and
1730 subsequent addresses are subaddresses; this is used to indicate that
1731 mail sent to the first address will automatically be delivered to the
1732 subaddresses.  So if the first address appears in the recipient list
1733 for a message, the subaddresses will be removed (if present) before
1734 the mail is sent.  All addresses in this structure should be
1735 downcased."
1736   :version "22.1"
1737   :group 'message-headers
1738   :type '(repeat (repeat string)))
1739
1740 (defcustom message-mail-user-agent nil
1741   "Like `mail-user-agent'.
1742 Except if it is nil, use Gnus native MUA; if it is t, use
1743 `mail-user-agent'."
1744   :version "22.1"
1745   :type '(radio (const :tag "Gnus native"
1746                        :format "%t\n"
1747                        nil)
1748                 (const :tag "`mail-user-agent'"
1749                        :format "%t\n"
1750                        t)
1751                 (function-item :tag "Default Emacs mail"
1752                                :format "%t\n"
1753                                sendmail-user-agent)
1754                 (function-item :tag "Emacs interface to MH"
1755                                :format "%t\n"
1756                                mh-e-user-agent)
1757                 (function :tag "Other"))
1758   :version "21.1"
1759   :group 'message)
1760
1761 (defcustom message-wide-reply-confirm-recipients nil
1762   "Whether to confirm a wide reply to multiple email recipients.
1763 If this variable is nil, don't ask whether to reply to all recipients.
1764 If this variable is non-nil, pose the question \"Reply to all
1765 recipients?\" before a wide reply to multiple recipients.  If the user
1766 answers yes, reply to all recipients as usual.  If the user answers
1767 no, only reply back to the author."
1768   :version "22.1"
1769   :group 'message-headers
1770   :link '(custom-manual "(message)Wide Reply")
1771   :type 'boolean)
1772
1773 (defcustom message-user-fqdn nil
1774   "*Domain part of Message-Ids."
1775   :version "22.1"
1776   :group 'message-headers
1777   :link '(custom-manual "(message)News Headers")
1778   :type '(radio (const :format "%v  " nil)
1779                 (string :format "FQDN: %v")))
1780
1781 (defcustom message-use-idna (and (condition-case nil (require 'idna)
1782                                    (file-error))
1783                                  (mm-coding-system-p 'utf-8)
1784                                  (executable-find idna-program)
1785                                  (string= (idna-to-ascii "räksmörgås")
1786                                           "xn--rksmrgs-5wao1o")
1787                                  t)
1788   "Whether to encode non-ASCII in domain names into ASCII according to IDNA.
1789 GNU Libidn, and in particular the elisp package \"idna.el\" and
1790 the external program \"idn\", must be installed for this
1791 functionality to work."
1792   :version "22.1"
1793   :group 'message-headers
1794   :link '(custom-manual "(message)IDNA")
1795   :type '(choice (const :tag "Ask" ask)
1796                  (const :tag "Never" nil)
1797                  (const :tag "Always" t)))
1798
1799 (defcustom message-generate-hashcash (if (executable-find "hashcash") 'opportunistic)
1800   "*Whether to generate X-Hashcash: headers.
1801 If t, always generate hashcash headers.  If `opportunistic',
1802 only generate hashcash headers if it can be done without the user
1803 waiting (i.e., only asynchronously).
1804
1805 You must have the \"hashcash\" binary installed, see `hashcash-path'."
1806   :version "24.1"
1807   :group 'message-headers
1808   :link '(custom-manual "(message)Mail Headers")
1809   :type '(choice (const :tag "Always" t)
1810                  (const :tag "Never" nil)
1811                  (const :tag "Opportunistic" opportunistic)))
1812
1813 ;;; Internal variables.
1814
1815 (defvar message-sending-message "Sending...")
1816 (defvar message-buffer-list nil)
1817 (defvar message-this-is-news nil)
1818 (defvar message-this-is-mail nil)
1819 (defvar message-draft-article nil)
1820 (defvar message-mime-part nil)
1821 (defvar message-posting-charset nil)
1822 (defvar message-inserted-headers nil)
1823 (defvar message-inhibit-ecomplete nil)
1824
1825 ;; Byte-compiler warning
1826 (defvar gnus-active-hashtb)
1827 (defvar gnus-read-active-file)
1828
1829 ;;; Regexp matching the delimiter of messages in UNIX mail format
1830 ;;; (UNIX From lines), minus the initial ^.  It should be a copy
1831 ;;; of rmail.el's rmail-unix-mail-delimiter.
1832 (defvar message-unix-mail-delimiter
1833   (let ((time-zone-regexp
1834          (concat "\\([A-Z]?[A-Z]?[A-Z][A-Z]\\( DST\\)?"
1835                  "\\|[-+]?[0-9][0-9][0-9][0-9]"
1836                  "\\|"
1837                  "\\) *")))
1838     (concat
1839      "From "
1840
1841      ;; Many things can happen to an RFC 822 mailbox before it is put into
1842      ;; a `From' line.  The leading phrase can be stripped, e.g.
1843      ;; `Joe <@w.x:joe@y.z>' -> `<@w.x:joe@y.z>'.  The <> can be stripped, e.g.
1844      ;; `<@x.y:joe@y.z>' -> `@x.y:joe@y.z'.  Everything starting with a CRLF
1845      ;; can be removed, e.g.
1846      ;;         From: joe@y.z (Joe      K
1847      ;;                 User)
1848      ;; can yield `From joe@y.z (Joe    K Fri Mar 22 08:11:15 1996', and
1849      ;;         From: Joe User
1850      ;;                 <joe@y.z>
1851      ;; can yield `From Joe User Fri Mar 22 08:11:15 1996'.
1852      ;; The mailbox can be removed or be replaced by white space, e.g.
1853      ;;         From: "Joe User"{space}{tab}
1854      ;;                 <joe@y.z>
1855      ;; can yield `From {space}{tab} Fri Mar 22 08:11:15 1996',
1856      ;; where {space} and {tab} represent the Ascii space and tab characters.
1857      ;; We want to match the results of any of these manglings.
1858      ;; The following regexp rejects names whose first characters are
1859      ;; obviously bogus, but after that anything goes.
1860      "\\([^\0-\b\n-\r\^?].*\\)?"
1861
1862      ;; The time the message was sent.
1863      "\\([^\0-\r \^?]+\\) +"            ; day of the week
1864      "\\([^\0-\r \^?]+\\) +"            ; month
1865      "\\([0-3]?[0-9]\\) +"              ; day of month
1866      "\\([0-2][0-9]:[0-5][0-9]\\(:[0-6][0-9]\\)?\\) *" ; time of day
1867
1868      ;; Perhaps a time zone, specified by an abbreviation, or by a
1869      ;; numeric offset.
1870      time-zone-regexp
1871
1872      ;; The year.
1873      " \\([0-9][0-9]+\\) *"
1874
1875      ;; On some systems the time zone can appear after the year, too.
1876      time-zone-regexp
1877
1878      ;; Old uucp cruft.
1879      "\\(remote from .*\\)?"
1880
1881      "\n"))
1882   "Regexp matching the delimiter of messages in UNIX mail format.")
1883
1884 (defvar message-unsent-separator
1885   (concat "^ *---+ +Unsent message follows +---+ *$\\|"
1886           "^ *---+ +Returned message +---+ *$\\|"
1887           "^Start of returned message$\\|"
1888           "^ *---+ +Original message +---+ *$\\|"
1889           "^ *--+ +begin message +--+ *$\\|"
1890           "^ *---+ +Original message follows +---+ *$\\|"
1891           "^ *---+ +Undelivered message follows +---+ *$\\|"
1892           "^------ This is a copy of the message, including all the headers. ------ *$\\|"
1893           "^|? *---+ +Message text follows: +---+ *|?$")
1894   "A regexp that matches the separator before the text of a failed message.")
1895
1896 (defvar message-field-fillers
1897   '((To message-fill-field-address)
1898     (Cc message-fill-field-address)
1899     (From message-fill-field-address))
1900   "Alist of header names/filler functions.")
1901
1902 (defvar message-header-format-alist
1903   `((From)
1904     (Newsgroups)
1905     (To)
1906     (Cc)
1907     (Subject)
1908     (In-Reply-To)
1909     (Fcc)
1910     (Bcc)
1911     (Date)
1912     (Organization)
1913     (Distribution)
1914     (Lines)
1915     (Expires)
1916     (Message-ID)
1917     (References . message-shorten-references)
1918     (User-Agent))
1919   "Alist used for formatting headers.")
1920
1921 (defvar message-options nil
1922   "Some saved answers when sending message.")
1923 ;; FIXME: On XEmacs this causes problems since let-binding like:
1924 ;; (let ((message-options message-options)) ...)
1925 ;; as in `message-send' and `mml-preview' loses to buffer-local
1926 ;; variable initialization.
1927 (unless (featurep 'xemacs)
1928   (make-variable-buffer-local 'message-options))
1929
1930 (defvar message-send-mail-real-function nil
1931   "Internal send mail function.")
1932
1933 (defvar message-bogus-system-names "\\`localhost\\.\\|\\.local\\'"
1934   "The regexp of bogus system names.")
1935
1936 (defcustom message-valid-fqdn-regexp
1937   (concat "[a-z0-9][-.a-z0-9]+\\." ;; [hostname.subdomain.]domain.
1938           ;; valid TLDs:
1939           "\\([a-z][a-z]\\|" ;; two letter country TDLs
1940           "aero\\|arpa\\|asia\\|bitnet\\|biz\\|bofh\\|"
1941           "cat\\|com\\|coop\\|edu\\|gov\\|"
1942           "info\\|int\\|jobs\\|"
1943           "mil\\|mobi\\|museum\\|name\\|net\\|"
1944           "org\\|pro\\|tel\\|travel\\|uucp\\)")
1945   ;; http://en.wikipedia.org/wiki/List_of_Internet_top-level_domains
1946   ;; http://en.wikipedia.org/wiki/GTLD
1947   ;; `approved, but not yet in operation': .xxx
1948   ;; "dead" nato bitnet uucp
1949   "Regular expression that matches a valid FQDN."
1950   ;; see also: gnus-button-valid-fqdn-regexp
1951   :version "22.1"
1952   :group 'message-headers
1953   :type 'regexp)
1954
1955 (autoload 'gnus-alive-p "gnus-util")
1956 (autoload 'gnus-delay-article "gnus-delay")
1957 (autoload 'gnus-extract-address-components "gnus-util")
1958 (autoload 'gnus-find-method-for-group "gnus")
1959 (autoload 'gnus-group-decoded-name "gnus-group")
1960 (autoload 'gnus-group-name-charset "gnus-group")
1961 (autoload 'gnus-group-name-decode "gnus-group")
1962 (autoload 'gnus-groups-from-server "gnus")
1963 (autoload 'gnus-make-local-hook "gnus-util")
1964 (autoload 'gnus-open-server "gnus-int")
1965 (autoload 'gnus-output-to-mail "gnus-util")
1966 (autoload 'gnus-output-to-rmail "gnus-util")
1967 (autoload 'gnus-request-post "gnus-int")
1968 (autoload 'gnus-select-frame-set-input-focus "gnus-util")
1969 (autoload 'gnus-server-string "gnus")
1970 (autoload 'idna-to-ascii "idna")
1971 (autoload 'message-setup-toolbar "messagexmas")
1972 (autoload 'mh-new-draft-name "mh-comp")
1973 (autoload 'mh-send-letter "mh-comp")
1974 (autoload 'nndraft-request-associate-buffer "nndraft")
1975 (autoload 'nndraft-request-expire-articles "nndraft")
1976 (autoload 'nnvirtual-find-group-art "nnvirtual")
1977 (autoload 'rmail-dont-reply-to "mail-utils")
1978 (autoload 'rmail-msg-is-pruned "rmail")
1979 (autoload 'rmail-output "rmailout")
1980
1981 \f
1982
1983 ;;;
1984 ;;; Utility functions.
1985 ;;;
1986
1987 (defmacro message-y-or-n-p (question show &rest text)
1988   "Ask QUESTION, displaying remaining args in a temporary buffer if SHOW."
1989   `(message-talkative-question 'y-or-n-p ,question ,show ,@text))
1990
1991 (defmacro message-delete-line (&optional n)
1992   "Delete the current line (and the next N lines)."
1993   `(delete-region (progn (beginning-of-line) (point))
1994                   (progn (forward-line ,(or n 1)) (point))))
1995
1996 (defun message-mark-active-p ()
1997   "Non-nil means the mark and region are currently active in this buffer."
1998   mark-active)
1999
2000 (defun message-unquote-tokens (elems)
2001   "Remove double quotes (\") from strings in list ELEMS."
2002   (mapcar (lambda (item)
2003             (while (string-match "^\\(.*\\)\"\\(.*\\)$" item)
2004               (setq item (concat (match-string 1 item)
2005                                  (match-string 2 item))))
2006             item)
2007           elems))
2008
2009 (defun message-tokenize-header (header &optional separator)
2010   "Split HEADER into a list of header elements.
2011 SEPARATOR is a string of characters to be used as separators.  \",\"
2012 is used by default."
2013   (if (not header)