Template
in package
An object that defines the email template to use for an email message, and the values to use for any message variables in that template. An *email template* is a type of message template that contains content that you want to define, save, and reuse in email messages that you send.
Table of Contents
Properties
- $headers : array<string|int, MessageHeader>|null
- The list of message headers that will be added to the email message.
- $templateArn : string|null
- The Amazon Resource Name (ARN) of the template.
- $templateData : string|null
- An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.
- $templateName : string|null
- The name of the template. You will refer to this name when you send email using the `SendTemplatedEmail` or `SendBulkTemplatedEmail` operations.
Methods
- __construct() : mixed
- create() : self
- getHeaders() : array<string|int, MessageHeader>
- getTemplateArn() : string|null
- getTemplateData() : string|null
- getTemplateName() : string|null
Properties
$headers
The list of message headers that will be added to the email message.
private
array<string|int, MessageHeader>|null
$headers
$templateArn
The Amazon Resource Name (ARN) of the template.
private
string|null
$templateArn
$templateData
An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.
private
string|null
$templateData
$templateName
The name of the template. You will refer to this name when you send email using the `SendTemplatedEmail` or `SendBulkTemplatedEmail` operations.
private
string|null
$templateName
Methods
__construct()
public
__construct(MessageHeader|array)[]} $input) : mixed
Parameters
- $input : MessageHeader|array)[]}
create()
public
static create(MessageHeader|array)[]}|Template $input) : self
Parameters
- $input : MessageHeader|array)[]}|Template
Return values
selfgetHeaders()
public
getHeaders() : array<string|int, MessageHeader>
Return values
array<string|int, MessageHeader>getTemplateArn()
public
getTemplateArn() : string|null
Return values
string|nullgetTemplateData()
public
getTemplateData() : string|null
Return values
string|nullgetTemplateName()
public
getTemplateName() : string|null