<!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>[BuddyPress][12688] branches/6.0/src/bp-core/classes/class-bp-phpmailer.php: Emails: ensure compatibility with PHPMailer 6.0</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://buddypress.trac.wordpress.org/changeset/12688">12688</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/12688","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-07-22 19:14:39 +0000 (Wed, 22 Jul 2020)</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'>Emails: ensure compatibility with PHPMailer 6.0
Since version 5.5, WordPress has deprecated version 5.2 of PHPMailer in favor of its 6.0 version. We are using this library for our BP Emails feature. To ensure compatibility with this new version of WordPress as well as with the previous versions we are supporting (4.8 to 5.4), we need to make sure to use the right version of PHPMailer according to the version of WordPress installed.
Props hareesh-pillai, man4toman
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/8322">#8322</a> (6.0 branch)</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches60srcbpcoreclassesclassbpphpmailerphp">branches/6.0/src/bp-core/classes/class-bp-phpmailer.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="branches60srcbpcoreclassesclassbpphpmailerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/6.0/src/bp-core/classes/class-bp-phpmailer.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/6.0/src/bp-core/classes/class-bp-phpmailer.php 2020-07-22 19:12:05 UTC (rev 12687)
+++ branches/6.0/src/bp-core/classes/class-bp-phpmailer.php 2020-07-22 19:14:39 UTC (rev 12688)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -26,6 +26,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function bp_email( BP_Email $email ) {
</span><span class="cx" style="display: block; padding: 0 10px"> static $phpmailer = null;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $phpmailer_is_6_0 = false;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filter PHPMailer object to use.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -38,16 +39,32 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $phpmailer = apply_filters( 'bp_phpmailer_object', $phpmailer );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! ( $phpmailer instanceof PHPMailer ) ) {
- if ( ! class_exists( 'PHPMailer' ) ) {
- require_once ABSPATH . WPINC . '/class-phpmailer.php';
- require_once ABSPATH . WPINC . '/class-smtp.php';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * WordPress 5.5 deprecated version 5.2 of PHPMailer
+ * and is now using version 6.0 of PHPMailer.
+ */
+ if ( file_exists( ABSPATH . WPINC . '/PHPMailer/PHPMailer.php' ) ) {
+ if ( ! ( $phpmailer instanceof PHPMailer\PHPMailer\PHPMailer ) ) {
+ if ( ! class_exists( 'PHPMailer\\PHPMailer\\PHPMailer' ) ) {
+ require_once ABSPATH . WPINC . '/PHPMailer/PHPMailer.php';
+ require_once ABSPATH . WPINC . '/PHPMailer/SMTP.php';
+ require_once ABSPATH . WPINC . '/PHPMailer/Exception.php';
+ }
+
+ $phpmailer = new PHPMailer\PHPMailer\PHPMailer( true );
+ $phpmailer_is_6_0 = true;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } else {
+ if ( ! ( $phpmailer instanceof PHPMailer ) ) {
+ if ( ! class_exists( 'PHPMailer' ) ) {
+ require_once ABSPATH . WPINC . '/class-phpmailer.php';
+ require_once ABSPATH . WPINC . '/class-smtp.php';
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $phpmailer = new PHPMailer( true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $phpmailer = new PHPMailer( true );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="cx" style="display: block; padding: 0 10px"> * Resets.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -58,21 +75,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $phpmailer->clearReplyTos();
</span><span class="cx" style="display: block; padding: 0 10px"> $phpmailer->Sender = '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="cx" style="display: block; padding: 0 10px"> * Set up.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> $phpmailer->IsMail();
</span><span class="cx" style="display: block; padding: 0 10px"> $phpmailer->CharSet = bp_get_option( 'blog_charset' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="cx" style="display: block; padding: 0 10px"> * Content.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> $phpmailer->Subject = $email->get_subject( 'replace-tokens' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $content_plaintext = PHPMailer::normalizeBreaks( $email->get_content_plaintext( 'replace-tokens' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $phpmailer_is_6_0 ) {
+ $content_plaintext = PHPMailer\PHPMailer\PHPMailer::normalizeBreaks( $email->get_content_plaintext( 'replace-tokens' ) );
+ } else {
+ $content_plaintext = PHPMailer::normalizeBreaks( $email->get_content_plaintext( 'replace-tokens' ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $email->get( 'content_type' ) === 'html' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $phpmailer->msgHTML( $email->get_template( 'add-content' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -84,39 +101,80 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $recipient = $email->get_from();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- try {
- $phpmailer->SetFrom( $recipient->get_address(), $recipient->get_name(), false );
- } catch ( phpmailerException $e ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $phpmailer_is_6_0 ) {
+ try {
+ $phpmailer->setFrom( $recipient->get_address(), $recipient->get_name(), false );
+ } catch ( PHPMailer\PHPMailer\Exception $e ) {
+ }
+ } else {
+ try {
+ $phpmailer->SetFrom( $recipient->get_address(), $recipient->get_name(), false );
+ } catch ( phpmailerException $e ) {
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $recipient = $email->get_reply_to();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- try {
- $phpmailer->addReplyTo( $recipient->get_address(), $recipient->get_name() );
- } catch ( phpmailerException $e ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $phpmailer_is_6_0 ) {
+ try {
+ $phpmailer->addReplyTo( $recipient->get_address(), $recipient->get_name() );
+ } catch ( PHPMailer\PHPMailer\Exception $e ) {
+ }
+ } else {
+ try {
+ $phpmailer->addReplyTo( $recipient->get_address(), $recipient->get_name() );
+ } catch ( phpmailerException $e ) {
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $recipients = $email->get_to();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $recipients as $recipient ) {
- try {
- $phpmailer->AddAddress( $recipient->get_address(), $recipient->get_name() );
- } catch ( phpmailerException $e ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $phpmailer_is_6_0 ) {
+ foreach ( $recipients as $recipient ) {
+ try {
+ $phpmailer->AddAddress( $recipient->get_address(), $recipient->get_name() );
+ } catch ( PHPMailer\PHPMailer\Exception $e ) {
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } else {
+ foreach ( $recipients as $recipient ) {
+ try {
+ $phpmailer->AddAddress( $recipient->get_address(), $recipient->get_name() );
+ } catch ( phpmailerException $e ) {
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $recipients = $email->get_cc();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $recipients as $recipient ) {
- try {
- $phpmailer->AddCc( $recipient->get_address(), $recipient->get_name() );
- } catch ( phpmailerException $e ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $phpmailer_is_6_0 ) {
+ foreach ( $recipients as $recipient ) {
+ try {
+ $phpmailer->AddCc( $recipient->get_address(), $recipient->get_name() );
+ } catch ( PHPMailer\PHPMailer\Exception $e ) {
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } else {
+ foreach ( $recipients as $recipient ) {
+ try {
+ $phpmailer->AddCc( $recipient->get_address(), $recipient->get_name() );
+ } catch ( phpmailerException $e ) {
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $recipients = $email->get_bcc();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $recipients as $recipient ) {
- try {
- $phpmailer->AddBcc( $recipient->get_address(), $recipient->get_name() );
- } catch ( phpmailerException $e ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $phpmailer_is_6_0 ) {
+ foreach ( $recipients as $recipient ) {
+ try {
+ $phpmailer->AddBcc( $recipient->get_address(), $recipient->get_name() );
+ } catch ( PHPMailer\PHPMailer\Exception $e ) {
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } else {
+ foreach ( $recipients as $recipient ) {
+ try {
+ $phpmailer->AddBcc( $recipient->get_address(), $recipient->get_name() );
+ } catch ( phpmailerException $e ) {
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $headers = $email->get_headers();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -124,7 +182,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $phpmailer->AddCustomHeader( $name, $content );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires after PHPMailer is initialised.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -137,14 +194,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-includes/pluggable.php */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action_ref_array( 'phpmailer_init', array( &$phpmailer ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- try {
- return $phpmailer->Send();
- } catch ( phpmailerException $e ) {
- return new WP_Error( $e->getCode(), $e->getMessage(), $email );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $phpmailer_is_6_0 ) {
+ try {
+ return $phpmailer->Send();
+ } catch ( PHPMailer\PHPMailer\Exception $e ) {
+ return new WP_Error( $e->getCode(), $e->getMessage(), $email );
+ }
+ } else {
+ try {
+ return $phpmailer->Send();
+ } catch ( phpmailerException $e ) {
+ return new WP_Error( $e->getCode(), $e->getMessage(), $email );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="cx" style="display: block; padding: 0 10px"> * Utility/helper functions.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre>
</div>
</div>
</body>
</html>