elgentos/module-notifier-mail-adapter

Magento mail adapter for MSP Notifier

dev-master 2019-12-12 09:09 UTC

Requires

• msp/module-notifier: ^0.1.6

OSL-3.0

README

Adapter for sending magento mails with https://github.com/magespecialist/notifier/

Description

With this module you can send magento template mails with only defining a template id and a receiver email.

With additional config you can change area, store_id or even the from and from_name which are also defined in the channel config.Also template vars can be added.

This adapter uses MSP Notifier to send the email. In the channel you can use Immediate send or with the MSP queue. Recommended is to use te queue if a lot of emails are send by a foreach loop.

The queue can be started with: bin/magento msp:notifier:queue:send so this can be added in a crontab.

For more features, read the complete documentation: https://github.com/magespecialist/notifier/wiki

Code

Minimal config is:

$config = [
    'to' => '[e-mail]',
];

Additional config can be:

$config = [
    'to' => '[e-mail]',
    'area' => 'frontend', // default
    'store_id' => 0, //default
    'template_vars' => [],
    'from' => '[e-mail]', // is definend in channel config, so can be overridden
    'from_name' => 'Elgentos', // is definend in channel config, so can be overridden
];

...
public function __construct(
    Elgentos\NotifierMagentoMailAdapter\Api\SendMessageInterface $sendMessage
) {
    $this->sendMessage = $sendMessage;
}
...
public function execute()
{
    ... // Your code
    
    $config = [
        'to' => '[e-mail]',
    ];
        
    $this->sendMessage->execute('my_channel_code', 'magento_mail_template_id', $config);

    ... // Your code
}