Mini Mods - Email Reminder for inactive users

AS OF MARCH 16TH 2013 - THIS ADDON IS NO LONGER BEING UPDATED DUE TO INSUFFICIENT TIME AVAILABLE. THANK YOU ALL FOR USING THIS ADDON AND FOR YOUR SUPPORT. IF YOU OR YOU KNOW OF ANYONE THAT WOULD BE ABLE TO PICK UP WHERE I LEFT OFF ON THIS ADDON, PLEASE DO SO. I'M RELEASING THIS ADDON TO THE VBULLETIN COMMUNITY TO UPDATE AS NEEDED.
================================================== =======

What does it do?
=====================================
This mod will send out reminder emails to inactive members to encourage them to come back to your site.

I also want to give full credit and thanks to the developers of the previous versions from which this was derived:
technom8t (Email reminder for inactive users 1.0.0)
C Braithwaite and djbaxter (Email reminder for inactive users v1.2.7)
robertjandreu (Email reminder for inactive users 1.1.3)

*** See Updates section below for new feature list per release. ***

IF YOU HAVE QUESTIONS OR PROBLEMS WITH THE ADDON, PLEASE LET ME KNOW.

PLEASE DON'T FORGET TO CLICK THE INSTALLED LINK!! THANK YOU!!

Features
=====================================
* Turn product on/off.
* Set the number of days a user can be away from your site before being considered inactive. (Default: 30 days)
* Send reminder emails once and once only during any inactive period. (Default: Off)
* Edit maximum number of reminder emails sent totally.
* Set how often an reminder email is sent during an inactive period .
* Set reminder email format - TEXT or HTML.
* Set the reminder email subject. (phrased) (site must be placed in debug mode currently to edit, not translate)
* Set the reminder email body. (phrased) (site must be placed in debug mode currently to edit, not translate)
* Set the usergroups to be sent a reminder email.
* Set userids to exclude.
* Log inactive users that have been sent a reminder.

Install Instructions
--------------------------
This was written specifically for VB4. The VB3.8.x version is here.

IMPORTANT BEFORE YOU INSTALL, IF YOU HAVE A PREVIOUS VERSION INSTALLED I STRONGLY RECOMMEND THAT YOU BACK UP YOUR
CUSTOM REMINDER MESSAGE SUBJECT AND MESSAGE BODY THIS MOD WILL OVER WRITE THEM. ALSO, IN VERSION 2.x, REMINDER
MESSAGE CONTENTS HAS BEEN MOVED TO USING VBPHRASES. LOOK IN THE INSTALL.TXT FILE WITH THIS UPLOAD FOR A LIST OF
PHRASES USED IN THIS MOD.

1. Back up Custom Reminder Email Phrases that you have made.
2. Upload file in the upload folder to the forums folder on your server.
3. In your AdminCP:
a. If you've installed an older version of this mod prior to 1.1.4 you must uninstall it first as well as remove the files that came with it. I can not stress this enough.
b. Go to Plugs & Products -> Product Manager -> Add New Product.
c. Import the product xml from the zip file. (make sure to use overwrite)
4. The mod is disabled by default on install so you will need to enable it. Go to Vbulletin "Settings" -> Options -> Inactivity Reminder Emails.
5. Settings and the inactivity log viewer are also available on the left menu just above the users settings group.

History Log
=======================================
Update 2.2.1
* NEW : New plugin resets inactive members when they return to site.
* FIX : UserID field in inactivity log was showing 0, and UserID was not being added to the optout url.

UpDate 2.2.0
* CHANGE : Inactivity is now based on members Last Activity Date.
* ADD : Exporting the following additional values which can be used in reminder email templates. Check readme.txt in zip file for list of place holders.

Update 2.1.5
* CHANGE : Mod no longer has the option of adding a footer credit to the end of your website.
* CHANGE : Mod no longer has the option of adding a footer credit to outgoing emails.
* CHANGE : New Reminder Optout: Currently this is only accessable from emails being sent out.

Note: Please let members know that they may receive one more email at which time they can choose to optout/unsubscribe by clicking on the embedded link or copying/paste it into
their browser.

* FIX : Reminders were still being sent out incorrectly. I believe this is now fixed finally.
* FIX : Issues when emails were sent out had the incorrect "From" address and listed the host domain name. This should be resolved now.
* FIX : Issue regarding special characters in the usernames being added to the database has been resolve.
* NEW: New data fields have been implimented for keeping track of when reminders are sent out and how many a member has received. If you have a had this mod installed since version 1.1.4, it will look for those fields and rename them so you do not loose previous data in those fields, otherwise new fields will be added.
* NEW: I've added the ability to turn off the admin report. In this version, if it is enabled, you may receive 2 reports. One report for members that have never received a reminder and one for members who haven't received a reminder since the last reminder based on the frequencey setting in the mod settings screen.
* NEW: Reminder's sender and email address are correctly determined now. Should now reflect site name with the webmasteremail address as the reply to.
* CHANGE :Translations for 2.1.1 may not work for versions after since some templates and phrases have been removed.

Update 2.1.1 (6/24/2010) - German Translation - (Thanks Semmi)
Thanks to Semmi for translating the Admin menu, Phrases and Reminder Phrase Templates to German.

Update 2.1.1 (3/30/2010) - Bug Fix
* FIX - Removed extra where clause in query where scheduled task script was performing an update when inactive reminders where based on last post count.
* FIX - Email Phrase Templates - Changed $bburl variable to $forumurl to correct a broken unsubscribe link.
* NEW - Includes tool to reset the date and count of reminder emails that were previously sent to users. This tool is mainly for testing purposes.

Update 2.1.0 (3/26/2010) - Bug Fixs and some new features
* Edit number of emails send totally
* Choose whether inactivity is based on members "Last Post" or their "Last Activity"
* Keep a log of all inactive users contacted
* Opt-Out Feature for members - Include an opt-out link in reminder email. (Thanks to Gene Steinberg)
* Added a link to the bottom of the default email template phrases that members can use to unsubscribe from reminder emails.

Update 2.0.1 (03/15/2010 9:00pm) - Bug Fix
* FIX - Issue related to processing users in a batch configuration. Mod was checking for a field length greater than zero instead of a numeric value greater than zero.

Update 2.0.0 (03/15/2010) - Complete rewrite of mod
* NEW - Can specify number of users to process during nightly scheduled task.
* NEW - Send reminder emails in either text or html format.
* NEW - Email subject and message body uses vb phrase templates. I've included sample content in email phrase templates so all you need to is customize as desired.

Update 1.1.4 (03/05/2010) - Initial release for vBulletin 4.x
* FIX - Would continue to send out email more often than specified intervals due to incorrect setting in cron job.
* NEW - Exclude userids from processing.


IF YOU HAVE QUESTIONS OR PROBLEMS WITH THE ADDON, PLEASE LET ME KNOW. THOSE THAT HAVE NOT INDICATED THE MOD IS INSTALLED WILL BE A LOWER PRIORITY.

PLEASE DON'T FORGET TO CLICK THE INSTALLED LINK!! THANK YOU!!

PLEASE DON'T FORGET TO NOMINATE.

If you like this mod and it has helped your site, and would like to see more features added, please consider donating.
Your support is very much appreciated! Thank you - Thank you

[badawidollah]

thanks

working
it will help my users come back to my forum

[TalkVirginia]

Can anyone tell me what type of mail services or servers you are using? I'm working on a script to automate processing bounced mail. So far I've got information on IMAP and a little on the POP protocols... Any others would be nice. Anyone interested in helping with beta testing please shoot me a PM. I'd like to have a few that would be using each protocol.

Thanks!

[lazerguy_82]

Occasionally I get errors. Is it maybe caused by user names that include the '@' sign?

Database error in vBulletin 4.0.2:

Invalid SQL:
INSERT INTO inactiveuserlog (username,userid,dateline,validemail,email)
VALUES ('Bill 'C'','8323','1270189848','1','someemail@sky.com');

MySQL Error : You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near 'C'','8323','1270189848','1','someemail@sky.com')' at line 2
Error Number : 1064
Request Date : Friday, April 2nd 2010 @ 02:30:48 AM
Error Date : Friday, April 2nd 2010 @ 02:30:48 AM
Script : http://www.
Referrer : http://www.
Username : Unregistered
Classname : vB_Database

[TalkVirginia]

Originally Posted by lazerguy_82

Occasionally I get errors. Is it maybe caused by user names that include the '@' sign?

Database error in vBulletin 4.0.2:

Invalid SQL:
INSERT INTO inactiveuserlog (username,userid,dateline,validemail,email)
VALUES ('Bill 'C'','8323','1270189848','1','someemail@sky.com');

MySQL Error : You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near 'C'','8323','1270189848','1','someemail@sky.com')' at line 2
Error Number : 1064
Request Date : Friday, April 2nd 2010 @ 02:30:48 AM
Error Date : Friday, April 2nd 2010 @ 02:30:48 AM
Script : http://www.
Referrer : http://www.
Username : Unregistered
Classname : vB_Database

Looks like the extra quotes in the username are causing it. There are 2 places to change that should fix it. To fix this manually, do the following:

1. Open the reminderemail.php file in the {forumroot}/includes/cron folder
2. Scroll down and insert the following code after 361, just before the line where $sql = "INSERT INTO " is getting set:

$username = addslashes($username);

3. Save and close the file.

4. Open the inactivitylog.php file in your admincp folder
5. Scroll down to line 133 and replace it with the following line of code.

$username = stripslashes($log['username']);


That should do it. I'll upload a new zip with this fix this weekend.

[lazerguy_82]

Ok thanks! Will that also fix the error if an apostrophe is in the username like this:
Norman O'Neill

That username generated an error as well.

[lazerguy_82]

Btw if I remove your plugin and add the new version, will it resend all the inactive email reminders?

[TalkVirginia]

Originally Posted by lazerguy_82

Ok thanks! Will that also fix the error if an apostrophe is in the username like this:
Norman O'Neill

That username generated an error as well.

Yes, that will escape (add slashes) to special characters such as the apostrophe, single and double quotes, etc that may be in the username.
Stripslash will remove them.

[TalkVirginia]

Originally Posted by lazerguy_82

Btw if I remove your plugin and add the new version, will it resend all the inactive email reminders?

No, all you will need to do is install it as usual, but make sure you use the overwrite so that any new features will be applied. I am doing some clean up in the code and back end such as renaming some of the table fields but the data won't be touched or deleted with exception to the email phrase templates. If you or anyone has customized the email templates that get sent out, I strongly recommend that you keep a copy of them because those will be overwritten. That's just the way the install works.

In the next release, I'm working on
1. Both automated (cron job) and manual processing (clicking on an embedded link) of bounced reminders.
2. Auto PM the user that bounces emails to request that they update their email address.
3. The ability to have the bouncing user moved to a usergroup of the admin's choice
4. The ability to send a reminder to users if they have not posted in x number of days.

I think thats about it unless anyone has any features they would like added.

EDIT: 4/7/2010 - I reread your post and I want to clarify that if you completely uninstall the mod.. yes, you will loose all previous data. If you are upgrading to a new version, just install over top of the current version using vbulletin's overwrite feature. Please let me know if you have additional questions.

[lazerguy_82]

Thanks for the detailed explanation! I have one more question. How do I edit the email templates myself? Every time I click them they open in a new window, but I don't see an edit link.

[lazerguy_82]

As for new version, please add the 'reset pwd' link to one of the emails. I believe the text version doesn't have it.