Skip to content

Latest commit

 

History

History
171 lines (118 loc) · 9.3 KB

README.md

File metadata and controls

171 lines (118 loc) · 9.3 KB
Raw

Build Status Stable release License Translation status
Fully functional Open Source email marketing manager for creating, sending, integrating, and analysing email campaigns and newsletters: https://www.phplist.org

phpList includes analytics, segmentation, content personalisation, bounce processing, plugin-based architecture, and multiple APIs. Used in 95 countries, available in 20 languages, and used to send more than 25 billion campaign messages in 2018.

Deploy it on your own server, or get a hosted account at http://phplist.com.

Features

  • Responsive web-based, and command-line interfaces
  • Real-time analytics: track message responses and subscriber behaviour
  • Message-queue management: load-balances and throttles multiple accounts and campaigns; tracks every delivery outcome
  • Content personalisation: every message customised to individual subscriber attributes and preferences
  • Automated bounce management and processing: policy and regex-based handling with every bounce accessibly archived
  • Schedule, pause, resume, repeat, and requeue campaigns
  • Amazon SES: built-in optimised support
  • CSV and Excel based subscriber import and export, including attributes and preferences
  • Send a Webpage: automatic remote html polling, conversion, and dispatch
  • Email attachments support
  • Domain-based throttling: comply with host-specific policies by defining custom rules
  • RSS Feeds: phpList can be set up to read a range of RSS sources and send the contents on a regular basis to users. The user can identify how often they want to receive the feeds.

Get phpList

If you'd like to use phpList for your own campaigns, or you just want to try phpList out, there is no need to do all the work of installing it yourself. phpList Hosted is free to use, just sign up to get started.

If at a later time you do want to migrate from your own installation to phpList Hosted, or vice versa, your data can be migrated.

Alternatively, you can try out the latest phpList release at phplist.org. This installation is wiped and refreshed every hour.

Upgrade

For users

See Upgrading a manual installation

For developers

'Use translate.phplist.org to translate the phpList admin interface.' How to upgrade from any previous version to the latest version

How to upgrade from any previous version to the latest version

BACKUP your database (e.g. `mysqldump -u[user] -p[password] [database] > phplist-backup.sql`)

Copy your old configured files to some safe place

These files are:

  • lists/config/config.php
  • possibly lists/texts/english.inc or any other language.inc if you have edited it
Copy the files from the tar file to your webroot.

You can copy everything in the lists directory in the tar file to your website. To facilitate future upgrades, ie to make it easier for you to simply copy everything I have now put the "configurable" files in their own directory. They reside in "lists/config". This is hopefully going to be the directory that you can keep between upgrades, and that will contain the only information that you want to be changed in order to make it work for your own site.

Copy your configuration files to lists/config or re-edit the new config file sometimes new features are added to the config file, so it's better to use the new config file and re-adapt it to your situation.

An example .htaccess exists file in this directory. You should not allow access to this directory from the webserver at all. The example will work with apache.

You can overwrite the files that are there. They are example files.

Go to `http://yourdomain/lists/admin/` and choose the 'Upgrade' link

Click the link on this page.
This process may take quite a while if your database is large. Don't interrupt it.

Issues

Report issues to Mantis issue tracker (select project phpList 3 application)
'Please don't use GitHub issues'.

Languages, Info files and Contextual help

In the directory phplists/lists/texts you will find existing translations of the public pages of phpList. You can use them in your config file to make the frontend of the system appear in the language of your choice.

In the config file there are a lot of choices to make about your particular installation. Make sure to read it carefully and step by step work your way through it. A lot of information is provided with each step.

Themes

phpList comes with Trevelin theme on default. Older versions than 3.4.6, include additionally Dressprow which is not currently maintained. Patches to Dressprow theme are still welcomed. Both themes are available for installation via GitHub.

To get the latest copy of each theme you should clone them individually into public_html/lists/admin/ui/ For the prerequisites of each and Installation guide on your development copy make sure you check the README files of the repos.

Code of Conduct

This project adheres to a Contributor Code of Conduct. By participating in this project and its community, you are expected to uphold this code.

License

phpList 3 is licensed under the terms of the AGPLv3 Open Source license and is available free of charge.