blob: 5e0cdebe1cd953ee72eea2449cd3677555ad7f56 (
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
|
<?php
/**
* This helper builds the IpPoolName 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 IpPoolName object for the /mail/send API call
*
* @package SendGrid\Mail
*/
class IpPoolName implements \JsonSerializable
{
/** @var $ip_pool_name string The IP Pool that you would like to send this email from. Minimum length: 2, Maximum Length: 64 */
private $ip_pool_name;
/**
* Optional constructor
*
* @param string|null $ip_pool_name The IP Pool that you would like to
* send this email from. Minimum length:
* 2, Maximum Length: 64
*/
public function __construct($ip_pool_name = null)
{
if (isset($ip_pool_name)) {
$this->setIpPoolName($ip_pool_name);
}
}
/**
* Set the ip pool name on a IpPoolName object
*
* @param string $ip_pool_name The IP Pool that you would like to
* send this email from. Minimum length:
* 2, Maximum Length: 64
*
* @throws TypeException
*/
public function setIpPoolName($ip_pool_name)
{
if (!is_string($ip_pool_name)) {
throw new TypeException('$ip_pool_name must be of type string.');
}
$this->ip_pool_name = $ip_pool_name;
}
/**
* Retrieve the ip pool name from a IpPoolName object
*
* @return string
*/
public function getIpPoolName()
{
return $this->ip_pool_name;
}
/**
* Return an array representing a IpPoolName object for the Twilio SendGrid API
*
* @return string
*/
public function jsonSerialize()
{
return $this->getIpPoolName();
}
}
|
