cpython: c8914dbe6ead (original) (raw)

Mercurial > cpython

changeset 84291:c8914dbe6ead 2.7

#18179: document the local_hostname parameter. Original patch by Berker Peksag. [#18179]

R David Murray rdmurray@bitdance.com
date	Sun, 23 Jun 2013 16:02:34 -0400
parents	8f0adcb66633
children	9f1f83d23ec4
files	Doc/library/smtplib.rst Lib/smtplib.py
diffstat	2 files changed, 15 insertions(+), 6 deletions(-)[+] [-] Doc/library/smtplib.rst 12 Lib/smtplib.py 9

line wrap: on

line diff

--- a/Doc/library/smtplib.rst +++ b/Doc/library/smtplib.rst @@ -25,7 +25,10 @@ Protocol) and :rfc:1869 (SMTP Service A :class:SMTP instance encapsulates an SMTP connection. It has methods that support a full repertoire of SMTP and ESMTP operations. If the optional host and port parameters are given, the SMTP :meth:connect method is called

with those parameters during initialization. If the :meth:connect call

with those parameters during initialization. If specified, local_hostname is
used as the FQDN of the local host in the HELO/EHLO command. Otherwise, the
local hostname is found using :func:socket.getfqdn. If the
:meth:connect call returns anything other than a success code, an :exc:SMTPConnectError is raised. The optional timeout parameter specifies a timeout in seconds for blocking operations like the connection attempt (if not specified, the @@ -45,7 +48,9 @@ Protocol) and :rfc:1869 (SMTP Service :class:SMTP. :class:SMTP_SSL should be used for situations where SSL is required from the beginning of the connection and using :meth:starttls is not appropriate. If host is not specified, the local host is used. If

port is omitted, the standard SMTP-over-SSL port (465) is used. keyfile

port is omitted, the standard SMTP-over-SSL port (465) is used.
local_hostname has the same meaning as it does for the :class:SMTP class.
keyfile and certfile are also optional, and can contain a PEM formatted private key and certificate chain file for the SSL connection. The optional timeout parameter specifies a timeout in seconds for blocking operations like the @@ -59,7 +64,8 @@ Protocol) and :rfc:1869 (SMTP Service The LMTP protocol, which is very similar to ESMTP, is heavily based on the standard SMTP client. It's common to use Unix sockets for LMTP, so our :meth:connect

method must support that as well as a regular host:port server. To specify a

method must support that as well as a regular host:port server. local_hostname
has the same meaning as it does for the :class:SMTP class. To specify a Unix socket, you must use an absolute path for host, starting with a '/'. Authentication is supported, using the regular SMTP mechanism. When using a Unix

--- a/Lib/smtplib.py +++ b/Lib/smtplib.py @@ -240,7 +240,8 @@ class SMTP: By default, smtplib.SMTP_PORT is used. If a host is specified the connect method is called, and if it returns anything other than a success code an SMTPConnectError is raised. If specified,

   `local_hostname` is used as the FQDN of the local host.  By default,[](#l2.7)

   `local_hostname` is used as the FQDN of the local host for the[](#l2.8)

   HELO/EHLO command.  Otherwise,[](#l2.9)
   the local hostname is found using socket.getfqdn().[](#l2.10)

""" @@ -762,7 +763,8 @@ if _have_ssl: """ This is a subclass derived from SMTP that connects over an SSL encrypted socket (to use this class you need a socket module that was compiled with SSL support). If host is not specified, '' (the local host) is used. If port is

   omitted, the standard SMTP-over-SSL port (465) is used. keyfile and certfile[](#l2.17)

   omitted, the standard SMTP-over-SSL port (465) is used.  local_hostname[](#l2.18)

   has the same meaning as it does in the SMTP class.  keyfile and certfile[](#l2.19)
   are also optional - they can contain a PEM formatted private key and[](#l2.20)
   certificate chain file for the SSL connection.[](#l2.21)
   """[](#l2.22)

@@ -797,7 +799,8 @@ class LMTP(SMTP): The LMTP protocol, which is very similar to ESMTP, is heavily based on the standard SMTP client. It's common to use Unix sockets for LMTP, so our connect() method must support that as well as a regular

host:port server. To specify a Unix socket, you must use an absolute

host:port server. local_hostname has the same meaning as it does in the
SMTP class. To specify a Unix socket, you must use an absolute path as the host, starting with a '/'. Authentication is supported, using the regular SMTP mechanism. When