phpbb/phpBB/phpbb/messenger/method/messenger_interface.php
2025-04-21 15:16:41 +02:00

63 lines
1.1 KiB
PHP

<?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
{
/**
* 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;
/**
* Add message header
*
* @param string $header_name Message header name
* @param mixed $header_value Message header value
*
* @return void
*/
public function header(string $header_name, mixed $header_value): void;
}