Yu1709$!%yuyu!$%wutu!5=126+

                
____  ___       .__                 
\   \/  /  _____|  |   ______  _  __
 \     /  /  ___/  |  /  _ \ \/ \/ /
 /     \  \___ \|  |_(  <_> )     / 
/___/\  \/____  >____/\____/ \/\_/  
      \_/     \/    @ligmakokz

Editing: email.mime.rst.txt

:mod:`email.mime`: Creating email and MIME objects from scratch
---------------------------------------------------------------

.. module:: email.mime
   :synopsis: Build MIME messages.

**Source code:** :source:`Lib/email/mime/`

--------------

This module is part of the legacy (``Compat32``) email API.  Its functionality
is partially replaced by the :mod:`~email.contentmanager` in the new API, but
in certain applications these classes may still be useful, even in non-legacy
code.

Ordinarily, you get a message object structure by passing a file or some text to
a parser, which parses the text and returns the root message object.  However
you can also build a complete message structure from scratch, or even individual
:class:`~email.message.Message` objects by hand.  In fact, you can also take an
existing structure and add new :class:`~email.message.Message` objects, move them
around, etc.  This makes a very convenient interface for slicing-and-dicing MIME
messages.

You can create a new object structure by creating :class:`~email.message.Message`
instances, adding attachments and all the appropriate headers manually.  For MIME
messages though, the :mod:`email` package provides some convenient subclasses to
make things easier.

Here are the classes:

.. currentmodule:: email.mime.base

.. class:: MIMEBase(_maintype, _subtype, *, policy=compat32, **_params)

Module: :mod:`email.mime.base`

This is the base class for all the MIME-specific subclasses of
   :class:`~email.message.Message`.  Ordinarily you won't create instances
   specifically of :class:`MIMEBase`, although you could.  :class:`MIMEBase`
   is provided primarily as a convenient base class for more specific
   MIME-aware subclasses.

*_maintype* is the :mailheader:`Content-Type` major type (e.g. :mimetype:`text`
   or :mimetype:`image`), and *_subtype* is the :mailheader:`Content-Type` minor
   type  (e.g. :mimetype:`plain` or :mimetype:`gif`).  *_params* is a parameter
   key/value dictionary and is passed directly to :meth:`Message.add_header
   <email.message.Message.add_header>`.

If *policy* is specified, (defaults to the
   :class:`compat32 <email.policy.Compat32>` policy) it will be passed to
   :class:`~email.message.Message`.

The :class:`MIMEBase` class always adds a :mailheader:`Content-Type` header
   (based on *_maintype*, *_subtype*, and *_params*), and a
   :mailheader:`MIME-Version` header (always set to ``1.0``).

.. versionchanged:: 3.6
      Added *policy* keyword-only parameter.

.. currentmodule:: email.mime.nonmultipart

.. class:: MIMENonMultipart()

Module: :mod:`email.mime.nonmultipart`

A subclass of :class:`~email.mime.base.MIMEBase`, this is an intermediate base
   class for MIME messages that are not :mimetype:`multipart`.  The primary
   purpose of this class is to prevent the use of the
   :meth:`~email.message.Message.attach` method, which only makes sense for
   :mimetype:`multipart` messages.  If :meth:`~email.message.Message.attach`
   is called, a :exc:`~email.errors.MultipartConversionError` exception is raised.

.. currentmodule:: email.mime.multipart

.. class:: MIMEMultipart(_subtype='mixed', boundary=None, _subparts=None, \
                         *, policy=compat32, **_params)

Module: :mod:`email.mime.multipart`

A subclass of :class:`~email.mime.base.MIMEBase`, this is an intermediate base
   class for MIME messages that are :mimetype:`multipart`.  Optional *_subtype*
   defaults to :mimetype:`mixed`, but can be used to specify the subtype of the
   message.  A :mailheader:`Content-Type` header of :mimetype:`multipart/_subtype`
   will be added to the message object.  A :mailheader:`MIME-Version` header will
   also be added.

Optional *boundary* is the multipart boundary string.  When ``None`` (the
   default), the boundary is calculated when needed (for example, when the
   message is serialized).

*_subparts* is a sequence of initial subparts for the payload.  It must be
   possible to convert this sequence to a list.  You can always attach new subparts
   to the message by using the :meth:`Message.attach
   <email.message.Message.attach>` method.

Optional *policy* argument defaults to :class:`compat32 <email.policy.Compat32>`.

Additional parameters for the :mailheader:`Content-Type` header are taken from
   the keyword arguments, or passed into the *_params* argument, which is a keyword
   dictionary.

.. versionchanged:: 3.6
      Added *policy* keyword-only parameter.

.. currentmodule:: email.mime.application

.. class:: MIMEApplication(_data, _subtype='octet-stream', \
                           _encoder=email.encoders.encode_base64, \
                           *, policy=compat32, **_params)

Module: :mod:`email.mime.application`

A subclass of :class:`~email.mime.nonmultipart.MIMENonMultipart`, the
   :class:`MIMEApplication` class is used to represent MIME message objects of
   major type :mimetype:`application`.  *_data* is a string containing the raw
   byte data.  Optional *_subtype* specifies the MIME subtype and defaults to
   :mimetype:`octet-stream`.

Optional *_encoder* is a callable (i.e. function) which will perform the actual
   encoding of the data for transport.  This callable takes one argument, which is
   the :class:`MIMEApplication` instance. It should use
   :meth:`~email.message.Message.get_payload` and
   :meth:`~email.message.Message.set_payload` to change the payload to encoded
   form.  It should also add
   any :mailheader:`Content-Transfer-Encoding` or other headers to the message
   object as necessary.  The default encoding is base64.  See the
   :mod:`email.encoders` module for a list of the built-in encoders.

Optional *policy* argument defaults to :class:`compat32 <email.policy.Compat32>`.

*_params* are passed straight through to the base class constructor.

.. versionchanged:: 3.6
      Added *policy* keyword-only parameter.

.. currentmodule:: email.mime.audio

.. class:: MIMEAudio(_audiodata, _subtype=None, \
                     _encoder=email.encoders.encode_base64, \
                     *, policy=compat32, **_params)

Module: :mod:`email.mime.audio`

A subclass of :class:`~email.mime.nonmultipart.MIMENonMultipart`, the
   :class:`MIMEAudio` class is used to create MIME message objects of major type
   :mimetype:`audio`. *_audiodata* is a string containing the raw audio data.  If
   this data can be decoded by the standard Python module :mod:`sndhdr`, then the
   subtype will be automatically included in the :mailheader:`Content-Type` header.
   Otherwise you can explicitly specify the audio subtype via the *_subtype*
   argument.  If the minor type could not be guessed and *_subtype* was not given,
   then :exc:`TypeError` is raised.

Optional *_encoder* is a callable (i.e. function) which will perform the actual
   encoding of the audio data for transport.  This callable takes one argument,
   which is the :class:`MIMEAudio` instance. It should use
   :meth:`~email.message.Message.get_payload` and
   :meth:`~email.message.Message.set_payload` to change the payload to encoded
   form.  It should also add
   any :mailheader:`Content-Transfer-Encoding` or other headers to the message
   object as necessary.  The default encoding is base64.  See the
   :mod:`email.encoders` module for a list of the built-in encoders.

Optional *policy* argument defaults to :class:`compat32 <email.policy.Compat32>`.

*_params* are passed straight through to the base class constructor.

.. versionchanged:: 3.6
      Added *policy* keyword-only parameter.

.. currentmodule:: email.mime.image

.. class:: MIMEImage(_imagedata, _subtype=None, \
                     _encoder=email.encoders.encode_base64, \
                    *, policy=compat32, **_params)

Module: :mod:`email.mime.image`

A subclass of :class:`~email.mime.nonmultipart.MIMENonMultipart`, the
   :class:`MIMEImage` class is used to create MIME message objects of major type
   :mimetype:`image`. *_imagedata* is a string containing the raw image data.  If
   this data can be decoded by the standard Python module :mod:`imghdr`, then the
   subtype will be automatically included in the :mailheader:`Content-Type` header.
   Otherwise you can explicitly specify the image subtype via the *_subtype*
   argument.  If the minor type could not be guessed and *_subtype* was not given,
   then :exc:`TypeError` is raised.

Optional *_encoder* is a callable (i.e. function) which will perform the actual
   encoding of the image data for transport.  This callable takes one argument,
   which is the :class:`MIMEImage` instance. It should use
   :meth:`~email.message.Message.get_payload` and
   :meth:`~email.message.Message.set_payload` to change the payload to encoded
   form.  It should also add
   any :mailheader:`Content-Transfer-Encoding` or other headers to the message
   object as necessary.  The default encoding is base64.  See the
   :mod:`email.encoders` module for a list of the built-in encoders.

Optional *policy* argument defaults to :class:`compat32 <email.policy.Compat32>`.

*_params* are passed straight through to the :class:`~email.mime.base.MIMEBase`
   constructor.

.. versionchanged:: 3.6
      Added *policy* keyword-only parameter.

.. currentmodule:: email.mime.message

.. class:: MIMEMessage(_msg, _subtype='rfc822', *, policy=compat32)

Module: :mod:`email.mime.message`

A subclass of :class:`~email.mime.nonmultipart.MIMENonMultipart`, the
   :class:`MIMEMessage` class is used to create MIME objects of main type
   :mimetype:`message`. *_msg* is used as the payload, and must be an instance
   of class :class:`~email.message.Message` (or a subclass thereof), otherwise
   a :exc:`TypeError` is raised.

Optional *_subtype* sets the subtype of the message; it defaults to
   :mimetype:`rfc822`.

Optional *policy* argument defaults to :class:`compat32 <email.policy.Compat32>`.

.. versionchanged:: 3.6
      Added *policy* keyword-only parameter.

.. currentmodule:: email.mime.text

.. class:: MIMEText(_text, _subtype='plain', _charset=None, *, policy=compat32)

Module: :mod:`email.mime.text`

A subclass of :class:`~email.mime.nonmultipart.MIMENonMultipart`, the
   :class:`MIMEText` class is used to create MIME objects of major type
   :mimetype:`text`. *_text* is the string for the payload.  *_subtype* is the
   minor type and defaults to :mimetype:`plain`.  *_charset* is the character
   set of the text and is passed as an argument to the
   :class:`~email.mime.nonmultipart.MIMENonMultipart` constructor; it defaults
   to ``us-ascii`` if the string contains only ``ascii`` code points, and
   ``utf-8`` otherwise.  The *_charset* parameter accepts either a string or a
   :class:`~email.charset.Charset` instance.

Unless the *_charset* argument is explicitly set to ``None``, the
   MIMEText object created will have both a :mailheader:`Content-Type` header
   with a ``charset`` parameter, and a :mailheader:`Content-Transfer-Encoding`
   header.  This means that a subsequent ``set_payload`` call will not result
   in an encoded payload, even if a charset is passed in the ``set_payload``
   command.  You can "reset" this behavior by deleting the
   ``Content-Transfer-Encoding`` header, after which a ``set_payload`` call
   will automatically encode the new payload (and add a new
   :mailheader:`Content-Transfer-Encoding` header).

Optional *policy* argument defaults to :class:`compat32 <email.policy.Compat32>`.

.. versionchanged:: 3.5
      *_charset* also accepts :class:`~email.charset.Charset` instances.

.. versionchanged:: 3.6
      Added *policy* keyword-only parameter.

Name	Type	Actions
2to3.rst.txt	File
__future__.rst.txt	File
__main__.rst.txt	File
_dummy_thread.rst.txt	File
_thread.rst.txt	File
abc.rst.txt	File
aifc.rst.txt	File
allos.rst.txt	File
archiving.rst.txt	File
argparse.rst.txt	File
array.rst.txt	File
ast.rst.txt	File
asynchat.rst.txt	File
asyncio-dev.rst.txt	File
asyncio-eventloop.rst.txt	File
asyncio-eventloops.rst.txt	File
asyncio-protocol.rst.txt	File
asyncio-queue.rst.txt	File
asyncio-stream.rst.txt	File
asyncio-subprocess.rst.txt	File
asyncio-sync.rst.txt	File
asyncio-task.rst.txt	File
asyncio.rst.txt	File
asyncore.rst.txt	File
atexit.rst.txt	File
audioop.rst.txt	File
base64.rst.txt	File
bdb.rst.txt	File
binary.rst.txt	File
binascii.rst.txt	File
binhex.rst.txt	File
bisect.rst.txt	File
builtins.rst.txt	File
bz2.rst.txt	File
calendar.rst.txt	File
cgi.rst.txt	File
cgitb.rst.txt	File
chunk.rst.txt	File
cmath.rst.txt	File
cmd.rst.txt	File
code.rst.txt	File
codecs.rst.txt	File
codeop.rst.txt	File
collections.abc.rst.txt	File
collections.rst.txt	File
colorsys.rst.txt	File
compileall.rst.txt	File
concurrency.rst.txt	File
concurrent.futures.rst.txt	File
concurrent.rst.txt	File
configparser.rst.txt	File
constants.rst.txt	File
contextlib.rst.txt	File
copy.rst.txt	File
copyreg.rst.txt	File
crypt.rst.txt	File
crypto.rst.txt	File
csv.rst.txt	File
ctypes.rst.txt	File
curses.ascii.rst.txt	File
curses.panel.rst.txt	File
curses.rst.txt	File
custominterp.rst.txt	File
datatypes.rst.txt	File
datetime.rst.txt	File
dbm.rst.txt	File
debug.rst.txt	File
decimal.rst.txt	File
development.rst.txt	File
difflib.rst.txt	File
dis.rst.txt	File
distribution.rst.txt	File
distutils.rst.txt	File
doctest.rst.txt	File
dummy_threading.rst.txt	File
email.charset.rst.txt	File
email.compat32-message.rst.txt	File
email.contentmanager.rst.txt	File
email.encoders.rst.txt	File
email.errors.rst.txt	File
email.examples.rst.txt	File
email.generator.rst.txt	File
email.header.rst.txt	File
email.headerregistry.rst.txt	File
email.iterators.rst.txt	File
email.message.rst.txt	File
email.mime.rst.txt	File
email.parser.rst.txt	File
email.policy.rst.txt	File
email.rst.txt	File
email.util.rst.txt	File
ensurepip.rst.txt	File
enum.rst.txt	File
errno.rst.txt	File
exceptions.rst.txt	File
faulthandler.rst.txt	File
fcntl.rst.txt	File
filecmp.rst.txt	File
fileformats.rst.txt	File
fileinput.rst.txt	File
filesys.rst.txt	File
fnmatch.rst.txt	File
formatter.rst.txt	File
fpectl.rst.txt	File
fractions.rst.txt	File
frameworks.rst.txt	File
ftplib.rst.txt	File
functional.rst.txt	File
functions.rst.txt	File
functools.rst.txt	File
gc.rst.txt	File
getopt.rst.txt	File
getpass.rst.txt	File
gettext.rst.txt	File
glob.rst.txt	File
grp.rst.txt	File
gzip.rst.txt	File
hashlib.rst.txt	File
heapq.rst.txt	File
hmac.rst.txt	File
html.entities.rst.txt	File
html.parser.rst.txt	File
html.rst.txt	File
http.client.rst.txt	File
http.cookiejar.rst.txt	File
http.cookies.rst.txt	File
http.rst.txt	File
http.server.rst.txt	File
i18n.rst.txt	File
idle.rst.txt	File
imaplib.rst.txt	File
imghdr.rst.txt	File
imp.rst.txt	File
importlib.rst.txt	File
index.rst.txt	File
inspect.rst.txt	File
internet.rst.txt	File
intro.rst.txt	File
io.rst.txt	File
ipaddress.rst.txt	File
ipc.rst.txt	File
itertools.rst.txt	File
json.rst.txt	File
keyword.rst.txt	File
language.rst.txt	File
linecache.rst.txt	File
locale.rst.txt	File
logging.config.rst.txt	File
logging.handlers.rst.txt	File
logging.rst.txt	File
lzma.rst.txt	File
macpath.rst.txt	File
mailbox.rst.txt	File
mailcap.rst.txt	File
markup.rst.txt	File
marshal.rst.txt	File
math.rst.txt	File
mimetypes.rst.txt	File
misc.rst.txt	File
mm.rst.txt	File
mmap.rst.txt	File
modulefinder.rst.txt	File
modules.rst.txt	File
msilib.rst.txt	File
msvcrt.rst.txt	File
multiprocessing.rst.txt	File
netdata.rst.txt	File
netrc.rst.txt	File
nis.rst.txt	File
nntplib.rst.txt	File
numbers.rst.txt	File
numeric.rst.txt	File
operator.rst.txt	File
optparse.rst.txt	File
os.path.rst.txt	File
os.rst.txt	File
ossaudiodev.rst.txt	File
othergui.rst.txt	File
parser.rst.txt	File
pathlib.rst.txt	File
pdb.rst.txt	File
persistence.rst.txt	File
pickle.rst.txt	File
pickletools.rst.txt	File
pipes.rst.txt	File
pkgutil.rst.txt	File
platform.rst.txt	File
plistlib.rst.txt	File
poplib.rst.txt	File
posix.rst.txt	File
pprint.rst.txt	File
profile.rst.txt	File
pty.rst.txt	File
pwd.rst.txt	File
py_compile.rst.txt	File
pyclbr.rst.txt	File
pydoc.rst.txt	File
pyexpat.rst.txt	File
python.rst.txt	File
queue.rst.txt	File
quopri.rst.txt	File
random.rst.txt	File
re.rst.txt	File
readline.rst.txt	File
reprlib.rst.txt	File
resource.rst.txt	File
rlcompleter.rst.txt	File
runpy.rst.txt	File
sched.rst.txt	File
secrets.rst.txt	File
select.rst.txt	File
selectors.rst.txt	File
shelve.rst.txt	File
shlex.rst.txt	File
shutil.rst.txt	File
signal.rst.txt	File
site.rst.txt	File
smtpd.rst.txt	File
smtplib.rst.txt	File
sndhdr.rst.txt	File
socket.rst.txt	File
socketserver.rst.txt	File
spwd.rst.txt	File
sqlite3.rst.txt	File
ssl.rst.txt	File
stat.rst.txt	File
statistics.rst.txt	File
stdtypes.rst.txt	File
string.rst.txt	File
stringprep.rst.txt	File
struct.rst.txt	File
subprocess.rst.txt	File
sunau.rst.txt	File
superseded.rst.txt	File
symbol.rst.txt	File
symtable.rst.txt	File
sys.rst.txt	File
sysconfig.rst.txt	File
syslog.rst.txt	File
tabnanny.rst.txt	File
tarfile.rst.txt	File
telnetlib.rst.txt	File
tempfile.rst.txt	File
termios.rst.txt	File
test.rst.txt	File
text.rst.txt	File
textwrap.rst.txt	File
threading.rst.txt	File
time.rst.txt	File
timeit.rst.txt	File
tk.rst.txt	File
tkinter.rst.txt	File
tkinter.scrolledtext.rst.txt	File
tkinter.tix.rst.txt	File
tkinter.ttk.rst.txt	File
token.rst.txt	File
tokenize.rst.txt	File
trace.rst.txt	File
traceback.rst.txt	File
tracemalloc.rst.txt	File
tty.rst.txt	File
turtle.rst.txt	File
types.rst.txt	File
typing.rst.txt	File
undoc.rst.txt	File
unicodedata.rst.txt	File
unittest.mock-examples.rst.txt	File
unittest.mock.rst.txt	File
unittest.rst.txt	File
unix.rst.txt	File
urllib.error.rst.txt	File
urllib.parse.rst.txt	File
urllib.request.rst.txt	File
urllib.robotparser.rst.txt	File
urllib.rst.txt	File
uu.rst.txt	File
uuid.rst.txt	File
venv.rst.txt	File
warnings.rst.txt	File
wave.rst.txt	File
weakref.rst.txt	File
webbrowser.rst.txt	File
windows.rst.txt	File
winreg.rst.txt	File
winsound.rst.txt	File
wsgiref.rst.txt	File
xdrlib.rst.txt	File
xml.dom.minidom.rst.txt	File
xml.dom.pulldom.rst.txt	File
xml.dom.rst.txt	File
xml.etree.elementtree.rst.txt	File
xml.rst.txt	File
xml.sax.handler.rst.txt	File
xml.sax.reader.rst.txt	File
xml.sax.rst.txt	File
xml.sax.utils.rst.txt	File
xmlrpc.client.rst.txt	File
xmlrpc.rst.txt	File
xmlrpc.server.rst.txt	File
zipapp.rst.txt	File
zipfile.rst.txt	File
zipimport.rst.txt	File
zlib.rst.txt	File