summaryrefslogtreecommitdiff
path: root/Postman/Postman-Mail/sendgrid/vendor/sendgrid/sendgrid/lib/mail/OpenTracking.php
diff options
context:
space:
mode:
Diffstat (limited to 'Postman/Postman-Mail/sendgrid/vendor/sendgrid/sendgrid/lib/mail/OpenTracking.php')
-rw-r--r--Postman/Postman-Mail/sendgrid/vendor/sendgrid/sendgrid/lib/mail/OpenTracking.php124
1 files changed, 124 insertions, 0 deletions
diff --git a/Postman/Postman-Mail/sendgrid/vendor/sendgrid/sendgrid/lib/mail/OpenTracking.php b/Postman/Postman-Mail/sendgrid/vendor/sendgrid/sendgrid/lib/mail/OpenTracking.php
new file mode 100644
index 0000000..f3204fe
--- /dev/null
+++ b/Postman/Postman-Mail/sendgrid/vendor/sendgrid/sendgrid/lib/mail/OpenTracking.php
@@ -0,0 +1,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;
+ }
+}