1	<?php
2	/**
3	* This program is free software; you can redistribute it and/or modify
4	* it under the terms of the GNU General Public License as published by
5	* the Free Software Foundation; either version 2 of the License, or
6	* (at your option) any later version.
7	*
8	* This program is distributed in the hope that it will be useful,
9	* but WITHOUT ANY WARRANTY; without even the implied warranty of
10	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11	* GNU General Public License for more details.
12	*
13	* You should have received a copy of the GNU General Public License along
14	* with this program; if not, write to the Free Software Foundation, Inc.,
15	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16	* http://www.gnu.org/copyleft/gpl.html
17	*
18	* @file
19	*/
20
21	namespace MediaWiki\Mail;
22
23	use MailAddress;
24	use StatusValue;
25
26	/**
27	* Interface for sending arbitrary emails.
28	*
29	* Default implementation is MediaWiki\Mail\Emailer.
30	*
31	* @internal
32	* @since 1.35
33	* @ingroup Mail
34	*/
35	interface IEmailer {
36
37	/**
38	* Sends emails to recipients
39	*
40	* @since 1.35
41	*
42	* @param MailAddress|MailAddress[] $to Array of Recipients' emails
43	* @param MailAddress $from Sender's email
44	* @param string $subject Email's subject.
45	* @param string $bodyText text part of body
46	* @param string|null $bodyHtml html part of body (optional)
47	* @param array $options Keys:
48	*     'replyTo' MailAddress
49	*     'contentType' string default 'text/plain; charset=UTF-8'
50	*     'headers' array Extra headers to set
51	*
52	* @phan-param array{replyTo?:?MailAddress,contentType?:string,headers?:array<string,string>} $options
53	* @return StatusValue
54	*/
55	public function send(
56	$to,
57	MailAddress $from,
58	string $subject,
59	string $bodyText,
60	?string $bodyHtml = null,
61	array $options = []
62	): StatusValue;
63	}