Add email notifications for new quote events #2303

pfefferle · 2025-10-09T09:10:24Z

Implements email notifications when a user's post is quoted, including user and blog-level settings, email template, and tests. Updates admin and settings UI to allow enabling/disabling quote notifications. Adds comprehensive PHPUnit tests for the new notification logic.

Proposed changes:

Adds email notification functionality for quote events with user and blog-level settings
Creates a new email template specifically for quote notifications
Implements comprehensive PHPUnit test coverage for the notification logic

Other information:

Have you written new tests for your changes, if applicable?

Testing instructions:

Checkout on a test site
Quote a blog-post with a mastodon user
Check Mail

Changelog entry

Automatically create a changelog entry from the details below.

Changelog Entry Details

Significance

Patch
Minor
Major

Type

Added - for new features
Changed - for changes in existing functionality
Deprecated - for soon-to-be removed features
Removed - for now removed features
Fixed - for any bug fixes
Security - in case of vulnerabilities

Message

Added email notifications for quoted posts, with user and blog-level settings and a new customizable email template.

Implements email notifications when a user's post is quoted, including user and blog-level settings, email template, and tests. Updates admin and settings UI to allow enabling/disabling quote notifications. Adds comprehensive PHPUnit tests for the new notification logic.

Copilot

Pull Request Overview

This PR implements email notifications when a user's post is quoted on the Fediverse. The feature adds comprehensive notification settings for both individual users and blog-level configurations, along with a dedicated email template and extensive test coverage.

Adds email notification functionality for quote events with user and blog-level settings
Creates a new email template specifically for quote notifications
Implements comprehensive PHPUnit test coverage for the notification logic

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
includes/class-mailer.php	Adds new `quote()` method for handling quote notification emails with proper user preference checks
templates/emails/new-quote.php	New email template for quote notifications with embedded content display
includes/wp-admin/class-user-settings-fields.php	Adds quote notification checkbox to user settings interface
includes/wp-admin/class-blog-settings-fields.php	Adds quote notification checkbox to blog settings interface
includes/wp-admin/class-settings.php	Registers new blog-level quote notification setting
includes/wp-admin/class-admin.php	Includes quote notification setting in user options processing
includes/class-activitypub.php	Registers quote notification user meta field with proper defaults
tests/phpunit/tests/includes/class-test-mailer.php	Comprehensive test coverage for quote notification functionality
tests/phpunit/tests/includes/handler/class-test-quote-request.php	Adds `preferredUsername` field to test actor data

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

includes/class-mailer.php

templates/emails/new-quote.php

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Replaces a line comment with a PHPDoc-style comment for the 'mention' action hook to improve code documentation consistency.

Replaces all @Covers ::quoted annotations with @Covers ::quote in class-test-mailer.php to accurately reflect the method being tested.

includes/class-mailer.php

templates/emails/new-quote.php

Co-authored-by: Konstantin Obenland <obenland@gmx.de>

Updated block comments for clarity and consistency in the mailer class. Simplified the quote URL assignment by using null coalescing, improving code readability.

Co-authored-by: Konstantin Obenland <obenland@gmx.de>

includes/class-mailer.php

templates/emails/new-quote.php

Simplified the wording in the notification email when a post is quoted on the Fediverse. The message is now more direct and concise.

Adds a check to return early if $quoted_url is not set, avoiding further processing and potential errors when quoteUrl is missing in the activity object.

obenland · 2025-10-10T20:34:29Z

A couple more thoughts on this:

A quote post represents a reblog at the same time, triggering email notifications for the new "comment". We should either not send the reblog notification or… figure something else out that doesn't result in two emails for the same action. (Including Dotcom)
The quote-url-only case, where there is no object to embed is still a mystery to me. In that case we don't seem to link to the quoting post either, just display the URL of the post that was quoted? Do we not have the URL of the quote post? (if we do, we should fetch it and embed it 🙂)

- Fetch remote quote object when only URL is available - Support both 'quote' (FEP-044f) and 'quoteUrl' properties - Simplify email template to use pre-prepared variables - Add direct link to quoted post for better user experience - Improve plaintext alternative message formatting

- Use activitypub_pre_http_get_remote_object filter for mocking - Template expects quote_object to always be an array from mailer - All 1116 tests pass successfully

obenland · 2025-10-14T14:55:04Z

Mailer::quote() and the quote template should be ready now. I think it's reasonable to expect that we'll always have a post to embed, similar to DM and Mention emails.

The two remaining items of uncertainty for me:

We have tests for create activities triggering Quote email notifications and account for Notes with quoteurl properties, but we're not currently wired in to trigger quote email notifications on Create. What should be done there?
A quote post represents a reblog at the same time, triggering email notifications for the new "comment". We should either not send the reblog notification or… figure something else out that doesn't result in two emails for the same action. (Including Dotcom)

pfefferle · 2025-10-15T08:57:05Z

@obenland Mastodon does not send an Announce in the case of a Quote, so there is no duplication.

pfefferle · 2025-10-15T13:01:30Z

We could add Quotes as Comments though. This way we could re-use (update) the comment Mails.

obenland · 2025-10-15T13:25:10Z

Mastodon does not send an Announce in the case of a Quote, so there is no duplication.

You don't get reblog comment notifications in your testing?

pfefferle · 2025-10-15T13:31:44Z

No, not even live!

pfefferle · 2025-10-15T13:33:28Z

@obenland have you clicked repost and quote?

pfefferle · 2025-10-15T13:46:06Z

(because you can do both actions on the same item)

obenland · 2025-10-15T15:38:44Z

Not that I know of. It gives me two options and I clicked quote.

obenland · 2025-10-15T15:42:56Z

We could add Quotes as Comments though. This way we could re-use (update) the comment Mails.

Yeah not sure I have an opinion on that, tbh, I'd just go with your preference on this.

pfefferle · 2025-10-15T18:55:16Z

@obenland can you try to reproduce if you receive two mails or not? I tried it several times and can not reproduce it.

obenland · 2025-10-15T20:18:07Z

Interesting, I can't reproduce it anymore, no. Checking that off the list.

obenland · 2025-10-15T20:18:53Z

We have tests for create activities triggering Quote email notifications and account for Notes with quoteurl properties, but we're not currently wired in to trigger quote email notifications on Create.

What should we do with that?

pfefferle requested a review from Copilot October 9, 2025 09:10

pfefferle self-assigned this Oct 9, 2025

github-actions bot added [Feature] Notifications [Feature] WP Admin [Status] In Progress [Tests] Includes Tests labels Oct 9, 2025

Copilot AI reviewed Oct 9, 2025

View reviewed changes

includes/class-mailer.php Outdated Show resolved Hide resolved

templates/emails/new-quote.php Outdated Show resolved Hide resolved

pfefferle and others added 2 commits October 9, 2025 11:13

Update includes/class-mailer.php

e8703fc

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update templates/emails/new-quote.php

9434ff8

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

pfefferle marked this pull request as ready for review October 9, 2025 09:13

Add changelog

06fd4b0

pfefferle requested a review from obenland October 9, 2025 09:25

pfefferle added 2 commits October 9, 2025 11:31

Update comment style for mention action hook

30ddfbe

Replaces a line comment with a PHPDoc-style comment for the 'mention' action hook to improve code documentation consistency.

Update @Covers annotations from quoted to quote

1795260

Replaces all @Covers ::quoted annotations with @Covers ::quote in class-test-mailer.php to accurately reflect the method being tested.

obenland reviewed Oct 9, 2025

View reviewed changes

pfefferle and others added 5 commits October 9, 2025 15:42

Update includes/class-mailer.php

b369c92

Co-authored-by: Konstantin Obenland <obenland@gmx.de>

Refactor comments and quote URL assignment in mailer

ee8c1c2

Updated block comments for clarity and consistency in the mailer class. Simplified the quote URL assignment by using null coalescing, improving code readability.

Update templates/emails/new-quote.php

7bd5426

Co-authored-by: Konstantin Obenland <obenland@gmx.de>

Update includes/class-mailer.php

ccbed26

Co-authored-by: Konstantin Obenland <obenland@gmx.de>

Merge branch 'trunk' into add/quote-notification

097dffb

obenland reviewed Oct 9, 2025

View reviewed changes

includes/class-mailer.php Show resolved Hide resolved

templates/emails/new-quote.php Outdated Show resolved Hide resolved

pfefferle requested a review from obenland October 9, 2025 15:19

pfefferle added 4 commits October 9, 2025 17:46

Update email message for new quote notification

70fde38

Simplified the wording in the notification email when a post is quoted on the Fediverse. The message is now more direct and concise.

Merge branch 'trunk' into add/quote-notification

31de72c

Merge branch 'trunk' into add/quote-notification

422caa1

Prevent processing when quoted_url is empty

0b8fd5e

Adds a check to return early if $quoted_url is not set, avoiding further processing and potential errors when quoteUrl is missing in the activity object.

obenland force-pushed the add/quote-notification branch from 10c9c14 to 0b8fd5e Compare October 10, 2025 20:29

Improve quote notification email with post references (#2310)

b78c9a1

obenland added 3 commits October 14, 2025 09:21

Assume we always have a post to embed

86bac33

Update quote notification tests to properly mock remote object fetching

6545041

- Use activitypub_pre_http_get_remote_object filter for mocking - Template expects quote_object to always be an array from mailer - All 1116 tests pass successfully

Merge branch 'trunk' into add/quote-notification

97af2ef

Merge branch 'trunk' into add/quote-notification

1892282

pfefferle mentioned this pull request Oct 17, 2025

Add support for quote comments and improve quote detection #2330

Draft

11 tasks

pfefferle closed this Oct 17, 2025

github-actions bot removed the [Status] In Progress label Oct 17, 2025

Add email notifications for new quote events #2303

Add email notifications for new quote events #2303

Uh oh!

Conversation

pfefferle commented Oct 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes:

Other information:

Testing instructions:

Changelog entry

Significance

Type

Message

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

obenland commented Oct 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

obenland commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pfefferle commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pfefferle commented Oct 15, 2025

Uh oh!

obenland commented Oct 15, 2025

Uh oh!

pfefferle commented Oct 15, 2025

Uh oh!

pfefferle commented Oct 15, 2025

Uh oh!

pfefferle commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

obenland commented Oct 15, 2025

Uh oh!

obenland commented Oct 15, 2025

Uh oh!

pfefferle commented Oct 15, 2025

Uh oh!

obenland commented Oct 15, 2025

Uh oh!

obenland commented Oct 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

pfefferle commented Oct 9, 2025 •

edited

Loading

obenland commented Oct 10, 2025 •

edited

Loading

obenland commented Oct 14, 2025 •

edited

Loading

pfefferle commented Oct 15, 2025 •

edited

Loading

pfefferle commented Oct 15, 2025 •

edited

Loading