Change "From" email address for GDPR request confirmation email

[zaffarn]

Hi

Is there a way to change the "From" email address for GDPR personal data export request confirmation email, currently when a request is generated through tools -> Export Personal Data, it sends a request confirmation email however the from email is "Wordpress@…" is it possible to change to something like "info@…"

b/w

[desrosj]

@zaffarn thanks for the ticket, and welcome to Trac!

The from email for privacy related emails is the default email used by wp_mail(). You can filter this email and name using wp_mail_from and wp_mail_from_name respectively.

Can you tell me more about your use case? If you need all other site emails to come from the default address and all privacy emails to come from another, that may be a good instance to look into adding a filter of some sort.

[zaffarn]

Hi

Thanks for the swift response, we currently have set "Email address" of wordpress in "Setting - General" as "Info@…" however this works for all other plugins but not this one, this functionality seems to send emails from "Wordpress@…".

With regards to your question are there any uses cases where we may need to use a separate email address, the short answer is yes, normally most automated emails sent by WP can be sent using the generic default email address, however for GDPR request (we) would like to use a different one specifically created for all GDPR requests such as "DPO@…" or "gdpr@…" so that we can keep track of all replies etc easily.

best wishes

[garrett-eclipse]

Hi @zaffarn thank you for the feedback. I definitely see the validity of having the from_email filterable for Privacy requests.

I'm sorry this ticket was raised in our team chat and I missed updating it afterwards.

It was agreed to look into a filter for the reply-to and from email addresses as we felt filtering them specifically would be very helpful for organizations with a DPO as you mentioned.

After reviewing some core implementations it appears the best way to accomplish this would be to introduce the email header as filterable and pass it along to wp_mail. As currently using thewp_mail_from and wp_mail_from_name filters would affect all email since those filters are unaware it's for a privacy request.

Two coding examples of this;
Pass Change Email - ​https://github.com/WordPress/WordPress/blob/e0c4e5b610bd0453b649f02c514f6eadc059e5be/wp-includes/user.php#L1974-L2011
Email Change Email - ​https://github.com/WordPress/WordPress/blob/6073c6e209f3877c2d4291f76e3cb3db1c874a99/wp-includes/functions.php#L6342-L6388

I'll look into this further when I have time.

[xkon]

I'll see if I can get a patch on this tomorrow, this will be nice for 5.4 and doesn't seem complicated :).

[xkon]

44501.diff​ introduces 4 new hooks to allow the filtering of all the privacy-related e-mails.

It will now be possible to change the From addresses on these emails as it's common to have a different address for DPO purposes.

All filters contain equal data and an easy way to test would be:

<?php

function my_privacy_mail_headers( $headers, $subject, $content, $request_id, $email_data ) {

	$headers = array(
		'From: My Name <myname@example.com>',
	);

	return $headers;
}
add_filter( 'user_request_action_email_headers', 'my_privacy_mail_headers', 10, 5 );
add_filter( 'user_request_confirmed_email_headers', 'my_privacy_mail_headers', 10, 5 );
add_filter( 'user_erasure_complete_email_headers', 'my_privacy_mail_headers', 10, 5 );
add_filter( 'wp_privacy_personal_data_email_headers', 'my_privacy_mail_headers', 10, 5 );

I'll be looking into adding unit tests also asap.

[xkon]

44501.2.diff​ also adds the necessary unit tests.

[xkon]

minor edit - correcting the descriptions of unit tests

[xkon]

@garrett-eclipse can you take a look here for a quick 2nd test? Patch still applies fine along with unit tests.

According to my tests, I'm ok for marking this for commit as it's easier to change the headers this way per-email but it would be good to get a 2nd look. Feel free to mark it if all good :-).

[garrett-eclipse]

Minor refresh to correct some docblocks

[garrett-eclipse]

Thanks @xkon this worked really nicely, some very minor tweaks in 44501.4.diff

1. In the user_request_confirmed_email_headers docblock corrected the mention of $email_text as it's $content that's used. And updated the $email_data block to match the expected for that email.
2. Updated the description for user_erasure_complete_email_headers, and the $email_data contents to match the email.
3. Updated user_request_action_email_headers to swap $email_text for $content.

Unit tests worked nicely and all my tests cleared (I appreciate the testing code made things simple)

Marking for final review.

[SergeyBiryukov]

In 47279:

Privacy: Introduce filters for the headers of all the privacy-related e-mails:

• wp_privacy_personal_data_email_headers
• user_request_confirmed_email_headers
• user_erasure_complete_email_headers
• user_request_action_email_headers

Props xkon, garrett-eclipse, zaffarn, desrosj.
Fixes #44501.

[garrett-eclipse]

Dev Note: ​https://make.wordpress.org/core/2020/03/02/privacy-updates-in-5-4/