waytonoway/mailer-ses-v4

Extension for sending emails via amazon ses V4

v1.3.0 2021-04-13 11:09 UTC

Requires

• php: >=7.2.0
• daniel-zahariev/php-aws-ses: ^0.9.5
• yiisoft/yii2: ~2.0.14

MIT

• Katya Bogdanova

• extension
• aws
• ses
• yii2
• v4

README

Extension for sending emails via amazon ses v4. (based on daniel-zahariev/php-aws-ses)

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist waytonoway/mailer-ses-v4

or add

"waytonoway/mailer-ses-v4": "1.0.0"

to the require section of your composer.json file.

Usage

To use this extension, you should configure it in the application configuration like the following:

'components' => [
    ...
    'mail' => [
        'class' => 'waytonoway\ses\Mailer',
        'access_key' => 'Your access key',
        'secret_key' => 'Your secret key',
        'host' => 'email.us-east-1.amazonaws.com' // not required
    ],
    ...
],

To send an email, you may use the following code:

Yii::$app->mail->compose('contact/html', ['contactForm' => $form])
    ->setFrom('[e-mail]')
    ->setTo($form->email)
    ->setSubject($form->subject)
    ->send();

To send an email with headers, you may use the following code:

Yii::$app->mail->compose('contact/html', ['contactForm' => $form])
    ->setFrom('[e-mail]')
    ->setTo($form->email)
    ->setSubject($form->subject)
    ->setHeader('Precedence', 'bulk')
    ->setHeader('List-id', '<1>')
    ->setHeader('List-Unsubscribe', Url::to(['user/unsubscribe'], true))
    ->send();