A Mail Driver with support for Using templates to send personalized emails with the Amazon SES API.
| Version (*1) | Laravel (*2) | PHP (*3) |
|---|---|---|
| 1 | 5.7 - 6 | 7.1 - 7.4 |
| 2 | 7 - 8 | 7.2 - 8.1 |
| 3 | 9 - 11 | 8.0 - 8.4 |
| 4 | 10 - 12 | 8.1 - 8.4 |
(*1) Supported Amazon SES template mail driver (This Driver) version
(*2) Supported Laravel versions
(*3) Supported PHP versions
composer require sunaoka/laravel-ses-template-driverNext, set the following in config/mail.php and config/services.php.
'default' => 'sestemplate',
'mailers' => [
'sestemplate' => [
'transport' => 'sestemplate', // or `sesv2template` - When using Amazon SES API v2
],
],'ses' => [
'key' => 'your-ses-key',
'secret' => 'your-ses-secret',
'region' => 'ses-region', // e.g. us-east-1
],If you need to include additional options when executing the SES SendTemplatedEmail request, you may define an options array within your ses configuration:
'ses' => [
'key' => 'your-ses-key',
'secret' => 'your-ses-secret',
'region' => 'ses-region', // e.g. us-east-1
'options' => [
'ConfigurationSetName' => 'MyConfigurationSet',
'TenantName' => 'MyTenant', // using Amazon SES API v2 with AWS SDK for PHP 3.352.0 or later
'Tags' => [
[
'Name' => 'foo',
'Value' => 'bar',
],
],
],
],use Illuminate\Support\Facades\Mail;
use Sunaoka\LaravelSesTemplateDriver\Mail\SesTemplate;
class Foo
{
public function sendmail()
{
$templateName = 'MyTemplate';
$templateData = [
'name' => 'Alejandro',
'favoriteanimal' => 'alligator',
];
$result = Mail::to('alejandro.rosalez@example.com')
->cc('cc@example.com')
->bcc('bcc@example.com')
->send(new SesTemplate($templateName, $templateData));
echo $result->getMessageId(); // Message-ID overwritten by Amazon SES
}
}Set From, Reply-To and custom header.
use Illuminate\Mail\Mailables\Address;
use Illuminate\Support\Facades\Mail;
use Sunaoka\LaravelSesTemplateDriver\Mail\SesTemplate;
use Sunaoka\LaravelSesTemplateDriver\Mail\SesTemplateOptions;
class Foo
{
public function sendmail()
{
$templateName = 'MyTemplate';
$templateData = [
'name' => 'Alejandro',
'favoriteanimal' => 'alligator',
];
$options = new SesTemplateOptions();
$options->from(new Address('alejandro.rosalez@example.com', 'Alejandro Rosalez'))
->replyTo(new Address('alejandro.rosalez@example.com'));
// Only with Amazon SES API v2 ('transport' is `sesv2template`)
$options->header('X-Custom-Header1', 'Custom Value 1')
->header('X-Custom-Header2', 'Custom Value 2');
// You can also set it in the constructor.
$options = new SesTemplateOptions(
from: new Address('alejandro.rosalez@example.com', 'Alejandro Rosalez'),
replyTo: new Address('alejandro.rosalez@example.com'),
headers: [
'X-Custom-Header1' => 'Custom Value 1',
'X-Custom-Header2' => 'Custom Value 2',
],
);
$result = Mail::to('alejandro.rosalez@example.com')
->cc('cc@example.com')
->bcc('bcc@example.com')
->send(new SesTemplate($templateName, $templateData, $options));
echo $result->getMessageId(); // Message-ID overwritten by Amazon SES
}
}{
"Template": {
"TemplateName": "MyTemplate",
"SubjectPart": "Greetings, {{name}}!",
"HtmlPart": "<h1>Hello {{name}},</h1><p>Your favorite animal is {{favoriteanimal}}.</p>",
"TextPart": "Dear {{name}},\r\nYour favorite animal is {{favoriteanimal}}."
}
}Not supported, to send a templated email to multiple destinations.
php artisan ses-template:list-templates --helpDescription:
Lists the email templates present in your Amazon SES account in the current AWS Region
Usage:
ses-template:list-templates [options]
Options:
--name Sort by the name of the template [default]
--time Sort by the time and date the template was created
--asc Sort by ascending order [default]
--desc Sort by descending order
--json The output is formatted as a JSON string
php artisan ses-template:list-templates+----+-------------+---------------------------+
| No | Name | Created At |
+----+-------------+---------------------------+
| 0 | MyTemplate | 2020-11-24T15:01:21+00:00 |
| 1 | MyTemplate2 | 2020-11-24T15:01:25+00:00 |
+----+-------------+---------------------------+
Enter a number to display the template object:
> 0
TemplateName:
MyTemplate
SubjectPart:
Greetings, {{name}}!
TextPart:
Dear {{name}},\r\nYour favorite animal is {{favoriteanimal}}.
HtmlPart:
<h1>Hello {{name}},</h1><p>Your favorite animal is {{favoriteanimal}}.</p>
php artisan ses-template:list-templates --json{
"TemplatesMetadata": [
{
"Name": "MyTemplate",
"CreatedTimestamp": "2020-11-24T15:01:21+00:00"
},
{
"Name": "MyTemplate2",
"CreatedTimestamp": "2020-11-24T15:01:25+00:00"
}
]
}Amazon SES API v2
{
"TemplatesMetadata": [
{
"TemplateName": "MyTemplate",
"CreatedTimestamp": "2020-11-24T15:01:21+00:00"
},
{
"TemplateName": "MyTemplate2",
"CreatedTimestamp": "2020-11-24T15:01:25+00:00"
}
]
}php artisan ses-template:get-template --helpDescription:
Displays the template object for the template you specify
Usage:
ses-template:get-template [options] [--] <TemplateName>
Arguments:
TemplateName The name of the template to retrieve
Options:
--json The output is formatted as a JSON string
php artisan ses-template:get-template MyTemplateTemplateName:
MyTemplate
SubjectPart:
Greetings, {{name}}!
TextPart:
Dear {{name}},\r\nYour favorite animal is {{favoriteanimal}}.
HtmlPart:
<h1>Hello {{name}},</h1><p>Your favorite animal is {{favoriteanimal}}.</p>
php artisan ses-template:get-template MyTemplate --json{
"Template": {
"TemplateName": "MyTemplate",
"SubjectPart": "Greetings, {{name}}!",
"HtmlPart": "<h1>Hello {{name}},</h1><p>Your favorite animal is {{favoriteanimal}}.</p>",
"TextPart": "Dear {{name}},\r\nYour favorite animal is {{favoriteanimal}}."
}
}Amazon SES API v2
{
"Template": {
"TemplateName": "MyTemplate",
"TemplateContent": {
"Subject": "Greetings, {{name}}!",
"Html": "<h1>Hello {{name}},</h1><p>Your favorite animal is {{favoriteanimal}}.</p>",
"Text": "Dear {{name}},\r\nYour favorite animal is {{favoriteanimal}}."
}
}
}{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"ses:SendTemplatedEmail",
"ses:ListTemplates",
"ses:GetTemplate"
],
"Resource": "*"
}
]
}{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"ses:SendEmail",
"ses:ListEmailTemplates",
"ses:GetEmailTemplate"
],
"Resource": "*"
}
]
}