vanchelo/phalcon-mailer

Mailer Service for Phalcon 2.0

english | русский

---

Phalcon Mailer

Удобная библиотека для отправки Вашей почты в Phalcon 2.0.

Код заимствован из Laravel 4 и адаптирован под Phalcon.

Установка

C помощью composer:

Добавить в файл composer.json в секцию require следующую строку:

"vanchelo/phalcon-mailer": "~2.0"

или выполнить в командной строке:

composer require vanchelo/phalcon-mailer

Должно получится примерно так:

{
  "require": {
    "vanchelo/phalcon-mailer": "~2.0"
  }
}

После этого выполните в терминале команду:

composer update

Инициализация сервиса

/**
 * Register Mailer Service
 */
$this->di['mailer'] = function() {
    $service = new MailerService();

    return $service->mailer();
};

или с передачей параметров на этапе инициализации сервиса

/**
 * Register Mailer Service
 */
$this->di['mailer'] = function() {
    $service = new MailerService([
        'driver' => 'smtp', // mail, sendmail, smtp
        'host'   => 'smtp.email.com',
        'port'   => 587,
        'from'   => [
            'address' => '[email protected]',
            'name'    => 'My Cool Company',
        ],
        'encryption' => 'tls',
        'username'   => '[email protected]',
        'password'   => 'some-strong-password',
        'sendmail'   => '/usr/sbin/sendmail -bs',
        // Путь используемый для поиска шаблонов писем
        'viewsDir'   => __DIR__ . '/../app/views/', // optional
    ]);

    return $service->mailer();
};

Отправка письма

Пример для контроллера, но работать будет не только в контроллерах

$this->mailer->send('emails/xxx', [
    'test' => 'test' // Переменные для передачи в шаблон
], function($message) {
    $message->to('[email protected]');
    $message->subject('Test Email');
});

где, emails/xxx - шаблон письма расположенный в каталоге views, (app/views/emails/xxx.[phtml|volt])

По умолчанию, если в контейнере зарегистрирован сервис view библиотека будет использовать его, соответственно можно использовать любой удобный доступный шаблонизатор (phtml, volt и т.д.)

Настройки

Настройки по умолчанию необходимо прописать в конфигурационном файле вашего приложения config/config.php

<?php
return new \Phalcon\Config([
    'mail' => [
        'driver' => 'smtp', // mail, sendmail, smtp
        'host'   => 'smtp.email.com',
        'port'   => 587,
        'from'   => [
            'address' => '[email protected]',
            'name'    => 'My Cool Company'
        ],
        'encryption' => 'tls',
        'username'   => '[email protected]',
        'password'   => 'some-strong-password',
        'sendmail'   => '/usr/sbin/sendmail -bs',
        // Путь используемый для поиска шаблонов писем
        'viewsDir'   => __DIR__ . '/../app/views/', // optional
    ],
]);

Если будет необходимость, настройки почты можно вынести в отдельный конфигурационный файл

UPD. Реализована возможность использования очередей для отложенной отправки почты через реализованный в Phalcon сервис очередей Beanstalk

Очереди (отложенная отправка почты)

Для отложенной отправки почты у вас должен быть зарегистрирован сервис queue в контейнере, например:

use Phalcon\Queue\Beanstalk;

$this->di['queue'] = function () {
    $queue = new Beanstalk();
    $queue->connect(); // ?

    return $queue;
};

Пример отложенной отправки почты

$this->mailer->queue('emails/xxx', [
    'test' => 'test' // Переменные для передачи в шаблон
], function($message) {
    $message->to('[email protected]');
    $message->subject('Test Email');
});

Вся отложенная почта помещается в очередь mailer (не знаю насколько это правильно)

Пример обработчика очереди https://github.com/vanchelo/phalcon-mailer/blob/master/example/mailer.php

phalcon-mailer's Issues

Queue

Добавить возможность отложенной отправки почты через Beanstalk

Использование layouts

Было бы неплохо добавить поддержку использования layout обёртки для писем, дабы вынести общий стиль оформления письма во внешний шаблон, сосредоточившись только на его содержимом.

Например, указать layout можно будет в конфиге или при помощи подобного синтаксиса (дабы не создавать лишних аргументов):

$this->getDI()->get("mailer")->send("layoutName:email/registration", ...);

Или же (хотя 1 вариант более компактный):

$this->getDI()->get("mailer")->send(array(
    "html" => "email/registration",
    "layout" => "layoutName"
), ...);

render template file and template html

Есть небольшое пожелание, не всегда удобно что бы передавать в метод путь к шаблону, иногда хочется передать только html

например сейчас так:
$service = new MailerService();
$server->send('/mail/template', array());

В моем например случаи шаблоны писем хранятся в базе данных, с синтаксисом volt, я его вытаскиваю и рендерю, получаю html который хочу отправить.

how to read the documentation?

yo sir no english version? 😥 @vanchelo

Phalcon 2.x

Привет!
Как насчёт сабжекта? :)

Composer

Добавишь работу через composer и packagist.org ?