blob: f3204fe9a6e63bbb5d50d5d209d41b62ea929cba (
plain)
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
|
<?php
/**
* This helper builds the OpenTracking 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 OpenTracking object for the /mail/send API call
*
* Allows you to track whether the email was opened or not, but including a single
* pixel image in the body of the content. When the pixel is loaded, we can log that
* the email was opened
*
* @package SendGrid\Mail
*/
class OpenTracking implements \JsonSerializable
{
/** @var $enable bool Indicates if this setting is enabled */
private $enable;
/** @var $substitution_tag string Allows you to specify a substitution tag that you can insert in the body of your email at a location that you desire. This tag will be replaced by the open tracking pixel */
private $substitution_tag;
/**
* Optional constructor
*
* @param bool|null $enable Indicates if this setting is enabled
* @param string|null $substitution_tag Allows you to specify a substitution
* tag that you can insert in the body
* of your email at a location that you
* desire. This tag will be replaced by
* the open tracking pixel
*/
public function __construct($enable = null, $substitution_tag = null)
{
if (isset($enable)) {
$this->setEnable($enable);
}
if (isset($substitution_tag)) {
$this->setSubstitutionTag($substitution_tag);
}
}
/**
* Update the enable setting on a OpenTracking 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 OpenTracking object
*
* @return bool
*/
public function getEnable()
{
return $this->enable;
}
/**
* Set the substitution tag on a OpenTracking object
*
* @param string $substitution_tag Allows you to specify a substitution
* tag that you can insert in the body
* of your email at a location that you
* desire. This tag will be replaced by
* the open tracking pixel
*
* @throws TypeException
*/
public function setSubstitutionTag($substitution_tag)
{
if (!is_string($substitution_tag)) {
throw new TypeException('$substitution_tag must be of type string.');
}
$this->substitution_tag = $substitution_tag;
}
/**
* Retrieve the substitution tag from a OpenTracking object
*
* @return string
*/
public function getSubstitutionTag()
{
return $this->substitution_tag;
}
/**
* Return an array representing a OpenTracking object for the Twilio SendGrid API
*
* @return null|array
*/
public function jsonSerialize()
{
return array_filter(
[
'enable' => $this->getEnable(),
'substitution_tag' => $this->getSubstitutionTag()
],
function ($value) {
return $value !== null;
}
) ?: null;
}
}
|
