包简介

Jacquesndl/MailerBundle

README 文档

README

MailerBundle add a new TemplatedEmail class for the Symfony Mailer Component.

Install

composer require jacquesndl/mailer-bundle

Setup

The bundle provides an official recipe to help you configure the bundle.

# config/packages/jacquesndl_mailer.yaml

jacquesndl_mailer:
    sender:
        name: '%env(JACQUESNDL_MAILER_SENDER_NAME)%'
        address: '%env(JACQUESNDL_MAILER_SENDER_ADDRESS)%'

# .env

JACQUESNDL_MAILER_SENDER_NAME="Example"
JACQUESNDL_MAILER_SENDER_ADDRESS="example@domain.tld"

The env variables JACQUESNDL_MAILER_SENDER_NAME and JACQUESNDL_MAILER_SENDER_ADDRESS define the default value for the sender. You can overwrite it using the to() method of the TemplatedEmail class. You can see an example below.

Usage

Basic

// src/Controller/WelcomeController.php

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\Mailer\MailerInterface;
use Symfony\Component\HttpFoundation\Response;
use Jacquesndl\MailerBundle\Message\TemplatedEmail;

class WelcomeController extends AbstractController
{
    public function index(MailerInterface $mailer): Response
    {
        // ...

        $email = (new TemplatedEmail())
            ->from('didier.deschamps@france.fr') // overwrite the default sender value
            ->to('zinedine.zidane@france.fr')
            ->replyTo('fabien.barthez@france.fr')
            ->template('emails/welcome.email.twig')
            ->attachFromPath('/path/to/documents/coupe-du-monde-1998.pdf')
            ->context([
                'firstName' => 'Zinédine',
            ])
        ;
        
        $mailer->send($email);
        
        // ...
    }
}

{# templates/emails/welcome.email.twig #}

{% block subject %}
   Welcome
{% endblock %}

{% block html %}
   <html>
   <head></head>
   <body>
   <h1>Welcome {{ firstName }}</h1>
   </body>
   </html>
{% endblock %}

{% block text %}
   Your text content
{% endblock %}

If the block text is missing or empty, mailer will generate it automatically by converting the HTML contents into text. If you have league/html-to-markdown installed in your application, it uses that to turn HTML into Markdown (so the text email has some visual appeal). Otherwise, it applies the strip_tags PHP function to the original HTML contents.

Advanced

The bundle provides a maker command to create an Email class that extends TemplatedEmail

php bin/console make:email WelcomeEmail

// src/Email/WelcomeEmail.php

namespace App\Email;

use Jacquesndl\MailerBundle\Message\TemplatedEmail;

class WelcomeEmail extends TemplatedEmail
{
   protected $template = 'emails/welcome.email.twig';
}

// src/Controller/WelcomeController.php

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\Mailer\MailerInterface;
use Symfony\Component\HttpFoundation\Response;
use App\Email\WelcomeEmail;

class WelcomeController extends AbstractController
{
    public function index(MailerInterface $mailer): Response
    {
        // ...

        $email = (new WelcomeEmail())
            ->to('zinedine.zidane@france.fr');
        
        $mailer->send($email);
        
        // ...
    }
}

jacquesndl/mailer-bundle 适用场景与选型建议

jacquesndl/mailer-bundle 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 60 次下载、GitHub Stars 达 0，最近一次更新时间为 2020 年 04 月 22 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「symfony」「bundle」「MailerBundle」「Jacquesndl」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 jacquesndl/mailer-bundle 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 jacquesndl/mailer-bundle 我们能提供哪些服务？

定制开发 / 二次开发

基于 jacquesndl/mailer-bundle 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发