Coverage for /var/srv/projects/api.amasfac.comuna18.com/tmp/venv/lib/python3.9/site-packages/sendgrid/helpers/mail/footer_settings.py: 33%
38 statements
« prev ^ index » next coverage.py v6.4.4, created at 2023-07-17 14:22 -0600
« prev ^ index » next coverage.py v6.4.4, created at 2023-07-17 14:22 -0600
1class FooterSettings(object):
2 """The default footer that you would like included on every email."""
4 def __init__(self, enable=None, text=None, html=None):
5 """Create a default footer.
7 :param enable: Whether this footer should be applied.
8 :type enable: boolean, optional
9 :param text: Text content of this footer
10 :type text: FooterText, optional
11 :param html: HTML content of this footer
12 :type html: FooterHtml, optional
13 """
14 self._enable = None
15 self._text = None
16 self._html = None
18 if enable is not None:
19 self.enable = enable
21 if text is not None:
22 self.text = text
24 if html is not None:
25 self.html = html
27 @property
28 def enable(self):
29 """Indicates if this setting is enabled.
31 :rtype: boolean
32 """
33 return self._enable
35 @enable.setter
36 def enable(self, value):
37 """Indicates if this setting is enabled.
39 :param value: Indicates if this setting is enabled.
40 :type value: boolean
41 """
42 self._enable = value
44 @property
45 def text(self):
46 """The plain text content of your footer.
48 :rtype: string
49 """
50 return self._text
52 @text.setter
53 def text(self, value):
54 """The plain text content of your footer.
56 :param value: The plain text content of your footer.
57 :type value: string
58 """
59 self._text = value
61 @property
62 def html(self):
63 """The HTML content of your footer.
65 :rtype: string
66 """
67 return self._html
69 @html.setter
70 def html(self, value):
71 """The HTML content of your footer.
73 :param value: The HTML content of your footer.
74 :type value: string
75 """
76 self._html = value
78 def get(self):
79 """
80 Get a JSON-ready representation of this FooterSettings.
82 :returns: This FooterSettings, ready for use in a request body.
83 :rtype: dict
84 """
85 footer_settings = {}
86 if self.enable is not None:
87 footer_settings["enable"] = self.enable
89 if self.text is not None:
90 footer_settings["text"] = self.text.get()
92 if self.html is not None:
93 footer_settings["html"] = self.html.get()
94 return footer_settings