aboutsummaryrefslogtreecommitdiff
path: root/.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/content.py
blob: 618eee91718ab5f1f4bec6cf8f23a92786b88a42 (about) (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
from .validators import ValidateApiKey



class Content(object):
    """Content to be included in your email.

    You must specify at least one mime type in the Contents of your email.
    """

    def __init__(self, mime_type, content):
        """Create a Content with the specified MIME type and content.

        :param mime_type: MIME type of this Content (e.g. "text/plain").
        :type mime_type: string
        :param content: The actual content.
        :type content: string
        """
        self._mime_type = None
        self._content = None
        self._validator = ValidateApiKey()

        if mime_type is not None:
            self.mime_type = mime_type

        if content is not None:
            self.content = content

    @property
    def mime_type(self):
        """The MIME type of the content you are including in your email.
        For example, "text/plain" or "text/html" or "text/x-amp-html".

        :rtype: string
        """
        return self._mime_type

    @mime_type.setter
    def mime_type(self, value):
        """The MIME type of the content you are including in your email.
        For example, "text/plain" or "text/html" or "text/x-amp-html".

        :param value: The MIME type of the content you are including in your
                      email.
        For example, "text/plain" or "text/html" or "text/x-amp-html".
        :type value: string
        """
        self._mime_type = value

    @property
    def content(self):
        """The actual content (of the specified mime type).

        :rtype: string
        """
        return self._content

    @content.setter
    def content(self, value):
        """The actual content (of the specified mime type).

        :param value: The actual content (of the specified mime type).
        :type value: string
        """
        self._validator.validate_message_dict(value)
        self._content = value

    def get(self):
        """
        Get a JSON-ready representation of this Content.

        :returns: This Content, ready for use in a request body.
        :rtype: dict
        """
        content = {}
        if self.mime_type is not None:
            content["type"] = self.mime_type

        if self.content is not None:
            content["value"] = self.content
        return content