summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2012-03-17 02:04:25 (GMT)
committerR David Murray <rdmurray@bitdance.com>2012-03-17 02:04:25 (GMT)
commit1ad2eeaa9946340b1a1191385190a3253eb2cff5 (patch)
tree62b760d154a995c1502efb855f7d5c0a30226947 /Doc
parent7104c7295c1f7f99a8323b55c4f2868dfd58f33d (diff)
parent69ebfe43b07928b33799854d90134e4b68aad8e6 (diff)
downloadcpython-1ad2eeaa9946340b1a1191385190a3253eb2cff5.zip
cpython-1ad2eeaa9946340b1a1191385190a3253eb2cff5.tar.gz
cpython-1ad2eeaa9946340b1a1191385190a3253eb2cff5.tar.bz2
Merge #11780: document that email.encoders throw TypeError on multipart messages.
Diffstat (limited to 'Doc')
-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: