Skip to main content

Introduction

hl.plone.boardnotifications provides email notifications for Ploneboard (http://pypi.python.org/pypi/Products.Ploneboard) for several purposes. It allows you to:

  • let users subscribe/unsubscribe to forum threads

  • notify conversation/comment owners when their content has been edited, deleted, or moved to a different forum by a moderator

  • configure a specific mail text for each purpose. Leave the mail text empty for notification types you don’t want to use

  • personalize mails using memberdata properties

  • use conversation/comment URL and title in the notifications

Installation

  1. Add the package to your buildout

  2. Run buildout

  3. Restart Zope

  4. Install hl.plone.boardnotifications using the Plone Management Interface

  5. Visit “Board Notifications” in the site control panel (go to @@boardnotifier-settings) and configure the mail templates (see “Configuration” below)

Configuration of Mail Templates

Subject and Signature

If you choose to configure subject and signature, those will be used in all templates. If you want to use subjects and signature on a per template basis, leave these fields blank. You can then add the signature to each template as appropriate. For a per template subject, enter

Subject:your subject here

on the first line of the mail template, followed by a blank line.

Variables

You can use a number of variables to produce meaningful mail texts using standard Python string conversion specifiers with the variable name as mapping key (i.e. %(variable_name)s). The following variables are available in the email templates:

  • all member properties as defined in portal_memberdata

  • conversation title: use %(threadtitle)s to reference the conversation’s title in

  • conversation URL: use %(threadurl)s to reference the conversation’s URL

  • forum title: use %(boardtitle)s to reference the forum’s title

  • comment URL: use %(commenturl)s to reference the comment’s url

Personalized Mail Salutations

The salutation field can be used to define gender specific salutations. If you don’t need this feature, just leave it blank. When you save your settings, your empty string will be replaced by ‘:’ - simply ignore this. You can still put a generic salutation in each mail template and use %(fullname)s to address the recipient. If you want personalized salutations, hl.plone.boardnotifications defines a new member property named ‘salutation’. It is your responsibility to fill it per member by e.g. customizing @@personal-settings. Then you have to map the possible contents of the salutation member property to the desired salutation, e.g.:

Mr:Dear Mr. %(fullname)s,

Mrs:Dear Mrs. %(fullname)s,

:Dear Mrs./Mr. %(fullname)s,

Examples of mailing texts

A comment has been added to a conversation, notify conversation subscribers:

Subject:New comment in thread “%(threadtitle)s”

%(salutation)s

there is a new post in thread “%(threadtitle)s” placed in the forum “%(boardtitle)s”. You are suscribed to this thread.

Get to the latests post: %(commenturl)s

%(mailsignature)s

If you don’t want to be notified: %(threadurl)s/unsubscribe

This e-mail has been sent automatically.

A conversation has been moved to another forum:

Subject:Conversation “%(threadtitle)s” has been moved

%(salutation)s

the conversation “%(threadtitle)s” has been moved to “%(boardtitle)s”.

Get to moved conversation: %(threadurl)s

%(mailsignature)s

Changelog

0.3 (13.12.2012)

  • added documentation

  • do not try to send emails to users that have been deleted

  • do not send email when a template contains only whitespace

0.2 (23.08.2012)

  • working MANIFEST.in

0.1 (23.08.2012)

  • initial release

Metadata

Release files for hl.plone.boardnotifications 0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hl.plone.boardnotifications 0.3
File Size Uploaded
hl.plone.boardnotifications-0.3.tar.gz 23.6 kB Details

Release files / hl.plone.boardnotifications-0.3.tar.gz

Download URL hl.plone.boardnotifications-0.3.tar.gz
Size 23.6 kB
Tags Source
SHA-256 checksum
How to use checksums
e2faf314f7d5e5c8c6eb70b5d2ea4953f90d80c73cea28b372e9e6d02561db1f
BLAKE2b-256 checksum
How to use checksums
7e75810bc9c33b0bc4e5381c39963950f1c82a490aae73c1193e12fe865d97b8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

1.1

1 release file

1.0

1 release file

0.9

1 release file

0.8

1 release file

0.7

1 release file

0.6

1 release file

0.5

1 release file

0.4

1 release file

This release

0.3 This release

1 release file

0.2

1 release file

0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page