Reminder Plug-In
From Emailworks Wiki / Documentation
Contents |
What is Reminder plug-in?
Reminder plug-in helps you to set emails to be sent at specific dates based on subscriber information. It makes easy to schedule emails to be sent on subscriber birthdays, anniversaries or payment periods.
Benefits
- Easy installation and use
- Ability to send HTML/plain emails with image embedded and file attachments
- Ability to send reminder emails before or after 'x' days
Installation
Follow these easy steps to complete installation process:
- Download Reminder plug-in from your client area > downloads section
- Unzip the package on your desktop
- Upload contents of "upload" directory your Emailworks Maillist Manager/plugins directory on your server
- Login to the administrator area of your Emailworks Maillist Manager
- Click "Settings > Plug-In Manager" link
- Click"Enable" button of Reminder Plug-In item
- Go to "User Groups" and edit user groups that you want to give permission for this plug-in
- Check "Reminder plug-in" permission in Plug-In Permissions section
Quick Start Guide
Reminder plug-in is a user side plug-in which means only users can access this plug-in through the user area. Users will be able to access this plug-in if the user group has permission to access.
Accessing Reminder Section
After logging into Emailworks Maillist Manager user area, move your mouse over "Manage" link on the top menu and you will see the "Reminders" link.
Once "Reminders" menu item is clicked, you will be redirected to Reminder browse page. If you have created Reminders before, you will see the list of your reminders in this page. Otherwise, list will be empty until you create a new Reminder.
Creating Reminders
In order to create a new reminder request, simply click "Create new reminder" link on the browse screen. Emailworks Maillist Manager will display you a window asking for reminder details. All fields in this window are required to fill in:
- Reminder Name
- Name your reminder. Example: Happy Birthday
- Target List
- Select the list which will be monitored for this reminder
- Choose Field
- Select the field to assign to the reminder. The custom field must be set as "Date validation enabled" in custom field details.
- Send Every
- Select the reminder frequency. You can send reminders monthly or yearly
- Send
- Select the day to send emails. You can send the reminder email on time, before or after x days
- Select or create the email content to send
Browsing Reminder Log
You can see the list of reminder emails which are sent so far. In the reminder list page, click "Reminder activity log" link under one of the reminders and you will see the list of email addresses that have received the reminder email so far. Click "Clear activity log" link to empty the activity list.
Setting CRON Job For Reminder Email Delivery
In order to automate monitoring and reminder email delivery, you will need to add another cron job on your server similar to Emailworks Maillist Manager CRON Settings
Reminder plug-in cron jobs can be found under /Emailworks Maillist Manager_directory/plugins/octremonder/cli/ directory. There are two cron job files:
- reminder_send.php
- web_reminder_send.php
"reminder_send.php" is a PHP CLI module which can be executed through your server shell with php interpreter or setting it as executable.
"web_reminder_send.php is a web browser version of reminder_send.php which can be executed with curl/wget through the shell or via your web browser.
Installing reminder_send.php CRON Job
- Type the following command to edit the existing CRON jobs.
crontab –e - Add the following new CRON jobs by typing it out.
* * * * * php -d safe_mode=off -f /path/to/Emailworks/plugins/octreminder/cli/reminder_send.php >/dev/null - Now Save the file and crontab should report – Installing New Crontab
Installing web_reminder_send.php CRON Job
- Type the following command to edit the existing CRON jobs.
crontab –e - Add the following new CRON jobs by typing it out.
* * * * * curl -s -o http://yoursite.com/Emailworks Maillist Manager/plugins/octreminder/cli/web_reminder_send.php >/dev/null - Now Save the file and crontab should report – Installing New Crontab
That’s it - you are done with the CRON setup and the server will execute the three jobs every minute.
Setting Up Pricing For Reminder Email Deliveries (ESP Edition)
Emailworks Maillist Manager ESP Edition owners set reminder emails to be included in user payment reports. In order to enable this feature, follow these steps:
- Login to Emailworks Maillist Manager administrator area
- Click "Settins > Reminder Plug-In Settings" link
- Set "Charge Per Reminder Emails Sent" setting to "Enabled"
That's all. Once this setting is saved, all outgoing reminder emails will be included in user payment reporting under "Campaign Emails Sent" title. Do not forget to enable payment feature in user group details and set pricing range(s) for number of campaign emails sent.
Thanks for using Reminder plug-in.
