traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

smtplib documentation fixes (GH-8708) 

* SMTP.startssl: Fix doc on keyfile and certfile use

* SMTP.startssl: Add missing keyfile and certfile deprecation notice

* SMTP: Doc grammar fixes
This commit is contained in:
Ville Skyttä 2018-08-13 06:39:19 +03:00 committed by Mariatta
parent 10b59f1b01
commit da12063f2f
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Doc/library/smtplib.rst
View File

@ -271,7 +271,7 @@ An :class:`SMTP` instance has the following methods:
.. method:: SMTP.ehlo_or_helo_if_needed() .. method:: SMTP.ehlo_or_helo_if_needed()
This method call :meth:`ehlo` and or :meth:`helo` if there has been no This method calls :meth:`ehlo` and/or :meth:`helo` if there has been no
previous ``EHLO`` or ``HELO`` command this session. It tries ESMTP ``EHLO`` previous ``EHLO`` or ``HELO`` command this session. It tries ESMTP ``EHLO``
first. first.
@ -379,16 +379,23 @@ An :class:`SMTP` instance has the following methods:
commands that follow will be encrypted. You should then call :meth:`ehlo` commands that follow will be encrypted. You should then call :meth:`ehlo`
again. again.
If *keyfile* and *certfile* are provided, these are passed to the :mod:`socket` If *keyfile* and *certfile* are provided, they are used to create an
module's :func:`ssl` function. :class:`ssl.SSLContext`.
Optional *context* parameter is a :class:`ssl.SSLContext` object; This is Optional *context* parameter is an :class:`ssl.SSLContext` object; This is
an alternative to using a keyfile and a certfile and if specified both an alternative to using a keyfile and a certfile and if specified both
*keyfile* and *certfile* should be ``None``. *keyfile* and *certfile* should be ``None``.
If there has been no previous ``EHLO`` or ``HELO`` command this session, If there has been no previous ``EHLO`` or ``HELO`` command this session,
this method tries ESMTP ``EHLO`` first. this method tries ESMTP ``EHLO`` first.
.. deprecated:: 3.6
*keyfile* and *certfile* are deprecated in favor of *context*.
Please use :meth:`ssl.SSLContext.load_cert_chain` instead, or let
:func:`ssl.create_default_context` select the system's trusted CA
certificates for you.
:exc:`SMTPHeloError` :exc:`SMTPHeloError`
The server didn't reply properly to the ``HELO`` greeting. The server didn't reply properly to the ``HELO`` greeting.