summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorGiampaolo Rodolà <g.rodola@gmail.com>2010-08-17 16:09:53 (GMT)
committerGiampaolo Rodolà <g.rodola@gmail.com>2010-08-17 16:09:53 (GMT)
commit42382fedccf1306c09055b68c0b67351118f8065 (patch)
treee92e9f677adda02bbfb194aabfe3dc0e4eabe584 /Doc
parentccfb91c89f9d7515356f31fff4af4c5cbd5eef7a (diff)
downloadcpython-42382fedccf1306c09055b68c0b67351118f8065.zip
cpython-42382fedccf1306c09055b68c0b67351118f8065.tar.gz
cpython-42382fedccf1306c09055b68c0b67351118f8065.tar.bz2
fix issue #8807: adds a context parameter to POP3_SSL class.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/poplib.rst10
-rw-r--r--Doc/whatsnew/3.2.rst7
2 files changed, 15 insertions, 2 deletions
diff --git a/Doc/library/poplib.rst b/Doc/library/poplib.rst
index b397b4b..b60ad0e 100644
--- a/Doc/library/poplib.rst
+++ b/Doc/library/poplib.rst
@@ -32,13 +32,19 @@ A single class is provided by the :mod:`poplib` module:
be used).
-.. class:: POP3_SSL(host, port=POP3_SSL_PORT, keyfile=None, certfile=None[, timeout])
+.. class:: POP3_SSL(host, port=POP3_SSL_PORT, keyfile=None, certfile=None, timeout=None, context=None)
This is a subclass of :class:`POP3` that connects to the server over an SSL
encrypted socket. If *port* is not specified, 995, the standard POP3-over-SSL
port is used. *keyfile* and *certfile* are also optional - they can contain a
PEM formatted private key and certificate chain file for the SSL connection.
- *timeout* works as in the :class:`POP3` constructor.
+ *timeout* works as in the :class:`POP3` constructor. *context* parameter is a
+ :class:`ssl.SSLContext` object which allows bundling SSL configuration
+ options, certificates and private keys into a single (potentially long-lived)
+ structure.
+
+ .. versionchanged:: 3.2
+ *context* parameter added.
One exception is defined as an attribute of the :mod:`poplib` module:
diff --git a/Doc/whatsnew/3.2.rst b/Doc/whatsnew/3.2.rst
index d03a67f..a2b7af4 100644
--- a/Doc/whatsnew/3.2.rst
+++ b/Doc/whatsnew/3.2.rst
@@ -186,6 +186,13 @@ New, Improved, and Deprecated Modules
(Contributed by Giampaolo Rodolà; :issue:`8866`.)
+* :class:`~poplib.POP3_SSL` class now accepts a *context* parameter, which is a
+ :class:`ssl.SSLContext` object allowing bundling SSL configuration options,
+ certificates and private keys into a single (potentially long-lived)
+ structure.
+
+ (Contributed by Giampaolo Rodolà; :issue:`8807`.)
+
Multi-threading
===============