Changeset 6919

Timestamp:

11/06/2019 12:02:53 AM (4 years ago)

Author:

johnjamesjacoby

Message:

Emails: chunk notification emails into 40 Bcc'd recipients.

This commit introduces the bbp_mail subfilter, used to target bbPress specific emails in conjunction with bbp_get_email_header() to help identify emails that came specifically from bbPress actions.

The purpose of this change is to help forum owners avoid their outbound emails being marked as spam, due to the high number of users that can be subscribed to any given forum or topic.

This change (combined with r6725) goes a long way towards improving the success of subscription emails reaching their intended recipients.

Fixes #3260. Props danielbachhuber.

Location:

trunk/src/includes

Files:

• common/functions.php (modified) (9 diffs)
• core/filters.php (modified) (4 diffs)
• core/sub-actions.php (modified) (1 diff)

trunk/src/includes/common/functions.php

@@ -1132 +1132 @@
     /** Headers ***************************************************************/
 
+    // Default bbPress X-header
+    $headers    = array( bbp_get_email_header() );
+
     // Get the noreply@ address
     $no_reply   = bbp_get_do_not_reply_address();
@@ -1139 +1142 @@
 
     // Setup the From header
-    $headers = array( 'From: ' . get_bloginfo( 'name' ) . ' <' . $from_email . '>' );
+    $headers[]  = 'From: ' . get_bloginfo( 'name' ) . ' <' . $from_email . '>';
 
     // Loop through addresses
@@ -1152 +1155 @@
     $to_email = apply_filters( 'bbp_subscription_to_email',     $no_reply );
 
+    // Before
     do_action( 'bbp_pre_notify_subscribers', $reply_id, $topic_id, $user_ids );
 
@@ -1157 +1161 @@
     wp_mail( $to_email, $subject, $message, $headers );
 
+    // After
     do_action( 'bbp_post_notify_subscribers', $reply_id, $topic_id, $user_ids );
 
@@ -1294 +1299 @@
     /** Headers ***************************************************************/
 
+    // Default bbPress X-header
+    $headers    = array( bbp_get_email_header() );
+
     // Get the noreply@ address
     $no_reply   = bbp_get_do_not_reply_address();
@@ -1301 +1309 @@
 
     // Setup the From header
-    $headers = array( 'From: ' . get_bloginfo( 'name' ) . ' <' . $from_email . '>' );
+    $headers[] = 'From: ' . get_bloginfo( 'name' ) . ' <' . $from_email . '>';
 
     // Loop through addresses
@@ -1314 +1322 @@
     $to_email = apply_filters( 'bbp_subscription_to_email',     $no_reply );
 
+    // Before
     do_action( 'bbp_pre_notify_forum_subscribers', $topic_id, $forum_id, $user_ids );
 
@@ -1319 +1328 @@
     wp_mail( $to_email, $subject, $message, $headers );
 
+    // After
     do_action( 'bbp_post_notify_forum_subscribers', $topic_id, $forum_id, $user_ids );
 
@@ -1416 +1426 @@
     // Filter & return
     return apply_filters( 'bbp_get_email_addresses_from_user_ids', $retval, $user_ids, $limit );
+}
+
+/**
+ * Automatically splits bbPress emails with many Bcc recipients into chunks.
+ *
+ * This middleware is useful because topics and forums with many subscribers
+ * run into problems with Bcc limits, and many hosting companies & third-party
+ * services limit the size of a Bcc audience to prevent spamming.
+ *
+ * The default "chunk" size is 40 users per iteration, and can be filtered if
+ * desired. A future version of bbPress will introduce a setting to more easily
+ * tune this.
+ *
+ * @since 2.6.0 (r6918)
+ *
+ * @param array $args Original arguments passed to wp_mail().
+ * @return array
+ */
+function bbp_chunk_emails( $args = array() ) {
+
+    // Get the maximum number of Bcc's per chunk
+    $max_num = apply_filters( 'bbp_get_bcc_chunk_limit', 40, $args );
+
+    // Look for "bcc: " in a case-insensitive way, and split into 2 sets
+    $match       = '/^bcc: (\w+)/i';
+    $old_headers = preg_grep( $match, $args['headers'], PREG_GREP_INVERT );
+    $bcc_headers = preg_grep( $match, $args['headers'] );
+
+    // Bail if less than $max_num recipients
+    if ( empty( $bcc_headers ) || ( count( $bcc_headers ) < $max_num ) ) {
+        return $args;
+    }
+
+    // Reindex the headers arrays
+    $old_headers = array_values( $old_headers );
+    $bcc_headers = array_values( $bcc_headers );
+
+    // Break the Bcc emails into chunks
+    foreach ( array_chunk( $bcc_headers, $max_num ) as $i => $chunk ) {
+
+        // Skip the first chunk (it will get used in the original wp_mail() call)
+        if ( 0 === $i ) {
+            $first_chunk = $chunk;
+            continue;
+        }
+
+        // Send out the chunk
+        $chunk_headers = array_merge( $old_headers, $chunk );
+
+        // Recursion alert, but should be OK!
+        wp_mail(
+            $args['to'],
+            $args['subject'],
+            $args['message'],
+            $chunk_headers,
+            $args['attachments']
+        );
+    }
+
+    // Set headers to old headers + the $first_chunk of Bcc's
+    $args['headers'] = array_merge( $old_headers, $first_chunk );
+
+    // Return the reduced args, with the first chunk of Bcc's
+    return $args;
+}
+
+/**
+ * Return the string used for the bbPress specific X-header.
+ *
+ * @since 2.6.0 (r6919)
+ *
+ * @return string
+ */
+function bbp_get_email_header() {
+    return apply_filters( 'bbp_get_email_header', 'X-bbPress: ' . bbp_get_version() );
 }
 

trunk/src/includes/core/filters.php

@@ -40 +40 @@
 add_filter( 'request',                 'bbp_request',            10    );
 add_filter( 'template_include',        'bbp_template_include',   10    );
+add_filter( 'wp_mail',                 'bbp_mail',               10, 3 );
 add_filter( 'wp_title',                'bbp_title',              10, 3 );
 add_filter( 'body_class',              'bbp_body_class',         10, 2 );
@@ -69 +70 @@
 
 /**
+ * Emails
+ *
+ * bbPress sends emails for a few different reasons, largely related to user
+ * notifications or account changes. Because the `wp_mail` filter can be a
+ * crowded space, the `bbp_mail` subfilter should be used in conjunction with
+ * bbp_get_email_header() to narrow the results to only bbPress emails.
+ */
+add_filter( 'bbp_mail', 'bbp_chunk_emails' );
+
+/**
  * Feeds
  *
@@ -84 +95 @@
  * bbp_template_include() works and do something similar. :)
  */
-add_filter( 'bbp_template_include',   'bbp_template_include_theme_supports', 2, 1 );
-add_filter( 'bbp_template_include',   'bbp_template_include_theme_compat',   4, 2 );
+add_filter( 'bbp_template_include', 'bbp_template_include_theme_supports', 2, 1 );
+add_filter( 'bbp_template_include', 'bbp_template_include_theme_compat',   4, 2 );
 
 // Filter bbPress template locations
-add_filter( 'bbp_get_template_stack', 'bbp_add_template_stack_locations'          );
+add_filter( 'bbp_get_template_stack', 'bbp_add_template_stack_locations' );
 
 // Links
@@ -97 +108 @@
 
 // wp_filter_kses on new/edit forum/topic/reply title
-add_filter( 'bbp_new_forum_pre_title',  'wp_filter_kses'  );
-add_filter( 'bbp_new_reply_pre_title',  'wp_filter_kses'  );
-add_filter( 'bbp_new_topic_pre_title',  'wp_filter_kses'  );
-add_filter( 'bbp_edit_forum_pre_title', 'wp_filter_kses'  );
-add_filter( 'bbp_edit_reply_pre_title', 'wp_filter_kses'  );
-add_filter( 'bbp_edit_topic_pre_title', 'wp_filter_kses'  );
+add_filter( 'bbp_new_forum_pre_title',  'wp_filter_kses' );
+add_filter( 'bbp_new_reply_pre_title',  'wp_filter_kses' );
+add_filter( 'bbp_new_topic_pre_title',  'wp_filter_kses' );
+add_filter( 'bbp_edit_forum_pre_title', 'wp_filter_kses' );
+add_filter( 'bbp_edit_reply_pre_title', 'wp_filter_kses' );
+add_filter( 'bbp_edit_topic_pre_title', 'wp_filter_kses' );
 
 // Prevent posting malicious or malformed content on new/edit topic/reply

trunk/src/includes/core/sub-actions.php

@@ -524 +524 @@
     return (array) apply_filters( 'bbp_map_meta_caps', $caps, $cap, $user_id, $args );
 }
+
+/**
+ * Filter the arguments used by wp_mail for bbPress specific emails
+ *
+ * @since 2.6.0 bbPress (r6918)
+ *
+ * @param array $args A compacted array of wp_mail() arguments, including the "to" email,
+ *                    subject, message, headers, and attachments values.
+ *
+ * @return array Array of capabilities
+ */
+function bbp_mail( $args = array() ) {
+
+    // Bail if headers are missing/malformed
+    if ( empty( $args['headers'] ) || ! is_array( $args['headers'] ) ) {
+        return $args;
+    }
+
+    // Header to search all headers for
+    $bbp_header = bbp_get_email_header();
+
+    // Bail if no bbPress header found
+    if ( false === array_search( $bbp_header, $args['headers'], true ) ) {
+        return $args;
+    }
+
+    // Filter & return
+    return (array) apply_filters( 'bbp_mail', $args );
+}