Products.PloneInvite 1.1.1

Allows users to invite others to join the site

About PloneInvite

PloneInvite is tool for Plone which allows portal members to invite new users to register into the portal. The portal administrator assigns the invite codes to the portal members and members can and these invite codes are used to send the invitation.

How to Use

For Portal Administrator:

1. Log in as portal administrator, go to Site Setup and click on Member Invitations link.

2. On this page you can give invites to other users and set the expiration period in days for the portal invites.

For Member:

1. After logging in open invite link present just below search box.

2. This page allows members to send invitations as well as see the status of their invitations.

Install

1. Put this product in to products folder and restart the zope.

2. Install the product from portal_quickinstaller.

Features

1. Assign invites to the users.

2. Admin can enforce email in the the invitation (invitee register with the same email address to which the invitation was sent )

3. Expiry Date for the invitation

4. Inviter can enforce email

5. User can register only if they have the invitation code

6. Manager can add users with out invitation code

7. Invitation e-mail message can be customized (page template modification)

Configuration

Customizing the invite e-mail

1. Go to the ZMI

2. Go to portal_skins, to plone_invite, select the invite_template, customize that

Customizing the invitation sender address

The email address which will be used as the “sender” in invite e-mails is the site-wide e-mail address by default. You can change it via “@@mail-controlpanel”.

If you want to use a different sender address than the site address:

1. Go to the ZMI

2. Go to the plone_invite tool, go to the ‘properties’ tab, modify plone_invite_email_address

Requirements

Tested on:

• Plone 3.2.1, CMF 2.1.2, Zope 2.10.6-final

• Plone 3.3b1, CMF 2.1.2, Zope 2.10.7-final

• Plone 3.3.3, CMF 2.1.2, Zope 2.10.9-final

Warning

The product relies on a modification of the join_form for its functionality. Using the product alongside another product which also modifies join_form will not work.

Credits

Created by Giovani Spagnolo of Partecs Participatory Technologies. Maintained by Kees Hink of Goldmund, Wyldebeast & Wunderliebe.

CHANGES

1.1.1 (2010-01-04)

• Fixed bug where invitation email’s sender address was left empty

• Add property ‘plone_invite_sender_addres’ to tool to use instead of site’s ‘email_from_addres’.

1.1 (2009-12-01)

Plone 3 compatibility fixes by Kees Hink <[e-mail]>. This takes care of just getting the product to work, but there’s more that could be done: see the TODO.

• Breaks compatibility with Plone 2.5, due to @@authenticator, which is called from the join_form in Plone 3, isn’t available in Plone 2.5.

• Renamed permissions from “PortalInvite: …” to “PloneInvite: …”.

• Minor modifications so it works under Plone 3, most notably

  • encode e-mail before sending

• Enabled self-registration (‘Add portal member’ permission on the site), which is needed to enable new members to register themselves. (Self-registration is protected by the validation on the join_form, so people will only be able to register with an invitation code.)

• Disabled ‘[e-mail]’ as default value, use site-wide email_from_address as default. (Still customizable through config.py)

• Disable overriding of mailhost settings. (Install.py used to reset the portal’s mailhost settings to localhost:25)

• Turn on invitation generation for new users by default (5 invitations), this is probably what most sites want. Should be configurable in Plone product settings configlet.

• Disable bare try-except blocks in invite.cpy

• Translations:

  • Added PloneInvite.pot and plone.pot

  • Added Makefile for easy creation and updating of translation (.po) files

  • Added Dutch translation

• Fixed a bug in the user_invites template table, which showed only the invites which did not have enforce_address set.

• Fixed bug in Extensions/Install.py which added two ‘invite_form’ links to user actions.

• Added a “FakeMessageFactory” class for translations in controller scripts, see fakemessagefactory.py

For future release, these would be nice improvements:

• Allow modification of invitiations e-mail “Sender” in configlet (currently through ZMI).

• Modify configlet to enable modification of number of invites to give new users. (default is 5)

• Include expiration functionality (invitation expires after configurable time period).

• Do not lose invitations when re-installing.