如何在 Laravel Nova 中通过邮件发送附件

引言

在 Laravel Nova 后台管理系统中，我们经常需要通过自定义操作（Action）来触发一些业务逻辑，例如发送包含特定内容的邮件。当这些邮件需要携带附件时，开发者可能会遇到一些困惑：如何在 Nova 资源中配置的文件字段，与 Mailable 的附件功能关联起来？本文将深入探讨这一问题，并提供一个清晰、专业的解决方案。

问题剖析：Nova 文件字段与 Mailable 附件的断裂

在 Laravel Nova 资源中，我们可以使用 File::make('File')-youjiankuohaophpcndisk('public') 这样的字段来允许用户上传文件。Nova 会负责文件的存储，并将文件路径（通常是文件名）保存到数据库中。然而，当通过一个 Action 触发邮件发送时，即使邮件内容是基于某个 Nova 资源记录生成的，这个 File 字段并不会自动将关联的文件作为附件发送出去。

原始的 Mailable build 方法通常只关注邮件内容：

public function build()
{
    // 假设从数据库获取邮件内容
    $this->content = DB::select('select * from newsletter_mails order by id desc limit 1')[0]->content;

    return $this->markdown('emails.newsletter')->with('content', $this->content);
}

这段代码仅仅是设置了邮件的视图和内容变量，并未涉及附件的逻辑。要实现附件功能，我们需要显式地告诉 Mailable 哪些文件需要作为附件发送。

核心解决方案：利用 Mailable 的 attach() 方法

Laravel 的 Mailable 类提供了一个 attach() 方法，专门用于在邮件中添加附件。其基本用法如下：

$this->attach(string $file, array $options = [])

• $file: 附件的完整路径（绝对路径）。
• $options: 可选数组，用于指定附件的文件名（as 键）和 MIME 类型（mime 键）。

要将 Nova 资源中上传的文件作为附件，我们需要完成以下步骤：

1. 获取文件路径： 从数据库中检索与邮件内容关联的 Nova 资源记录，获取其文件字段存储的相对路径。
2. 构建完整路径： 结合 Laravel 配置的存储盘（disk），将相对路径转换为文件的绝对路径。
3. 调用 attach()： 在 Mailable 的 build() 方法中，使用获取到的绝对路径和可选参数调用 attach() 方法。

代码示例

假设我们的 newsletter_mails 表中有一个 file 字段，存储了上传文件的相对路径（例如 files/attachments/my_document.pdf）。

首先，确保你的 Mailable 类能够访问到这个 newsletter_mail 记录，以便获取 content 和 file 字段。这里我们直接在 build 方法中查询最新的邮件记录：

稿定在线PS

PS软件网页版

99

查看详情

// app/Mail/NewsletterMail.php

namespace App\Mail;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Mail\Mailable;
use Illuminate\Queue\SerializesModels;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Storage;

class NewsletterMail extends Mailable
{
    use Queueable, SerializesModels;

    public $content;
    protected $attachmentPath;
    protected $attachmentOriginalName;

    /**
     * Create a new message instance.
     *
     * @return void
     */
    public function __construct()
    {
        // 构造函数中可以预加载数据，或者在build方法中加载
    }

    /**
     * Build the message.
     *
     * @return $this
     */
    public function build()
    {
        // 获取最新的 newsletter_mail 记录
        $newsletterMailRecord = DB::table('newsletter_mails')
                                  ->orderByDesc('id')
                                  ->limit(1)
                                  ->first();

        if ($newsletterMailRecord) {
            $this->content = $newsletterMailRecord->content;
            $relativePath = $newsletterMailRecord->file; // 获取文件字段存储的相对路径

            if ($relativePath) {
                // 构建文件的绝对路径。'public' 是你在 config/filesystems.php 中定义的磁盘名称
                // Storage::disk('public')->path() 会返回 'storage/app/public/files/attachments/my_document.pdf' 这样的绝对路径
                $this->attachmentPath = Storage::disk('public')->path($relativePath);

                // 尝试从相对路径中提取原始文件名，作为附件在邮件中的显示名称
                $this->attachmentOriginalName = basename($relativePath);
            }
        } else {
            // 处理没有找到记录的情况，例如设置默认内容或抛出异常
            $this->content = 'No newsletter content available.';
        }

        // 构建邮件内容
        $mail = $this->markdown('emails.newsletter')
                     ->with('content', $this->content);

        // 如果存在附件路径，则将其添加到邮件中
        if ($this->attachmentPath && file_exists($this->attachmentPath)) {
            $mail->attach($this->attachmentPath, [
                'as'   => $this->attachmentOriginalName ?: 'attachment', // 附件在邮件中的显示名称
                'mime' => mime_content_type($this->attachmentPath) // 自动检测 MIME 类型
            ]);
        }

        return $mail;
    }
}

关键点说明：

• DB::table('newsletter_mails')->orderByDesc('id')->limit(1)->first();：这行代码用于获取最新的 newsletter_mail 记录。在实际应用中，你可能需要根据 Nova Action 传入的 $models 集合来获取特定的记录，或者通过其他方式传递 newsletter_mail 的 ID。
• $relativePath = $newsletterMailRecord->file;：从数据库记录中获取文件字段的值。
• Storage::disk('public')->path($relativePath);：这是获取文件绝对路径的关键。Storage facade 结合你配置的磁盘（public）能够正确地解析存储路径。请确保你的 public 磁盘配置正确，并且 storage:link 命令已运行，以便 public 目录下的文件可以通过 Web 访问。
• basename($relativePath)：用于从文件路径中提取文件名，作为附件在邮件中的显示名称。
• mime_content_type($this->attachmentPath)：这是一个 PHP 函数，用于自动检测文件的 MIME 类型。在大多数情况下，它比手动指定更可靠。
• file_exists($this->attachmentPath)：在尝试附加文件之前，进行文件存在性检查是一个良好的实践，可以避免因文件不存在而导致的错误。

注意事项

1. 文件存储与访问权限：

   • 确保 Nova 配置的 File 字段使用的存储盘（disk）与你在 Storage::disk() 中使用的盘一致。
   • public 磁盘通常会将文件存储在 storage/app/public 目录下。为了让 Web 服务器能够访问这些文件，你需要运行 php artisan storage:link 命令，在 public 目录下创建一个符号链接。
   • 确保 PHP 进程对附件文件及其所在目录具有读取权限。

2. 文件路径的准确性：

   • 数据库中存储的路径必须是相对于存储盘根目录的路径。
   • Storage::disk('your_disk')->path($relativePath) 是获取文件绝对路径的最可靠方法，避免硬编码路径。

3. MIME 类型与文件名：

   • 'as' => fileName：这是附件在收件人邮箱中显示的名称。如果不指定，Mailable 会尝试从路径中推断。
   • 'mime' => 'application/pdf'：指定附件的 MIME 类型。虽然 mime_content_type() 能够自动检测，但对于某些特殊文件类型或确保兼容性，手动指定可能更稳妥。

4. 文件不存在的处理：

   • 在 attach() 之前添加 if (file_exists($this->attachmentPath)) 检查，可以优雅地处理文件可能已被删除或路径不正确的情况，避免邮件发送失败。

5. 动态附件：

   • 如果附件是动态生成的（例如 PDF 报告），你可以使用 attachData() 方法，直接传入文件内容而不是文件路径。

总结

在 Laravel Nova 中通过 Action 触发带附件的邮件发送，关键在于理解 Nova 的 File 字段仅负责文件存储和路径记录，而 Mailable 的 attach() 方法才是实现附件功能的入口。通过从数据库中获取文件路径，并结合 Laravel 的 Storage facade 构建完整的文件路径，我们可以在 Mailable 中轻松地将文件作为附件发送出去。遵循本文提供的代码示例和注意事项，你将能够构建出功能完善、健壮的带附件邮件发送系统。

以上就是如何在 Laravel Nova 中通过邮件发送附件的详细内容，更多请关注php中文网其它相关文章！