blob: 031f035b4efac0bc8084d5c1e23cc27872f0a93b (
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
|
<?php
/**
* This helper builds the CustomArg 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 CustomArg object for the /mail/send API call
*
* Values that are specific to the entire send that will be carried along with the
* email and its activity data. Substitutions will not be made on custom arguments,
* so any string that is entered into this parameter will be assumed to be the
* custom argument that you would like to be used. This parameter is overridden by
* personalizations[x].custom_args if that parameter has been defined. Total custom
* args size may not exceed 10,000 bytes.
*
* @package SendGrid\Mail
*/
class CustomArg implements \JsonSerializable
{
/** @var $key string Custom arg key */
private $key;
/** @var $value string Custom arg value */
private $value;
/**
* Optional constructor
*
* @param string|null $key Custom arg key
* @param string|null $value Custom arg value
*/
public function __construct($key = null, $value = null)
{
if (isset($key)) {
$this->setKey($key);
}
if (isset($value)) {
$this->setValue($value);
}
}
/**
* Add a custom arg key on a CustomArg object
*
* @param string $key Custom arg key
*
* @throws TypeException
*/
public function setKey($key)
{
if (!is_string($key)) {
throw new TypeException('$key must be of type string');
}
$this->key = (string) $key;
}
/**
* Retrieve a custom arg key on a CustomArg object
*
* @return string
*/
public function getKey()
{
return $this->key;
}
/**
* Add a custom arg value on a CustomArg object
*
* @param string $value Custom arg value
*
* @throws TypeException
*/
public function setValue($value)
{
if (!is_string($value)) {
throw new TypeException('$value must be of type string.');
}
$this->value = (string) $value;
}
/**
* Retrieve a custom arg key on a CustomArg object
*
* @return string
*/
public function getValue()
{
return $this->value;
}
/**
* Return an array representing a CustomArg 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;
}
}
|
