forked from sendgrid/sendgrid-python
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsandbox_mode.py
44 lines (36 loc) · 1.16 KB
/
sandbox_mode.py
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
class SandBoxMode(object):
"""Setting for sandbox mode.
This allows you to send a test email to ensure that your request body is
valid and formatted correctly.
"""
def __init__(self, enable=None):
"""Create an enabled or disabled SandBoxMode.
:param enable: Whether this is a test request.
:type enable: boolean, optional
"""
self._enable = None
if enable is not None:
self.enable = enable
@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
def get(self):
"""
Get a JSON-ready representation of this SandBoxMode.
:returns: This SandBoxMode, ready for use in a request body.
:rtype: dict
"""
sandbox_mode = {}
if self.enable is not None:
sandbox_mode["enable"] = self.enable
return sandbox_mode