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
|
<?php
/**
* This helper builds the SpamCheck 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 SpamCheck object for the /mail/send API call
*
* @package SendGrid\Mail
*/
class SpamCheck implements \JsonSerializable
{
/** @var $enable bool Indicates if this setting is enabled */
private $enable;
/**
* @var $threshold int 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
* likely to be considered as spam
*/
private $threshold;
/**
* @var $post_to_urlstring An Inbound Parse URL that you would like a copy of your
* email along with the spam report to be sent to
*/
private $post_to_url;
/**
* Optional constructor
*
* @param bool|null $enable Indicates if this setting is enabled
* @param int|null $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|null $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
*/
public function __construct($enable = null, $threshold = null, $post_to_url = null)
{
if (isset($enable)) {
$this->setEnable($enable);
}
if (isset($threshold)) {
$this->setThreshold($threshold);
}
if (isset($post_to_url)) {
$this->setPostToUrl($post_to_url);
}
}
/**
* Update the enable setting on a SpamCheck object
*
* @param bool $enable Indicates if this setting is enabled
*
* @throws TypeException
*/
public function setEnable($enable)
{
if (!is_bool($enable)) {
throw new TypeException('$enable must be of type bool.');
}
$this->enable = $enable;
}
/**
* Retrieve the enable setting on a SpamCheck object
*
* @return bool
*/
public function getEnable()
{
return $this->enable;
}
/**
* Set the threshold value on a SpamCheck object
*
* @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
*
* @throws TypeException
*/
public function setThreshold($threshold)
{
if (!is_int($threshold)) {
throw new TypeException('$threshold must be of type int.');
}
$this->threshold = $threshold;
}
/**
* Retrieve the threshold value from a SpamCheck object
*
* @return int
*/
public function getThreshold()
{
return $this->threshold;
}
/**
* Set the post to url value on a SpamCheck object
*
* @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
*
* @throws TypeException
*/
public function setPostToUrl($post_to_url)
{
if (!is_string($post_to_url)) {
throw new TypeException('$post_to_url must be of type string.');
}
$this->post_to_url = $post_to_url;
}
/**
* Retrieve the post to url value from a SpamCheck object
*
* @return string
*/
public function getPostToUrl()
{
return $this->post_to_url;
}
/**
* Return an array representing a SpamCheck object for the Twilio SendGrid API
*
* @return null|array
*/
public function jsonSerialize()
{
return array_filter(
[
'enable' => $this->getEnable(),
'threshold' => $this->getThreshold(),
'post_to_url' => $this->getPostToUrl()
],
function ($value) {
return $value !== null;
}
) ?: null;
}
}
|
