aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Mail/Events/BeforeMessageSent.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/Mail/Events/BeforeMessageSent.php')
-rw-r--r--lib/public/Mail/Events/BeforeMessageSent.php39
1 files changed, 39 insertions, 0 deletions
diff --git a/lib/public/Mail/Events/BeforeMessageSent.php b/lib/public/Mail/Events/BeforeMessageSent.php
new file mode 100644
index 00000000000..f528bd11409
--- /dev/null
+++ b/lib/public/Mail/Events/BeforeMessageSent.php
@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Mail\Events;
+
+use OCP\EventDispatcher\Event;
+use OCP\Mail\IMessage;
+
+/**
+ * Emitted before a system mail is sent. It can be used to alter the message.
+ *
+ * @since 19.0.0
+ */
+class BeforeMessageSent extends Event {
+ /** @var IMessage */
+ private $message;
+
+ /**
+ * @param IMessage $message
+ * @since 19.0.0
+ */
+ public function __construct(IMessage $message) {
+ parent::__construct();
+ $this->message = $message;
+ }
+
+ /**
+ * @return IMessage
+ * @since 19.0.0
+ */
+ public function getMessage(): IMessage {
+ return $this->message;
+ }
+}