|
Maxprog List Manager (MLM for short) is a double opt-in list subscription manager PHP script. It supports a full set of commands you can use either directly with your web browser to maintain your lists or by placing them on your web pages or on your outgoing messages. You can set MLM to work with either a mySQL database or simple raw text files just changing a parameter in the settings file. An updated version of this page is available here: http://www.maxprog.com/scripts/list_manager/user_guide.html
Installation
The installation of MLM is very simple. You just need to go thru the following steps:
1.- Open the mlm/mlm_settings.php file with a text editor.
2.- Edit the script settings and save.
3.- Upload the MLM folder to your FTP server.
4.- Use your FTP software to CHMOD the MLM folder to 777.
5.- If you have selected to use mySQL run the script with the 'Init' command:
http://<script_path_here>/mlm.php?cmd=init&pwd=password
Note: The mlm/mlm_settings.php contains all the parameters you can change to customize the script to match your needs. It is important to open that file with a plain text editor like Notepad on Windows or TextEdit on the Macintosh. If you don't know how to CHMOD a folder with your FTP software please read your FTP software manual. The HTML folder includes a few sample pages for subscribing customers to your lists (to a fixed single list, a single list from a selection or multiple lists at once) and a sample page for uploading lists to MLM (Pro version only).
MLM fully integrates with MaxBulk Mailer (v6 or higher) thru the 'Remote Lists' function allowing you to send messages to your remote lists directly as if they were local, without the need to go thru the tedious and boring import/export steps. The 'Remote List' option is a new entry available in the List Manager pull-down menu, just below 'Multiple Lists'.
Commands
All MLM commands can be issued thru a Web Browser or thru a link on email messages. Some of those commands are intended to be used by the subscribers and others by the administrator (you). A subscriber can get the list of available lists, subscribe to a list or unsubscribe from a list. In addition the administrator can also create a list, remove a list, get the contents of one or several lists and get info about the server. Administrator commands are protected with a password.
A command is made of parameters, 'cmd' is the command name and it is required. 'list' is the list name(s), 'email' is the email address involved in the command and 'pwd' is the administrator password. Optional parameters (or parts) are enclosed into brackets. Remove the brackets to include a parameter or remove the parameter and its brackets if you don't want to use it. Do not use a command with optional parameters enclosed into brackets. All commands are delimited with an ampersand but the first one. In fact the script name 'mlm.php' is separated from its parameters with an interrogation sign. There is no specific order for parameters. Parameter '&list=list1[&list2;...]' means you can place one or several lists separated with a semicolon. Some optional parameters can change the command functionality.
All supported commands are listed below:
|
|
Subscribing
|
[All]
|
|
|
|
|
mlm.php?cmd=subscribe&list=list1[;list2;...]&email=email_addr[&pwd=password]
|
|
|
This command when used without the administrator password lets a visitor subscribe itself to one or several lists. When used with the administrator password the command forces the direct subscription of an address to one or several lists bypassing the double opt-in mechanism.
|
|
|
Unsubscribing
|
[All]
|
|
|
|
|
mlm.php?cmd=unsubscribe[&list=list1[;list2;...]]&email=email_addr[&pwd=password]
|
|
|
This command when used without the administrator password lets a visitor unsubscribe itself from one or several lists. When used with the administrator password the command forces the direct unsubscription of an address from one or several lists bypassing the double opt-in mechanism. If no list is submitted the email address will be unsubscribed from all lists.
|
|
|
Getting the available lists
|
[All]
|
|
|
|
|
mlm.php?cmd=lists[&email=email_addr][&pwd=password]
|
|
|
This command when used without the administrator password lets a visitor find out which lists he is subscribed to. When used with the administrator password the command returns detailed information of all lists available on the server, including each list name, recipient count and modification date.
|
|
|
Initializating (mySQL only)
|
[Admin]
|
|
|
|
|
mlm.php?cmd=init&pwd=password
|
|
|
This command allows the administrator to create, if they don't exist, the mySQL database and the list table following the mlm settings file. It is required to run this command once only if you are using mySQL to store your lists.
|
|
|
Getting a subscriber list
|
[Admin]
|
|
|
|
|
mlm.php?cmd=getlist&list=list1[;list2;...]&pwd=password[&output=file]
|
|
|
This command lets the administrator download one or several lists. If you are issuing the command with a web browser, the default output is the current web document. However, you can redirect the output to a file adding the '&output=file' parameter.
|
|
|
Creating lists
|
[Admin]
|
|
|
|
|
mlm.php?cmd=createlist&list=list&pwd=password
|
|
|
This command allows the administrator to create a new list when using text files for list storage. This command is not required as lists are automatically created by commands involving them. If you use mySQL this command will simply create the database and the table (same as Init command).
|
|
|
Removing lists
|
[Admin]
|
|
|
|
|
mlm.php?cmd=removelist&list=list1[;list2;...]&pwd=password
|
|
|
This command allows the administrator to remove one or several lists. This command should be used with extreme care as deleted lists are not recoverable.
|
|
|
Getting info
|
[Admin]
|
|
|
|
|
mlm.php?cmd=getinfo&pwd=password
|
|
|
This command allows the administrator to get valuable info about the server and the script status. It returns the PHP version and the mySQL version if mySQL is being used.
|
|
|
Uninstall
|
[Admin]
|
|
|
|
|
mlm.php?cmd=uninstall&pwd=password
|
|
|
This command allows the administrator to remove all the folders and files created by MLM. In the case you are using mySQL, it will also remove the list table from the database. In other words, the Uninstall command restore MLM back to its initial state. Note that deleted lists are not recoverable.
|
|