collective.contentrules.mailtogroup 1.6.3
Send e-mail to groups and members defined in the action.
Keywords: plone automatic content rules

.. image:: https://secure.travis-ci.org/collective/collective.contentrules.mailtogroup.png?branch=master
    :target: http://travis-ci.org/collective/collective.contentrules.mailtogroup
    :alt: Travis CI badge

.. image:: https://coveralls.io/repos/collective/collective.contentrules.mailtogroup/badge.png?branch=master
    :target: https://coveralls.io/r/collective/collective.contentrules.mailtogroup
    :alt: Coveralls badge

.. image:: https://pypip.in/d/collective.contentrules.mailtogroup/badge.png
    :target: https://pypi.python.org/pypi/collective.contentrules.mailtogroup/
    :alt: Downloads

Introduction
============

This action rule allows you to send e-mail to groups and users. The groups and
users are defined in the action rule, it's possible to combine both. This action
was made because the current actions cannot mail to a dynamic set of users (group).
Adding multiple members was also added because you don't always know the e-mail of
a certain user.


Disclaimer
==========

The variable `${namedirectory}` for an item's parent folder name, and the
variable `${text}` for an item's body text field, won't be substituted anymore
since version 1.5, due to an unintentional breaking commit introducing the
regressions which haven't been restored since then.

If you want to use these variables, you need to pin this add-on to the
preceding version (`1.3.1`_), see installation section below.

.. _1.3.1: https://pypi.org/project/collective.contentrules.mailtogroup/1.3.1/


Installation
============

Please refer to Plone's official documentation for `installing add-ons`_
and `pinning specific add-on versions`_.

An activation of this add-on via a Plone site's controlpanel is not necessary,
the features of this add-on will be immediately available to all Plone sites of
the ZOPE instance.

.. _installing add-ons: https://docs.plone.org/manage/installing/installing_addons.html#installing-add-ons-using-buildout
.. _pinning specific add-on versions: https://docs.plone.org/manage/installing/installing_addons.html#pinning-add-on-versions


Usage
=====

Go to the Plone Control Panel, select Content Rules and add a new Rule.
Under 'actions' you now have a new option: Send email to groups and users.

When searching for users and groups make sure you press the search button. Don't
hit enter. Search results for these items are only shown when you press search.


Future
======

This add-on has been `approved`_ for inclusion in the core of Plone.
When that happens, independent development of it might cease.

.. _approved: https://github.com/plone/Products.CMFPlone/issues/1808


Credits
=======

Most of this package is directly copied from the plone.app.contenttules.mail
action. The package collective.contentrules.mailtolocalrole was also used as
an example.


Changelog
=========

1.6.3 (2018-10-05)
------------------

- Add more information about regressions to README.rst.
  [ida, fulv]


1.6.2 (2018-06-19)
------------------

- I messed up 1.6.1 and made a brown bag release.
  [fulv]


1.6.1 (2018-06-19)
------------------

- Add note about unfixed regressions and more verbose install-instructions. [ida]


1.6 (2016-11-08)
----------------

- Add test case for empty recipients.
  [fulv]
  
- Add support for Plone 5.0 and 5.1.  On Plone 5.x we use z3c.form instead of formlib.
  [fulv]

- Drop support for Plone 4.0, Plone 4.1 and Plone 4.2.
  Package may work, but we are no longer testing against these versions as Python 2.6 is no longer supported on code analysis.
  [hvelarde]

- Use plone.app.contentrules.ManageContentRules permission instead of cmf.ManagePortal.
  [fulv]


1.5 (2014-06-30)
-------------------

- Fixed tests and version numbering [kcleong]

- Fixed source address assignment. Now doesn't break the rule execution[cekk]

- Enabled the use of string interpolator for string substitutions [cekk]

- Add Brazilian Portuguese and Spanish translations.
  [hvelarde]

- Fix package dependencies.
  [hvelarde]



1.3.1 (2013-05-03)
-------------------

- Added help-text for text-variable. [ida]

- Added exception, if text-variable is used, but an item doesn't have a text-field.
  Concerns actions/mail.py [ida]


1.3 (2012-02-15)
-------------------

- Added fieldname 'text' as a substitutable variable and perform text-transformation,
  in order to send the message as html and as plain-text, providing a fallback
  for non-html-capable email-clients. [ida]

- Add the {namedirectory} variabel. Which can be used in the subject or message
  to show the title of the folder the rule is applied to.
  [puittenbroek]

- Add LICENSE.txt + LICENSE.GPL in /docs.
  [WouterVH]

- Remove old-style i18n-directory, and register locales-folders.
  [WouterVH]

- Add MANIFEST.in
  [WouterVH]


1.2 - 2011-04-05
----------------

- Added z3c.autoinclude in setup.py
  [kcleong]

- Using 'send' instead of deprecated 'secureSend' in Plone 4. For Plone 3
  secureSend is used.
  [kcleong]

- Use include for CMFCore in zcml, fixes permission bug in Plone 4.1
  [puittenbroek]


1.1 - 2010-12-06
----------------

- Fixed error when used on Plone 4: passing 'From' to secureSend is
  not needed in Plone 3 and breaks in Plone 4.
  [maurits]


1.0 - 2010-02-12
----------------

- No bug changes, just marking it as final.

- Must pin down plone.app.form on 1.1.8 if you're using version 1.1.8, bug
  in UberMultiSelectionWidget.