summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2012-03-17 02:06:08 (GMT)
committerR David Murray <rdmurray@bitdance.com>2012-03-17 02:06:08 (GMT)
commit0cc4e53d1d0af3e6b96b35858ffa4c11cd51e6ce (patch)
tree0f5527eb07dc871b8e253f74457c517b788e11ef
parentdbc52f8a0d3c496e642dbc92c684f873e67f3127 (diff)
downloadcpython-0cc4e53d1d0af3e6b96b35858ffa4c11cd51e6ce.zip
cpython-0cc4e53d1d0af3e6b96b35858ffa4c11cd51e6ce.tar.gz
cpython-0cc4e53d1d0af3e6b96b35858ffa4c11cd51e6ce.tar.bz2
#11780: document that email.encoders throw TypeError on multipart messages.
-rw-r--r--Doc/library/email.encoders.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/Doc/library/email.encoders.rst b/Doc/library/email.encoders.rst
index 5421b9f..3c32c3b 100644
--- a/Doc/library/email.encoders.rst
+++ b/Doc/library/email.encoders.rst
@@ -18,6 +18,10 @@ exactly one argument, the message object to encode. They usually extract the
payload, encode it, and reset the payload to this newly encoded value. They
should also set the :mailheader:`Content-Transfer-Encoding` header as appropriate.
+Note that these functions are not meaningful for a multipart message. They
+must be applied to individual subparts instead, and will throw a
+:exc:`TypeError` if passed a message whose type is multipart.
+
Here are the encoding functions provided: