<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[11562] sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums: Support Forums: 'unroll' forum subscription emails, sending an individual email per recipient rather than BCC'ing them all together.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/11562">11562</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/11562","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-02-16 05:04:32 +0000 (Wed, 16 Feb 2022)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Support Forums: 'unroll' forum subscription emails, sending an individual email per recipient rather than BCC'ing them all together.
See <a href="http://meta.trac.wordpress.org/ticket/5505">#5505</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginssupportforumsincclasspluginphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-plugin.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginssupportforumsincclassstatsphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-stats.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginssupportforumssupportforumsphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/support-forums.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginssupportforumsincclassemailsphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-emails.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginssupportforumsincclassemailsphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-emails.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-emails.php (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-emails.php 2022-02-16 05:04:32 UTC (rev 11562)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,109 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+namespace WordPressdotorg\Forums;
+
+/**
+ * Support Forum Email modifications.
+ *
+ * This filters outgoing bbPress emails to 'unroll' subscription emails from a set of BCC's to individual emails.
+ */
+class Emails {
+
+ public function __construct() {
+ // Forum subscribers. This is also for Term (Plugin/Theme/Tag) subscriptions new topics.
+ add_action( 'bbp_pre_notify_forum_subscribers', [ $this, 'start_unroll' ] );
+ add_action( 'bbp_post_notify_forum_subscribers', [ $this, 'stop_unroll' ] );
+
+ // Topic subscribers. This is also for Term (Plugin/Theme/Tag) subscriptions new replies.
+ add_action( 'bbp_pre_notify_subscribers', [ $this, 'start_unroll' ] );
+ add_action( 'bbp_post_notify_subscribers', [ $this, 'stop_unroll' ] );
+ }
+
+ /**
+ * Attached to the filter to start filtering outgoing emails on.
+ */
+ public function start_unroll() {
+ add_filter( 'pre_wp_mail', [ $this, 'pre_wp_mail_unroll' ], 1, 2 );
+ }
+
+ /**
+ * Attached to the filter to stop filtering outgoing emails on.
+ */
+ public function stop_unroll() {
+ remove_filter( 'pre_wp_mail', [ $this, 'pre_wp_mail_unroll' ], 1 );
+ }
+
+ /**
+ * Unroll wp_mail() BCC'd emails into individual emails.
+ */
+ public function pre_wp_mail_unroll( $filter_return, $attrs ) {
+ static $recursive = false;
+ // Short circuit if we're the one who called wp_mail().
+ if ( $recursive ) {
+ return $filter_return;
+ }
+
+ $attrs = wp_parse_args(
+ $attrs,
+ [
+ 'to' => [],
+ 'subject' => '',
+ 'message' => '',
+ 'headers' => [],
+ 'attachments' => [],
+ ]
+ );
+
+ if ( ! is_array( $attrs['headers'] ) ) {
+ $attrs['headers'] = explode( "\n", str_replace( "\r\n", "\n", $attrs['headers'] ) );
+ }
+
+ // Pull out CC's and BCC's to a separate array.
+ foreach ( $attrs['headers'] as $i => $header ) {
+ if ( ! str_contains( $header, ':' ) ) {
+ return;
+ }
+
+ list( $name, $value ) = explode( ':', trim( $header ), 2 );
+ $name = strtolower( trim( $name ) );
+
+ if ( 'cc' === $name || 'bcc' === $name ) {
+ unset( $attrs['headers'][ $i ] );
+ $dest_emails[] = trim( $value );
+ }
+ }
+
+ $no_reply = apply_filters( 'bbp_subscription_to_email', bbp_get_do_not_reply_address() );
+ $dest_emails = is_array( $attrs['to'] ) ? $attrs['to'] : explode( ',', $attrs['to'] );
+ // Remove the noreply email, it was probably set as the $to address.
+ $dest_emails = array_diff( $dest_emails, [ $no_reply ] );
+
+ // This shouldn't happen, but if it does, let wp_mail() do it's thing instead.
+ // NOTE: We still process if there was only one to/cc/bcc address, to ensure the below custom filter gets run.
+ if ( empty( $dest_emails ) ) {
+ return $filter_return;
+ }
+
+ // Prevent recursive calls.
+ $recursive = true;
+ foreach ( $dest_emails as $to ) {
+ // The to is always the current recipient.
+ $attrs['to'] = $to;
+
+ // Filter for w.org plugins to personalize emails.
+ $attrs = apply_filters( 'wporg_bbp_subscription_email', $attrs );
+
+ $filter_return = wp_mail(
+ $attrs['to'],
+ $attrs['subject'],
+ $attrs['message'],
+ $attrs['headers'],
+ $attrs['attachments']
+ );
+ }
+
+ $recursive = false;
+
+ // We've sent the emails, we return the last emails result here, even tho calling function probably won't look at it.
+ return $filter_return;
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-emails.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginssupportforumsincclasspluginphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-plugin.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-plugin.php 2022-02-15 22:30:42 UTC (rev 11561)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-plugin.php 2022-02-16 05:04:32 UTC (rev 11562)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -44,6 +44,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->report_topic = new Report_Topic;
</span><span class="cx" style="display: block; padding: 0 10px"> $this->nsfw_handler = new NSFW_Handler;
</span><span class="cx" style="display: block; padding: 0 10px"> $this->stats = new Stats;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->emails = new Emails;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // These modifications are specific to https://wordpress.org/support/
</span><span class="cx" style="display: block; padding: 0 10px"> $blog_id = get_current_blog_id();
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginssupportforumsincclassstatsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-stats.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-stats.php 2022-02-15 22:30:42 UTC (rev 11561)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-stats.php 2022-02-16 05:04:32 UTC (rev 11562)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4,6 +4,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Some basic Statistics for forum actions.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * These are very ad-hoc and added on an as-needed basis.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * No user-specific detail is stored, only that a `key: value` action occurred `x` times.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class Stats {
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginssupportforumssupportforumsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/support-forums.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/support-forums.php 2022-02-15 22:30:42 UTC (rev 11561)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/support-forums.php 2022-02-16 05:04:32 UTC (rev 11562)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -27,6 +27,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> include( dirname( __FILE__ ) . '/inc/class-report-topic.php' );
</span><span class="cx" style="display: block; padding: 0 10px"> include( dirname( __FILE__ ) . '/inc/class-nsfw-handler.php' );
</span><span class="cx" style="display: block; padding: 0 10px"> include( dirname( __FILE__ ) . '/inc/class-stats.php' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+include( dirname( __FILE__ ) . '/inc/class-emails.php' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Compat-only includes.
</span><span class="cx" style="display: block; padding: 0 10px"> include( dirname( __FILE__ ) . '/inc/class-dropin.php' );
</span></span></pre>
</div>
</div>
</body>
</html>