The plugin allows you to send a campaign to a segment, a subset, of the subscribers who belong to the selected lists.
The plugin adds a tab to the Send a campaign page that lets you define conditions. A condition comprises a field, an operator, and a target value. When the campaign is sent only those subscribers who meet either any or all of the conditions will be selected.
These subscriber fields and attributes are supported for fields:
- each subscriber attribute
- the subscriber email address
- the subscriber id
- the subscriber unique id
- the date they signed-up to phpList
- the date they subscribed to the lists to which the campaign is being sent
- the subscriber belongs to all lists to which the campaign is being sent
- subscriber campaign activity - whether the subscriber was sent, opened, or clicked a link in a specific prior campaign
Each condition has a set of operators, specific to each field, such as 'is', 'is not', 'matches', 'is before', 'opened', etc.
The target value, also specific to each field, can be a text value, a select value, a date, etc.
Requires phplist version 3.3.2 or later, and php version 5.4.0 or later. Please check your php version before installing the plugin, otherwise phplist will fail (probably a white page).
This plugin requires the Common Plugin version 3.11.0 or greater to be installed, and will not work without that. That plugin is now included in phplist so you should only need to enable it. See https://github.com/bramley/phplist-plugin-common
Install on the Plugins page (menu Config > Plugins) using the package URL https://github.com/bramley/phplist-plugin-segment/archive/master.zip
Download the plugin zip file from https://github.com/bramley/phplist-plugin-segment/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 SegmentPlugin.php
- the directory SegmentPlugin
In the Segmentation group on the Settings page you can specify:
- The size of the list of previous campaigns for Campaign activity. The default is 10.
- The number of subscribers to display who meet the segment conditions. The default is 50.
For guidance on usage see the plugin page within the phplist documentation site https://resources.phplist.com/plugin/segment
Please raise any questions or problems in the user forum https://discuss.phplist.org/.
This plugin is free but if you install and find it useful then a donation to support further development is greatly appreciated.
version Description
2.14.1+20231212 Minor internal changes
2.14.0+20231018 When viewing message show number of pending subscribers
2.13.2+20230403 Update translations
2.13.1+20230103 Fix problem with an invalid regex causing an exception and a "white page"
2.13.0+20221104 Add IS NOT INCLUDED operator
2.12.1+20210428 Allow the plugin to be a dependency of phplist
2.12.0+20210225 Simplify whether campaign can be submitted
2.11.0+20201212 Support aggregated campaigns for sent and clicked
2.10.1+20200515 Make the dependency check message clearer
2.10.0+20200307 Allow searching select list of subscriber fields and attributes
2.9.0+20191231 Add aggregated campaigns to subscriber campaigns opened/not opened
2.8.0+20190212 Add anniversary operator for date attribute field
2.7.0+20181115 Add condition for date subscribed to list
2.6.1+20181104 When sending a campaign log an event showing the number of subscribers selected
2.6.0+20181103 Add condition for subscriber belonging to all lists selected for the campaign
2.5.1+20181003 Fix earlier regression that limited the number of attributes to 15
2.5.0+20180906 Segment according to a textarea filled with emails
2.4.0+20180905 Add export of selected subscribers
2.3.0+20180722 Display subscribers that meet the segment conditions
2.2.7+20180517 Avoid dependency on php 5.6
2.2.6+20180328 Reduce the level of php errors that are reported
2.2.5+20171218 Improve the layout of the Segment tab
2.2.4+20171109 Improve display of multiple-select
2.2.3+20171023 Improvements to layout of the Segment tab
2.2.2+20171018 Display warning when lists have not been selected
2.2.1+20170208 Copy segment fields when copying a campaign
2.2.0+20170126 Improvements to use of saved segments
2.1.11+20161217 Extra validation of from and to dates
Use flatpickr for date input
2.1.10+20160725 Calculate number of subscribers when there are not any conditions
2.1.9+20160626 Fix problem whereby 0 was not accepted in text fields
2.1.8+20160515 Fix sql error introduced in version 2.1.6
2.1.7+20160515 Minor changes
2.1.6+20160513 Fix for bug when using MESSAGEQUEUE_PREPARE
2.1.5+20160316 Handle condition for an attribute that no longer exists
2.1.4+20151117 Internal code refactoring
2.1.3+20151024 Internal changes to meet coding standards
2.1.2+20151019 Fix php warning
2.1.1+20150912 Fix problem when viewing message
2.1.0+20150903 Added "after interval" operator for date fields
Improve validation and warning of invalid conditions
2.0.0+20150811 Display segment conditions on view message page
2015-07-16 Can now save and re-use segments
2015-06-02 Handle attribute not existing
2015-05-06 Add dependency checks
2015-04-04 Internal changes to improve memory usage
2015-03-23 Change to autoload approach
2015-03-04 Add subscriber id and uniqid as subscriber data fields
2015-02-13 Add "is between" operator for date fields
2015-01-06 Remove limit of 15 attributes
2014-11-21 Allow text to be translated
2014-10-20 Campaign activity select list is limited to prior campaigns sent to the lists
2014-10-18 Fix bug in date attribute processing
2014-10-15 Added list exclusion, internal changes
2014-10-04 Add sent/not sent a campaign, and clicked/did not click any link
2014-10-03 Add any/all, multi-value for select list and radio button attributes
2014-09-27 Correct error reporting
2014-09-26 Pull Request #1
2014-09-25 Add regexp matching
2014-09-24 Release to GitHub
