1# Copyright (C) 2001-2006 Python Software Foundation
2# Author: Barry Warsaw
3# Contact: email-sig@python.org
4
5"""Class representing image/* type MIME documents."""
6
7__all__ = ['MIMEImage']
8
9import imghdr
10
11from email import encoders
12from email.mime.nonmultipart import MIMENonMultipart
13
14
15
16class MIMEImage(MIMENonMultipart):
17    """Class for generating image/* type MIME documents."""
18
19    def __init__(self, _imagedata, _subtype=None,
20                 _encoder=encoders.encode_base64, *, policy=None, **_params):
21        """Create an image/* type MIME document.
22
23        _imagedata is a string containing the raw image data.  If this data
24        can be decoded by the standard Python `imghdr' module, then the
25        subtype will be automatically included in the Content-Type header.
26        Otherwise, you can specify the specific image subtype via the _subtype
27        parameter.
28
29        _encoder is a function which will perform the actual encoding for
30        transport of the image data.  It takes one argument, which is this
31        Image instance.  It should use get_payload() and set_payload() to
32        change the payload to the encoded form.  It should also add any
33        Content-Transfer-Encoding or other headers to the message as
34        necessary.  The default encoding is Base64.
35
36        Any additional keyword arguments are passed to the base class
37        constructor, which turns them into parameters on the Content-Type
38        header.
39        """
40        if _subtype is None:
41            _subtype = imghdr.what(None, _imagedata)
42        if _subtype is None:
43            raise TypeError('Could not guess image MIME subtype')
44        MIMENonMultipart.__init__(self, 'image', _subtype, policy=policy,
45                                  **_params)
46        self.set_payload(_imagedata)
47        _encoder(self)
48