Skip to content

Latest commit

 

History

History
76 lines (52 loc) · 3.32 KB

README.md

File metadata and controls

76 lines (52 loc) · 3.32 KB

Subscribers Plugin

Description

The plugin adds pages to the Subscribers menu:

  • advanced search - search for subscribers and show subscriber attributes with confirmed and blacklisted status
  • subscriber history - shows history events: all, since a start date or those containing specific text
  • subscriptions - lists the number of subscriptions and unsubscriptions for each month with a chart showing the data graphically

Installation

Dependencies

This plugin is for phplist 3.

Requires php version 5.3 or later.

Requires the Common Plugin version 2015-03-23 or later to be installed. You should install or upgrade to the latest version. See https://github.com/bramley/phplist-plugin-common

Set the plugin directory

You can use a directory outside of the web root by changing the definition of PLUGIN_ROOTDIR in config.php. The benefit of this is that plugins will not be affected when you upgrade phplist.

Install through phplist

Install on the Plugins page (menu Config > Manage Plugins) using the package URL https://github.com/bramley/phplist-plugin-subscribers/archive/master.zip.

In phplist releases 3.0.5 and earlier there is a bug that can cause a plugin to be incompletely installed on some configurations (https://mantis.phplist.com/view.php?id=16865). Check that these files are in the plugin directory. If not then you will need to install manually. The bug has been fixed in release 3.0.6.

  • the file SubscribersPlugin.php
  • the directory SubscribersPlugin

Then click the small orange icon to enable the plugin.

Install manually

Download the plugin zip file from https://github.com/bramley/phplist-plugin-subscribers/archive/master.zip

Expand the zip file, then copy the contents of the plugins directory to your phplist plugins directory. This should contain

  • the file SubscribersPlugin.php
  • the directory SubscribersPlugin

Known problems

Export fails with "Error, incorrect session token"

phplist 3.0.9 had a change that stopped the plugin export working. Instead the message "Error, incorrect session token" is displayed.

To fix this problem upgrade to the latest version of CommonPlugin.

Donation

This plugin is free but if you install and find it useful then a donation to support further development is greatly appreciated.

Donate

Version history

version     Description
2015-05-29  Improved German translation
2015-05-28  Allow menu items to be translated
2015-05-17  Include IP address in export of subscriber history
2015-05-10  Add dependency checks
2015-03-23  Change to autoload approach
2015-01-18  Allow searching on user history IP address
2014-11-17  Shorten keys on config table to allow longer admin ids
2014-04-18  Search on id and uniqid
2014-03-11  Search on confirmed/unconfirmed and blacklisted/not blacklisted
2014-02-12  Allow searching on email address
2014-02-03  Display as pages instead of tabs
2014-01-25  Use Google Chart, minor changes
2013-11-20  Bug fix
2013-11-05  Improve layout to be similar to core phplist
2013-10-27  Display each page as a tab
2013-05-10  Initial version for phplist 2.11.9 converted from 2.10 version