summaryrefslogtreecommitdiffstats
path: root/Doc/library/poplib.rst
diff options
context:
space:
mode:
authorSteve Dower <steve.dower@python.org>2019-06-24 15:42:54 (GMT)
committerGitHub <noreply@github.com>2019-06-24 15:42:54 (GMT)
commit60419a7e96577cf783b3b45bf3984f9fb0d7ddff (patch)
tree2718cb915663c42902621491ba60accce6729d42 /Doc/library/poplib.rst
parent9bbf4d7083a819cbcee2a6cd3df2802d4c50f734 (diff)
downloadcpython-60419a7e96577cf783b3b45bf3984f9fb0d7ddff.zip
cpython-60419a7e96577cf783b3b45bf3984f9fb0d7ddff.tar.gz
cpython-60419a7e96577cf783b3b45bf3984f9fb0d7ddff.tar.bz2
bpo-37363: Add audit events for a range of modules (GH-14301)
Diffstat (limited to 'Doc/library/poplib.rst')
-rw-r--r--Doc/library/poplib.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/Doc/library/poplib.rst b/Doc/library/poplib.rst
index d72b660..d227b53 100644
--- a/Doc/library/poplib.rst
+++ b/Doc/library/poplib.rst
@@ -39,6 +39,12 @@ The :mod:`poplib` module provides two classes:
connection attempt (if not specified, the global default timeout setting will
be used).
+ .. audit-event:: poplib.POP3 "self host port"
+
+ All commands will raise an :ref:`auditing event <auditing>`
+ ``poplib.POP3.putline`` with arguments ``self`` and ``line``,
+ where ``line`` is the bytes about to be sent to the remote host.
+
.. class:: POP3_SSL(host, port=POP3_SSL_PORT, keyfile=None, certfile=None, timeout=None, context=None)
@@ -54,6 +60,12 @@ The :mod:`poplib` module provides two classes:
point to PEM-formatted private key and certificate chain files,
respectively, for the SSL connection.
+ .. audit-event:: poplib.POP3 "self host port"
+
+ All commands will raise an :ref:`auditing event <auditing>`
+ ``poplib.POP3.putline`` with arguments ``self`` and ``line``,
+ where ``line`` is the bytes about to be sent to the remote host.
+
.. versionchanged:: 3.2
*context* parameter added.