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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
class SubscriptionTracking(object):
"""Allows you to insert a subscription management link at the bottom of the
text and html bodies of your email. If you would like to specify the
location of the link within your email, you may use the substitution_tag.
"""
def __init__(
self, enable=None, text=None, html=None, substitution_tag=None):
"""Create a SubscriptionTracking to customize subscription management.
:param enable: Whether this setting is enabled.
:type enable: boolean, optional
:param text: Text to be appended to the email with the link as "<% %>".
:type text: SubscriptionText, optional
:param html: HTML to be appended to the email with the link as "<% %>".
:type html: SubscriptionHtml, optional
:param substitution_tag: Tag replaced with URL. Overrides text, html
params.
:type substitution_tag: SubscriptionSubstitutionTag, optional
"""
self._enable = None
self._text = None
self._html = None
self._substitution_tag = None
if enable is not None:
self.enable = enable
if text is not None:
self.text = text
if html is not None:
self.html = html
if substitution_tag is not None:
self.substitution_tag = substitution_tag
@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 text(self):
"""Text to be appended to the email, with the subscription tracking
link. You may control where the link is by using the tag <% %>
:rtype: string
"""
return self._text
@text.setter
def text(self, value):
"""Text to be appended to the email, with the subscription tracking
link. You may control where the link is by using the tag <% %>
:param value: Text to be appended to the email, with the subscription
tracking link. You may control where the link is by
using the tag <% %>
:type value: string
"""
self._text = value
@property
def html(self):
"""HTML to be appended to the email, with the subscription tracking
link. You may control where the link is by using the tag <% %>
:rtype: string
"""
return self._html
@html.setter
def html(self, value):
"""HTML to be appended to the email, with the subscription tracking
link. You may control where the link is by using the tag <% %>
:param value: HTML to be appended to the email, with the subscription
tracking link. You may control where the link is by
using the tag <% %>
:type value: string
"""
self._html = value
@property
def substitution_tag(self):
""""A tag that will be replaced with the unsubscribe URL. for example:
[unsubscribe_url]. If this parameter is used, it will override both the
`text` and `html` parameters. The URL of the link will be placed at the
substitution tag's location, with no additional formatting.
:rtype: string
"""
return self._substitution_tag
@substitution_tag.setter
def substitution_tag(self, value):
""""A tag that will be replaced with the unsubscribe URL. for example:
[unsubscribe_url]. If this parameter is used, it will override both the
`text` and `html` parameters. The URL of the link will be placed at the
substitution tag's location, with no additional formatting.
:param value: A tag that will be replaced with the unsubscribe URL.
For example: [unsubscribe_url]. If this parameter is
used, it will override both the `text` and `html`
parameters. The URL of the link will be placed at the
substitution tag's location, with no additional
formatting.
:type value: string
"""
self._substitution_tag = value
def get(self):
"""
Get a JSON-ready representation of this SubscriptionTracking.
:returns: This SubscriptionTracking, ready for use in a request body.
:rtype: dict
"""
subscription_tracking = {}
if self.enable is not None:
subscription_tracking["enable"] = self.enable
if self.text is not None:
subscription_tracking["text"] = self.text.get()
if self.html is not None:
subscription_tracking["html"] = self.html.get()
if self.substitution_tag is not None:
subscription_tracking["substitution_tag"] = \
self.substitution_tag.get()
return subscription_tracking
|
