BroadcastByEmail Software Help

BroadcastByEmail Web Module (bbemod) enables Voicent BroadcastByEmail software to communicate with a web site and its database. Specifically, it provides email subscribe/unsubscribe web pages, managing these email addresses in a mysql database, and stores email open tracking data.

This module should be installed on your web site.

Before you begin the install, there are few things you need to have and do. You need access to your site and its directory and software to proceed with the installation. These are: access to your web server (via shell or FTP); a text editor; an FTP Client; your web browser of choice.

Your web server should support PHP and MySQL database.

The short instruction is listed here. For a detailed description, please see Detailed Instructions section listed below.

• Download and unzip the bbemod package if you haven't already.
• Create a database for bbemod on your web server, as well as a MySQL user who has all privileges for accessing and modifying it.
• Edit the includes\class.config.php file
• Open class.config.php file in a text editor and fill in the correct information listed under TODO
• Upload the bbemod files in the desired location on your web server.
• Run the bbemod installation script by accessing install.php in a web browser.

That's it! bbemod should now be installed.

Step 1. Download And Extract

Download the BroadcastByPhone Web Module to your computer and unzip the package.

Step 2. Create the Database and a User

If your hosting provider supplies the cPanel hosting control panel, you may follow these simple instructions to create your bbemod username and database.

• Log in to your cPanel.
• Click MySQL Database Wizard icon under the Databases section.
• In Step 1. Create a Database enter the database name and click Next Step.
• In Step 2. Create Database Users enter the database user name and the password. Make sure to use a strong password. Click Create User.
• In Step 3. Add User to Database click the All Privileges checkbox and click Next Step.
• In Step 4. Complete the task note the database name and user. Write down the values of hostname, username, databasename, and the password you chose. (Note that hostname will usually be localhost.)

If your web server has phpMyAdmin installed, you may follow these simple instructions to create your bbemod username and database.

• Log in to your phpMyAdminl.
• If a database relating to bbemod does not already exist in the Database dropdown on the left, create one: Choose a name for your bbemod database, enter it in the Create new database field, and click Create.
• Click the Home icon in the upper left to return to the main page, then click Privileges. If a user relating to bbemod does not already exist in the list of users, create one: Click Add a new User. Chose a username for bbemod and enter it in the User name field. (Be sure Use text field: is selected from the dropdown.) Choose a password and enter it in the Password field. (Be sure Use text field: is selected from the dropdown.) Re-enter the password in the Re-type field. Leave all options under Global privileges at their defaults. Click Go.
• Return to the Privileges screen and click the Check privileges icon on the user you've just created for bbemod. In the Database-specific privileges section, select the database you've just created for bbemod under the Add privileges to the following database dropdown. The page will refresh with privileges for that database. Click Check All to select all privileges, and click Go.
• On the resulting page, make note of the host name listed after Server: at the top of the page. (This will usually be localhost.)
• Write down the values of hostname, username, databasename, and the password you chose.

Step 3. Edit class.config.php File

Open class.config.php file in a text editor and fill in the correct information below TODO.

• Find the line: private $productionServers = array('/^your-domain\.com$/'); change 'your-domain' to your site's name. e.g. if your site is 'acme.com', replace 'your-domain' with 'acme'
• Find the line: define('WEB_ROOT', '/bbemod'); change the /bbemod to the folder name you will install the module; leave it unchanged if you will keep the folder name as 'bbemod'
• Find the following lines and enter the appropriate values you saved in step 2. $this->dbReadHost = 'localhost'; // database host $this->dbName = ''; // database name for bbemod $this->dbReadUsername = ''; // database user name $this->dbReadPassword = ''; // database user password
• Save the file

Step 4. Upload the Files

Use an FTP client to upload the unzipped bbemod directory to your desired location within the root directory of your web site. Please note if you change the directory name to something other than 'bbemod', you must change the WEB_ROOT value as described in step 3.

Step 5. Run the Install Script

Point a web browser to start the installation script. If you placed the bbemod files in a subdirectory under the root directory, for example, you should visit: http://example.com/bbemod/install.php