summaryrefslogtreecommitdiff
path: root/Postman/Postman-Mail/sendgrid/vendor/sendgrid/sendgrid/lib/mail/Header.php
diff options
context:
space:
mode:
Diffstat (limited to 'Postman/Postman-Mail/sendgrid/vendor/sendgrid/sendgrid/lib/mail/Header.php')
-rw-r--r--Postman/Postman-Mail/sendgrid/vendor/sendgrid/sendgrid/lib/mail/Header.php116
1 files changed, 116 insertions, 0 deletions
diff --git a/Postman/Postman-Mail/sendgrid/vendor/sendgrid/sendgrid/lib/mail/Header.php b/Postman/Postman-Mail/sendgrid/vendor/sendgrid/sendgrid/lib/mail/Header.php
new file mode 100644
index 0000000..aa901cf
--- /dev/null
+++ b/Postman/Postman-Mail/sendgrid/vendor/sendgrid/sendgrid/lib/mail/Header.php
@@ -0,0 +1,116 @@
+<?php
+/**
+ * This helper builds the Header 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 Header object for the /mail/send API call
+ *
+ * An object containing key/value pairs of header names and the value to substitute
+ * for them. You must ensure these are properly encoded if they contain unicode
+ * characters. Must not be one of the reserved headers
+ *
+ * @package SendGrid\Mail
+ */
+class Header implements \JsonSerializable
+{
+ /** @var $key string Header key */
+ private $key;
+ /** @var $value string Header value */
+ private $value;
+
+ /**
+ * Optional constructor
+ *
+ * @param string|null $key Header key
+ * @param string|null $value Header value
+ */
+ public function __construct($key = null, $value = null)
+ {
+ if (isset($key)) {
+ $this->setKey($key);
+ }
+ if (isset($value)) {
+ $this->setValue($value);
+ }
+ }
+
+ /**
+ * Add the key on a Header object
+ *
+ * @param string $key Header key
+ *
+ * @throws TypeException
+ */
+ public function setKey($key)
+ {
+ if (!is_string($key)) {
+ throw new TypeException('$key must be of type string.');
+ }
+ $this->key = $key;
+ }
+
+ /**
+ * Retrieve the key from a Header object
+ *
+ * @return string
+ */
+ public function getKey()
+ {
+ return $this->key;
+ }
+
+ /**
+ * Add the value on a Header object
+ *
+ * @param string $value Header value
+ *
+ * @throws TypeException
+ */
+ public function setValue($value)
+ {
+ if (!is_string($value)) {
+ throw new TypeException('$value must be of type string.');
+ }
+ $this->value = $value;
+ }
+
+ /**
+ * Retrieve the value from a Header object
+ *
+ * @return string
+ */
+ public function getValue()
+ {
+ return $this->value;
+ }
+
+ /**
+ * Return an array representing a Header object for the Twilio SendGrid API
+ *
+ * @return null|array
+ */
+ public function jsonSerialize()
+ {
+ return array_filter(
+ [
+ 'key' => $this->getKey(),
+ 'value' => $this->getValue()
+ ],
+ function ($value) {
+ return $value !== null;
+ }
+ ) ?: null;
+ }
+}