Welcome, guest | Sign In | My Account | Store | Cart

Notice! PyPM is being replaced with the ActiveState Platform, which enhances PyPM’s build and deploy capabilities. Create your free Platform account to download ActivePython or customize Python with the packages you require and get automatic updates.

Download
ActivePython
INSTALL>
pypm install products.ploneinvite

How to install Products.PloneInvite

  1. Download and install ActivePython
  2. Open Command Prompt
  3. Type pypm install products.ploneinvite
 Python 2.7Python 3.2Python 3.3
Windows (32-bit)
2.0a1 Available View build log
Windows (64-bit)
2.0a1 Available View build log
Mac OS X (10.5+)
2.0a1 Available View build log
Linux (32-bit)
2.0a1 Available View build log
Linux (64-bit)
2.0a1 Available View build log
 
Author
License
GPL
Dependencies
Lastest release
version 2.0a1 on Jan 5th, 2011

About PloneInvite

PloneInvite is a tool for Plone which allows portal members to invite new users to register into the portal. Members get invite codes which are used to send the invitation.

This is a short introduction. For more information, bug trackers, feauture request, etcetera, see the product web page.

How to Use

For the portal administrator:
  1. Go to Site Setup and click on the "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 a member:

1. After logging in, open the "invite someone" link available under your login name in the upper right corner.

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

Install

  1. Add Products.PloneInvite to your buildout's instance's eggs.

2. Install the product from Plone's Add-on configuration or use the portal_quickinstaller in the ZMI.

Features

1. Assign invitations to the current site members. With these invitations, they can invite new members. New members will receive this invitation by e-mail.

2. The site manager can enforce email in the the invitation. This means the invitee must register with the email address to which the invitation was sent.

3. The inviting member can optionally also enforce email, if it was not already enforced by the site manager.

4. The "@@register" form now contains a field "invite_code". New users can register only if they have a valid invitation code.

5. The invitation e-mail message can be customized. (This can be done through the ZMI, it's a skin template.)

  1. The portal administrator manage invitations through the configlet:
  • see which invitations have been accepted
  • revoke unused invitations
  • revoke sent but unaccepted invitations

Configuration

1. Customize PloneInvite/skins/invite_template.cpt in your Product folder to customize your portal Invitation template.

2. The email address which will be used as the "sender" in invite e-mails is the site-wide e-mail address. You can change it via the site's Mail configuration.

Requirements

Tested on:

  • Plone 4.0a3, Zope 2.12.2

Technical summary

  • Subclasses and overrides plone.app.users' RegistrationForm ("@@register")
  • Stores invitations in a portal tool ('portal_invitations')
  • Uses skin templates and scripts for sending and managing invitations
  • Defines custom permissions (among others, for giving invitations to

System Message: WARNING/2 (<string>, line 97)

Bullet list ends without a blank line; unexpected unindent.

members)

Caveats

This product has not been tested in conjunction with other products, such as emaillogin or membrane users.

Credits

  • Created by Giovani Spagnolo of Partecs Participatory Technologies.
  • Plone 4 port and maintained by Kees Hink of

System Message: WARNING/2 (<string>, line 112)

Bullet list ends without a blank line; unexpected unindent.

Goldmund, Wyldebeast & Wunderliebe.

Changelog

2.0a1 (2009-12-30)
  • Plone 4 compatible (Plone 3 support dropped)
  • Generic Setup installation
  • Updated README.txt's
1.1-alpha (march 2009)

Plone 3 compatibility fixes [khink]. 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

System Message: WARNING/2 (<string>, line 137)

Bullet list ends without a blank line; unexpected unindent.

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

System Message: WARNING/2 (<string>, line 145)

Bullet list ends without a blank line; unexpected unindent.

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.)

System Message: WARNING/2 (<string>, line 150)

Bullet list ends without a blank line; unexpected unindent.

email_from_address as default. (Still customizable through config.py)

  • Disable overriding of mailhost settings. (Install.py used to reset the

System Message: WARNING/2 (<string>, line 153)

Bullet list ends without a blank line; unexpected unindent.

portal's mailhost settings to localhost:25)

  • Turn on invitation generation for new users by default (5 invitations), this

System Message: WARNING/2 (<string>, line 156)

Bullet list ends without a blank line; unexpected unindent.

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

System Message: WARNING/2 (<string>, line 170)

Bullet list ends without a blank line; unexpected unindent.

which did not have enforce_address set.

  • Fixed bug in Extensions/Install.py which added two 'invite_form' links to

System Message: WARNING/2 (<string>, line 173)

Bullet list ends without a blank line; unexpected unindent.

user actions.

  • Added a "FakeMessageFactory" class for translations in controller scripts,

System Message: WARNING/2 (<string>, line 176)

Bullet list ends without a blank line; unexpected unindent.

see fakemessagefactory.py

TODO

  • Complete i18n.
  • Automaticaly add a number of invites for new members.

System Message: WARNING/2 (<string>, line 185)

Bullet list ends without a blank line; unexpected unindent.

(And modify the configlet to enable modification of number of invites to give new users.

  • Re-add expiration functionality (invitation expires after configurable time

System Message: WARNING/2 (<string>, line 189)

Bullet list ends without a blank line; unexpected unindent.

period).

  • Modify configlet to enable modification of invitiations e-mail "Sender" in

System Message: WARNING/2 (<string>, line 192)

Bullet list ends without a blank line; unexpected unindent.

Plone.

  • In the configlet, don't show "Number of days the invitation stays active"

System Message: WARNING/2 (<string>, line 195)

Bullet list ends without a blank line; unexpected unindent.

if there are no members.

  • Do not lose invitations when re-installing.
  • See if we can subclass zope.interface.Interface instead of

System Message: WARNING/2 (<string>, line 200)

Bullet list ends without a blank line; unexpected unindent.

IDefaultPloneLayer (interfaces.IPloneInvitePolicy)

Subscribe to package updates

Last updated Jan 5th, 2011

Download Stats

Last month:1

What does the lock icon mean?

Builds marked with a lock icon are only available via PyPM to users with a current ActivePython Business Edition subscription.

Need custom builds or support?

ActivePython Enterprise Edition guarantees priority access to technical support, indemnification, expert consulting and quality-assured language builds.

Plan on re-distributing ActivePython?

Get re-distribution rights and eliminate legal risks with ActivePython OEM Edition.