diff options
Diffstat (limited to 'lib/public/Mail/Provider/IMessageSend.php')
-rw-r--r-- | lib/public/Mail/Provider/IMessageSend.php | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/lib/public/Mail/Provider/IMessageSend.php b/lib/public/Mail/Provider/IMessageSend.php new file mode 100644 index 00000000000..fe1b2884452 --- /dev/null +++ b/lib/public/Mail/Provider/IMessageSend.php @@ -0,0 +1,33 @@ +<?php + +declare(strict_types=1); + +/** + * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later + */ +namespace OCP\Mail\Provider; + +/** + * Mail Message Send Interface + * + * This interface is the required set of methods and functionality used to extend IService with message sending functionality + * + * @since 30.0.0 + * + */ +interface IMessageSend { + + /** + * send an outbound message + * + * @since 30.0.0 + * + * @param IMessage $message mail message object with all required parameters to send a message + * @param array $options array of options reserved for future use + * + * @throws \OCP\Mail\Provider\Exception\SendException on failure, check message for reason + */ + public function sendMessage(IMessage $message, array $options = []): void; + +} |