使用 SendGrid 结合本地模板文件发送动态邮件内容的教程-php教程-PHP中文网

使用 SendGrid 结合本地模板文件发送动态邮件内容的教程

聖光之護

发布： 2025-11-14 12:43:39

原创

509人浏览过

使用 SendGrid 结合本地模板文件发送动态邮件内容的教程

本教程将指导您如何在使用 sendgrid 发送邮件时，有效地将动态数据注入到本地 html 模板文件中。针对 `file_get_contents` 读取模板后无法直接传递变量的问题，我们将详细介绍通过字符串替换（`str_replace`）机制实现数据注入的方法，并提供清晰的代码示例和最佳实践建议，确保您能生成个性化且专业的邮件内容。

在现代应用程序中，发送包含个性化内容的电子邮件是常见的需求。当使用 SendGrid 这样的邮件服务提供商时，开发者通常会希望将动态数据（如用户姓名、订单详情等）注入到预先设计好的 HTML 邮件模板中。本文将详细阐述如何通过 PHP 读取本地模板文件并有效地注入动态数据，最终通过 SendGrid 发送邮件。

理解 SendGrid 邮件模板与数据传递机制

在使用 SendGrid PHP 库时，我们通常会通过 setHtml() 方法设置邮件的 HTML 内容。如果该内容来源于一个本地文件，例如一个 .php 或 .html 文件，最直观的做法是使用 file_get_contents() 函数读取其内容。

然而，需要明确的是，当您使用 file_get_contents() 读取一个 PHP 文件时，PHP 解释器并不会执行该文件中的 PHP 代码，而是将其视为一个普通的文本文件，读取其原始字符串内容。这意味着，您无法像使用 include 或 require 那样，在读取文件时将变量直接传递给模板文件进行解析。

因此，如果您的模板文件 (third-party-booking.php 或 third-party-booking.html) 包含像 <?php echo $details['name']; ?> 这样的 PHP 标签，file_get_contents() 将会原样读取这些标签，而不是它们被解析后的值。为了实现动态数据注入，我们需要在读取模板内容后，手动进行数据的替换。

动态数据注入方案：字符串替换

最直接且有效的方法是采用字符串替换机制。这要求我们在模板文件中预定义好占位符，然后通过 PHP 代码将这些占位符替换为实际的动态数据。

AiPPT模板广场

AiPPT模板广场-PPT模板-word文档模板-excel表格模板

147

查看详情

1. 模板设计

首先，设计您的 HTML 邮件模板，并在需要插入动态数据的地方使用独特的占位符。这些占位符可以是任何您定义的字符串，但建议使用不易与实际内容冲突的格式，例如 %{placeholder_name}% 或 [[placeholder_name]]。

示例模板文件：templates/emails/third-party-booking.html

<!DOCTYPE html>
<html>
<head>
    <title>预订确认</title>
</head>
<body>
    <h1>您好，%{name}%！</h1>
    <p>感谢您的预订。以下是您的预订详情：</p>
    <ul>
        <li>预订编号: %{booking_id}%</li>
        <li>服务名称: %{service_name}%</li>
        <li>预订日期: %{booking_date}%</li>
        <li>联系邮箱: %{email}%</li>
    </ul>
    <p>如有任何疑问，请随时联系我们。</p>
    <p>此致，<br>您的团队</p>
</body>
</html>

登录后复制

2. 实现代码示例

接下来，在您的 PHP 代码中，读取模板内容，准备动态数据，然后遍历数据并使用 str_replace() 函数替换模板中的占位符。

<?php
require 'vendor/autoload.php'; // 确保您的项目已安装 SendGrid 库

use SendGrid\Mail\Mail;
use SendGrid\Mail\Personalization;

// 假设您已通过环境变量或配置文件设置了 SendGrid API Key
// putenv('SENDGRID_KEY=YOUR_SENDGRID_API_KEY'); 

// 1. 初始化 SendGrid 客户端
$sendgrid = new \SendGrid(getenv('SENDGRID_KEY'));

// 2. 准备动态数据
$details = [
    'name' => '张三',
    'email' => 'zhangsan@example.com',
    'booking_id' => 'BKN-20231027-001',
    'service_name' => '高级咨询服务',
    'booking_date' => '2023年11月15日'
];

// 3. 读取邮件模板内容
$message_body = file_get_contents('../templates/emails/third-party-booking.html');

// 4. 遍历动态数据，替换模板中的占位符
foreach ($details as $parameter => $value) {
    // 占位符格式为 %{parameter}%
    $message_body = str_replace('%{' . $parameter . '}%', $value, $message_body);
}

// 5. 构建 SendGrid 邮件对象
$email = new Mail();
$email->setFrom("noreply@yourdomain.com", "您的公司"); // 发件人邮箱和名称
$email->setSubject("您的预订确认函"); // 邮件主题
$email->addContent("text/html", $message_body); // 设置 HTML 内容

// 添加收件人
// 如果有多个收件人，可以使用 addTos()
$email->addTo("recipient@example.com", "收件人姓名"); 

// 6. 发送邮件
try {
    $response = $sendgrid->send($email);
    print_r($response->statusCode());
    print_r($response->headers());
    print_r($response->body());
    echo "邮件发送成功！\n";
} catch (Exception $e) {
    echo '捕获异常: '. $e->getMessage() ."\n";
}

?>

登录后复制

代码解释：

require 'vendor/autoload.php';: 引入 Composer 自动加载文件，确保 SendGrid 库可用。
$sendgrid = new \SendGrid(getenv('SENDGRID_KEY'));: 使用您的 SendGrid API 密钥初始化 SendGrid 客户端。建议将 API 密钥存储在环境变量中以提高安全性。
$details = [...]: 定义一个关联数组，其中键是模板中占位符的名称（不含 %{}%），值是需要注入的实际数据。
$message_body = file_get_contents(...): 读取本地 HTML 模板文件的全部内容作为一个字符串。
foreach ($details as $parameter => $value) { ... }: 遍历 $details 数组。对于数组中的每一个键值对：
- '%{' . $parameter . '}%': 构造出模板中对应的占位符字符串。
- str_replace(...): 将模板内容 $message_body 中所有匹配到的占位符替换为 $value。
$email = new Mail();: 创建一个新的 SendGrid 邮件对象。
$email->setFrom(...), $email->setSubject(...), $email->addContent("text/html", $message_body);: 设置邮件的基本信息和经过数据替换后的 HTML 内容。
$email->addTo(...): 添加邮件收件人。
$sendgrid->send($email);: 调用 SendGrid API 发送邮件。

注意事项与最佳实践

安全性（数据净化）: 在将任何用户提供的数据注入到 HTML 模板之前，务必进行严格的净化（sanitization），以防止跨站脚本攻击 (XSS)。例如，使用 htmlspecialchars() 或更专业的 HTML 净化库来处理文本内容。
```
// 示例：净化用户输入
$details['name'] = htmlspecialchars($userInputName, ENT_QUOTES, 'UTF-8');
// ... 其他数据
```
登录后复制
占位符约定: 确保您的占位符格式是唯一的，且不会与邮件内容中的正常文本冲突。例如，使用双大括号 {{placeholder}} 或百分号大括号 %{placeholder}% 都是常见的做法。
模板复杂性: 对于非常复杂的邮件模板，或者需要更高级逻辑（如条件渲染、循环列表）的场景，纯粹的 str_replace 可能会变得笨拙。在这种情况下，可以考虑使用专门的 PHP 模板引擎（如 Twig, Blade）来生成 HTML 内容，然后再将生成的 HTML 字符串传递给 SendGrid。或者，如果您的 SendGrid 账户支持，直接使用 SendGrid 的动态模板功能，它提供了更强大的变量替换和条件逻辑处理能力。
错误处理: 在实际生产环境中，始终要包含 try-catch 块来捕获 SendGrid 发送邮件时可能发生的异常，并进行适当的日志记录或用户反馈。
文件路径: 确保 file_get_contents() 中的文件路径是正确的，并且 PHP 进程有权限读取该文件。

总结

通过 file_get_contents() 读取本地 HTML 模板文件，并结合 str_replace() 进行占位符替换，是使用 SendGrid 发送动态邮件内容的一种简单而有效的方法。这种方法允许您将邮件内容和动态数据逻辑清晰地分离，提高了代码的可维护性和灵活性。在实现过程中，务必关注数据安全性，并根据项目需求选择最适合的模板处理方案。

以上就是使用 SendGrid 结合本地模板文件发送动态邮件内容的教程的详细内容，更多请关注php中文网其它相关文章！