使用 SendGrid 与 PHP 动态生成邮件模板内容的实践指南-php教程-PHP中文网

使用 SendGrid 与 PHP 动态生成邮件模板内容的实践指南

心靈之曲

发布： 2025-11-06 13:01:11

原创

736人浏览过

使用 SendGrid 与 PHP 动态生成邮件模板内容的实践指南

本文详细介绍了在使用 sendgrid 发送邮件时，如何将动态数据集成到本地 php 文件作为模板的方法。由于 `file_get_contents()` 无法直接执行 php 代码或传递变量，我们通过在模板中定义占位符，并利用 php 的 `str_replace()` 函数在发送前替换这些占位符，从而实现动态内容的注入。文章提供了详细的示例代码和最佳实践，帮助开发者高效、安全地构建个性化邮件。

理解 SendGrid 邮件模板与动态数据集成

在使用 SendGrid 发送邮件时，开发者常常需要将动态数据（如用户名、订单详情等）注入到预先设计好的邮件模板中。当选择使用本地 PHP 文件作为邮件模板时，一个常见的误区是试图像 include 或 require 那样直接向 PHP 模板文件传递变量。然而，当通过 file_get_contents() 函数读取一个 PHP 文件时，PHP 解释器并不会执行该文件中的 PHP 代码，而是将其视为纯文本内容进行读取。这意味着，如果在模板文件中定义了 $variable，这些变量并不会被解析，也无法通过外部作用域直接赋值。

因此，为了实现动态数据的注入，我们需要一种在文件内容被读取为字符串之后，再进行数据替换的机制。最直接有效的方法是使用占位符替换。

核心方法：占位符替换

占位符替换是一种简单而强大的技术，它允许我们在模板文件中定义特定的标记（占位符），然后在运行时将这些标记替换为实际的动态数据。

步骤一：准备邮件模板

首先，在您的邮件模板文件（例如 third-party-booking.php）中，定义需要被动态数据替换的占位符。为了避免与邮件内容本身的字符冲突，建议使用独特的占位符格式，例如 %VARIABLE_NAME% 或 {{VARIABLE_NAME}}。

立即学习“PHP免费学习笔记（深入）”；

../templates/emails/third-party-booking.php 示例：

<html>
<head>
    <title>预订确认</title>
</head>
<body>
    <p>尊敬的 %name% 您好，</p>
    <p>感谢您的预订！</p>
    <p>您的预订详情如下：</p>
    <ul>
        <li>电子邮件：<a href="mailto:%email%">%email%</a></li>
        <li>预订编号：#%booking_id%</li>
        <li>入住日期：<time>%check_in_date%</time></li>
        <li>退房日期：<time>%check_out_date%</time></li>
    </ul>
    <p>如有任何疑问，请随时联系我们。</p>
    <p>祝您愉快！</p>
</body>
</html>

登录后复制

步骤二：构建动态数据

在发送邮件的 PHP 脚本中，准备一个关联数组，其中键是占位符名称（不含前后缀），值是对应的动态数据。

$details = [
    'name' => '张三',
    'email' => 'zhangsan@example.com',
    'booking_id' => 'ABC12345',
    'check_in_date' => '2023-10-26',
    'check_out_date' => '2023-10-28'
];

登录后复制

步骤三：执行占位符替换

在将模板内容传递给 SendGrid 之前，遍历动态数据数组，并使用 str_replace() 函数将模板中的占位符替换为实际的值。

$message_body = file_get_contents('../templates/emails/third-party-booking.php');

foreach ($details as $parameter => $value) {
    // 确保占位符格式与模板中定义的一致
    $message_body = str_replace('%' . $parameter . '%', htmlspecialchars($value), $message_body);
}

登录后复制

重要提示： 在进行替换时，务必对动态数据进行 htmlspecialchars() 处理，以防止跨站脚本攻击（XSS），特别是当数据来源于用户输入时。

Boomy

AI音乐生成工具，创建生成音乐,与世界分享.

272

查看详情

步骤四：发送邮件

最后，将处理过的 $message_body 设置为 SendGrid 邮件的 HTML 内容，并发送邮件。

完整示例代码

以下是使用 SendGrid 发送动态邮件的完整 PHP 代码：

<?php

require __DIR__ . '/vendor/autoload.php'; // 确保引入 SendGrid 库

// 从环境变量获取 SendGrid API Key
$sendgrid_key = getenv('SENDGRID_KEY');
if (!$sendgrid_key) {
    die("SENDGRID_KEY environment variable not set.");
}

$sendgrid = new \SendGrid($sendgrid_key);
$email = new \SendGrid\Mail\Mail(); // 使用新的命名空间 \SendGrid\Mail\Mail

// 动态数据
$details = [
    'name' => '张三',
    'email' => 'zhangsan@example.com', // 替换为收件人邮箱
    'booking_id' => 'ABC12345',
    'check_in_date' => '2023-10-26',
    'check_out_date' => '2023-10-28'
];

// 读取邮件模板内容
$template_path = '../templates/emails/third-party-booking.php';
if (!file_exists($template_path)) {
    die("Email template not found at: " . $template_path);
}
$message_body = file_get_contents($template_path);

// 执行占位符替换
foreach ($details as $parameter => $value) {
    // 对动态数据进行 HTML 实体编码，防止 XSS 攻击
    $message_body = str_replace('%' . $parameter . '%', htmlspecialchars($value, ENT_QUOTES, 'UTF-8'), $message_body);
}

// 设置邮件参数
$email->setFrom("sender@example.com", "您的公司名称"); // 发件人邮箱和名称
$email->setSubject("您的预订确认函 - " . $details['booking_id']); // 邮件主题

// 添加收件人
// 注意：这里使用 $details['email'] 作为收件人，确保其是有效的邮箱地址
$email->addTo($details['email'], $details['name']);

// 设置邮件内容为 HTML
$email->addContent("text/html", $message_body);

try {
    $response = $sendgrid->send($email);
    echo "邮件发送成功！\n";
    // 打印响应信息，用于调试
    // print_r($response->statusCode());
    // print_r($response->headers());
    // print_r($response->body());
} catch (Exception $e) {
    echo '邮件发送失败: ' . $e->getMessage() . "\n";
}
?>

登录后复制

注意事项与最佳实践

安全性（XSS 防护）：
- 始终对所有插入到 HTML 邮件模板中的动态数据使用 htmlspecialchars() 或类似的函数进行转义。这可以有效防止恶意用户通过注入脚本来窃取信息或破坏邮件内容。
- 特别是当数据来源于用户输入时，此步骤至关重要。
占位符约定：
- 在整个项目中保持一致的占位符格式（例如 %VAR% 或 {{VAR}}），这有助于提高代码的可读性和维护性。
- 选择不易与邮件正文内容冲突的特殊字符作为占位符的定界符。
模板复杂性与性能：
- 对于非常复杂的邮件模板或需要大量动态替换的场景，str_replace() 可能会变得难以管理或效率不高。
- 在这种情况下，可以考虑使用更专业的 PHP 模板引擎，如 Twig 或 Blade，它们提供了更强大的模板继承、条件逻辑和循环功能。这些引擎通常会将模板编译成 PHP 代码，执行效率更高。
SendGrid 动态模板：
- SendGrid 自身也提供了强大的动态模板功能，允许在 SendGrid 平台上设计和管理模板，并通过 API 传递 JSON 数据来填充。
- 如果您的项目允许，并且希望将模板管理与代码分离，使用 SendGrid 的动态模板是更推荐的方案。本文介绍的方法适用于需要在本地完全控制模板文件内容的场景。
错误处理：
- 在实际应用中，应增加对 file_get_contents() 返回值以及 SendGrid API 响应的错误检查和处理，确保邮件发送的健壮性。

总结

通过 file_get_contents() 读取本地 PHP 文件作为邮件模板，并结合 str_replace() 进行占位符替换，是一种简单有效的向 SendGrid 邮件注入动态数据的方法。它避免了直接执行 PHP 模板文件的复杂性，同时提供了足够的灵活性来构建个性化的邮件内容。在实施时，务必注意数据安全性和模板的可维护性，并根据项目需求考虑是否采用更高级的模板引擎或 SendGrid 自身的动态模板功能。

以上就是使用 SendGrid 与 PHP 动态生成邮件模板内容的实践指南的详细内容，更多请关注php中文网其它相关文章！

大家都在看：

如何下载php日志记录文件_下载php日志功能实现文件的方法 php怎么调试接口头部信息_php接口请求头与响应头调试方法 php枚举怎么用_PHP枚举类型（Enum）定义与使用方法（PHP 8.1+） php编写数据验证与过滤的方法_php编写表单安全处理的技巧 PHP递归函数怎么写_PHP递归函数的编写步骤与代码实例