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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
try:
import rfc822
except ImportError:
import email.utils as rfc822
try:
basestring = basestring
except NameError:
# Define basestring when Python >= 3.0
basestring = str
class Email(object):
"""An email address with an optional name."""
def __init__(self,
email=None,
name=None,
substitutions=None,
subject=None,
p=0,
dynamic_template_data=None):
"""Create an Email with the given address and name.
Either fill the separate name and email fields, or pass all information
in the email parameter (e.g. email="dude Fella <example@example.com>").
:param email: Email address, or name and address in standard format.
:type email: string, optional
:param name: Name for this sender or recipient.
:type name: string, optional
:param substitutions: String substitutions to be applied to the email.
:type substitutions: list(Substitution), optional
:param subject: Subject for this sender or recipient.
:type subject: string, optional
:param p: p is the Personalization object or Personalization object
index
:type p: Personalization, integer, optional
:param dynamic_template_data: Data for a dynamic transactional template.
:type dynamic_template_data: DynamicTemplateData, optional
"""
self._name = None
self._email = None
self._personalization = p
if email and not name:
# allows passing emails as "Example Name <example@example.com>"
self.parse_email(email)
else:
# allows backwards compatibility for Email(email, name)
if email is not None:
self.email = email
if name is not None:
self.name = name
# Note that these only apply to To Emails (see Personalization.add_to)
# and should be moved but have not been for compatibility.
self._substitutions = substitutions
self._dynamic_template_data = dynamic_template_data
self._subject = subject
@property
def name(self):
"""Name associated with this email.
:rtype: string
"""
return self._name
@name.setter
def name(self, value):
"""Name associated with this email.
:param value: Name associated with this email.
:type value: string
"""
if not (value is None or isinstance(value, basestring)):
raise TypeError('name must be of type string.')
self._name = value
@property
def email(self):
"""Email address.
See http://tools.ietf.org/html/rfc3696#section-3 and its errata
http://www.rfc-editor.org/errata_search.php?rfc=3696 for information
on valid email addresses.
:rtype: string
"""
return self._email
@email.setter
def email(self, value):
"""Email address.
See http://tools.ietf.org/html/rfc3696#section-3 and its errata
http://www.rfc-editor.org/errata_search.php?rfc=3696 for information
on valid email addresses.
:param value: Email address.
See http://tools.ietf.org/html/rfc3696#section-3 and its errata
http://www.rfc-editor.org/errata_search.php?rfc=3696 for information
on valid email addresses.
:type value: string
"""
self._email = value
@property
def substitutions(self):
"""A list of Substitution objects. These substitutions will apply to
the text and html content of the body of your email, in addition
to the subject and reply-to parameters. The total collective size
of your substitutions may not exceed 10,000 bytes per
personalization object.
:rtype: list(Substitution)
"""
return self._substitutions
@substitutions.setter
def substitutions(self, value):
"""A list of Substitution objects. These substitutions will apply to
the text and html content of the body of your email, in addition to
the subject and reply-to parameters. The total collective size of
your substitutions may not exceed 10,000 bytes per personalization
object.
:param value: A list of Substitution objects. These substitutions will
apply to the text and html content of the body of your email, in
addition to the subject and reply-to parameters. The total collective
size of your substitutions may not exceed 10,000 bytes per
personalization object.
:type value: list(Substitution)
"""
self._substitutions = value
@property
def dynamic_template_data(self):
"""Data for a dynamic transactional template.
:rtype: DynamicTemplateData
"""
return self._dynamic_template_data
@dynamic_template_data.setter
def dynamic_template_data(self, value):
"""Data for a dynamic transactional template.
:param value: DynamicTemplateData
:type value: DynamicTemplateData
"""
self._dynamic_template_data = value
@property
def subject(self):
"""Subject for this sender or recipient.
:rtype: string
"""
return self._subject
@subject.setter
def subject(self, value):
"""Subject for this sender or recipient.
:param value: Subject for this sender or recipient.
:type value: string, optional
"""
self._subject = 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 parse_email(self, email_info):
"""Allows passing emails as "Example Name <example@example.com>"
:param email_info: Allows passing emails as
"Example Name <example@example.com>"
:type email_info: string
"""
name, email = rfc822.parseaddr(email_info)
# more than likely a string was passed here instead of an email address
if "@" not in email:
name = email
email = None
if not name:
name = None
if not email:
email = None
self.name = name
self.email = email
return name, email
def get(self):
"""
Get a JSON-ready representation of this Email.
:returns: This Email, ready for use in a request body.
:rtype: dict
"""
email = {}
if self.name is not None:
email["name"] = self.name
if self.email is not None:
email["email"] = self.email
return email
|
