Log in

hypeNotifications

hypeNotifications for Elgg

Elgg 3.0

PopupDigest

Features

  • Facebook-style site notifications
  • Email digest: users can specify at which interval they receive notifications for each type
  • A tool to update preferred notification methods for all site users
  • Leverages Zend_Mail (email library used in core) to send out HTML emails
  • Allows to configure email transports (Sendmail, SMTP, File Transport, SendGrid, Mailgun, SparkPost)
  • Allows to send file attachments
  • Inlines CSS styles for improved email client experience
  • Simpler testing experience: catch all email address, email/domain whitelist

Usage

Notification preferences

Go to Admin > Administer > Utilities > Notification Methods to update personal and subscription notification preferences globally.

Developer Notes

Notification event types

Notification event types can be filtered using 'notification_events','notifications' hook. Users will be given an option to unsubscribe from notifications about these events or batch them into a digest. Note that some instant notification events should not be added this list, e.g. password reset and other account related notifications should remain instant.

Notification Testing

You can disable outgoing email by switching to File Transport in plugin settings, this will instead write email as txt files to the filestore under /notifications_log/zend/

Sample SMTP config for GMail

To use GMail as your SMTP relay, you will likely need to Allow less secure apps: https://support.google.com/accounts/answer/6010255?hl=en

  • Host: smtp.gmail.com
  • Port: 587
  • Secure Connection: TLS
  • Auth: SMTP with AUTH LOGIN
  • Username:
  • Password:

Sample SMTP config for SendGrid

  • Host: smtp.sendgrid.com
  • Port: 587
  • Secure Connection: TLS
  • Auth: SMTP with AUTH LOGIN
  • Username: apikey
  • Password:

File Attachments

To add attachments to your email, add an array of ElggFile objects to notification parameters:

notify_user($to, $from, $subject, $body, array(
    'attachments' => array(
        $file1, $file2,
    )
));

Package Releases

VersionRelease Date
hypeNotifications 2.1.22.1.2
hypeNotifications 2.1.12.1.1
hypeNotifications 2.1.02.1.0
hypeNotifications 2.0.42.0.4
hypeNotifications 2.0.32.0.3
hypeNotifications 2.0.22.0.2
hypeNotifications 2.0.12.0.1
hypeNotifications 2.0.02.0.0

Changelog

2.1.1 (2018-07-01)

Bug Fixes

  • email: fix email styling (403b2f3)
  • template: do not use header_logo view in notification header (444ab7b)

2.1.0 (2018-06-29)

Bug Fixes

  • actions: fix test email action registration (29a100c)
  • api: update method signatures to match core (7635336)
  • logs: log error messages on failed send (6b52a97)
  • sql: fix SQL query that returned partial rows (28f0861)

Features

  • core: updates and fixes (4cfcd6d)
  • links: add support for providing links through notify_user() (711cc1f)

2.0.4 (2018-04-25)

Bug Fixes

  • api: update method signatures to match core (7635336)

2.0.3 (2018-03-31)

Bug Fixes

  • actions: fix test email action registration (29a100c)
  • logs: log error messages on failed send (6b52a97)

2.0.2 (2018-03-27)

Features

  • links: add support for providing links through notify_user() (711cc1f)

2.0.1 (2018-03-20)

Bug Fixes

  • sql: fix SQL query that returned partial rows (28f0861)

2.0.0 (2018-03-19)

Features

  • releases: upgrade for Elgg 3 (f83668b)

1.4.0 (2017-08-28)

Features

  • admin: improve transport settings UI (e1e9521)
  • menus: add menu item for settings (2fd38ad)

1.3.4 (2017-08-14)

Bug Fixes

1.3.3 (2017-08-14)

Bug Fixes

1.3.2 (2017-08-14)

Bug Fixes

  • comments: comment notifications now have correct access_id query (c474d38)
  • mailgun: fall back to site domain if none is set (92b145d)
  • menu: add missing icon text (6141442)

Features

  • ui: integrate with hypeUI (dadc025)

1.3.1 (2017-07-09)

Bug Fixes

  • menu: add missing icon text (6141442)

1.3.0 (2017-07-09)

Bug Fixes

  • comments: comment notifications now have correct access_id query (c474d38)

Features

  • ui: integrate with hypeUI (dadc025)

1.2.0 (2017-07-06)

Features

  • mailgun: add mailgun support (1b01e5d)

1.1.0 (2017-04-12)

Bug Fixes

  • access: entity/extender access now syncs correctly (e372beb)
  • email: let zend set content-type (a43b66a)
  • notifications: only mark notifications as read for a logged in user (ee182f9)

Features

  • settings: add an admin setting to set timer interval (7ba5fc9), closes #8

1.0.1 (2017-04-10)

Bug Fixes

  • digest: remove certain system-like events from digest service (97b0629)
  • js: only use ticker if user is logged in (a67787c)
  • notifications: correctly populate notification event data (822cd3e)

1.0.0 (2017-03-13)

Bug Fixes

  • sql: fix syntax error in sql query (3b84f00)

Features

  • releases: initial commit (4bbd9d1)

About

Dependencies

Conflicts
Plugin: site_notifications Any
Requires
Elgg version >= 3.0