/
usr
/
share
/
doc
/
python2-docs
/
html
/
library
/
/usr/share/doc/python2-docs/html/library
mkdir
upload
Name
Size
Mode
Actions
2to3.html
59507
0644
edit
dl
rm
abc.html
25826
0644
edit
dl
rm
aepack.html
14164
0644
edit
dl
rm
aetools.html
16389
0644
edit
dl
rm
aetypes.html
21021
0644
edit
dl
rm
aifc.html
25064
0644
edit
dl
rm
al.html
18672
0644
edit
dl
rm
allos.html
35297
0644
edit
dl
rm
anydbm.html
18124
0644
edit
dl
rm
archiving.html
10078
0644
edit
dl
rm
argparse.html
263616
0644
edit
dl
rm
array.html
31855
0644
edit
dl
rm
ast.html
38167
0644
edit
dl
rm
asynchat.html
33930
0644
edit
dl
rm
asyncore.html
40631
0644
edit
dl
rm
atexit.html
18455
0644
edit
dl
rm
audioop.html
34252
0644
edit
dl
rm
autogil.html
8733
0644
edit
dl
rm
base64.html
21862
0644
edit
dl
rm
basehttpserver.html
37441
0644
edit
dl
rm
bastion.html
11798
0644
edit
dl
rm
bdb.html
41395
0644
edit
dl
rm
binascii.html
22997
0644
edit
dl
rm
binhex.html
11309
0644
edit
dl
rm
bisect.html
24666
0644
edit
dl
rm
bsddb.html
28589
0644
edit
dl
rm
bz2.html
29048
0644
edit
dl
rm
calendar.html
41762
0644
edit
dl
rm
carbon.html
51998
0644
edit
dl
rm
cd.html
30033
0644
edit
dl
rm
cgi.html
55922
0644
edit
dl
rm
cgihttpserver.html
14026
0644
edit
dl
rm
cgitb.html
12263
0644
edit
dl
rm
chunk.html
15899
0644
edit
dl
rm
cmath.html
28365
0644
edit
dl
rm
cmd.html
29042
0644
edit
dl
rm
code.html
26959
0644
edit
dl
rm
codecs.html
118258
0644
edit
dl
rm
codeop.html
15898
0644
edit
dl
rm
collections.html
147647
0644
edit
dl
rm
colorpicker.html
8035
0644
edit
dl
rm
colorsys.html
11919
0644
edit
dl
rm
commands.html
15516
0644
edit
dl
rm
compileall.html
18621
0644
edit
dl
rm
compiler.html
75897
0644
edit
dl
rm
configparser.html
67751
0644
edit
dl
rm
constants.html
13979
0644
edit
dl
rm
contextlib.html
22777
0644
edit
dl
rm
cookie.html
41854
0644
edit
dl
rm
cookielib.html
91032
0644
edit
dl
rm
copy.html
13004
0644
edit
dl
rm
copy_reg.html
14691
0644
edit
dl
rm
crypt.html
10647
0644
edit
dl
rm
crypto.html
7761
0644
edit
dl
rm
csv.html
76456
0644
edit
dl
rm
ctypes.html
264575
0644
edit
dl
rm
curses.ascii.html
24873
0644
edit
dl
rm
curses.html
167501
0644
edit
dl
rm
curses.panel.html
15824
0644
edit
dl
rm
custominterp.html
8026
0644
edit
dl
rm
datatypes.html
18015
0644
edit
dl
rm
datetime.html
253438
0644
edit
dl
rm
dbhash.html
16825
0644
edit
dl
rm
dbm.html
13507
0644
edit
dl
rm
debug.html
10703
0644
edit
dl
rm
decimal.html
222315
0644
edit
dl
rm
development.html
14828
0644
edit
dl
rm
difflib.html
91975
0644
edit
dl
rm
dircache.html
12299
0644
edit
dl
rm
dis.html
84156
0644
edit
dl
rm
distribution.html
7679
0644
edit
dl
rm
distutils.html
10152
0644
edit
dl
rm
dl.html
17668
0644
edit
dl
rm
doctest.html
185883
0644
edit
dl
rm
docxmlrpcserver.html
17573
0644
edit
dl
rm
dumbdbm.html
15549
0644
edit
dl
rm
dummy_thread.html
10065
0644
edit
dl
rm
dummy_threading.html
8934
0644
edit
dl
rm
easydialogs.html
33124
0644
edit
dl
rm
email-examples.html
47424
0644
edit
dl
rm
email.charset.html
29424
0644
edit
dl
rm
email.encoders.html
12847
0644
edit
dl
rm
email.errors.html
17952
0644
edit
dl
rm
email.generator.html
23141
0644
edit
dl
rm
email.header.html
29108
0644
edit
dl
rm
email.html
55722
0644
edit
dl
rm
email.iterators.html
12623
0644
edit
dl
rm
email.message.html
70189
0644
edit
dl
rm
email.mime.html
31655
0644
edit
dl
rm
email.parser.html
35142
0644
edit
dl
rm
email.utils.html
27076
0644
edit
dl
rm
ensurepip.html
18327
0644
edit
dl
rm
errno.html
40246
0644
edit
dl
rm
exceptions.html
63693
0644
edit
dl
rm
fcntl.html
26245
0644
edit
dl
rm
filecmp.html
23997
0644
edit
dl
rm
fileformats.html
9653
0644
edit
dl
rm
fileinput.html
27071
0644
edit
dl
rm
filesys.html
10866
0644
edit
dl
rm
fl.html
56525
0644
edit
dl
rm
fm.html
13009
0644
edit
dl
rm
fnmatch.html
16258
0644
edit
dl
rm
formatter.html
37371
0644
edit
dl
rm
fpectl.html
16879
0644
edit
dl
rm
fpformat.html
11455
0644
edit
dl
rm
fractions.html
24888
0644
edit
dl
rm
framework.html
36934
0644
edit
dl
rm
frameworks.html
7551
0644
edit
dl
rm
ftplib.html
49577
0644
edit
dl
rm
functions.html
205640
0644
edit
dl
rm
functools.html
29645
0644
edit
dl
rm
future_builtins.html
14477
0644
edit
dl
rm
gc.html
28423
0644
edit
dl
rm
gdbm.html
17805
0644
edit
dl
rm
gensuitemodule.html
12574
0644
edit
dl
rm
getopt.html
25280
0644
edit
dl
rm
getpass.html
11426
0644
edit
dl
rm
gettext.html
84971
0644
edit
dl
rm
gl.html
24342
0644
edit
dl
rm
glob.html
14430
0644
edit
dl
rm
grp.html
11316
0644
edit
dl
rm
gzip.html
20576
0644
edit
dl
rm
hashlib.html
25467
0644
edit
dl
rm
heapq.html
34890
0644
edit
dl
rm
hmac.html
14374
0644
edit
dl
rm
hotshot.html
20147
0644
edit
dl
rm
htmllib.html
27682
0644
edit
dl
rm
htmlparser.html
42433
0644
edit
dl
rm
httplib.html
70932
0644
edit
dl
rm
i18n.html
10047
0644
edit
dl
rm
ic.html
18654
0644
edit
dl
rm
idle.html
42148
0644
edit
dl
rm
imageop.html
16099
0644
edit
dl
rm
imaplib.html
58515
0644
edit
dl
rm
imgfile.html
12732
0644
edit
dl
rm
imghdr.html
12238
0644
edit
dl
rm
imp.html
37603
0644
edit
dl
rm
importlib.html
8926
0644
edit
dl
rm
imputil.html
33563
0644
edit
dl
rm
index.html
79088
0644
edit
dl
rm
inspect.html
56823
0644
edit
dl
rm
internet.html
26138
0644
edit
dl
rm
intro.html
9353
0644
edit
dl
rm
io.html
113701
0644
edit
dl
rm
ipc.html
16598
0644
edit
dl
rm
itertools.html
125397
0644
edit
dl
rm
jpeg.html
13757
0644
edit
dl
rm
json.html
73678
0644
edit
dl
rm
keyword.html
8210
0644
edit
dl
rm
language.html
11687
0644
edit
dl
rm
linecache.html
11416
0644
edit
dl
rm
locale.html
61576
0644
edit
dl
rm
logging.config.html
80045
0644
edit
dl
rm
logging.handlers.html
80194
0644
edit
dl
rm
logging.html
110254
0644
edit
dl
rm
mac.html
23376
0644
edit
dl
rm
macos.html
16129
0644
edit
dl
rm
macosa.html
14080
0644
edit
dl
rm
macostools.html
16898
0644
edit
dl
rm
macpath.html
8386
0644
edit
dl
rm
mailbox.html
171121
0644
edit
dl
rm
mailcap.html
14132
0644
edit
dl
rm
markup.html
19862
0644
edit
dl
rm
marshal.html
19456
0644
edit
dl
rm
math.html
44015
0644
edit
dl
rm
md5.html
15123
0644
edit
dl
rm
mhlib.html
24123
0644
edit
dl
rm
mimetools.html
21206
0644
edit
dl
rm
mimetypes.html
30634
0644
edit
dl
rm
mimewriter.html
16078
0644
edit
dl
rm
mimify.html
15279
0644
edit
dl
rm
miniaeframe.html
13109
0644
edit
dl
rm
misc.html
7236
0644
edit
dl
rm
mm.html
9570
0644
edit
dl
rm
mmap.html
30832
0644
edit
dl
rm
modulefinder.html
18096
0644
edit
dl
rm
modules.html
9017
0644
edit
dl
rm
msilib.html
57853
0644
edit
dl
rm
msvcrt.html
21232
0644
edit
dl
rm
multifile.html
26256
0644
edit
dl
rm
multiprocessing.html
414535
0644
edit
dl
rm
mutex.html
12147
0644
edit
dl
rm
netdata.html
18379
0644
edit
dl
rm
netrc.html
14021
0644
edit
dl
rm
new.html
13177
0644
edit
dl
rm
nis.html
11502
0644
edit
dl
rm
nntplib.html
45689
0644
edit
dl
rm
numbers.html
40636
0644
edit
dl
rm
numeric.html
14292
0644
edit
dl
rm
operator.html
93622
0644
edit
dl
rm
optparse.html
250109
0644
edit
dl
rm
os.html
240195
0644
edit
dl
rm
os.path.html
43402
0644
edit
dl
rm
ossaudiodev.html
45594
0644
edit
dl
rm
othergui.html
9403
0644
edit
dl
rm
parser.html
42558
0644
edit
dl
rm
pdb.html
38603
0644
edit
dl
rm
persistence.html
15676
0644
edit
dl
rm
pickle.html
109684
0644
edit
dl
rm
pickletools.html
11475
0644
edit
dl
rm
pipes.html
19685
0644
edit
dl
rm
pkgutil.html
27367
0644
edit
dl
rm
platform.html
31599
0644
edit
dl
rm
plistlib.html
18344
0644
edit
dl
rm
popen2.html
27601
0644
edit
dl
rm
poplib.html
24320
0644
edit
dl
rm
posix.html
16626
0644
edit
dl
rm
posixfile.html
21387
0644
edit
dl
rm
pprint.html
32207
0644
edit
dl
rm
profile.html
72788
0644
edit
dl
rm
pty.html
10195
0644
edit
dl
rm
pwd.html
12388
0644
edit
dl
rm
pyclbr.html
15812
0644
edit
dl
rm
pydoc.html
13650
0644
edit
dl
rm
pyexpat.html
80886
0644
edit
dl
rm
python.html
12854
0644
edit
dl
rm
py_compile.html
11932
0644
edit
dl
rm
queue.html
26856
0644
edit
dl
rm
quopri.html
12739
0644
edit
dl
rm
random.html
42722
0644
edit
dl
rm
re.html
155985
0644
edit
dl
rm
readline.html
37383
0644
edit
dl
rm
repr.html
21778
0644
edit
dl
rm
resource.html
28286
0644
edit
dl
rm
restricted.html
12366
0644
edit
dl
rm
rexec.html
40566
0644
edit
dl
rm
rfc822.html
46408
0644
edit
dl
rm
rlcompleter.html
14460
0644
edit
dl
rm
robotparser.html
13403
0644
edit
dl
rm
runpy.html
21925
0644
edit
dl
rm
sched.html
19878
0644
edit
dl
rm
scrolledtext.html
9728
0644
edit
dl
rm
select.html
44090
0644
edit
dl
rm
sets.html
40151
0644
edit
dl
rm
sgi.html
10371
0644
edit
dl
rm
sgmllib.html
34464
0644
edit
dl
rm
sha.html
13062
0644
edit
dl
rm
shelve.html
29955
0644
edit
dl
rm
shlex.html
35033
0644
edit
dl
rm
shutil.html
45454
0644
edit
dl
rm
signal.html
34023
0644
edit
dl
rm
simplehttpserver.html
20351
0644
edit
dl
rm
simplexmlrpcserver.html
37794
0644
edit
dl
rm
site.html
26887
0644
edit
dl
rm
smtpd.html
13587
0644
edit
dl
rm
smtplib.html
47054
0644
edit
dl
rm
sndhdr.html
10993
0644
edit
dl
rm
socket.html
116414
0644
edit
dl
rm
socketserver.html
76430
0644
edit
dl
rm
someos.html
16472
0644
edit
dl
rm
spwd.html
11163
0644
edit
dl
rm
sqlite3.html
150014
0644
edit
dl
rm
ssl.html
202453
0644
edit
dl
rm
stat.html
34597
0644
edit
dl
rm
statvfs.html
11326
0644
edit
dl
rm
stdtypes.html
298144
0644
edit
dl
rm
string.html
120219
0644
edit
dl
rm
stringio.html
20061
0644
edit
dl
rm
stringprep.html
17729
0644
edit
dl
rm
strings.html
15905
0644
edit
dl
rm
struct.html
44896
0644
edit
dl
rm
subprocess.html
110447
0644
edit
dl
rm
sun.html
7253
0644
edit
dl
rm
sunau.html
30011
0644
edit
dl
rm
sunaudio.html
19236
0644
edit
dl
rm
symbol.html
8140
0644
edit
dl
rm
symtable.html
25871
0644
edit
dl
rm
sys.html
110996
0644
edit
dl
rm
sysconfig.html
26299
0644
edit
dl
rm
syslog.html
19737
0644
edit
dl
rm
tabnanny.html
11393
0644
edit
dl
rm
tarfile.html
88728
0644
edit
dl
rm
telnetlib.html
27782
0644
edit
dl
rm
tempfile.html
31903
0644
edit
dl
rm
termios.html
17309
0644
edit
dl
rm
test.html
57030
0644
edit
dl
rm
textwrap.html
30135
0644
edit
dl
rm
thread.html
21486
0644
edit
dl
rm
threading.html
86655
0644
edit
dl
rm
time.html
63798
0644
edit
dl
rm
timeit.html
40529
0644
edit
dl
rm
tix.html
50582
0644
edit
dl
rm
tk.html
26568
0644
edit
dl
rm
tkinter.html
84316
0644
edit
dl
rm
token.html
20999
0644
edit
dl
rm
tokenize.html
20607
0644
edit
dl
rm
trace.html
28668
0644
edit
dl
rm
traceback.html
40900
0644
edit
dl
rm
ttk.html
108515
0644
edit
dl
rm
tty.html
9753
0644
edit
dl
rm
turtle.html
230483
0644
edit
dl
rm
types.html
29833
0644
edit
dl
rm
undoc.html
24680
0644
edit
dl
rm
unicodedata.html
20186
0644
edit
dl
rm
unittest.html
225021
0644
edit
dl
rm
unix.html
11223
0644
edit
dl
rm
urllib.html
68266
0644
edit
dl
rm
urllib2.html
113380
0644
edit
dl
rm
urlparse.html
43474
0644
edit
dl
rm
user.html
12707
0644
edit
dl
rm
userdict.html
32069
0644
edit
dl
rm
uu.html
11810
0644
edit
dl
rm
uuid.html
30137
0644
edit
dl
rm
warnings.html
50950
0644
edit
dl
rm
wave.html
24894
0644
edit
dl
rm
weakref.html
38808
0644
edit
dl
rm
webbrowser.html
26565
0644
edit
dl
rm
whichdb.html
9499
0644
edit
dl
rm
windows.html
9817
0644
edit
dl
rm
winsound.html
20466
0644
edit
dl
rm
wsgiref.html
88384
0644
edit
dl
rm
xdrlib.html
33018
0644
edit
dl
rm
xml.dom.html
97877
0644
edit
dl
rm
xml.dom.minidom.html
43230
0644
edit
dl
rm
xml.dom.pulldom.html
13835
0644
edit
dl
rm
xml.etree.elementtree.html
111804
0644
edit
dl
rm
xml.html
18007
0644
edit
dl
rm
xml.sax.handler.html
41877
0644
edit
dl
rm
xml.sax.html
23458
0644
edit
dl
rm
xml.sax.reader.html
44802
0644
edit
dl
rm
xml.sax.utils.html
16087
0644
edit
dl
rm
xmlrpclib.html
69191
0644
edit
dl
rm
zipfile.html
62227
0644
edit
dl
rm
zipimport.html
22769
0644
edit
dl
rm
zlib.html
31230
0644
edit
dl
rm
_winreg.html
64631
0644
edit
dl
rm
__builtin__.html
11069
0644
edit
dl
rm
__future__.html
14688
0644
edit
dl
rm
__main__.html
7512
0644
edit
dl
rm
Edit:
/usr/share/doc/python2-docs/html/library/rfc822.html
(46408B)
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>18.11. rfc822 — Parse RFC 2822 mail headers — Python 2.7.16 documentation</title> <link rel="stylesheet" href="../_static/classic.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 2.7.16 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.12. base64 — RFC 3548: Base16, Base32, Base64 Data Encodings" href="base64.html" /> <link rel="prev" title="18.10. multifile — Support for files containing distinct parts" href="multifile.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> <link rel="canonical" href="https://docs.python.org/2/library/rfc822.html" /> <script type="text/javascript" src="../_static/copybutton.js"></script> </head><body> <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="base64.html" title="18.12. base64 — RFC 3548: Base16, Base32, Base64 Data Encodings" accesskey="N">next</a> |</li> <li class="right" > <a href="multifile.html" title="18.10. multifile — Support for files containing distinct parts" 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> »</li> <li> <a href="../index.html">Python 2.7.16 documentation</a> » </li> <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li> <li class="nav-item nav-item-2"><a href="netdata.html" accesskey="U">18. Internet Data Handling</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <div class="section" id="module-rfc822"> <span id="rfc822-parse-rfc-2822-mail-headers"></span><h1>18.11. <a class="reference internal" href="#module-rfc822" title="rfc822: Parse 2822 style mail messages. (deprecated)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">rfc822</span></code></a> — Parse RFC 2822 mail headers<a class="headerlink" href="#module-rfc822" title="Permalink to this headline">¶</a></h1> <div class="deprecated"> <p><span class="versionmodified">Deprecated since version 2.3: </span>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"><span class="pre">email</span></code></a> package should be used in preference to the <a class="reference internal" href="#module-rfc822" title="rfc822: Parse 2822 style mail messages. (deprecated)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">rfc822</span></code></a> module. This module is present only to maintain backward compatibility, and has been removed in Python 3.</p> </div> <p>This module defines a class, <a class="reference internal" href="#rfc822.Message" title="rfc822.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a>, which represents an “email message” as defined by the Internet standard <span class="target" id="index-0"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a>. <a class="footnote-reference" href="#id4" id="id1">[1]</a> Such messages consist of a collection of message headers, and a message body. This module also defines a helper class <a class="reference internal" href="#rfc822.AddressList" title="rfc822.AddressList"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddressList</span></code></a> for parsing <span class="target" id="index-1"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a> addresses. Please refer to the RFC for information on the specific syntax of <span class="target" id="index-2"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a> messages.</p> <p id="index-3">The <a class="reference internal" href="mailbox.html#module-mailbox" title="mailbox: Manipulate mailboxes in various formats"><code class="xref py py-mod docutils literal notranslate"><span class="pre">mailbox</span></code></a> module provides classes to read mailboxes produced by various end-user mail programs.</p> <dl class="class"> <dt id="rfc822.Message"> <em class="property">class </em><code class="descclassname">rfc822.</code><code class="descname">Message</code><span class="sig-paren">(</span><em>file</em><span class="optional">[</span>, <em>seekable</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.Message" title="Permalink to this definition">¶</a></dt> <dd><p>A <a class="reference internal" href="#rfc822.Message" title="rfc822.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> instance is instantiated with an input object as parameter. Message relies only on the input object having a <a class="reference internal" href="readline.html#module-readline" title="readline: GNU readline support for Python. (Unix)"><code class="xref py py-meth docutils literal notranslate"><span class="pre">readline()</span></code></a> method; in particular, ordinary file objects qualify. Instantiation reads headers from the input object up to a delimiter line (normally a blank line) and stores them in the instance. The message body, following the headers, is not consumed.</p> <p>This class can work with any input object that supports a <a class="reference internal" href="readline.html#module-readline" title="readline: GNU readline support for Python. (Unix)"><code class="xref py py-meth docutils literal notranslate"><span class="pre">readline()</span></code></a> method. If the input object has seek and tell capability, the <a class="reference internal" href="#rfc822.Message.rewindbody" title="rfc822.Message.rewindbody"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rewindbody()</span></code></a> method will work; also, illegal lines will be pushed back onto the input stream. If the input object lacks seek but has an <code class="xref py py-meth docutils literal notranslate"><span class="pre">unread()</span></code> method that can push back a line of input, <a class="reference internal" href="#rfc822.Message" title="rfc822.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> will use that to push back illegal lines. Thus this class can be used to parse messages coming from a buffered stream.</p> <p>The optional <em>seekable</em> argument is provided as a workaround for certain stdio libraries in which <code class="xref c c-func docutils literal notranslate"><span class="pre">tell()</span></code> discards buffered data before discovering that the <code class="xref c c-func docutils literal notranslate"><span class="pre">lseek()</span></code> system call doesn’t work. For maximum portability, you should set the seekable argument to zero to prevent that initial <code class="xref py py-meth docutils literal notranslate"><span class="pre">tell()</span></code> when passing in an unseekable object such as a file object created from a socket object.</p> <p>Input lines as read from the file may either be terminated by CR-LF or by a single linefeed; a terminating CR-LF is replaced by a single linefeed before the line is stored.</p> <p>All header matching is done independent of upper or lower case; e.g. <code class="docutils literal notranslate"><span class="pre">m['From']</span></code>, <code class="docutils literal notranslate"><span class="pre">m['from']</span></code> and <code class="docutils literal notranslate"><span class="pre">m['FROM']</span></code> all yield the same result.</p> </dd></dl> <dl class="class"> <dt id="rfc822.AddressList"> <em class="property">class </em><code class="descclassname">rfc822.</code><code class="descname">AddressList</code><span class="sig-paren">(</span><em>field</em><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.AddressList" title="Permalink to this definition">¶</a></dt> <dd><p>You may instantiate the <a class="reference internal" href="#rfc822.AddressList" title="rfc822.AddressList"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddressList</span></code></a> helper class using a single string parameter, a comma-separated list of <span class="target" id="index-4"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a> addresses to be parsed. (The parameter <code class="docutils literal notranslate"><span class="pre">None</span></code> yields an empty list.)</p> </dd></dl> <dl class="function"> <dt id="rfc822.quote"> <code class="descclassname">rfc822.</code><code class="descname">quote</code><span class="sig-paren">(</span><em>str</em><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.quote" title="Permalink to this definition">¶</a></dt> <dd><p>Return a new string with backslashes in <em>str</em> replaced by two backslashes and double quotes replaced by backslash-double quote.</p> </dd></dl> <dl class="function"> <dt id="rfc822.unquote"> <code class="descclassname">rfc822.</code><code class="descname">unquote</code><span class="sig-paren">(</span><em>str</em><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.unquote" title="Permalink to this definition">¶</a></dt> <dd><p>Return a new string which is an <em>unquoted</em> version of <em>str</em>. If <em>str</em> ends and begins with double quotes, they are stripped off. Likewise if <em>str</em> ends and begins with angle brackets, they are stripped off.</p> </dd></dl> <dl class="function"> <dt id="rfc822.parseaddr"> <code class="descclassname">rfc822.</code><code class="descname">parseaddr</code><span class="sig-paren">(</span><em>address</em><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.parseaddr" title="Permalink to this definition">¶</a></dt> <dd><p>Parse <em>address</em>, which should be the value of some address-containing field such as <em class="mailheader">To</em> or <em class="mailheader">Cc</em>, into its constituent “realname” and “email address” parts. Returns a tuple of that information, unless the parse fails, in which case a 2-tuple <code class="docutils literal notranslate"><span class="pre">(None,</span> <span class="pre">None)</span></code> is returned.</p> </dd></dl> <dl class="function"> <dt id="rfc822.dump_address_pair"> <code class="descclassname">rfc822.</code><code class="descname">dump_address_pair</code><span class="sig-paren">(</span><em>pair</em><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.dump_address_pair" title="Permalink to this definition">¶</a></dt> <dd><p>The inverse of <a class="reference internal" href="#rfc822.parseaddr" title="rfc822.parseaddr"><code class="xref py py-meth docutils literal notranslate"><span class="pre">parseaddr()</span></code></a>, this takes a 2-tuple of the form <code class="docutils literal notranslate"><span class="pre">(realname,</span> <span class="pre">email_address)</span></code> and returns the string value suitable for a <em class="mailheader">To</em> or <em class="mailheader">Cc</em> header. If the first element of <em>pair</em> is false, then the second element is returned unmodified.</p> </dd></dl> <dl class="function"> <dt id="rfc822.parsedate"> <code class="descclassname">rfc822.</code><code class="descname">parsedate</code><span class="sig-paren">(</span><em>date</em><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.parsedate" title="Permalink to this definition">¶</a></dt> <dd><p>Attempts to parse a date according to the rules in <span class="target" id="index-5"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a>. however, some mailers don’t follow that format as specified, so <a class="reference internal" href="#rfc822.parsedate" title="rfc822.parsedate"><code class="xref py py-func docutils literal notranslate"><span class="pre">parsedate()</span></code></a> tries to guess correctly in such cases. <em>date</em> is a string containing an <span class="target" id="index-6"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a> date, such as <code class="docutils literal notranslate"><span class="pre">'Mon,</span> <span class="pre">20</span> <span class="pre">Nov</span> <span class="pre">1995</span> <span class="pre">19:12:08</span> <span class="pre">-0500'</span></code>. If it succeeds in parsing the date, <a class="reference internal" href="#rfc822.parsedate" title="rfc822.parsedate"><code class="xref py py-func docutils literal notranslate"><span class="pre">parsedate()</span></code></a> returns a 9-tuple that can be passed directly to <a class="reference internal" href="time.html#time.mktime" title="time.mktime"><code class="xref py py-func docutils literal notranslate"><span class="pre">time.mktime()</span></code></a>; otherwise <code class="docutils literal notranslate"><span class="pre">None</span></code> will be returned. Note that indexes 6, 7, and 8 of the result tuple are not usable.</p> </dd></dl> <dl class="function"> <dt id="rfc822.parsedate_tz"> <code class="descclassname">rfc822.</code><code class="descname">parsedate_tz</code><span class="sig-paren">(</span><em>date</em><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.parsedate_tz" title="Permalink to this definition">¶</a></dt> <dd><p>Performs the same function as <a class="reference internal" href="#rfc822.parsedate" title="rfc822.parsedate"><code class="xref py py-func docutils literal notranslate"><span class="pre">parsedate()</span></code></a>, but returns either <code class="docutils literal notranslate"><span class="pre">None</span></code> or a 10-tuple; the first 9 elements make up a tuple that can be passed directly to <a class="reference internal" href="time.html#time.mktime" title="time.mktime"><code class="xref py py-func docutils literal notranslate"><span class="pre">time.mktime()</span></code></a>, and the tenth is the offset of the date’s timezone from UTC (which is the official term for Greenwich Mean Time). (Note that the sign of the timezone offset is the opposite of the sign of the <code class="docutils literal notranslate"><span class="pre">time.timezone</span></code> variable for the same timezone; the latter variable follows the POSIX standard while this module follows <span class="target" id="index-7"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a>.) If the input string has no timezone, the last element of the tuple returned is <code class="docutils literal notranslate"><span class="pre">None</span></code>. Note that indexes 6, 7, and 8 of the result tuple are not usable.</p> </dd></dl> <dl class="function"> <dt id="rfc822.mktime_tz"> <code class="descclassname">rfc822.</code><code class="descname">mktime_tz</code><span class="sig-paren">(</span><em>tuple</em><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.mktime_tz" title="Permalink to this definition">¶</a></dt> <dd><p>Turn a 10-tuple as returned by <a class="reference internal" href="#rfc822.parsedate_tz" title="rfc822.parsedate_tz"><code class="xref py py-func docutils literal notranslate"><span class="pre">parsedate_tz()</span></code></a> into a UTC timestamp. If the timezone item in the tuple is <code class="docutils literal notranslate"><span class="pre">None</span></code>, assume local time. Minor deficiency: this first interprets the first 8 elements as a local time and then compensates for the timezone difference; this may yield a slight error around daylight savings time switch dates. Not enough to worry about for common use.</p> </dd></dl> <div class="admonition seealso"> <p class="first admonition-title">See also</p> <dl class="last docutils"> <dt>Module <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"><span class="pre">email</span></code></a></dt> <dd>Comprehensive email handling package; supersedes the <a class="reference internal" href="#module-rfc822" title="rfc822: Parse 2822 style mail messages. (deprecated)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">rfc822</span></code></a> module.</dd> <dt>Module <a class="reference internal" href="mailbox.html#module-mailbox" title="mailbox: Manipulate mailboxes in various formats"><code class="xref py py-mod docutils literal notranslate"><span class="pre">mailbox</span></code></a></dt> <dd>Classes to read various mailbox formats produced by end-user mail programs.</dd> <dt>Module <a class="reference internal" href="mimetools.html#module-mimetools" title="mimetools: Tools for parsing MIME-style message bodies. (deprecated)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">mimetools</span></code></a></dt> <dd>Subclass of <a class="reference internal" href="#rfc822.Message" title="rfc822.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">rfc822.Message</span></code></a> that handles MIME encoded messages.</dd> </dl> </div> <div class="section" id="message-objects"> <span id="id2"></span><h2>18.11.1. Message Objects<a class="headerlink" href="#message-objects" title="Permalink to this headline">¶</a></h2> <p>A <a class="reference internal" href="#rfc822.Message" title="rfc822.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> instance has the following methods:</p> <dl class="method"> <dt id="rfc822.Message.rewindbody"> <code class="descclassname">Message.</code><code class="descname">rewindbody</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.Message.rewindbody" title="Permalink to this definition">¶</a></dt> <dd><p>Seek to the start of the message body. This only works if the file object is seekable.</p> </dd></dl> <dl class="method"> <dt id="rfc822.Message.isheader"> <code class="descclassname">Message.</code><code class="descname">isheader</code><span class="sig-paren">(</span><em>line</em><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.Message.isheader" title="Permalink to this definition">¶</a></dt> <dd><p>Returns a line’s canonicalized fieldname (the dictionary key that will be used to index it) if the line is a legal <span class="target" id="index-8"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a> header; otherwise returns <code class="docutils literal notranslate"><span class="pre">None</span></code> (implying that parsing should stop here and the line be pushed back on the input stream). It is sometimes useful to override this method in a subclass.</p> </dd></dl> <dl class="method"> <dt id="rfc822.Message.islast"> <code class="descclassname">Message.</code><code class="descname">islast</code><span class="sig-paren">(</span><em>line</em><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.Message.islast" title="Permalink to this definition">¶</a></dt> <dd><p>Return true if the given line is a delimiter on which Message should stop. The delimiter line is consumed, and the file object’s read location positioned immediately after it. By default this method just checks that the line is blank, but you can override it in a subclass.</p> </dd></dl> <dl class="method"> <dt id="rfc822.Message.iscomment"> <code class="descclassname">Message.</code><code class="descname">iscomment</code><span class="sig-paren">(</span><em>line</em><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.Message.iscomment" title="Permalink to this definition">¶</a></dt> <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the given line should be ignored entirely, just skipped. By default this is a stub that always returns <code class="docutils literal notranslate"><span class="pre">False</span></code>, but you can override it in a subclass.</p> </dd></dl> <dl class="method"> <dt id="rfc822.Message.getallmatchingheaders"> <code class="descclassname">Message.</code><code class="descname">getallmatchingheaders</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.Message.getallmatchingheaders" title="Permalink to this definition">¶</a></dt> <dd><p>Return a list of lines consisting of all headers matching <em>name</em>, if any. Each physical line, whether it is a continuation line or not, is a separate list item. Return the empty list if no header matches <em>name</em>.</p> </dd></dl> <dl class="method"> <dt id="rfc822.Message.getfirstmatchingheader"> <code class="descclassname">Message.</code><code class="descname">getfirstmatchingheader</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.Message.getfirstmatchingheader" title="Permalink to this definition">¶</a></dt> <dd><p>Return a list of lines comprising the first header matching <em>name</em>, and its continuation line(s), if any. Return <code class="docutils literal notranslate"><span class="pre">None</span></code> if there is no header matching <em>name</em>.</p> </dd></dl> <dl class="method"> <dt id="rfc822.Message.getrawheader"> <code class="descclassname">Message.</code><code class="descname">getrawheader</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.Message.getrawheader" title="Permalink to this definition">¶</a></dt> <dd><p>Return a single string consisting of the text after the colon in the first header matching <em>name</em>. This includes leading whitespace, the trailing linefeed, and internal linefeeds and whitespace if there any continuation line(s) were present. Return <code class="docutils literal notranslate"><span class="pre">None</span></code> if there is no header matching <em>name</em>.</p> </dd></dl> <dl class="method"> <dt id="rfc822.Message.getheader"> <code class="descclassname">Message.</code><code class="descname">getheader</code><span class="sig-paren">(</span><em>name</em><span class="optional">[</span>, <em>default</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.Message.getheader" title="Permalink to this definition">¶</a></dt> <dd><p>Return a single string consisting of the last header matching <em>name</em>, but strip leading and trailing whitespace. Internal whitespace is not stripped. The optional <em>default</em> argument can be used to specify a different default to be returned when there is no header matching <em>name</em>; it defaults to <code class="docutils literal notranslate"><span class="pre">None</span></code>. This is the preferred way to get parsed headers.</p> </dd></dl> <dl class="method"> <dt id="rfc822.Message.get"> <code class="descclassname">Message.</code><code class="descname">get</code><span class="sig-paren">(</span><em>name</em><span class="optional">[</span>, <em>default</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.Message.get" title="Permalink to this definition">¶</a></dt> <dd><p>An alias for <a class="reference internal" href="#rfc822.Message.getheader" title="rfc822.Message.getheader"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getheader()</span></code></a>, to make the interface more compatible with regular dictionaries.</p> </dd></dl> <dl class="method"> <dt id="rfc822.Message.getaddr"> <code class="descclassname">Message.</code><code class="descname">getaddr</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.Message.getaddr" title="Permalink to this definition">¶</a></dt> <dd><p>Return a pair <code class="docutils literal notranslate"><span class="pre">(full</span> <span class="pre">name,</span> <span class="pre">email</span> <span class="pre">address)</span></code> parsed from the string returned by <code class="docutils literal notranslate"><span class="pre">getheader(name)</span></code>. If no header matching <em>name</em> exists, return <code class="docutils literal notranslate"><span class="pre">(None,</span> <span class="pre">None)</span></code>; otherwise both the full name and the address are (possibly empty) strings.</p> <p>Example: If <em>m</em>’s first <em class="mailheader">From</em> header contains the string <code class="docutils literal notranslate"><span class="pre">'jack@cwi.nl</span> <span class="pre">(Jack</span> <span class="pre">Jansen)'</span></code>, then <code class="docutils literal notranslate"><span class="pre">m.getaddr('From')</span></code> will yield the pair <code class="docutils literal notranslate"><span class="pre">('Jack</span> <span class="pre">Jansen',</span> <span class="pre">'jack@cwi.nl')</span></code>. If the header contained <code class="docutils literal notranslate"><span class="pre">'Jack</span> <span class="pre">Jansen</span> <span class="pre"><jack@cwi.nl>'</span></code> instead, it would yield the exact same result.</p> </dd></dl> <dl class="method"> <dt id="rfc822.Message.getaddrlist"> <code class="descclassname">Message.</code><code class="descname">getaddrlist</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.Message.getaddrlist" title="Permalink to this definition">¶</a></dt> <dd><p>This is similar to <code class="docutils literal notranslate"><span class="pre">getaddr(list)</span></code>, but parses a header containing a list of email addresses (e.g. a <em class="mailheader">To</em> header) and returns a list of <code class="docutils literal notranslate"><span class="pre">(full</span> <span class="pre">name,</span> <span class="pre">email</span> <span class="pre">address)</span></code> pairs (even if there was only one address in the header). If there is no header matching <em>name</em>, return an empty list.</p> <p>If multiple headers exist that match the named header (e.g. if there are several <em class="mailheader">Cc</em> headers), all are parsed for addresses. Any continuation lines the named headers contain are also parsed.</p> </dd></dl> <dl class="method"> <dt id="rfc822.Message.getdate"> <code class="descclassname">Message.</code><code class="descname">getdate</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.Message.getdate" title="Permalink to this definition">¶</a></dt> <dd><p>Retrieve a header using <a class="reference internal" href="#rfc822.Message.getheader" title="rfc822.Message.getheader"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getheader()</span></code></a> and parse it into a 9-tuple compatible with <a class="reference internal" href="time.html#time.mktime" title="time.mktime"><code class="xref py py-func docutils literal notranslate"><span class="pre">time.mktime()</span></code></a>; note that fields 6, 7, and 8 are not usable. If there is no header matching <em>name</em>, or it is unparsable, return <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p> <p>Date parsing appears to be a black art, and not all mailers adhere to the standard. While it has been tested and found correct on a large collection of email from many sources, it is still possible that this function may occasionally yield an incorrect result.</p> </dd></dl> <dl class="method"> <dt id="rfc822.Message.getdate_tz"> <code class="descclassname">Message.</code><code class="descname">getdate_tz</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.Message.getdate_tz" title="Permalink to this definition">¶</a></dt> <dd><p>Retrieve a header using <a class="reference internal" href="#rfc822.Message.getheader" title="rfc822.Message.getheader"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getheader()</span></code></a> and parse it into a 10-tuple; the first 9 elements will make a tuple compatible with <a class="reference internal" href="time.html#time.mktime" title="time.mktime"><code class="xref py py-func docutils literal notranslate"><span class="pre">time.mktime()</span></code></a>, and the 10th is a number giving the offset of the date’s timezone from UTC. Note that fields 6, 7, and 8 are not usable. Similarly to <a class="reference internal" href="#rfc822.Message.getdate" title="rfc822.Message.getdate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getdate()</span></code></a>, if there is no header matching <em>name</em>, or it is unparsable, return <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p> </dd></dl> <p><a class="reference internal" href="#rfc822.Message" title="rfc822.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> instances also support a limited mapping interface. In particular: <code class="docutils literal notranslate"><span class="pre">m[name]</span></code> is like <code class="docutils literal notranslate"><span class="pre">m.getheader(name)</span></code> but raises <a class="reference internal" href="exceptions.html#exceptions.KeyError" title="exceptions.KeyError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">KeyError</span></code></a> if there is no matching header; and <code class="docutils literal notranslate"><span class="pre">len(m)</span></code>, <code class="docutils literal notranslate"><span class="pre">m.get(name[,</span> <span class="pre">default])</span></code>, <code class="docutils literal notranslate"><span class="pre">name</span> <span class="pre">in</span> <span class="pre">m</span></code>, <code class="docutils literal notranslate"><span class="pre">m.keys()</span></code>, <code class="docutils literal notranslate"><span class="pre">m.values()</span></code> <code class="docutils literal notranslate"><span class="pre">m.items()</span></code>, and <code class="docutils literal notranslate"><span class="pre">m.setdefault(name[,</span> <span class="pre">default])</span></code> act as expected, with the one difference that <code class="xref py py-meth docutils literal notranslate"><span class="pre">setdefault()</span></code> uses an empty string as the default value. <a class="reference internal" href="#rfc822.Message" title="rfc822.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> instances also support the mapping writable interface <code class="docutils literal notranslate"><span class="pre">m[name]</span> <span class="pre">=</span> <span class="pre">value</span></code> and <code class="docutils literal notranslate"><span class="pre">del</span> <span class="pre">m[name]</span></code>. <a class="reference internal" href="#rfc822.Message" title="rfc822.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> objects do not support the <code class="xref py py-meth docutils literal notranslate"><span class="pre">clear()</span></code>, <a class="reference internal" href="copy.html#module-copy" title="copy: Shallow and deep copy operations."><code class="xref py py-meth docutils literal notranslate"><span class="pre">copy()</span></code></a>, <code class="xref py py-meth docutils literal notranslate"><span class="pre">popitem()</span></code>, or <code class="xref py py-meth docutils literal notranslate"><span class="pre">update()</span></code> methods of the mapping interface. (Support for <code class="xref py py-meth docutils literal notranslate"><span class="pre">get()</span></code> and <code class="xref py py-meth docutils literal notranslate"><span class="pre">setdefault()</span></code> was only added in Python 2.2.)</p> <p>Finally, <a class="reference internal" href="#rfc822.Message" title="rfc822.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> instances have some public instance variables:</p> <dl class="attribute"> <dt id="rfc822.Message.headers"> <code class="descclassname">Message.</code><code class="descname">headers</code><a class="headerlink" href="#rfc822.Message.headers" title="Permalink to this definition">¶</a></dt> <dd><p>A list containing the entire set of header lines, in the order in which they were read (except that setitem calls may disturb this order). Each line contains a trailing newline. The blank line terminating the headers is not contained in the list.</p> </dd></dl> <dl class="attribute"> <dt id="rfc822.Message.fp"> <code class="descclassname">Message.</code><code class="descname">fp</code><a class="headerlink" href="#rfc822.Message.fp" title="Permalink to this definition">¶</a></dt> <dd><p>The file or file-like object passed at instantiation time. This can be used to read the message content.</p> </dd></dl> <dl class="attribute"> <dt id="rfc822.Message.unixfrom"> <code class="descclassname">Message.</code><code class="descname">unixfrom</code><a class="headerlink" href="#rfc822.Message.unixfrom" title="Permalink to this definition">¶</a></dt> <dd><p>The Unix <code class="docutils literal notranslate"><span class="pre">From</span></code> line, if the message had one, or an empty string. This is needed to regenerate the message in some contexts, such as an <code class="docutils literal notranslate"><span class="pre">mbox</span></code>-style mailbox file.</p> </dd></dl> </div> <div class="section" id="addresslist-objects"> <span id="id3"></span><h2>18.11.2. AddressList Objects<a class="headerlink" href="#addresslist-objects" title="Permalink to this headline">¶</a></h2> <p>An <a class="reference internal" href="#rfc822.AddressList" title="rfc822.AddressList"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddressList</span></code></a> instance has the following methods:</p> <dl class="method"> <dt id="rfc822.AddressList.__len__"> <code class="descclassname">AddressList.</code><code class="descname">__len__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.AddressList.__len__" title="Permalink to this definition">¶</a></dt> <dd><p>Return the number of addresses in the address list.</p> </dd></dl> <dl class="method"> <dt id="rfc822.AddressList.__str__"> <code class="descclassname">AddressList.</code><code class="descname">__str__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.AddressList.__str__" title="Permalink to this definition">¶</a></dt> <dd><p>Return a canonicalized string representation of the address list. Addresses are rendered in “name” <<a class="reference external" href="mailto:host%40domain">host<span>@</span>domain</a>> form, comma-separated.</p> </dd></dl> <dl class="method"> <dt id="rfc822.AddressList.__add__"> <code class="descclassname">AddressList.</code><code class="descname">__add__</code><span class="sig-paren">(</span><em>alist</em><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.AddressList.__add__" title="Permalink to this definition">¶</a></dt> <dd><p>Return a new <a class="reference internal" href="#rfc822.AddressList" title="rfc822.AddressList"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddressList</span></code></a> instance that contains all addresses in both <a class="reference internal" href="#rfc822.AddressList" title="rfc822.AddressList"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddressList</span></code></a> operands, with duplicates removed (set union).</p> </dd></dl> <dl class="method"> <dt id="rfc822.AddressList.__iadd__"> <code class="descclassname">AddressList.</code><code class="descname">__iadd__</code><span class="sig-paren">(</span><em>alist</em><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.AddressList.__iadd__" title="Permalink to this definition">¶</a></dt> <dd><p>In-place version of <a class="reference internal" href="#rfc822.AddressList.__add__" title="rfc822.AddressList.__add__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__add__()</span></code></a>; turns this <a class="reference internal" href="#rfc822.AddressList" title="rfc822.AddressList"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddressList</span></code></a> instance into the union of itself and the right-hand instance, <em>alist</em>.</p> </dd></dl> <dl class="method"> <dt id="rfc822.AddressList.__sub__"> <code class="descclassname">AddressList.</code><code class="descname">__sub__</code><span class="sig-paren">(</span><em>alist</em><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.AddressList.__sub__" title="Permalink to this definition">¶</a></dt> <dd><p>Return a new <a class="reference internal" href="#rfc822.AddressList" title="rfc822.AddressList"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddressList</span></code></a> instance that contains every address in the left-hand <a class="reference internal" href="#rfc822.AddressList" title="rfc822.AddressList"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddressList</span></code></a> operand that is not present in the right-hand address operand (set difference).</p> </dd></dl> <dl class="method"> <dt id="rfc822.AddressList.__isub__"> <code class="descclassname">AddressList.</code><code class="descname">__isub__</code><span class="sig-paren">(</span><em>alist</em><span class="sig-paren">)</span><a class="headerlink" href="#rfc822.AddressList.__isub__" title="Permalink to this definition">¶</a></dt> <dd><p>In-place version of <a class="reference internal" href="#rfc822.AddressList.__sub__" title="rfc822.AddressList.__sub__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__sub__()</span></code></a>, removing addresses in this list which are also in <em>alist</em>.</p> </dd></dl> <p>Finally, <a class="reference internal" href="#rfc822.AddressList" title="rfc822.AddressList"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddressList</span></code></a> instances have one public instance variable:</p> <dl class="attribute"> <dt id="rfc822.AddressList.addresslist"> <code class="descclassname">AddressList.</code><code class="descname">addresslist</code><a class="headerlink" href="#rfc822.AddressList.addresslist" title="Permalink to this definition">¶</a></dt> <dd><p>A list of tuple string pairs, one per address. In each member, the first is the canonicalized name part, the second is the actual route-address (<code class="docutils literal notranslate"><span class="pre">'@'</span></code>-separated username-host.domain pair).</p> </dd></dl> <p class="rubric">Footnotes</p> <table class="docutils footnote" frame="void" id="id4" rules="none"> <colgroup><col class="label" /><col /></colgroup> <tbody valign="top"> <tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>This module originally conformed to <span class="target" id="index-9"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc822.html"><strong>RFC 822</strong></a>, hence the name. Since then, <span class="target" id="index-10"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a> has been released as an update to <span class="target" id="index-11"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc822.html"><strong>RFC 822</strong></a>. This module should be considered <span class="target" id="index-12"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a>-conformant, especially in cases where the syntax or semantics have changed since <span class="target" id="index-13"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc822.html"><strong>RFC 822</strong></a>.</td></tr> </tbody> </table> </div> </div> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <h3><a href="../contents.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">18.11. <code class="docutils literal notranslate"><span class="pre">rfc822</span></code> — Parse RFC 2822 mail headers</a><ul> <li><a class="reference internal" href="#message-objects">18.11.1. Message Objects</a></li> <li><a class="reference internal" href="#addresslist-objects">18.11.2. AddressList Objects</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="multifile.html" title="previous chapter">18.10. <code class="docutils literal notranslate"><span class="pre">multifile</span></code> — Support for files containing distinct parts</a></p> <h4>Next topic</h4> <p class="topless"><a href="base64.html" title="next chapter">18.12. <code class="docutils literal notranslate"><span class="pre">base64</span></code> — RFC 3548: Base16, Base32, Base64 Data Encodings</a></p> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../_sources/library/rfc822.rst.txt" rel="nofollow">Show Source</a></li> </ul> </div> <div id="searchbox" style="display: none" role="search"> <h3>Quick search</h3> <div class="searchformwrapper"> <form class="search" action="../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div> <script type="text/javascript">$('#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="base64.html" title="18.12. base64 — RFC 3548: Base16, Base32, Base64 Data Encodings" >next</a> |</li> <li class="right" > <a href="multifile.html" title="18.10. multifile — Support for files containing distinct parts" >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> »</li> <li> <a href="../index.html">Python 2.7.16 documentation</a> » </li> <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li> <li class="nav-item nav-item-2"><a href="netdata.html" >18. Internet Data Handling</a> »</li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 1990-2019, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="https://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on Mar 27, 2019. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.7.6. </div> </body> </html>
Save
cmd:
run