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.header.html

<!DOCTYPE html>

<title>18.1.5. email.header: Internationalized headers &#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.6. email.charset: Representing character sets" href="email.charset.html" />
 <link rel="prev" title="18.1.4. email.mime: Creating email and MIME objects from scratch" href="email.mime.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.header.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.header.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.charset.html" title="18.1.6. email.charset: Representing character sets"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="email.mime.html" title="18.1.4. email.mime: Creating email and MIME objects from scratch"
 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.header">
<h1>18.1.5. <a class="reference internal" href="#module-email.header" title="email.header: Representing non-ASCII headers"><code class="xref py py-mod docutils literal notranslate">email.header</code></a>: Internationalized headers<a class="headerlink" href="#module-email.header" title="Permalink to this headline">¶</a></h1>
<a class="rfc reference external" href="https://tools.ietf.org/html/rfc2822.html">RFC 2822</a> is the base standard that describes the format of email messages.
It derives from the older <a class="rfc reference external" href="https://tools.ietf.org/html/rfc822.html">RFC 822</a> standard which came into widespread use at
a time when most email was composed of ASCII characters only. <a class="rfc reference external" href="https://tools.ietf.org/html/rfc2822.html">RFC 2822</a> is a
specification written assuming email contains only 7-bit ASCII characters.
Of course, as email has been deployed worldwide, it has become
internationalized, such that language specific character sets can now be used in
email messages. The base standard still requires email messages to be
transferred using only 7-bit ASCII characters, so a slew of RFCs have been
written describing how to encode email containing non-ASCII characters into
<a class="rfc reference external" href="https://tools.ietf.org/html/rfc2822.html">RFC 2822</a>-compliant format. These RFCs include <a class="rfc reference external" href="https://tools.ietf.org/html/rfc2045.html">RFC 2045</a>, <a class="rfc reference external" href="https://tools.ietf.org/html/rfc2046.html">RFC 2046</a>,
<a class="rfc reference external" href="https://tools.ietf.org/html/rfc2047.html">RFC 2047</a>, and <a class="rfc reference external" href="https://tools.ietf.org/html/rfc2231.html">RFC 2231</a>. 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 supports these standards
in its <a class="reference internal" href="#module-email.header" title="email.header: Representing non-ASCII headers"><code class="xref py py-mod docutils literal notranslate">email.header</code></a> and <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> modules.
If you want to include non-ASCII characters in your email headers, say in the
Subject or To fields, you should use the
<a class="reference internal" href="#email.header.Header" title="email.header.Header"><code class="xref py py-class docutils literal notranslate">Header</code></a> class and assign the field in the <a class="reference internal" href="email.message.html#email.message.Message" title="email.message.Message"><code class="xref py py-class docutils literal notranslate">Message</code></a>
object to an instance of <a class="reference internal" href="#email.header.Header" title="email.header.Header"><code class="xref py py-class docutils literal notranslate">Header</code></a> instead of using a string for the header
value. Import the <a class="reference internal" href="#email.header.Header" title="email.header.Header"><code class="xref py py-class docutils literal notranslate">Header</code></a> class from the <a class="reference internal" href="#module-email.header" title="email.header: Representing non-ASCII headers"><code class="xref py py-mod docutils literal notranslate">email.header</code></a> module.
For example:
<div class="highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from email.message import Message
&gt;&gt;&gt; from email.header import Header
&gt;&gt;&gt; msg = Message()
&gt;&gt;&gt; h = Header(&#39;p\xf6stal&#39;, &#39;iso-8859-1&#39;)
&gt;&gt;&gt; msg[&#39;Subject&#39;] = h
&gt;&gt;&gt; print msg.as_string()
Subject: =?iso-8859-1?q?p=F6stal?=
</pre></div>
</div>
Notice here how we wanted the Subject field to contain a non-ASCII
character? We did this by creating a <a class="reference internal" href="#email.header.Header" title="email.header.Header"><code class="xref py py-class docutils literal notranslate">Header</code></a> instance and passing in
the character set that the byte string was encoded in. When the subsequent
<a class="reference internal" href="email.message.html#email.message.Message" title="email.message.Message"><code class="xref py py-class docutils literal notranslate">Message</code></a> instance was flattened, the Subject
field was properly <a class="rfc reference external" href="https://tools.ietf.org/html/rfc2047.html">RFC 2047</a> encoded. MIME-aware mail readers would show this
header using the embedded ISO-8859-1 character.
<div class="versionadded">
New in version 2.2.2.
</div>
Here is the <a class="reference internal" href="#email.header.Header" title="email.header.Header"><code class="xref py py-class docutils literal notranslate">Header</code></a> class description:
<dl class="py class">
<dt class="sig sig-object py" id="email.header.Header">
class email.header.Header([s[, charset[, maxlinelen[, header_name[, continuation_ws[, errors]]]]]])<a class="headerlink" href="#email.header.Header" title="Permalink to this definition">¶</a></dt>
<dd>Create a MIME-compliant header that can contain strings in different character
sets.
Optional s is the initial header value. If <code class="docutils literal notranslate">None</code> (the default), the
initial header value is not set. You can later append to the header with
<a class="reference internal" href="#email.header.Header.append" title="email.header.Header.append"><code class="xref py py-meth docutils literal notranslate">append()</code></a> method calls. s may be a byte string or a Unicode string, but
see the <a class="reference internal" href="#email.header.Header.append" title="email.header.Header.append"><code class="xref py py-meth docutils literal notranslate">append()</code></a> documentation for semantics.
Optional charset serves two purposes: it has the same meaning as the charset
argument to the <a class="reference internal" href="#email.header.Header.append" title="email.header.Header.append"><code class="xref py py-meth docutils literal notranslate">append()</code></a> method. It also sets the default character set
for all subsequent <a class="reference internal" href="#email.header.Header.append" title="email.header.Header.append"><code class="xref py py-meth docutils literal notranslate">append()</code></a> calls that omit the charset argument. If
charset is not provided in the constructor (the default), the <code class="docutils literal notranslate">us-ascii</code>
character set is used both as s’s initial charset and as the default for
subsequent <a class="reference internal" href="#email.header.Header.append" title="email.header.Header.append"><code class="xref py py-meth docutils literal notranslate">append()</code></a> calls.
The maximum line length can be specified explicitly via maxlinelen. For
splitting the first line to a shorter value (to account for the field header
which isn’t included in s, e.g. Subject) pass in the name of the
field in header_name. The default maxlinelen is 76, and the default value
for header_name is <code class="docutils literal notranslate">None</code>, meaning it is not taken into account for the
first line of a long, split header.
Optional continuation_ws must be <a class="rfc reference external" href="https://tools.ietf.org/html/rfc2822.html">RFC 2822</a>-compliant folding whitespace,
and is usually either a space or a hard tab character. This character will be
prepended to continuation lines. continuation_ws defaults to a single
space character (” “).
Optional errors is passed straight through to the <a class="reference internal" href="#email.header.Header.append" title="email.header.Header.append"><code class="xref py py-meth docutils literal notranslate">append()</code></a> method.
<dl class="py method">
<dt class="sig sig-object py" id="email.header.Header.append">
append(s[, charset[, errors]])<a class="headerlink" href="#email.header.Header.append" title="Permalink to this definition">¶</a></dt>
<dd>Append the string s to the MIME header.
Optional charset, if given, should 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>) or the name of a character set, which
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. A value
of <code class="docutils literal notranslate">None</code> (the default) means that the charset given in the constructor
is used.
s may be a byte string or a Unicode string. If it is a byte string
(i.e. <code class="docutils literal notranslate">isinstance(s, str)</code> is true), then charset is the encoding of
that byte string, and a <code class="xref py py-exc docutils literal notranslate">UnicodeError</code> will be raised if the string
cannot be decoded with that character set.
If s is a Unicode string, then charset is a hint specifying the
character set of the characters in the string. In this case, when
producing an <a class="rfc reference external" href="https://tools.ietf.org/html/rfc2822.html">RFC 2822</a>-compliant header using <a class="rfc reference external" href="https://tools.ietf.org/html/rfc2047.html">RFC 2047</a> rules, the
Unicode string will be encoded using the following charsets in order:
<code class="docutils literal notranslate">us-ascii</code>, the charset hint, <code class="docutils literal notranslate">utf-8</code>. The first character set to
not provoke a <code class="xref py py-exc docutils literal notranslate">UnicodeError</code> is used.
Optional errors is passed through to any <a class="reference internal" href="functions.html#unicode" title="unicode"><code class="xref py py-func docutils literal notranslate">unicode()</code></a> or
<code class="xref py py-meth docutils literal notranslate">unicode.encode()</code> call, and defaults to “strict”.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.header.Header.encode">
encode([splitchars])<a class="headerlink" href="#email.header.Header.encode" title="Permalink to this definition">¶</a></dt>
<dd>Encode a message header into an RFC-compliant format, possibly wrapping
long lines and encapsulating non-ASCII parts in base64 or quoted-printable
encodings. Optional splitchars is a string containing characters to
split long ASCII lines on, in rough support of <a class="rfc reference external" href="https://tools.ietf.org/html/rfc2822.html">RFC 2822</a>’s highest
level syntactic breaks. This doesn’t affect <a class="rfc reference external" href="https://tools.ietf.org/html/rfc2047.html">RFC 2047</a> encoded lines.
</dd></dl>

The <a class="reference internal" href="#email.header.Header" title="email.header.Header"><code class="xref py py-class docutils literal notranslate">Header</code></a> class also provides a number of methods to support
standard operators and built-in functions.
<dl class="py method">
<dt class="sig sig-object py" id="email.header.Header.__str__">
__str__()<a class="headerlink" href="#email.header.Header.__str__" title="Permalink to this definition">¶</a></dt>
<dd>A synonym for <a class="reference internal" href="#email.header.Header.encode" title="email.header.Header.encode"><code class="xref py py-meth docutils literal notranslate">Header.encode()</code></a>. Useful for <code class="docutils literal notranslate">str(aHeader)</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.header.Header.__unicode__">
__unicode__()<a class="headerlink" href="#email.header.Header.__unicode__" title="Permalink to this definition">¶</a></dt>
<dd>A helper for the built-in <a class="reference internal" href="functions.html#unicode" title="unicode"><code class="xref py py-func docutils literal notranslate">unicode()</code></a> function. Returns the header as
a Unicode string.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.header.Header.__eq__">
__eq__(other)<a class="headerlink" href="#email.header.Header.__eq__" title="Permalink to this definition">¶</a></dt>
<dd>This method allows you to compare two <a class="reference internal" href="#email.header.Header" title="email.header.Header"><code class="xref py py-class docutils literal notranslate">Header</code></a> instances for
equality.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="email.header.Header.__ne__">
__ne__(other)<a class="headerlink" href="#email.header.Header.__ne__" title="Permalink to this definition">¶</a></dt>
<dd>This method allows you to compare two <a class="reference internal" href="#email.header.Header" title="email.header.Header"><code class="xref py py-class docutils literal notranslate">Header</code></a> instances for
inequality.
</dd></dl>

</dd></dl>

The <a class="reference internal" href="#module-email.header" title="email.header: Representing non-ASCII headers"><code class="xref py py-mod docutils literal notranslate">email.header</code></a> module also provides the following convenient functions.
<dl class="py function">
<dt class="sig sig-object py" id="email.header.decode_header">
email.header.decode_header(header)<a class="headerlink" href="#email.header.decode_header" title="Permalink to this definition">¶</a></dt>
<dd>Decode a message header value without converting the character set. The header
value is in header.
This function returns a list of <code class="docutils literal notranslate">(decoded_string, charset)</code> pairs containing
each of the decoded parts of the header. charset is <code class="docutils literal notranslate">None</code> for non-encoded
parts of the header, otherwise a lower case string containing the name of the
character set specified in the encoded string.
Here’s an example:
<div class="highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from email.header import decode_header
&gt;&gt;&gt; decode_header(&#39;=?iso-8859-1?q?p=F6stal?=&#39;)
[(&#39;p\xf6stal&#39;, &#39;iso-8859-1&#39;)]
</pre></div>
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="email.header.make_header">
email.header.make_header(decoded_seq[, maxlinelen[, header_name[, continuation_ws]]])<a class="headerlink" href="#email.header.make_header" title="Permalink to this definition">¶</a></dt>
<dd>Create a <a class="reference internal" href="#email.header.Header" title="email.header.Header"><code class="xref py py-class docutils literal notranslate">Header</code></a> instance from a sequence of pairs as returned by
<a class="reference internal" href="#email.header.decode_header" title="email.header.decode_header"><code class="xref py py-func docutils literal notranslate">decode_header()</code></a>.
<a class="reference internal" href="#email.header.decode_header" title="email.header.decode_header"><code class="xref py py-func docutils literal notranslate">decode_header()</code></a> takes a header value string and returns a sequence of
pairs of the format <code class="docutils literal notranslate">(decoded_string, charset)</code> where charset is the name of
the character set.
This function takes one of those sequence of pairs and returns a <a class="reference internal" href="#email.header.Header" title="email.header.Header"><code class="xref py py-class docutils literal notranslate">Header</code></a>
instance. Optional maxlinelen, header_name, and continuation_ws are as in
the <a class="reference internal" href="#email.header.Header" title="email.header.Header"><code class="xref py py-class docutils literal notranslate">Header</code></a> constructor.
</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.mime.html"
 title="previous chapter">18.1.4. <code class="xref py py-mod docutils literal notranslate">email.mime</code>: Creating email and MIME objects from scratch</a>
 <h4>Next topic</h4>
 <a href="email.charset.html"
 title="next chapter">18.1.6. <code class="xref py py-mod docutils literal notranslate">email.charset</code>: Representing character sets</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/library/email.header.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.charset.html" title="18.1.6. email.charset: Representing character sets"
 >next</a> |</li>
 <li class="right" >
 <a href="email.mime.html" title="18.1.4. email.mime: Creating email and MIME objects from scratch"
 >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.5. <code class="xref py py-mod docutils literal notranslate">email.header</code>: Internationalized headers</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.header.html