feat(sharebymail): dispatch BeforeShare*MailSentEvent before each mail send#61948
Open
printminion-co wants to merge 2 commits into
Open
feat(sharebymail): dispatch BeforeShare*MailSentEvent before each mail send#61948printminion-co wants to merge 2 commits into
printminion-co wants to merge 2 commits into
Conversation
6 tasks
printminion-co
force-pushed
the
feat/sharebymail-before-mail-sent-event
branch
from
3391f42 to
d928ae7
Compare
printminion-co
requested review from
Altahrim,
ArtificialOwl,
icewind1991 and
provokateurin
and removed request for
a team
…ateData variables Extract the inline array literals passed to each createEMailTemplate() call into named $templateData variables. For sendNote(), which previously passed no data array, add a minimal array so all four send methods are consistent. Zero behaviour change — $templateData is passed straight through to createEMailTemplate() with identical contents. Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>
…ch mail send
Dispatch a typed PSR-14 event immediately before every mailer->send() call
in ShareByMailProvider so that external listeners can intercept and replace
Nextcloud's native SMTP delivery.
Event hierarchy:
AbstractBeforeShareMailSentEvent (base: share, resolvedEmails, message,
markMailHandled / isMailHandled)
├── BeforeShareMailSentEvent – sendEmail()
├── BeforeSharePasswordMailSentEvent – sendPassword() + sendPasswordToOwner()
└── BeforeShareNoteMailSentEvent – sendNote()
Each concrete class holds its own typed $templateData (psalm array-shape)
and exposes named getters (getSenderUserId(), getFileName(), …) instead of
a generic getMailData(): array<string,mixed>. This avoids defensive
is_string() / null guards in listeners.
$templateData reuses the array already passed to createEMailTemplate(), with
one extra key added for sendEmail(): senderUserId (the raw user ID, distinct
from the display name stored under 'initiator').
The native mailer->send() is skipped when a listener calls markMailHandled().
If the listener's own send throws, the exception propagates and the native
send is also skipped — no silent SMTP fallback.
sendEmail() and sendPassword() are flattened from nested
if (!isMailHandled()) { ... } pyramids to early-return style.
createPasswordSendActivity() in sendPassword() and sendPasswordToOwner() now runs
only when the mail was actually sent: it moved inside the isMailHandled() early
return, so a listener that suppresses the SMTP send no longer produces a false
password-share activity entry.
Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>
printminion-co
force-pushed
the
feat/sharebymail-before-mail-sent-event
branch
from
d928ae7 to
edc6c9c
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
ShareByMailProvidersends share-by-mail notifications straight through the native mailer with noextension point. This adds a typed PSR-14 event dispatched immediately before every
mailer->send(), so an app can intercept and replace delivery (e.g. route through a differenttransport) without patching the provider.
A listener calls
markMailHandled()to take ownership of delivery; the nativemailer->send()isthen skipped. If the listener throws, the exception propagates and the native send is still skipped
— no silent SMTP fallback. With no listener registered, behaviour is unchanged.
Before — native SMTP only
sequenceDiagram participant C as Caller (share flow) participant P as ShareByMailProvider participant M as IMailer C->>P: sendEmail / sendPassword / sendPasswordToOwner / sendNote P->>M: mailer->send(message) M-->>P: failedRecipientsAfter — event dispatched before send
sequenceDiagram participant C as Caller (share flow) participant P as ShareByMailProvider participant D as IEventDispatcher participant L as App listener (optional) participant M as IMailer C->>P: sendEmail / sendPassword / sendPasswordToOwner / sendNote P->>D: dispatchTyped(BeforeShare*MailSentEvent) D->>L: handle(event) alt listener took over delivery L->>L: deliver via own transport L->>P: markMailHandled() Note over P,M: native send skipped, activity not logged else no listener / not handled (default) P->>M: mailer->send(message) M-->>P: failedRecipients endNotes
OCA\ShareByMail\Event\*; each concrete event carries typed getters for thedata already computed before building the
IMessage(no re-derivation in listeners).createPasswordSendActivity()now runs only when the mail is actually sent (moved inside theisMailHandled()guard), so a suppressed password mail no longer logs a false activity entry.TODO
Checklist
apps/sharebymail/tests/ShareByMailProviderTest.phpAI (if applicable)