Cleanup uses of "-hooks".
[bpt/emacs.git] / lisp / mail / sendmail.el
CommitLineData
328f984d 1;;; sendmail.el --- mail sending commands for Emacs
c88ab9ce 2
acaf905b 3;; Copyright (C) 1985-1986, 1992-1996, 1998, 2000-2012
c2457e54 4;; Free Software Foundation, Inc.
3a801d0c 5
e5167999 6;; Maintainer: FSF
d7b4d18f 7;; Keywords: mail
e5167999 8
20a8832d
RS
9;; This file is part of GNU Emacs.
10
b1fc2b50 11;; GNU Emacs is free software: you can redistribute it and/or modify
20a8832d 12;; it under the terms of the GNU General Public License as published by
b1fc2b50
GM
13;; the Free Software Foundation, either version 3 of the License, or
14;; (at your option) any later version.
20a8832d
RS
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
b1fc2b50 22;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
20a8832d 23
d9ecc911
ER
24;;; Commentary:
25
26;; This mode provides mail-sending facilities from within Emacs. It is
27;; documented in the Emacs user's manual.
28
e5167999 29;;; Code:
e758216c 30(require 'mail-utils)
be0b8d69 31
b8d747b9 32(require 'rfc2047)
67ad9438 33
0b5bb3ec
SE
34(defgroup sendmail nil
35 "Mail sending commands for Emacs."
36 :prefix "mail-"
37 :group 'mail)
20a8832d 38
1938b566
RS
39(defcustom mail-setup-with-from t
40 "Non-nil means insert `From:' field when setting up the message."
1287f53f 41 :type 'boolean
1938b566
RS
42 :group 'sendmail
43 :version "22.1")
44
82695714 45(defcustom sendmail-program
8340026c
GM
46 (or (executable-find "sendmail")
47 (cond
48 ((file-exists-p "/usr/sbin/sendmail") "/usr/sbin/sendmail")
49 ((file-exists-p "/usr/lib/sendmail") "/usr/lib/sendmail")
50 ((file-exists-p "/usr/ucblib/sendmail") "/usr/ucblib/sendmail")
c136e5cd 51 (t "sendmail")))
82695714 52 "Program used to send messages."
c136e5cd 53 :version "24.1" ; add executable-find, remove fakemail
82695714
CY
54 :group 'mail
55 :type 'file)
56
ea9ceb34 57;;;###autoload
0b8ee421 58(defcustom mail-from-style 'default
95fe848e 59 "Specifies how \"From:\" fields look.
ea9ceb34
KH
60
61If `nil', they contain just the return address like:
62 king@grassland.com
63If `parens', they look like:
64 king@grassland.com (Elvis Parsley)
65If `angles', they look like:
cc674186 66 Elvis Parsley <king@grassland.com>
0b8ee421
CY
67
68Otherwise, most addresses look like `angles', but they look like
69`parens' if `angles' would need quoting and `parens' would not."
70 ;; The value `system-default' is now deprecated.
71 :type '(choice (const :tag "simple" nil)
72 (const parens)
73 (const angles)
74 (const default))
2a42d160 75 :version "20.3"
0b5bb3ec 76 :group 'sendmail)
ea9ceb34 77
32afb744 78;;;###autoload
3d04071d 79(defcustom mail-specify-envelope-from nil
95fe848e 80 "If non-nil, specify the envelope-from address when sending mail.
c1a1fd60 81The value used to specify it is whatever is found in
6b61353c 82the variable `mail-envelope-from', with `user-mail-address' as fallback.
32afb744 83
01bb608e 84On most systems, specifying the envelope-from address is a
6b61353c
KH
85privileged operation. This variable affects sendmail and
86smtpmail -- if you use feedmail to send mail, see instead the
87variable `feedmail-deduce-envelope-from'."
32afb744
KH
88 :version "21.1"
89 :type 'boolean
90 :group 'sendmail)
91
c1a1fd60 92(defcustom mail-envelope-from nil
95fe848e 93 "If non-nil, designate the envelope-from address when sending mail.
01bb608e
GM
94This only has an effect if `mail-specify-envelope-from' is non-nil.
95The value should be either a string, or the symbol `header' (in
96which case the contents of the \"From\" header of the message
97being sent is used), or nil (in which case the value of
98`user-mail-address' is used)."
c1a1fd60 99 :version "21.1"
00417fac 100 :type '(choice (string :tag "From-name")
56e5818f 101 (const :tag "Use From: header from message" header)
00417fac 102 (const :tag "Use `user-mail-address'" nil))
c1a1fd60
GM
103 :group 'sendmail)
104
20a8832d 105;;;###autoload
95fe848e
SM
106(defcustom mail-self-blind nil
107 "Non-nil means insert BCC to self in messages to be sent.
20a8832d 108This is done when the message is initialized,
0b5bb3ec
SE
109so you can remove or alter the BCC field to override the default."
110 :type 'boolean
111 :group 'sendmail)
20a8832d
RS
112
113;;;###autoload
10b6d5c4
SM
114(defcustom mail-interactive t
115 ;; We used to use a default of nil rather than t, but nowadays it is very
116 ;; common for sendmail to be misconfigured, so one cannot rely on the
117 ;; bounce message to be delivered anywhere, least of all to the
118 ;; user's mailbox.
95fe848e 119 "Non-nil means when sending a message wait for and display errors.
87ede499 120Otherwise, let mailer send back a message to report errors."
0b5bb3ec 121 :type 'boolean
c2457e54 122 :version "23.1" ; changed from nil to t
0b5bb3ec 123 :group 'sendmail)
20a8832d 124
95fe848e
SM
125(defcustom mail-yank-ignored-headers
126 (concat "^"
127 (regexp-opt '("via" "mail-from" "origin" "status" "remailed"
128 "received" "message-id" "summary-line" "to" "subject"
129 "in-reply-to" "return-path" "mail-reply-to"
87ede499
GM
130 ;; Should really be rmail-attribute-header and
131 ;; rmail-keyword-header, but this file does not
132 ;; require rmail (at run time).
133 "x-rmail-attributes" "x-rmail-keywords"
95fe848e
SM
134 "mail-followup-to") "\\(?:")
135 ":")
136 "Delete these headers from old message when it's inserted in a reply."
0b5bb3ec 137 :type 'regexp
87ede499
GM
138 :group 'sendmail
139 :version "23.1")
20a8832d
RS
140
141;; Useful to set in site-init.el
142;;;###autoload
a120bde9
SM
143(defcustom send-mail-function
144 ;; Assume smtpmail is the preferred choice if it's already configured.
145 (if (and (boundp 'smtpmail-smtp-server)
146 smtpmail-smtp-server)
147 'smtpmail-send-it 'sendmail-query-once)
67ad9438 148 "Function to call to send the current buffer as mail.
51d541d4 149The headers should be delimited by a line which is
e04233aa
GM
150not a valid RFC822 header or continuation line,
151that matches the variable `mail-header-separator'.
67ad9438
DL
152This is used by the default mail-sending commands. See also
153`message-send-mail-function' for use with the Message package."
c5dfddb6 154 :type '(radio (function-item sendmail-send-it :tag "Use Sendmail package")
2f31f37a 155 (function-item sendmail-query-once :tag "Query the user")
c5dfddb6
DL
156 (function-item smtpmail-send-it :tag "Use SMTPmail package")
157 (function-item feedmail-send-it :tag "Use Feedmail package")
5c290b9e 158 (function-item mailclient-send-it :tag "Use Mailclient package")
40fa0008 159 function)
f0691d22 160 :version "24.1"
40fa0008 161 :group 'sendmail)
20a8832d
RS
162
163;;;###autoload
a7610c52 164(defcustom mail-header-separator (purecopy "--text follows this line--")
95fe848e 165 "Line used to separate headers from text in messages being composed."
0b5bb3ec
SE
166 :type 'string
167 :group 'sendmail)
20a8832d 168
6737ae74
RS
169;; Set up mail-header-separator for use as a category text property.
170(put 'mail-header-separator 'rear-nonsticky '(category))
95fe848e
SM
171;; This was a nice idea, for preventing accidental modification of
172;; the separator. But I found it also prevented or obstructed
173;; certain deliberate operations, such as copying the separator line
174;; up to the top to send myself a copy of an already sent outgoing message
175;; and other things. So I turned it off. --rms.
176;;(put 'mail-header-separator 'read-only t)
6737ae74 177
20a8832d 178;;;###autoload
95fe848e
SM
179(defcustom mail-archive-file-name nil
180 "Name of file to write all outgoing messages in, or nil for none.
0462d019
GM
181This is normally an mbox file, but for backwards compatibility may also
182be a Babyl file."
0b5bb3ec
SE
183 :type '(choice file (const nil))
184 :group 'sendmail)
20a8832d 185
fe8c32a6 186;;;###autoload
0b5bb3ec 187(defcustom mail-default-reply-to nil
95fe848e 188 "Address to insert as default Reply-to field of outgoing messages.
6da74aab 189If nil, it will be initialized from the REPLYTO environment variable
0b5bb3ec
SE
190when you first send mail."
191 :type '(choice (const nil) string)
192 :group 'sendmail)
20a8832d 193
0b5bb3ec 194(defcustom mail-alias-file nil
e758216c 195 "If non-nil, the name of a file to use instead of the sendmail default.
20a8832d
RS
196This file defines aliases to be expanded by the mailer; this is a different
197feature from that of defining aliases in `.mailrc' to be expanded in Emacs.
e758216c
GM
198This variable has no effect unless your system uses sendmail as its mailer.
199The default file is defined in sendmail's configuration file, e.g.
200`/etc/aliases'."
201 :type '(choice (const :tag "Sendmail default" nil) file)
0b5bb3ec 202 :group 'sendmail)
20a8832d 203
8790b698 204;;;###autoload
a7610c52 205(defcustom mail-personal-alias-file (purecopy "~/.mailrc")
95fe848e 206 "If non-nil, the name of the user's personal mail alias file.
8790b698
NF
207This file typically should be in same format as the `.mailrc' file used by
208the `Mail' or `mailx' program.
0b5bb3ec
SE
209This file need not actually exist."
210 :type '(choice (const nil) file)
211 :group 'sendmail)
8790b698 212
214d5640 213;;;###autoload
0b5bb3ec 214(defcustom mail-setup-hook nil
28f57f7e 215 "Normal hook, run each time a new outgoing message is initialized."
0b5bb3ec 216 :type 'hook
f70de9d4 217 :options '(fortune-to-signature spook mail-abbrevs-setup)
0b5bb3ec 218 :group 'sendmail)
8b262cbc 219
214d5640 220;;;###autoload
5ef9d627 221(defvar mail-aliases t
ade349a0 222 "Alist of mail address aliases,
de01bf7d 223or t meaning should be initialized from your mail aliases file.
6b61353c
KH
224\(The file's name is normally `~/.mailrc', but `mail-personal-alias-file'
225can specify a different file name.)
de01bf7d 226The alias definitions in the file have this form:
ade349a0 227 alias ALIAS MEANING")
5ef9d627 228
9cc75191 229(defvar mail-alias-modtime nil
de01bf7d 230 "The modification time of your mail alias file when it was last examined.")
9cc75191 231
214d5640 232;;;###autoload
0b8ee421 233(defcustom mail-yank-prefix "> "
95fe848e 234 "Prefix insert on lines of yanked message being replied to.
e009b596 235If this is nil, use indentation, as specified by `mail-indentation-spaces'."
0b5bb3ec
SE
236 :type '(choice (const nil) string)
237 :group 'sendmail)
238
214d5640 239;;;###autoload
0b5bb3ec 240(defcustom mail-indentation-spaces 3
95fe848e 241 "Number of spaces to insert at the beginning of each cited line.
0b5bb3ec
SE
242Used by `mail-yank-original' via `mail-indent-citation'."
243 :type 'integer
244 :group 'sendmail)
214d5640 245
fa24a822 246(defvar mail-yank-hooks nil
015c5c55
RS
247 "Obsolete hook for modifying a citation just inserted in the mail buffer.
248Each hook function can find the citation between (point) and (mark t).
249And each hook function should leave point and mark around the citation
250text as modified.
015c5c55 251This is a normal hook, misnamed for historical reasons.
d1069532
SM
252It is obsolete and mail agents should no longer use it.")
253(make-obsolete-variable 'mail-yank-hooks 'mail-citation-hook "19.34")
015c5c55 254
3ca0be33 255;;;###autoload
0b5bb3ec 256(defcustom mail-citation-hook nil
95fe848e 257 "Hook for modifying a citation just inserted in the mail buffer.
d6bccf09
RS
258Each hook function can find the citation between (point) and (mark t),
259and should leave point and mark around the citation text as modified.
260The hook functions can find the header of the cited message
261in the variable `mail-citation-header', whether or not this is included
262in the cited portion of the message.
1c24b04a 263
015c5c55 264If this hook is entirely empty (nil), a default action is taken
0b5bb3ec
SE
265instead of no action."
266 :type 'hook
267 :group 'sendmail)
20a8832d 268
d6bccf09
RS
269(defvar mail-citation-header nil
270 "While running `mail-citation-hook', this variable holds the message header.
271This enables the hook functions to see the whole message header
272regardless of what part of it (if any) is included in the cited text.")
273
214d5640 274;;;###autoload
0b8ee421 275(defcustom mail-citation-prefix-regexp
e0a185ae 276 (purecopy "\\([ \t]*\\(\\w\\|[_.]\\)+>+\\|[ \t]*[]>|]\\)+")
95fe848e 277 "Regular expression to match a citation prefix plus whitespace.
706e3d85
RS
278It should match whatever sort of citation prefixes you want to handle,
279with whitespace before and after; it should also match just whitespace.
280The default value matches citations like `foo-bar>' plus whitespace."
281 :type 'regexp
282 :group 'sendmail
e0a185ae 283 :version "24.1")
706e3d85 284
20a8832d 285(defvar mail-abbrevs-loaded nil)
95fe848e
SM
286(defvar mail-mode-map
287 (let ((map (make-sparse-keymap)))
daca8ba5 288 (define-key map "\M-\t" 'completion-at-point)
95fe848e
SM
289 (define-key map "\C-c?" 'describe-mode)
290 (define-key map "\C-c\C-f\C-t" 'mail-to)
291 (define-key map "\C-c\C-f\C-b" 'mail-bcc)
292 (define-key map "\C-c\C-f\C-f" 'mail-fcc)
293 (define-key map "\C-c\C-f\C-c" 'mail-cc)
294 (define-key map "\C-c\C-f\C-s" 'mail-subject)
295 (define-key map "\C-c\C-f\C-r" 'mail-reply-to)
296 (define-key map "\C-c\C-f\C-a" 'mail-mail-reply-to) ; author
297 (define-key map "\C-c\C-f\C-l" 'mail-mail-followup-to) ; list
298 (define-key map "\C-c\C-t" 'mail-text)
299 (define-key map "\C-c\C-y" 'mail-yank-original)
300 (define-key map "\C-c\C-r" 'mail-yank-region)
301 (define-key map [remap split-line] 'mail-split-line)
302 (define-key map "\C-c\C-q" 'mail-fill-yanked-message)
303 (define-key map "\C-c\C-w" 'mail-signature)
95fe848e
SM
304 (define-key map "\C-c\C-c" 'mail-send-and-exit)
305 (define-key map "\C-c\C-s" 'mail-send)
529c06b6 306 (define-key map "\C-c\C-i" 'mail-insert-file)
e009b596
GM
307 ;; FIXME add this? "b" = bury buffer. It's in the menu-bar.
308;;; (define-key map "\C-c\C-b" 'mail-dont-send)
95fe848e
SM
309
310 (define-key map [menu-bar mail]
311 (cons "Mail" (make-sparse-keymap "Mail")))
312
767d420a
EZ
313 (define-key map [menu-bar mail attachment]
314 '("Attach File" . mail-add-attachment))
315
95fe848e
SM
316 (define-key map [menu-bar mail fill]
317 '("Fill Citation" . mail-fill-yanked-message))
318
319 (define-key map [menu-bar mail yank]
e009b596 320 '(menu-item "Cite Original" mail-yank-original :enable mail-reply-action))
95fe848e
SM
321
322 (define-key map [menu-bar mail signature]
323 '("Insert Signature" . mail-signature))
324
325 (define-key map [menu-bar mail mail-sep]
326 '("--"))
327
328 (define-key map [menu-bar mail cancel]
329 '("Cancel" . mail-dont-send))
330
331 (define-key map [menu-bar mail send-stay]
332 '("Send, Keep Editing" . mail-send))
333
334 (define-key map [menu-bar mail send]
335 '("Send Message" . mail-send-and-exit))
336
337 (define-key map [menu-bar headers]
338 (cons "Headers" (make-sparse-keymap "Move to Header")))
339
340 (define-key map [menu-bar headers text]
341 '("Text" . mail-text))
342
343 (define-key map [menu-bar headers expand-aliases]
344 '("Expand Aliases" . expand-mail-aliases))
345
95fe848e 346 (define-key map [menu-bar headers mail-reply-to]
e009b596 347 '("Mail-Reply-To" . mail-mail-reply-to))
95fe848e
SM
348
349 (define-key map [menu-bar headers mail-followup-to]
e009b596 350 '("Mail-Followup-To" . mail-mail-followup-to))
95fe848e
SM
351
352 (define-key map [menu-bar headers reply-to]
353 '("Reply-To" . mail-reply-to))
354
355 (define-key map [menu-bar headers bcc]
356 '("Bcc" . mail-bcc))
357
358 (define-key map [menu-bar headers fcc]
359 '("Fcc" . mail-fcc))
360
361 (define-key map [menu-bar headers cc]
362 '("Cc" . mail-cc))
363
364 (define-key map [menu-bar headers subject]
365 '("Subject" . mail-subject))
366
367 (define-key map [menu-bar headers to]
368 '("To" . mail-to))
369
370 map))
20a8832d 371
5ef9d627 372(autoload 'build-mail-aliases "mailalias"
82445062 373 "Read mail aliases from personal aliases file and set `mail-aliases'.
53aff12a 374By default, this is the file specified by `mail-personal-alias-file'." t)
5ef9d627 375
ef15f270 376;;;###autoload
0b8ee421 377(defcustom mail-signature t
95fe848e 378 "Text inserted at end of mail buffer when a message is initialized.
f13c1dae
RS
379If t, it means to insert the contents of the file `mail-signature-file'.
380If a string, that string is inserted.
381 (To make a proper signature, the string should begin with \\n\\n-- \\n,
382 which is the standard way to delimit a signature in a message.)
383Otherwise, it should be an expression; it is evaluated
384and should insert whatever you want to insert."
eb1213c1 385 :type '(choice (const :tag "None" nil)
f13c1dae
RS
386 (const :tag "Use `.signature' file" t)
387 (string :tag "String to insert")
388 (sexp :tag "Expression to evaluate"))
0b5bb3ec 389 :group 'sendmail)
f13c1dae 390(put 'mail-signature 'risky-local-variable t)
4ac2e032 391
214d5640 392;;;###autoload
1e8780b1 393(defcustom mail-signature-file (purecopy "~/.signature")
95fe848e 394 "File containing the text inserted at end of mail buffer."
0b5bb3ec
SE
395 :type 'file
396 :group 'sendmail)
20a8832d 397
eb1213c1 398;;;###autoload
1e8780b1 399(defcustom mail-default-directory (purecopy "~/")
03ffe8be
CY
400 "Value of `default-directory' for Mail mode buffers.
401This directory is used for auto-save files of Mail mode buffers.
402
403Note that Message mode does not use this variable; it auto-saves
404in `message-auto-save-directory'."
eb1213c1 405 :type '(directory :tag "Directory")
65280ff3 406 :group 'sendmail
bf247b6e 407 :version "22.1")
eb1213c1 408
c8553837 409(defvar mail-reply-action nil)
20a8832d
RS
410(defvar mail-send-actions nil
411 "A list of actions to be performed upon successful sending of a message.")
25ca2e61 412(defvar mail-return-action nil)
20a8832d 413
214d5640 414;;;###autoload
0b5bb3ec 415(defcustom mail-default-headers nil
95fe848e 416 "A string containing header lines, to be inserted in outgoing messages.
0462d019
GM
417It can contain newlines, and should end in one. It is inserted
418before you edit the message, so you can edit or delete the lines."
0b5bb3ec
SE
419 :type '(choice (const nil) string)
420 :group 'sendmail)
20a8832d 421
0b5bb3ec 422(defcustom mail-bury-selects-summary t
04ca017c 423 "If non-nil, try to show Rmail summary buffer after returning from mail.
1f7850dd 424The functions \\[mail-send-on-exit] or \\[mail-dont-send] select
04ca017c 425the Rmail summary buffer before returning, if it exists and this variable
0b5bb3ec
SE
426is non-nil."
427 :type 'boolean
428 :group 'sendmail)
1f7850dd 429
baaa1f19 430(defcustom mail-send-nonascii 'mime
95fe848e 431 "Specify whether to allow sending non-ASCII characters in mail.
34153d76
RS
432If t, that means do allow it. nil means don't allow it.
433`query' means ask the user each time.
baaa1f19
GM
434`mime' means add an appropriate MIME header if none already present.
435The default is `mime'.
34153d76 436Including non-ASCII characters in a mail message can be problematical
0b5bb3ec 437for the recipient, who may not know how to decode them properly."
baaa1f19 438 :type '(choice (const t) (const nil) (const query) (const mime))
0b5bb3ec 439 :group 'sendmail)
34153d76 440
0b0b4ce7 441(defcustom mail-use-dsn nil
95fe848e 442 "Ask MTA for notification of failed, delayed or successful delivery.
0b0b4ce7
RS
443Note that only some MTAs (currently only recent versions of Sendmail)
444support Delivery Status Notification."
445 :group 'sendmail
446 :type '(repeat (radio (const :tag "Failure" failure)
447 (const :tag "Delay" delay)
448 (const :tag "Success" success)))
bf247b6e 449 :version "22.1")
0b0b4ce7 450
7c203051
RS
451;; Note: could use /usr/ucb/mail instead of sendmail;
452;; options -t, and -v if not interactive.
e758216c 453(defvar mail-mailer-swallows-blank-line nil
7c203051 454 "Set this non-nil if the system's mailer runs the header and body together.
e758216c
GM
455The actual value should be an expression to evaluate that returns
456non-nil if the problem will actually occur.
457\(As far as we know, this is not an issue on any system still supported
458by Emacs.)")
459
460(put 'mail-mailer-swallows-blank-line 'risky-local-variable t) ; gets evalled
461(make-obsolete-variable 'mail-mailer-swallows-blank-line
2403c841
SM
462 "no need to set this on any modern system."
463 "24.1" 'set)
7c203051 464
f81b71c7 465(defvar mail-mode-syntax-table
87ede499 466 ;; define-derived-mode will make it inherit from text-mode-syntax-table.
f81b71c7 467 (let ((st (make-syntax-table)))
87ede499
GM
468 ;; FIXME this is probably very obsolete now ("percent hack").
469 ;; sending.texi used to say:
470 ;; Mail mode defines the character `%' as a word separator; this
471 ;; is helpful for using the word commands to edit mail addresses.
f81b71c7
SM
472 (modify-syntax-entry ?% ". " st)
473 st)
474 "Syntax table used while in `mail-mode'.")
20a8832d 475
8b1f1a0c 476(defvar mail-font-lock-keywords
70a302f8 477 (eval-when-compile
f1052d2e 478 (let* ((cite-chars "[>|}]")
0eafc06c 479 (cite-prefix "[:alpha:]")
f1052d2e 480 (cite-suffix (concat cite-prefix "0-9_.@-`'\"")))
3d51068d 481 (list '("^\\(To\\|Newsgroups\\):" . font-lock-function-name-face)
3ca0be33 482 '("^\\(B?CC\\|Reply-to\\|Mail-\\(reply\\|followup\\)-to\\):" . font-lock-keyword-face)
70a302f8 483 '("^\\(Subject:\\)[ \t]*\\(.+\\)?"
b795df2b
RS
484 (1 font-lock-comment-face)
485;; (2 font-lock-type-face nil t)
486 )
f1052d2e 487 ;; Use EVAL to delay in case `mail-header-separator' gets changed.
3d51068d 488 '(eval .
e69d810c 489 (let ((separator (if (zerop (length mail-header-separator))
8646fe22 490 " \\`\\' "
e69d810c
SM
491 (regexp-quote mail-header-separator))))
492 (cons (concat "^" separator "$") 'font-lock-warning-face)))
f1052d2e
SM
493 ;; Use MATCH-ANCHORED to effectively anchor the regexp left side.
494 `(,cite-chars
495 (,(concat "\\=[ \t]*"
d2f29015
RS
496 "\\(\\(\\([" cite-prefix "]+[" cite-suffix "]*\\)?"
497 "\\(" cite-chars "[ \t]*\\)\\)+\\)"
3d51068d 498 "\\(.*\\)")
f1052d2e 499 (beginning-of-line) (end-of-line)
d2f29015
RS
500 (1 font-lock-comment-delimiter-face nil t)
501 (5 font-lock-comment-face nil t)))
c034acdf 502 '("^\\(X-[A-Za-z0-9-]+\\|In-reply-to\\):.*\\(\n[ \t]+.*\\)*$"
70a302f8 503 . font-lock-string-face))))
8b1f1a0c
RS
504 "Additional expressions to highlight in Mail mode.")
505
5b6575b7 506\f
2784c434
CY
507;;;###autoload
508(defun sendmail-query-once ()
509 "Query for `send-mail-function' and send mail with it.
510This also saves the value of `send-mail-function' via Customize."
a120bde9
SM
511 ;; If send-mail-function is already setup, we're incorrectly called
512 ;; a second time, probably because someone's using an old value
513 ;; of send-mail-function.
514 (when (eq send-mail-function 'sendmail-query-once)
cc26d239
LI
515 (sendmail-query-user-about-smtp))
516 (funcall send-mail-function))
517
518(defun sendmail-query-user-about-smtp ()
519 (let* ((options `(("mail client" . mailclient-send-it)
520 ,@(when (and sendmail-program
521 (executable-find sendmail-program))
522 '(("transport" . sendmail-send-it)))
523 ("smtp" . smtpmail-send-it)))
524 (choice
525 ;; Query the user.
526 (with-temp-buffer
527 (rename-buffer "*Emacs Mail Setup Help*" t)
528 (insert "\
6bbfa6e1
CY
529 Emacs is about to send an email message, but it has not been
530 configured for sending email. To tell Emacs how to send email:
531
532 - Type `"
cc26d239
LI
533 (propertize "mail client" 'face 'bold)
534 "' to start your default email client and
6bbfa6e1 535 pass it the message text.\n\n")
cc26d239
LI
536 (and sendmail-program
537 (executable-find sendmail-program)
538 (insert "\
6bbfa6e1 539 - Type `"
cc26d239
LI
540 (propertize "transport" 'face 'bold)
541 "' to invoke the system's mail transport agent
6bbfa6e1 542 (the `"
cc26d239
LI
543 sendmail-program
544 "' program).\n\n"))
545 (insert "\
6bbfa6e1 546 - Type `"
cc26d239
LI
547 (propertize "smtp" 'face 'bold)
548 "' to send mail directly to an \"outgoing mail\" server.
6bbfa6e1 549 (Emacs may prompt you for SMTP settings).
186f4720 550
6bbfa6e1
CY
551 Emacs will record your selection and will use it thereafter.
552 To change it later, customize the option `send-mail-function'.\n")
cc26d239
LI
553 (goto-char (point-min))
554 (display-buffer (current-buffer))
555 (let ((completion-ignore-case t))
556 (completing-read "Send mail via: "
557 options nil 'require-match)))))
558 (customize-save-variable 'send-mail-function
559 (cdr (assoc-string choice options t)))))
2784c434 560\f
1498db18 561(defun sendmail-sync-aliases ()
6b61353c
KH
562 (when mail-personal-alias-file
563 (let ((modtime (nth 5 (file-attributes mail-personal-alias-file))))
564 (or (equal mail-alias-modtime modtime)
565 (setq mail-alias-modtime modtime
566 mail-aliases t)))))
9cc75191 567
25ca2e61
CY
568\f
569;;;###autoload
570(define-mail-user-agent 'sendmail-user-agent
571 'sendmail-user-agent-compose
572 'mail-send-and-exit)
573
574;;;###autoload
575(defun sendmail-user-agent-compose (&optional to subject other-headers
576 continue switch-function yank-action
577 send-actions return-action
578 &rest ignored)
579 (if switch-function
3199b96f 580 (funcall switch-function "*mail*"))
25ca2e61
CY
581 (let ((cc (cdr (assoc-string "cc" other-headers t)))
582 (in-reply-to (cdr (assoc-string "in-reply-to" other-headers t)))
583 (body (cdr (assoc-string "body" other-headers t))))
584 (or (mail continue to subject in-reply-to cc yank-action
585 send-actions return-action)
586 continue
587 (error "Message aborted"))
588 (save-excursion
589 (rfc822-goto-eoh)
590 (while other-headers
591 (unless (member-ignore-case (car (car other-headers))
592 '("in-reply-to" "cc" "body"))
593 (insert (car (car other-headers)) ": "
594 (cdr (car other-headers))
595 (if use-hard-newlines hard-newline "\n")))
596 (setq other-headers (cdr other-headers)))
597 (when body
598 (forward-line 1)
599 (insert body))
600 t)))
601
602(defun mail-setup (to subject in-reply-to cc replybuffer
603 actions return-action)
235c2d35 604 (or mail-default-reply-to
810163a3 605 (setq mail-default-reply-to (getenv "REPLYTO")))
1498db18 606 (sendmail-sync-aliases)
e758216c
GM
607 (when (eq mail-aliases t)
608 (setq mail-aliases nil)
609 (and mail-personal-alias-file
610 (file-exists-p mail-personal-alias-file)
611 (build-mail-aliases)))
2813dcb9 612 ;; Don't leave this around from a previous message.
f8081291 613 (kill-local-variable 'buffer-file-coding-system)
9be82109
KH
614 ;; This doesn't work for enable-multibyte-characters.
615 ;; (kill-local-variable 'enable-multibyte-characters)
597e2240 616 (set-buffer-multibyte (default-value 'enable-multibyte-characters))
8881c1ab 617 (if current-input-method
72b255c7 618 (deactivate-input-method))
25ca2e61
CY
619
620 ;; Local variables for Mail mode.
20a8832d 621 (setq mail-send-actions actions)
c8553837 622 (setq mail-reply-action replybuffer)
25ca2e61
CY
623 (setq mail-return-action return-action)
624
20a8832d 625 (goto-char (point-min))
1938b566
RS
626 (if mail-setup-with-from
627 (mail-insert-from-field))
20a8832d
RS
628 (insert "To: ")
629 (save-excursion
630 (if to
70ca75ae
RS
631 ;; Here removed code to extract names from within <...>
632 ;; on the assumption that mail-strip-quoted-names
633 ;; has been called and has done so.
634 (let ((fill-prefix "\t")
635 (address-start (point)))
20a8832d 636 (insert to "\n")
118a3c04
RS
637 (fill-region-as-paragraph address-start (point-max))
638 (goto-char (point-max))
639 (unless (bolp)
640 (newline)))
20a8832d
RS
641 (newline))
642 (if cc
70ca75ae
RS
643 (let ((fill-prefix "\t")
644 (address-start (progn (insert "CC: ") (point))))
645 (insert cc "\n")
118a3c04
RS
646 (fill-region-as-paragraph address-start (point-max))
647 (goto-char (point-max))
648 (unless (bolp)
649 (newline))))
20a8832d 650 (if in-reply-to
118a3c04 651 (let ((fill-prefix "\t")
58cabff0 652 (fill-column 78)
34046d66
RS
653 (address-start (point)))
654 (insert "In-reply-to: " in-reply-to "\n")
118a3c04
RS
655 (fill-region-as-paragraph address-start (point-max))
656 (goto-char (point-max))
657 (unless (bolp)
658 (newline))))
20a8832d
RS
659 (insert "Subject: " (or subject "") "\n")
660 (if mail-default-headers
661 (insert mail-default-headers))
662 (if mail-default-reply-to
663 (insert "Reply-to: " mail-default-reply-to "\n"))
664 (if mail-self-blind
22c03d39 665 (insert "BCC: " user-mail-address "\n"))
20a8832d
RS
666 (if mail-archive-file-name
667 (insert "FCC: " mail-archive-file-name "\n"))
6737ae74
RS
668 (put-text-property (point)
669 (progn
670 (insert mail-header-separator "\n")
671 (1- (point)))
672 'category 'mail-header-separator)
874bdb5a
RS
673 ;; Insert the signature. But remember the beginning of the message.
674 (if to (setq to (point)))
87ede499 675 (if mail-signature (mail-signature t))
20a8832d
RS
676 (goto-char (point-max))
677 (or (bolp) (newline)))
874bdb5a 678 (if to (goto-char to))
20a8832d
RS
679 (or to subject in-reply-to
680 (set-buffer-modified-p nil))
681 (run-hooks 'mail-setup-hook))
5b6575b7 682\f
be0b8d69 683(defcustom mail-mode-hook nil
b769f3da
GM
684 "Hook run by Mail mode.
685When composing a mail, this runs immediately after creating, or
686switching to, the `*mail*' buffer. See also `mail-setup-hook'."
be0b8d69
DL
687 :group 'sendmail
688 :type 'hook
689 :options '(footnote-mode))
690
567bb3dd 691(defvar mail-mode-abbrev-table text-mode-abbrev-table)
fd59d131 692(defvar mail-encode-mml)
20a8832d 693;;;###autoload
f81b71c7 694(define-derived-mode mail-mode text-mode "Mail"
20a8832d
RS
695 "Major mode for editing mail to be sent.
696Like Text Mode but with these additional commands:
e8f4db18
RS
697
698\\[mail-send] mail-send (send the message)
699\\[mail-send-and-exit] mail-send-and-exit (send the message and exit)
700
d3db616e 701Here are commands that move to a header field (and create it if there isn't):
5d838629
CY
702 \\[mail-to] move to To: \\[mail-subject] move to Subj:
703 \\[mail-bcc] move to BCC: \\[mail-cc] move to CC:
0678d779 704 \\[mail-fcc] move to FCC: \\[mail-reply-to] move to Reply-To:
3ca0be33
RS
705 \\[mail-mail-reply-to] move to Mail-Reply-To:
706 \\[mail-mail-followup-to] move to Mail-Followup-To:
5d838629 707\\[mail-text] move to message text.
d3db616e
KH
708\\[mail-signature] mail-signature (insert `mail-signature-file' file).
709\\[mail-yank-original] mail-yank-original (insert current message, in Rmail).
710\\[mail-fill-yanked-message] mail-fill-yanked-message (fill what was yanked).
c3760c17
EZ
711\\[mail-insert-file] insert a text file into the message.
712\\[mail-add-attachment] attach to the message a file as binary attachment.
4deb3ba9
EZ
713Turning on Mail mode runs the normal hooks `text-mode-hook' and
714`mail-mode-hook' (in that order)."
c8553837 715 (make-local-variable 'mail-reply-action)
20a8832d 716 (make-local-variable 'mail-send-actions)
25ca2e61 717 (make-local-variable 'mail-return-action)
fd59d131
EZ
718 (make-local-variable 'mail-encode-mml)
719 (setq mail-encode-mml nil)
20a8832d 720 (setq buffer-offer-save t)
2667df42 721 (make-local-variable 'font-lock-defaults)
117e4b0c 722 (setq font-lock-defaults '(mail-font-lock-keywords t t))
20a8832d 723 (make-local-variable 'paragraph-separate)
5b6575b7
RS
724 (make-local-variable 'normal-auto-fill-function)
725 (setq normal-auto-fill-function 'mail-mode-auto-fill)
b5682230 726 (make-local-variable 'fill-paragraph-function)
c8553837 727 (setq fill-paragraph-function 'mail-mode-fill-paragraph)
eba52a1a
MB
728 ;; Allow using comment commands to add/remove quoting (this only does
729 ;; anything if mail-yank-prefix is set to a non-nil value).
730 (set (make-local-variable 'comment-start) mail-yank-prefix)
6b61353c
KH
731 (if mail-yank-prefix
732 (set (make-local-variable 'comment-start-skip)
733 (concat "^" (regexp-quote mail-yank-prefix) "[ \t]*")))
1b8def58 734 (make-local-variable 'adaptive-fill-regexp)
04e74403 735 ;; Also update the paragraph-separate entry if you change this.
1b8def58 736 (setq adaptive-fill-regexp
567a1c29 737 (concat "[ \t]*[-[:alnum:]]+>+[ \t]*\\|"
f81b71c7 738 adaptive-fill-regexp))
d78f466f 739 (make-local-variable 'adaptive-fill-first-line-regexp)
f03ca5f5 740 (setq adaptive-fill-first-line-regexp
40035487 741 (concat "[ \t]*[-[:alnum:]]*>+[ \t]*\\|"
f81b71c7 742 adaptive-fill-first-line-regexp))
daca8ba5
SM
743 (add-hook 'completion-at-point-functions #'mail-completion-at-point-function
744 nil 'local)
df0d89b1
RS
745 ;; `-- ' precedes the signature. `-----' appears at the start of the
746 ;; lines that delimit forwarded messages.
747 ;; Lines containing just >= 3 dashes, perhaps after whitespace,
748 ;; are also sometimes used and should be separators.
328f984d
GM
749 (setq paragraph-separate
750 (concat (regexp-quote mail-header-separator)
403993a8
GM
751 ;; This is based on adaptive-fill-regexp (presumably
752 ;; the idea is to allow navigation etc of cited paragraphs).
328f984d
GM
753 "$\\|\t*[-–!|#%;>*·•‣⁃◦ ]+$"
754 "\\|[ \t]*[-[:alnum:]]*>+[ \t]*$\\|[ \t]*$\\|"
755 "--\\( \\|-+\\)$\\|"
756 page-delimiter)))
5b6575b7 757
51d541d4
RS
758
759(defun mail-header-end ()
760 "Return the buffer location of the end of headers, as a number."
66191b7e
RS
761 (save-restriction
762 (widen)
763 (save-excursion
764 (rfc822-goto-eoh)
765 (point))))
51d541d4
RS
766
767(defun mail-text-start ()
768 "Return the buffer location of the start of text, as a number."
66191b7e
RS
769 (save-restriction
770 (widen)
771 (save-excursion
772 (rfc822-goto-eoh)
773 (forward-line 1)
774 (point))))
51d541d4
RS
775
776(defun mail-sendmail-delimit-header ()
777 "Set up whatever header delimiter convention sendmail will use.
778Concretely: replace the first blank line in the header with the separator."
779 (rfc822-goto-eoh)
780 (insert mail-header-separator)
781 (point))
782
783(defun mail-sendmail-undelimit-header ()
784 "Remove header separator to put the message in correct form for sendmail.
785Leave point at the start of the delimiter line."
786 (rfc822-goto-eoh)
787 (delete-region (point) (progn (end-of-line) (point))))
788
5b6575b7
RS
789(defun mail-mode-auto-fill ()
790 "Carry out Auto Fill for Mail mode.
791If within the headers, this makes the new lines into continuation lines."
51d541d4 792 (if (< (point) (mail-header-end))
5ed619e0 793 (let ((old-line-start (line-beginning-position)))
5b6575b7
RS
794 (if (do-auto-fill)
795 (save-excursion
796 (beginning-of-line)
797 (while (not (eq (point) old-line-start))
28afe199
RS
798 ;; Use insert-before-markers in case we're inserting
799 ;; before the saved value of point (which is common).
800 (insert-before-markers " ")
5b6575b7
RS
801 (forward-line -1))
802 t)))
803 (do-auto-fill)))
c8553837
RS
804
805(defun mail-mode-fill-paragraph (arg)
806 ;; Do something special only if within the headers.
51d541d4 807 (if (< (point) (mail-header-end))
a1506d29 808 (let (beg end fieldname)
8fcbbf7d
GM
809 (when (prog1 (re-search-backward "^[-a-zA-Z]+:" nil 'yes)
810 (setq beg (point)))
c8553837 811 (setq fieldname
8fcbbf7d 812 (downcase (buffer-substring beg (1- (match-end 0))))))
c8553837
RS
813 (forward-line 1)
814 ;; Find continuation lines and get rid of their continuation markers.
815 (while (looking-at "[ \t]")
816 (delete-horizontal-space)
817 (forward-line 1))
818 (setq end (point-marker))
819 (goto-char beg)
820 ;; If this field contains addresses,
821 ;; make sure we can fill after each address.
822 (if (member fieldname
823 '("to" "cc" "bcc" "from" "reply-to"
3ca0be33 824 "mail-reply-to" "mail-followup-to"
c8553837
RS
825 "resent-to" "resent-cc" "resent-bcc"
826 "resent-from" "resent-reply-to"))
827 (while (search-forward "," end t)
828 (or (looking-at "[ \t]")
829 (insert " "))))
95fe848e 830 (fill-region-as-paragraph beg end arg)
c8553837
RS
831 ;; Mark all lines except the first as continuations.
832 (goto-char beg)
833 (forward-line 1)
834 (while (< (point) end)
835 (insert " ")
836 (forward-line 1))
837 (move-marker end nil)
838 t)))
299fdd8d 839\f
5b6575b7
RS
840;; User-level commands for sending.
841
2c1e2995 842(defun mail-send-and-exit (&optional arg)
33b4a308 843 "Send message like `mail-send', then, if no errors, exit from mail buffer.
20a8832d
RS
844Prefix arg means don't delete this window."
845 (interactive "P")
846 (mail-send)
1b6bb250
RS
847 (mail-bury arg))
848
8451b5e9 849(defun mail-dont-send (&optional arg)
1b6bb250
RS
850 "Don't send the message you have been editing.
851Prefix arg means don't delete this window."
852 (interactive "P")
853 (mail-bury arg))
854
8451b5e9 855(defun mail-bury (&optional arg)
1b6bb250 856 "Bury this mail buffer."
50718fc2 857 (let ((newbuf (other-buffer (current-buffer)))
4d6769e1 858 (return-action mail-return-action))
e49ad9a5 859 (bury-buffer (current-buffer))
50718fc2
RS
860 ;; If there is an Rmail buffer, return to it nicely
861 ;; even if this message was not started by an Rmail command.
862 (unless return-action
863 (dolist (buffer (buffer-list))
5f6530ea
RS
864 (if (and (eq (buffer-local-value 'major-mode buffer) 'rmail-mode)
865 (null return-action)
866 ;; Don't match message-viewer buffer.
867 (not (string-match "\\` " (buffer-name buffer))))
868 (setq return-action `(rmail-mail-return ,buffer)))))
50718fc2
RS
869 (if (and (null arg) return-action)
870 (apply (car return-action) (cdr return-action))
25ca2e61 871 (switch-to-buffer newbuf))))
20a8832d 872
be0b8d69 873(defcustom mail-send-hook nil
28f57f7e 874 "Hook run just before sending a message."
be0b8d69
DL
875 :type 'hook
876 :options '(flyspell-mode-off)
877 :group 'sendmail)
878
3ca0be33 879;;;###autoload
0462d019
GM
880(defcustom mail-mailing-lists nil
881"List of mailing list addresses the user is subscribed to.
3ca0be33
RS
882The variable is used to trigger insertion of the \"Mail-Followup-To\"
883header when sending a message to a mailing list."
884 :type '(repeat string)
885 :group 'sendmail)
886
c3760c17 887(declare-function mml-to-mime "mml" ())
3ca0be33 888
20a8832d
RS
889(defun mail-send ()
890 "Send the message in the current buffer.
891If `mail-interactive' is non-nil, wait for success indication
892or error messages, and inform user.
893Otherwise any failure is reported in a message back to
894the user from the mailer."
895 (interactive)
e11094e6
RS
896 (if (if buffer-file-name
897 (y-or-n-p "Send buffer contents as mail message? ")
898 (or (buffer-modified-p)
899 (y-or-n-p "Message already sent; resend? ")))
34153d76 900 (let ((inhibit-read-only t)
3ca0be33
RS
901 (opoint (point))
902 (ml (when mail-mailing-lists
903 ;; The surrounding regexp assumes the use of
904 ;; `mail-strip-quoted-names' on addresses before matching
905 ;; Cannot deal with full RFC 822 freedom, but that is
906 ;; unlikely to be problematic.
907 (concat "\\(?:[[:space:];,]\\|\\`\\)"
908 (regexp-opt mail-mailing-lists t)
909 "\\(?:[[:space:];,]\\|\\'\\)"))))
910 ;; If there are mailing lists defined
911 (when ml
912 (save-excursion
913 (let* ((to (mail-fetch-field "to" nil t))
914 (cc (mail-fetch-field "cc" nil t))
915 (new-header-values ; To: and Cc:
916 (mail-strip-quoted-names
917 (concat to (when cc (concat ", " cc))))))
918 ;; If message goes to known mailing list ...
919 (when (string-match ml new-header-values)
920 ;; Add Mail-Followup-To if none yet
921 (unless (mail-fetch-field "mail-followup-to")
922 (goto-char (mail-header-end))
923 (insert "Mail-Followup-To: "
924 (let ((l))
925 (mapc
926 ;; remove duplicates
4f91a816
SM
927 (lambda (e)
928 (unless (member e l)
929 (push e l)))
6f0de615
EZ
930 (split-string new-header-values
931 ",[[:space:]]+" t))
3ca0be33
RS
932 (mapconcat 'identity l ", "))
933 "\n"))
934 ;; Add Mail-Reply-To if none yet
935 (unless (mail-fetch-field "mail-reply-to")
936 (goto-char (mail-header-end))
937 (insert "Mail-Reply-To: "
938 (or (mail-fetch-field "reply-to")
939 user-mail-address)
940 "\n"))))))
42d305db 941 (unless (memq mail-send-nonascii '(t mime))
34153d76
RS
942 (goto-char (point-min))
943 (skip-chars-forward "\0-\177")
944 (or (= (point) (point-max))
945 (if (eq mail-send-nonascii 'query)
946 (or (y-or-n-p "Message contains non-ASCII characters; send anyway? ")
947 (error "Aborted"))
948 (error "Message contains non-ASCII characters"))))
413d1aa2
RS
949 ;; Complain about any invalid line.
950 (goto-char (point-min))
c43d7539
CY
951 (re-search-forward (regexp-quote mail-header-separator) (point-max) t)
952 (let ((header-end (or (match-beginning 0) (point-max))))
953 (goto-char (point-min))
954 (while (< (point) header-end)
955 (unless (looking-at "[ \t]\\|.*:\\|$")
956 (push-mark opoint)
957 (error "Invalid header line (maybe a continuation line lacks initial whitespace)"))
958 (forward-line 1)))
34153d76 959 (goto-char opoint)
fd59d131
EZ
960 (when mail-encode-mml
961 (mml-to-mime)
962 (setq mail-encode-mml nil))
20a8832d 963 (run-hooks 'mail-send-hook)
da5667c6 964 (message "Sending...")
20a8832d
RS
965 (funcall send-mail-function)
966 ;; Now perform actions on successful sending.
967 (while mail-send-actions
968 (condition-case nil
d2561f34
RS
969 (apply (car (car mail-send-actions))
970 (cdr (car mail-send-actions)))
20a8832d
RS
971 (error))
972 (setq mail-send-actions (cdr mail-send-actions)))
d2561f34 973 (message "Sending...done")
4e0c8650 974 ;; If buffer has no file, mark it as unmodified and delete auto-save.
d2561f34
RS
975 (if (not buffer-file-name)
976 (progn
977 (set-buffer-modified-p nil)
978 (delete-auto-save-file-if-necessary t))))))
56e5818f
SJ
979
980(defun mail-envelope-from ()
981 "Return the envelope mail address to use when sending mail.
982This function uses `mail-envelope-from'."
983 (if (eq mail-envelope-from 'header)
984 (nth 1 (mail-extract-address-components
985 (mail-fetch-field "From")))
986 mail-envelope-from))
5b6575b7
RS
987\f
988;; This does the real work of sending a message via sendmail.
989;; It is called via the variable send-mail-function.
20a8832d 990
ae54d287
KH
991;;;###autoload
992(defvar sendmail-coding-system nil
fb7ada5f 993 "Coding system for encoding the outgoing mail.
b56a5ae0 994This has higher priority than the default `buffer-file-coding-system'
da241b5c
KH
995and `default-sendmail-coding-system',
996but lower priority than the local value of `buffer-file-coding-system'.
0b64a3da 997See also the function `select-message-coding-system'.")
da241b5c
KH
998
999;;;###autoload
1000(defvar default-sendmail-coding-system 'iso-latin-1
265f03bc 1001 "Default coding system for encoding the outgoing mail.
da241b5c
KH
1002This variable is used only when `sendmail-coding-system' is nil.
1003
27f667c0 1004This variable is set/changed by the command `set-language-environment'.
da241b5c 1005User should not set this variable manually,
27f667c0 1006instead use `sendmail-coding-system' to get a constant encoding
da241b5c 1007of outgoing mails regardless of the current language environment.
0b64a3da 1008See also the function `select-message-coding-system'.")
ee0a4f29 1009
1938b566 1010(defun mail-insert-from-field ()
b8d747b9
KH
1011 "Insert the \"From:\" field of a mail header.
1012The style of the field is determined by the variable `mail-from-style'.
1013This function does not perform RFC2047 encoding."
1938b566
RS
1014 (let* ((login user-mail-address)
1015 (fullname (user-full-name))
1016 (quote-fullname nil))
1017 (if (string-match "[^\0-\177]" fullname)
b8d747b9 1018 (setq quote-fullname t))
0b8ee421
CY
1019 (cond ((null mail-from-style)
1020 (insert "From: " login "\n"))
1021 ;; This is deprecated.
1022 ((eq mail-from-style 'system-default)
1023 nil)
1024 ((or (eq mail-from-style 'angles)
1025 (and (not (eq mail-from-style 'parens))
1026 ;; Use angles if no quoting is needed, or if
1027 ;; parens would need quoting too.
1028 (or (not (string-match "[^- !#-'*+/-9=?A-Z^-~]" fullname))
1029 (let ((tmp (concat fullname nil)))
1030 (while (string-match "([^()]*)" tmp)
1031 (aset tmp (match-beginning 0) ?-)
1032 (aset tmp (1- (match-end 0)) ?-))
1033 (string-match "[\\()]" tmp)))))
1938b566
RS
1034 (insert "From: " fullname)
1035 (let ((fullname-start (+ (point-min) 6))
1036 (fullname-end (point-marker)))
1037 (goto-char fullname-start)
1038 ;; Look for a character that cannot appear unquoted
1039 ;; according to RFC 822.
1040 (if (or (re-search-forward "[^- !#-'*+/-9=?A-Z^-~]"
1041 fullname-end 1)
1042 quote-fullname)
1043 (progn
1044 ;; Quote fullname, escaping specials.
1045 (goto-char fullname-start)
1046 (insert "\"")
1047 (while (re-search-forward "[\"\\]"
1048 fullname-end 1)
1049 (replace-match "\\\\\\&" t))
1050 (insert "\""))))
1051 (insert " <" login ">\n"))
0b8ee421
CY
1052 ;; 'parens or default
1053 (t
1938b566
RS
1054 (insert "From: " login " (")
1055 (let ((fullname-start (point)))
1056 (if quote-fullname
1057 (insert "\""))
1058 (insert fullname)
1059 (if quote-fullname
1060 (insert "\""))
1061 (let ((fullname-end (point-marker)))
1062 (goto-char fullname-start)
1063 ;; RFC 822 says \ and nonmatching parentheses
1064 ;; must be escaped in comments.
1065 ;; Escape every instance of ()\ ...
1066 (while (re-search-forward "[()\\]" fullname-end 1)
1067 (replace-match "\\\\\\&" t))
1068 ;; ... then undo escaping of matching parentheses,
1069 ;; including matching nested parentheses.
1070 (goto-char fullname-start)
1071 (while (re-search-forward
1072 "\\(\\=\\|[^\\]\\(\\\\\\\\\\)*\\)\\\\(\\(\\([^\\]\\|\\\\\\\\\\)*\\)\\\\)"
1073 fullname-end 1)
1074 (replace-match "\\1(\\3)" t)
1075 (goto-char fullname-start))))
0b8ee421 1076 (insert ")\n")))))
1938b566 1077
b8d747b9
KH
1078(defun mail-encode-header (beg end)
1079 "Encode the mail header between BEG and END according to RFC2047.
1080Return non-nil if and only if some part of the header is encoded."
1081 (save-restriction
1082 (narrow-to-region beg end)
1083 (let* ((selected (select-message-coding-system))
1084 (mm-coding-system-priorities
1085 (if (and selected (coding-system-get selected :mime-charset))
1086 (cons selected mm-coding-system-priorities)
1087 mm-coding-system-priorities))
c92a1e54 1088 (tick (buffer-chars-modified-tick))
899cb7cb
KY
1089 ;; Many mailers, including Gnus, passes a message of which
1090 ;; the header is already encoded, so this is necessary to
1091 ;; prevent it from being encoded again.
1092 (rfc2047-encode-encoded-words nil))
b8d747b9
KH
1093 (rfc2047-encode-message-header)
1094 (= tick (buffer-chars-modified-tick)))))
1095
78205dab
SS
1096;; Normally you will not need to modify these options unless you are
1097;; using some non-genuine substitute for sendmail which does not
1098;; implement each and every option that the original supports.
1099;; E.g., ssmtp does not support "-odb", so, if your site uses it,
1100;; you will need to modify `sendmail-error-reporting-non-interactive'
1101;; in your site-init.el.
1102(defvar sendmail-error-reporting-interactive
1103 ;; These mean "report errors to terminal" and "deliver interactively"
1104 '("-oep" "-odi"))
1105(defvar sendmail-error-reporting-non-interactive
1106 ;; These mean "report errors by mail" and "deliver in background".
1107 '("-oem" "-odb"))
1108
20a8832d 1109(defun sendmail-send-it ()
67ad9438
DL
1110 "Send the current mail buffer using the Sendmail package.
1111This is a suitable value for `send-mail-function'. It sends using the
1112external program defined by `sendmail-program'."
8e183d5b 1113 (require 'mail-utils)
20a8832d
RS
1114 (let ((errbuf (if mail-interactive
1115 (generate-new-buffer " sendmail errors")
538b9847 1116 0))
20a8832d 1117 (tembuf (generate-new-buffer " sendmail temp"))
c86237b2 1118 (multibyte enable-multibyte-characters)
20a8832d 1119 (case-fold-search nil)
a80d7290 1120 (selected-coding (select-message-coding-system))
3ca0be33 1121 resend-to-addresses
20a8832d 1122 delimline
00365e98 1123 fcc-was-found
3ff0518e 1124 (mailbuf (current-buffer))
00417fac
RS
1125 ;; Examine these variables now, so that
1126 ;; local binding in the mail buffer will take effect.
1127 (envelope-from
1128 (and mail-specify-envelope-from
56e5818f 1129 (or (mail-envelope-from) user-mail-address))))
20a8832d 1130 (unwind-protect
95fe848e 1131 (with-current-buffer tembuf
20a8832d 1132 (erase-buffer)
c86237b2
RS
1133 (unless multibyte
1134 (set-buffer-multibyte nil))
20a8832d 1135 (insert-buffer-substring mailbuf)
b8d747b9 1136 (set-buffer-file-coding-system selected-coding)
20a8832d
RS
1137 (goto-char (point-max))
1138 ;; require one newline at the end.
1139 (or (= (preceding-char) ?\n)
1140 (insert ?\n))
1141 ;; Change header-delimiter to be what sendmail expects.
51d541d4
RS
1142 (goto-char (mail-header-end))
1143 (delete-region (point) (progn (end-of-line) (point)))
20a8832d 1144 (setq delimline (point-marker))
1498db18 1145 (sendmail-sync-aliases)
5ef9d627
RS
1146 (if mail-aliases
1147 (expand-mail-aliases (point-min) delimline))
20a8832d 1148 (goto-char (point-min))
413d1aa2 1149 ;; Ignore any blank lines in the header
20a8832d
RS
1150 (while (and (re-search-forward "\n\n\n*" delimline t)
1151 (< (point) delimline))
1152 (replace-match "\n"))
413d1aa2 1153 (goto-char (point-min))
3ca0be33
RS
1154 ;; Look for Resent- headers. They require sending
1155 ;; the message specially.
20a8832d 1156 (let ((case-fold-search t))
3ca0be33
RS
1157 (goto-char (point-min))
1158 (while (re-search-forward "^Resent-\\(to\\|cc\\|bcc\\):" delimline t)
1159 ;; Put a list of such addresses in resend-to-addresses.
1160 (setq resend-to-addresses
1161 (save-restriction
1162 (narrow-to-region (point)
1163 (save-excursion
1164 (forward-line 1)
1165 (while (looking-at "^[ \t]")
1166 (forward-line 1))
1167 (point)))
1168 (append (mail-parse-comma-list)
1169 resend-to-addresses)))
1170 ;; Delete Resent-BCC ourselves
1171 (if (save-excursion (beginning-of-line)
1172 (looking-at "resent-bcc"))
1f7f45a5
SM
1173 (delete-region (line-beginning-position)
1174 (line-beginning-position 2))))
1175 ;; Apparently this causes a duplicate Sender.
1176 ;; ;; If the From is different than current user, insert Sender.
1177 ;; (goto-char (point-min))
1178 ;; (and (re-search-forward "^From:" delimline t)
1179 ;; (progn
1180 ;; (require 'mail-utils)
1181 ;; (not (string-equal
1182 ;; (mail-strip-quoted-names
1183 ;; (save-restriction
1184 ;; (narrow-to-region (point-min) delimline)
1185 ;; (mail-fetch-field "From")))
1186 ;; (user-login-name))))
1187 ;; (progn
1188 ;; (forward-line 1)
1189 ;; (insert "Sender: " (user-login-name) "\n")))
20a8832d
RS
1190 ;; Don't send out a blank subject line
1191 (goto-char (point-min))
66961910 1192 (if (re-search-forward "^Subject:\\([ \t]*\n\\)+\\b" delimline t)
54115447
RS
1193 (replace-match "")
1194 ;; This one matches a Subject just before the header delimiter.
1195 (if (and (re-search-forward "^Subject:\\([ \t]*\n\\)+" delimline t)
1196 (= (match-end 0) delimline))
1197 (replace-match "")))
ea9ceb34
KH
1198 ;; Put the "From:" field in unless for some odd reason
1199 ;; they put one in themselves.
1200 (goto-char (point-min))
1201 (if (not (re-search-forward "^From:" delimline t))
1938b566 1202 (mail-insert-from-field))
baaa1f19 1203 ;; Possibly add a MIME header for the current coding system
caf9510c
RS
1204 (let (charset where-content-type)
1205 (goto-char (point-min))
1206 (setq where-content-type
1207 (re-search-forward "^Content-type:" delimline t))
baaa1f19
GM
1208 (goto-char (point-min))
1209 (and (eq mail-send-nonascii 'mime)
1210 (not (re-search-forward "^MIME-version:" delimline t))
1211 (progn (skip-chars-forward "\0-\177")
1212 (/= (point) (point-max)))
a80d7290 1213 selected-coding
baaa1f19 1214 (setq charset
3724c600 1215 (coding-system-get selected-coding :mime-charset))
caf9510c
RS
1216 (progn
1217 (goto-char delimline)
1218 (insert "MIME-version: 1.0\n"
1219 "Content-type: text/plain; charset="
1220 (symbol-name charset)
1221 "\nContent-Transfer-Encoding: 8bit\n")
1222 ;; The character set we will actually use
1223 ;; should override any specified in the message itself.
1224 (when where-content-type
1225 (goto-char where-content-type)
9b026d9f 1226 (delete-region (point-at-bol)
caf9510c 1227 (progn (forward-line 1) (point)))))))
7c203051
RS
1228 ;; Insert an extra newline if we need it to work around
1229 ;; Sun's bug that swallows newlines.
1230 (goto-char (1+ delimline))
1231 (if (eval mail-mailer-swallows-blank-line)
1232 (newline))
d6e000df
RS
1233 ;; Find and handle any FCC fields.
1234 (goto-char (point-min))
1235 (if (re-search-forward "^FCC:" delimline t)
00365e98
RS
1236 (progn
1237 (setq fcc-was-found t)
1238 (mail-do-fcc delimline)))
20a8832d 1239 (if mail-interactive
95fe848e 1240 (with-current-buffer errbuf
20a8832d 1241 (erase-buffer))))
b8d747b9
KH
1242 ;; Encode the header according to RFC2047.
1243 (mail-encode-header (point-min) delimline)
00365e98
RS
1244 (goto-char (point-min))
1245 (if (let ((case-fold-search t))
3ca0be33
RS
1246 (or resend-to-addresses
1247 (re-search-forward "^To:\\|^cc:\\|^bcc:"
1248 delimline t)))
63b89616 1249 (let* ((default-directory "/")
a80d7290 1250 (coding-system-for-write selected-coding)
a1506d29 1251 (args
63b89616 1252 (append (list (point-min) (point-max)
8340026c 1253 sendmail-program
63b89616 1254 nil errbuf nil "-oi")
00417fac
RS
1255 (and envelope-from
1256 (list "-f" envelope-from))
1f7f45a5
SM
1257 ;; ;; Don't say "from root" if running under su.
1258 ;; (and (equal (user-real-login-name) "root")
1259 ;; (list "-f" (user-login-name)))
63b89616
KH
1260 (and mail-alias-file
1261 (list (concat "-oA" mail-alias-file)))
1262 (if mail-interactive
78205dab
SS
1263 sendmail-error-reporting-interactive
1264 sendmail-error-reporting-non-interactive)
3ca0be33
RS
1265 ;; Get the addresses from the message
1266 ;; unless this is a resend.
1267 ;; We must not do that for a resend
1268 ;; because we would find the original addresses.
1269 ;; For a resend, include the specific addresses.
1270 (or resend-to-addresses
180d5509 1271 '("-t")
3ca0be33 1272 )
0b0b4ce7
RS
1273 (if mail-use-dsn
1274 (list "-N" (mapconcat 'symbol-name
1275 mail-use-dsn ",")))
180d5509
GM
1276 )
1277 )
63b89616 1278 (exit-value (apply 'call-process-region args)))
0d0ff7bc
GM
1279 (cond ((or (null exit-value) (eq 0 exit-value)))
1280 ((numberp exit-value)
1281 (error "Sending...failed with exit value %d" exit-value))
1282 ((stringp exit-value)
1283 (error "Sending...terminated by signal: %s" exit-value))
1284 (t
1285 (error "SENDMAIL-SEND-IT -- fall through: %S" exit-value))))
00365e98
RS
1286 (or fcc-was-found
1287 (error "No recipients")))
20a8832d 1288 (if mail-interactive
95fe848e 1289 (with-current-buffer errbuf
20a8832d
RS
1290 (goto-char (point-min))
1291 (while (re-search-forward "\n\n* *" nil t)
1292 (replace-match "; "))
1293 (if (not (zerop (buffer-size)))
1294 (error "Sending...failed to %s"
1295 (buffer-substring (point-min) (point-max)))))))
1296 (kill-buffer tembuf)
1297 (if (bufferp errbuf)
1298 (kill-buffer errbuf)))))
1299
04ca017c
GM
1300(autoload 'rmail-output-to-rmail-buffer "rmailout")
1301
20a8832d 1302(defun mail-do-fcc (header-end)
04ca017c
GM
1303 "Find and act on any FCC: headers in the current message before HEADER-END.
1304If a buffer is visiting the FCC file, append to it before
1305offering to save it, if it was modified initially. If this is an
1306Rmail buffer, update Rmail as needed. If there is no buffer,
1307just append to the file, in Babyl format if necessary."
95fe848e
SM
1308 (unless (markerp header-end)
1309 (error "Value of `header-end' must be a marker"))
20a8832d 1310 (let (fcc-list
04ca017c
GM
1311 (mailbuf (current-buffer))
1312 (time (current-time)))
20a8832d
RS
1313 (save-excursion
1314 (goto-char (point-min))
04ca017c
GM
1315 (let ((case-fold-search t))
1316 (while (re-search-forward "^FCC:[ \t]*" header-end t)
1317 (push (buffer-substring (point)
1318 (progn
1319 (end-of-line)
1320 (skip-chars-backward " \t")
1321 (point)))
1322 fcc-list)
1323 (delete-region (match-beginning 0)
1324 (progn (forward-line 1) (point)))))
1325 (with-temp-buffer
1326 ;; This initial newline is not written out if we create a new
1327 ;; file (see below).
1328 (insert "\nFrom " (user-login-name) " " (current-time-string time) "\n")
1329 ;; Insert the time zone before the year.
1330 (forward-char -1)
1331 (forward-word -1)
1332 (require 'mail-utils)
1333 (insert (mail-rfc822-time-zone time) " ")
1334 (goto-char (point-max))
1335 (insert-buffer-substring mailbuf)
1336 ;; Make sure messages are separated.
1337 (goto-char (point-max))
1338 (insert ?\n)
1339 (goto-char 2)
1340 ;; ``Quote'' "^From " as ">From "
1341 ;; (note that this isn't really quoting, as there is no requirement
1342 ;; that "^[>]+From " be quoted in the same transparent way.)
1343 (let ((case-fold-search nil))
1344 (while (search-forward "\nFrom " nil t)
1345 (forward-char -5)
1346 (insert ?>)))
1347 (dolist (fcc fcc-list)
1348 (let* ((buffer (find-buffer-visiting fcc))
1349 (curbuf (current-buffer))
1350 dont-write-the-file
1351 buffer-matches-file
1352 (beg (point-min)) ; the initial blank line
1353 (end (point-max))
1354 ;; After the ^From line.
1355 (beg2 (save-excursion (goto-char (point-min))
1356 (forward-line 2) (point))))
1357 (if buffer
1358 ;; File is present in a buffer => append to that buffer.
1359 (with-current-buffer buffer
1360 (setq buffer-matches-file
1361 (and (not (buffer-modified-p))
1362 (verify-visited-file-modtime buffer)))
1363 (let ((msg (bound-and-true-p rmail-current-message))
1364 (buffer-read-only nil))
1365 ;; If MSG is non-nil, buffer is in Rmail mode.
1366 (if msg
1367 (let ((buff (generate-new-buffer " *mail-do-fcc")))
1368 (unwind-protect
1369 (progn
1370 (with-current-buffer buff
1371 (insert-buffer-substring curbuf (1+ beg) end))
1372 (rmail-output-to-rmail-buffer buff msg))
1373 (kill-buffer buff)))
1374 ;; Output file not in Rmail mode => just insert
1375 ;; at the end.
1376 (save-restriction
1377 (widen)
1378 (goto-char (point-max))
1379 (insert-buffer-substring curbuf beg end)))
1380 ;; Offer to save the buffer if it was modified
1381 ;; before we started.
1382 (unless buffer-matches-file
1383 (if (y-or-n-p (format "Save file %s? " fcc))
1384 (save-buffer))
1385 (setq dont-write-the-file t)))))
1386 ;; Append to the file directly, unless we've already taken
1387 ;; care of it.
1388 (unless dont-write-the-file
1389 (if (and (file-exists-p fcc)
1390 (mail-file-babyl-p fcc))
1391 ;; If the file is a Babyl file, convert the message to
1392 ;; Babyl format. Even though Rmail no longer uses
1393 ;; Babyl, this code can remain for the time being, on
1394 ;; the off-chance one FCCs to a Babyl file that has
1395 ;; not yet been converted to mbox.
1396 (let ((coding-system-for-write
1397 (or rmail-file-coding-system 'emacs-mule)))
1398 (with-temp-buffer
1399 (insert "\C-l\n0, unseen,,\n*** EOOH ***\nDate: "
1400 (mail-rfc822-date) "\n")
1401 (insert-buffer-substring curbuf beg2 end)
1402 (insert "\n\C-_")
1403 (write-region (point-min) (point-max) fcc t)))
1404 ;; Ensure there is a blank line between messages, but
1405 ;; not at the very start of the file.
1406 (write-region (if (file-exists-p fcc)
1407 (point-min)
1408 (1+ (point-min)))
1409 (point-max) fcc t)))
1410 (and buffer (not dont-write-the-file)
1411 (with-current-buffer buffer
1412 (set-visited-file-modtime)))))))))
20a8832d
RS
1413
1414(defun mail-sent-via ()
1415 "Make a Sent-via header line from each To or CC header line."
59f7af81 1416 (declare (obsolete "nobody can remember what it is for." "24.1"))
20a8832d
RS
1417 (interactive)
1418 (save-excursion
20a8832d 1419 ;; put a marker at the end of the header
81f5ed32 1420 (let ((end (copy-marker (mail-header-end)))
95fe848e 1421 (case-fold-search t))
20a8832d
RS
1422 (goto-char (point-min))
1423 ;; search for the To: lines and make Sent-via: lines from them
1424 ;; search for the next To: line
1425 (while (re-search-forward "^\\(to\\|cc\\):" end t)
1426 ;; Grab this line plus all its continuations, sans the `to:'.
1427 (let ((to-line
1428 (buffer-substring (point)
1429 (progn
1430 (if (re-search-forward "^[^ \t\n]" end t)
1431 (backward-char 1)
1432 (goto-char end))
1433 (point)))))
1434 ;; Insert a copy, with altered header field name.
1435 (insert-before-markers "Sent-via:" to-line))))))
1436\f
1437(defun mail-to ()
87ede499 1438 "Move point to end of To field, creating it if necessary."
20a8832d
RS
1439 (interactive)
1440 (expand-abbrev)
1441 (mail-position-on-field "To"))
1442
1443(defun mail-subject ()
87ede499 1444 "Move point to end of Subject field, creating it if necessary."
20a8832d
RS
1445 (interactive)
1446 (expand-abbrev)
1447 (mail-position-on-field "Subject"))
1448
1449(defun mail-cc ()
87ede499 1450 "Move point to end of CC field, creating it if necessary."
20a8832d
RS
1451 (interactive)
1452 (expand-abbrev)
1453 (or (mail-position-on-field "cc" t)
1454 (progn (mail-position-on-field "to")
1455 (insert "\nCC: "))))
1456
1457(defun mail-bcc ()
87ede499 1458 "Move point to end of BCC field, creating it if necessary."
20a8832d
RS
1459 (interactive)
1460 (expand-abbrev)
1461 (or (mail-position-on-field "bcc" t)
1462 (progn (mail-position-on-field "to")
1463 (insert "\nBCC: "))))
1464
5a31c2d2 1465(defun mail-fcc (folder)
70ee42f7 1466 "Add a new FCC field, with file name completion."
5a31c2d2 1467 (interactive "FFolder carbon copy: ")
70ee42f7
JB
1468 (expand-abbrev)
1469 (or (mail-position-on-field "fcc" t) ;Put new field after exiting FCC.
1470 (mail-position-on-field "to"))
5a31c2d2 1471 (insert "\nFCC: " folder))
70ee42f7 1472
a1506d29 1473(defun mail-reply-to ()
87ede499 1474 "Move point to end of Reply-To field, creating it if necessary."
3a3ffba4
RS
1475 (interactive)
1476 (expand-abbrev)
1477 (mail-position-on-field "Reply-To"))
1478
3ca0be33 1479(defun mail-mail-reply-to ()
87ede499 1480 "Move point to end of Mail-Reply-To field, creating it if necessary."
3ca0be33
RS
1481 (interactive)
1482 (expand-abbrev)
1483 (or (mail-position-on-field "mail-reply-to" t)
1484 (progn (mail-position-on-field "to")
1485 (insert "\nMail-Reply-To: "))))
1486
1487(defun mail-mail-followup-to ()
87ede499 1488 "Move point to end of Mail-Followup-To field, creating it if necessary."
3ca0be33
RS
1489 (interactive)
1490 (expand-abbrev)
1491 (or (mail-position-on-field "mail-followup-to" t)
1492 (progn (mail-position-on-field "to")
1493 (insert "\nMail-Followup-To: "))))
1494
20a8832d
RS
1495(defun mail-position-on-field (field &optional soft)
1496 (let (end
1497 (case-fold-search t))
51d541d4 1498 (setq end (mail-header-end))
20a8832d
RS
1499 (goto-char (point-min))
1500 (if (re-search-forward (concat "^" (regexp-quote field) ":") end t)
1501 (progn
1502 (re-search-forward "^[^ \t]" nil 'move)
1503 (beginning-of-line)
1504 (skip-chars-backward "\n")
1505 t)
1506 (or soft
1507 (progn (goto-char end)
08564963
JB
1508 (insert field ": \n")
1509 (skip-chars-backward "\n")))
20a8832d
RS
1510 nil)))
1511
1512(defun mail-text ()
5d838629 1513 "Move point to beginning of text field."
20a8832d 1514 (interactive)
e3b671fc 1515 (expand-abbrev)
51d541d4 1516 (goto-char (mail-text-start)))
20a8832d 1517\f
e04233aa 1518(defun mail-signature (&optional atpoint)
87ede499
GM
1519 "Sign letter with signature.
1520If the variable `mail-signature' is a string, inserts it.
1521If it is t or nil, inserts the contents of the file `mail-signature-file'.
1522Otherwise, evals `mail-signature'.
1523Prefix argument ATPOINT means insert at point rather than the end."
1524 (interactive "*P")
1525 ;; Test for an unreadable file here, before we delete trailing
1526 ;; whitespace, so that we don't modify the buffer needlessly.
1527 (if (and (memq mail-signature '(t nil))
1528 (not (file-readable-p mail-signature-file)))
32226619 1529 (if (called-interactively-p 'interactive)
87ede499
GM
1530 (message "The signature file `%s' could not be read"
1531 mail-signature-file))
1532 (save-excursion
1533 (unless atpoint
1534 (goto-char (point-max))
1535 ;; Delete trailing whitespace and blank lines.
1536 (skip-chars-backward " \t\n")
1537 (end-of-line)
0d021ccf 1538 (delete-region (point) (point-max)))
87ede499
GM
1539 (cond ((stringp mail-signature)
1540 (insert mail-signature))
1541 ((memq mail-signature '(t nil))
1542 (insert "\n\n-- \n")
1543 (insert-file-contents (expand-file-name mail-signature-file)))
1544 (t
1545 ;; FIXME add condition-case error handling?
1546 (eval mail-signature))))))
20a8832d
RS
1547
1548(defun mail-fill-yanked-message (&optional justifyp)
1549 "Fill the paragraphs of a message yanked into this one.
1550Numeric argument means justify as well."
1551 (interactive "P")
1552 (save-excursion
51d541d4 1553 (goto-char (mail-text-start))
20a8832d
RS
1554 (fill-individual-paragraphs (point)
1555 (point-max)
1556 justifyp
706e3d85 1557 mail-citation-prefix-regexp)))
20a8832d 1558
374bda6b 1559(defun mail-indent-citation ()
1c24b04a
RS
1560 "Modify text just inserted from a message to be cited.
1561The inserted text should be the region.
1562When this function returns, the region is again around the modified text.
1563
1564Normally, indent each nonblank line `mail-indentation-spaces' spaces.
1565However, if `mail-yank-prefix' is non-nil, insert that prefix on each line."
374bda6b 1566 (mail-yank-clear-headers (region-beginning) (region-end))
e39e74c0 1567 (if (null mail-yank-prefix)
374bda6b
RS
1568 (indent-rigidly (region-beginning) (region-end)
1569 mail-indentation-spaces)
e39e74c0 1570 (save-excursion
374bda6b
RS
1571 (let ((end (set-marker (make-marker) (region-end))))
1572 (goto-char (region-beginning))
1573 (while (< (point) end)
1574 (insert mail-yank-prefix)
1575 (forward-line 1))))))
1c24b04a 1576
20a8832d 1577(defun mail-yank-original (arg)
04ca017c 1578 "Insert the message being replied to, if any (in Rmail).
26adca1b 1579Puts point after the text and mark before.
20a8832d
RS
1580Normally, indents each nonblank line ARG spaces (default 3).
1581However, if `mail-yank-prefix' is non-nil, insert that prefix on each line.
1582
1583Just \\[universal-argument] as argument means don't indent, insert no prefix,
1584and don't delete any header fields."
1585 (interactive "P")
c8553837
RS
1586 (if mail-reply-action
1587 (let ((start (point))
9295137d
CY
1588 (original mail-reply-action)
1589 (omark (mark t)))
c8553837
RS
1590 (and (consp original) (eq (car original) 'insert-buffer)
1591 (setq original (nth 1 original)))
1592 (if (consp original)
9295137d
CY
1593 (progn
1594 ;; Call yank function, and set the mark if it doesn't.
1595 (apply (car original) (cdr original))
1596 (if (eq omark (mark t))
1597 (push-mark (point))))
1598 ;; If the original message is in another window in the same
1599 ;; frame, delete that window to save space.
c8553837 1600 (delete-windows-on original t)
c7c93bd9
RS
1601 (with-no-warnings
1602 ;; We really want this to set mark.
60c2df40
EZ
1603 (insert-buffer original)
1604 ;; If they yank the original text, the encoding of the
1605 ;; original message is a better default than
b56a5ae0 1606 ;; the default buffer-file-coding-system.
60c2df40
EZ
1607 (and (coding-system-equal
1608 (default-value 'buffer-file-coding-system)
1609 buffer-file-coding-system)
1610 (setq buffer-file-coding-system
1611 (coding-system-change-text-conversion
1612 buffer-file-coding-system
1613 (coding-system-base
1614 (with-current-buffer original
1615 buffer-file-coding-system))))))
75e4db34 1616 (set-text-properties (point) (mark t) nil))
20a8832d
RS
1617 (if (consp arg)
1618 nil
1c24b04a
RS
1619 (goto-char start)
1620 (let ((mail-indentation-spaces (if arg (prefix-numeric-value arg)
ac9f0310 1621 mail-indentation-spaces))
8761c2c4
RS
1622 ;; Avoid error in Transient Mark mode
1623 ;; on account of mark's being inactive.
ac9f0310 1624 (mark-even-if-inactive t))
e04233aa
GM
1625 (cond (mail-citation-hook
1626 ;; Bind mail-citation-header to the inserted
1627 ;; message's header.
1628 (let ((mail-citation-header
1629 (buffer-substring-no-properties
1630 start
1631 (save-excursion
1632 (save-restriction
1633 (narrow-to-region start (point-max))
1634 (goto-char start)
1635 (rfc822-goto-eoh)
1636 (point))))))
1637 (run-hooks 'mail-citation-hook)))
1638 (mail-yank-hooks
1639 (run-hooks 'mail-yank-hooks))
1640 (t
1641 (mail-indent-citation)))))
3c280f48
RS
1642 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1643 ;; It is cleaner to avoid activation, even though the command
1644 ;; loop would deactivate the mark because we inserted text.
1645 (goto-char (prog1 (mark t)
1646 (set-marker (mark-marker) (point) (current-buffer))))
20a8832d
RS
1647 (if (not (eolp)) (insert ?\n)))))
1648
1649(defun mail-yank-clear-headers (start end)
e39e74c0
RS
1650 (if (< end start)
1651 (let (temp)
1652 (setq temp start start end end temp)))
2b3a206d
RS
1653 (if mail-yank-ignored-headers
1654 (save-excursion
1655 (goto-char start)
1656 (if (search-forward "\n\n" end t)
1657 (save-restriction
1658 (narrow-to-region start (point))
1659 (goto-char start)
1660 (while (let ((case-fold-search t))
1661 (re-search-forward mail-yank-ignored-headers nil t))
1662 (beginning-of-line)
1663 (delete-region (point)
1664 (progn (re-search-forward "\n[^ \t]")
1665 (forward-char -1)
1666 (point)))))))))
e39e74c0
RS
1667
1668(defun mail-yank-region (arg)
1669 "Insert the selected region from the message being replied to.
1670Puts point after the text and mark before.
1671Normally, indents each nonblank line ARG spaces (default 3).
1672However, if `mail-yank-prefix' is non-nil, insert that prefix on each line.
1673
1674Just \\[universal-argument] as argument means don't indent, insert no prefix,
1675and don't delete any header fields."
1676 (interactive "P")
1677 (and (consp mail-reply-action)
b30b64b9
EZ
1678 (memq (car mail-reply-action)
1679 '(rmail-yank-current-message insert-buffer))
75e4db34
RS
1680 (with-current-buffer (nth 1 mail-reply-action)
1681 (or (mark t)
1682 (error "No mark set: %S" (current-buffer))))
e39e74c0 1683 (let ((buffer (nth 1 mail-reply-action))
8761c2c4
RS
1684 (start (point))
1685 ;; Avoid error in Transient Mark mode
1686 ;; on account of mark's being inactive.
1687 (mark-even-if-inactive t))
e39e74c0
RS
1688 ;; Insert the citation text.
1689 (insert (with-current-buffer buffer
d6bccf09 1690 (buffer-substring-no-properties (point) (mark))))
e39e74c0
RS
1691 (push-mark start)
1692 ;; Indent or otherwise annotate the citation text.
1693 (if (consp arg)
1694 nil
1695 (let ((mail-indentation-spaces (if arg (prefix-numeric-value arg)
1696 mail-indentation-spaces)))
1697 (if mail-citation-hook
d746203c 1698 ;; Bind mail-citation-header to the original message's header.
d6bccf09
RS
1699 (let ((mail-citation-header
1700 (with-current-buffer buffer
1701 (buffer-substring-no-properties
1702 (point-min)
1703 (save-excursion
1704 (goto-char (point-min))
1705 (rfc822-goto-eoh)
1706 (point))))))
1707 (run-hooks 'mail-citation-hook))
e39e74c0
RS
1708 (if mail-yank-hooks
1709 (run-hooks 'mail-yank-hooks)
374bda6b 1710 (mail-indent-citation))))))))
8ba7cd40
KS
1711
1712(defun mail-split-line ()
1713 "Split current line, moving portion beyond point vertically down.
1714If the current line has `mail-yank-prefix', insert it on the new line."
1715 (interactive "*")
1716 (split-line mail-yank-prefix))
1717
20a8832d 1718\f
c3760c17 1719(defun mail-insert-file (&optional file)
f0aef6bf
RS
1720 "Insert a file at the end of the buffer, with separator lines around it."
1721 (interactive "fAttach file: ")
1722 (save-excursion
1723 (goto-char (point-max))
1724 (or (bolp) (newline))
1725 (newline)
1726 (let ((start (point))
1727 middle)
1728 (insert (format "===File %s===" file))
1729 (insert-char ?= (max 0 (- 60 (current-column))))
1730 (newline)
1731 (setq middle (point))
1732 (insert "============================================================\n")
1733 (push-mark)
1734 (goto-char middle)
1735 (insert-file-contents file)
1736 (or (bolp) (newline))
1737 (goto-char start))))
767d420a 1738
c3760c17
EZ
1739(define-obsolete-function-alias 'mail-attach-file 'mail-insert-file "24.1")
1740
1741(declare-function mml-attach-file "mml"
1742 (file &optional type description disposition))
1743(declare-function mm-default-file-encoding "mm-encode" (file))
1744
767d420a 1745(defun mail-add-attachment (file)
c3760c17 1746 "Add FILE as a MIME attachment to the end of the mail message being composed."
767d420a
EZ
1747 (interactive "fAttach file: ")
1748 (mml-attach-file file
1749 (or (mm-default-file-encoding file)
1750 "application/octet-stream") nil)
1751 (setq mail-encode-mml t))
1752
f0aef6bf 1753\f
699adcb2
RS
1754;; Put these commands last, to reduce chance of lossage from quitting
1755;; in middle of loading the file.
1756
20a8832d 1757;;;###autoload
25ca2e61
CY
1758(defun mail (&optional noerase to subject in-reply-to cc replybuffer
1759 actions return-action)
e635fdf0
RS
1760 "Edit a message to be sent. Prefix arg means resume editing (don't erase).
1761When this function returns, the buffer `*mail*' is selected.
1762The value is t if the message was newly initialized; otherwise, nil.
20a8832d 1763
4ac2e032
RS
1764Optionally, the signature file `mail-signature-file' can be inserted at the
1765end; see the variable `mail-signature'.
20a8832d
RS
1766
1767\\<mail-mode-map>
1768While editing message, type \\[mail-send-and-exit] to send the message and exit.
1769
1770Various special commands starting with C-c are available in sendmail mode
1771to move to message header fields:
1772\\{mail-mode-map}
1773
1774If `mail-self-blind' is non-nil, a BCC to yourself is inserted
1775when the message is initialized.
1776
1777If `mail-default-reply-to' is non-nil, it should be an address (a string);
1778a Reply-to: field with that address is inserted.
1779
1780If `mail-archive-file-name' is non-nil, an FCC field with that file name
1781is inserted.
1782
8b262cbc
KH
1783The normal hook `mail-setup-hook' is run after the message is
1784initialized. It can add more default fields to the message.
20a8832d 1785
1db2d450
CY
1786The first argument, NOERASE, determines what to do when there is
1787an existing modified `*mail*' buffer. If NOERASE is nil, the
1788existing mail buffer is used, and the user is prompted whether to
1789keep the old contents or to erase them. If NOERASE has the value
1790`new', a new mail buffer will be created instead of using the old
1791one. Any other non-nil value means to always select the old
1792buffer without erasing the contents.
dfdac213
RS
1793
1794The second through fifth arguments,
1795 TO, SUBJECT, IN-REPLY-TO and CC, specify if non-nil
20a8832d
RS
1796 the initial contents of those header fields.
1797 These arguments should not have final newlines.
c8553837
RS
1798The sixth argument REPLYBUFFER is a buffer which contains an
1799 original message being replied to, or else an action
1800 of the form (FUNCTION . ARGS) which says how to insert the original.
1801 Or it can be nil, if not replying to anything.
20a8832d
RS
1802The seventh argument ACTIONS is a list of actions to take
1803 if/when the message is sent. Each action looks like (FUNCTION . ARGS);
1804 when the message is sent, we apply FUNCTION to ARGS.
1805 This is how Rmail arranges to mark messages `answered'."
1806 (interactive "P")
1db2d450 1807 (if (eq noerase 'new)
72258fe5 1808 (pop-to-buffer-same-window (generate-new-buffer "*mail*"))
09c9e6bb
CY
1809 (and noerase
1810 (not (get-buffer "*mail*"))
1811 (setq noerase nil))
72258fe5 1812 (pop-to-buffer-same-window "*mail*"))
1db2d450 1813
eb1213c1
MR
1814 ;; Avoid danger that the auto-save file can't be written.
1815 (let ((dir (expand-file-name
1816 (file-name-as-directory mail-default-directory))))
1817 (if (file-exists-p dir)
1818 (setq default-directory dir)))
2e78575e
RS
1819 ;; Only call auto-save-mode if necessary, to avoid changing auto-save file.
1820 (if (or (and auto-save-default (not buffer-auto-save-file-name))
1821 (and (not auto-save-default) buffer-auto-save-file-name))
1822 (auto-save-mode auto-save-default))
e635fdf0 1823 (mail-mode)
3b112b5e
MB
1824 ;; Disconnect the buffer from its visited file
1825 ;; (in case the user has actually visited a file *mail*).
1f7f45a5 1826 ;; (set-visited-file-name nil)
e635fdf0 1827 (let (initialized)
09c9e6bb
CY
1828 (and (not (and noerase
1829 (not (eq noerase 'new))))
5e32e119
RS
1830 (if buffer-file-name
1831 (if (buffer-modified-p)
1832 (when (y-or-n-p "Buffer has unsaved changes; reinitialize it and discard them? ")
1833 (if (y-or-n-p "Disconnect buffer from visited file? ")
1834 (set-visited-file-name nil))
1835 t)
1836 (when (y-or-n-p "Reinitialize buffer, and disconnect it from the visited file? ")
1837 (set-visited-file-name nil)
1838 t))
1839 ;; A non-file-visiting buffer.
1840 (if (buffer-modified-p)
1841 (y-or-n-p "Unsent message being composed; erase it? ")
1842 t))
6737ae74
RS
1843 (let ((inhibit-read-only t))
1844 (erase-buffer)
25ca2e61
CY
1845 (mail-setup to subject in-reply-to cc replybuffer actions
1846 return-action)
6737ae74 1847 (setq initialized t)))
e635fdf0
RS
1848 (if (and buffer-auto-save-file-name
1849 (file-exists-p buffer-auto-save-file-name))
1850 (message "Auto save file for draft message exists; consider M-x mail-recover"))
1851 initialized))
20a8832d 1852
73e72da4
DN
1853(declare-function dired-view-file "dired" ())
1854(declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
1855
6cd4cfc5 1856(defun mail-recover-1 ()
918c7db7 1857 "Pop up a list of auto-saved draft messages so you can recover one of them."
6cd4cfc5
EZ
1858 (interactive)
1859 (let ((file-name (make-auto-save-file-name))
1860 (ls-lisp-support-shell-wildcards t)
1861 non-random-len wildcard)
1862 ;; Remove the random part from the auto-save-file-name, and
1863 ;; create a wildcard which matches possible candidates.
1864 ;; Note: this knows that make-auto-save-file-name appends
1865 ;; "#<RANDOM-STUFF>#" to the buffer name, where RANDOM-STUFF
1866 ;; is the result of (make-temp-name "").
1867 (setq non-random-len
d41eb0aa 1868 (- (length file-name) (length (make-temp-name "")) 1))
6cd4cfc5
EZ
1869 (setq wildcard (concat (substring file-name 0 non-random-len) "*"))
1870 (if (null (file-expand-wildcards wildcard))
1871 (message "There are no auto-saved drafts to recover")
1872 ;; Bind dired-trivial-filenames to t because all auto-save file
1873 ;; names are normally ``trivial'', so Dired will set point after
1874 ;; all the files, at buffer bottom. We want it on the first
1875 ;; file instead.
aae4b48c
GM
1876 ;; Require dired so that dired-trivial-filenames does not get
1877 ;; unbound on exit from the let.
1878 (require 'dired)
6cd4cfc5 1879 (let ((dired-trivial-filenames t))
254c37a5 1880 (dired-other-window wildcard (concat dired-listing-switches " -t")))
6cd4cfc5
EZ
1881 (rename-buffer "*Auto-saved Drafts*" t)
1882 (save-excursion
1883 (goto-char (point-min))
1884 (or (looking-at " Move to the draft file you want to recover,")
1885 (let ((inhibit-read-only t))
1886 ;; Each line starts with a space so that Font Lock mode
1887 ;; won't highlight the first character.
1888 (insert "\
1889 Move to the draft file you want to recover, then type C-c C-c
1890 to recover text of message whose composition was interrupted.
1891 To browse text of a draft, type v on the draft file's line.
1892
1893 You can also delete some of these files;
1894 type d on a line to mark that file for deletion.
1895
1896 List of possible auto-save files for recovery:
1897
1898"))))
1899 (use-local-map
1900 (let ((map (make-sparse-keymap)))
1901 (set-keymap-parent map (current-local-map))
1902 map))
1903 (define-key (current-local-map) "v"
1904 (lambda ()
1905 (interactive)
7f04a67e 1906 (let ((coding-system-for-read 'utf-8-emacs-unix))
6cd4cfc5
EZ
1907 (dired-view-file))))
1908 (define-key (current-local-map) "\C-c\C-c"
1909 (lambda ()
1910 (interactive)
1911 (let ((fname (dired-get-filename))
1912 ;; Auto-saved files are written in the internal
1913 ;; representation, so they should be read accordingly.
7f04a67e 1914 (coding-system-for-read 'utf-8-emacs-unix))
6cd4cfc5
EZ
1915 (switch-to-buffer-other-window "*mail*")
1916 (let ((buffer-read-only nil))
1917 (erase-buffer)
1918 (insert-file-contents fname nil)
1919 ;; insert-file-contents will set buffer-file-coding-system
7f04a67e 1920 ;; to utf-8-emacs, which is probably not what they want to
6cd4cfc5
EZ
1921 ;; use for sending the message. But we don't know what
1922 ;; was its value before the buffer was killed or Emacs
1923 ;; crashed. We therefore reset buffer-file-coding-system
1924 ;; to the default value, so that either the default does
1925 ;; TRT, or the user will get prompted for the right
1926 ;; encoding when they send the message.
1927 (setq buffer-file-coding-system
b56a5ae0 1928 (default-value 'buffer-file-coding-system)))))))))
6cd4cfc5 1929
2b54af74
DN
1930(declare-function dired-move-to-filename "dired" (&optional raise-error eol))
1931(declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
1932(declare-function dired-view-file "dired" ())
1933
20a8832d 1934(defun mail-recover ()
918c7db7
EZ
1935 "Recover interrupted mail composition from auto-save files.
1936
1937If the mail buffer has a current valid auto-save file,
1938the command recovers that file. Otherwise, it displays a
1939buffer showing the existing auto-saved draft messages;
1940you can move to one of them and type C-c C-c to recover that one."
20a8832d 1941 (interactive)
6cd4cfc5
EZ
1942 ;; In case they invoke us from some random buffer...
1943 (switch-to-buffer "*mail*")
1944 ;; If *mail* didn't exist, set its directory, so that auto-saved
1945 ;; drafts will be found.
eb1213c1
MR
1946 (let ((dir (expand-file-name
1947 (file-name-as-directory mail-default-directory))))
1948 (if (file-exists-p dir)
1949 (setq default-directory dir)))
6cd4cfc5
EZ
1950 (or (eq major-mode 'mail-mode)
1951 (mail-mode))
1952 (let ((file-name buffer-auto-save-file-name))
1953 (cond ((and file-name (file-exists-p file-name))
1954 (let ((dispbuf
1955 ;; This used to invoke `ls' via call-process, but
1956 ;; dired-noselect is more portable to systems where
1957 ;; `ls' is not a standard program (it will use
1958 ;; ls-lisp instead).
1959 (dired-noselect file-name
254c37a5 1960 (concat dired-listing-switches " -t"))))
8366cfb5 1961 (save-selected-window
37ac18a3 1962 (switch-to-buffer-other-window dispbuf)
8366cfb5
RS
1963 (goto-char (point-min))
1964 (forward-line 2)
1965 (dired-move-to-filename)
1966 (setq dispbuf (rename-buffer "*Directory*" t)))
6cd4cfc5
EZ
1967 (if (not (yes-or-no-p
1968 (format "Recover mail draft from auto save file %s? "
1969 file-name)))
1970 (error "mail-recover cancelled")
1971 (let ((buffer-read-only nil)
1972 (buffer-coding buffer-file-coding-system)
1973 ;; Auto-save files are written in internal
1974 ;; representation of non-ASCII characters.
7f04a67e 1975 (coding-system-for-read 'utf-8-emacs-unix))
6cd4cfc5
EZ
1976 (erase-buffer)
1977 (insert-file-contents file-name nil)
1978 (setq buffer-file-coding-system buffer-coding)))))
1979 (t (mail-recover-1)))))
20a8832d
RS
1980
1981;;;###autoload
1982(defun mail-other-window (&optional noerase to subject in-reply-to cc replybuffer sendactions)
1983 "Like `mail' command, but display mail buffer in another window."
1984 (interactive "P")
3199b96f 1985 (switch-to-buffer-other-window "*mail*")
20a8832d
RS
1986 (mail noerase to subject in-reply-to cc replybuffer sendactions))
1987
1988;;;###autoload
0cc89026
JB
1989(defun mail-other-frame (&optional noerase to subject in-reply-to cc replybuffer sendactions)
1990 "Like `mail' command, but display mail buffer in another frame."
20a8832d 1991 (interactive "P")
3199b96f 1992 (switch-to-buffer-other-frame "*mail*")
20a8832d
RS
1993 (mail noerase to subject in-reply-to cc replybuffer sendactions))
1994
95fe848e 1995;; Do not add anything but external entries on this page.
49116ac0
JB
1996
1997(provide 'sendmail)
1998
328f984d
GM
1999;; Local Variables:
2000;; byte-compile-dynamic: t
2001;; coding: utf-8
2002;; End:
2003
c88ab9ce 2004;;; sendmail.el ends here