petrabarus/yii2-archivable-mailer

Yii2 extension for archiving mail HTML content

dev-master 2015-02-26 09:16 UTC

Requires

• php: >=5.5.0
• aws/aws-sdk-php: >=2.4
• yiisoft/yii2: *
• yiisoft/yii2-swiftmailer: *

MIT

• Petra Barus

README

Yii2 extension for archiving mail HTML content

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist petrabarus/yii2-archivable-mailer "*"

or add

"petrabarus/yii2-archivable-mailer": "*"

to the require section of your composer.json file.

Usage

At the moment there is only one provider: AWS S3. Put the behavior in the mailer configuration.

    'mailer' => [
        /* @var $mailer yii\swiftmailer\Mailer */
        'viewPath' => '@app/mail',
        'useFileTransport' => true,
        'as archivable' => [
            'class' => '\PetraBarus\Yii2\ArchivableMailer\ArchivableBehavior',
            'provider' => [
                'class' => '\PetraBarus\Yii2\ArchivableMailer\Providers\S3Provider',
                'bucket' => 'bucket',
                'directoryPath' => 'email',
                'config' => [
                    'key' => 'AKIAI123456789012345',
                    'secret' => '1234567890123456789012345678901234567890',
                    'region' => 'ap-southeast-1',
                ]
            ]
        ]
    ],

To put the URL of the archive in the HTML, just put {{archiveurl}} in the HTML.

e.g.

   <a href="{{archiveurl}}">View in Browser</a>

The text can be changed using archiveUrlTag attribute of the behavior.

Road Map

• Add more providers.