包简介

CnertaMailinBundle is a Symfony2 Bundle who provide an easy way to send email build with Twig template

README 文档

README

CnertaMailingBundle

CnertaMailinBundle is a Symfony2 Bundle who provide an easy way to send email build with Twig template.

Create your email message with Twig and use the CnertaMailinBundle's service for sending it.

Easy, fast and builded on the shoulders of giants like SwiftMail.

Because quality matters :

Installation

Composer

Add to composer json:

    "require": {
        //..
        "cnerta/mailing-bundle": "dev-master"
    }

Run:

$ composer install cnerta/mailing-bundle

Register the bundle in your AppKernel class.

<?php
// app/AppKernel.php

    public function registerBundles()
    {
        $bundles = array(
            // ...
            new Cnerta\MailingBundle\CnertaMailingBundle(),
        );

        // ...
    }

    // ...

Configure the bundle

In config.yml

cnerta_mailing:
    default_bundle: "FooBundle" # The name of the bundle where the email template are stored
    active_log: false # Defined if you want to log each sending email
    from_email:
        address: exemple@exemple.com
        sender_name: "My name is"

How To Use

Create mail templates

Create a Mails folder in your src/AppBundle/Resources
Create a BlocksMail.html.twig in this new folder
Create a default.html.twig
Create a default.txt.twig

The BlocksMail.html.twig must contain all the objects and bodys part of your mail. Exemple :

{% block bar_object %}A mail object{% endblock %}
{% block bar_body %}
A Body with full of pretty things !
{% endblock %}

The default.html.twig is the base template of your mail Exemple :

<!DOCTYPE html>
<html>
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    </head>
    <body>
        <strong>Hello dear user</strong>
        <div>
            {{ body|raw }} {# This is mandatory, it's the body message of your mail #}
        </div>
    </body>
</html>

The default.txt.twig is the base template of your mail Exemple :

Hello dear user</strong

{{ body|raw }} {# This is mandatory, it's the body message of your mail in text version (without HTML elements) #}

Send mail !

Service name : cnerta.mailing

In a Controller :

use Cnerta\MailingBundle\Mailing\MailingServiceInterface;
use Cnerta\MailingBundle\Mailing\MailParameters;
use Cnerta\MailingBundle\Mailing\MailParametersInterface;

[...]
public function fooAction() {
    $mailParameters = MailParameters();

    $mailParameters
            ->setTemplateBundle('MyBundle')
            ->addBodyParameters("user", "User name");

    $this->get('cnerta.mailing')
        ->sendEmail(
            array("user@exemple.com"), // List of mail address or Symfony\Component\Security\Core\User\UserInterface
            "template_email", // Name of the block define in `BlocksMail.html.twig`
            $mailParameters);
}

Log all sending email in a specific channel

Because sometime you need to know what thé system send as email, this bundle provide an easy way to log all message.

This bundle use the mailingbundle channel to write log.

So, if you want to log this specific messages in a separate log file, use the config below.

monolog:
    handlers:
        myMailingChannel:
            # log all messages (since debug is the lowest level)
            level:    debug
            type:     stream
            path:     "%kernel.logs_dir%/mailing.log"
            channels: [mailingbundle]

cnerta/mailing-bundle 适用场景与选型建议

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

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

围绕 cnerta/mailing-bundle 我们能提供哪些服务？

定制开发 / 二次开发

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

BUG 修复 & 性能优化

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

项目外包 & 长期维护

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

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

cnerta/mailing-bundle

包简介