[ticket/17135] Add messenger method interface class

PHPBB-17135

phpBB/phpbb/messenger/method/messenger_interface.php

@@ -0,0 +1,59 @@
+<?php
+/**
+ *
+ * This file is part of the phpBB Forum Software package.
+ *
+ * @copyright (c) phpBB Limited <https://www.phpbb.com>
+ * @license GNU General Public License, version 2 (GPL-2.0)
+ *
+ * For full copyright and license information, please see
+ * the docs/CREDITS.txt file.
+ *
+ */
+
+namespace phpbb\messenger\method;
+
+/**
+ * Messenger method interface class
+ */
+interface messenger_interface
+{
+	/**
+	 * Get messenger method id
+	 *
+	 * @return int
+	 */
+	public function get_id(): int;
+
+	/**
+	 * Check if the messenger method is enabled
+	 *
+	 * @return bool
+	 */
+	public function is_enabled(): bool;
+
+	/**
+	 * Set up subject for the message
+	 *
+	 * @param string	$subject	Email subject
+	 *
+	 * @return void
+	 */
+	public function subject(string $subject = ''): void;
+
+	/**
+	 * Send out messages
+	 *
+	 * @return bool
+	 */
+	public function send(): bool;
+
+	/**
+	 * Add error message to log
+	 *
+	 * @param string	$msg	Error message text
+	 *
+	 * @return void
+	 */
+	public function error(string $msg): void;
+}