geekdevs/swift-mailer-extensions

2.0.0 2018-06-08 06:24 UTC

README

Overview

This project is intended to extend capabilities of SwiftMailer.

Note, that master now only supports SwiftMailer v.6 and not compatible with earlier version. If you still need earlier versions, check v.1 of this package.

Transport

File transport

For dev environment it is usually desirable to prevent sending out actual emails and store them into files instead for testing.

FileTransport does exactly that - it stores emails into eml format which can then be opened with most email applications (e.g. Outlook or Thunderbird). It accepts event dispatcher as first argument and path to the folder where email files will be stored (you should have write access in it).

Usage example:

// Initialize file transport
$eventDispatcher = new \Swift_Events_SimpleEventDispatcher()
$transport = new FileTransport($eventDispatcher, 'path/to/folder');

// Create the Mailer using your created Transport
$mailer = Swift_Mailer::newInstance($transport);

// Create a message
$message = Swift_Message::newInstance('Wonderful Subject')
  ->setFrom(array('john@doe.com' => 'John Doe'))
  ->setTo(array('receiver@domain.org', 'other@domain.org' => 'A name'))
  ->setBody('Here is the message itself')
  ;

// Send the message
$result = $mailer->send($message);

Connecting to Symfony:

Define FileTransport as service in services.yml:

swiftmailer.mailer.transport.file:
    class: Geekdevs\SwiftMailer\Transport\FileTransport
    arguments:
      - "@swiftmailer.mailer.default.transport.eventdispatcher"
      - "%kernel.project_dir%/var/emails"      

Configure SwiftMailer to understand new transport in config.yml file:

swiftmailer:
    transport: file

Copy plugin

Copy plugin is useful to BCC all outgoing emails to specific address (e.g. if you want to monitor everything what you send out).

Connecting to Symfony:

Define CopyPlugin as service in services.yml:

swiftmailer.mailer.plugin.copy:
    class: Geekdevs\SwiftMailer\Plugin\CopyPlugin
    arguments:
      - "notifications@recipient.com"
    tags:
      - { name: "swiftmailer.default.plugin" }

Note the tag swiftmailer.primary.plugin where "default" should be the name of your mailer.