blob: 890de3faffbaf9192c0b543fd881f954c151c1ae (
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
|
<?php
/**
* This helper builds the TemplateId 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 TemplateId object for the /mail/send API call
*
* @package SendGrid\Mail
*/
class TemplateId implements \JsonSerializable
{
/**
* @var $template_id string The id of a template that you would like to use. If you use a
* template that contains a subject and content (either text or html), you do
* not need to specify those at the personalizations nor message level
*/
private $template_id;
/**
* Optional constructor
*
* @param string|null $template_id The id of a template that you would like
* to use. If you use a template that contains
* a subject and content (either text or html),
* you do not need to specify those at the
* personalizations nor message level
*/
public function __construct($template_id = null)
{
if (isset($template_id)) {
$this->setTemplateId($template_id);
}
}
/**
* Add a template id to a TemplateId object
*
* @param string $template_id The id of a template that you would like
* to use. If you use a template that contains
* a subject and content (either text or html),
* you do not need to specify those at the
* personalizations nor message level
*
* @throws TypeException
*/
public function setTemplateId($template_id)
{
if (!is_string($template_id)) {
throw new TypeException('$template_id must be of type string.');
}
$this->template_id = $template_id;
}
/**
* Retrieve a template id from a TemplateId object
*
* @return string
*/
public function getTemplateId()
{
return $this->template_id;
}
/**
* Return an array representing a TemplateId object for the Twilio SendGrid API
*
* @return string
*/
public function jsonSerialize()
{
return $this->getTemplateId();
}
}
|