IONOS(sharebymail): add BeforeShare*MailSentEvent dispatched before each mail send (HDNEXT-1010)

[printminion-co]

Summary

Introduces a PSR-14 event hook inside ShareByMailProvider that allows app-layer listeners to replace the native Nextcloud SMTP path for share-by-mail notifications.

New event classes in apps/sharebymail/lib/Event/

• AbstractBeforeShareMailSentEvent — abstract base carrying the fully-prepared IMessage, validated recipient list, pre-computed mail data, and a markMailHandled() flag
• BeforeShareMailSentEvent — fired by sendEmail() before the share-link notification send
• BeforeSharePasswordMailSentEvent — fired by sendPassword() and sendPasswordToOwner() before password emails
• BeforeShareNoteMailSentEvent — fired by sendNote() before note-update emails

How the replacement mechanism works

When a listener calls $event->markMailHandled(), the native mailer->send() is skipped. If the listener's own send throws, the exception propagates — native send is also skipped. No silent fallback. When no listener is active, native SMTP runs as before.

mailData array

Each send method passes the data it already computed before building the IMessage. Listeners read $event->getMailData() instead of re-deriving from the share, avoiding duplicate user/node lookups.

BeforeShareMailSentEvent carries: senderUserId, fileName, resourceUrl, note, expiration (\DateTime|null).

Dispatch point

Events fire inside each private send method immediately before mailer->send() — covering both Manager::createShare() and sendShareEmail() Controller paths without touching either.

Related PRs

• feat(HDNEXT-1010): intercept file-request send-email via IONOS mailer API nc-ionos-processes#17 — IONOS listener that handles `BeforeShareMailSentEvent
• Created upstream PR feat(sharebymail): dispatch BeforeShare*MailSentEvent before each mail send nextcloud/server#61948

Test plan

• apps/sharebymail/ unit tests pass
• E2E: file request → send email via UI → IONOS API called; no native SMTP
• E2E: regular share by email → IONOS API called once; no double-send
• E2E: disable nc_ionos_processes → native SMTP resumes without code changes

[tanyaka]

Code review

Found 2 issues:

1. createPasswordSendActivity() fires unconditionally when mail is suppressed by a listener

In both sendPassword() and sendPasswordToOwner(), createPasswordSendActivity() is called outside the if (!$event->isMailHandled()) guard. This means every time the companion listener (nc-ionos-processes) calls markMailHandled() to intercept a password email, an activity-log entry is still written for a mail that was never sent by the native mailer. sendEmail() avoids this by using an early return instead, so no side effects run after the flag is set.

nc-server/apps/sharebymail/lib/ShareByMailProvider.php

Lines 499 to 514 in 6b86f4e

	}
	$message->useTemplate($emailTemplate);
	$event = new BeforeSharePasswordMailSentEvent($share, $emails, $message, $templateData);
	$this->eventDispatcher->dispatchTyped($event);
	if (!$event->isMailHandled()) {
	$failedRecipients = $this->mailer->send($message);
	if (!empty($failedRecipients)) {
	$this->logger->error('Share password mail could not be sent to: ' . implode(', ', $failedRecipients));
	return false;
	}
	}
	$this->createPasswordSendActivity($share, $shareWith, false);
	return true;
	}

nc-server/apps/sharebymail/lib/ShareByMailProvider.php

Lines 641 to 650 in 6b86f4e

	$event = new BeforeSharePasswordMailSentEvent($share, [$initiatorEMailAddress], $message, $templateData);
	$this->eventDispatcher->dispatchTyped($event);
	if (!$event->isMailHandled()) {
	$this->mailer->send($message);
	}
	$this->createPasswordSendActivity($share, $shareWith, true);
	return true;
	}

2. BeforeShareNoteMailSentEvent has no test coverage

The PR adds test expectations for BeforeShareMailSentEvent and BeforeSharePasswordMailSentEvent via withConsecutive, but BeforeShareNoteMailSentEvent is never imported in the test file and the sendNote() dispatch path has no corresponding dispatchTyped expectation. The sendNote() event firing and its markMailHandled() bypass are therefore unverified.

nc-server/apps/sharebymail/tests/ShareByMailProviderTest.php

Lines 24 to 26 in 6b86f4e

	use OCP\Mail\IMessage;
	use OCA\ShareByMail\Event\BeforeShareMailSentEvent;
	use OCA\ShareByMail\Event\BeforeSharePasswordMailSentEvent;

nc-server/apps/sharebymail/tests/ShareByMailProviderTest.php

Lines 363 to 370 in 6b86f4e

	->willReturn('autogeneratedPassword');
	$this->eventDispatcher->expects($this->exactly(3))
	->method('dispatchTyped')
	->withConsecutive(
	[new GenerateSecurePasswordEvent()],
	[$this->isInstanceOf(BeforeShareMailSentEvent::class)],
	[$this->isInstanceOf(BeforeSharePasswordMailSentEvent::class)],
	);

🤖 Generated with Claude Code

_{- If this code review was useful, please react with 👍. Otherwise, react with 👎.}

[Copilot]

Pull request overview

Adds PSR-14 “BeforeShare*MailSentEvent” hooks to apps/sharebymail so app-layer listeners can intercept share-by-mail outgoing messages and optionally suppress the native mailer->send() path.

Changes:

• Dispatch BeforeShareMailSentEvent, BeforeSharePasswordMailSentEvent, and BeforeShareNoteMailSentEvent immediately before sending share-by-mail notifications.
• Refactor mail template input into $templateData arrays that are passed to both createEMailTemplate() and the dispatched events.
• Extend unit tests to assert event dispatch and “handled” behavior.

Reviewed changes

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

Show a summary per file

File	Description
apps/sharebymail/lib/ShareByMailProvider.php	Dispatches new events before mailer->send() in share, password, note, and owner-password flows.
apps/sharebymail/lib/Event/AbstractBeforeShareMailSentEvent.php	Introduces shared event base with message, recipients, and “handled” flag.
apps/sharebymail/lib/Event/BeforeShareMailSentEvent.php	Adds event for share-link notification email sends.
apps/sharebymail/lib/Event/BeforeSharePasswordMailSentEvent.php	Adds event for password email sends (recipient + owner flows).
apps/sharebymail/lib/Event/BeforeShareNoteMailSentEvent.php	Adds event for note-update email sends.
apps/sharebymail/tests/ShareByMailProviderTest.php	Updates expectations for added dispatches and adds tests for note + handled password scenarios.
apps/sharebymail/composer/composer/autoload_static.php	Updates classmap to include new event classes.
apps/sharebymail/composer/composer/autoload_classmap.php	Updates classmap to include new event classes.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.