summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2013-02-19 17:17:31 (GMT)
committerR David Murray <rdmurray@bitdance.com>2013-02-19 17:17:31 (GMT)
commit774a39f26ef2fa8ed96f3c52d3edac5e93926b4b (patch)
treea7fb7a639755bc6843c6189d9b928e0039433bcd /Doc/library
parent6b30759022d836099a0844983816edaa5e64f52f (diff)
downloadcpython-774a39f26ef2fa8ed96f3c52d3edac5e93926b4b.zip
cpython-774a39f26ef2fa8ed96f3c52d3edac5e93926b4b.tar.gz
cpython-774a39f26ef2fa8ed96f3c52d3edac5e93926b4b.tar.bz2
#13700: Make imap.authenticate with authobject work.
This fixes a bytes/string confusion in the API which prevented custom authobjects from working at all. Original patch by Erno Tukia.
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/imaplib.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/Doc/library/imaplib.rst b/Doc/library/imaplib.rst
index 3f45c95..da6cc8c 100644
--- a/Doc/library/imaplib.rst
+++ b/Doc/library/imaplib.rst
@@ -176,9 +176,10 @@ An :class:`IMAP4` instance has the following methods:
data = authobject(response)
- It will be called to process server continuation responses. It should return
- ``data`` that will be encoded and sent to server. It should return ``None`` if
- the client abort response ``*`` should be sent instead.
+ It will be called to process server continuation responses; the *response*
+ argument it is passed will be ``bytes``. It should return ``bytes`` *data*
+ that will be base64 encoded and sent to the server. It should return
+ ``None`` if the client abort response ``*`` should be sent instead.
.. method:: IMAP4.check()