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

[Tize.]

I am understand you TalkVirginia.
Thank you very much for your reply and for your help.

Regards from canary Islands in Spain.

[TalkVirginia]

Originally Posted by Tize.

I am understand you TalkVirginia.
Thank you very much for your reply and for your help.

Regards from canary Islands in Spain.

Great! If you have additional questions, please feel free to ask. I'm happy to help.

[Tize.]

Thank you very much friend, you are very kind and a great programmer.
Greetings.

[Alibass]

@TalkVirginia

Check your PM's

[shyguy82]

Originally Posted by TalkVirginia

You're correct to a point. It's not 1 hour and 30 mins, it actually means that the cron job will run every day at 1:30 in the morning.

Based on a tutorial I checked out just to confirm my understanding. If you look at this chart, it will show that the cron job is laid out like this:

minute hour [day of month] [Month] [Day of Week]

Field Locations and Meaning:

1.Minute (0-59)
2.Hour (0-23)
3.Day of month (1-31)
4.Month (1-12, Jan, Feb, ...)
5.Day of week (0-6) 0 = Sunday, 1 = Monday, ... or Sun, Mon, etc)
6.Command to execute





I would strongly recommend resetting it back to process at midnight or in the early morning hours. You may want to check with your host provider and see if there is a limit to now many emails you can send at one time. I imagine it would also depend on how you have vBulletin itself configured. Do you use the mailqueue or do you send email out immediately? I haven't worked with large amounts like that before so I don't know what your hosting situation you have or what it will support. To be on the safe side till more can be determined I'd try small batches of maybe 100 - 200 then increase it by 100 or so.




Members get an inactivity grace period... which a site admin would set to 1 or more days. This means that a user would have to be inactive for that number of days before they would receive their first reminder email. In the example above, users would have to be inactive for 30 days. They would receive an email reminder on their 31st day.



Depending on what you have set in this field. If for instance you have 7, this would send out a reminder every 7 days until that user logs back in and/or posts a message.

Does this answer your questions and/or concerns? Please let me know if you have any other questions.

WOW!!!! What a detailed response, thank you SO much, now this makes sense. I've set the number of emails to be 150 for now, I have a dedicated server. I already spoke to my provider and they said, as long as your users are opt-in, this shouldn't be an issue. So I'll try this setting for a few days, see how it goes and maybe gradually increase the number of emails.

Again, thank you SO much for your response and this MOD. Rating this mod as +++++++ al the way.

By the way, do you write any mods for hire by any chance? I have a requirement and unfortunately Im not proficient in PHP, my background is .NET.

[TalkVirginia]

Originally Posted by shyguy82

WOW!!!! What a detailed response, thank you SO much, now this makes sense. I've set the number of emails to be 150 for now, I have a dedicated server. I already spoke to my provider and they said, as long as your users are opt-in, this shouldn't be an issue. So I'll try this setting for a few days, see how it goes and maybe gradually increase the number of emails.

Again, thank you SO much for your response and this MOD. Rating this mod as +++++++ al the way.

By the way, do you write any mods for hire by any chance? I have a requirement and unfortunately Im not proficient in PHP, my background is .NET.

You're very welcome! Sounds like it's all on the right track. Regarding the opt-in part, v2.1.0 defaults all users to opt-in, so they receive the initial reminder emails. If they decide they want to opt-out they can do so under General Settings in there usercp down at the bottom. Uncheck the option to receive reminder emails from administrator and they are good to go. Also, there is an unsubscribe link in the footer of the default reminder email template. There is a slight bug in it however. It says $bburl/misc.php?do=unsub&u=$userid The $bburl should be $forumurl instead. Anyway, users can click this to optout as well.

As for mods for hire, I've been interested in going that route, but shoot me a pm with your requirements, etc and I'd be happy to talk with you about it. We can go from there.

[TalkVirginia]

Thanks to Alibass to for pointing this out to me. An bug was found in the script that is executed during the cron job. If you have your reminder emails based on last post the script will crash due to an extra "Where" clause in the update query. An oversight on my part. I guess that is what happens when you have only had 4 hours sleep in the last couple days. If you would like to apply the fix, it's very easy to do. I'll apply the fix on my end and release an update as soon as I can.

Here the fix:

1. In your favorite text editor, open the reminderemail.php file in your forumroot/includes/cron/ folder.

2. Scroll down to line 210 where you will see this:

PHP Code:


$sql .= " WHERE lastactivity < '$inactivity_graceperiod' AND emailDate < '$lastemail' "; 


Remove the line and resave. You should be good to go at that point.

For those of you that don't feel comfortable modifying the file, I've attached a fixed file here. Just download and drop it into your cron folder overwriting the old one.

If you have any questions, or need assistance, as always feel free to ask.

[Tize.]

Item supremme!!
Works good!! 100% Fine, today i am received the eMail .

Thank you very much TalkVirginia.

[Tize.]

Nominate!!!!

[TalkVirginia]

Originally Posted by Tize.

Nominate!!!!

Thank you!