aboutsummaryrefslogtreecommitdiff
path: root/.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/bcc_settings.py
diff options
context:
space:
mode:
Diffstat (limited to '.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/bcc_settings.py')
-rw-r--r--.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/bcc_settings.py72
1 files changed, 72 insertions, 0 deletions
diff --git a/.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/bcc_settings.py b/.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/bcc_settings.py
new file mode 100644
index 00000000..eeb8ba10
--- /dev/null
+++ b/.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/bcc_settings.py
@@ -0,0 +1,72 @@
+class BccSettings(object):
+ """Settings object for automatic BCC.
+
+ This allows you to have a blind carbon copy automatically sent to the
+ specified email address for every email that is sent.
+ """
+
+ def __init__(self, enable=None, email=None):
+ """Create a BCCSettings.
+
+ :param enable: Whether this BCCSettings is applied to sent emails.
+ :type enable: boolean, optional
+ :param email: Who should be BCCed.
+ :type email: BccSettingEmail, optional
+ """
+ self._enable = None
+ self._email = None
+
+ if enable is not None:
+ self.enable = enable
+
+ if email is not None:
+ self.email = email
+
+ @property
+ def enable(self):
+ """Indicates if this setting is enabled.
+
+ :rtype: boolean
+ """
+ return self._enable
+
+ @enable.setter
+ def enable(self, value):
+ """Indicates if this setting is enabled.
+
+ :type param: Indicates if this setting is enabled.
+ :type value: boolean
+ """
+ self._enable = value
+
+ @property
+ def email(self):
+ """The email address that you would like to receive the BCC.
+
+ :rtype: string
+ """
+ return self._email
+
+ @email.setter
+ def email(self, value):
+ """The email address that you would like to receive the BCC.
+
+ :param value: The email address that you would like to receive the BCC.
+ :type value: string
+ """
+ self._email = value
+
+ def get(self):
+ """
+ Get a JSON-ready representation of this BCCSettings.
+
+ :returns: This BCCSettings, ready for use in a request body.
+ :rtype: dict
+ """
+ bcc_settings = {}
+ if self.enable is not None:
+ bcc_settings["enable"] = self.enable
+
+ if self.email is not None:
+ bcc_settings["email"] = self.email.get()
+ return bcc_settings