cgonser/swiftmailer-database-s3-spool-bundle

A symfony bundle that enables Swift Mailer to spool messages from a database and store message files on Amazon S3

Swift Mailer Database S3 Spool

A Symfony bundle that enables Swift Mailer to spool messages from a database and store message files on an Amazon S3 bucket., _(*1)

It requires the AWS PHP SDK and relies on Doctrine for data persistency., _(*2)

Installation

This bundle can be installed via Composer by requiring cgonser/swiftmailer-database-s3-spool-bundle package in your project's composer.json:, _(*3)

{
    "require": {
        "cgonser/swiftmailer-database-s3-spool-bundle": "dev-master"
    }
}

Then, enable the bundle by adding it to the list of registered bundles in the app/AppKernel.php file of your project:, _(*4)

<?php
// app/AppKernel.php

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = [
            // ...

            new Cgonser\SwiftMailerDatabaseS3SpoolBundle\CgonserSwiftMailerDatabaseS3SpoolBundle(),
        ];
    }
}

Configuration

Please remember to first configure the AWS SDK accordingly. Once it's properly configured, you can place this bundle configuration in app/config/config.yml file., _(*5)

cgonser_swift_mailer_database_s3_spool:
    s3:
        bucket: "<TARGET BUCKET>"
        region: "<S3 REGION>"
        folder: "<TARGET FOLDER>" (optional)

You can optionally include specific credentials configurations for the s3 client, as follows:, _(*6)

cgonser_swift_mailer_database_s3_spool:
    s3:
        credentials:
            key: "<AWS_ACCESS_KEY_ID>"
            secret: "<AWS_SECRET_ACCESS_KEY>"

Still in app/config/config.yml, enable the services and change the swift mailer spool configuration:, _(*7)

imports:
    // ...
    - { resource: "@CgonserSwiftMailerDatabaseS3SpoolBundle/Resources/config/services.yml" }

swiftmailer:
    // ...
    spool: { type: db_s3 }

You can also provide specific AWS credentials for this bucket, if you want to:, _(*8)

cgonser_swift_mailer_database_s3_spool:
    s3:
        bucket: "<TARGET BUCKET>"
        region: "<BUCKET REGION>"
        key: "<YOUR AWS KEY>"
        secret: "<YOUR AWS SECRET>"

After finishing the configuration, you will need to update your database schema to create the entity necessary to store the spooler queue., _(*9)

php bin/console doctrine:schema:update

Mail Queue Entity

By default, the mail queue will be stored in a table named cgonser_mail_queue, but you can override the default entity. To do so, you will need to create a new entity with the same structure of the default one (which you can find inside the package at Entity/MailQueue.php) and change its name and/or definition., _(*10)

After that, you will need to inform the bundle about the new entity, using the following configuration in app/config/config.yml:, _(*11)

cgonser_swift_mailer_database_s3_spool:
    entity_class: "<YOUR NEW ENTITY>" (e.g.: \AppBundle\Entity\MailQueue)

Keep in mind that this bundle relies on the default entity structure and modifying that may break it., _(*12)