Skip to main content

An add-on for Plone

Project description

rer.newsletter

https://travis-ci.org/PloneGov-IT/rer.newsletter.svg?branch=master

This product allows the complete management of a newsletter.

Features

New Content-type

  • Channel

    • Totally customizable because it is possible to set a header, a footer and CSS styles. This fields allows to uniform template of email that will be sent from one channel.

    • content type that inherit from folder content.

  • Message

    • content type that inherit from folder content.

Portlet and Tile

The product provide a portlet and a tile for user subscribe.

Form for user subscribe have two fields: email and reCaptcha, so do not forget to set key for reCaptcha fields. See plone.formwidget.recaptcha for more details.

User Manage

Allows complete management of user.

  • Add user from admin setting

  • Delete user from admin setting

  • Import users directly from CSV file

  • Export users directly to CSV file

  • Delete a group of user directly from CSV file

  • Subscribe users

  • Unsubscribe users

Advanced Features

Utility for email sending

This product normaly send email through plone mailer, but creating a product which implements the utility IChannelUtility it is possible use another system of mailing-list, like for example mailman.

At the inside of IChannel Utility interface are described all methods that will be implemented and the way that they must responded.

Utility declaration:

<utility
  provides=".channel.IChannelUtility"
  factory=".base.BaseHandler" />

and creates a class that implement utility interface:

@implementer(IChannelUtility)
class BaseHandler(object):
    """ utility class to send channel email with mailer of plone """

Advanced security

New permissions have been added for the management of the Newsletter:

  • rer.newsletter: Add Channel

  • rer.newsletter: Add Message

  • rer.newsletter: Manage Newsletter

  • rer.newsletter: Send Newsletter

This permission are assigned to Manager and Site Administrator. Besides it been added a new role Gestore Newsletter which have permissions for all possible operations on newsletter.

Asynchronous sending of email

rer.newsletter supports asyncronous sendout using collective.taskqueue, that it is already installed like a dependency of product.

For support this asyncronous sendout you must add to section instance-settings of your buildout this configuration:

zope-conf-additional =
   %import collective.taskqueue
   <taskqueue>
     queue rer.newsletter.queue
   </taskqueue>
   <taskqueue-server>
     queue rer.newsletter.queue
   </taskqueue-server>

This code adds a queue to which various email submissions are added. See collective.taskqueue for more details.

Cron job

rer.newsletter have a view that can called from a cron job. This view delete all users that not have confirmed subscription to a channel in time.

Inside the settings of the product there is a field that allows you to set validity time of the channel subscription token.

View is:

.../@@delete_expired_users

Installation

Install rer.newsletter by adding it to your buildout:

[buildout]

...

eggs =
    rer.newsletter

and then running bin/buildout

Dependencies

This product has been tested on Plone 5.1

Credits

Developed with the support of Regione Emilia Romagna;

Regione Emilia Romagna supports the PloneGov initiative.

Authors

This product was developed by RedTurtle Technology team.

RedTurtle Technology Site

Contributors

Changelog

0.1.9 (2018-09-20)

  • Fixed modal timeout [eikichi18]

0.1.8 (2018-07-19)

  • Added Redis for asynchronous task

  • Fixed label of close button on subscription modal

  • Added Translatation

  • Fixed the way in which it takes the title of the site

  • Added content rules for user subscription and unsubscription [eikichi18]

0.1.7 (2018-06-19)

  • Fixed buildout [eikichi18]

0.1.6 (2018-06-19)

  • Fixed some minor label [eikichi18]

0.1.5 (2018-05-25)

  • fixed default profile in upgrade step [eikichi18]

0.1.4 (2018-05-23)

  • upgrade step to fix bundle for initializedModal.js [eikichi18]

0.1.3 (2018-05-23)

  • Fixed accessibility problem on subscribe/unsubscribe modal for IE. [eikichi18]

0.1.2 (2018-03-15)

  • Fixed accessibility and style for subscribe/unsubscribe modal. [eikichi18]

0.1.1 (2018-03-02)

  • Fixed doc. [eikichi18]

0.1.0 (2018-03-02)

  • Initial release. [eikichi18]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rer.newsletter-0.1.9.tar.gz (178.7 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page