Changeset 10941 for trunk/src/bp-groups/bp-groups-notifications.php

Timestamp:

07/10/2016 09:46:27 PM (10 years ago)

Author:

djpaul

Message:

Emails: add unsubscribe feature.

Updates the unsubscribe token to link to a new unsubscribe action handler.

All emails from other platforms or popular websites have a unsubscribe link. For previous versions of BuddyPress, our unsubscribe link pointed to that user's notifications page. However, if someone creates an account on a BuddyPress with a fraudulent email address (for example), that email address' owner will not know the account's authentication details, and so have no way to unsubscribe from that "spam" email.

The change implements a new action handler which accepts unsubscription requests from un-authenticated requests. It adds an new option containing a dynamically generated salt which is used to generate the hash on the unsubscribe link.

Fixes #6932

Props tharsheblows, DJPaul

File:

• trunk/src/bp-groups/bp-groups-notifications.php (modified) (10 diffs)

trunk/src/bp-groups/bp-groups-notifications.php

@@ -69 +69 @@
                 }
 
+                $unsubscribe_args = array(
+                        'user_id'           => $user_id,
+                        'notification_type' => 'groups-details-updated',
+                );
+
                 $args = array(
                         'tokens' => array(
@@ -76 +81 @@
                                 'group.url'    => esc_url( bp_get_group_permalink( $group ) ),
                                 'group.name'   => $group->name,
+                                'unsubscribe'  => esc_url( bp_email_get_unsubscribe_link( $unsubscribe_args ) ),
                         ),
                 );
@@ -116 +122 @@
                         'secondary_item_id' => $requesting_user_id,
                         'component_name'    => buddypress()->groups->id,
-                        'component_action'  => 'new_membership_request'
+                        'component_action'  => 'new_membership_request',
                 ) );
         }
@@ -124 +130 @@
                 return;
         }
+
+        $unsubscribe_args = array(
+                'user_id'           => $admin_id,
+                'notification_type' => 'groups-membership-request',
+        );
 
         $group = groups_get_group( array( 'group_id' => $group_id ) );
@@ -137 +148 @@
                         'requesting-user.id'   => $requesting_user_id,
                         'requesting-user.name' => bp_core_get_user_displayname( $requesting_user_id ),
+                        'unsubscribe'          => esc_url( bp_email_get_unsubscribe_link( $unsubscribe_args ) ),
                 ),
         );
@@ -185 +197 @@
 
         if ( ! empty( $accepted ) ) {
+
+                $unsubscribe_args = array(
+                        'user_id'           => $requesting_user_id,
+                        'notification_type' => 'groups-membership-request-accepted',
+                );
+
+                $args['tokens']['unsubscribe'] = esc_url( bp_email_get_unsubscribe_link( $unsubscribe_args ) );
+
                 bp_send_email( 'groups-membership-request-accepted', (int) $requesting_user_id, $args );
+
         } else {
+
+                $unsubscribe_args = array(
+                        'user_id'           => $requesting_user_id,
+                        'notification_type' => 'groups-membership-request-rejected',
+                );
+
+                $args['tokens']['unsubscribe'] = esc_url( bp_email_get_unsubscribe_link( $unsubscribe_args ) );
+
                 bp_send_email( 'groups-membership-request-rejected', (int) $requesting_user_id, $args );
         }
@@ -226 +255 @@
                 return;
         }
+
+        $unsubscribe_args = array(
+                'user_id'           => $user_id,
+                'notification_type' => 'groups-member-promoted',
+        );
 
         $group = groups_get_group( array( 'group_id' => $group_id ) );
@@ -236 +270 @@
                         'promoted_to' => $promoted_to,
                         'user.id'     => $user_id,
+                        'unsubscribe' => esc_url( bp_email_get_unsubscribe_link( $unsubscribe_args ) ),
                 ),
         );
@@ -278 +313 @@
 
         $invited_link = bp_core_get_user_domain( $invited_user_id ) . bp_get_groups_slug();
+
+        $unsubscribe_args = array(
+                'user_id'           => $invited_user_id,
+                'notification_type' => 'groups-invitation',
+        );
+
         $args         = array(
                 'tokens' => array(
@@ -287 +328 @@
                         'inviter.id'   => $inviter_user_id,
                         'invites.url'  => esc_url( $invited_link . '/invites/' ),
+                        'unsubscribe'  => esc_url( bp_email_get_unsubscribe_link( $unsubscribe_args ) ),
                 ),
         );