sfcod/email-engine

Email engine for Symfony

1.2.0 2022-12-16 13:52 UTC

Requires

• php: ^7.4
• symfony/dotenv: ^5.4
• symfony/framework-bundle: ^5.4
• symfony/monolog-bundle: ^3.1
• symfony/swiftmailer-bundle: ^3.1

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.8
• symfony/phpunit-bridge: ^5.4

MIT

• Orlov Aleksey
• Virchenko Maksim

README

Provides possibility to send parametrized emails with attachments using queue of senders+repositories combination.

Config:

sfcod_email_engine:
    main_sender: chained_sender
    senders:
        chained_sender:
            chain:
                senders: [db_swiftmailer_sender, twig_file_swiftmailer_sender]
        twig_file_swiftmailer_sender:
            sender:
                class: SfCod\EmailEngineBundle\Sender\SwiftMailerSender
            repository:
                class: SfCod\EmailEngineBundle\Repository\TwigFileRepository
        db_swiftmailer_sender:
            sender:
                class: SfCod\EmailEngineBundle\Sender\SwiftMailerSender
            repository:
                class: SfCod\EmailEngineBundle\Repository\DbRepository
                arguments: { entity: <entity_class>, attribute: slug }
    templates:
        - SfCod\EmailEngineBundle\Example\TestTemplate

Where "templates" section needed for "SfCod\EmailEngineBundle\Mailer\TemplateManager" service and for params autowiring/autoconfiguring as services. Using which you can get all possible email template parameters, description, etc.

And <entity_class> implements SfCod\EmailEngineBundle\Entity\EmailEntityInterface

Usage:

use SfCod\EmailEngineBundle\Mailer\Mailer;
use SfCod\EmailEngineBundle\Example\TestOptions;
use SfCod\EmailEngineBundle\Example\TestTemplate;

public function indexAction(Mailer $mailer) {
    $options = new TestOptions('some message', 'attachment_path');
    $template = new TestTemplate($options);
    $mailer->send($template, '[e-mail]');
}

If you want to use SfCod\EmailEngineBundle\Sender\SwiftMailerSender with SfCod\EmailEngineBundle\Repository\TwigFileRepository then you have to implement SfCod\EmailEngineBundle\Template\TwigTemplateAwareInterface.

And TestTemplate email will be sent using SwiftMailerSender and template data will be collected from DbRepository. If it fails, will be used SwiftMailerSender+TwigFileRepository, because both of them listed in "chained_sender" (see config section).