summaryrefslogtreecommitdiffstats
path: root/Doc/library/poplib.rst
diff options
context:
space:
mode:
authorAntoine Pitrou <solipsis@pitrou.net>2012-11-23 19:07:39 (GMT)
committerAntoine Pitrou <solipsis@pitrou.net>2012-11-23 19:07:39 (GMT)
commit25cee19beb3117f834100cf29cff625c98d0da29 (patch)
tree327c7f85c59825754afd328915afd57072439f5d /Doc/library/poplib.rst
parentd89824b0e2fa9a44b56394a5185de737a6527ea7 (diff)
downloadcpython-25cee19beb3117f834100cf29cff625c98d0da29.zip
cpython-25cee19beb3117f834100cf29cff625c98d0da29.tar.gz
cpython-25cee19beb3117f834100cf29cff625c98d0da29.tar.bz2
Issue #4473: Add a POP3.capa() method to query the capabilities advertised by the POP3 server.
Patch by Lorenzo Catucci.
Diffstat (limited to 'Doc/library/poplib.rst')
-rw-r--r--Doc/library/poplib.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/Doc/library/poplib.rst b/Doc/library/poplib.rst
index 01f680e..2eb3b72 100644
--- a/Doc/library/poplib.rst
+++ b/Doc/library/poplib.rst
@@ -97,6 +97,14 @@ An :class:`POP3` instance has the following methods:
Returns the greeting string sent by the POP3 server.
+.. method:: POP3.capa()
+
+ Query the server's capabilities as specified in :rfc:`2449`.
+ Returns a dictionary in the form ``{'name': ['param'...]}``.
+
+ .. versionadded:: 3.4
+
+
.. method:: POP3.user(username)
Send user command, response should indicate that a password is required.