diff options
| author | R David Murray <rdmurray@bitdance.com> | 2012-03-16 22:03:17 -0400 |
|---|---|---|
| committer | R David Murray <rdmurray@bitdance.com> | 2012-03-16 22:03:17 -0400 |
| commit | ff44f96d4d337b004661e686b3b30406b3094f6e (patch) | |
| tree | 655a4aaebdad824fd57506b53fab511522d1496d /Doc/library/email.encoders.rst | |
| parent | 38bf80a7aa223f1024fed93ecb684003d08e1ba1 (diff) | |
| download | cpython-ff44f96d4d337b004661e686b3b30406b3094f6e.tar.gz | |
#11780: document that email.encoders throw TypeError on multipart messages.
Diffstat (limited to 'Doc/library/email.encoders.rst')
| -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 5421b9f66f..3c32c3bb42 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: |