2017 © Pedro Peláez
 

elgg-plugin digest

Sends out a digest mail for site and group activity

image

coldtrick/digest

Sends out a digest mail for site and group activity

  • Thursday, September 14, 2017
  • by jeabakker
  • Repository
  • 5 Watchers
  • 12 Stars
  • 39 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 6 Forks
  • 11 Open issues
  • 1 Versions
  • 0 % Grown

The README.md

Digest

Build Status Scrutinizer Code Quality Latest Stable Version License, (*1)

Send out a digest to your users, (*2)

Features

Sends mails with update information to your site or group members based on default or personal intervals (monthly, fortnightly, weekly or daily), (*3)

  • site wide digest
  • group digest
  • html mail (or fallback to online link if not supported)
  • sent digest can also be viewed online (not only in mail)
  • extend/replace layout or content of digests with own views
  • exclude groups from delivery with a hook

Plugin developers

If you wish to supply content for either the Site digest of Group digest you can easily extend the digest., (*4)

For the Site digest

Please extend the view "digest/elements/site" with the content from your plugin and extend the view "css/digest/site" with the CSS that's part of this content., (*5)

You can find out which variables your have available in your view by checking the view "digest/elements/site"., (*6)

We suggest you put your content in "digest/elements/site/" and the CSS in "css/digest/site/". This is just a suggestion, but it would make it easier for theme developers., (*7)

For the Group digest

Please extend the view "digest/elements/group" with the content from your plugin and extend the view "css/digest/group" with the CSS that's part of this content., (*8)

You can find out which variables your have available in your view by checking the view "digest/elements/group"., (*9)

We suggest you put your content in "digest/elements/group/" and the CSS in "css/digest/group/". This is just a suggestion, but it would make it easier for theme developers., (*10)

Theme developers

If you want to adjust the Digest to look like your theme, please check to following elements, (*11)

Shell

The base layout of the digest can be found in the view "page/layouts/digest". The CSS that's part of the base layout can be found in the view "css/digest/core"., (*12)

Elements

The base layout consists of a few default elements, (*13)

In the view "digest/elements/header" this contains the title of the current digest., (*14)

In the view "digest/elements/online" this contains a link to the online view of the digest. In case the digest can't be viewed correctly in the e-mail client., (*15)

Content

The content of the digest will be made using the view view "digest/elements/site" for the Site digest or "digest/elements/group" for the Group digest., (*16)

Both view are just empty wrapper view, all plugins are required to extend to these views in order to display content., (*17)

In the view "digest/elements/footer" this contains a description of either the Site or the Group, depending on the digest., (*18)

Unsubscribe

In the view "digest/elements/unsubscribe" this contains some information about where the digest came from, how the user can change the settings of the digest and a direct link to unsubscribe from the digest., (*19)

The Versions

14/09 2017

dev-master

9999999-dev

Sends out a digest mail for site and group activity

  Sources   Download

GPL-2.0

The Requires

 

The Development Requires

plugin email notification elgg