ethercreative/yii2-sendgrid-unsubscribe

A Yii2 module to easily provide public unsubscribe urls with suppression group support.

yii2-sendgrid-unsubscribe

A Yii2 module to easily provide public unsubscribe urls with suppression group support., _(*1)

Installation

The preferred way to install this extension is through composer., _(*2)

Either run, _(*3)

php composer.phar require ethercretaive/yii2-sendgrid-unsubscribe "~1.0.0"

or add, _(*4)

"ethercreative/yii2-sendgrid-unsubscribe": "~1.0.0"

to the require section of your composer.json file., _(*5)

Usage

This plugin assumes you are using shershennm/yii2-sendgrid, _(*6)

Once the extension is installed, simply modify your application configuration as follows:, _(*7)

return [
    'modules' => [
        'unsubscribe' => [
            'class' => 'ethercreative\unsubscribe\Module',

            // the following are optional

            // default group to unsubscribe from
            'default' => 70,

            // flash message options
            'flashMessage' => 'Your email address has successfully been unsubscribed',
            'flashGroup' => 'unsubscribe-success',

            // where to redirect to, after success
            // defaults to `Url::home()`
            'redirect' => ['/site/login'],

            // if you want to hide the IDs of your suppression groups, use `groups` to convert
            // the following will allow you to use
            //     `?email=email@address.com&group=messages`
            //     `?email=email@address.com&group=Y30JOMJjA7V7bcAC`
            'groups' => [
                'messages' => 70,
                'Y30JOMJjA7V7bcAC' => 80,
            ],
        ],
        // ...
    ],
    // ...
];

You can then generate links to /unsubscribe/?email={email}&group={id/key}, _(*8)

Url::to(['/unsubscribe', 'email' => $email, 'group' => $group], true);