-
-
Notifications
You must be signed in to change notification settings - Fork 34.6k
gh-137339: Clarify host and port parameter behavior in smtplib.SMTP_SSL initialization #137340
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 3 commits
65451a6
7337b6d
54907a0
4be90cd
d975adf
220e8f6
749a316
e4d78cf
f779ba4
ae806be
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,11 +23,13 @@ | |
|
|
||
| .. class:: SMTP(host='', port=0, local_hostname=None[, timeout], source_address=None) | ||
|
|
||
| An :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 specified, | ||
| *local_hostname* is used as the FQDN of the local host in the HELO/EHLO | ||
| that support a full repertoire of SMTP and ESMTP operations. | ||
| If *host* is omitted or set to an empty string, no connection is made during initialization; you must | ||
| call :meth:`connect` manually before using the instance. | ||
| If *port* is zero,the value of the :attr:`default_port` attribute is used. | ||
|
|
||
| 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 | ||
|
bitdancer marked this conversation as resolved.
|
||
| than a success code, an :exc:`SMTPConnectError` is raised. The optional | ||
|
|
@@ -78,12 +80,16 @@ | |
| .. class:: SMTP_SSL(host='', port=0, local_hostname=None, * [, timeout], \ | ||
| context=None, source_address=None) | ||
|
|
||
| An :class:`SMTP_SSL` instance behaves exactly the same as instances of | ||
|
Check warning on line 83 in Doc/library/smtplib.rst
|
||
| :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 zero, the standard SMTP-over-SSL port (465) is used. The optional | ||
| arguments *local_hostname*, *timeout* and *source_address* have the same | ||
| not appropriate. If the optional *host* and *port* parameters are given, the | ||
| SMTP_SSL :meth:`connect` method is called with those parameters during initialization. | ||
| If *host* is omitted or an empty string, no connection is made during initialization; | ||
| you must call :meth:`connect` manually before using the instance. If | ||
| *port* is zero, the standard SMTP-over-SSL port (465) is used. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The original of this is quite a bit less accurate. I would revise it in an identical fashion to the above, again deferring the explanation of what happens with port to the connection docs, including the default port number mention. |
||
|
|
||
| The optional arguments *local_hostname*, *timeout* and *source_address* have the same | ||
|
bitdancer marked this conversation as resolved.
|
||
| meaning as they do in the :class:`SMTP` class. *context*, also optional, | ||
| can contain a :class:`~ssl.SSLContext` and allows configuring various | ||
| aspects of the secure connection. Please read :ref:`ssl-security` for | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.