
在 Laravel Nova 环境下,通过 Mailable 类为电子邮件添加文件附件是一项常见需求。本教程将详细指导您如何实现这一功能,涵盖从 Nova Resource 定义到 Mailable build 方法中附件功能的实现,包括如何获取文件路径、使用 attach 方法以及相关注意事项,确保您能成功发送带有附件的动态邮件。
理解邮件附件的发送机制
在 laravel 中,电子邮件附件的发送主要通过 mailable 类的 attach 方法来完成。虽然 laravel nova 的 file 字段能够方便地处理文件的上传和存储,但它本身并不直接将文件附加到邮件中。因此,核心逻辑在于将 nova 管理的文件路径正确地传递给 mailable 类,并在其 build 方法中调用 attach。
Nova Resource 中的文件定义
首先,在您的 Nova Resource 中,需要定义一个 File 字段来允许用户上传文件。这个字段会将文件的相对路径存储在您的数据库中。
// app/Nova/NewsletterMail.php
<?php
namespace App/Nova;
use Laravel/Nova/Fields/ID;
use Illuminate/Http/Request;
use Laravel/Nova/Fields/Date;
use Laravel/Nova/Fields/File;
use Laravel/Nova/Fields/Markdown;
use Laravel/Nova/Http/Requests/NovaRequest;
class NewsletterMail extends Resource
{
public static $model = /App/Models/NewsletterMail::class;
public static $title = 'id';
public static $search = [
'id',
];
public function fields(Request $request)
{
return [
ID::make(__('ID'), 'id')->sortable(),
Date::make('创建日期', 'created_at')->sortable(),
Markdown::make('邮件内容', 'content')->alwaysShow(),
// 假设文件路径存储在数据库表的 'file_path' 字段
// 文件将存储在 'public' 存储盘
File::make('附件文件', 'file_path')->disk('public'),
];
}
public function actions(Request $request)
{
return [
Actions/SendNewsletterMail::make()->standalone(),
];
}
}
在上述代码中,我们假设文件路径存储在 newsletter_mails 表的 file_path 字段中,并使用 public 存储盘。
Mailable 中实现文件附件
接下来,关键在于 Mailable 类。您需要在 build 方法中获取邮件内容和文件路径,然后使用 Storage facade 来解析文件的完整物理路径,并将其传递给 attach 方法。
为了提高效率,我们可以在控制器中查询邮件记录并将其传递给 Mailable 的构造函数,避免在每个邮件发送循环中重复查询数据库。
// app/Mail/NewsletterMail.php
<?php
namespace App/Mail;
use Illuminate/Bus/Queueable;
use Illuminate/Mail/Mailable;
use Illuminate/Queue/SerializesModels;
use Illuminate/Support/Facades/Storage;
use Illuminate/Contracts/Queue/ShouldQueue;
class NewsletterMail extends Mailable implements ShouldQueue // 如果需要队列发送,实现 ShouldQueue
{
use Queueable, SerializesModels;
public $content;
protected $newsletterMailRecord;
/**
* 创建一个新的消息实例。
*
* @param object $newsletterMailRecord 包含邮件内容和文件路径的记录
* @return void
*/
public function __construct(object $newsletterMailRecord)
{
$this->newsletterMailRecord = $newsletterMailRecord;
}
/**
* 构建邮件消息。
*
* @return $this
*/
public function build()
{
$this->content = $this->newsletterMailRecord->content;
$mailable = $this->markdown('emails.newsletter')->with('content', $this->content);
// 检查是否存在文件路径字段,并尝试附加文件
// 假设数据库中存储文件路径的字段名为 'file_path'
if (isset($this->newsletterMailRecord->file_path) && $this->newsletterMailRecord->file_path) {
$disk = 'public'; // 对应 Nova Resource 中定义的 disk
$relativePath = $this->newsletterMailRecord->file_path;
// 获取文件的完整物理路径
$filePath = Storage::disk($disk)->path($relativePath);
// 确保文件存在且可读
if (file_exists($filePath) && is_readable($filePath)) {
// 提取文件名作为附件名称
$fileName = basename($relativePath);
// 尝试获取 MIME 类型,如果失败则使用通用类型
$mimeType = Storage::disk($disk)->mimeType($relativePath) ?? 'application/octet-stream';
$mailable->attach($filePath, [
'as' => $fileName, // 附件在邮件中显示的文件名
'mime' => $mimeType, // 附件的 MIME 类型
]);
} else {
// 文件不存在或不可读的日志记录
/Log::warning("邮件附件文件不存在或不可读,路径: " . $filePath);
}
}
return $mailable;
}
}
控制器中发送邮件
在 Nova Action 触发的控制器中,您需要查询最新的邮件记录(包含文件路径),然后遍历收件人列表,为每个收件人发送带有附件的邮件。
// app/Http/Controllers/NewsletterMailController.php
<?php
namespace App/Http/Controllers;
use App/Mail/NewsletterMail;
use Illuminate/Support/Facades/DB;
use Illuminate/Support/Facades/Mail;
use Illuminate/Http/Request;
class NewsletterMailController extends Controller
{
public function send()
{
// 提前获取最新的邮件记录,避免在循环中重复查询
$newsletterMailRecord = DB::table('newsletter_mails')
->orderByDesc('id')
->first();
if (!$newsletterMailRecord) {
/Log::error("尝试发送通讯邮件时未找到邮件内容。");
return response()->json(['message' => '未找到邮件内容,无法发送。'], 400);
}
$emailRecipients = DB::table('newsletter_recipients')->orderByDesc('id')->get();
foreach ($emailRecipients as $emailRecipient) {
// 将邮件记录传递给 Mailable 的构造函数
Mail::to($emailRecipient->email)->send(new NewsletterMail($newsletterMailRecord));
}
return response()->json(['message' => '通讯邮件已发送。']);
}
}
Nova Action 的配置
最后,确保您的 Nova Action 正确调用了上述控制器方法。
// app/Nova/Actions/SendNewsletterMail.php
<?php
namespace App/Nova/Actions;
use App/Http/Controllers/NewsletterMailController;
use Illuminate/Bus/Queueable;
use Laravel/Nova/Actions/Action;
use Illuminate/Support/Collection;
use Laravel/Nova/Fields/ActionFields;
use Illuminate/Queue/InteractsWithQueue;
use Illuminate/Contracts/Queue/ShouldQueue;
class SendNewsletterMail extends Action
{
use InteractsWithQueue, Queueable;
public $standalone = true; // 允许独立运行
/**
* 执行操作。
*
* @param /Laravel/Nova/Fields/ActionFields $fields
* @param /Illuminate/Support/Collection $models
* @return array
*/
public function handle(ActionFields $fields, Collection $models)
{
try {
app(NewsletterMailController::class)->send();
return Action::message('通讯邮件已成功发送!');
} catch (/Exception $e) {
/Log::error("发送通讯邮件失败: " . $e->getMessage());
return Action::danger('发送通讯邮件失败,请检查日志。');
}
}
}
注意事项
- 文件路径准确性: 确保数据库中存储的文件路径是相对于您在 config/filesystems.php 中配置的存储盘根目录的正确相对路径。
- 存储盘配置: 检查 config/filesystems.php 中 public 盘的配置,特别是 root 路径,要与您的实际文件存储位置匹配。如果文件存储在其他盘(例如 s3),则 Storage::disk(‘public’) 需要相应调整。
- 文件权限: 确保运行 PHP 进程的用户对存储附件的目录具有读取权限。否则,file_exists() 或 is_readable() 将返回 false。
- 动态文件名和 MIME 类型: 建议从存储的文件信息中动态获取文件名和 MIME 类型,而不是硬编码。Storage::mimeType() 方法可以帮助您自动检测 MIME 类型。
- 错误处理: 务必在 Mailable 和控制器中加入文件不存在或不可读的错误处理逻辑,例如记录日志,以避免邮件发送失败或发送不完整的邮件。
- 附件大小: 邮件服务提供商通常对附件大小有限制(例如,Gmail 限制为 25MB)。如果附件过大,邮件可能无法发送成功。对于大文件,考虑提供下载链接而不是直接附件。
- 队列: 如果您发送的邮件数量较多或附件较大,强烈建议将邮件发送放入队列中处理(如 ShouldQueue 接口),以避免阻塞请求。
总结
通过上述步骤,您可以在 Laravel Nova 环境下,利用其文件管理能力,结合 Laravel Mailable 的 attach 方法,成功地为您的电子邮件添加文件附件。关键在于正确地从数据库中获取文件路径,并在 Mailable 的 build 方法中调用 Storage::disk()->path() 获取完整路径,然后使用 attach() 方法将其作为附件发送。遵循这些指导原则和注意事项,将确保您的邮件附件功能稳定可靠。
以上就是在 Laravel Nova 中通过邮件发送文件附件的教程的详细内容,更多请关注php中文网其它相关文章!


