Administrative and Maintenance Tools - Auto Bounce Messages Management

Brought to you by Syrian Medical Society & Milado

Introduction: quoted from wikipedia with adaptation.
Any long-lived forums is going to eventually contain addresses that can't be reached. Addresses that were once valid can become unusable because the person receiving the mail there has switched to a different provider (possibly as a result of changing jobs or schools). In another scenario, the address may still exist but be abandoned, with unread mail accumulating until there is not enough room left to accept any more.

The presence of invalid addresses in the forums results in bounce messages being sent to the owner of the forums. If the mailing list is small, the owner can read the bounce messages and manually remove the invalid addresses from the forums. With a larger forums, this is a tedious, unpleasant job, so it is desirable to automate the process.

In short: This hack automates handling of the bounce messages.


Requirements:

• vBulletin 3.7.1
• catch-all email address, with POP3 access. (I use Google app (Gmail))

Features:

• Auto Bounce Messages Management.
• Uses POP3 protocol to retrieve messages from your catch-all email box.
• On bounce detection the user will be moved to bounce usergroup (you can set which usergroup).
• Works according to VERP.

A note:
I believe there is no need to delete the user subscriptions. because once a user got moved to the "Awaiting email confirmation" usergroup, he / she won't be sent any additional emails.

How Does It Work?
You have your catch-all email box, that will be used to receive the bounce messages. Of course we must have a POP3 access to retrieve messages from it.
Let's suppose that your catch-all email address is bounces@yourdomain.ext
After we set it properly, it will work as described below:
1) By default: On every single message being sent, vBulletin generates a unique Message-ID for it, example:

Message-ID: <20080608103128.551e45224330@www.yourdomain.ext>

This ID is generated By using the following code in /includes/class_mail.php:

PHP Code:

$msgid = '<' . gmdate('YmdHis') . '.' . substr(md5($message . microtime()), 0, 6) . vbrand(100000, 999999) . '@' . $http_host . '>'; 


I take the red portion from the unique Message-ID, and the red portion from the domain name of the catch-all address:

Message-ID: <20080608103128.551e45224330@www.yourdomain.ext>

bounces@yourdomain.ext

The result will be:

bounce20080608103128.551e45224330@yourdomain.ext

Now every single message has its own unique envelope-from address. so if it gets returned as a bounce, I will recognize it easily.
So every message will be recorded in the database. each record consists of : toemail, bounceemail (the one we generated) and the timeline (for sake of pruning.)
2) A cron job runs every ten minutes to retrieve bounce messages from the catch-all email box.
If the message sent to something similar to the bounceemail we generate, it will update the appropriate record in the database to be marked as returned. and delete the message from the POP3 server.
3) Another cron job runs once an hour, reads the bounced emails from the database and moves their owners to an usergroup which is determined by the admin from the settings.
4) Yet another cron job, will run once daily, to prune the records that haven't returned bounces in a settable period of time (30 days by default).

Did I miss something here?
Yeh, right. this is the first beta, I believe the core is almost done. but there may be some functions to add, and few things to tweak.
I'm all opened to your suggestions. So feel free to dream!

Installation & Upgrade:
1) Have your own catch-all email with POP3 access. I don't have the time to write a how-to article for this please do it yourself, you'll be luckily if someone explains it to others.
2) Upload files from the /upload/ folder in the package to their appropriate locations.
3) Install the xml product file: product-bounce_management.xml, of course choose yes to override when upgrading.
4) Refresh your AdminCP. you will see at the navigation side, above the Users tab, a new tab called "Bounces Management"
5) At that tab, go to the settings: Set your POP server settings, your "Bounce Usergroup" and "Exclude Usergroups".
6) At the same tab you will find a link called "Test POP Connection" to test the connection with your POP server.
7) Enjoy! Click install to let me enjoy too!

Settings:
Attachment 81933

Know issues:
- In rare situations, a vacation reply may returned via the bounce path rather than the webmaster path.


Change log:

• 1.0.0.b.1 first public release, on June, 8 2008.

Support:
The product marked as not supported, but that doesn't mean you won't see me again here.
So please try to help each other.

License & Credits:
1) I use the pop3_class from Manuel Lemos, Copyright (c) 1999-2005 to retrieve messages from the POP server, so all the credits regarding this go to him.
Here is his license (included in the package too):

Copyright (c) 1999-2005, Manuel Lemos
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of the Manuel Lemos nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Click install to receive updates.
You like it? nominate it. I'm looking forward to enter the Mod Of The Month competition.
I depend on you.
Also donations will help me to improve the product. :up:

[stwilson]

Still not able to get this working. I have configured all the settings and have verified the bounced message has the appropriate string in it but the usergroup is not changed, even after the chron job is run manually.

Can anyone confirm this mod has worked for them?

[mrahul]

isn't it possible to track down all emails automatically if the email bounces more than thrice the system stops sending mails to the non-active mails ?

[Alfa1]

If a member is placed into the bounced usergroup and then updates his/her email address, will the member be placed back in his/her original usergroup?

[djilou]

3)Another cron job runs once an hour, reads the bounced emails from the database and moves their owners to an usergroup which is determined by the admin from the settings.
4) Yet another cron job, will run once daily, to prune the records that haven't returned bounces in a settable period of time (30 days by default).

Why I don't see those cron jobs on the Scheduled Tasks ??
I see only : ABMM: Retrive Bounces
This Scheduled Task retrieves the bounced emails from the server every ten minutes.

[Milad]

Originally Posted by djilou

Why I don't see those cron jobs on the Scheduled Tasks ??
I see only : ABMM: Retrive Bounces
This Scheduled Task retrieves the bounced emails from the server every ten minutes.

Two cron jobs run as plug-ins in other cron jobs.

[djilou]

Edit : never mind the cron job didn't work because of this

Originally Posted by AngelBlue

I've added some code so that bouncing users now get:
* Popup PM notification set to YES
* Receive admin emails set to NO
* Recieve email PM notification set to NO
* Thread subscription mode set to "no email" (if it was previously set to instant, daily or weekly email)
* All their thread and forum subscriptions set to 'no email'.
* A PM to explain the above.

To do this, I replaced the code in your "Move Users To Bounce Usergroup" plugin with this:

$bounces = $vbulletin->db->query_read("
	SELECT messageid, toemail
	FROM " . TABLE_PREFIX . "sent_email
	WHERE bounced = 1
");

if ($vbulletin->db->num_rows($bounces) > 0)
{
	$toemails = array();
	$messageids = array();
	
	while ($bounce = $vbulletin->db->fetch_array($bounces))
	{
		$toemails[] = "'" . $bounce['toemail'] . "'";
		$messageids[] = $bounce['messageid'];
	}
	$toemails = array_unique($toemails);

	// start added code here... define data for PM data manager

	$tonames = array();
	$touids = array();
	$fromuser = fetch_userinfo(1);
	$message = "We tried to deliver an email to you, but unfortunately, it bounced. To prevent us sending more mail to you while your email provider is not accepting it, we have deactivated all the email-related features of your account. To reactivate your account, go to your UserCP, and update your email address. You will then get a confirmation email. Clicking on the link in this confirmation email should re-enable your account, at which point you will need to visit your UserCP options page to re-enable the email notifications you wish to use.";

	$affected = $vbulletin->db->query_read("SELECT userid,username FROM " . TABLE_PREFIX . "user WHERE email IN (" . implode(', ', $toemails) . ")");
	while ($affected = $vbulletin->db->fetch_array($affected)) {
		$tonames[] = $affected['username'];
		$touids[] = $affected['userid'];
	}
	$tonames = array_unique($tonames);
	$pmdm =& datamanager_init('PM', $vbulletin, ERRTYPE_SILENT);
	$pmdm->set('fromuserid', '1');
	$pmdm->set('fromusername', 'EmailBot');
	$pmdm->set_info('reciept', false);
	$pmdm->set_info('savecopy', false);
	$pmdm->set('title', 'Email Broken!');
	$pmdm->set('message', $message);
	$pmdm->set_recipients(implode(";",$tonames), $fromuser['permissions']);
	$pmdm->set('dateline', TIMENOW);
	$pmdm->save();

	
	
	// this is stock mod code to move them to the different usergroup.
	$vbulletin->db->query_write("UPDATE " . TABLE_PREFIX . "user SET usergroupid = " .  $vbulletin->options['bm_usergroup'] . ", membergroupids = '', displaygroupid = 0 WHERE usergroupid NOT IN (" . $vbulletin->options['bm_excludeusergroups'] . ") AND email IN (" . implode(', ', $toemails) . ")");

	// and stock code to delete their message tracking info...
	$vbulletin->db->query_write("DELETE FROM " . TABLE_PREFIX . "sent_email WHERE messageid IN (" . implode(', ', $messageids) . ")");

	// continue custom code to update their user options...
	// stop them generating any more email!

	// pm popup = YES
	$vbulletin->db->query_write("UPDATE " . TABLE_PREFIX . "user SET pmpopup = 1 WHERE email IN (" . implode(', ', $toemails) . ")");
	
	// send notification email on PM - NO
	$vbulletin->db->query_write("UPDATE " . TABLE_PREFIX . "user SET options = (options - 4096) WHERE (options & 4096) AND email IN (" . implode(', ', $toemails) . ")");

	// admin email OFF
	$vbulletin->db->query_write("UPDATE " . TABLE_PREFIX . "user SET options = (options - 16) WHERE (options & 16) AND email IN (" . implode(', ', $toemails) . ")");

	// set autosubscribe = without email WHERE autosubscribe_with_email
	$vbulletin->db->query_write("UPDATE " . TABLE_PREFIX . "user SET autosubscribe = 1 WHERE (autosubscribe > 1) AND email IN (" . implode(', ', $toemails) . ")");

	// set emailupdates = 0 for their thread subscriptions
	$vbulletin->db->query_write("UPDATE " . TABLE_PREFIX . "subscribethread SET emailupdate = 0 WHERE (emailupdate > 0) AND userid IN (" . implode(', ', $touids) . ")");

	// set emailupdates = 0 for their forum subscriptions
	$vbulletin->db->query_write("UPDATE " . TABLE_PREFIX . "subscribeforum SET emailupdate = 0 WHERE (emailupdate > 0) AND userid IN (" . implode(', ', $touids) . ")");

	// finish
	unset($toemails, $messageids);
}

$vbulletin->db->free_result($bounces);

[testebr]

When will the final version be released?

[scsa20]

I'm trying to set this up and when I test the connection to the pop server, I get the following error message:

110 could not connect to the host "pop.gmail.com": Connection timed out

what am I possibly doing wrong?

[psylenced]

Can this mod read the message ID directly out of the email source?

If it can wouldn't it be easier to read this rather than creating an individual email address for each user or email sent.

Originally Posted by scsa20

I'm trying to set this up and when I test the connection to the pop server, I get the following error message:

110 could not connect to the host "pop.gmail.com": Connection timed out

what am I possibly doing wrong?

Have you enabled pop in your settings on gmail? Also if you read their help it might give you a different address - maybe you've typed it wrong..

[scsa20]

no, the pop is turned on, and it's the correct address it told me to use, and set the port to 995, still gives me the error.