1 ;;; smtp.el --- basic functions to send mail with SMTP server
3 ;; Copyright (C) 1995, 1996, 1998, 1999 Free Software Foundation, Inc.
5 ;; Author: Tomoji Kagatani <kagatani@rbc.ncl.omron.co.jp>
6 ;; Simon Leinen <simon@switch.ch> (ESMTP support)
7 ;; Shuhei KOBAYASHI <shuhei@aqua.ocn.ne.jp>
8 ;; Daiki Ueno <ueno@unixuser.org>
9 ;; Keywords: SMTP, mail
11 ;; This file is part of FLIM (Faithful Library about Internet Message).
13 ;; This program is free software; you can redistribute it and/or
14 ;; modify it under the terms of the GNU General Public License as
15 ;; published by the Free Software Foundation; either version 2, or (at
16 ;; your option) any later version.
18 ;; This program is distributed in the hope that it will be useful, but
19 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 ;; General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with this program; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
35 (require 'mail-utils) ; mail-strip-quoted-names
40 "SMTP protocol for sending mail."
43 (defgroup smtp-extensions nil
44 "SMTP service extensions (RFC1869)."
47 (defcustom smtp-default-server nil
48 "Specify default SMTP server."
49 :type '(choice (const nil) string)
52 (defcustom smtp-server (or (getenv "SMTPSERVER") smtp-default-server)
53 "The name of the host running SMTP server.
54 It can also be a function
55 called from `smtp-via-smtp' with arguments SENDER and RECIPIENTS."
56 :type '(choice (string :tag "Name")
57 (function :tag "Function"))
60 (defcustom smtp-service "smtp"
61 "SMTP service port number. \"smtp\" or 25."
62 :type '(choice (integer :tag "25" 25)
63 (string :tag "smtp" "smtp"))
66 (defcustom smtp-local-domain nil
67 "Local domain name without a host name.
68 If the function (system-name) returns the full internet address,
69 don't define this value."
70 :type '(choice (const nil) string)
73 (defcustom smtp-fqdn nil
74 "Fully qualified domain name used for Message-ID."
75 :type '(choice (const nil) string)
78 (defcustom smtp-use-8bitmime t
79 "If non-nil, use ESMTP 8BITMIME (RFC1652) if available."
81 :group 'smtp-extensions)
83 (defcustom smtp-use-size t
84 "If non-nil, use ESMTP SIZE (RFC1870) if available."
86 :group 'smtp-extensions)
88 (defcustom smtp-use-starttls nil
89 "If non-nil, use STARTTLS (RFC2595) if available."
91 :group 'smtp-extensions)
93 (defcustom smtp-use-sasl nil
94 "If non-nil, use SMTP Authentication (RFC2554) if available."
96 :group 'smtp-extensions)
98 (defcustom smtp-sasl-user-name (user-login-name)
99 "Identification to be used for authorization."
101 :group 'smtp-extensions)
103 (defcustom smtp-sasl-properties nil
104 "Properties set to SASL client."
106 :group 'smtp-extensions)
108 (defcustom smtp-sasl-mechanisms nil
109 "List of authentication mechanisms."
110 :type '(repeat string)
111 :group 'smtp-extensions)
113 (defvar sasl-mechanisms)
115 (autoload 'binary-open-network-stream "raw-io")
117 (defvar smtp-open-connection-function #'binary-open-network-stream)
119 (defvar smtp-read-point nil)
121 (defvar smtp-connection-alist nil)
123 (defvar smtp-submit-package-function #'smtp-submit-package)
126 ;;; A package contains a mail message, an envelope sender address,
127 ;;; and one or more envelope recipient addresses. In ESMTP model
128 ;;; the current sending package should be guaranteed to be accessible
129 ;;; anywhere from the hook methods (or SMTP commands).
132 (luna-define-class smtp-package ()
137 (luna-define-internal-accessors 'smtp-package))
139 (defun smtp-make-package (sender recipients buffer)
140 "Create a new package structure.
141 A package is a unit of SMTP message
142 SENDER specifies the package sender, a string.
143 RECIPIENTS is a list of recipients.
144 BUFFER may be a buffer or a buffer name which contains mail message."
145 (luna-make-entity 'smtp-package :sender sender :recipients recipients :buffer buffer))
147 (defun smtp-package-buffer-internal-size (package)
148 "Return the size of PACKAGE, an integer."
150 (set-buffer (smtp-package-buffer-internal package))
153 ;; Add one byte for each change-of-line
154 ;; because or CR-LF representation:
155 (count-lines (point-min) (point-max))
156 ;; For some reason, an empty line is
157 ;; added to the message. Maybe this
158 ;; is a bug, but it can't hurt to add
159 ;; those two bytes anyway:
161 (goto-char (point-min))
162 (while (re-search-forward "^\\." nil t)
163 (setq size (1+ size)))
166 ;;; @ SMTP connection
167 ;;; We should consider the function `open-network-stream' is a emulation
168 ;;; for another network stream. They are likely to be implemented with an
169 ;;; external program and the function `process-contact' returns the
170 ;;; process id instead of `(HOST SERVICE)' pair.
173 (luna-define-class smtp-connection ()
181 (luna-define-internal-accessors 'smtp-connection))
183 (defun smtp-make-connection (process server service)
184 "Create a new connection structure.
185 PROCESS is an internal subprocess-object. SERVER is name of the host
186 to connect to. SERVICE is name of the service desired."
187 (luna-make-entity 'smtp-connection :process process :server server :service service))
189 (luna-define-generic smtp-connection-opened (connection)
190 "Say whether the CONNECTION to server has been opened.")
192 (luna-define-generic smtp-close-connection (connection)
193 "Close the CONNECTION to server.")
195 (luna-define-method smtp-connection-opened ((connection smtp-connection))
196 (let ((process (smtp-connection-process-internal connection)))
197 (if (memq (process-status process) '(open run))
200 (luna-define-method smtp-close-connection ((connection smtp-connection))
201 (let ((process (smtp-connection-process-internal connection)))
202 (delete-process process)))
204 (defun smtp-make-fqdn ()
205 "Return user's fully qualified domain name."
208 (let ((system-name (system-name)))
211 (concat system-name "." smtp-local-domain))
212 ((string-match "[^.]\\.[^.]" system-name)
215 (error "Cannot generate valid FQDN"))))))
217 (defun smtp-find-connection (buffer)
218 "Find the connection delivering to BUFFER."
219 (let ((entry (assq buffer smtp-connection-alist))
222 (setq connection (nth 1 entry))
223 (if (smtp-connection-opened connection)
225 (setq smtp-connection-alist
226 (delq entry smtp-connection-alist))
230 (autoload 'starttls-open-stream "starttls")
231 (autoload 'starttls-negotiate "starttls"))
233 (defun smtp-open-connection (buffer server service)
234 "Open a SMTP connection for a service to a host.
235 Return a newly allocated connection-object.
236 BUFFER is the buffer to associate with the connection. SERVER is name
237 of the host to connect to. SERVICE is name of the service desired."
239 (funcall smtp-open-connection-function
240 "SMTP" buffer server service))
243 (setq connection (smtp-make-connection process server service))
244 (set-process-filter process 'smtp-process-filter)
245 (setq smtp-connection-alist
246 (cons (list buffer connection)
247 smtp-connection-alist))
251 (defun smtp-via-smtp (sender recipients buffer)
252 "Like `smtp-send-buffer', but sucks in any errors."
255 (smtp-send-buffer sender recipients buffer)
259 (make-obsolete 'smtp-via-smtp "It's old API.")
262 (defun smtp-send-buffer (sender recipients buffer)
264 SENDER is an envelope sender address.
265 RECIPIENTS is a list of envelope recipient addresses.
266 BUFFER may be a buffer or a buffer name which contains mail message."
268 (if (functionp smtp-server)
269 (funcall smtp-server sender recipients)
272 (smtp-make-package sender recipients buffer))
273 (smtp-open-connection-function
274 (if smtp-use-starttls
275 #'starttls-open-stream
276 smtp-open-connection-function)))
280 (format "*trace of SMTP session to %s*" server)))
282 (buffer-disable-undo)
283 (unless (smtp-find-connection (current-buffer))
284 (smtp-open-connection (current-buffer) server smtp-service))
285 (make-local-variable 'smtp-read-point)
286 (setq smtp-read-point (point-min))
287 (funcall smtp-submit-package-function package))))
289 (defun smtp-submit-package (package)
292 (smtp-primitive-greeting package)
294 (smtp-primitive-ehlo package)
296 (smtp-primitive-helo package)))
297 (if smtp-use-starttls
298 (smtp-primitive-starttls package))
300 (smtp-primitive-auth package))
301 (smtp-primitive-mailfrom package)
302 (smtp-primitive-rcptto package)
303 (smtp-primitive-data package))
304 (let ((connection (smtp-find-connection (current-buffer))))
305 (when (smtp-connection-opened connection)
306 (smtp-primitive-quit package)
307 (smtp-close-connection connection)))))
309 ;;; @ hook methods for `smtp-submit-package'
312 (defun smtp-primitive-greeting (package)
314 (smtp-find-connection (current-buffer)))
316 (smtp-read-response connection)))
317 (if (/= (car response) 220)
318 (smtp-response-error response))))
320 (defun smtp-primitive-ehlo (package)
322 (smtp-find-connection (current-buffer)))
324 (smtp-send-command connection (format "EHLO %s" (smtp-make-fqdn)))
325 (setq response (smtp-read-response connection))
326 (if (/= (car response) 250)
327 (smtp-response-error response))
328 (smtp-connection-set-extensions-internal
332 (split-string extension)))
334 (car (read-from-string
335 (downcase (car extensions)))))
339 (defun smtp-primitive-helo (package)
341 (smtp-find-connection (current-buffer)))
343 (smtp-send-command connection (format "HELO %s" (smtp-make-fqdn)))
344 (setq response (smtp-read-response connection))
345 (if (/= (car response) 250)
346 (smtp-response-error response))))
348 (defun smtp-primitive-auth (package)
350 (smtp-find-connection (current-buffer)))
352 (cdr (assq 'auth (smtp-connection-extensions-internal connection))))
354 (or smtp-sasl-mechanisms sasl-mechanisms))
356 (sasl-find-mechanism mechanisms))
362 (error "No authentication mechanism available"))
363 (setq client (sasl-make-client mechanism smtp-sasl-user-name "smtp"
364 (smtp-connection-server-internal connection)))
365 (if smtp-sasl-properties
366 (sasl-client-set-properties client smtp-sasl-properties))
367 (setq name (sasl-mechanism-name mechanism)
368 ;; Retrieve the initial response
369 step (sasl-next-step client nil))
372 (if (sasl-step-data step)
373 (format "AUTH %s %s" name (base64-encode-string (sasl-step-data step) t))
374 (format "AUTH %s" name)))
377 (setq response (smtp-read-response connection))
378 (when (= (car response) 235)
379 ;; The authentication process is finished.
380 (setq step (sasl-next-step client step))
383 (smtp-response-error response)) ;Bogus server?
384 (if (/= (car response) 334)
385 (smtp-response-error response))
386 (sasl-step-set-data step (base64-decode-string (nth 1 response)))
387 (setq step (sasl-next-step client step))
390 (if (sasl-step-data step)
391 (base64-encode-string (sasl-step-data step) t)
393 ;;; (smtp-connection-set-encoder-internal
394 ;;; connection (sasl-client-encoder client))
395 ;;; (smtp-connection-set-decoder-internal
396 ;;; connection (sasl-client-decoder client))
399 (defun smtp-primitive-starttls (package)
401 (smtp-find-connection (current-buffer)))
403 ;; STARTTLS --- begin a TLS negotiation (RFC 2595)
404 (smtp-send-command connection "STARTTLS")
405 (setq response (smtp-read-response connection))
406 (if (/= (car response) 220)
407 (smtp-response-error response))
408 (starttls-negotiate (smtp-connection-process-internal connection))))
410 (defun smtp-primitive-mailfrom (package)
412 (smtp-find-connection (current-buffer)))
414 (smtp-connection-extensions-internal
417 (smtp-package-sender-internal package))
420 ;; SIZE --- Message Size Declaration (RFC1870)
421 (if (and smtp-use-size
422 (assq 'size extensions))
423 (setq extension (format "SIZE=%d" (smtp-package-buffer-internal-size package))))
424 ;; 8BITMIME --- 8bit-MIMEtransport (RFC1652)
425 (if (and smtp-use-8bitmime
426 (assq '8bitmime extensions))
427 (setq extension (concat extension " BODY=8BITMIME")))
431 (format "MAIL FROM:<%s> %s" sender extension)
432 (format "MAIL FROM:<%s>" sender)))
433 (setq response (smtp-read-response connection))
434 (if (/= (car response) 250)
435 (smtp-response-error response))))
437 (defun smtp-primitive-rcptto (package)
439 (smtp-find-connection (current-buffer)))
441 (smtp-package-recipients-internal package))
445 connection (format "RCPT TO:<%s>" (pop recipients)))
446 (setq response (smtp-read-response connection))
447 (unless (memq (car response) '(250 251))
448 (smtp-response-error response)))))
450 (defun smtp-primitive-data (package)
452 (smtp-find-connection (current-buffer)))
454 (smtp-send-command connection "DATA")
455 (setq response (smtp-read-response connection))
456 (if (/= (car response) 354)
457 (smtp-response-error response))
459 (set-buffer (smtp-package-buffer-internal package))
460 (goto-char (point-min))
463 connection (buffer-substring (point) (progn (end-of-line)(point))))
464 (beginning-of-line 2)))
465 (smtp-send-command connection ".")
466 (setq response (smtp-read-response connection))
467 (if (/= (car response) 250)
468 (smtp-response-error response))))
470 (defun smtp-primitive-quit (package)
472 (smtp-find-connection (current-buffer)))
474 (smtp-send-command connection "QUIT")
475 (setq response (smtp-read-response connection))
476 (if (/= (car response) 221)
477 (smtp-response-error response))))
479 ;;; @ low level process manipulating function
481 (defun smtp-process-filter (process output)
483 (set-buffer (process-buffer process))
484 (goto-char (point-max))
487 (put 'smtp-error 'error-message "SMTP error")
488 (put 'smtp-error 'error-conditions '(smtp-error error))
490 (put 'smtp-response-error 'error-message "SMTP response error")
491 (put 'smtp-response-error 'error-conditions '(smtp-response-error smtp-error error))
493 (defun smtp-response-error (response)
494 (signal 'smtp-response-error response))
496 (defun smtp-read-response (connection)
498 (smtp-connection-decoder-internal connection))
499 (response-continue t)
501 (while response-continue
502 (goto-char smtp-read-point)
503 (while (not (search-forward "\r\n" nil t))
504 (accept-process-output (smtp-connection-process-internal connection))
505 (goto-char smtp-read-point))
507 (let ((string (buffer-substring smtp-read-point (- (point) 2))))
508 (delete-region smtp-read-point (point))
509 (insert (funcall decoder string) "\r\n")))
512 (list (buffer-substring
513 (+ 4 smtp-read-point)
516 (prog1 smtp-read-point
517 (setq smtp-read-point (point))))
518 (if (looking-at "[1-5][0-9][0-9] ")
519 (setq response (cons (read (point-marker)) response)
520 response-continue nil)))
523 (defun smtp-send-command (connection command)
526 (smtp-connection-process-internal connection))
528 (smtp-connection-encoder-internal connection)))
529 (set-buffer (process-buffer process))
530 (goto-char (point-max))
531 (setq command (concat command "\r\n"))
533 (setq smtp-read-point (point))
535 (setq command (funcall encoder command)))
536 (process-send-string process command))))
538 (defun smtp-send-data (connection data)
540 (smtp-connection-process-internal connection))
542 (smtp-connection-encoder-internal connection)))
543 ;; Escape "." at start of a line.
544 (if (eq (string-to-char data) ?.)
545 (setq data (concat "." data "\r\n"))
546 (setq data (concat data "\r\n")))
548 (setq data (funcall encoder data)))
549 (process-send-string process data)))
551 (defun smtp-deduce-address-list (smtp-text-buffer header-start header-end)
552 "Get address list suitable for smtp RCPT TO:<address>."
553 (let ((simple-address-list "")
557 (smtp-address-buffer (generate-new-buffer " *smtp-mail*")))
561 (set-buffer smtp-address-buffer)
562 (setq case-fold-search t)
564 (insert (save-excursion
565 (set-buffer smtp-text-buffer)
566 (buffer-substring-no-properties header-start header-end)))
567 (goto-char (point-min))
568 ;; RESENT-* fields should stop processing of regular fields.
570 (if (re-search-forward "^RESENT-TO:" header-end t)
572 "^\\(RESENT-TO:\\|RESENT-CC:\\|RESENT-BCC:\\)")
573 (setq addr-regexp "^\\(TO:\\|CC:\\|BCC:\\)")))
575 (while (re-search-forward addr-regexp header-end t)
577 (setq this-line (match-beginning 0))
579 ;; get any continuation lines.
580 (while (and (looking-at "^[ \t]+") (< (point) header-end))
582 (setq this-line-end (point-marker))
583 (setq simple-address-list
584 (concat simple-address-list " "
585 (mail-strip-quoted-names
586 (buffer-substring this-line this-line-end)))))
589 (insert-string simple-address-list)
592 (subst-char-in-region (point-min) (point-max) 10 ? t)
594 (subst-char-in-region (point-min) (point-max) ?, ? t)
596 (subst-char-in-region (point-min) (point-max) 9 ? t)
598 (goto-char (point-min))
599 ;; tidyness in case hook is not robust when it looks at this
600 (while (re-search-forward "[ \t]+" header-end t) (replace-match " "))
602 (goto-char (point-min))
603 (let (recipient-address-list)
604 (while (re-search-forward " \\([^ ]+\\) " (point-max) t)
606 (setq recipient-address-list
607 (cons (buffer-substring (match-beginning 1) (match-end 1))
608 recipient-address-list)))
609 recipient-address-list))
610 (kill-buffer smtp-address-buffer))))
614 ;;; smtp.el ends here