About this Documentation

This site is a collaborative effort of phpList users to provide documentation for phpList. If you do not know what phplist is, first read the Introduction and the feature list.

If you don't know how to use a wiki, which is a type of software this documentation site uses, go to the SandBox and experiment freely. Your first time, you must go to Login/Register at the top of this page. (This is a different login from logging in to the forum itself.) Fill in all four blanks, then click Register. Then go to the SandBox, click "Edit page" at the bottom, and try your hand. See WikiInstructions for greater detail.

I - Installation and Configuration

Step by step installation procedure and tips. Some knowledge of Windows or *nix systems is required.

• Installing phpList (creating the database, uploading files)
  • SystemRequirements
• Post-install configuration (options found in config.php file, tunes phpList's performance and features)
  • Settings for database connection & web pages
  • Settings for handling bounces
  • Setting the Send Speed (Rate)
  • Other configuration options
• Setting Up For Use (adding Lists and Users; readying for launch)
• Preflight Checklist (items to check before your first mailing)
• Upgrading
• FAQ (answers to common questions)
• Troubleshooting (answers to common warning and error messages)
• Securing phpList

II - phpList Userguide

• Basic phpList Concepts (a primer on how phpList organizes Lists and Email Addresses)
• Configuration Functions
  • Configure phplist
  • Attributes
  • Subscribe pages
  • Custom subscribe form
  • Configure Bounces
• List and User Functions
  • Lists
    • List the current lists
    • View members
  • Users
    • User info
    • List all users
    • Export users
    • Import users
    • Reconcile users
    • Check for users
• Message Functions
  • Send a message
    • Message Format
    • Attach Files to message
    • Schedule message
    • Select Criteria
    • Select Lists
    • Miscellania
  • Process the Message Queue
  • List all messages
  • Message templates
  • Using placeholders
  • Message Forwarding
  • Message Repetition
  • Message Statistics
• Administrator functions
  • Creating/editing admins
  • Admin permissions
  • SuperAdmins
  • Admin attributes
  • Import admins
  • Setup a Cron Job
• RSS Functions
  • Conceptual Setup of RSS feed distribution via phplist
  • Get RSS
  • View RSS
  • Scheduling tab
• System Functions
  • Setup
  • Datavase check
  • Event Log
  • Securing phpList
  • Integrating phplist with web applications
• Editors
  • FCKEditor
  • TinyMCE
• Phplist Hacks
• Phplist Translation
• Glossary
  
  

---

Disclaimer

Please do NOT use this wiki if you experience problems with your system. Please use the phplist Forums instead. This wiki is meant to provide simple documentation on how phpList works (not on why it doesn't work), as well as a place for phpList developers to discuss new features.

Bugs can be reported on mantis bug tracker. If you are not already doing so, please test the bug with the latest version of phpList or check the Change Log as it may have already been fixed.

---

phpList Development

phpList Development: Documentation on the setup of phplist code and how you can contribute to it.
Includes: Add-ons, MODs, Editors, Translation of phplist, etc.
Proposals for new features and modifications can be found in the phpList Development Category.

Support this project

If you like phplist and wish to contribute to this project make a donation.