collective.contentrules.mailfromfield

by Luca Fabbri last modified May 02, 2013 02:24 PM

A Plone content rule for send e-mail to addresses taken from the content

Project Description

Introduction

This product will add to Plone a new content rules, someway similar to the default "Send an email" ones. The difference is that the email recipient is taken dinamically from the content itself, not from a static list of values.

In this way the same rule, applied in different places in the site, can send the message to different users.

How to use

The rules can be enabled globally and locally like every one else, as default Plone feature. In the rule configuration panel you need to fill a set of information:

Subject
The e-mail subject. You can place inside this text some markers (see below).
Sender email
The sender of the e-mail. You can leave this empty and automatically use the one from the site mail settings.
Source field
You must put there the name of the attribute from which you want to retrieve the recipient e-mail. See next section.
Target element

You need to select if the recipient's e-mail must be taken from the object where the rule is activated on ("From trigger object", default choice) or from the document that really raised the event ("From event target").

See below for details.

Mail message

The body text of the e-mail that will be sent. The text is the same for all section where the rule is activated on.

You can place inside this text some markers (see below).

How it take the email data

First of all you must choose the type of target element.

If you choose to keep default "From trigger object" option, the data is read from the section you have activated the rule on.

Example: if you activated the rule on a folder called section and the rule will raise event when working on a document called foo (like: modifying the document), the e-mail address will be taken from the folder.

Changing to "From event target" will change the behavior, trying to get e-mail data from the same attribute but looking for it on the object that raised the event.

In the example above: we will look for the value from the document.

What it try to read

The rule try to get from the object:

  • an attribute of the given name
  • a callable method from the given name
  • an Archetypes field with given id
  • a ZMI property with given id

The rule try to read, one after one, all this data. The first match found will be the one used; if not one give results, no e-mail is sent at all.

Message markers

Marker labels that follow can be used in the message text and subject.

${title}
The title of the content that triggered the event (foo title in our example)
${url}
The URL of the content that triggered the event (foo URL in our example)
${section_name}
The title of the folder where the rule is activated on (section title in our example)
${section_url}
The URL of the folder where the rule is activated on (section URL in our example)

A real Plone use case

A Plone site use Signup Sheet for manage internal training session. The form fieldset is customized as normal, but one of the field is director_email.

The scope there is that this e-mail address is notified when a user subscribe and the user itself put there the e-mail address of the proper director.

To reach this we need to:

  • create a new rule triggered on "Object added to this container"
  • add a filter condition based on content type Registrant
  • add an action using the "Send email to address taken from the content"
  • specify in the action the SignupSheet field with the director email
  • specify in the action that we want to take the email from the target object (the Registrant itself)

TODO

  • why don't support also looking in annotations?
  • why don't support also multiple valued sources?
  • right now the rules check all mail source until one is found with a defined order; maybe is better to leave this choice to the configuration
  • Dexterity support (probably already there, but needs to be tested)

Requirements

This product has been tested on:

  • Plone 3.3
  • Plone 4.2
  • Plone 4.3

Credits

Developed with the support of S. Anna Hospital, Ferrara; S. Anna Hospital supports the PloneGov initiative.

OspFE logo

This product was largely developed looking at the source of collective.contentrules.mailtogroup.

Authors

This product was developed by RedTurtle Technology team.

RedTurtle Technology Site

Self-Certification

[X] Internationalized

[X] Unit tests

[X] End-user documentation

[ ] Internal documentation (documentation, interfaces, etc.)

[X] Existed and maintained for at least 6 months

[X] Installs and uninstalls cleanly

[ ] Code structure follows best practice

Current Release

No stable release available yet.

All Releases

Version Released Description Compatibility Licenses Status
0.2.0 Bugfix and Plone version compatibility upgrade More about this release…
Plone 4.3
Plone 4.2
Plone 4.1
Plone 4
Plone 3
GPL beta
0.1.0 First release More about this release…
Plone 4.1
Plone 4
Plone 3
GPL beta