summaryrefslogtreecommitdiffstats
path: root/Lib/email/message.py
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2012-06-17 19:26:35 (GMT)
committerR David Murray <rdmurray@bitdance.com>2012-06-17 19:26:35 (GMT)
commit3ac8c780f4fdb32f07b03954e38e23a1ce6fb99c (patch)
treeecb4301e909b5cfe413e1b50bc600cd542aec8ad /Lib/email/message.py
parentf90ea1f0a0e258deb7211ce6736f050ce4f22ae2 (diff)
downloadcpython-3ac8c780f4fdb32f07b03954e38e23a1ce6fb99c.zip
cpython-3ac8c780f4fdb32f07b03954e38e23a1ce6fb99c.tar.gz
cpython-3ac8c780f4fdb32f07b03954e38e23a1ce6fb99c.tar.bz2
Update out of date docstring.
Diffstat (limited to 'Lib/email/message.py')
-rw-r--r--Lib/email/message.py12
1 files changed, 5 insertions, 7 deletions
diff --git a/Lib/email/message.py b/Lib/email/message.py
index 922617a..f1ffcdb 100644
--- a/Lib/email/message.py
+++ b/Lib/email/message.py
@@ -613,17 +613,15 @@ class Message:
the form (CHARSET, LANGUAGE, VALUE). Note that both CHARSET and
LANGUAGE can be None, in which case you should consider VALUE to be
encoded in the us-ascii charset. You can usually ignore LANGUAGE.
+ The parameter value (either the returned string, or the VALUE item in
+ the 3-tuple) is always unquoted, unless unquote is set to False.
- Your application should be prepared to deal with 3-tuple return
- values, and can convert the parameter to a Unicode string like so:
+ If your application doesn't care whether the parameter was RFC 2231
+ encoded, it can turn the return value into a string as follows:
param = msg.get_param('foo')
- if isinstance(param, tuple):
- param = unicode(param[2], param[0] or 'us-ascii')
+ param = email.utils.collapse_rfc2231_value(rawparam)
- In any case, the parameter value (either the returned string, or the
- VALUE item in the 3-tuple) is always unquoted, unless unquote is set
- to False.
"""
if header not in self:
return failobj