closes bpo-34525: Fix smtplib's authobject() documentation (GH-8965)
This commit is contained in:
parent
9797b7ae44
commit
78deb7f332
|
@ -346,7 +346,7 @@ An :class:`SMTP` instance has the following methods:
|
|||
|
||||
If optional keyword argument *initial_response_ok* is true,
|
||||
``authobject()`` will be called first with no argument. It can return the
|
||||
:rfc:`4954` "initial response" bytes which will be encoded and sent with
|
||||
:rfc:`4954` "initial response" ASCII ``str`` which will be encoded and sent with
|
||||
the ``AUTH`` command as below. If the ``authobject()`` does not support an
|
||||
initial response (e.g. because it requires a challenge), it should return
|
||||
``None`` when called with ``challenge=None``. If *initial_response_ok* is
|
||||
|
@ -355,7 +355,7 @@ An :class:`SMTP` instance has the following methods:
|
|||
If the initial response check returns ``None``, or if *initial_response_ok* is
|
||||
false, ``authobject()`` will be called to process the server's challenge
|
||||
response; the *challenge* argument it is passed will be a ``bytes``. It
|
||||
should return ``bytes`` *data* that will be base64 encoded and sent to the
|
||||
should return ASCII ``str`` *data* that will be base64 encoded and sent to the
|
||||
server.
|
||||
|
||||
The ``SMTP`` class provides ``authobjects`` for the ``CRAM-MD5``, ``PLAIN``,
|
||||
|
|
|
@ -615,7 +615,7 @@ class SMTP:
|
|||
|
||||
It will be called to process the server's challenge response; the
|
||||
challenge argument it is passed will be a bytes. It should return
|
||||
bytes data that will be base64 encoded and sent to the server.
|
||||
an ASCII string that will be base64 encoded and sent to the server.
|
||||
|
||||
Keyword arguments:
|
||||
- initial_response_ok: Allow sending the RFC 4954 initial-response
|
||||
|
|
Loading…
Reference in New Issue