* smtp.el (smtp-via-smtp): Mark as obsolete.

(smtp-send-buffer): Rename from `smtp-via-smtp'.

* sasl.el: Rearrange.

diff --git a/ChangeLog b/ChangeLog
index e635381..9dcf1b9 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
 2000-11-02   Daiki Ueno  <ueno@unixuser.org>
 
+       * smtp.el (smtp-via-smtp): Mark as obsolete.
+       (smtp-send-buffer): Rename from `smtp-via-smtp'.
+
+2000-11-02   Daiki Ueno  <ueno@unixuser.org>
+
        * sasl.el (sasl-make-authenticator): Allocate a freshly generated
        symbol for each continuation.
 

diff --git a/sasl.el b/sasl.el
index d2e6a4e..b8147ca 100644 (file)
--- a/sasl.el
+++ b/sasl.el
@@ -23,6 +23,9 @@
 ;; Boston, MA 02111-1307, USA.
 
 ;;; Commentary:
+;;
+
+;;; Code:
 
 (require 'poe)
 
@@ -36,15 +39,6 @@
 
 (defvar sasl-unique-id-function #'sasl-unique-id-function)
 
-(defun sasl-make-authenticator (mechanism continuations)
-  (vector mechanism
-         (mapcar
-          (lambda (continuation)
-            (let ((symbol (make-symbol (symbol-name continuation))))
-              (fset symbol (symbol-function continuation))
-              symbol))
-          continuations)))
-
 (defmacro sasl-authenticator-mechanism-internal (authenticator)
   `(aref ,authenticator 0))
 
@@ -66,6 +60,18 @@
 (defmacro sasl-principal-server-internal (principal)
   `(aref ,principal 3))
 
+(defun sasl-make-authenticator (mechanism continuations)
+  "Make an authenticator.
+MECHANISM is a IANA registered SASL mechanism name.
+CONTINUATIONS is list of continuation function."
+  (vector mechanism
+         (mapcar
+          (lambda (continuation)
+            (let ((symbol (make-symbol (symbol-name continuation))))
+              (fset symbol (symbol-function continuation))
+              symbol))
+          continuations)))
+
 (defun sasl-find-authenticator (mechanisms)
   "Retrieve an apropriate authenticator object from MECHANISMS hints."
   (let* ((sasl-mechanisms sasl-mechanisms)
@@ -82,8 +88,12 @@
 
 (defun sasl-evaluate-challenge (authenticator principal &optional challenge)
   "Evaluate the challenge and prepare an appropriate next response.
-The data type of the value and the CHALLENGE is nil or a cons cell of the form
-\(CONTINUATION STRING).  At the first time CONTINUATION should be set to nil."
+The data type of the value and optional 3rd argument CHALLENGE is nil or
+a cons cell of the form \(CONTINUATION STRING).
+At the first time CONTINUATION should be set to nil.
+
+Argument AUTHENTICATOR is the current evaluator.
+Argument PRINCIPAL is the client principal."
   (let* ((continuations
          (sasl-authenticator-continuations-internal authenticator))
         (function

diff --git a/smtp.el b/smtp.el
index fc97404..7e90d18 100644 (file)
--- a/smtp.el
+++ b/smtp.el
@@ -25,6 +25,10 @@
 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 ;; Boston, MA 02111-1307, USA.
 
+
+;;; Commentary:
+;; 
+
 ;;; Code:
 
 (require 'pces)
@@ -45,14 +49,15 @@
   :group 'smtp)
 
 (defcustom smtp-server (or (getenv "SMTPSERVER") smtp-default-server)
-  "The name of the host running SMTP server.  It can also be a function
+  "The name of the host running SMTP server.
+It can also be a function
 called from `smtp-via-smtp' with arguments SENDER and RECIPIENTS."
   :type '(choice (string :tag "Name")
                 (function :tag "Function"))
   :group 'smtp)
 
 (defcustom smtp-service "smtp"
-  "SMTP service port number. \"smtp\" or 25."
+  "SMTP service port number.  \"smtp\" or 25."
   :type '(choice (integer :tag "25" 25)
                  (string :tag "smtp" "smtp"))
   :group 'smtp)
@@ -121,18 +126,28 @@ don't define this value."
 ;;; anywhere from the hook methods (or SMTP commands).
 
 (defmacro smtp-package-sender-internal (package)
+  "Return the sender of PACKAGE, a string."
   `(aref ,package 0))
 
 (defmacro smtp-package-recipients-internal (package)
+  "Return the recipients of PACKAGE, a list of strings."
   `(aref ,package 1))
 
 (defmacro smtp-package-buffer-internal (package)
+  "Return the data of PACKAGE, a buffer."
   `(aref ,package 2))
 
 (defmacro smtp-make-package (sender recipients buffer)
+  "Create a new package structure.
+A package is a unit of SMTP message which contains a mail message,
+an envelope sender address, and one or more envelope recipient addresses.
+SENDER specifies the package sender, a string.
+RECIPIENTS is a list of recipients.
+BUFFER may be a buffer or a buffer name which contains mail message."
   `(vector ,sender ,recipients ,buffer))
 
 (defun smtp-package-buffer-size (package)
+  "Return the size of PACKAGE, an integer."
   (save-excursion
     (set-buffer (smtp-package-buffer-internal package))
     (let ((size
@@ -156,21 +171,31 @@ don't define this value."
 ;;; `process-contact' returns the process ID instead of `(HOST SERVICE)' pair.
 
 (defmacro smtp-connection-process-internal (connection)
+  "Return the subprocess-object of CONNECTION."
   `(aref ,connection 0))
 
 (defmacro smtp-connection-server-internal (connection)
+  "Return the server of CONNECTION, a string."
   `(aref ,connection 1))
 
 (defmacro smtp-connection-service-internal (connection)
+  "Return the service of CONNECTION, a string or an integer."
   `(aref ,connection 2))
 
 (defmacro smtp-connection-extensions-internal (connection)
+  "Return the SMTP extensions of CONNECTION, a list of strings."
   `(aref ,connection 3))
 
 (defmacro smtp-connection-set-extensions-internal (connection extensions)
+  "Set the SMTP extensions of CONNECTION.
+EXTENSIONS is a list of cons cells of the form \(EXTENSION . PARAMETERS).
+Where EXTENSION is a symbol and PARAMETERS is a list of strings."
   `(aset ,connection 3 ,extensions))
 
 (defmacro smtp-make-connection (process server service)
+  "Create a new connection structure.
+PROCESS is an internal subprocess-object.  SERVER is name of the host
+to connect to.  SERVICE is name of the service desired."
   `(vector ,process ,server ,service nil))
 
 (defun smtp-connection-opened (connection)
@@ -195,8 +220,7 @@ don't define this value."
        ((string-match "[^.]\\.[^.]" system-name)
        system-name)
        (t
-       (error "Cannot generate valid FQDN. Set `smtp-fqdn' \
-or `smtp-local-domain' correctly."))))))
+       (error "Cannot generate valid FQDN"))))))
 
 (defun smtp-find-connection (buffer)
   "Find the connection delivering to BUFFER."
@@ -215,6 +239,10 @@ or `smtp-local-domain' correctly."))))))
   (autoload 'starttls-negotiate "starttls"))
 
 (defun smtp-open-connection (buffer server service)
+  "Open a SMTP connection for a service to a host.
+Return a newly allocated connection-object.
+BUFFER is the buffer to associate with the connection.  SERVER is name
+of the host to connect to.  SERVICE is name of the service desired."
   (let ((process
         (as-binary-process
          (funcall smtp-open-connection-function
@@ -230,6 +258,16 @@ or `smtp-local-domain' correctly."))))))
 
 ;;;###autoload
 (defun smtp-via-smtp (sender recipients buffer)
+  (condition-case nil
+      (progn
+       (smtp-send-buffer sender recipients buffer)
+       t)
+    (smtp-response-error)))
+
+(make-obsolete 'smtp-via-smtp "It's old API.")
+
+;;;###autoload
+(defun smtp-send-buffer (sender recipients buffer)
   (let ((server
         (if (functionp smtp-server)
             (funcall smtp-server sender recipients)
@@ -250,11 +288,7 @@ or `smtp-local-domain' correctly."))))))
        (smtp-open-connection (current-buffer) server smtp-service))
       (make-local-variable 'smtp-read-point)
       (setq smtp-read-point (point-min))
-      (condition-case nil
-         (progn
-           (funcall smtp-submit-package-function package)
-           t)
-       (smtp-response-error)))))
+      (funcall smtp-submit-package-function package))))
 
 (defun smtp-submit-package (package)
   (unwind-protect
@@ -278,7 +312,7 @@ or `smtp-local-domain' correctly."))))))
        (smtp-close-connection connection)))))
 
 ;;; @ hook methods for `smtp-submit-package'
-;;;
+;;
 (defun smtp-primitive-greeting (package)
   (let* ((connection
          (smtp-find-connection (current-buffer)))
@@ -343,15 +377,14 @@ or `smtp-local-domain' correctly."))))))
            (sasl-find-authenticator mechanisms)))
         mechanism sasl-response response)
     (unless authenticator
-      (error "No authentication mechanism available."))
+      (error "No authentication mechanism available"))
     (setq mechanism (sasl-authenticator-mechanism-internal authenticator)
          ;; Retrieve the initial response
          sasl-response (sasl-evaluate-challenge authenticator principal))
     (smtp-send-command
      process
      (if (nth 1 sasl-response)
-        (format "AUTH %s %s" mechanism (base64-encode-string
-                                        (nth 1 sasl-response) t))
+        (format "AUTH %s %s" mechanism (base64-encode-string (nth 1 sasl-response) t))
        (format "AUTH %s" mechanism)))
     (catch 'done
       (while t