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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
|
<?php
/**
* This helper builds the MailSettings object for a /mail/send API call
*
* PHP Version - 5.6, 7.0, 7.1, 7.2
*
* @package SendGrid\Mail
* @author Elmer Thomas <dx@sendgrid.com>
* @copyright 2018-19 Twilio SendGrid
* @license https://opensource.org/licenses/MIT The MIT License
* @version GIT: <git_id>
* @link http://packagist.org/packages/sendgrid/sendgrid
*/
namespace SendGrid\Mail;
/**
* This class is used to construct a MailSettings object for the /mail/send API call
*
* A collection of different mail settings that you can use to specify how you would
* like this email to be handled
*
* @package SendGrid\Mail
*/
class MailSettings implements \JsonSerializable
{
/** @var $bcc Bcc object */
private $bcc;
/** @var $bypass_list_management BypassListManagement object */
private $bypass_list_management;
/** @var $footer Footer object */
private $footer;
/** @var $sandbox_mode SandBoxMode object */
private $sandbox_mode;
/** @var $spam_check SpamCheck object */
private $spam_check;
/**
* Optional constructor
*
* @param BccSettings|null $bcc_settings BccSettings object
* @param BypassListManagement|null $bypass_list_management BypassListManagement
* object
* @param Footer|null $footer Footer object
* @param SandBoxMode|null $sandbox_mode SandBoxMode object
* @param SpamCheck|null $spam_check SpamCheck object
*/
public function __construct(
$bcc_settings = null,
$bypass_list_management = null,
$footer = null,
$sandbox_mode = null,
$spam_check = null
) {
if (isset($bcc_settings)) {
$this->setBccSettings($bcc_settings);
}
if (isset($bypass_list_management)) {
$this->setBypassListManagement($bypass_list_management);
}
if (isset($footer)) {
$this->setFooter($footer);
}
if (isset($sandbox_mode)) {
$this->setSandboxMode($sandbox_mode);
}
if (isset($spam_check)) {
$this->setSpamCheck($spam_check);
}
}
/**
* Set the bcc settings on a MailSettings object
*
* @param BccSettings|bool $enable The BccSettings object or an indication
* if the setting is enabled
* @param string|null $email The email address that you would like
* to receive the BCC
*
* @throws TypeException
*/
public function setBccSettings($enable, $email = null)
{
if ($enable instanceof BccSettings) {
$bcc = $enable;
$this->bcc = $bcc;
return;
}
if (!is_bool($enable)) {
throw new TypeException(
'$enable must be an instance of SendGrid\Mail\BccSettings or of type bool.'
);
}
$this->bcc = new BccSettings($enable, $email);
}
/**
* Retrieve the bcc settings from a MailSettings object
*
* @return Bcc
*/
public function getBccSettings()
{
return $this->bcc;
}
/**
* Set bypass list management settings on a MailSettings object
*
* @param BypassListManagement|bool $enable The BypassListManagement
* object or an indication
* if the setting is enabled
*
* @throws TypeException
*/
public function setBypassListManagement($enable)
{
if ($enable instanceof BypassListManagement) {
$bypass_list_management = $enable;
$this->bypass_list_management = $bypass_list_management;
return;
}
if (!is_bool($enable)) {
throw new TypeException(
'$enable must be an instance of SendGrid\Mail\BypassListManagement or of type bool.'
);
}
$this->bypass_list_management = new BypassListManagement($enable);
return;
}
/**
* Retrieve bypass list management settings from a MailSettings object
*
* @return BypassListManagement
*/
public function getBypassListManagement()
{
return $this->bypass_list_management;
}
/**
* Set the footer settings on a MailSettings object
*
* @param Footer|bool $enable The Footer object or an indication
* if the setting is enabled
* @param string|null $text The plain text content of your footer
* @param string|null $html The HTML content of your footer
*
* @return null
*/
public function setFooter($enable, $text = null, $html = null)
{
if ($enable instanceof Footer) {
$footer = $enable;
$this->footer = $footer;
return;
}
$this->footer = new Footer($enable, $text, $html);
return;
}
/**
* Retrieve the footer settings from a MailSettings object
*
* @return Footer
*/
public function getFooter()
{
return $this->footer;
}
/**
* Set sandbox mode settings on a MailSettings object
*
* @param SandBoxMode|bool $enable The SandBoxMode object or an
* indication if the setting is enabled
*
* @return null
*/
public function setSandboxMode($enable)
{
if ($enable instanceof SandBoxMode) {
$sandbox_mode = $enable;
$this->sandbox_mode = $sandbox_mode;
return;
}
$this->sandbox_mode = new SandBoxMode($enable);
return;
}
/**
* Retrieve sandbox mode settings on a MailSettings object
*
* @return SandBoxMode
*/
public function getSandboxMode()
{
return $this->sandbox_mode;
}
/**
* Enable sandbox mode on a MailSettings object
*/
public function enableSandboxMode()
{
$this->setSandboxMode(true);
}
/**
* Disable sandbox mode on a MailSettings object
*/
public function disableSandboxMode()
{
$this->setSandboxMode(false);
}
/**
* Set spam check settings on a MailSettings object
*
* @param SpamCheck|bool $enable The SpamCheck object or an
* indication if the setting is enabled
* @param int $threshold The threshold used to determine if your
* content qualifies as spam on a scale
* from 1 to 10, with 10 being most strict,
* or most
* @param string $post_to_url An Inbound Parse URL that you would like
* a copy of your email along with the spam
* report to be sent to
*
* @return null
*/
public function setSpamCheck($enable, $threshold = null, $post_to_url = null)
{
if ($enable instanceof SpamCheck) {
$spam_check = $enable;
$this->spam_check = $spam_check;
return;
}
$this->spam_check = new SpamCheck($enable, $threshold, $post_to_url);
return;
}
/**
* Retrieve spam check settings from a MailSettings object
*
* @return SpamCheck
*/
public function getSpamCheck()
{
return $this->spam_check;
}
/**
* Return an array representing a MailSettings object for the Twilio SendGrid API
*
* @return null|array
*/
public function jsonSerialize()
{
return array_filter(
[
'bcc' => $this->getBccSettings(),
'bypass_list_management' => $this->getBypassListManagement(),
'footer' => $this->getFooter(),
'sandbox_mode' => $this->getSandboxMode(),
'spam_check' => $this->getSpamCheck()
],
function ($value) {
return $value !== null;
}
) ?: null;
}
}
|
