webiny/notification-manager

There is no license information available for the latest version (v1.1.0) of this package.

v1.1.0 2017-10-29 13:59 UTC

Unknown License

README

Notification Manager app provides a user-friendly interface for creating transactional emails similar to Mandrill with a few additional features that make your development life a lot easier.

The system keeps track of your email variables and will not send your email if there are any missing replacement values, which will spare you from embarrassment and unprofessional looking emails.

Besides the regular email templates, you are also able to create email layout templates (for your header, footer, etc.) and save you some time maintaining dozens and even hundreds of templates when your company contact info or social media accounts change.

Sending email with attachments from PHP

/* @var NotificationManager $nm */
$nm = $this->wService('NotificationManager');
$notification = $nm->getNotification('test');

$file = new File('webiny.json', $this->wStorage('YourStorage'));
$notification->addAttachment($file, 'custom.json', 'application/json');

// the recipient needs to be instance of Recipients\Email, based on that notification manager know what type of notification to send
$recipient = new \Apps\NotificationManager\Php\Lib\Recipients\Email('[e-mail]', 'ClientName');
$notification->setRecipient($recipient);
$notification->send();

Instant Send

If you don't want your emails to be added to the queue, but you want them to be sent instantly, just set NotificationManager.InstantSend to true in your config. This is useful for development, so you don't wait for the cron job to trigger for in order to receive your email.

NotificationManager:
  InstantSend: true

Reroute sending

In situations where you would need to reroute emails, i.e. you downloaded a production database with customer data, but you don't want the system to accidentally send an email to that customer. You can tell to the notification system that all emails should be sent to a specific email, regardless to what the email queue says.

NotificationManager:
  Reroute: [e-mail]

All notifications will now be sent to [e-mail].

Email content - template

The email content field is parsed by Smarty template engine. This enables you to write an if or a foreach loop, amongst many other stuff that smarty supports. You can also write variables like {$object.attribute} in case if you want to access child parameters, or array keys.