summaryrefslogtreecommitdiffstats
path: root/Doc/library/imaplib.rst
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2013-02-19 17:19:13 (GMT)
committerR David Murray <rdmurray@bitdance.com>2013-02-19 17:19:13 (GMT)
commit6cd6f015567d35be5831f0095b39a512842d31f2 (patch)
treeffedc8a64cf6e8b120ae48a27ef5d2fcbe14066c /Doc/library/imaplib.rst
parent674a42b1141c2caa6e439a0cc47b07f620520ca4 (diff)
parent774a39f26ef2fa8ed96f3c52d3edac5e93926b4b (diff)
downloadcpython-6cd6f015567d35be5831f0095b39a512842d31f2.zip
cpython-6cd6f015567d35be5831f0095b39a512842d31f2.tar.gz
cpython-6cd6f015567d35be5831f0095b39a512842d31f2.tar.bz2
Merge: #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/imaplib.rst')
-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 626f661..59a61da 100644
--- a/Doc/library/imaplib.rst
+++ b/Doc/library/imaplib.rst
@@ -185,9 +185,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()