[Emacs-diffs] /srv/bzr/emacs/trunk r107285: * lisp/mail/smtpmail.el (smtpmail-query-smtp-server): Give it a doc.

[Glenn Morris]

------------------------------------------------------------
revno: 107285
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Tue 2012-02-14 13:22:47 -0500
message:
  * lisp/mail/smtpmail.el (smtpmail-query-smtp-server): Give it a doc.
modified:
  lisp/ChangeLog
  lisp/mail/smtpmail.el

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2012-02-14 15:43:07 +0000
+++ b/lisp/ChangeLog    2012-02-14 18:22:47 +0000
@@ -1,3 +1,7 @@
+2012-02-14  Glenn Morris  <address@hidden>
+
+       * mail/smtpmail.el (smtpmail-query-smtp-server): Give it a doc.
+
 2012-02-14  Lars Ingebrigtsen  <address@hidden>
 
        * mail/smtpmail.el (smtpmail-query-smtp-server): Fix typo in the

=== modified file 'lisp/mail/smtpmail.el'
--- a/lisp/mail/smtpmail.el     2012-02-14 15:43:07 +0000
+++ b/lisp/mail/smtpmail.el     2012-02-14 18:22:47 +0000
@@ -1,6 +1,6 @@
 ;;; smtpmail.el --- simple SMTP protocol (RFC 821) for sending mail
 
-;; Copyright (C) 1995-1996, 2001-2012  Free Software Foundation, Inc.
+;; Copyright (C) 1995-1996, 2001-2012 Free Software Foundation, Inc.
 
 ;; Author: Tomoji Kagatani <address@hidden>
 ;; Maintainer: Simon Josefsson <address@hidden>
@@ -596,6 +596,12 @@
   (mapconcat 'identity (cdr response) "\n"))
 
 (defun smtpmail-query-smtp-server ()
+  "Query for an SMTP server and try to contact it.
+If the contact succeeds, customizes and saves `smtpmail-smtp-server'
+and `smtpmail-smtp-service'.  This tries standard SMTP ports, and if
+none works asks you to supply one.  If you know that you need to use
+a non-standard port, you can set `smtpmail-smtp-service' in advance.
+Returns an error if the server cannot be contacted."
   (let ((server (read-string "Outgoing SMTP mail server: "))
        (ports '(25 587))
        stream port prompted)
@@ -608,8 +614,7 @@
                                (open-network-stream "smtp" nil server port)
                              (quit nil)
                              (error nil))))
-         ;; We've used up the list of default ports, so query the
-         ;; user.
+         ;; We've used up the list of default ports, so query the user.
          (when (and (not ports)
                     (not prompted))
            (push (read-number (format "Port number to use when contacting %s? "