diff options
Diffstat (limited to '.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/header.py')
-rw-r--r-- | .venv/lib/python3.12/site-packages/sendgrid/helpers/mail/header.py | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/header.py b/.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/header.py new file mode 100644 index 00000000..7f3bd4c4 --- /dev/null +++ b/.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/header.py @@ -0,0 +1,94 @@ +class Header(object): + """A header to specify specific handling instructions for your email. + + If the name or value contain Unicode characters, they must be properly + encoded. You may not overwrite the following reserved headers: + x-sg-id, x-sg-eid, received, dkim-signature, Content-Type, + Content-Transfer-Encoding, To, From, Subject, Reply-To, CC, BCC + """ + + def __init__(self, key=None, value=None, p=None): + """Create a Header. + + :param key: The name of the header (e.g. "Date") + :type key: string, optional + :param value: The header's value (e.g. "2013-02-27 1:23:45 PM PDT") + :type value: string, optional + :param name: p is the Personalization object or Personalization object + index + :type name: Personalization, integer, optional + """ + self._key = None + self._value = None + self._personalization = None + + if key is not None: + self.key = key + if value is not None: + self.value = value + if p is not None: + self.personalization = p + + @property + def key(self): + """The name of the header. + + :rtype: string + """ + return self._key + + @key.setter + def key(self, value): + """The name of the header. + + :param value: The name of the header. + :type value: string + """ + self._key = value + + @property + def value(self): + """The value of the header. + + :rtype: string + """ + return self._value + + @value.setter + def value(self, value): + """The value of the header. + + :param value: The value of the header. + :type value: string + """ + self._value = value + + @property + def personalization(self): + """The Personalization object or Personalization object index + + :rtype: Personalization, integer + """ + return self._personalization + + @personalization.setter + def personalization(self, value): + """The Personalization object or Personalization object index + + :param value: The Personalization object or Personalization object + index + :type value: Personalization, integer + """ + self._personalization = value + + def get(self): + """ + Get a JSON-ready representation of this Header. + + :returns: This Header, ready for use in a request body. + :rtype: dict + """ + header = {} + if self.key is not None and self.value is not None: + header[self.key] = self.value + return header |