Laravel Mail Auto Embed 开源项目安装与配置指南
laravel-mail-auto-embed项目地址:https://gitcode.com/gh_mirrors/la/laravel-mail-auto-embed
项目目录结构及介绍
Laravel Mail Auto Embed 的项目结构遵循了 Laravel 框架的标准布局,确保了良好的组织性和可维护性。下面是主要的目录和文件说明:
.
├── config # 配置文件夹,存放项目特有的配置
│ └── mail_auto_embed.php # 主配置文件,用于控制图片自动嵌入行为
├── src # 源代码目录,包含了核心类和逻辑
│ ├── ServiceProvider.php # Laravel 服务提供者,负责注册绑定和发布配置
│ └── ... # 其他源代码文件
├── tests # 测试目录,包括单元测试和功能测试
├── composer.json # Composer依赖描述文件,定义项目依赖和脚本
├── LICENSE # 项目许可协议
├── README.md # 项目的主要文档,介绍项目用途、安装步骤等
└── ...
项目启动文件介绍
在 Laravel 中,并没有直接所谓的“启动文件”来启动此扩展。然而,关键的集成发生在 composer require eduardokum/laravel-mail-auto-embed
之后。这一步通过 Composer 自动执行服务提供者的注册和配置的发布。
- 服务提供者 (ServiceProvider):
src/ServiceProvider.php
文件是集成到 Laravel 应用的关键。当您安装完此扩展后,Laravel 的自动发现机制会处理好服务提供者的注册工作。对于不支持自动发现的 Laravel 版本,您需要手动在config/app.php
的 providers 数组中添加服务提供者。
项目配置文件介绍
- 主配置文件:
config/mail_auto_embed.php
。此文件允许您自定义 Laravel Mail Auto Embed 的行为。- 自动嵌入开关: 可以通过
MAIL_AUTO_EMBED
环境变量或此配置文件中的enabled
来全局开启或关闭自动图片嵌入。 - 图片跳过标识: 添加
data-skip-embed
属性到图片标签,可以阻止特定图片被自动嵌入。 - 个别图片启用: 使用
data-auto-embed
属性即使在全球禁用自动嵌入的情况下,也可以使特定图片被嵌入。
- 自动嵌入开关: 可以通过
安装步骤简述:
- 执行命令
composer require eduardokum/laravel-mail-auto-embed
来添加依赖。 - (如果是较旧的 Laravel 版本)在
config/app.php
的服务提供者列表中手动添加Eduardokum\LaravelMailAutoEmbed\ServiceProvider::class
。 - 发布配置文件:运行
php artisan vendor:publish --provider="Eduardokum\LaravelMailAutoEmbed\ServiceProvider"
。 - 根据业务需要调整
config/mail_auto_embed.php
配置文件。 - 开始在您的邮件模板中享受自动图片嵌入的功能。
这样,您便成功设置了 Laravel Mail Auto Embed,提高了邮件的呈现质量和用户体验。
laravel-mail-auto-embed项目地址:https://gitcode.com/gh_mirrors/la/laravel-mail-auto-embed