aboutsummaryrefslogtreecommitdiff
path: root/.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/content_id.py
blob: 0fff301070a93dbded20881cca2bc2187e9910e5 (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
class ContentId(object):
    """The ContentId of an Attachment."""

    def __init__(self, content_id=None):
        """Create a ContentId object

        :param content_id: The content id for the attachment.
                           This is used when the Disposition is set to "inline"
                           and the attachment is an image, allowing the file to
                           be displayed within the email body.
        :type content_id: string, optional
        """
        self._content_id = None

        if content_id is not None:
            self.content_id = content_id

    @property
    def content_id(self):
        """The content id for the attachment.
           This is used when the Disposition is set to "inline" and the
           attachment is an image, allowing the file to be displayed within
           the email body.

        :rtype: string
        """
        return self._content_id

    @content_id.setter
    def content_id(self, value):
        """The content id for the attachment.
           This is used when the Disposition is set to "inline" and the
           attachment is an image, allowing the file to be displayed within
           the email body.

        :param value: The content id for the attachment.
        This is used when the Disposition is set to "inline" and the attachment
        is an image, allowing the file to be displayed within the email body.
        :type value: string
        """
        self._content_id = value

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

        :returns: This ContentId, ready for use in a request body.
        :rtype: string
        """
        return self.content_id