about summary refs log tree commit diff
path: root/.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/spam_check.py
diff options
context:
space:
mode:
authorS. Solomon Darnell2025-03-28 21:52:21 -0500
committerS. Solomon Darnell2025-03-28 21:52:21 -0500
commit4a52a71956a8d46fcb7294ac71734504bb09bcc2 (patch)
treeee3dc5af3b6313e921cd920906356f5d4febc4ed /.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/spam_check.py
parentcc961e04ba734dd72309fb548a2f97d67d578813 (diff)
downloadgn-ai-master.tar.gz
two version of R2R are here HEAD master
Diffstat (limited to '.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/spam_check.py')
-rw-r--r--.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/spam_check.py112
1 files changed, 112 insertions, 0 deletions
diff --git a/.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/spam_check.py b/.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/spam_check.py
new file mode 100644
index 00000000..c584f8cf
--- /dev/null
+++ b/.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/spam_check.py
@@ -0,0 +1,112 @@
+from .spam_threshold import SpamThreshold
+from .spam_url import SpamUrl
+
+
+class SpamCheck(object):
+    """This allows you to test the content of your email for spam."""
+
+    def __init__(self, enable=None, threshold=None, post_to_url=None):
+        """Create a SpamCheck to test the content of your email for spam.
+
+        :param enable: If this setting is applied.
+        :type enable: boolean, optional
+        :param threshold: Spam qualification threshold, from 1 to 10 (strict).
+        :type threshold: int, optional
+        :param post_to_url: Inbound Parse URL to send a copy of your email.
+        :type post_to_url: string, optional
+        """
+        self._enable = None
+        self._threshold = None
+        self._post_to_url = None
+
+        if enable is not None:
+            self.enable = enable
+        if threshold is not None:
+            self.threshold = threshold
+        if post_to_url is not None:
+            self.post_to_url = post_to_url
+
+    @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.
+
+        :param value: Indicates if this setting is enabled.
+        :type value: boolean
+        """
+        self._enable = value
+
+    @property
+    def threshold(self):
+        """Threshold used to determine if your content qualifies as spam.
+        On a scale from 1 to 10, with 10 being most strict, or most likely to
+        be considered as spam.
+
+        :rtype: int
+        """
+        return self._threshold
+
+    @threshold.setter
+    def threshold(self, value):
+        """Threshold used to determine if your content qualifies as spam.
+        On a scale from 1 to 10, with 10 being most strict, or most likely to
+        be considered as spam.
+
+        :param value: Threshold used to determine if your content qualifies as
+                      spam.
+                      On a scale from 1 to 10, with 10 being most strict, or
+                      most likely to be considered as spam.
+        :type value: int
+        """
+        if isinstance(value, SpamThreshold):
+            self._threshold = value
+        else:
+            self._threshold = SpamThreshold(value)
+
+    @property
+    def post_to_url(self):
+        """An Inbound Parse URL to send a copy of your email.
+        If defined, a copy of your email and its spam report will be sent here.
+
+        :rtype: string
+        """
+        return self._post_to_url
+
+    @post_to_url.setter
+    def post_to_url(self, value):
+        """An Inbound Parse URL to send a copy of your email.
+        If defined, a copy of your email and its spam report will be sent here.
+
+        :param value: An Inbound Parse URL to send a copy of your email.
+        If defined, a copy of your email and its spam report will be sent here.
+        :type value: string
+        """
+        if isinstance(value, SpamUrl):
+            self._post_to_url = value
+        else:
+            self._post_to_url = SpamUrl(value)
+
+    def get(self):
+        """
+        Get a JSON-ready representation of this SpamCheck.
+
+        :returns: This SpamCheck, ready for use in a request body.
+        :rtype: dict
+        """
+        spam_check = {}
+        if self.enable is not None:
+            spam_check["enable"] = self.enable
+
+        if self.threshold is not None:
+            spam_check["threshold"] = self.threshold.get()
+
+        if self.post_to_url is not None:
+            spam_check["post_to_url"] = self.post_to_url.get()
+        return spam_check