https://github.com/webiny/notificationmanager

[NOT MAINTAINED] Webiny app that manages notifications. For now supports email notifications and slack messages.
https://github.com/webiny/notificationmanager

email notifications slack transactional-emails webiny

Last synced: about 5 hours ago
JSON representation

[NOT MAINTAINED] Webiny app that manages notifications. For now supports email notifications and slack messages.

• Host: GitHub
• URL: https://github.com/webiny/notificationmanager
• Owner: webiny
• License: mit
• Created: 2016-05-15T10:29:26.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-11-21T19:43:34.000Z (almost 7 years ago)
• Last Synced: 2024-04-15T15:33:46.056Z (7 months ago)
• Topics: email, notifications, slack, transactional-emails, webiny
• Language: JavaScript
• Homepage:
• Size: 296 KB
• Stars: 2
• Watchers: 10
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Notification Manager

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

```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('[email protected]', '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.

```yaml

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.

```yaml

NotificationManager:

  Reroute: [email protected]

```

All notifications will now be sent to `[email protected]`.

## 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.