Changeset 12913

Timestamp:

04/28/2021 11:49:31 PM (4 years ago)

Author:

dcavins

Message:

BP_Optout: Prevent bp_send_email() delivery to opted-out address.

In BP_Email::validate() ensure that the recipient has
not opted out from communications from this site.

See #8448.

Location:

trunk

Files:

• src/bp-core/classes/class-bp-email.php (modified) (1 diff)
• tests/phpunit/testcases/core/optouts.php (modified) (1 diff)

trunk/src/bp-core/classes/class-bp-email.php

@@ -1000 +1000 @@
         }
 
+        // Has the user opted out of receiving any email from this site?
+        $recipient_to       = $this->get_to();
+        $recipient_to_first = array_shift( $recipient_to );
+        $recipient_address  = $recipient_to_first->get_address();
+        if ( bp_user_has_opted_out( $recipient_address ) ) {
+            $retval = new WP_Error( 'user_has_opted_out', __( 'The email recipient has opted out from receiving communication from this site.', 'buddypress' ), $recipient_address );
+        }
+
         /**
          * Filters whether the email passes basic validation checks.

trunk/tests/phpunit/testcases/core/optouts.php

@@ -182 +182 @@
     }
 
+    public function test_bp_optout_prevents_bp_email_send() {
+        $old_current_user = get_current_user_id();
+
+        $u1 = $this->factory->user->create();
+        $this->set_current_user( $u1 );
+        // Create an opt-out.
+        $args = array(
+            'email_address'     => 'test2@example.com',
+            'user_id'           => $u1,
+            'email_type'        => 'annoyance'
+        );
+        $i1 = bp_add_optout( $args );
+        $email = new BP_Email( 'activity-at-message' );
+        $email->set_from( 'test1@example.com' )->set_to( 'test2@example.com' )->set_subject( 'testing' );
+        $email->set_content_html( 'testing' )->set_tokens( array( 'poster.name' => 'example' ) );
+
+        $this->assertTrue( is_wp_error( $email->validate() ) );
+        $this->set_current_user( $old_current_user );
+    }
+
 }