Gecko [ v99win.today ]

Name	Size	Permission
2to3.html	63.71 KB	-rw-r--r--
__builtin__.html	11.79 KB	-rw-r--r--
__future__.html	15.58 KB	-rw-r--r--
__main__.html	8.33 KB	-rw-r--r--
_winreg.html	73.99 KB	-rw-r--r--
abc.html	26.82 KB	-rw-r--r--
aepack.html	15.47 KB	-rw-r--r--
aetools.html	18.79 KB	-rw-r--r--
aetypes.html	27.08 KB	-rw-r--r--
aifc.html	29.59 KB	-rw-r--r--
al.html	22.13 KB	-rw-r--r--
allos.html	35.48 KB	-rw-r--r--
anydbm.html	19.31 KB	-rw-r--r--
archiving.html	10.64 KB	-rw-r--r--
argparse.html	269.59 KB	-rw-r--r--
array.html	35.35 KB	-rw-r--r--
ast.html	42.42 KB	-rw-r--r--
asynchat.html	35.84 KB	-rw-r--r--
asyncore.html	43.22 KB	-rw-r--r--
atexit.html	19.23 KB	-rw-r--r--
audioop.html	41.32 KB	-rw-r--r--
autogil.html	9.77 KB	-rw-r--r--
base64.html	24.8 KB	-rw-r--r--
basehttpserver.html	40.6 KB	-rw-r--r--
bastion.html	13.02 KB	-rw-r--r--
bdb.html	50.06 KB	-rw-r--r--
binascii.html	26.64 KB	-rw-r--r--
binhex.html	12.66 KB	-rw-r--r--
bisect.html	28.52 KB	-rw-r--r--
bsddb.html	32.02 KB	-rw-r--r--
bz2.html	31.92 KB	-rw-r--r--
calendar.html	50.16 KB	-rw-r--r--
carbon.html	54.14 KB	-rw-r--r--
cd.html	35.24 KB	-rw-r--r--
cgi.html	58.4 KB	-rw-r--r--
cgihttpserver.html	15.12 KB	-rw-r--r--
cgitb.html	13.5 KB	-rw-r--r--
chunk.html	17.41 KB	-rw-r--r--
cmath.html	32.41 KB	-rw-r--r--
cmd.html	32.69 KB	-rw-r--r--
code.html	28.92 KB	-rw-r--r--
codecs.html	125.92 KB	-rw-r--r--
codeop.html	16.42 KB	-rw-r--r--
collections.html	150.36 KB	-rw-r--r--
colorpicker.html	9.02 KB	-rw-r--r--
colorsys.html	14.38 KB	-rw-r--r--
commands.html	16.63 KB	-rw-r--r--
compileall.html	21.18 KB	-rw-r--r--
compiler.html	78.14 KB	-rw-r--r--
configparser.html	73.92 KB	-rw-r--r--
constants.html	14.68 KB	-rw-r--r--
contextlib.html	22.91 KB	-rw-r--r--
cookie.html	45.38 KB	-rw-r--r--
cookielib.html	102.78 KB	-rw-r--r--
copy.html	14.21 KB	-rw-r--r--
copy_reg.html	15.82 KB	-rw-r--r--
crypt.html	11.62 KB	-rw-r--r--
crypto.html	8.35 KB	-rw-r--r--
csv.html	82.79 KB	-rw-r--r--
ctypes.html	280.57 KB	-rw-r--r--
curses.ascii.html	28.97 KB	-rw-r--r--
curses.html	200.94 KB	-rw-r--r--
curses.panel.html	18.43 KB	-rw-r--r--
custominterp.html	8.59 KB	-rw-r--r--
datatypes.html	18.84 KB	-rw-r--r--
datetime.html	261.02 KB	-rw-r--r--
dbhash.html	18.4 KB	-rw-r--r--
dbm.html	14.75 KB	-rw-r--r--
debug.html	11.28 KB	-rw-r--r--
decimal.html	239.14 KB	-rw-r--r--
development.html	15.27 KB	-rw-r--r--
difflib.html	96.93 KB	-rw-r--r--
dircache.html	13.66 KB	-rw-r--r--
dis.html	96.52 KB	-rw-r--r--
distribution.html	8.27 KB	-rw-r--r--
distutils.html	10.97 KB	-rw-r--r--
dl.html	19.27 KB	-rw-r--r--
doctest.html	193.18 KB	-rw-r--r--
docxmlrpcserver.html	20.02 KB	-rw-r--r--
dumbdbm.html	16.74 KB	-rw-r--r--
dummy_thread.html	11.04 KB	-rw-r--r--
dummy_threading.html	9.96 KB	-rw-r--r--
easydialogs.html	38.83 KB	-rw-r--r--
email-examples.html	47.2 KB	-rw-r--r--
email.charset.html	32.45 KB	-rw-r--r--
email.encoders.html	14.09 KB	-rw-r--r--
email.errors.html	19.2 KB	-rw-r--r--
email.generator.html	24.78 KB	-rw-r--r--
email.header.html	31.12 KB	-rw-r--r--
email.html	55.3 KB	-rw-r--r--
email.iterators.html	14.22 KB	-rw-r--r--
email.message.html	74.91 KB	-rw-r--r--
email.mime.html	34.51 KB	-rw-r--r--
email.parser.html	37.09 KB	-rw-r--r--
email.utils.html	30.04 KB	-rw-r--r--
ensurepip.html	20.21 KB	-rw-r--r--
errno.html	52.31 KB	-rw-r--r--
exceptions.html	73.4 KB	-rw-r--r--
fcntl.html	27.85 KB	-rw-r--r--
filecmp.html	26.49 KB	-rw-r--r--
fileformats.html	10.21 KB	-rw-r--r--
fileinput.html	29.36 KB	-rw-r--r--
filesys.html	11.55 KB	-rw-r--r--
fl.html	71.58 KB	-rw-r--r--
fm.html	15 KB	-rw-r--r--
fnmatch.html	17.78 KB	-rw-r--r--
formatter.html	43.91 KB	-rw-r--r--
fpectl.html	17.84 KB	-rw-r--r--
fpformat.html	12.65 KB	-rw-r--r--
fractions.html	27.17 KB	-rw-r--r--
framework.html	44.24 KB	-rw-r--r--
frameworks.html	8.11 KB	-rw-r--r--
ftplib.html	56.56 KB	-rw-r--r--
functions.html	216.84 KB	-rw-r--r--
functools.html	31.06 KB	-rw-r--r--
future_builtins.html	15.9 KB	-rw-r--r--
gc.html	30.74 KB	-rw-r--r--
gdbm.html	19.35 KB	-rw-r--r--
gensuitemodule.html	14.54 KB	-rw-r--r--
getopt.html	26.56 KB	-rw-r--r--
getpass.html	12.5 KB	-rw-r--r--
gettext.html	91.32 KB	-rw-r--r--
gl.html	26.71 KB	-rw-r--r--
glob.html	15.42 KB	-rw-r--r--
grp.html	12.33 KB	-rw-r--r--
gzip.html	21.95 KB	-rw-r--r--
hashlib.html	27.4 KB	-rw-r--r--
heapq.html	36.72 KB	-rw-r--r--
hmac.html	15.97 KB	-rw-r--r--
hotshot.html	22.69 KB	-rw-r--r--
htmllib.html	29.9 KB	-rw-r--r--
htmlparser.html	45.11 KB	-rw-r--r--
httplib.html	78.55 KB	-rw-r--r--
i18n.html	10.61 KB	-rw-r--r--
ic.html	22.03 KB	-rw-r--r--
idle.html	45.74 KB	-rw-r--r--
imageop.html	20.94 KB	-rw-r--r--
imaplib.html	69.9 KB	-rw-r--r--
imgfile.html	14.91 KB	-rw-r--r--
imghdr.html	13.43 KB	-rw-r--r--
imp.html	41.48 KB	-rw-r--r--
importlib.html	10.27 KB	-rw-r--r--
imputil.html	36.11 KB	-rw-r--r--
index.html	82.54 KB	-rw-r--r--
inspect.html	64.31 KB	-rw-r--r--
internet.html	26.77 KB	-rw-r--r--
intro.html	9.76 KB	-rw-r--r--
io.html	122.3 KB	-rw-r--r--
ipc.html	17.18 KB	-rw-r--r--
itertools.html	129.91 KB	-rw-r--r--
jpeg.html	15.36 KB	-rw-r--r--
json.html	79.09 KB	-rw-r--r--
keyword.html	9.27 KB	-rw-r--r--
language.html	12.35 KB	-rw-r--r--
linecache.html	12.7 KB	-rw-r--r--
locale.html	68.54 KB	-rw-r--r--
logging.config.html	82.23 KB	-rw-r--r--
logging.handlers.html	91.96 KB	-rw-r--r--
logging.html	123.15 KB	-rw-r--r--
mac.html	24.49 KB	-rw-r--r--
macos.html	18.51 KB	-rw-r--r--
macosa.html	14.55 KB	-rw-r--r--
macostools.html	19.67 KB	-rw-r--r--
macpath.html	9.19 KB	-rw-r--r--
mailbox.html	185.53 KB	-rw-r--r--
mailcap.html	15.3 KB	-rw-r--r--
markup.html	20.37 KB	-rw-r--r--
marshal.html	19.88 KB	-rw-r--r--
math.html	50.52 KB	-rw-r--r--
md5.html	16.65 KB	-rw-r--r--
mhlib.html	30.04 KB	-rw-r--r--
mimetools.html	23.84 KB	-rw-r--r--
mimetypes.html	35.82 KB	-rw-r--r--
mimewriter.html	18.19 KB	-rw-r--r--
mimify.html	16.96 KB	-rw-r--r--
miniaeframe.html	14.5 KB	-rw-r--r--
misc.html	7.77 KB	-rw-r--r--
mm.html	10.19 KB	-rw-r--r--
mmap.html	33.52 KB	-rw-r--r--
modulefinder.html	19.85 KB	-rw-r--r--
modules.html	9.68 KB	-rw-r--r--
msilib.html	72.78 KB	-rw-r--r--
msvcrt.html	24.1 KB	-rw-r--r--
multifile.html	28.82 KB	-rw-r--r--
multiprocessing.html	423.97 KB	-rw-r--r--
mutex.html	13.56 KB	-rw-r--r--
netdata.html	19.28 KB	-rw-r--r--
netrc.html	15.51 KB	-rw-r--r--
new.html	16.1 KB	-rw-r--r--
nis.html	13.19 KB	-rw-r--r--
nntplib.html	51.08 KB	-rw-r--r--
numbers.html	40.91 KB	-rw-r--r--
numeric.html	14.85 KB	-rw-r--r--
operator.html	118.32 KB	-rw-r--r--
optparse.html	251.08 KB	-rw-r--r--
os.html	270.49 KB	-rw-r--r--
os.path.html	48.87 KB	-rw-r--r--
ossaudiodev.html	49.79 KB	-rw-r--r--
othergui.html	9.98 KB	-rw-r--r--
parser.html	44.52 KB	-rw-r--r--
pdb.html	41.44 KB	-rw-r--r--
persistence.html	16.25 KB	-rw-r--r--
pickle.html	107.94 KB	-rw-r--r--
pickletools.html	13.21 KB	-rw-r--r--
pipes.html	21.85 KB	-rw-r--r--
pkgutil.html	30.59 KB	-rw-r--r--
platform.html	40.14 KB	-rw-r--r--
plistlib.html	20.96 KB	-rw-r--r--
popen2.html	30.13 KB	-rw-r--r--
poplib.html	27.93 KB	-rw-r--r--
posix.html	17.27 KB	-rw-r--r--
posixfile.html	23.68 KB	-rw-r--r--
pprint.html	36.42 KB	-rw-r--r--
profile.html	76.65 KB	-rw-r--r--
pty.html	11.42 KB	-rw-r--r--
pwd.html	13.53 KB	-rw-r--r--
py_compile.html	13.33 KB	-rw-r--r--
pyclbr.html	18.14 KB	-rw-r--r--
pydoc.html	14.33 KB	-rw-r--r--
pyexpat.html	93.28 KB	-rw-r--r--
python.html	13.53 KB	-rw-r--r--
queue.html	29.64 KB	-rw-r--r--
quopri.html	14.5 KB	-rw-r--r--
random.html	47.78 KB	-rw-r--r--
re.html	163.11 KB	-rw-r--r--
readline.html	41.2 KB	-rw-r--r--
repr.html	24.57 KB	-rw-r--r--
resource.html	30.86 KB	-rw-r--r--
restricted.html	12.69 KB	-rw-r--r--
rexec.html	43.59 KB	-rw-r--r--
rfc822.html	51.25 KB	-rw-r--r--
rlcompleter.html	15.29 KB	-rw-r--r--
robotparser.html	15.01 KB	-rw-r--r--
runpy.html	23.55 KB	-rw-r--r--
sched.html	21.76 KB	-rw-r--r--
scrolledtext.html	10.67 KB	-rw-r--r--
select.html	50.17 KB	-rw-r--r--
sets.html	39.92 KB	-rw-r--r--
sgi.html	11.09 KB	-rw-r--r--
sgmllib.html	38.77 KB	-rw-r--r--
sha.html	14.55 KB	-rw-r--r--
shelve.html	32.93 KB	-rw-r--r--
shlex.html	38.43 KB	-rw-r--r--
shutil.html	49.49 KB	-rw-r--r--
signal.html	36.52 KB	-rw-r--r--
simplehttpserver.html	21.57 KB	-rw-r--r--
simplexmlrpcserver.html	40.41 KB	-rw-r--r--
site.html	29 KB	-rw-r--r--
smtpd.html	15.64 KB	-rw-r--r--
smtplib.html	51.86 KB	-rw-r--r--
sndhdr.html	12.05 KB	-rw-r--r--
socket.html	126.94 KB	-rw-r--r--
socketserver.html	81.38 KB	-rw-r--r--
someos.html	17.09 KB	-rw-r--r--
spwd.html	12.25 KB	-rw-r--r--
sqlite3.html	154.12 KB	-rw-r--r--
ssl.html	214.5 KB	-rw-r--r--
stat.html	41.11 KB	-rw-r--r--
statvfs.html	13.24 KB	-rw-r--r--
stdtypes.html	309.83 KB	-rw-r--r--
string.html	129.58 KB	-rw-r--r--
stringio.html	21.1 KB	-rw-r--r--
stringprep.html	21.4 KB	-rw-r--r--
strings.html	16.42 KB	-rw-r--r--
struct.html	47.68 KB	-rw-r--r--
subprocess.html	117 KB	-rw-r--r--
sun.html	7.83 KB	-rw-r--r--
sunau.html	35.43 KB	-rw-r--r--
sunaudio.html	21.05 KB	-rw-r--r--
symbol.html	9.06 KB	-rw-r--r--
symtable.html	29.03 KB	-rw-r--r--
sys.html	118.12 KB	-rw-r--r--
sysconfig.html	28.8 KB	-rw-r--r--
syslog.html	21.29 KB	-rw-r--r--
tabnanny.html	12.78 KB	-rw-r--r--
tarfile.html	99.54 KB	-rw-r--r--
telnetlib.html	30.46 KB	-rw-r--r--
tempfile.html	35.02 KB	-rw-r--r--
termios.html	19.22 KB	-rw-r--r--
test.html	61.42 KB	-rw-r--r--
textwrap.html	32.28 KB	-rw-r--r--
thread.html	22.67 KB	-rw-r--r--
threading.html	92.04 KB	-rw-r--r--
time.html	65.55 KB	-rw-r--r--
timeit.html	44.38 KB	-rw-r--r--
tix.html	56.73 KB	-rw-r--r--
tk.html	26.76 KB	-rw-r--r--
tkinter.html	86.67 KB	-rw-r--r--
token.html	27.31 KB	-rw-r--r--
tokenize.html	21.69 KB	-rw-r--r--
trace.html	33.91 KB	-rw-r--r--
traceback.html	44.22 KB	-rw-r--r--
ttk.html	123.83 KB	-rw-r--r--
tty.html	10.95 KB	-rw-r--r--
turtle.html	246.17 KB	-rw-r--r--
types.html	33.66 KB	-rw-r--r--
undoc.html	25.54 KB	-rw-r--r--
unicodedata.html	22.64 KB	-rw-r--r--
unittest.html	246.75 KB	-rw-r--r--
unix.html	11.9 KB	-rw-r--r--
urllib.html	71.61 KB	-rw-r--r--
urllib2.html	128.77 KB	-rw-r--r--
urlparse.html	49.04 KB	-rw-r--r--
user.html	13.41 KB	-rw-r--r--
userdict.html	32.96 KB	-rw-r--r--
uu.html	13.25 KB	-rw-r--r--
uuid.html	33.55 KB	-rw-r--r--
warnings.html	51.86 KB	-rw-r--r--
wave.html	29.08 KB	-rw-r--r--
weakref.html	41.14 KB	-rw-r--r--
webbrowser.html	29.53 KB	-rw-r--r--
whichdb.html	10.44 KB	-rw-r--r--
windows.html	10.37 KB	-rw-r--r--
winsound.html	22.56 KB	-rw-r--r--
wsgiref.html	94.38 KB	-rw-r--r--
xdrlib.html	38.05 KB	-rw-r--r--
xml.dom.html	110.39 KB	-rw-r--r--
xml.dom.minidom.html	45.23 KB	-rw-r--r--
xml.dom.pulldom.html	16.32 KB	-rw-r--r--
xml.etree.elementtree.html	124.2 KB	-rw-r--r--
xml.html	18.76 KB	-rw-r--r--
xml.sax.handler.html	47.5 KB	-rw-r--r--
xml.sax.html	26.04 KB	-rw-r--r--
xml.sax.reader.html	51.4 KB	-rw-r--r--
xml.sax.utils.html	18.11 KB	-rw-r--r--
xmlrpclib.html	71.79 KB	-rw-r--r--
zipfile.html	67.26 KB	-rw-r--r--
zipimport.html	24.32 KB	-rw-r--r--
zlib.html	34.41 KB	-rw-r--r--

Code Editor : email.message.html

<!DOCTYPE html>

<title>18.1.1. email.message: Representing an email message &#8212; Python 2.7.18 documentation</title>
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 2.7.18 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="18.1.2. email.parser: Parsing email messages" href="email.parser.html" />
 <link rel="prev" title="18.1. email — An email and MIME handling package" href="email.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 <link rel="canonical" href="file:///usr/share/doc/python2.7/html/library/email.message.html" />
 <script type="text/javascript" src="../_static/copybutton.js"></script>

</head><body>
<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
 This document is for an old version of Python that is <a href="https://devguide.python.org/devcycle/#end-of-life-branches">no longer supported</a>.
 You should install the python3 and python3-doc packages and read the 
 <a href="file:///usr/share/doc/python3-doc/html/library/email.message.html"> Python documentation for the Python3 version packaged in this release</a>.
</div>
 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="email.parser.html" title="18.1.2. email.parser: Parsing email messages"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="email.html" title="18.1. email — An email and MIME handling package"
 accesskey="P">previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-email.message">
<h1>18.1.1. <a class="reference internal" href="#module-email.message" title="email.message: The base class representing email messages."><code class="xref py py-mod docutils literal notranslate">email.message</code></a>: Representing an email message<a class="headerlink" href="#module-email.message" title="Permalink to this headline">¶</a></h1>
The central class in the <a class="reference internal" href="email.html#module-email" title="email: Package supporting the parsing, manipulating, and generating email messages, including MIME documents."><code class="xref py py-mod docutils literal notranslate">email</code></a> package is the <a class="reference internal" href="#email.message.Message" title="email.message.Message"><code class="xref py py-class docutils literal notranslate">Message</code></a> class,
imported from the <a class="reference internal" href="#module-email.message" title="email.message: The base class representing email messages."><code class="xref py py-mod docutils literal notranslate">email.message</code></a> module. It is the base class for the
<a class="reference internal" href="email.html#module-email" title="email: Package supporting the parsing, manipulating, and generating email messages, including MIME documents."><code class="xref py py-mod docutils literal notranslate">email</code></a> object model. <a class="reference internal" href="#email.message.Message" title="email.message.Message"><code class="xref py py-class docutils literal notranslate">Message</code></a> provides the core functionality for
setting and querying header fields, and for accessing message bodies.
Conceptually, a <a class="reference internal" href="#email.message.Message" title="email.message.Message"><code class="xref py py-class docutils literal notranslate">Message</code></a> object consists of headers and payloads.
Headers are <a class="rfc reference external" href="https://tools.ietf.org/html/rfc2822.html">RFC 2822</a> style field names and values where the field name and
value are separated by a colon. The colon is not part of either the field name
or the field value.
Headers are stored and returned in case-preserving form but are matched
case-insensitively. There may also be a single envelope header, also known as
the Unix-From header or the <code class="docutils literal notranslate">From_</code> header. The payload is either a string
in the case of simple message objects or a list of <a class="reference internal" href="#email.message.Message" title="email.message.Message"><code class="xref py py-class docutils literal notranslate">Message</code></a> objects for
MIME container documents (e.g. multipart/* and
message/rfc822).
<a class="reference internal" href="#email.message.Message" title="email.message.Message"><code class="xref py py-class docutils literal notranslate">Message</code></a> objects provide a mapping style interface for accessing the
message headers, and an explicit interface for accessing both the headers and
the payload. It provides convenience methods for generating a flat text
representation of the message object tree, for accessing commonly used header
parameters, and for recursively walking over the object tree.
Here are the methods of the <a class="reference internal" href="#email.message.Message" title="email.message.Message"><code class="xref py py-class docutils literal notranslate">Message</code></a> class:
<dl class="py class">
<dt class="sig sig-object py" id="email.message.Message">
class email.message.Message<a class="headerlink" href="#email.message.Message" title="Permalink to this definition">¶</a></dt>
<dd>The constructor takes no arguments.
<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.as_string">
as_string([unixfrom])<a class="headerlink" href="#email.message.Message.as_string" title="Permalink to this definition">¶</a></dt>
<dd>Return the entire message flattened as a string. When optional unixfrom
is <code class="docutils literal notranslate">True</code>, the envelope header is included in the returned string.
unixfrom defaults to <code class="docutils literal notranslate">False</code>. Flattening the message may trigger
changes to the <a class="reference internal" href="#email.message.Message" title="email.message.Message"><code class="xref py py-class docutils literal notranslate">Message</code></a> if defaults need to be filled in to
complete the transformation to a string (for example, MIME boundaries may
be generated or modified).
Note that this method is provided as a convenience and may not always
format the message the way you want. For example, by default it mangles
lines that begin with <code class="docutils literal notranslate">From</code>. For more flexibility, instantiate a
<a class="reference internal" href="email.generator.html#email.generator.Generator" title="email.generator.Generator"><code class="xref py py-class docutils literal notranslate">Generator</code></a> instance and use its
<a class="reference internal" href="email.generator.html#email.generator.Generator.flatten" title="email.generator.Generator.flatten"><code class="xref py py-meth docutils literal notranslate">flatten()</code></a> method directly. For example:
<div class="highlight-default notranslate"><div class="highlight"><pre>from cStringIO import StringIO
from email.generator import Generator
fp = StringIO()
g = Generator(fp, mangle_from_=False, maxheaderlen=60)
g.flatten(msg)
text = fp.getvalue()
</pre></div>
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.__str__">
__str__()<a class="headerlink" href="#email.message.Message.__str__" title="Permalink to this definition">¶</a></dt>
<dd>Equivalent to <code class="docutils literal notranslate">as_string(unixfrom=True)</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.is_multipart">
is_multipart()<a class="headerlink" href="#email.message.Message.is_multipart" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if the message’s payload is a list of sub-<a class="reference internal" href="#email.message.Message" title="email.message.Message"><code class="xref py py-class docutils literal notranslate">Message</code></a> objects, otherwise return <code class="docutils literal notranslate">False</code>. When
<a class="reference internal" href="#email.message.Message.is_multipart" title="email.message.Message.is_multipart"><code class="xref py py-meth docutils literal notranslate">is_multipart()</code></a> returns <code class="docutils literal notranslate">False</code>, the payload should be a string object.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.set_unixfrom">
set_unixfrom(unixfrom)<a class="headerlink" href="#email.message.Message.set_unixfrom" title="Permalink to this definition">¶</a></dt>
<dd>Set the message’s envelope header to unixfrom, which should be a string.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.get_unixfrom">
get_unixfrom()<a class="headerlink" href="#email.message.Message.get_unixfrom" title="Permalink to this definition">¶</a></dt>
<dd>Return the message’s envelope header. Defaults to <code class="docutils literal notranslate">None</code> if the
envelope header was never set.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.attach">
attach(payload)<a class="headerlink" href="#email.message.Message.attach" title="Permalink to this definition">¶</a></dt>
<dd>Add the given payload to the current payload, which must be <code class="docutils literal notranslate">None</code> or
a list of <a class="reference internal" href="#email.message.Message" title="email.message.Message"><code class="xref py py-class docutils literal notranslate">Message</code></a> objects before the call. After the call, the
payload will always be a list of <a class="reference internal" href="#email.message.Message" title="email.message.Message"><code class="xref py py-class docutils literal notranslate">Message</code></a> objects. If you want to
set the payload to a scalar object (e.g. a string), use
<a class="reference internal" href="#email.message.Message.set_payload" title="email.message.Message.set_payload"><code class="xref py py-meth docutils literal notranslate">set_payload()</code></a> instead.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.get_payload">
get_payload([i[, decode]])<a class="headerlink" href="#email.message.Message.get_payload" title="Permalink to this definition">¶</a></dt>
<dd>Return the current payload, which will be a list of
<a class="reference internal" href="#email.message.Message" title="email.message.Message"><code class="xref py py-class docutils literal notranslate">Message</code></a> objects when <a class="reference internal" href="#email.message.Message.is_multipart" title="email.message.Message.is_multipart"><code class="xref py py-meth docutils literal notranslate">is_multipart()</code></a> is <code class="docutils literal notranslate">True</code>, or a
string when <a class="reference internal" href="#email.message.Message.is_multipart" title="email.message.Message.is_multipart"><code class="xref py py-meth docutils literal notranslate">is_multipart()</code></a> is <code class="docutils literal notranslate">False</code>. If the payload is a list
and you mutate the list object, you modify the message’s payload in place.
With optional argument i, <a class="reference internal" href="#email.message.Message.get_payload" title="email.message.Message.get_payload"><code class="xref py py-meth docutils literal notranslate">get_payload()</code></a> will return the i-th
element of the payload, counting from zero, if <a class="reference internal" href="#email.message.Message.is_multipart" title="email.message.Message.is_multipart"><code class="xref py py-meth docutils literal notranslate">is_multipart()</code></a> is
<code class="docutils literal notranslate">True</code>. An <code class="xref py py-exc docutils literal notranslate">IndexError</code> will be raised if i is less than 0 or
greater than or equal to the number of items in the payload. If the
payload is a string (i.e. <a class="reference internal" href="#email.message.Message.is_multipart" title="email.message.Message.is_multipart"><code class="xref py py-meth docutils literal notranslate">is_multipart()</code></a> is <code class="docutils literal notranslate">False</code>) and i is
given, a <code class="xref py py-exc docutils literal notranslate">TypeError</code> is raised.
Optional decode is a flag indicating whether the payload should be
decoded or not, according to the Content-Transfer-Encoding
header. When <code class="docutils literal notranslate">True</code> and the message is not a multipart, the payload will
be decoded if this header’s value is <code class="docutils literal notranslate">quoted-printable</code> or <code class="docutils literal notranslate">base64</code>.
If some other encoding is used, or Content-Transfer-Encoding
header is missing, or if the payload has bogus base64 data, the payload is
returned as-is (undecoded). If the message is a multipart and the
decode flag is <code class="docutils literal notranslate">True</code>, then <code class="docutils literal notranslate">None</code> is returned. The default for
decode is <code class="docutils literal notranslate">False</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.set_payload">
set_payload(payload[, charset])<a class="headerlink" href="#email.message.Message.set_payload" title="Permalink to this definition">¶</a></dt>
<dd>Set the entire message object’s payload to payload. It is the client’s
responsibility to ensure the payload invariants. Optional charset sets
the message’s default character set; see <a class="reference internal" href="#email.message.Message.set_charset" title="email.message.Message.set_charset"><code class="xref py py-meth docutils literal notranslate">set_charset()</code></a> for details.
<div class="versionchanged">
Changed in version 2.2.2: charset argument added.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.set_charset">
set_charset(charset)<a class="headerlink" href="#email.message.Message.set_charset" title="Permalink to this definition">¶</a></dt>
<dd>Set the character set of the payload to charset, which can either be a
<a class="reference internal" href="email.charset.html#email.charset.Charset" title="email.charset.Charset"><code class="xref py py-class docutils literal notranslate">Charset</code></a> instance (see <a class="reference internal" href="email.charset.html#module-email.charset" title="email.charset: Character Sets"><code class="xref py py-mod docutils literal notranslate">email.charset</code></a>), a
string naming a character set, or <code class="docutils literal notranslate">None</code>. If it is a string, it will
be converted to a <a class="reference internal" href="email.charset.html#email.charset.Charset" title="email.charset.Charset"><code class="xref py py-class docutils literal notranslate">Charset</code></a> instance. If charset
is <code class="docutils literal notranslate">None</code>, the <code class="docutils literal notranslate">charset</code> parameter will be removed from the
Content-Type header (the message will not be otherwise
modified). Anything else will generate a <code class="xref py py-exc docutils literal notranslate">TypeError</code>.
If there is no existing MIME-Version header one will be
added. If there is no existing Content-Type header, one
will be added with a value of text/plain. Whether the
Content-Type header already exists or not, its <code class="docutils literal notranslate">charset</code>
parameter will be set to charset.output_charset. If
charset.input_charset and charset.output_charset differ, the payload
will be re-encoded to the output_charset. If there is no existing
Content-Transfer-Encoding header, then the payload will be
transfer-encoded, if needed, using the specified
<a class="reference internal" href="email.charset.html#email.charset.Charset" title="email.charset.Charset"><code class="xref py py-class docutils literal notranslate">Charset</code></a>, and a header with the appropriate value
will be added. If a Content-Transfer-Encoding header
already exists, the payload is assumed to already be correctly encoded
using that Content-Transfer-Encoding and is not modified.
The message will be assumed to be of type text/*, with the
payload either in unicode or encoded with charset.input_charset.
It will be encoded or converted to charset.output_charset
and transfer encoded properly, if needed, when generating the plain text
representation of the message. MIME headers (MIME-Version,
Content-Type, Content-Transfer-Encoding) will
be added as needed.
<div class="versionadded">
New in version 2.2.2.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.get_charset">
get_charset()<a class="headerlink" href="#email.message.Message.get_charset" title="Permalink to this definition">¶</a></dt>
<dd>Return the <a class="reference internal" href="email.charset.html#email.charset.Charset" title="email.charset.Charset"><code class="xref py py-class docutils literal notranslate">Charset</code></a> instance associated with the
message’s payload.
<div class="versionadded">
New in version 2.2.2.
</div>
</dd></dl>

The following methods implement a mapping-like interface for accessing the
message’s <a class="rfc reference external" href="https://tools.ietf.org/html/rfc2822.html">RFC 2822</a> headers. Note that there are some semantic differences
between these methods and a normal mapping (i.e. dictionary) interface. For
example, in a dictionary there are no duplicate keys, but here there may be
duplicate message headers. Also, in dictionaries there is no guaranteed
order to the keys returned by <a class="reference internal" href="#email.message.Message.keys" title="email.message.Message.keys"><code class="xref py py-meth docutils literal notranslate">keys()</code></a>, but in a <a class="reference internal" href="#email.message.Message" title="email.message.Message"><code class="xref py py-class docutils literal notranslate">Message</code></a> object,
headers are always returned in the order they appeared in the original
message, or were added to the message later. Any header deleted and then
re-added are always appended to the end of the header list.
These semantic differences are intentional and are biased toward maximal
convenience.
Note that in all cases, any envelope header present in the message is not
included in the mapping interface.
<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.__len__">
__len__()<a class="headerlink" href="#email.message.Message.__len__" title="Permalink to this definition">¶</a></dt>
<dd>Return the total number of headers, including duplicates.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.__contains__">
__contains__(name)<a class="headerlink" href="#email.message.Message.__contains__" title="Permalink to this definition">¶</a></dt>
<dd>Return true if the message object has a field named name. Matching is
done case-insensitively and name should not include the trailing colon.
Used for the <code class="docutils literal notranslate">in</code> operator, e.g.:
<div class="highlight-default notranslate"><div class="highlight"><pre>if &#39;message-id&#39; in myMessage:
 print &#39;Message-ID:&#39;, myMessage[&#39;message-id&#39;]
</pre></div>
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.__getitem__">
__getitem__(name)<a class="headerlink" href="#email.message.Message.__getitem__" title="Permalink to this definition">¶</a></dt>
<dd>Return the value of the named header field. name should not include the
colon field separator. If the header is missing, <code class="docutils literal notranslate">None</code> is returned; a
<code class="xref py py-exc docutils literal notranslate">KeyError</code> is never raised.
Note that if the named field appears more than once in the message’s
headers, exactly which of those field values will be returned is
undefined. Use the <a class="reference internal" href="#email.message.Message.get_all" title="email.message.Message.get_all"><code class="xref py py-meth docutils literal notranslate">get_all()</code></a> method to get the values of all the
extant named headers.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.__setitem__">
__setitem__(name, val)<a class="headerlink" href="#email.message.Message.__setitem__" title="Permalink to this definition">¶</a></dt>
<dd>Add a header to the message with field name name and value val. The
field is appended to the end of the message’s existing fields.
Note that this does not overwrite or delete any existing header with the same
name. If you want to ensure that the new header is the only one present in the
message with field name name, delete the field first, e.g.:
<div class="highlight-default notranslate"><div class="highlight"><pre>del msg[&#39;subject&#39;]
msg[&#39;subject&#39;] = &#39;Python roolz!&#39;
</pre></div>
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.__delitem__">
__delitem__(name)<a class="headerlink" href="#email.message.Message.__delitem__" title="Permalink to this definition">¶</a></dt>
<dd>Delete all occurrences of the field with name name from the message’s
headers. No exception is raised if the named field isn’t present in the headers.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.has_key">
has_key(name)<a class="headerlink" href="#email.message.Message.has_key" title="Permalink to this definition">¶</a></dt>
<dd>Return true if the message contains a header field named name, otherwise
return false.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.keys">
keys()<a class="headerlink" href="#email.message.Message.keys" title="Permalink to this definition">¶</a></dt>
<dd>Return a list of all the message’s header field names.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.values">
values()<a class="headerlink" href="#email.message.Message.values" title="Permalink to this definition">¶</a></dt>
<dd>Return a list of all the message’s field values.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.items">
items()<a class="headerlink" href="#email.message.Message.items" title="Permalink to this definition">¶</a></dt>
<dd>Return a list of 2-tuples containing all the message’s field headers and
values.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.get">
get(name[, failobj])<a class="headerlink" href="#email.message.Message.get" title="Permalink to this definition">¶</a></dt>
<dd>Return the value of the named header field. This is identical to
<a class="reference internal" href="#email.message.Message.__getitem__" title="email.message.Message.__getitem__"><code class="xref py py-meth docutils literal notranslate">__getitem__()</code></a> except that optional failobj is returned if the
named header is missing (defaults to <code class="docutils literal notranslate">None</code>).
</dd></dl>

Here are some additional useful methods:
<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.get_all">
get_all(name[, failobj])<a class="headerlink" href="#email.message.Message.get_all" title="Permalink to this definition">¶</a></dt>
<dd>Return a list of all the values for the field named name. If there are
no such named headers in the message, failobj is returned (defaults to
<code class="docutils literal notranslate">None</code>).
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.add_header">
add_header(_name, _value, **_params)<a class="headerlink" href="#email.message.Message.add_header" title="Permalink to this definition">¶</a></dt>
<dd>Extended header setting. This method is similar to <a class="reference internal" href="#email.message.Message.__setitem__" title="email.message.Message.__setitem__"><code class="xref py py-meth docutils literal notranslate">__setitem__()</code></a>
except that additional header parameters can be provided as keyword
arguments. _name is the header field to add and _value is the
primary value for the header.
For each item in the keyword argument dictionary _params, the key is
taken as the parameter name, with underscores converted to dashes (since
dashes are illegal in Python identifiers). Normally, the parameter will
be added as <code class="docutils literal notranslate">key=&quot;value&quot;</code> unless the value is <code class="docutils literal notranslate">None</code>, in which case
only the key will be added. If the value contains non-ASCII characters,
it must be specified as a three tuple in the format
<code class="docutils literal notranslate">(CHARSET, LANGUAGE, VALUE)</code>, where <code class="docutils literal notranslate">CHARSET</code> is a string naming the
charset to be used to encode the value, <code class="docutils literal notranslate">LANGUAGE</code> can usually be set
to <code class="docutils literal notranslate">None</code> or the empty string (see <a class="rfc reference external" href="https://tools.ietf.org/html/rfc2231.html">RFC 2231</a> for other possibilities),
and <code class="docutils literal notranslate">VALUE</code> is the string value containing non-ASCII code points.
Here’s an example:
<div class="highlight-default notranslate"><div class="highlight"><pre>msg.add_header(&#39;Content-Disposition&#39;, &#39;attachment&#39;, filename=&#39;bud.gif&#39;)
</pre></div>
</div>
This will add a header that looks like
<div class="highlight-default notranslate"><div class="highlight"><pre>Content-Disposition: attachment; filename=&quot;bud.gif&quot;
</pre></div>
</div>
An example with non-ASCII characters:
<div class="highlight-default notranslate"><div class="highlight"><pre>msg.add_header(&#39;Content-Disposition&#39;, &#39;attachment&#39;,
 filename=(&#39;iso-8859-1&#39;, &#39;&#39;, &#39;Fußballer.ppt&#39;))
</pre></div>
</div>
Which produces
<div class="highlight-default notranslate"><div class="highlight"><pre>Content-Disposition: attachment; filename*=&quot;iso-8859-1&#39;&#39;Fu%DFballer.ppt&quot;
</pre></div>
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.replace_header">
replace_header(_name, _value)<a class="headerlink" href="#email.message.Message.replace_header" title="Permalink to this definition">¶</a></dt>
<dd>Replace a header. Replace the first header found in the message that
matches _name, retaining header order and field name case. If no
matching header was found, a <code class="xref py py-exc docutils literal notranslate">KeyError</code> is raised.
<div class="versionadded">
New in version 2.2.2.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.get_content_type">
get_content_type()<a class="headerlink" href="#email.message.Message.get_content_type" title="Permalink to this definition">¶</a></dt>
<dd>Return the message’s content type. The returned string is coerced to
lower case of the form maintype/subtype. If there was no
Content-Type header in the message the default type as given
by <a class="reference internal" href="#email.message.Message.get_default_type" title="email.message.Message.get_default_type"><code class="xref py py-meth docutils literal notranslate">get_default_type()</code></a> will be returned. Since according to
<a class="rfc reference external" href="https://tools.ietf.org/html/rfc2045.html">RFC 2045</a>, messages always have a default type, <a class="reference internal" href="#email.message.Message.get_content_type" title="email.message.Message.get_content_type"><code class="xref py py-meth docutils literal notranslate">get_content_type()</code></a>
will always return a value.
<a class="rfc reference external" href="https://tools.ietf.org/html/rfc2045.html">RFC 2045</a> defines a message’s default type to be text/plain
unless it appears inside a multipart/digest container, in
which case it would be message/rfc822. If the
Content-Type header has an invalid type specification,
<a class="rfc reference external" href="https://tools.ietf.org/html/rfc2045.html">RFC 2045</a> mandates that the default type be text/plain.
<div class="versionadded">
New in version 2.2.2.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.get_content_maintype">
get_content_maintype()<a class="headerlink" href="#email.message.Message.get_content_maintype" title="Permalink to this definition">¶</a></dt>
<dd>Return the message’s main content type. This is the maintype
part of the string returned by <a class="reference internal" href="#email.message.Message.get_content_type" title="email.message.Message.get_content_type"><code class="xref py py-meth docutils literal notranslate">get_content_type()</code></a>.
<div class="versionadded">
New in version 2.2.2.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.get_content_subtype">
get_content_subtype()<a class="headerlink" href="#email.message.Message.get_content_subtype" title="Permalink to this definition">¶</a></dt>
<dd>Return the message’s sub-content type. This is the subtype
part of the string returned by <a class="reference internal" href="#email.message.Message.get_content_type" title="email.message.Message.get_content_type"><code class="xref py py-meth docutils literal notranslate">get_content_type()</code></a>.
<div class="versionadded">
New in version 2.2.2.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.get_default_type">
get_default_type()<a class="headerlink" href="#email.message.Message.get_default_type" title="Permalink to this definition">¶</a></dt>
<dd>Return the default content type. Most messages have a default content
type of text/plain, except for messages that are subparts of
multipart/digest containers. Such subparts have a default
content type of message/rfc822.
<div class="versionadded">
New in version 2.2.2.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.set_default_type">
set_default_type(ctype)<a class="headerlink" href="#email.message.Message.set_default_type" title="Permalink to this definition">¶</a></dt>
<dd>Set the default content type. ctype should either be
text/plain or message/rfc822, although this is not
enforced. The default content type is not stored in the
Content-Type header.
<div class="versionadded">
New in version 2.2.2.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.get_params">
get_params([failobj[, header[, unquote]]])<a class="headerlink" href="#email.message.Message.get_params" title="Permalink to this definition">¶</a></dt>
<dd>Return the message’s Content-Type parameters, as a list.
The elements of the returned list are 2-tuples of key/value pairs, as
split on the <code class="docutils literal notranslate">'='</code> sign. The left hand side of the <code class="docutils literal notranslate">'='</code> is the key,
while the right hand side is the value. If there is no <code class="docutils literal notranslate">'='</code> sign in
the parameter the value is the empty string, otherwise the value is as
described in <a class="reference internal" href="#email.message.Message.get_param" title="email.message.Message.get_param"><code class="xref py py-meth docutils literal notranslate">get_param()</code></a> and is unquoted if optional unquote is
<code class="docutils literal notranslate">True</code> (the default).
Optional failobj is the object to return if there is no
Content-Type header. Optional header is the header to
search instead of Content-Type.
<div class="versionchanged">
Changed in version 2.2.2: unquote argument added.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.get_param">
get_param(param[, failobj[, header[, unquote]]])<a class="headerlink" href="#email.message.Message.get_param" title="Permalink to this definition">¶</a></dt>
<dd>Return the value of the Content-Type header’s parameter
param as a string. If the message has no Content-Type
header or if there is no such parameter, then failobj is returned
(defaults to <code class="docutils literal notranslate">None</code>).
Optional header if given, specifies the message header to use instead of
Content-Type.
Parameter keys are always compared case insensitively. The return value
can either be a string, or a 3-tuple if the parameter was <a class="rfc reference external" href="https://tools.ietf.org/html/rfc2231.html">RFC 2231</a>
encoded. When it’s a 3-tuple, the elements of the value are of the form
<code class="docutils literal notranslate">(CHARSET, LANGUAGE, VALUE)</code>. Note that both <code class="docutils literal notranslate">CHARSET</code> and
<code class="docutils literal notranslate">LANGUAGE</code> can be <code class="docutils literal notranslate">None</code>, in which case you should consider <code class="docutils literal notranslate">VALUE</code>
to be encoded in the <code class="docutils literal notranslate">us-ascii</code> charset. You can usually ignore
<code class="docutils literal notranslate">LANGUAGE</code>.
If your application doesn’t care whether the parameter was encoded as in
<a class="rfc reference external" href="https://tools.ietf.org/html/rfc2231.html">RFC 2231</a>, you can collapse the parameter value by calling
<a class="reference internal" href="email.utils.html#email.utils.collapse_rfc2231_value" title="email.utils.collapse_rfc2231_value"><code class="xref py py-func docutils literal notranslate">email.utils.collapse_rfc2231_value()</code></a>, passing in the return value
from <a class="reference internal" href="#email.message.Message.get_param" title="email.message.Message.get_param"><code class="xref py py-meth docutils literal notranslate">get_param()</code></a>. This will return a suitably decoded Unicode
string when the value is a tuple, or the original string unquoted if it
isn’t. For example:
<div class="highlight-default notranslate"><div class="highlight"><pre>rawparam = msg.get_param(&#39;foo&#39;)
param = email.utils.collapse_rfc2231_value(rawparam)
</pre></div>
</div>
In any case, the parameter value (either the returned string, or the
<code class="docutils literal notranslate">VALUE</code> item in the 3-tuple) is always unquoted, unless unquote is set
to <code class="docutils literal notranslate">False</code>.
<div class="versionchanged">
Changed in version 2.2.2: unquote argument added, and 3-tuple return value possible.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.set_param">
set_param(param, value[, header[, requote[, charset[, language]]]])<a class="headerlink" href="#email.message.Message.set_param" title="Permalink to this definition">¶</a></dt>
<dd>Set a parameter in the Content-Type header. If the
parameter already exists in the header, its value will be replaced with
value. If the Content-Type header as not yet been defined
for this message, it will be set to text/plain and the new
parameter value will be appended as per <a class="rfc reference external" href="https://tools.ietf.org/html/rfc2045.html">RFC 2045</a>.
Optional header specifies an alternative header to
Content-Type, and all parameters will be quoted as necessary
unless optional requote is <code class="docutils literal notranslate">False</code> (the default is <code class="docutils literal notranslate">True</code>).
If optional charset is specified, the parameter will be encoded
according to <a class="rfc reference external" href="https://tools.ietf.org/html/rfc2231.html">RFC 2231</a>. Optional language specifies the RFC 2231
language, defaulting to the empty string. Both charset and language
should be strings.
<div class="versionadded">
New in version 2.2.2.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.del_param">
del_param(param[, header[, requote]])<a class="headerlink" href="#email.message.Message.del_param" title="Permalink to this definition">¶</a></dt>
<dd>Remove the given parameter completely from the Content-Type
header. The header will be re-written in place without the parameter or
its value. All values will be quoted as necessary unless requote is
<code class="docutils literal notranslate">False</code> (the default is <code class="docutils literal notranslate">True</code>). Optional header specifies an
alternative to Content-Type.
<div class="versionadded">
New in version 2.2.2.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.set_type">
set_type(type[, header][, requote])<a class="headerlink" href="#email.message.Message.set_type" title="Permalink to this definition">¶</a></dt>
<dd>Set the main type and subtype for the Content-Type
header. type must be a string in the form maintype/subtype,
otherwise a <code class="xref py py-exc docutils literal notranslate">ValueError</code> is raised.
This method replaces the Content-Type header, keeping all
the parameters in place. If requote is <code class="docutils literal notranslate">False</code>, this leaves the
existing header’s quoting as is, otherwise the parameters will be quoted
(the default).
An alternative header can be specified in the header argument. When the
Content-Type header is set a MIME-Version
header is also added.
<div class="versionadded">
New in version 2.2.2.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.get_filename">
get_filename([failobj])<a class="headerlink" href="#email.message.Message.get_filename" title="Permalink to this definition">¶</a></dt>
<dd>Return the value of the <code class="docutils literal notranslate">filename</code> parameter of the
Content-Disposition header of the message. If the header
does not have a <code class="docutils literal notranslate">filename</code> parameter, this method falls back to looking
for the <code class="docutils literal notranslate">name</code> parameter on the Content-Type header. If
neither is found, or the header is missing, then failobj is returned.
The returned string will always be unquoted as per
<a class="reference internal" href="email.utils.html#email.utils.unquote" title="email.utils.unquote"><code class="xref py py-func docutils literal notranslate">email.utils.unquote()</code></a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.get_boundary">
get_boundary([failobj])<a class="headerlink" href="#email.message.Message.get_boundary" title="Permalink to this definition">¶</a></dt>
<dd>Return the value of the <code class="docutils literal notranslate">boundary</code> parameter of the
Content-Type header of the message, or failobj if either
the header is missing, or has no <code class="docutils literal notranslate">boundary</code> parameter. The returned
string will always be unquoted as per <a class="reference internal" href="email.utils.html#email.utils.unquote" title="email.utils.unquote"><code class="xref py py-func docutils literal notranslate">email.utils.unquote()</code></a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.set_boundary">
set_boundary(boundary)<a class="headerlink" href="#email.message.Message.set_boundary" title="Permalink to this definition">¶</a></dt>
<dd>Set the <code class="docutils literal notranslate">boundary</code> parameter of the Content-Type header to
boundary. <a class="reference internal" href="#email.message.Message.set_boundary" title="email.message.Message.set_boundary"><code class="xref py py-meth docutils literal notranslate">set_boundary()</code></a> will always quote boundary if
necessary. A <a class="reference internal" href="email.errors.html#email.errors.HeaderParseError" title="email.errors.HeaderParseError"><code class="xref py py-exc docutils literal notranslate">HeaderParseError</code></a> is raised if the
message object has no Content-Type header.
Note that using this method is subtly different than deleting the old
Content-Type header and adding a new one with the new
boundary via <a class="reference internal" href="#email.message.Message.add_header" title="email.message.Message.add_header"><code class="xref py py-meth docutils literal notranslate">add_header()</code></a>, because <a class="reference internal" href="#email.message.Message.set_boundary" title="email.message.Message.set_boundary"><code class="xref py py-meth docutils literal notranslate">set_boundary()</code></a> preserves
the order of the Content-Type header in the list of
headers. However, it does not preserve any continuation lines which may
have been present in the original Content-Type header.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.get_content_charset">
get_content_charset([failobj])<a class="headerlink" href="#email.message.Message.get_content_charset" title="Permalink to this definition">¶</a></dt>
<dd>Return the <code class="docutils literal notranslate">charset</code> parameter of the Content-Type header,
coerced to lower case. If there is no Content-Type header, or if
that header has no <code class="docutils literal notranslate">charset</code> parameter, failobj is returned.
Note that this method differs from <a class="reference internal" href="#email.message.Message.get_charset" title="email.message.Message.get_charset"><code class="xref py py-meth docutils literal notranslate">get_charset()</code></a> which returns the
<a class="reference internal" href="email.charset.html#email.charset.Charset" title="email.charset.Charset"><code class="xref py py-class docutils literal notranslate">Charset</code></a> instance for the default encoding of the message body.
<div class="versionadded">
New in version 2.2.2.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.get_charsets">
get_charsets([failobj])<a class="headerlink" href="#email.message.Message.get_charsets" title="Permalink to this definition">¶</a></dt>
<dd>Return a list containing the character set names in the message. If the
message is a multipart, then the list will contain one element
for each subpart in the payload, otherwise, it will be a list of length 1.
Each item in the list will be a string which is the value of the
<code class="docutils literal notranslate">charset</code> parameter in the Content-Type header for the
represented subpart. However, if the subpart has no
Content-Type header, no <code class="docutils literal notranslate">charset</code> parameter, or is not of
the text main MIME type, then that item in the returned list
will be failobj.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.message.Message.walk">
walk()<a class="headerlink" href="#email.message.Message.walk" title="Permalink to this definition">¶</a></dt>
<dd>The <a class="reference internal" href="#email.message.Message.walk" title="email.message.Message.walk"><code class="xref py py-meth docutils literal notranslate">walk()</code></a> method is an all-purpose generator which can be used to
iterate over all the parts and subparts of a message object tree, in
depth-first traversal order. You will typically use <a class="reference internal" href="#email.message.Message.walk" title="email.message.Message.walk"><code class="xref py py-meth docutils literal notranslate">walk()</code></a> as the
iterator in a <code class="docutils literal notranslate">for</code> loop; each iteration returns the next subpart.
Here’s an example that prints the MIME type of every part of a multipart
message structure:
<div class="highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; for part in msg.walk():
... print part.get_content_type()
multipart/report
text/plain
message/delivery-status
text/plain
text/plain
message/rfc822
</pre></div>
</div>
</dd></dl>

<div class="versionchanged">
Changed in version 2.5: The previously deprecated methods <code class="xref py py-meth docutils literal notranslate">get_type()</code>, <code class="xref py py-meth docutils literal notranslate">get_main_type()</code>, and
<code class="xref py py-meth docutils literal notranslate">get_subtype()</code> were removed.
</div>
<a class="reference internal" href="#email.message.Message" title="email.message.Message"><code class="xref py py-class docutils literal notranslate">Message</code></a> objects can also optionally contain two instance attributes,
which can be used when generating the plain text of a MIME message.
<dl class="py attribute">
<dt class="sig sig-object py" id="email.message.Message.preamble">
preamble<a class="headerlink" href="#email.message.Message.preamble" title="Permalink to this definition">¶</a></dt>
<dd>The format of a MIME document allows for some text between the blank line
following the headers, and the first multipart boundary string. Normally,
this text is never visible in a MIME-aware mail reader because it falls
outside the standard MIME armor. However, when viewing the raw text of
the message, or when viewing the message in a non-MIME aware reader, this
text can become visible.
The preamble attribute contains this leading extra-armor text for MIME
documents. When the <a class="reference internal" href="email.parser.html#email.parser.Parser" title="email.parser.Parser"><code class="xref py py-class docutils literal notranslate">Parser</code></a> discovers some text
after the headers but before the first boundary string, it assigns this
text to the message’s preamble attribute. When the
<a class="reference internal" href="email.generator.html#email.generator.Generator" title="email.generator.Generator"><code class="xref py py-class docutils literal notranslate">Generator</code></a> is writing out the plain text
representation of a MIME message, and it finds the
message has a preamble attribute, it will write this text in the area
between the headers and the first boundary. See <a class="reference internal" href="email.parser.html#module-email.parser" title="email.parser: Parse flat text email messages to produce a message object structure."><code class="xref py py-mod docutils literal notranslate">email.parser</code></a> and
<a class="reference internal" href="email.generator.html#module-email.generator" title="email.generator: Generate flat text email messages from a message structure."><code class="xref py py-mod docutils literal notranslate">email.generator</code></a> for details.
Note that if the message object has no preamble, the preamble attribute
will be <code class="docutils literal notranslate">None</code>.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="email.message.Message.epilogue">
epilogue<a class="headerlink" href="#email.message.Message.epilogue" title="Permalink to this definition">¶</a></dt>
<dd>The epilogue attribute acts the same way as the preamble attribute,
except that it contains text that appears between the last boundary and
the end of the message.
<div class="versionchanged">
Changed in version 2.5: You do not need to set the epilogue to the empty string in order for the
<a class="reference internal" href="email.generator.html#email.generator.Generator" title="email.generator.Generator"><code class="xref py py-class docutils literal notranslate">Generator</code></a> to print a newline at the end of the
file.
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="email.message.Message.defects">
defects<a class="headerlink" href="#email.message.Message.defects" title="Permalink to this definition">¶</a></dt>
<dd>The defects attribute contains a list of all the problems found when
parsing this message. See <a class="reference internal" href="email.errors.html#module-email.errors" title="email.errors: The exception classes used by the email package."><code class="xref py py-mod docutils literal notranslate">email.errors</code></a> for a detailed description
of the possible parsing defects.
<div class="versionadded">
New in version 2.4.
</div>
</dd></dl>

</dd></dl>

</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h4>Previous topic</h4>
 <a href="email.html"
 title="previous chapter">18.1. <code class="xref py py-mod docutils literal notranslate">email</code> — An email and MIME handling package</a>
 <h4>Next topic</h4>
 <a href="email.parser.html"
 title="next chapter">18.1.2. <code class="xref py py-mod docutils literal notranslate">email.parser</code>: Parsing email messages</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/library/email.message.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="email.parser.html" title="18.1.2. email.parser: Parsing email messages"
 >next</a> |</li>
 <li class="right" >
 <a href="email.html" title="18.1. email — An email and MIME handling package"
 >previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="netdata.html" >18. Internet Data Handling</a> &#187;</li>
 <li class="nav-item nav-item-3"><a href="email.html" >18.1. <code class="xref py py-mod docutils literal notranslate">email</code> — An email and MIME handling package</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">18.1.1. <code class="xref py py-mod docutils literal notranslate">email.message</code>: Representing an email message</a></li> 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on December 09, 2024.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : email.message.html