Laravel Mail Auto Embed 项目教程

Laravel Mail Auto Embed 项目教程

laravel-mail-auto-embed 项目地址: https://gitcode.com/gh_mirrors/la/laravel-mail-auto-embed

1. 项目目录结构及介绍

laravel-mail-auto-embed/
├── config/
│   └── mail-auto-embed.php
├── src/
│   ├── EmbeddableEntity.php
│   ├── MailAutoEmbed.php
│   ├── ServiceProvider.php
│   └── ...
├── tests/
│   └── ...
├── .gitignore
├── composer.json
├── LICENSE
├── phpunit.xml
└── README.md

目录结构介绍

• config/: 包含项目的配置文件 mail-auto-embed.php，用于配置自动嵌入邮件图片的选项。
• src/: 包含项目的主要源代码文件，包括 EmbeddableEntity.php、MailAutoEmbed.php 和 ServiceProvider.php 等。
• tests/: 包含项目的测试文件，用于测试项目的功能。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。
• composer.json: Composer 配置文件，定义项目的依赖关系。
• LICENSE: 项目的开源许可证文件。
• phpunit.xml: PHPUnit 配置文件，用于配置测试环境。
• README.md: 项目的说明文档，介绍项目的基本信息和使用方法。

2. 项目启动文件介绍

项目的启动文件主要涉及 ServiceProvider.php 和 MailAutoEmbed.php。

ServiceProvider.php

ServiceProvider.php 是 Laravel 服务提供者文件，负责注册和启动项目的服务。它通常包含以下内容：

namespace Eduardokum\LaravelMailAutoEmbed;

use Illuminate\Support\ServiceProvider;

class ServiceProvider extends ServiceProvider
{
    public function boot()
    {
        // 发布配置文件
        $this->publishes([
            __DIR__.'/../config/mail-auto-embed.php' => config_path('mail-auto-embed.php'),
        ]);
    }

    public function register()
    {
        // 注册服务
        $this->app->singleton(MailAutoEmbed::class, function ($app) {
            return new MailAutoEmbed();
        });
    }
}

MailAutoEmbed.php

MailAutoEmbed.php 是项目的主要功能实现文件，负责自动嵌入邮件中的图片。它通常包含以下内容：

namespace Eduardokum\LaravelMailAutoEmbed;

class MailAutoEmbed
{
    public function embedImages($message)
    {
        // 实现图片嵌入逻辑
    }
}

3. 项目的配置文件介绍

项目的配置文件位于 config/mail-auto-embed.php，用于配置自动嵌入邮件图片的选项。

mail-auto-embed.php

return [
    /*
    |--------------------------------------------------------------------------
    | Mail auto embed
    |--------------------------------------------------------------------------
    |
    | If true, images will be automatically embedded.
    | If false, only images with the 'data-auto-embed' attribute will be embedded.
    |
    */
    'enabled' => env('MAIL_AUTO_EMBED', true),

    /*
    |--------------------------------------------------------------------------
    | Mail embed method
    |--------------------------------------------------------------------------
    |
    | Supported: "attachment", "base64"
    |
    */
    'method' => 'attachment',
];

配置项说明

• enabled: 是否启用自动嵌入图片功能。默认为 true，即自动嵌入图片；如果设置为 false，则只有带有 data-auto-embed 属性的图片才会被嵌入。
• method: 嵌入图片的方法，支持 attachment 和 base64。默认为 attachment，即使用内联附件的方式嵌入图片；如果设置为 base64，则使用 Base64 编码嵌入图片。

通过以上配置，可以灵活控制邮件中图片的嵌入方式和行为。

laravel-mail-auto-embed 项目地址: https://gitcode.com/gh_mirrors/la/laravel-mail-auto-embed