blob: 508e60c5eac14d2a71259be439a770bf31d74f0f (
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
|
<?php
/**
* This helper builds the BatchId 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 BatchId object for the /mail/send API call
*
* @package SendGrid\Mail
*/
class BatchId implements \JsonSerializable
{
/** @var $batch_id string This ID represents a batch of emails to be sent at the same time */
private $batch_id;
/**
* Optional constructor
*
* @param string|null $batch_id This ID represents a batch of emails to
* be sent at the same time
*/
public function __construct($batch_id = null)
{
if (isset($batch_id)) {
$this->setBatchId($batch_id);
}
}
/**
* Add the batch id to a BatchId object
*
* @param string $batch_id This ID represents a batch of emails to be sent
* at the same time
*
* @throws TypeException
*/
public function setBatchId($batch_id)
{
if (!is_string($batch_id)) {
throw new TypeException('$batch_id must be of type string.');
}
$this->batch_id = $batch_id;
}
/**
* Return the batch id from a BatchId object
*
* @return string
*/
public function getBatchId()
{
return $this->batch_id;
}
/**
* Return an array representing a BatchId object for the Twilio SendGrid API
*
* @return null|string
*/
public function jsonSerialize()
{
return $this->getBatchId();
}
}
|
