diff options
| author | R David Murray <rdmurray@bitdance.com> | 2012-03-17 02:03:17 (GMT) |
|---|---|---|
| committer | R David Murray <rdmurray@bitdance.com> | 2012-03-17 02:03:17 (GMT) |
| commit | 69ebfe43b07928b33799854d90134e4b68aad8e6 (patch) | |
| tree | e66f11653c0125c1149476eff6e12bdab61a2db2 | |
| parent | 969b8daf5a825f8137a10bb64d91fdbf07c5b27f (diff) | |
| download | cpython-69ebfe43b07928b33799854d90134e4b68aad8e6.zip cpython-69ebfe43b07928b33799854d90134e4b68aad8e6.tar.gz cpython-69ebfe43b07928b33799854d90134e4b68aad8e6.tar.bz2 | |
#11780: document that email.encoders throw TypeError on multipart messages.
| -rw-r--r-- | Doc/library/email.encoders.rst | 4 |
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: |